Objetos
AnswerResponse
A resposta do assistente (POST /v1/ask, POST /v1/chat sem streaming e o evento done do stream). Há várias formas: uma resposta comum; “nenhum documento” (empty: no_hits, sem provenance); uma recusa sobre um tema restrito (empty: restricted com restricted); e uma recusa por regra de proteção (empty: guardrail com guardrail, em que o texto é a mensagem de recusa padrão da organização). Uma resposta do cache tem cached: true e cache_hit (uma repetição exata ou uma resposta a uma pergunta semelhante). Uma resposta baseada só em cartões verificados (VERIFIED_ONLY) tem verified_only: true.
Campos
answerstringobrigatórioquestion_idintegerobrigatórioquerystringcollectionstringobrigatórioprovenancearray 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 que foram usadas ferramentas nesta resposta:
request(pedido explicitamente);compare,compute,action(com base na pergunta);needs_calc(é preciso um cálculo sobre tabelas);summary(uma visão geral de uma coleção ou de documentos);mcp(a organização conectou servidores MCP externos).Valores permitidos:
requestcomparecomputeactionneeds_calcsummarymcpnulltool_callsarray of ToolCallInfocalculationsarray of Calculationpending_actionsarray of PendingActionconversation_idstringSó para
POST /v1/chatcom uma conversa.answer_idstringID do objeto da resposta.
Usado em
- POST
/v1/askObter uma resposta do assistente sem stream - POST
/v1/chatTransmitir uma resposta do assistente (SSE)