Skip to content
Sursa Developers

Objects

AnswerWarning

A warning attached to an answer. kind is extensible: show an unknown kind with a generic message. Kinds:
- chart_unavailable, chart_type_changed, chart_axis_categorical, tool_not_allowed, tool_failed, table_query_failed (a table query of the answer failed), truncated. These kinds have no reason.

- answer_mismatch_data: a number in the answer next to a month differs from the chart data for that month (reason: period_value, period_missing, total_as_period, period_part); or the number is not in the answer data (reason: number_not_in_data); or an overview answer names a document that is not in the document list and has no source link (reason: document_not_in_list); or the number is in the data, but in another currency (reason: currency_mismatch, with the fields number, currency, currencies). Fields: text, expected, spans.

- answer_source_ambiguous: the data comes from several similar tables for the same period, and the question did not ask to combine them (text lists the tables).

- answer_no_data_basis: an answer with monthly numbers has no table data, so the numbers are not verified.

- currency_missing: a number from monetary data has no currency, although the data has several currencies (text, number, spans, currencies).

- mixed_currency_sum: a number in the answer equals a sum of values in different currencies (text, number, spans, currencies).

- access_limited: some results were excluded by the user's access, so the answer may be incomplete (no data fields).

- fx_rate_stale: the conversion used an exchange rate older than the freshness threshold of its source (rate_date, currencies).

- fx_rate_missing: an amount in the answer was not converted. reason is no_rate_on_date (no rate for the date of the amount's row within the tolerance: 7 days, or 31 days for manually uploaded rates) or no_rate (no rates for the pair at all). currencies lists the currencies without a rate. text is a fallback in English with the pairs and dates, for example “RUB → USD on 2026-03-04, 2026-03-05”, with several pairs separated by “; ”.

- restricted_unverified: a question on a restricted topic. Excerpts are not shown without a relevance check (no data fields).

- enrichment_pending: the scope of the question has documents that are still being processed, so their fields and financial records are not ready. reason is documents (a question about amounts or an answer from tables, so the total may be incomplete) or document (a question about a specific document that is still being processed or could not be processed). pending is the number of documents being processed, and card_ids are those visible to the user (at most 20). failed is the number of documents that could not be processed, and failed_card_ids are the visible ones (at most 20).

- partial_coverage: a dossier question or a list of documents of one type. found documents were found in the scope, and only shown < found are in the answer, so the answer may be incomplete.

- reconcile_unconfirmed: the answer says “matches” to a reconciliation question, but the amount was not found in two different documents (text is a note with the amounts of both sources in the answer language).

The client builds the user-facing text from kind, reason and the data fields in the interface language. The text of access_limited, restricted_unverified and fx_rate_missing, and expected, are fallback texts in the answer language or in English.

Fields

  • kindstringrequired
  • reasonstring

    answer_mismatch_data: the reason code (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: no reason. currency_missing, mixed_currency_sum: an explanation in English (a fallback; the client builds the phrase from currencies). fx_rate_missing: no_rate_on_date (no rate for the row's date within the tolerance) or no_rate (no rates for the pair at all).

  • requestedstring
  • typestring
  • toolstring

    tool_failed, tool_not_allowed: the name of the tool.

  • textstring

    The part of the answer the warning refers to (answer_mismatch_data: the month and the number as written in the answer). For access_limited, restricted_unverified and fx_rate_missing, a fallback text (fx_rate_missing: the pairs and dates without a rate).

  • expectedstring

    What the data says (answer_mismatch_data: the value for this month and the month of this value, or the value of the total).

  • spansarray of array of integer

    Positions of the fragments in the answer text (UTF-16, as in JavaScript strings): the number and the month.

  • numberstring

    answer_mismatch_data: the number as written in the answer. Together with period, other_period, values and rows, this is the data for the warning text in the interface language.

  • periodstring

    answer_mismatch_data: the month from the answer (YYYY-MM).

  • other_periodstring

    answer_mismatch_data: the month of the data whose value equals the number (YYYY-MM).

  • valuesarray of number (double)

    answer_mismatch_data: the data values for the month, or the total.

  • rowsinteger

    answer_mismatch_data, period_part: how many rows were added up in the month's total.

  • currencystring

    answer_mismatch_data, currency_mismatch: the currency of the number as named in the answer (ISO 4217 code).

  • currenciesarray of string

    Currencies of the data (ISO 4217 codes). For currency_mismatch, those in which this value appears in the data; for currency_missing and mixed_currency_sum, the currencies of the monetary values in the answer data; for fx_rate_stale, the currencies converted at an outdated rate; for fx_rate_missing, the currencies without a rate.

  • rate_datestring (date)

    fx_rate_stale: the date of the outdated rate (YYYY-MM-DD).

  • pendinginteger

    enrichment_pending: how many documents in the scope of the question are still being processed.

  • card_idsarray of string

    enrichment_pending: the cards of these documents that are visible to the user (at most 20).

  • failedinteger

    enrichment_pending: how many documents in the scope of the question could not be processed.

  • failed_card_idsarray of string

    enrichment_pending: the cards of the documents that could not be processed and are visible to the user (at most 20).

  • foundinteger

    partial_coverage: how many documents of the set were found in the scope of the question.

  • showninteger

    partial_coverage: how many of the documents found are in the answer.

Part of

AnswerResponseChatEventDataFeedItemQuestionPayload