SearchWarning
Fields
| Field | Type | Always present | Description |
|---|---|---|---|
code | string | no | One of ignored_parameter, unknown_ticker, snippet_truncated, near_budget_exhausted, leading_wildcard_dropped, no_searchable_text, cursor_generation_expired, cluster_table_changed. |
detail | string | no | — |
doc_id | string | no | For snippet_truncated: the document whose snippet search was cut short. |
parameter | string | no | For ignored_parameter: the parameter's name. |
position | integer | null | no | Character offset in q, when the warning is about q. |
ticker | string | no | For unknown_ticker: the ticker that SEC's ticker file does not list. |
Used by
- Part of SearchParse and SearchResults.
Markdown version: /docs/reference/schemas/search-warning.md