@invinite-org/data-api-client 0.4.0 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. package/dist/apis/EarningsCallsApi.d.ts +4 -8
  2. package/dist/apis/EarningsCallsApi.js +6 -10
  3. package/dist/esm/apis/EarningsCallsApi.d.ts +4 -8
  4. package/dist/esm/apis/EarningsCallsApi.js +6 -10
  5. package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
  6. package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +1 -3
  7. package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
  8. package/dist/esm/models/EarningsCallsSearch200Response.d.ts +0 -2
  9. package/dist/esm/models/EarningsCallsSearch200Response.js +1 -3
  10. package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
  11. package/dist/esm/models/HitMatch.d.ts +4 -12
  12. package/dist/esm/models/HitMatch.js +1 -7
  13. package/dist/esm/models/SearchCoverage.d.ts +1 -11
  14. package/dist/esm/models/SearchCoverage.js +0 -8
  15. package/dist/esm/models/SearchCoverageLeg.d.ts +1 -1
  16. package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
  17. package/dist/models/EarningsCallsDocumentSearch200Response.js +1 -3
  18. package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
  19. package/dist/models/EarningsCallsSearch200Response.d.ts +0 -2
  20. package/dist/models/EarningsCallsSearch200Response.js +1 -3
  21. package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
  22. package/dist/models/HitMatch.d.ts +4 -12
  23. package/dist/models/HitMatch.js +1 -7
  24. package/dist/models/SearchCoverage.d.ts +1 -11
  25. package/dist/models/SearchCoverage.js +0 -8
  26. package/dist/models/SearchCoverageLeg.d.ts +1 -1
  27. package/docs/EarningsCallsApi.md +12 -14
  28. package/docs/HitMatch.md +0 -2
  29. package/docs/SearchCoverage.md +1 -3
  30. package/docs/SearchCoverageLeg.md +1 -1
  31. package/package.json +1 -1
  32. package/src/apis/EarningsCallsApi.ts +6 -10
  33. package/src/models/EarningsCallsDocumentSearch200Response.ts +1 -3
  34. package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -1
  35. package/src/models/EarningsCallsSearch200Response.ts +1 -3
  36. package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +1 -1
  37. package/src/models/HitMatch.ts +5 -16
  38. package/src/models/SearchCoverage.ts +1 -14
  39. package/src/models/SearchCoverageLeg.ts +1 -1
@@ -1008,7 +1008,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
1008
1008
  }
1009
1009
 
1010
1010
  /**
1011
- * Search the page text of investor documents by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
1011
+ * Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
1012
1012
  * Search investor documents
1013
1013
  */
1014
1014
  async earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>> {
@@ -1019,7 +1019,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
1019
1019
  }
1020
1020
 
1021
1021
  /**
1022
- * Search the page text of investor documents by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
1022
+ * Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
1023
1023
  * Search investor documents
1024
1024
  */
1025
1025
  async earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response> {
@@ -2141,7 +2141,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
2141
2141
  }
2142
2142
 
2143
2143
  /**
2144
- * \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
2144
+ * \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
2145
2145
  * Search earnings calls
2146
2146
  */
2147
2147
  async earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>> {
@@ -2152,7 +2152,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
2152
2152
  }
2153
2153
 
2154
2154
  /**
2155
- * \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`), exact text (`literal`), meaning (`semantic`) or both (`hybrid`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work (`websearch_to_tsquery`); ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `semantic`: meaning-based search (multilingual sentence embeddings); `score` is the cosine similarity. - `hybrid`: `lexical` and `semantic` fused by reciprocal rank (`score = Σ 1 / (60 + rank)`, equal weights, ties by passage); `match.lexical_rank` / `match.semantic_rank` give each leg\'s rank. Best for natural-language questions. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`). Semantic matches carry no spans. An exact mode never expands into semantic or fuzzy results. Every mode costs the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed, or a hybrid leg was unavailable) or `unknown` (a mode\'s index is not built for the searched scope, e.g. `semantic_index_missing`) — read it before treating an empty list as \"not found\". - `coverage.lexical` / `coverage.semantic` count the searched transcripts or documents per index (`indexed`, `pending`, `failed`); null for a leg the mode did not use. `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, both legs null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`; pass `mode=semantic` for the previous behaviour (or `mode=hybrid` for natural-language questions). ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `429 upstream_rate_limited` and `503 search_unavailable` carry `Retry-After` (`503` also when a keyword search runs over its time limit — never an empty answer). - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
2155
+ * \"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
2156
2156
  * Search earnings calls
2157
2157
  */
