Automaatsed viited ja parimad tavad
Sellel lehel
Allikatega ja usaldusväärsed vastused
Kui mudel kasutab veebiotsingut või X-i otsingut, lisab Responses API vastusesse automaatselt viited. Need viited võimaldavad sinu kasutajatel allikaid kontrollida ja suurendavad usaldust genereeritud vastuste vastu.
Kuidas viited toimivad
Viited ilmuvad iga sisuelemendi annotations massiivi:
{
"output": [{
"type": "message",
"content": [{
"type": "output_text",
"text": "According to the latest data, the AI market...",
"annotations": [
{
"type": "url_citation",
"url": "https://example.com/article",
"title": "AI Market Analysis in 2026",
"start_index": 35,
"end_index": 68
}
]
}]
}]
}
Viitade väljad
| Väli | Kirjeldus |
|---|---|
type | Alati url_citation |
url | Allika URL |
title | Allikalehe pealkiri |
start_index | Algpositsioon tekstis |
end_index | Lõpppositsioon tekstis |
Kuva viited oma rakenduses
response = client.responses.create(
model="grok-4.20-0309-reasoning",
input="What are the latest advancements in AI?",
tools=[{"type": "web_search"}]
)
text = response.output[0].content[0].text
annotations = response.output[0].content[0].annotations
# Ehita tekst koos jalustega
footnotes = []
for i, ann in enumerate(annotations, 1):
footnotes.append(f"[{i}] {ann.title} — {ann.url}")
print(text)
print("\n--- Sources ---")
for fn in footnotes:
print(fn)
HTML-is
def render_with_citations(text, annotations):
# Sorteeri positsiooni järgi (lõpust algusesse, et indekseid nihutada)
sorted_anns = sorted(annotations, key=lambda a: a.start_index, reverse=True)
html = text
for i, ann in enumerate(sorted_anns):
ref_num = len(sorted_anns) - i
link = f'<a href="{ann.url}" title="{ann.title}" target="_blank">[{ref_num}]</a>'
html = html[:ann.end_index] + link + html[ann.end_index:]
return html
Parimad tavad tootmises
1. Kontrolli alati olekut
response = client.responses.create(...)
if response.status != "completed":
handle_error(response)
return
2. Käitle tühje vastuseid
if not response.output or not response.output[0].content:
return "The model did not generate a response."
text = response.output[0].content[0].text
3. Logi mõõdikuid
Iga tootmispäringu kohta logi:
response.idjälgitavuse jaoksusage.total_tokenstarbimise jaoksusage.cost_in_nano_usdkulude jaoks- Kliendipoolne vastusaeg
- Vastuse olek
4. Turva oma API võti
- Salvesta see keskkonnamuutujasse, mitte kunagi koodi
- Kasuta tootmises saladuste haldurit (Vault, AWS Secrets Manager)
- Vaheta võtmeid regulaarselt
- Ära kunagi avalda neid kliendipoolselt (brauseris)
5. Halda genereeritud sisu
Mudeli vastused võivad hoolimata filtritest sisaldada sobimatut sisu. Rakenda modereerimiskiht, kui kuvad vastuseid avalikult.
6. Planeeri skaleeritavust
- Kasuta voogedastust, et vähendada ooteaja tajumist
- Rakenda järjekorrasüsteem mahukate päringute jaoks
- Vahemällu sagedased vastused
- Jälgi oma kiiruse piiramise kvooti
Kasutuselevõtu kontrollnimekiri
- Aegumine seatud 3600 sekundile
- Uuesti proovimine eksponentsiaalse tagasipöördumisega
- Kliendipoolne kiiruse piiramine
- Mõõdikute logimine (tokenid, kulud, latentsus)
- Veakäitlus (401, 429, 500, aegumine)
- Turvaline API võti
- Sisumodereerimine vajadusel
- Kulude jälgimine ja hoiatused
- Vooluahela katkestaja vastupidavuse tagamiseks
Peamised punktid
- Viited on automaatsed, kui mudel kasutab
web_searchvõix_search - Need sisaldavad URL-i, pealkirja ja positsiooni tekstis
- Kontrolli alati olekut ja käitle tühje vastuseid
- Turva oma API võti – mitte kunagi lähtekoodis ega kliendipoolselt
- Rakenda logimine, uuesti proovimine, kiiruse piiramine ja jälgimine enne tootmisse minekut
Testi oma teadmisi
Responses API süvitsi: lõplik kontroll.
1. Mida pakub Responses API võrreldes Chat Completionsiga?
Vastus: Kaasaegne formaat: serveripoolne vastuste püsivus (GET/DELETE, aheldamine ID järgi), sisseehitatud tööriistad ja uusimad funktsioonid – API, millele xAI keskendub arenduses.
2. Kuidas aheldada vestlust?
Vastus: Viidates eelmisele vastusele: kontekst hoitakse serveripoolselt – kogu ajalugu pole vaja iga pöördega uuesti saata.
3. Mis on krüpteeritud arutluskäik?
Vastus: Mudeli sisemine arutluskäik, mis tagastatakse krüpteeritud kujul: uuesti kasutatav järgnevates pööretes ilma loetavana – mõtteprotsess liigub, konfidentsiaalsus säilib.
4. Mida võimaldab serveri ja kliendi tööriistade segamine?
Vastus: Kombineeri xAI poolt täidetavaid sisseehitatud tööriistu (veebiotsing jne) ja sinu koodi poolt täidetavaid kohandatud funktsioone – iga tööriist õiges kohas, orkestreeritud samas päringus.
5. Millised on parimad tavad tootmiseks?
Vastus: Käitle aegumist ja uuesti proovimist, jälgi arveldust (tokenid, tööriistad) ja kasuta automaatseid viiteid kontrollitavate vastuste jaoks – töökindlus ja usaldus koos.
Püsivus, tööriistad, krüpteeritud arutluskäik, viited: Responses API on kaasaegne alustala – siin ehitatakse sinu Groki rakendusi.