Objecten
AnswerResponse
Het antwoord van de assistent (POST /v1/ask, POST /v1/chat zonder streaming en het event done van de stream). Er zijn verschillende vormen: een gewoon antwoord; “geen documenten” (empty: no_hits, zonder provenance); een weigering bij een beperkt onderwerp (empty: restricted met restricted); en een weigering door een beschermingsregel (empty: guardrail met guardrail, waarbij de tekst de standaardmelding van de organisatie voor een weigering is). Een antwoord uit de cache heeft cached: true en cache_hit (een exacte herhaling of een antwoord op een vergelijkbare vraag). Een antwoord dat alleen op geverifieerde kaarten is gebaseerd (VERIFIED_ONLY), heeft verified_only: true.
Velden
answerstringverplichtquestion_idintegerverplichtquerystringcollectionstringverplichtprovenancearray of NumberProvenanceemptystringToegestane waarden:
no_hitsrestrictedguardrailno_data_for_periodbasisAnswerBasisverificationAnswerVerificationalt_periodsarray of AnswerAltPerioditems ≤ 6
drilldownarray of AnswerDrilldownitems ≤ 20
restrictedRestrictedInfoguardrailGuardrailVerdictverified_onlybooleancachedbooleancache_hitAnswerCacheHitout_of_scopeAnswerOutOfScopeattachmentsarray of Attachmentexport_errorstringtoolsstring | nullWaarom er voor dit antwoord tools zijn gebruikt:
request(expliciet gevraagd);compare,compute,action(op basis van de vraag);needs_calc(er is een berekening over tabellen nodig);summary(een overzicht van een collectie of documenten);mcp(de organisatie heeft externe MCP-servers gekoppeld).Toegestane waarden:
requestcomparecomputeactionneeds_calcsummarymcpnulltool_callsarray of ToolCallInfocalculationsarray of Calculationpending_actionsarray of PendingActionconversation_idstringAlleen voor
POST /v1/chatmet een gesprek.answer_idstringID van het antwoordobject.
Gebruikt door
- POST
/v1/askAntwoord van de assistent ophalen zonder streaming - POST
/v1/chatAntwoord van de assistent streamen (SSE)