2158
2158
  async earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response> {
@@ -2944,9 +2944,7 @@ export type EarningsCallsDiffVsEnum = typeof EarningsCallsDiffVsEnum[keyof typeo
2944
2944
  */
2945
2945
  export const EarningsCallsDocumentSearchModeEnum = {
2946
2946
  Lexical: 'lexical',
2947
- Literal: 'literal',
2948
- Semantic: 'semantic',
2949
- Hybrid: 'hybrid'
2947
+ Literal: 'literal'
2950
2948
  } as const;
2951
2949
  export type EarningsCallsDocumentSearchModeEnum = typeof EarningsCallsDocumentSearchModeEnum[keyof typeof EarningsCallsDocumentSearchModeEnum];
2952
2950
  /**
@@ -3157,9 +3155,7 @@ export type EarningsCallsQaIncludeEnum = typeof EarningsCallsQaIncludeEnum[keyof
3157
3155
  */
3158
3156
  export const EarningsCallsSearchModeEnum = {
3159
3157
  Lexical: 'lexical',
3160
- Literal: 'literal',
3161
- Semantic: 'semantic',
3162
- Hybrid: 'hybrid'
3158
+ Literal: 'literal'
3163
3159
  } as const;
3164
3160
  export type EarningsCallsSearchModeEnum = typeof EarningsCallsSearchModeEnum[keyof typeof EarningsCallsSearchModeEnum];
3165
3161
  /**
@@ -66,9 +66,7 @@ export interface EarningsCallsDocumentSearch200Response {
66
66
  */
67
67
  export const EarningsCallsDocumentSearch200ResponseModeEnum = {
68
68
  Lexical: 'lexical',
69
- Literal: 'literal',
70
- Semantic: 'semantic',
71
- Hybrid: 'hybrid'
69
+ Literal: 'literal'
72
70
  } as const;
73
71
  export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
74
72
 
@@ -28,7 +28,7 @@ import {
28
28
  */
29
29
  export interface EarningsCallsDocumentSearch200ResponseHitsInner {
30
30
  /**
31
- * Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
31
+ * Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
32
32
  * @type {number}
33
33
  * @memberof EarningsCallsDocumentSearch200ResponseHitsInner
34
34
  */
@@ -66,9 +66,7 @@ export interface EarningsCallsSearch200Response {
66
66
  */
67
67
  export const EarningsCallsSearch200ResponseModeEnum = {
68
68
  Lexical: 'lexical',
69
- Literal: 'literal',
70
- Semantic: 'semantic',
71
- Hybrid: 'hybrid'
69
+ Literal: 'literal'
72
70
  } as const;
73
71
  export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
74
72
 
@@ -120,7 +120,7 @@ export interface EarningsCallsSearch200ResponseHitsInner {
120
120
  */
121
121
  text_truncated: boolean;
122
122
  /**
123
- * Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first), semantic = cosine similarity (4 decimals), hybrid = reciprocal-rank-fusion score (6 decimals)
123
+ * Relevance per mode: lexical = BM25 with `identifier` / `event_id` (an answer attached to its question scores 0.99 × the question), else ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first)
124
124
  * @type {number}
125
125
  * @memberof EarningsCallsSearch200ResponseHitsInner
126
126
  */
@@ -28,25 +28,19 @@ import {
28
28
  */
29
29
  export interface HitMatch {
30
30
  /**
31
- * The leg that found the passage; hybrid = both legs of mode=hybrid
31
+ * The mode that found the passage
32
32
  * @type {HitMatchTypeEnum}
33
33
  * @memberof HitMatch
34
34
  */
35
35
  type: HitMatchTypeEnum;
36
36
  /**
37
- * 1-based rank in the keyword leg (lexical / literal); null when it did not find it
37
+ * 1-based rank of the passage in the answer
38
38
  * @type {number}
39
39
  * @memberof HitMatch
40
40
  */
41
- lexical_rank: number | null;
41
+ lexical_rank: number;
42
42
  /**
43
- * 1-based rank in the semantic leg; null when it did not find it
44
- * @type {number}
45
- * @memberof HitMatch
46
- */
47
- semantic_rank: number | null;
48
- /**
49
- * Matched characters in `text`; empty for semantic matches
43
+ * Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
50
44
  * @type {Array<MatchSpan>}
51
45
  * @memberof HitMatch
52
46
  */
@@ -59,9 +53,7 @@ export interface HitMatch {
59
53
  */
60
54
  export const HitMatchTypeEnum = {
61
55
  Lexical: 'lexical',
62
- Literal: 'literal',
63
- Semantic: 'semantic',
64
- Hybrid: 'hybrid'
56
+ Literal: 'literal'
65
57
  } as const;
66
58
  export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
67
59
 
@@ -72,7 +64,6 @@ export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchType
72
64
  export function instanceOfHitMatch(value: object): value is HitMatch {
73
65
  if (!('type' in value) || value['type'] === undefined) return false;
74
66
  if (!('lexical_rank' in value) || value['lexical_rank'] === undefined) return false;
75
- if (!('semantic_rank' in value) || value['semantic_rank'] === undefined) return false;
76
67
  if (!('spans' in value) || value['spans'] === undefined) return false;
77
68
  return true;
78
69
  }
@@ -89,7 +80,6 @@ export function HitMatchFromJSONTyped(json: any, ignoreDiscriminator: boolean):
89
80
 
90
81
  'type': json['type'],
91
82
  'lexical_rank': json['lexical_rank'],
92
- 'semantic_rank': json['semantic_rank'],
93
83
  'spans': ((json['spans'] as Array<any>).map(MatchSpanFromJSON)),
94
84
  };
95
85
  }
@@ -107,7 +97,6 @@ export function HitMatchToJSONTyped(value?: HitMatch | null, ignoreDiscriminator
107
97
 
108
98
  'type': value['type'],
109
99
  'lexical_rank': value['lexical_rank'],
110
- 'semantic_rank': value['semantic_rank'],
111
100
  'spans': ((value['spans'] as Array<any>).map(MatchSpanToJSON)),
112
101
  };
113
102
  }
@@ -22,7 +22,7 @@ import {
22
22
  } from './SearchCoverageLeg';
23
23
 
24
24
  /**
25
- * How much of the searched scope the mode's indexes cover
25
+ * How much of the searched scope the text index covers
26
26
  * @export
27
27
  * @interface SearchCoverage
28
28
  */
@@ -39,12 +39,6 @@ export interface SearchCoverage {
39
39
  * @memberof SearchCoverage
40
40
  */
41
41
  lexical: SearchCoverageLeg | null;
42
- /**
43
- *
44
- * @type {SearchCoverageLeg}
45
- * @memberof SearchCoverage
46
- */
47
- semantic: SearchCoverageLeg | null;
48
42
  /**
49
43
  * Why the answer may be incomplete
50
44
  * @type {Array<SearchCoverageReasonsEnum>}
@@ -70,10 +64,6 @@ export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEn
70
64
  export const SearchCoverageReasonsEnum = {
71
65
  LexicalBackfillPending: 'lexical_backfill_pending',
72
66
  ProjectionFailed: 'projection_failed',
73
- SemanticIndexMissing: 'semantic_index_missing',
74
- SemanticBackfillPending: 'semantic_backfill_pending',
75
- LexicalUnavailable: 'lexical_unavailable',
76
- SemanticUnavailable: 'semantic_unavailable',
77
67
  CoverageUnavailable: 'coverage_unavailable'
78
68
  } as const;
79
69
  export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
@@ -85,7 +75,6 @@ export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof t
85
75
  export function instanceOfSearchCoverage(value: object): value is SearchCoverage {
86
76
  if (!('completeness' in value) || value['completeness'] === undefined) return false;
87
77
  if (!('lexical' in value) || value['lexical'] === undefined) return false;
88
- if (!('semantic' in value) || value['semantic'] === undefined) return false;
89
78
  if (!('reasons' in value) || value['reasons'] === undefined) return false;
90
79
  return true;
91
80
  }
@@ -102,7 +91,6 @@ export function SearchCoverageFromJSONTyped(json: any, ignoreDiscriminator: bool
102
91
 
103
92
  'completeness': json['completeness'],
104
93
  'lexical': SearchCoverageLegFromJSON(json['lexical']),
105
- 'semantic': SearchCoverageLegFromJSON(json['semantic']),
106
94
  'reasons': json['reasons'],
107
95
  };
108
96
  }
@@ -120,7 +108,6 @@ export function SearchCoverageToJSONTyped(value?: SearchCoverage | null, ignoreD
120
108
 
121
109
  'completeness': value['completeness'],
122
110
  'lexical': SearchCoverageLegToJSON(value['lexical']),
123
- 'semantic': SearchCoverageLegToJSON(value['semantic']),
124
111
  'reasons': value['reasons'],
125
112
  };
126
113
  }
@@ -14,7 +14,7 @@
14
14
 
15
15
  import { mapValues } from '../runtime';
16
16
  /**
17
- * The keyword index (lexical / literal / hybrid); null when the mode did not use it
17
+ * The text index (lexical and literal); null when the counts could not be read
18
18
  * @export
19
19
  * @interface SearchCoverageLeg
20
20
  */