Objets
AnswerResponse
Réponse de l’assistant (POST /v1/ask, POST /v1/chat sans flux, et l’événement done du flux). Il existe plusieurs formes : une réponse ordinaire ; « aucun document » (empty: no_hits, sans provenance) ; un refus sur un sujet restreint (empty: restricted avec restricted) ; et un refus par une règle de protection (empty: guardrail avec guardrail, dont le texte est le message de refus standard de l’organisation). Une réponse en cache a cached: true et cache_hit (une répétition exacte ou une réponse à une question similaire). Une réponse fondée uniquement sur des fiches validées (VERIFIED_ONLY) a verified_only: true.
Champs
answerstringobligatoirequestion_idintegerobligatoirequerystringcollectionstringobligatoireprovenancearray of NumberProvenanceemptystringValeurs autorisées:
no_hitsrestrictedguardrailno_data_for_periodbasisAnswerBasisverificationAnswerVerificationalt_periodsarray of AnswerAltPerioditems ≤ 6
drilldownarray of AnswerDrilldownitems ≤ 20
restrictedRestrictedInfoguardrailGuardrailVerdictverified_onlybooleancachedbooleancache_hitAnswerCacheHitout_of_scopeAnswerOutOfScopeattachmentsarray of Attachmentexport_errorstringtoolsstring | nullRaison de l’utilisation d’outils pour cette réponse :
request(demandé explicitement) ;compare,compute,action(selon la question) ;needs_calc(un calcul sur des tableaux est nécessaire) ;summary(une vue d’ensemble d’une collection ou de documents) ;mcp(l’organisation a connecté des serveurs MCP externes).Valeurs autorisées:
requestcomparecomputeactionneeds_calcsummarymcpnulltool_callsarray of ToolCallInfocalculationsarray of Calculationpending_actionsarray of PendingActionconversation_idstringUniquement pour
POST /v1/chatavec une conversation.answer_idstringID de l’objet réponse.
Utilisé par
- POST
/v1/askObtenir une réponse de l’assistant sans flux - POST
/v1/chatRecevoir une réponse de l’assistant en flux (SSE)