@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
|
@@ -254,6 +254,8 @@ export interface EarningsCallsDiffRequest {
|
|
|
254
254
|
|
|
255
255
|
export interface EarningsCallsDocumentSearchRequest {
|
|
256
256
|
q: string;
|
|
257
|
+
mode?: EarningsCallsDocumentSearchModeEnum;
|
|
258
|
+
caseSensitive?: EarningsCallsDocumentSearchCaseSensitiveEnum;
|
|
257
259
|
identifier?: string;
|
|
258
260
|
kind?: Array<string>;
|
|
259
261
|
section?: Array<string>;
|
|
@@ -391,6 +393,8 @@ export interface EarningsCallsQaRequest {
|
|
|
391
393
|
|
|
392
394
|
export interface EarningsCallsSearchRequest {
|
|
393
395
|
q: string;
|
|
396
|
+
mode?: EarningsCallsSearchModeEnum;
|
|
397
|
+
caseSensitive?: EarningsCallsSearchCaseSensitiveEnum;
|
|
394
398
|
eventId?: string;
|
|
395
399
|
identifier?: string;
|
|
396
400
|
from?: Date;
|
|
@@ -950,6 +954,14 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
950
954
|
queryParameters['q'] = requestParameters['q'];
|
|
951
955
|
}
|
|
952
956
|
|
|
957
|
+
if (requestParameters['mode'] != null) {
|
|
958
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
959
|
+
}
|
|
960
|
+
|
|
961
|
+
if (requestParameters['caseSensitive'] != null) {
|
|
962
|
+
queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
|
|
963
|
+
}
|
|
964
|
+
|
|
953
965
|
if (requestParameters['identifier'] != null) {
|
|
954
966
|
queryParameters['identifier'] = requestParameters['identifier'];
|
|
955
967
|
}
|
|
@@ -996,7 +1008,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
996
1008
|
}
|
|
997
1009
|
|
|
998
1010
|
/**
|
|
999
|
-
*
|
|
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.
|
|
1000
1012
|
* Search investor documents
|
|
1001
1013
|
*/
|
|
1002
1014
|
async earningsCallsDocumentSearchRaw(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsDocumentSearch200Response>> {
|
|
@@ -1007,7 +1019,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
1007
1019
|
}
|
|
1008
1020
|
|
|
1009
1021
|
/**
|
|
1010
|
-
*
|
|
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.
|
|
1011
1023
|
* Search investor documents
|
|
1012
1024
|
*/
|
|
1013
1025
|
async earningsCallsDocumentSearch(requestParameters: EarningsCallsDocumentSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsDocumentSearch200Response> {
|
|
@@ -2071,6 +2083,14 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2071
2083
|
queryParameters['q'] = requestParameters['q'];
|
|
2072
2084
|
}
|
|
2073
2085
|
|
|
2086
|
+
if (requestParameters['mode'] != null) {
|
|
2087
|
+
queryParameters['mode'] = requestParameters['mode'];
|
|
2088
|
+
}
|
|
2089
|
+
|
|
2090
|
+
if (requestParameters['caseSensitive'] != null) {
|
|
2091
|
+
queryParameters['case_sensitive'] = requestParameters['caseSensitive'];
|
|
2092
|
+
}
|
|
2093
|
+
|
|
2074
2094
|
if (requestParameters['eventId'] != null) {
|
|
2075
2095
|
queryParameters['event_id'] = requestParameters['eventId'];
|
|
2076
2096
|
}
|
|
@@ -2121,7 +2141,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2121
2141
|
}
|
|
2122
2142
|
|
|
2123
2143
|
/**
|
|
2124
|
-
* \"Ask this call\":
|
|
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.
|
|
2125
2145
|
* Search earnings calls
|
|
2126
2146
|
*/
|
|
2127
2147
|
async earningsCallsSearchRaw(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSearch200Response>> {
|
|
@@ -2132,7 +2152,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2132
2152
|
}
|
|
2133
2153
|
|
|
2134
2154
|
/**
|
|
2135
|
-
* \"Ask this call\":
|
|
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.
|
|
2136
2156
|
* Search earnings calls
|
|
2137
2157
|
*/
|
|
2138
2158
|
async earningsCallsSearch(requestParameters: EarningsCallsSearchRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSearch200Response> {
|
|
@@ -2200,7 +2220,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2200
2220
|
}
|
|
2201
2221
|
|
|
2202
2222
|
/**
|
|
2203
|
-
* 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.
|
|
2223
|
+
* 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.
|
|
2204
2224
|
* Earnings call slides
|
|
2205
2225
|
*/
|
|
2206
2226
|
async earningsCallsSlidesRaw(requestParameters: EarningsCallsSlidesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EarningsCallsSlides200Response>> {
|
|
@@ -2211,7 +2231,7 @@ export class EarningsCallsApi extends runtime.BaseAPI {
|
|
|
2211
2231
|
}
|
|
2212
2232
|
|
|
2213
2233
|
/**
|
|
2214
|
-
* 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.
|
|
2234
|
+
* 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.
|
|
2215
2235
|
* Earnings call slides
|
|
2216
2236
|
*/
|
|
2217
2237
|
async earningsCallsSlides(requestParameters: EarningsCallsSlidesRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EarningsCallsSlides200Response> {
|
|
@@ -2919,6 +2939,24 @@ export const EarningsCallsDiffVsEnum = {
|
|
|
2919
2939
|
Prior: 'prior'
|
|
2920
2940
|
} as const;
|
|
2921
2941
|
export type EarningsCallsDiffVsEnum = typeof EarningsCallsDiffVsEnum[keyof typeof EarningsCallsDiffVsEnum];
|
|
2942
|
+
/**
|
|
2943
|
+
* @export
|
|
2944
|
+
*/
|
|
2945
|
+
export const EarningsCallsDocumentSearchModeEnum = {
|
|
2946
|
+
Lexical: 'lexical',
|
|
2947
|
+
Literal: 'literal',
|
|
2948
|
+
Semantic: 'semantic',
|
|
2949
|
+
Hybrid: 'hybrid'
|
|
2950
|
+
} as const;
|
|
2951
|
+
export type EarningsCallsDocumentSearchModeEnum = typeof EarningsCallsDocumentSearchModeEnum[keyof typeof EarningsCallsDocumentSearchModeEnum];
|
|
2952
|
+
/**
|
|
2953
|
+
* @export
|
|
2954
|
+
*/
|
|
2955
|
+
export const EarningsCallsDocumentSearchCaseSensitiveEnum = {
|
|
2956
|
+
True: 'true',
|
|
2957
|
+
False: 'false'
|
|
2958
|
+
} as const;
|
|
2959
|
+
export type EarningsCallsDocumentSearchCaseSensitiveEnum = typeof EarningsCallsDocumentSearchCaseSensitiveEnum[keyof typeof EarningsCallsDocumentSearchCaseSensitiveEnum];
|
|
2922
2960
|
/**
|
|
2923
2961
|
* @export
|
|
2924
2962
|
*/
|
|
@@ -3114,6 +3152,24 @@ export const EarningsCallsQaIncludeEnum = {
|
|
|
3114
3152
|
Scores: 'scores'
|
|
3115
3153
|
} as const;
|
|
3116
3154
|
export type EarningsCallsQaIncludeEnum = typeof EarningsCallsQaIncludeEnum[keyof typeof EarningsCallsQaIncludeEnum];
|
|
3155
|
+
/**
|
|
3156
|
+
* @export
|
|
3157
|
+
*/
|
|
3158
|
+
export const EarningsCallsSearchModeEnum = {
|
|
3159
|
+
Lexical: 'lexical',
|
|
3160
|
+
Literal: 'literal',
|
|
3161
|
+
Semantic: 'semantic',
|
|
3162
|
+
Hybrid: 'hybrid'
|
|
3163
|
+
} as const;
|
|
3164
|
+
export type EarningsCallsSearchModeEnum = typeof EarningsCallsSearchModeEnum[keyof typeof EarningsCallsSearchModeEnum];
|
|
3165
|
+
/**
|
|
3166
|
+
* @export
|
|
3167
|
+
*/
|
|
3168
|
+
export const EarningsCallsSearchCaseSensitiveEnum = {
|
|
3169
|
+
True: 'true',
|
|
3170
|
+
False: 'false'
|
|
3171
|
+
} as const;
|
|
3172
|
+
export type EarningsCallsSearchCaseSensitiveEnum = typeof EarningsCallsSearchCaseSensitiveEnum[keyof typeof EarningsCallsSearchCaseSensitiveEnum];
|
|
3117
3173
|
/**
|
|
3118
3174
|
* @export
|
|
3119
3175
|
*/
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
17
|
+
import {
|
|
18
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON,
|
|
19
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped,
|
|
20
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoToJSON,
|
|
21
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped,
|
|
22
|
+
} from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
*
|
|
18
26
|
* @export
|
|
@@ -181,6 +189,12 @@ export interface EarningsCallsCalendar200ResponseEventsInner {
|
|
|
181
189
|
* @memberof EarningsCallsCalendar200ResponseEventsInner
|
|
182
190
|
*/
|
|
183
191
|
webcast_url: string | null;
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
|
|
195
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInner
|
|
196
|
+
*/
|
|
197
|
+
video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
|
|
184
198
|
}
|
|
185
199
|
|
|
186
200
|
|
|
@@ -260,6 +274,7 @@ export function instanceOfEarningsCallsCalendar200ResponseEventsInner(value: obj
|
|
|
260
274
|
if (!('has_press_release' in value) || value['has_press_release'] === undefined) return false;
|
|
261
275
|
if (!('has_documents' in value) || value['has_documents'] === undefined) return false;
|
|
262
276
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined) return false;
|
|
277
|
+
if (!('video' in value) || value['video'] === undefined) return false;
|
|
263
278
|
return true;
|
|
264
279
|
}
|
|
265
280
|
|
|
@@ -300,6 +315,7 @@ export function EarningsCallsCalendar200ResponseEventsInnerFromJSONTyped(json: a
|
|
|
300
315
|
'has_press_release': json['has_press_release'],
|
|
301
316
|
'has_documents': json['has_documents'],
|
|
302
317
|
'webcast_url': json['webcast_url'],
|
|
318
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json['video']),
|
|
303
319
|
};
|
|
304
320
|
}
|
|
305
321
|
|
|
@@ -341,6 +357,7 @@ export function EarningsCallsCalendar200ResponseEventsInnerToJSONTyped(value?: E
|
|
|
341
357
|
'has_press_release': value['has_press_release'],
|
|
342
358
|
'has_documents': value['has_documents'],
|
|
343
359
|
'webcast_url': value['webcast_url'],
|
|
360
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(value['video']),
|
|
344
361
|
};
|
|
345
362
|
}
|
|
346
363
|
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* Invinite API
|
|
5
|
+
* Invinite financial data API. Each endpoint has a base credit cost: `x-credits` is the base cost; responses add 1 credit per started 1,000 rows beyond the first 1,000; `X-Credits-Charged` reports the final debit and `X-Credits-Included-Remaining` what is left of the plan\'s included credits. `GET /v1/account/usage` returns your account\'s usage by day, endpoint family and key (it costs no credits). SEC filing search has a 100-credit base cost. ## Webhooks Accounts on LITE and above subscribe with `POST /v1/earnings-calls/webhooks` to the `earnings_call.*` lifecycle events (filtered by CIK); see `x-webhooks` for each `data` object. What a subscription may hold depends on the plan (a create / update beyond it is refused with the plan\'s limit; `ping` needs no subscription — the test route and the disabled notice send it to any subscription): | Plan | Webhooks | Events | CIKs per webhook | Keywords per webhook | |---|---|---|---|---| | FREE | 0 | — | — | — | | LITE | 5 | `.scheduled`, `.rescheduled`, `.started`, `.ended`, `.transcript_ready`, `.assets_ready` | ≤ 10 | — | | STANDARD | 15 | LITE + `.transcript_provisional`, `.transcript_corrected`, `.documents_updated` | ≤ 25 | — | | PRO / ENTERPRISE | 50 | STANDARD + `.guidance_flash`, `.keyword_hit` | ≤ 100 | ≤ 20 (on ≤ 10 webhooks) | Every delivery is a `POST` with `Content-Type: application/json`, `X-Invinite-Event`, `X-Invinite-Delivery` and `X-Invinite-Signature: t=<unix seconds>,v1=<hex>` where `v1` = HMAC-SHA256(secret, `<t>.<raw body>`); during a secret rotation the header carries one `v1` per valid secret. Reject a signature older than 5 minutes. Any 2xx within 10 s acknowledges; redirects are not followed. A failed delivery is retried after 1 min, 5 min, 30 min, 2 h, 6 h, 12 h, 24 h (8 attempts in all, the same delivery id each time). A subscription is disabled after 8 consecutive dead-lettered deliveries (a final `ping` with `notice: subscription_disabled` is sent). Deliveries are at-least-once and unordered: dedupe on the delivery id, order by `created_at`. ## Licensing | Tier | display | redistribute | rag | train | audio | resell | | --- | --- | --- | --- | --- | --- | --- | | FREE | ✓ | – | – | – | – | – | | LITE | ✓ | – | – | – | – | – | | STANDARD | ✓ | – | ✓ | – | – | – | | PRO | ✓ | ✓ | ✓ | – | ✓ | – | Invinite data may be shown and, from PRO, redistributed inside the licensee\'s own product with attribution (\"Source: Invinite\" on screen or in the API response that carries it). It may never be resold, relicensed, white-labelled or offered as a data feed as the licensee\'s own data, at any tier, under any contract. Policy version: 2026-10-draft. Draft — pending counsel sign-off. Audio files carry a forensic watermark that identifies the recording. Audio is subject to per-company takedown and may not be re-hosted. SEC data: Figures and filings originate from SEC EDGAR; the standardisation, mapping and derived metrics are Invinite\'s. Every `/v1/_*` data operation carries `x-license`, the minimum use right its data ships with; `GET /status/licensing` serves the same matrix per route, rendered at [data.invinite.com/docs/licensing](https://data.invinite.com/docs/licensing). `/v1/account/usage` serves no licensed data and carries none. ## Status [`/status`](/status) reports whether each product family works (a status and its uptime over 7, 30 and 90 days); [`/status/licensing`](/status/licensing) serves the licensing matrix per route. The status routes need no API key and are cached for 5 minutes. The public status page is [status.data.invinite.com](https://status.data.invinite.com): a snapshot of `/status` every 15 minutes plus an external reachability probe of the API. Uptime is the share of requests answered without a server error, measured by the API per product family; a window with too little traffic to judge shows no figure. Status reflects the last 24 hours. Product families: Company, Financials, SEC Filings, Insider Trades, Institutional Ownership, IPOs, Market, Metadata, Earnings Calls, WebSocket, Account.
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
* The company's public broadcast on a video platform (YouTube, Vimeo). Embed `embed_url` when `embeddable` is not false; otherwise link `url`. Present before, during and after the event; null = none known.
|
|
18
|
+
* @export
|
|
19
|
+
* @interface EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
20
|
+
*/
|
|
21
|
+
export interface EarningsCallsCalendar200ResponseEventsInnerVideo {
|
|
22
|
+
/**
|
|
23
|
+
* Video platform
|
|
24
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum}
|
|
25
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
26
|
+
*/
|
|
27
|
+
provider: EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum;
|
|
28
|
+
/**
|
|
29
|
+
* The platform's video id
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
32
|
+
*/
|
|
33
|
+
video_id: string;
|
|
34
|
+
/**
|
|
35
|
+
* Watch page
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
38
|
+
*/
|
|
39
|
+
url: string;
|
|
40
|
+
/**
|
|
41
|
+
* Privacy-enhanced player URL (YouTube: youtube-nocookie.com; Vimeo: dnt=1)
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
44
|
+
*/
|
|
45
|
+
embed_url: string;
|
|
46
|
+
/**
|
|
47
|
+
* Video title
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
50
|
+
*/
|
|
51
|
+
title: string | null;
|
|
52
|
+
/**
|
|
53
|
+
* Channel or account that published it
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
56
|
+
*/
|
|
57
|
+
channel: string | null;
|
|
58
|
+
/**
|
|
59
|
+
* Thumbnail image
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
62
|
+
*/
|
|
63
|
+
thumbnail_url: string | null;
|
|
64
|
+
/**
|
|
65
|
+
* false = the owner disabled or restricted embedding (link `url`); null = not checked yet
|
|
66
|
+
* @type {boolean}
|
|
67
|
+
* @memberof EarningsCallsCalendar200ResponseEventsInnerVideo
|
|
68
|
+
*/
|
|
69
|
+
embeddable: boolean | null;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
/**
|
|
74
|
+
* @export
|
|
75
|
+
*/
|
|
76
|
+
export const EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum = {
|
|
77
|
+
Youtube: 'youtube',
|
|
78
|
+
Vimeo: 'vimeo'
|
|
79
|
+
} as const;
|
|
80
|
+
export type EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum = typeof EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum[keyof typeof EarningsCallsCalendar200ResponseEventsInnerVideoProviderEnum];
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
/**
|
|
84
|
+
* Check if a given object implements the EarningsCallsCalendar200ResponseEventsInnerVideo interface.
|
|
85
|
+
*/
|
|
86
|
+
export function instanceOfEarningsCallsCalendar200ResponseEventsInnerVideo(value: object): value is EarningsCallsCalendar200ResponseEventsInnerVideo {
|
|
87
|
+
if (!('provider' in value) || value['provider'] === undefined) return false;
|
|
88
|
+
if (!('video_id' in value) || value['video_id'] === undefined) return false;
|
|
89
|
+
if (!('url' in value) || value['url'] === undefined) return false;
|
|
90
|
+
if (!('embed_url' in value) || value['embed_url'] === undefined) return false;
|
|
91
|
+
if (!('title' in value) || value['title'] === undefined) return false;
|
|
92
|
+
if (!('channel' in value) || value['channel'] === undefined) return false;
|
|
93
|
+
if (!('thumbnail_url' in value) || value['thumbnail_url'] === undefined) return false;
|
|
94
|
+
if (!('embeddable' in value) || value['embeddable'] === undefined) return false;
|
|
95
|
+
return true;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerVideo {
|
|
99
|
+
return EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json, false);
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped(json: any, ignoreDiscriminator: boolean): EarningsCallsCalendar200ResponseEventsInnerVideo {
|
|
103
|
+
if (json == null) {
|
|
104
|
+
return json;
|
|
105
|
+
}
|
|
106
|
+
return {
|
|
107
|
+
|
|
108
|
+
'provider': json['provider'],
|
|
109
|
+
'video_id': json['video_id'],
|
|
110
|
+
'url': json['url'],
|
|
111
|
+
'embed_url': json['embed_url'],
|
|
112
|
+
'title': json['title'],
|
|
113
|
+
'channel': json['channel'],
|
|
114
|
+
'thumbnail_url': json['thumbnail_url'],
|
|
115
|
+
'embeddable': json['embeddable'],
|
|
116
|
+
};
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(json: any): EarningsCallsCalendar200ResponseEventsInnerVideo {
|
|
120
|
+
return EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(json, false);
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
export function EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped(value?: EarningsCallsCalendar200ResponseEventsInnerVideo | null, ignoreDiscriminator: boolean = false): any {
|
|
124
|
+
if (value == null) {
|
|
125
|
+
return value;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
return {
|
|
129
|
+
|
|
130
|
+
'provider': value['provider'],
|
|
131
|
+
'video_id': value['video_id'],
|
|
132
|
+
'url': value['url'],
|
|
133
|
+
'embed_url': value['embed_url'],
|
|
134
|
+
'title': value['title'],
|
|
135
|
+
'channel': value['channel'],
|
|
136
|
+
'thumbnail_url': value['thumbnail_url'],
|
|
137
|
+
'embeddable': value['embeddable'],
|
|
138
|
+
};
|
|
139
|
+
}
|
|
140
|
+
|
|
@@ -20,6 +20,13 @@ import {
|
|
|
20
20
|
EarningsCallsDocumentSearch200ResponseHitsInnerToJSON,
|
|
21
21
|
EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped,
|
|
22
22
|
} from './EarningsCallsDocumentSearch200ResponseHitsInner';
|
|
23
|
+
import type { SearchCoverage } from './SearchCoverage';
|
|
24
|
+
import {
|
|
25
|
+
SearchCoverageFromJSON,
|
|
26
|
+
SearchCoverageFromJSONTyped,
|
|
27
|
+
SearchCoverageToJSON,
|
|
28
|
+
SearchCoverageToJSONTyped,
|
|
29
|
+
} from './SearchCoverage';
|
|
23
30
|
|
|
24
31
|
/**
|
|
25
32
|
*
|
|
@@ -33,6 +40,18 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
33
40
|
* @memberof EarningsCallsDocumentSearch200Response
|
|
34
41
|
*/
|
|
35
42
|
query: string;
|
|
43
|
+
/**
|
|
44
|
+
* The mode searched
|
|
45
|
+
* @type {EarningsCallsDocumentSearch200ResponseModeEnum}
|
|
46
|
+
* @memberof EarningsCallsDocumentSearch200Response
|
|
47
|
+
*/
|
|
48
|
+
mode: EarningsCallsDocumentSearch200ResponseModeEnum;
|
|
49
|
+
/**
|
|
50
|
+
*
|
|
51
|
+
* @type {SearchCoverage}
|
|
52
|
+
* @memberof EarningsCallsDocumentSearch200Response
|
|
53
|
+
*/
|
|
54
|
+
coverage: SearchCoverage;
|
|
36
55
|
/**
|
|
37
56
|
* Passages, best first
|
|
38
57
|
* @type {Array<EarningsCallsDocumentSearch200ResponseHitsInner>}
|
|
@@ -41,11 +60,26 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
41
60
|
hits: Array<EarningsCallsDocumentSearch200ResponseHitsInner>;
|
|
42
61
|
}
|
|
43
62
|
|
|
63
|
+
|
|
64
|
+
/**
|
|
65
|
+
* @export
|
|
66
|
+
*/
|
|
67
|
+
export const EarningsCallsDocumentSearch200ResponseModeEnum = {
|
|
68
|
+
Lexical: 'lexical',
|
|
69
|
+
Literal: 'literal',
|
|
70
|
+
Semantic: 'semantic',
|
|
71
|
+
Hybrid: 'hybrid'
|
|
72
|
+
} as const;
|
|
73
|
+
export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
|
|
74
|
+
|
|
75
|
+
|
|
44
76
|
/**
|
|
45
77
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
46
78
|
*/
|
|
47
79
|
export function instanceOfEarningsCallsDocumentSearch200Response(value: object): value is EarningsCallsDocumentSearch200Response {
|
|
48
80
|
if (!('query' in value) || value['query'] === undefined) return false;
|
|
81
|
+
if (!('mode' in value) || value['mode'] === undefined) return false;
|
|
82
|
+
if (!('coverage' in value) || value['coverage'] === undefined) return false;
|
|
49
83
|
if (!('hits' in value) || value['hits'] === undefined) return false;
|
|
50
84
|
return true;
|
|
51
85
|
}
|
|
@@ -61,6 +95,8 @@ export function EarningsCallsDocumentSearch200ResponseFromJSONTyped(json: any, i
|
|
|
61
95
|
return {
|
|
62
96
|
|
|
63
97
|
'query': json['query'],
|
|
98
|
+
'mode': json['mode'],
|
|
99
|
+
'coverage': SearchCoverageFromJSON(json['coverage']),
|
|
64
100
|
'hits': ((json['hits'] as Array<any>).map(EarningsCallsDocumentSearch200ResponseHitsInnerFromJSON)),
|
|
65
101
|
};
|
|
66
102
|
}
|
|
@@ -77,6 +113,8 @@ export function EarningsCallsDocumentSearch200ResponseToJSONTyped(value?: Earnin
|
|
|
77
113
|
return {
|
|
78
114
|
|
|
79
115
|
'query': value['query'],
|
|
116
|
+
'mode': value['mode'],
|
|
117
|
+
'coverage': SearchCoverageToJSON(value['coverage']),
|
|
80
118
|
'hits': ((value['hits'] as Array<any>).map(EarningsCallsDocumentSearch200ResponseHitsInnerToJSON)),
|
|
81
119
|
};
|
|
82
120
|
}
|
|
@@ -13,6 +13,14 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import { mapValues } from '../runtime';
|
|
16
|
+
import type { HitMatch } from './HitMatch';
|
|
17
|
+
import {
|
|
18
|
+
HitMatchFromJSON,
|
|
19
|
+
HitMatchFromJSONTyped,
|
|
20
|
+
HitMatchToJSON,
|
|
21
|
+
HitMatchToJSONTyped,
|
|
22
|
+
} from './HitMatch';
|
|
23
|
+
|
|
16
24
|
/**
|
|
17
25
|
*
|
|
18
26
|
* @export
|
|
@@ -20,11 +28,17 @@ import { mapValues } from '../runtime';
|
|
|
20
28
|
*/
|
|
21
29
|
export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
22
30
|
/**
|
|
23
|
-
*
|
|
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)
|
|
24
32
|
* @type {number}
|
|
25
33
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
26
34
|
*/
|
|
27
35
|
score: number;
|
|
36
|
+
/**
|
|
37
|
+
*
|
|
38
|
+
* @type {HitMatch}
|
|
39
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
40
|
+
*/
|
|
41
|
+
match: HitMatch;
|
|
28
42
|
/**
|
|
29
43
|
* Document identifier (company_documents: /v1/earnings-calls/company-documents/{document_id})
|
|
30
44
|
* @type {string}
|
|
@@ -92,11 +106,23 @@ export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
|
92
106
|
*/
|
|
93
107
|
heading: string | null;
|
|
94
108
|
/**
|
|
95
|
-
*
|
|
109
|
+
* Position of the passage among the document's passages
|
|
110
|
+
* @type {number}
|
|
111
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
112
|
+
*/
|
|
113
|
+
chunk_index: number | null;
|
|
114
|
+
/**
|
|
115
|
+
* The passage (≤ 600 characters, cut on word boundaries around the first match)
|
|
96
116
|
* @type {string}
|
|
97
117
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
98
118
|
*/
|
|
99
119
|
text: string;
|
|
120
|
+
/**
|
|
121
|
+
* true = text is shorter than the passage
|
|
122
|
+
* @type {boolean}
|
|
123
|
+
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
124
|
+
*/
|
|
125
|
+
text_truncated: boolean;
|
|
100
126
|
/**
|
|
101
127
|
* Document title
|
|
102
128
|
* @type {string}
|
|
@@ -166,6 +192,7 @@ export type EarningsCallsDocumentSearch200ResponseHitsInnerCategoryEnum = typeof
|
|
|
166
192
|
*/
|
|
167
193
|
export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value: object): value is EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
168
194
|
if (!('score' in value) || value['score'] === undefined) return false;
|
|
195
|
+
if (!('match' in value) || value['match'] === undefined) return false;
|
|
169
196
|
if (!('document_id' in value) || value['document_id'] === undefined) return false;
|
|
170
197
|
if (!('table' in value) || value['table'] === undefined) return false;
|
|
171
198
|
if (!('event_id' in value) || value['event_id'] === undefined) return false;
|
|
@@ -177,7 +204,9 @@ export function instanceOfEarningsCallsDocumentSearch200ResponseHitsInner(value:
|
|
|
177
204
|
if (!('period' in value) || value['period'] === undefined) return false;
|
|
178
205
|
if (!('page' in value) || value['page'] === undefined) return false;
|
|
179
206
|
if (!('heading' in value) || value['heading'] === undefined) return false;
|
|
207
|
+
if (!('chunk_index' in value) || value['chunk_index'] === undefined) return false;
|
|
180
208
|
if (!('text' in value) || value['text'] === undefined) return false;
|
|
209
|
+
if (!('text_truncated' in value) || value['text_truncated'] === undefined) return false;
|
|
181
210
|
if (!('title' in value) || value['title'] === undefined) return false;
|
|
182
211
|
if (!('group' in value) || value['group'] === undefined) return false;
|
|
183
212
|
if (!('group_label' in value) || value['group_label'] === undefined) return false;
|
|
@@ -198,6 +227,7 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
198
227
|
return {
|
|
199
228
|
|
|
200
229
|
'score': json['score'],
|
|
230
|
+
'match': HitMatchFromJSON(json['match']),
|
|
201
231
|
'document_id': json['document_id'],
|
|
202
232
|
'table': json['table'],
|
|
203
233
|
'event_id': json['event_id'],
|
|
@@ -209,7 +239,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerFromJSONTyped(jso
|
|
|
209
239
|
'period': json['period'],
|
|
210
240
|
'page': json['page'],
|
|
211
241
|
'heading': json['heading'],
|
|
242
|
+
'chunk_index': json['chunk_index'],
|
|
212
243
|
'text': json['text'],
|
|
244
|
+
'text_truncated': json['text_truncated'],
|
|
213
245
|
'title': json['title'],
|
|
214
246
|
'group': json['group'],
|
|
215
247
|
'group_label': json['group_label'],
|
|
@@ -231,6 +263,7 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
231
263
|
return {
|
|
232
264
|
|
|
233
265
|
'score': value['score'],
|
|
266
|
+
'match': HitMatchToJSON(value['match']),
|
|
234
267
|
'document_id': value['document_id'],
|
|
235
268
|
'table': value['table'],
|
|
236
269
|
'event_id': value['event_id'],
|
|
@@ -242,7 +275,9 @@ export function EarningsCallsDocumentSearch200ResponseHitsInnerToJSONTyped(value
|
|
|
242
275
|
'period': value['period'],
|
|
243
276
|
'page': value['page'],
|
|
244
277
|
'heading': value['heading'],
|
|
278
|
+
'chunk_index': value['chunk_index'],
|
|
245
279
|
'text': value['text'],
|
|
280
|
+
'text_truncated': value['text_truncated'],
|
|
246
281
|
'title': value['title'],
|
|
247
282
|
'group': value['group'],
|
|
248
283
|
'group_label': value['group_label'],
|
|
@@ -20,6 +20,13 @@ import {
|
|
|
20
20
|
EarningsCallsEvents200ResponseEventsInnerObservationsInnerToJSON,
|
|
21
21
|
EarningsCallsEvents200ResponseEventsInnerObservationsInnerToJSONTyped,
|
|
22
22
|
} from './EarningsCallsEvents200ResponseEventsInnerObservationsInner';
|
|
23
|
+
import type { EarningsCallsCalendar200ResponseEventsInnerVideo } from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
24
|
+
import {
|
|
25
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON,
|
|
26
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoFromJSONTyped,
|
|
27
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoToJSON,
|
|
28
|
+
EarningsCallsCalendar200ResponseEventsInnerVideoToJSONTyped,
|
|
29
|
+
} from './EarningsCallsCalendar200ResponseEventsInnerVideo';
|
|
23
30
|
|
|
24
31
|
/**
|
|
25
32
|
*
|
|
@@ -189,6 +196,12 @@ export interface EarningsCallsEvents200ResponseEventsInner {
|
|
|
189
196
|
* @memberof EarningsCallsEvents200ResponseEventsInner
|
|
190
197
|
*/
|
|
191
198
|
webcast_url: string | null;
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @type {EarningsCallsCalendar200ResponseEventsInnerVideo}
|
|
202
|
+
* @memberof EarningsCallsEvents200ResponseEventsInner
|
|
203
|
+
*/
|
|
204
|
+
video: EarningsCallsCalendar200ResponseEventsInnerVideo | null;
|
|
192
205
|
/**
|
|
193
206
|
* Date / time observations, oldest first (at most 50)
|
|
194
207
|
* @type {Array<EarningsCallsEvents200ResponseEventsInnerObservationsInner>}
|
|
@@ -274,6 +287,7 @@ export function instanceOfEarningsCallsEvents200ResponseEventsInner(value: objec
|
|
|
274
287
|
if (!('has_press_release' in value) || value['has_press_release'] === undefined) return false;
|
|
275
288
|
if (!('has_documents' in value) || value['has_documents'] === undefined) return false;
|
|
276
289
|
if (!('webcast_url' in value) || value['webcast_url'] === undefined) return false;
|
|
290
|
+
if (!('video' in value) || value['video'] === undefined) return false;
|
|
277
291
|
return true;
|
|
278
292
|
}
|
|
279
293
|
|
|
@@ -314,6 +328,7 @@ export function EarningsCallsEvents200ResponseEventsInnerFromJSONTyped(json: any
|
|
|
314
328
|
'has_press_release': json['has_press_release'],
|
|
315
329
|
'has_documents': json['has_documents'],
|
|
316
330
|
'webcast_url': json['webcast_url'],
|
|
331
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoFromJSON(json['video']),
|
|
317
332
|
'observations': json['observations'] == null ? undefined : ((json['observations'] as Array<any>).map(EarningsCallsEvents200ResponseEventsInnerObservationsInnerFromJSON)),
|
|
318
333
|
};
|
|
319
334
|
}
|
|
@@ -356,6 +371,7 @@ export function EarningsCallsEvents200ResponseEventsInnerToJSONTyped(value?: Ear
|
|
|
356
371
|
'has_press_release': value['has_press_release'],
|
|
357
372
|
'has_documents': value['has_documents'],
|
|
358
373
|
'webcast_url': value['webcast_url'],
|
|
374
|
+
'video': EarningsCallsCalendar200ResponseEventsInnerVideoToJSON(value['video']),
|
|
359
375
|
'observations': value['observations'] == null ? undefined : ((value['observations'] as Array<any>).map(EarningsCallsEvents200ResponseEventsInnerObservationsInnerToJSON)),
|
|
360
376
|
};
|
|
361
377
|
}
|