@invinite-org/data-api-client 0.3.0 → 0.4.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.
- package/.openapi-generator/FILES +12 -0
- package/dist/apis/EarningsCallsApi.d.ts +46 -6
- package/dist/apis/EarningsCallsApi.js +51 -7
- package/dist/esm/apis/EarningsCallsApi.d.ts +46 -6
- package/dist/esm/apis/EarningsCallsApi.js +50 -6
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
- package/dist/esm/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +78 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +18 -0
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
- package/dist/esm/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +23 -0
- package/dist/esm/models/EarningsCallsSearch200Response.js +18 -0
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
- package/dist/esm/models/EarningsCallsSlides200Response.d.ts +7 -0
- package/dist/esm/models/EarningsCallsSlides200Response.js +5 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
- package/dist/esm/models/EarningsCallsSlides200ResponseTimelineInner.js +47 -0
- package/dist/esm/models/HitMatch.d.ts +61 -0
- package/dist/esm/models/HitMatch.js +65 -0
- package/dist/esm/models/MatchSpan.d.ts +38 -0
- package/dist/esm/models/MatchSpan.js +47 -0
- package/dist/esm/models/SearchCoverage.d.ts +73 -0
- package/dist/esm/models/SearchCoverage.js +76 -0
- package/dist/esm/models/SearchCoverageLeg.d.ts +59 -0
- package/dist/esm/models/SearchCoverageLeg.js +63 -0
- package/dist/esm/models/index.d.ts +6 -0
- package/dist/esm/models/index.js +6 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.d.ts +82 -0
- package/dist/models/EarningsCallsCalendar200ResponseEventsInnerVideo.js +86 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +23 -0
- package/dist/models/EarningsCallsDocumentSearch200Response.js +19 -0
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.js +13 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsEvents200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.d.ts +7 -0
- package/dist/models/EarningsCallsLive200ResponseEventsInner.js +5 -0
- package/dist/models/EarningsCallsSearch200Response.d.ts +23 -0
- package/dist/models/EarningsCallsSearch200Response.js +19 -0
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +21 -2
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.js +13 -0
- package/dist/models/EarningsCallsSlides200Response.d.ts +7 -0
- package/dist/models/EarningsCallsSlides200Response.js +5 -0
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.d.ts +38 -0
- package/dist/models/EarningsCallsSlides200ResponseTimelineInner.js +54 -0
- package/dist/models/HitMatch.d.ts +61 -0
- package/dist/models/HitMatch.js +73 -0
- package/dist/models/MatchSpan.d.ts +38 -0
- package/dist/models/MatchSpan.js +54 -0
- package/dist/models/SearchCoverage.d.ts +73 -0
- package/dist/models/SearchCoverage.js +84 -0
- package/dist/models/SearchCoverageLeg.d.ts +59 -0
- package/dist/models/SearchCoverageLeg.js +71 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/docs/EarningsCallsApi.md +22 -10
- package/docs/EarningsCallsCalendar200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md +49 -0
- package/docs/EarningsCallsDocumentSearch200Response.md +4 -0
- package/docs/EarningsCallsDocumentSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsEvents200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsLive200ResponseEventsInner.md +2 -0
- package/docs/EarningsCallsSearch200Response.md +4 -0
- package/docs/EarningsCallsSearch200ResponseHitsInner.md +6 -0
- package/docs/EarningsCallsSlides200Response.md +2 -0
- package/docs/EarningsCallsSlides200ResponseTimelineInner.md +36 -0
- package/docs/HitMatch.md +41 -0
- package/docs/MatchSpan.md +36 -0
- package/docs/SearchCoverage.md +41 -0
- package/docs/SearchCoverageLeg.md +41 -0
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +62 -6
- package/src/models/EarningsCallsCalendar200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts +140 -0
- package/src/models/EarningsCallsDocumentSearch200Response.ts +38 -0
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +37 -2
- package/src/models/EarningsCallsEvents200ResponseEventsInner.ts +16 -0
- package/src/models/EarningsCallsLive200ResponseEventsInner.ts +17 -0
- package/src/models/EarningsCallsSearch200Response.ts +38 -0
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +36 -2
- package/src/models/EarningsCallsSlides200Response.ts +16 -0
- package/src/models/EarningsCallsSlides200ResponseTimelineInner.ts +75 -0
- package/src/models/HitMatch.ts +114 -0
- package/src/models/MatchSpan.ts +75 -0
- package/src/models/SearchCoverage.ts +127 -0
- package/src/models/SearchCoverageLeg.ts +105 -0
- package/src/models/index.ts +6 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -54,6 +54,7 @@ docs/EarningsCallsApi.md
|
|
|
54
54
|
docs/EarningsCallsAudio200Response.md
|
|
55
55
|
docs/EarningsCallsCalendar200Response.md
|
|
56
56
|
docs/EarningsCallsCalendar200ResponseEventsInner.md
|
|
57
|
+
docs/EarningsCallsCalendar200ResponseEventsInnerVideo.md
|
|
57
58
|
docs/EarningsCallsCompanyDocument200Response.md
|
|
58
59
|
docs/EarningsCallsCompanyDocuments200Response.md
|
|
59
60
|
docs/EarningsCallsCompanyDocuments200ResponseCompany.md
|
|
@@ -112,6 +113,7 @@ docs/EarningsCallsSearch200ResponseHitsInnerSlide.md
|
|
|
112
113
|
docs/EarningsCallsSlides200Response.md
|
|
113
114
|
docs/EarningsCallsSlides200ResponseDeck.md
|
|
114
115
|
docs/EarningsCallsSlides200ResponseSlidesInner.md
|
|
116
|
+
docs/EarningsCallsSlides200ResponseTimelineInner.md
|
|
115
117
|
docs/EarningsCallsTranscript200Response.md
|
|
116
118
|
docs/EarningsCallsTranscript404Response.md
|
|
117
119
|
docs/EarningsCallsTranscriptDiff200Response.md
|
|
@@ -137,6 +139,7 @@ docs/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.md
|
|
|
137
139
|
docs/ForbiddenError.md
|
|
138
140
|
docs/HealthApi.md
|
|
139
141
|
docs/HealthGet200Response.md
|
|
142
|
+
docs/HitMatch.md
|
|
140
143
|
docs/IPOsApi.md
|
|
141
144
|
docs/InsiderTradesApi.md
|
|
142
145
|
docs/InsiderTradesList200Response.md
|
|
@@ -155,6 +158,7 @@ docs/IposList200ResponseIposInner.md
|
|
|
155
158
|
docs/MarketApi.md
|
|
156
159
|
docs/MarketHolidays200Response.md
|
|
157
160
|
docs/MarketHolidays200ResponseHolidaysInner.md
|
|
161
|
+
docs/MatchSpan.md
|
|
158
162
|
docs/MetadataApi.md
|
|
159
163
|
docs/MetadataAvailableMetrics200Response.md
|
|
160
164
|
docs/MetadataAvailableMetrics200ResponseMetricsInner.md
|
|
@@ -164,6 +168,8 @@ docs/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.md
|
|
|
164
168
|
docs/NotFoundError.md
|
|
165
169
|
docs/PresentationFact.md
|
|
166
170
|
docs/SECFilingsApi.md
|
|
171
|
+
docs/SearchCoverage.md
|
|
172
|
+
docs/SearchCoverageLeg.md
|
|
167
173
|
docs/SecFilingsAvailableFormTypes200Response.md
|
|
168
174
|
docs/SecFilingsList200Response.md
|
|
169
175
|
docs/SecFilingsList200ResponseCompaniesInner.md
|
|
@@ -314,6 +320,7 @@ src/models/EarningsCallsAnalysts200ResponseAnalystsInner.ts
|
|
|
314
320
|
src/models/EarningsCallsAudio200Response.ts
|
|
315
321
|
src/models/EarningsCallsCalendar200Response.ts
|
|
316
322
|
src/models/EarningsCallsCalendar200ResponseEventsInner.ts
|
|
323
|
+
src/models/EarningsCallsCalendar200ResponseEventsInnerVideo.ts
|
|
317
324
|
src/models/EarningsCallsCompanyDocument200Response.ts
|
|
318
325
|
src/models/EarningsCallsCompanyDocuments200Response.ts
|
|
319
326
|
src/models/EarningsCallsCompanyDocuments200ResponseCompany.ts
|
|
@@ -372,6 +379,7 @@ src/models/EarningsCallsSearch200ResponseHitsInnerSlide.ts
|
|
|
372
379
|
src/models/EarningsCallsSlides200Response.ts
|
|
373
380
|
src/models/EarningsCallsSlides200ResponseDeck.ts
|
|
374
381
|
src/models/EarningsCallsSlides200ResponseSlidesInner.ts
|
|
382
|
+
src/models/EarningsCallsSlides200ResponseTimelineInner.ts
|
|
375
383
|
src/models/EarningsCallsTranscript200Response.ts
|
|
376
384
|
src/models/EarningsCallsTranscript404Response.ts
|
|
377
385
|
src/models/EarningsCallsTranscriptDiff200Response.ts
|
|
@@ -395,6 +403,7 @@ src/models/FinancialMetricsRatios200ResponseCompaniesInner.ts
|
|
|
395
403
|
src/models/FinancialMetricsRatios200ResponseCompaniesInnerPeriodsInner.ts
|
|
396
404
|
src/models/ForbiddenError.ts
|
|
397
405
|
src/models/HealthGet200Response.ts
|
|
406
|
+
src/models/HitMatch.ts
|
|
398
407
|
src/models/InsiderTradesList200Response.ts
|
|
399
408
|
src/models/InsiderTradesList200ResponseTransactionsInner.ts
|
|
400
409
|
src/models/InstitutionalOwnershipHoldingsByCompany200Response.ts
|
|
@@ -409,6 +418,7 @@ src/models/IposList200Response.ts
|
|
|
409
418
|
src/models/IposList200ResponseIposInner.ts
|
|
410
419
|
src/models/MarketHolidays200Response.ts
|
|
411
420
|
src/models/MarketHolidays200ResponseHolidaysInner.ts
|
|
421
|
+
src/models/MatchSpan.ts
|
|
412
422
|
src/models/MetadataAvailableMetrics200Response.ts
|
|
413
423
|
src/models/MetadataAvailableMetrics200ResponseMetricsInner.ts
|
|
414
424
|
src/models/MetadataAvailableSectionIds200Response.ts
|
|
@@ -416,6 +426,8 @@ src/models/MetadataAvailableSectionIds200ResponseFormTypesInner.ts
|
|
|
416
426
|
src/models/MetadataAvailableSectionIds200ResponseFormTypesInnerSectionsInner.ts
|
|
417
427
|
src/models/NotFoundError.ts
|
|
418
428
|
src/models/PresentationFact.ts
|
|
429
|
+
src/models/SearchCoverage.ts
|
|
430
|
+
src/models/SearchCoverageLeg.ts
|
|
419
431
|
src/models/SecFilingsAvailableFormTypes200Response.ts
|
|
420
432
|
src/models/SecFilingsList200Response.ts
|
|
421
433
|
src/models/SecFilingsList200ResponseCompaniesInner.ts
|
|
@@ -98,6 +98,8 @@ export interface EarningsCallsDiffRequest {
|
|
|
98
98
|
}
|
|
99
99
|
export interface EarningsCallsDocumentSearchRequest {
|
|
100
100
|
q: string;
|
|
101
|
+
mode?: EarningsCallsDocumentSearchModeEnum;
|
|
102
|
+
caseSensitive?: EarningsCallsDocumentSearchCaseSensitiveEnum;
|
|
101
103
|
identifier?: string;
|
|
102
104
|
kind?: Array<string>;
|
|
103
105
|
section?: Array<string>;
|
|
@@ -221,6 +223,8 @@ export interface EarningsCallsQaRequest {
|
|
|
221
223
|
}
|
|
222
224
|
export interface EarningsCallsSearchRequest {
|
|
223
225
|
q: string;
|
|
226
|
+
mode?: EarningsCallsSearchModeEnum;
|
|
227
|
+
caseSensitive?: EarningsCallsSearchCaseSensitiveEnum;
|
|
224
228
|
eventId?: string;
|
|
225
229
|
identifier?: string;
|
|
226
230
|
from?: Date;
|
|
@@ -380,12 +384,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
380
384
|
*/
|
|
381
385
|
earningsCallsDocumentSearchRequestOpts(requestParameters: EarningsCallsDocumentSearchRequest): Promise<runtime.RequestOpts>;
|
|
382
386
|
/**
|
|
383
|
-
*
|
|
387
|
+
* 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.
|
|
384
388
|
* Search investor documents
|
|
385
389
|
*/
|
|
386
390
|
earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>>;
|
|
387
391
|
/**
|
|
388
|
-
*
|
|
392
|
+
* 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.
|
|
389
393
|
* Search investor documents
|
|
390
394
|
*/
|
|
391
395
|
earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response>;
|
|
@@ -590,12 +594,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
590
594
|
*/
|
|
591
595
|
earningsCallsSearchRequestOpts(requestParameters: EarningsCallsSearchRequest): Promise<runtime.RequestOpts>;
|
|
592
596
|
/**
|
|
593
|
-
* \"Ask this call\":
|
|
597
|
+
* \"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.
|
|
594
598
|
* Search earnings calls
|
|
595
599
|
*/
|
|
596
600
|
earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>>;
|
|
597
601
|
/**
|
|
598
|
-
* \"Ask this call\":
|
|
602
|
+
* \"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.
|
|
599
603
|
* Search earnings calls
|
|
600
604
|
*/
|
|
601
605
|
earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response>;
|
|
@@ -604,12 +608,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
604
608
|
*/
|
|
605
609
|
earningsCallsSlidesRequestOpts(requestParameters: EarningsCallsSlidesRequest): Promise<runtime.RequestOpts>;
|
|
606
610
|
/**
|
|
607
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
611
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
608
612
|
* Earnings call slides
|
|
609
613
|
*/
|
|
610
614
|
earningsCallsSlidesRaw(requestParameters: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSlides200Response>>;
|
|
611
615
|
/**
|
|
612
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
616
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
613
617
|
* Earnings call slides
|
|
614
618
|
*/
|
|
615
619
|
earningsCallsSlides(requestParameters?: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSlides200Response>;
|
|
@@ -831,6 +835,24 @@ export declare const EarningsCallsDiffVsEnum: {
|
|
|
831
835
|
readonly Prior: "prior";
|
|
832
836
|
};
|
|
833
837
|
export type EarningsCallsDiffVsEnum = typeof EarningsCallsDiffVsEnum[keyof typeof EarningsCallsDiffVsEnum];
|
|
838
|
+
/**
|
|
839
|
+
* @export
|
|
840
|
+
*/
|
|
841
|
+
export declare const EarningsCallsDocumentSearchModeEnum: {
|
|
842
|
+
readonly Lexical: "lexical";
|
|
843
|
+
readonly Literal: "literal";
|
|
844
|
+
readonly Semantic: "semantic";
|
|
845
|
+
readonly Hybrid: "hybrid";
|
|
846
|
+
};
|
|
847
|
+
export type EarningsCallsDocumentSearchModeEnum = typeof EarningsCallsDocumentSearchModeEnum[keyof typeof EarningsCallsDocumentSearchModeEnum];
|
|
848
|
+
/**
|
|
849
|
+
* @export
|
|
850
|
+
*/
|
|
851
|
+
export declare const EarningsCallsDocumentSearchCaseSensitiveEnum: {
|
|
852
|
+
readonly True: "true";
|
|
853
|
+
readonly False: "false";
|
|
854
|
+
};
|
|
855
|
+
export type EarningsCallsDocumentSearchCaseSensitiveEnum = typeof EarningsCallsDocumentSearchCaseSensitiveEnum[keyof typeof EarningsCallsDocumentSearchCaseSensitiveEnum];
|
|
834
856
|
/**
|
|
835
857
|
* @export
|
|
836
858
|
*/
|
|
@@ -1026,6 +1048,24 @@ export declare const EarningsCallsQaIncludeEnum: {
|
|
|
1026
1048
|
readonly Scores: "scores";
|
|
1027
1049
|
};
|
|
1028
1050
|
export type EarningsCallsQaIncludeEnum = typeof EarningsCallsQaIncludeEnum[keyof typeof EarningsCallsQaIncludeEnum];
|
|
1051
|
+
/**
|
|
1052
|
+
* @export
|
|
1053
|
+
*/
|
|
1054
|
+
export declare const EarningsCallsSearchModeEnum: {
|
|
1055
|
+
readonly Lexical: "lexical";
|
|
1056
|
+
readonly Literal: "literal";
|
|
1057
|
+
readonly Semantic: "semantic";
|
|
1058
|
+
readonly Hybrid: "hybrid";
|
|
1059
|
+
};
|
|
1060
|
+
export type EarningsCallsSearchModeEnum = typeof EarningsCallsSearchModeEnum[keyof typeof EarningsCallsSearchModeEnum];
|
|
1061
|
+
/**
|
|
1062
|
+
* @export
|
|
1063
|
+
*/
|
|
1064
|
+
export declare const EarningsCallsSearchCaseSensitiveEnum: {
|
|
1065
|
+
readonly True: "true";
|
|
1066
|
+
readonly False: "false";
|
|
1067
|
+
};
|
|
1068
|
+
export type EarningsCallsSearchCaseSensitiveEnum = typeof EarningsCallsSearchCaseSensitiveEnum[keyof typeof EarningsCallsSearchCaseSensitiveEnum];
|
|
1029
1069
|
/**
|
|
1030
1070
|
* @export
|
|
1031
1071
|
*/
|
|
@@ -22,7 +22,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
|
|
|
22
22
|
});
|
|
23
23
|
};
|
|
24
24
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
-
exports.EarningsCallsTranscriptVersionsEventTypeEnum = exports.EarningsCallsTranscriptDiffEventTypeEnum = exports.EarningsCallsTranscriptFormatEnum = exports.EarningsCallsTranscriptEventTypeEnum = exports.EarningsCallsSlidesEventTypeEnum = exports.EarningsCallsSearchTypeEnum = exports.EarningsCallsQaIncludeEnum = exports.EarningsCallsQaEventTypeEnum = exports.EarningsCallsProsodySectionEnum = exports.EarningsCallsProsodyEventTypeEnum = exports.EarningsCallsPriceAttributionEventTypeEnum = exports.EarningsCallsPressReleaseIncludeEnum = exports.EarningsCallsPressReleaseEventTypeEnum = exports.EarningsCallsParticipantsIncludeEnum = exports.EarningsCallsParticipantsEventTypeEnum = exports.EarningsCallsMetricsEventTypeEnum = exports.EarningsCallsLiveStreamEventTypeEnum = exports.EarningsCallsGuidanceHistoryBasisEnum = exports.EarningsCallsGuidanceHistoryPeriodKindEnum = exports.EarningsCallsExtractionsReviewEnum = exports.EarningsCallsExtractionsKindEnum = exports.EarningsCallsExtractionsEventTypeEnum = exports.EarningsCallsEventsSortEnum = exports.EarningsCallsEventsIncludeEnum = exports.EarningsCallsEventIncludeEnum = exports.EarningsCallsDocumentsEventTypeEnum = exports.EarningsCallsDocumentSearchTableEnum = exports.EarningsCallsDiffVsEnum = exports.EarningsCallsDiffEventTypeEnum = exports.EarningsCallsCompanyDocumentsIncludeEnum = exports.EarningsCallsCompanyDocumentsPeriodEnum = exports.EarningsCallsCalendarSortEnum = exports.EarningsCallsCalendarSessionEnum = exports.EarningsCallsCalendarStatusEnum = exports.EarningsCallsAudioEventTypeEnum = exports.EarningsCallsApi = void 0;
|
|
25
|
+
exports.EarningsCallsTranscriptVersionsEventTypeEnum = exports.EarningsCallsTranscriptDiffEventTypeEnum = exports.EarningsCallsTranscriptFormatEnum = exports.EarningsCallsTranscriptEventTypeEnum = exports.EarningsCallsSlidesEventTypeEnum = exports.EarningsCallsSearchTypeEnum = exports.EarningsCallsSearchCaseSensitiveEnum = exports.EarningsCallsSearchModeEnum = exports.EarningsCallsQaIncludeEnum = exports.EarningsCallsQaEventTypeEnum = exports.EarningsCallsProsodySectionEnum = exports.EarningsCallsProsodyEventTypeEnum = exports.EarningsCallsPriceAttributionEventTypeEnum = exports.EarningsCallsPressReleaseIncludeEnum = exports.EarningsCallsPressReleaseEventTypeEnum = exports.EarningsCallsParticipantsIncludeEnum = exports.EarningsCallsParticipantsEventTypeEnum = exports.EarningsCallsMetricsEventTypeEnum = exports.EarningsCallsLiveStreamEventTypeEnum = exports.EarningsCallsGuidanceHistoryBasisEnum = exports.EarningsCallsGuidanceHistoryPeriodKindEnum = exports.EarningsCallsExtractionsReviewEnum = exports.EarningsCallsExtractionsKindEnum = exports.EarningsCallsExtractionsEventTypeEnum = exports.EarningsCallsEventsSortEnum = exports.EarningsCallsEventsIncludeEnum = exports.EarningsCallsEventIncludeEnum = exports.EarningsCallsDocumentsEventTypeEnum = exports.EarningsCallsDocumentSearchTableEnum = exports.EarningsCallsDocumentSearchCaseSensitiveEnum = exports.EarningsCallsDocumentSearchModeEnum = exports.EarningsCallsDiffVsEnum = exports.EarningsCallsDiffEventTypeEnum = exports.EarningsCallsCompanyDocumentsIncludeEnum = exports.EarningsCallsCompanyDocumentsPeriodEnum = exports.EarningsCallsCalendarSortEnum = exports.EarningsCallsCalendarSessionEnum = exports.EarningsCallsCalendarStatusEnum = exports.EarningsCallsAudioEventTypeEnum = exports.EarningsCallsApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
27
|
const EarningsCallsAnalysts200Response_1 = require("../models/EarningsCallsAnalysts200Response");
|
|
28
28
|
const EarningsCallsAudio200Response_1 = require("../models/EarningsCallsAudio200Response");
|
|
@@ -465,6 +465,12 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
465
465
|
if (requestParameters['q'] != null) {
|
|
466
466
|
queryParameters['q'] = requestParameters['q'];
|
|
467
467
|
}
|
|
468
|
+
if (requestParameters['mode'] != null) {
|
|
469
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
470
|
+
}
|
|
471
|
+
if (requestParameters['caseSensitive'] != null) {
|
|
472
|
+
queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
|
|
473
|
+
}
|
|
468
474
|
if (requestParameters['identifier'] != null) {
|
|
469
475
|
queryParameters['identifier'] = requestParameters['identifier'];
|
|
470
476
|
}
|
|
@@ -501,7 +507,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
501
507
|
});
|
|
502
508
|
}
|
|
503
509
|
/**
|
|
504
|
-
*
|
|
510
|
+
* 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.
|
|
505
511
|
* Search investor documents
|
|
506
512
|
*/
|
|
507
513
|
earningsCallsDocumentSearchRaw(requestParameters, initOverrides) {
|
|
@@ -512,7 +518,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
512
518
|
});
|
|
513
519
|
}
|
|
514
520
|
/**
|
|
515
|
-
*
|
|
521
|
+
* 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.
|
|
516
522
|
* Search investor documents
|
|
517
523
|
*/
|
|
518
524
|
earningsCallsDocumentSearch(requestParameters, initOverrides) {
|
|
@@ -1424,6 +1430,12 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1424
1430
|
if (requestParameters['q'] != null) {
|
|
1425
1431
|
queryParameters['q'] = requestParameters['q'];
|
|
1426
1432
|
}
|
|
1433
|
+
if (requestParameters['mode'] != null) {
|
|
1434
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
1435
|
+
}
|
|
1436
|
+
if (requestParameters['caseSensitive'] != null) {
|
|
1437
|
+
queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
|
|
1438
|
+
}
|
|
1427
1439
|
if (requestParameters['eventId'] != null) {
|
|
1428
1440
|
queryParameters['event_id'] = requestParameters['eventId'];
|
|
1429
1441
|
}
|
|
@@ -1463,7 +1475,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1463
1475
|
});
|
|
1464
1476
|
}
|
|
1465
1477
|
/**
|
|
1466
|
-
* \"Ask this call\":
|
|
1478
|
+
* \"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.
|
|
1467
1479
|
* Search earnings calls
|
|
1468
1480
|
*/
|
|
1469
1481
|
earningsCallsSearchRaw(requestParameters, initOverrides) {
|
|
@@ -1474,7 +1486,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1474
1486
|
});
|
|
1475
1487
|
}
|
|
1476
1488
|
/**
|
|
1477
|
-
* \"Ask this call\":
|
|
1489
|
+
* \"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.
|
|
1478
1490
|
* Search earnings calls
|
|
1479
1491
|
*/
|
|
1480
1492
|
earningsCallsSearch(requestParameters, initOverrides) {
|
|
@@ -1531,7 +1543,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1531
1543
|
});
|
|
1532
1544
|
}
|
|
1533
1545
|
/**
|
|
1534
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
1546
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
1535
1547
|
* Earnings call slides
|
|
1536
1548
|
*/
|
|
1537
1549
|
earningsCallsSlidesRaw(requestParameters, initOverrides) {
|
|
@@ -1542,7 +1554,7 @@ class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1542
1554
|
});
|
|
1543
1555
|
}
|
|
1544
1556
|
/**
|
|
1545
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
1557
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
1546
1558
|
* Earnings call slides
|
|
1547
1559
|
*/
|
|
1548
1560
|
earningsCallsSlides() {
|
|
@@ -2160,6 +2172,22 @@ exports.EarningsCallsDiffEventTypeEnum = {
|
|
|
2160
2172
|
exports.EarningsCallsDiffVsEnum = {
|
|
2161
2173
|
Prior: 'prior'
|
|
2162
2174
|
};
|
|
2175
|
+
/**
|
|
2176
|
+
* @export
|
|
2177
|
+
*/
|
|
2178
|
+
exports.EarningsCallsDocumentSearchModeEnum = {
|
|
2179
|
+
Lexical: 'lexical',
|
|
2180
|
+
Literal: 'literal',
|
|
2181
|
+
Semantic: 'semantic',
|
|
2182
|
+
Hybrid: 'hybrid'
|
|
2183
|
+
};
|
|
2184
|
+
/**
|
|
2185
|
+
* @export
|
|
2186
|
+
*/
|
|
2187
|
+
exports.EarningsCallsDocumentSearchCaseSensitiveEnum = {
|
|
2188
|
+
True: 'true',
|
|
2189
|
+
False: 'false'
|
|
2190
|
+
};
|
|
2163
2191
|
/**
|
|
2164
2192
|
* @export
|
|
2165
2193
|
*/
|
|
@@ -2334,6 +2362,22 @@ exports.EarningsCallsQaEventTypeEnum = {
|
|
|
2334
2362
|
exports.EarningsCallsQaIncludeEnum = {
|
|
2335
2363
|
Scores: 'scores'
|
|
2336
2364
|
};
|
|
2365
|
+
/**
|
|
2366
|
+
* @export
|
|
2367
|
+
*/
|
|
2368
|
+
exports.EarningsCallsSearchModeEnum = {
|
|
2369
|
+
Lexical: 'lexical',
|
|
2370
|
+
Literal: 'literal',
|
|
2371
|
+
Semantic: 'semantic',
|
|
2372
|
+
Hybrid: 'hybrid'
|
|
2373
|
+
};
|
|
2374
|
+
/**
|
|
2375
|
+
* @export
|
|
2376
|
+
*/
|
|
2377
|
+
exports.EarningsCallsSearchCaseSensitiveEnum = {
|
|
2378
|
+
True: 'true',
|
|
2379
|
+
False: 'false'
|
|
2380
|
+
};
|
|
2337
2381
|
/**
|
|
2338
2382
|
* @export
|
|
2339
2383
|
*/
|
|
@@ -98,6 +98,8 @@ export interface EarningsCallsDiffRequest {
|
|
|
98
98
|
}
|
|
99
99
|
export interface EarningsCallsDocumentSearchRequest {
|
|
100
100
|
q: string;
|
|
101
|
+
mode?: EarningsCallsDocumentSearchModeEnum;
|
|
102
|
+
caseSensitive?: EarningsCallsDocumentSearchCaseSensitiveEnum;
|
|
101
103
|
identifier?: string;
|
|
102
104
|
kind?: Array<string>;
|
|
103
105
|
section?: Array<string>;
|
|
@@ -221,6 +223,8 @@ export interface EarningsCallsQaRequest {
|
|
|
221
223
|
}
|
|
222
224
|
export interface EarningsCallsSearchRequest {
|
|
223
225
|
q: string;
|
|
226
|
+
mode?: EarningsCallsSearchModeEnum;
|
|
227
|
+
caseSensitive?: EarningsCallsSearchCaseSensitiveEnum;
|
|
224
228
|
eventId?: string;
|
|
225
229
|
identifier?: string;
|
|
226
230
|
from?: Date;
|
|
@@ -380,12 +384,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
380
384
|
*/
|
|
381
385
|
earningsCallsDocumentSearchRequestOpts(requestParameters: EarningsCallsDocumentSearchRequest): Promise<runtime.RequestOpts>;
|
|
382
386
|
/**
|
|
383
|
-
*
|
|
387
|
+
* 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.
|
|
384
388
|
* Search investor documents
|
|
385
389
|
*/
|
|
386
390
|
earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>>;
|
|
387
391
|
/**
|
|
388
|
-
*
|
|
392
|
+
* 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.
|
|
389
393
|
* Search investor documents
|
|
390
394
|
*/
|
|
391
395
|
earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response>;
|
|
@@ -590,12 +594,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
590
594
|
*/
|
|
591
595
|
earningsCallsSearchRequestOpts(requestParameters: EarningsCallsSearchRequest): Promise<runtime.RequestOpts>;
|
|
592
596
|
/**
|
|
593
|
-
* \"Ask this call\":
|
|
597
|
+
* \"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.
|
|
594
598
|
* Search earnings calls
|
|
595
599
|
*/
|
|
596
600
|
earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>>;
|
|
597
601
|
/**
|
|
598
|
-
* \"Ask this call\":
|
|
602
|
+
* \"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.
|
|
599
603
|
* Search earnings calls
|
|
600
604
|
*/
|
|
601
605
|
earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response>;
|
|
@@ -604,12 +608,12 @@ export declare class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
604
608
|
*/
|
|
605
609
|
earningsCallsSlidesRequestOpts(requestParameters: EarningsCallsSlidesRequest): Promise<runtime.RequestOpts>;
|
|
606
610
|
/**
|
|
607
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
611
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
608
612
|
* Earnings call slides
|
|
609
613
|
*/
|
|
610
614
|
earningsCallsSlidesRaw(requestParameters: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSlides200Response>>;
|
|
611
615
|
/**
|
|
612
|
-
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
616
|
+
* The slide deck of one earnings call (PRO): the deck PDF and each page image as signed URLs, page titles and, with `include=markdown`, each page\'s text. ### Files - Files are served as short-lived signed URLs (see `expires_at`), never proxied; request a fresh response after expiry. - `timeline`: the slides shown in the webcast player, keyed to the call audio (`at_ms` from the start of the recording the audio route serves; the whole call, whatever `pages` asks). ### Errors - `404 slides_unavailable` when no deck is available. - `503 media_unavailable` while media signing is not configured. ### Choose the call - By `event_id`, or - by `identifier` with `year` + `quarter` (fiscal), or - by `identifier` with `date` (a calendar day in New York time (America/New_York); a call without a confirmed time is listed on its announced date). With `date`, `event_type` (default `earnings_call`) also addresses an investor day, conference or shareholder meeting. ### 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.
|
|
613
617
|
* Earnings call slides
|
|
614
618
|
*/
|
|
615
619
|
earningsCallsSlides(requestParameters?: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSlides200Response>;
|
|
@@ -831,6 +835,24 @@ export declare const EarningsCallsDiffVsEnum: {
|
|
|
831
835
|
readonly Prior: "prior";
|
|
832
836
|
};
|
|
833
837
|
export type EarningsCallsDiffVsEnum = typeof EarningsCallsDiffVsEnum[keyof typeof EarningsCallsDiffVsEnum];
|
|
838
|
+
/**
|
|
839
|
+
* @export
|
|
840
|
+
*/
|
|
841
|
+
export declare const EarningsCallsDocumentSearchModeEnum: {
|
|
842
|
+
readonly Lexical: "lexical";
|
|
843
|
+
readonly Literal: "literal";
|
|
844
|
+
readonly Semantic: "semantic";
|
|
845
|
+
readonly Hybrid: "hybrid";
|
|
846
|
+
};
|
|
847
|
+
export type EarningsCallsDocumentSearchModeEnum = typeof EarningsCallsDocumentSearchModeEnum[keyof typeof EarningsCallsDocumentSearchModeEnum];
|
|
848
|
+
/**
|
|
849
|
+
* @export
|
|
850
|
+
*/
|
|
851
|
+
export declare const EarningsCallsDocumentSearchCaseSensitiveEnum: {
|
|
852
|
+
readonly True: "true";
|
|
853
|
+
readonly False: "false";
|
|
854
|
+
};
|
|
855
|
+
export type EarningsCallsDocumentSearchCaseSensitiveEnum = typeof EarningsCallsDocumentSearchCaseSensitiveEnum[keyof typeof EarningsCallsDocumentSearchCaseSensitiveEnum];
|
|
834
856
|
/**
|
|
835
857
|
* @export
|
|
836
858
|
*/
|
|
@@ -1026,6 +1048,24 @@ export declare const EarningsCallsQaIncludeEnum: {
|
|
|
1026
1048
|
readonly Scores: "scores";
|
|
1027
1049
|
};
|
|
1028
1050
|
export type EarningsCallsQaIncludeEnum = typeof EarningsCallsQaIncludeEnum[keyof typeof EarningsCallsQaIncludeEnum];
|
|
1051
|
+
/**
|
|
1052
|
+
* @export
|
|
1053
|
+
*/
|
|
1054
|
+
export declare const EarningsCallsSearchModeEnum: {
|
|
1055
|
+
readonly Lexical: "lexical";
|
|
1056
|
+
readonly Literal: "literal";
|
|
1057
|
+
readonly Semantic: "semantic";
|
|
1058
|
+
readonly Hybrid: "hybrid";
|
|
1059
|
+
};
|
|
1060
|
+
export type EarningsCallsSearchModeEnum = typeof EarningsCallsSearchModeEnum[keyof typeof EarningsCallsSearchModeEnum];
|
|
1061
|
+
/**
|
|
1062
|
+
* @export
|
|
1063
|
+
*/
|
|
1064
|
+
export declare const EarningsCallsSearchCaseSensitiveEnum: {
|
|
1065
|
+
readonly True: "true";
|
|
1066
|
+
readonly False: "false";
|
|
1067
|
+
};
|
|
1068
|
+
export type EarningsCallsSearchCaseSensitiveEnum = typeof EarningsCallsSearchCaseSensitiveEnum[keyof typeof EarningsCallsSearchCaseSensitiveEnum];
|
|
1029
1069
|
/**
|
|
1030
1070
|
* @export
|
|
1031
1071
|
*/
|