Automatiske citationer og bedste praksis
På denne side
Kildehenvisninger og pålidelige svar
Når modellen bruger websøgning eller X-søgning, inkluderer Responses API automatisk citationer i svaret. Disse citationer giver dine brugere mulighed for at verificere kilderne og opbygge tillid til de genererede svar.
Sådan fungerer citationer
Citationer vises i annotations-arrayet for hvert indholdselement:
{
"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
}
]
}]
}]
}
Citationsfelter
| Felt | Beskrivelse |
|---|---|
type | Altid url_citation |
url | Kilde-URL |
title | Titlen på kildesiden |
start_index | Startposition i teksten |
end_index | Slutposition i teksten |
Vis citationer 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
# Byg tekst med fodnoter
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):
# Sortér efter position (slut til start for at undgå forskudte indeks)
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
Bedste praksis til produktion
1. Valider altid status
response = client.responses.create(...)
if response.status != "completed":
handle_error(response)
return
2. Håndtér tomme 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. Log metrikker
For hver produktionsanmodning skal du logge:
response.idfor sporbarhedusage.total_tokensfor forbrugusage.cost_in_nano_usdfor omkostninger- Svartid på klientsiden
- Svarstatus
4. Sikr din API-nøgle
- Gem den i en miljøvariabel, aldrig i koden
- Brug en hemmelighedsadministrator i produktion (Vault, AWS Secrets Manager)
- Rotér dine nøgler regelmæssigt
- Eksponér dem aldrig på klientsiden (browser)
5. Administrér genereret indhold
Modelsvar kan indeholde upassende indhold trods filtre. Implementér et modereringslag, hvis du viser svar offentligt.
6. Planlæg skalering
- Brug streaming til at reducere den oplevede ventetid
- Implementér et køsystem til tunge anmodninger
- Cache hyppige svar
- Overvåg dine kvoter for rate limiting
Tjekliste til implementering
- Timeout sat til 3600 sekunder
- Genforsøg med eksponentiel backoff
- Rate limiting på klientsiden
- Log metrikker (tokens, omkostninger, latenstid)
- Fejlhåndtering (401, 429, 500, timeout)
- Sikker API-nøgle
- Indholdsmoderering om nødvendigt
- Omkostningsovervågning og alarmer
- Circuit breaker for robusthed
Vigtige pointer
- Citationer er automatiske, når modellen bruger
web_searchellerx_search - De indeholder URL, titel og position i teksten
- Valider altid status og håndtér tomme svar
- Sikr din API-nøgle – aldrig i kildekoden eller på klientsiden
- Implementér logning, genforsøg, rate limiting og overvågning, før du går i produktion
Test din viden
Responses API i dybden: den afsluttende kontrol.
1. Hvad tilbyder Responses API sammenlignet med Chat Completions?
Svar: Det moderne format: server-side persistens af svar (GET/DELETE, kædning via ID), indbyggede værktøjer og nyeste funktioner – det API, hvor xAI fokuserer sin udvikling.
2. Hvordan kæder du en samtale?
Svar: Ved at referere til det tidligere svar: konteksten holdes på serveren – ingen grund til at gensende hele historien ved hver tur.
3. Hvad er krypteret ræsonnement?
Svar: Modellens interne ræsonnement returneret i krypteret form: genanvendeligt i efterfølgende ture uden at være læsbart – tankeprocessen rejser, fortroligheden bevares.
4. Hvad muliggør blanding af server- og klientværktøjer?
Svar: Kombination af indbyggede værktøjer udført af xAI (websøgning osv.) og dine brugerdefinerede funktioner udført af din kode – hvert værktøj på det rette sted, orkestreret i samme anmodning.
5. Hvad er bedste praksis til produktion?
Svar: Håndtér timeout og genforsøg, spor fakturering (tokens, værktøjer), og udnyt automatiske citationer til verificerbare svar – robusthed og tillid samlet.
Persistens, værktøjer, krypteret ræsonnement, citationer: Responses API er det moderne fundament – her bygger du dine Grok-applikationer.