Objetos
AnswerWarning
Um aviso associado a uma resposta. kind é extensível: mostre um tipo desconhecido com uma mensagem genérica. Tipos:
- chart_unavailable, chart_type_changed, chart_axis_categorical, tool_not_allowed, tool_failed, table_query_failed (uma consulta às tabelas da resposta falhou), truncated. Esses tipos não têm reason.
- answer_mismatch_data: um número na resposta ao lado de um mês difere dos dados do gráfico para esse mês (reason: period_value, period_missing, total_as_period, period_part); ou o número não está nos dados da resposta (reason: number_not_in_data); ou uma resposta de visão geral cita um documento que não está na lista de documentos e não tem link para a fonte (reason: document_not_in_list); ou o número está nos dados, mas em outra moeda (reason: currency_mismatch, com os campos number, currency, currencies). Campos: text, expected, spans.
- answer_source_ambiguous: os dados vêm de várias tabelas semelhantes do mesmo período, e a pergunta não pediu para combiná-las (text lista as tabelas).
- answer_no_data_basis: uma resposta com números mensais não tem dados de tabela, por isso os números não foram verificados.
- currency_missing: um número de dados monetários não tem moeda, embora os dados tenham várias moedas (text, number, spans, currencies).
- mixed_currency_sum: um número na resposta é igual a uma soma de valores em moedas diferentes (text, number, spans, currencies).
- access_limited: alguns resultados foram excluídos pelo acesso do usuário, por isso a resposta pode estar incompleta (sem campos de dados).
- fx_rate_stale: a conversão usou uma taxa de câmbio mais antiga que o limite de atualidade da fonte dela (rate_date, currencies).
- fx_rate_missing: um valor na resposta não foi convertido. reason é no_rate_on_date (não há taxa para a data da linha do valor dentro da tolerância: 7 dias, ou 31 dias para taxas carregadas manualmente) ou no_rate (não há nenhuma taxa para o par). currencies lista as moedas sem taxa. text é um texto alternativo em inglês com os pares e as datas, por exemplo “RUB → USD on 2026-03-04, 2026-03-05”, com vários pares separados por “; ”.
- restricted_unverified: uma pergunta sobre um tema restrito. Os trechos não são mostrados sem uma conferência de relevância (sem campos de dados).
- enrichment_pending: a abrangência da pergunta tem documentos que ainda estão sendo processados, por isso os campos e os registros financeiros deles não estão prontos. reason é documents (uma pergunta sobre valores ou uma resposta a partir de tabelas, por isso o total pode estar incompleto) ou document (uma pergunta sobre um documento específico que ainda está sendo processado ou não pôde ser processado). pending é o número de documentos sendo processados, e card_ids são os visíveis para o usuário (no máximo 20). failed é o número de documentos que não puderam ser processados, e failed_card_ids são os visíveis (no máximo 20).
- partial_coverage: uma pergunta de dossiê ou uma lista de documentos de um tipo. found documentos foram encontrados na abrangência, e só shown < found estão na resposta, por isso a resposta pode estar incompleta.
- reconcile_unconfirmed: a resposta diz “confere” a uma pergunta de reconciliação, mas o valor não foi encontrado em dois documentos diferentes (text é uma nota com os valores das duas fontes no idioma da resposta).
O cliente monta o texto para o usuário a partir de kind, reason e dos campos de dados, no idioma da interface. O text de access_limited, restricted_unverified e fx_rate_missing, e expected, são textos alternativos no idioma da resposta ou em inglês.
Campos
kindstringobrigatórioreasonstringanswer_mismatch_data: o código do motivo (period_value,period_missing,total_as_period,period_part,number_not_in_data,document_not_in_list,currency_mismatch).chart_axis_categorical:unparsed_periods.tool_failed,table_query_failed,truncated: semreason.currency_missing,mixed_currency_sum: uma explicação em inglês (um texto alternativo; o cliente monta a frase a partir decurrencies).fx_rate_missing:no_rate_on_date(não há taxa para a data da linha dentro da tolerância) ouno_rate(não há nenhuma taxa para o par).requestedstringtypestringtoolstringtool_failed,tool_not_allowed: o nome da ferramenta.textstringA parte da resposta a que o aviso se refere (
answer_mismatch_data: o mês e o número como escritos na resposta). Paraaccess_limited,restricted_unverifiedefx_rate_missing, um texto alternativo (fx_rate_missing: os pares e as datas sem taxa).expectedstringO que os dados dizem (
answer_mismatch_data: o valor deste mês e o mês deste valor, ou o valor do total).spansarray of array of integerPosições dos trechos no texto da resposta (UTF-16, como nas strings de JavaScript): o número e o mês.
numberstringanswer_mismatch_data: o número como escrito na resposta. Junto comperiod,other_period,valueserows, são os dados para o texto do aviso no idioma da interface.periodstringanswer_mismatch_data: o mês da resposta (YYYY-MM).other_periodstringanswer_mismatch_data: o mês dos dados cujo valor é igual ao número (YYYY-MM).valuesarray of number (double)answer_mismatch_data: os valores dos dados do mês, ou o total.rowsintegeranswer_mismatch_data,period_part: quantas linhas foram somadas no total do mês.currencystringanswer_mismatch_data,currency_mismatch: a moeda do número como citada na resposta (código ISO 4217).currenciesarray of stringMoedas dos dados (códigos ISO 4217). Para
currency_mismatch, aquelas em que este valor aparece nos dados; paracurrency_missingemixed_currency_sum, as moedas dos valores monetários dos dados da resposta; parafx_rate_stale, as moedas convertidas por uma taxa desatualizada; parafx_rate_missing, as moedas sem taxa.rate_datestring (date)fx_rate_stale: a data da taxa desatualizada (YYYY-MM-DD).pendingintegerenrichment_pending: quantos documentos da abrangência da pergunta ainda estão sendo processados.card_idsarray of stringenrichment_pending: os cartões desses documentos que são visíveis para o usuário (no máximo 20).failedintegerenrichment_pending: quantos documentos da abrangência da pergunta não puderam ser processados.failed_card_idsarray of stringenrichment_pending: os cartões dos documentos que não puderam ser processados e são visíveis para o usuário (no máximo 20).foundintegerpartial_coverage: quantos documentos do conjunto foram encontrados na abrangência da pergunta.shownintegerpartial_coverage: quantos dos documentos encontrados estão na resposta.