Objetos
AnswerResponse
La respuesta del asistente (POST /v1/ask, POST /v1/chat sin transmisión en flujo y el evento done del flujo). Hay varias formas: una respuesta normal; «sin documentos» (empty: no_hits, sin provenance); un rechazo por un tema restringido (empty: restricted con restricted); y un rechazo de una regla de protección (empty: guardrail con guardrail, donde el texto es el mensaje de rechazo estándar de la organización). Una respuesta en caché tiene cached: true y cache_hit (una repetición exacta o una respuesta a una pregunta similar). Una respuesta basada solo en tarjetas verificadas (VERIFIED_ONLY) tiene verified_only: true.
Campos
answerstringobligatorioquestion_idintegerobligatorioquerystringcollectionstringobligatorioprovenancearray of NumberProvenanceemptystringValores permitidos:
no_hitsrestrictedguardrailno_data_for_periodbasisAnswerBasisverificationAnswerVerificationalt_periodsarray of AnswerAltPerioditems ≤ 6
drilldownarray of AnswerDrilldownitems ≤ 20
restrictedRestrictedInfoguardrailGuardrailVerdictverified_onlybooleancachedbooleancache_hitAnswerCacheHitout_of_scopeAnswerOutOfScopeattachmentsarray of Attachmentexport_errorstringtoolsstring | nullPor qué se usaron herramientas en esta respuesta:
request(se pidieron de forma explícita);compare,compute,action(según la pregunta);needs_calc(hace falta un cálculo sobre tablas);summary(una visión general de una colección o de documentos);mcp(la organización ha conectado servidores MCP externos).Valores permitidos:
requestcomparecomputeactionneeds_calcsummarymcpnulltool_callsarray of ToolCallInfocalculationsarray of Calculationpending_actionsarray of PendingActionconversation_idstringSolo en
POST /v1/chatcon una conversación.answer_idstringID del objeto de la respuesta.
Se usa en
- POST
/v1/askObtener una respuesta del asistente sin transmisión - POST
/v1/chatTransmitir una respuesta del asistente (SSE)