Automatiska citeringar och bästa praxis
På denna sida
Källhänvisade och tillförlitliga svar
När modellen använder webbsökning eller X-sökning inkluderar Responses API automatiskt citeringar i svaret. Dessa citeringar låter dina användare verifiera källor och bygger förtroende för de genererade svaren.
Hur citeringar fungerar
Citeringar visas i annotations-arrayen för varje innehållselement:
{
"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
}
]
}]
}]
}
Fält för citeringar
| Fält | Beskrivning |
|---|---|
type | Alltid url_citation |
url | Källans URL |
title | Titeln på källsidan |
start_index | Startposition i texten |
end_index | Slutposition i texten |
Visa citeringar i din applikation
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
# Bygg text med fotnoter
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)
I HTML
def render_with_citations(text, annotations):
# Sortera efter position (slut till start för att undvika förskjutna index)
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
Bästa praxis för produktion
1. Validera alltid status
response = client.responses.create(...)
if response.status != "completed":
handle_error(response)
return
2. Hantera tomma svar
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. Logga metrik
För varje produktionsbegäran ska du logga:
response.idför spårbarhetusage.total_tokensför konsumtionusage.cost_in_nano_usdför kostnader- Svarstid på klientsidan
- Svarsstatus
4. Säkra din API-nyckel
- Lagra den i en miljövariabel, aldrig i koden
- Använd en hemlighetshanterare i produktion (Vault, AWS Secrets Manager)
- Rotera dina nycklar regelbundet
- Exponera dem aldrig på klientsidan (webbläsare)
5. Hantera genererat innehåll
Modellsvar kan innehålla olämpligt innehåll trots filter. Implementera ett modereringslager om du visar svar offentligt.
6. Planera för skalbarhet
- Använd strömning för att minska den upplevda väntetiden
- Implementera ett kösystem för tunga begäranden
- Cacha frekventa svar
- Övervaka dina kvoter för hastighetsbegränsning
Checklista för distribution
- Timeout inställd på 3600 sekunder
- Försök igen med exponentiell backoff
- Hastighetsbegränsning på klientsidan
- Logga metrik (tokens, kostnader, latens)
- Felhantering (401, 429, 500, timeout)
- Säker API-nyckel
- Innehållsmoderering vid behov
- Kostnadsövervakning och aviseringar
- Strömbrytare för resiliens
Viktiga punkter
- Citeringar är automatiska när modellen använder
web_searchellerx_search - De innehåller URL, titel och position i texten
- Validera alltid status och hantera tomma svar
- Säkra din API-nyckel – aldrig i källkoden eller på klientsidan
- Implementera loggning, försök igen, hastighetsbegränsning och övervakning innan du går till produktion
Testa dina kunskaper
Responses API på djupet: den slutgiltiga kontrollen.
1. Vad erbjuder Responses API jämfört med Chat Completions?
Svar: Det moderna formatet: beständighet för svar på serversidan (GET/DELETE, kedjebildning efter ID), inbyggda verktyg och senaste funktioner – API:t där xAI fokuserar sin utveckling.
2. Hur kedjar du ett samtal?
Svar: Genom att referera till föregående svar: kontexten behålls på serversidan – inget behov av att skicka om hela historiken vid varje varv.
3. Vad är krypterat resonemang?
Svar: Modellens interna resonemang returneras i krypterad form: återanvändbart i efterföljande varv utan att vara läsbart – tankeprocessen färdas, konfidentialiteten består.
4. Vad möjliggör blandning av server- och klientverktyg?
Svar: Kombinera inbyggda verktyg som körs av xAI (webbsökning etc.) och dina anpassade funktioner som körs av din kod – varje verktyg på rätt plats, orkestrerat i samma begäran.
5. Vilka är de bästa praxis för produktion?
Svar: Hantera timeout och försök igen, spåra fakturering (tokens, verktyg) och utnyttja automatiska citeringar för verifierbara svar – robusthet och förtroende tillsammans.
Beständighet, verktyg, krypterat resonemang, citeringar: Responses API är den moderna grunden – här bygger du dina Grok-applikationer.