Systemos užklausos API agentams
Šiame puslapyje
Agentų kūrimas naudojant grok-build-0.1
Jei kuri savo kūrimo įrankius – kodo peržiūros agentą, diegimo asistentą ar dokumentacijos generavimo įrankį – tiesiogiai bendrausi su xAI API. Sistemos užklausa yra tavo pagrindinis svertas valdant modelio elgseną.
Geros sistemos užklausos sandara
Efektyvi sistemos užklausa agentui, pagrįstam grok-build-0.1, susideda iš keturių dalių:
1. Užduoties aprašymas
Pradėk aiškiai apibrėždamas, ką agentas daro:
## Vaidmuo
Esi kodo peržiūros asistentas, specializuojantis TypeScript kalboje.
Analizuoji kodo skirtumus, kad nustatytum galimas klaidas,
našumo problemas ir konvencijų pažeidimus.
2. Lūkesčiai ir išvesties formatas
Aprašyk, ko tikiesi iš modelio:
## Išvesties formatas
Kiekvienai nustatytai problemai pateik:
- Failą ir eilutę, kurioje ji yra
- Svarbumą (kritinė, įspėjimas, informacija)
- Problemos aprašymą
- Pataisymo pasiūlymą su kodo pavyzdžiu
3. Ribiniai atvejai
Numatyk dviprasmiškas situacijas:
## Ribiniai atvejai
- Jei skirtumų nėra, atsakyk „Nėra pokyčių analizei“
- Jei kodas parašytas nepalaikoma kalba, tai nurodyk
- Nekomentuok formatavimo pakeitimų (tarpai, įtraukos)
- Ignoruok sugeneruotus konfigūracijos failus (.lock, dist/)
4. Apribojimai
Apibrėžk ribas:
## Apribojimai
- Daugiausia 10 komentarų vienai peržiūrai
- Teik pirmenybę kritinėms klaidoms, o ne stiliaus pasiūlymams
- Siūlydamas mažus pataisymus, nerekomenduok didelio refaktoravimo
Struktūravimas naudojant „Markdown“ arba XML
Modelis pripratęs matyti didelį, struktūruotą kontekstą pirmoje užklausoje. Gerai veikia du formatai:
„Markdown“ (rekomenduojama skaitomumui)
## Vaidmuo
Vaidmens aprašymas...
## Galimi įrankiai
- read_file: nuskaityti projekto failą
- write_file: modifikuoti failą
- run_command: vykdyti terminalo komandą
## Taisyklės
1. Prieš modifikuodamas visada perskaityk failą
2. Prieš trindamas kodą paprašyk patvirtinimo
3. Po kiekvieno pakeitimo paleisk testus
XML (rekomenduojama tikslumui)
<agent>
<role>TypeScript kodo peržiūros asistentas</role>
<tools>
<tool name="read_file">Nuskaityti projekto failą</tool>
<tool name="write_file">Modifikuoti failą</tool>
</tools>
<rules>
<rule>Prieš modifikuodamas visada perskaityk failą</rule>
<rule>Prieš trindamas kodą paprašyk patvirtinimo</rule>
</rules>
</agent>
Abu formatai yra veiksmingi. „Markdown“ lengviau prižiūrėti; XML yra labiau struktūruotas automatiniam analizavimui.
Podėlio optimizavimas
Prisimink pamoką apie podėlį: sistemos užklausa turi būti stabili. Parašyk ją vieną kartą, išsamiai, ir sesijos metu nekeisk. Jei reikia pakeisti agento elgseną, pridėk instrukcijas vartotojo žinutėje, o ne keisk sistemos užklausos.
Pilnas pavyzdys: testų generavimo agentas
## Vaidmuo
Esi agentas, generuojantis vienetinius testus TypeScript kodui.
Naudoji Vitest kaip testavimo sistemą.
## Procesas
1. Nuskaityk šaltinio failą naudodamas read_file
2. Nustatyk eksportuojamas funkcijas
3. Kiekvienai funkcijai sugeneruok testus, apimančius:
- Nominalų atvejį
- Ribinius atvejus (null, undefined, tuščias masyvas)
- Klaidų atvejus
4. Įrašyk testus naudodamas write_file aplanke __tests__/
5. Paleisk testus naudodamas run_command("npx vitest run")
## Konvencijos
- Pavadinimai: {file}.test.ts
- Struktūra: describe > it > expect
- Sudėtingiems duomenims naudok fikstūras
- Imituok išorines priklausomybes (API, DB)
## Apribojimai
- Nekeisk šaltinio kodo
- Jei testas nepavyksta, taisyk testą, o ne šaltinio kodą
- Daugiausia 20 testų vienam failui
Ši sistemos užklausa suteikia agentui visą būtiną informaciją veikti savarankiškai, kartu laikantis nustatytų ribų.
Svarbiausi punktai
- Sistemos užklausa struktūruoja agento elgseną į 4 dalis: vaidmuo, lūkesčiai, ribiniai atvejai, apribojimai
- Sekcijoms struktūruoti naudok „Markdown“ arba XML
- Sistemos užklausa turi būti stabili, kad būtų optimizuotas podėlis
- Nuosekliems agentams įtrauk žingsnis po žingsnio vykdomus procesus
- Visada apibrėžk ribinius atvejus, kad išvengtum netikėtos elgsenos
Patikrink savo žinias
grok-build tavo redaktoriuose: galutinė kontrolė.
1. Kas yra grok-build-0.1?
Atsakymas: xAI agentinis kodo modelis: vietinis įrankių kvietimas, samprotavimų srautas, kūrimo užduotims pritaikytas kontekstas – variklis, slypintis už Grok Build ir redaktorių integracijų.
2. Kaip jį naudoti savo redaktoriuje?
Atsakymas: Per integracijas: Cline VS Code, Cursor, GitHub Copilot, Windsurf ir kitose – su OpenAI suderinama xAI API leidžia tiesioginę integraciją.
3. Kokie įpročiai užtikrina kokybiškas kodo užduotis?
Atsakymas: Nurodyk kontekstą (failai, apribojimai), apibrėžk aiškius ir patikrinamus tikslus, iteruok palaipsniui – ir optimizuok podėlį išlaikydamas priešdėlius stabilius.
4. grok-build-0.1 ar grok-4.5 kodui?
Atsakymas: grok-build kasdienėms kūrimo agentinėms užduotims (greitas, specializuotas); grok-4.5, kai užduotis reikalauja maksimalaus samprotavimo – pasirinkimas priklauso nuo sudėtingumo.
5. Kas turi būti API kodo agento sistemos užklausoje?
Atsakymas: Vaidmuo, projekto konvencijos, redagavimo taisyklės (testai, stilius) ir ribos – tai rėmai, paverčiantys kodo modelį tavo kodų bazės komandos nariu.
Specializuotas modelis, sujungtas redaktorius, tvarkingos užduotys, apibrėžtos užklausos: kūrimas su Grok pagalba sumažinamas iki keturių pasirinkimų – visi jie daromi sąmoningai.