@invinite-org/data-api-client 0.4.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/EarningsCallsApi.d.ts +4 -8
- package/dist/apis/EarningsCallsApi.js +6 -10
- package/dist/esm/apis/EarningsCallsApi.d.ts +4 -8
- package/dist/esm/apis/EarningsCallsApi.js +6 -10
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
- package/dist/esm/models/EarningsCallsDocumentSearch200Response.js +1 -3
- package/dist/esm/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/EarningsCallsSearch200Response.d.ts +0 -2
- package/dist/esm/models/EarningsCallsSearch200Response.js +1 -3
- package/dist/esm/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/esm/models/HitMatch.d.ts +4 -12
- package/dist/esm/models/HitMatch.js +1 -7
- package/dist/esm/models/SearchCoverage.d.ts +1 -11
- package/dist/esm/models/SearchCoverage.js +0 -8
- package/dist/esm/models/SearchCoverageLeg.d.ts +1 -1
- package/dist/models/EarningsCallsDocumentSearch200Response.d.ts +0 -2
- package/dist/models/EarningsCallsDocumentSearch200Response.js +1 -3
- package/dist/models/EarningsCallsDocumentSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/EarningsCallsSearch200Response.d.ts +0 -2
- package/dist/models/EarningsCallsSearch200Response.js +1 -3
- package/dist/models/EarningsCallsSearch200ResponseHitsInner.d.ts +1 -1
- package/dist/models/HitMatch.d.ts +4 -12
- package/dist/models/HitMatch.js +1 -7
- package/dist/models/SearchCoverage.d.ts +1 -11
- package/dist/models/SearchCoverage.js +0 -8
- package/dist/models/SearchCoverageLeg.d.ts +1 -1
- package/docs/EarningsCallsApi.md +12 -14
- package/docs/HitMatch.md +0 -2
- package/docs/SearchCoverage.md +1 -3
- package/docs/SearchCoverageLeg.md +1 -1
- package/package.json +1 -1
- package/src/apis/EarningsCallsApi.ts +6 -10
- package/src/models/EarningsCallsDocumentSearch200Response.ts +1 -3
- package/src/models/EarningsCallsDocumentSearch200ResponseHitsInner.ts +1 -1
- package/src/models/EarningsCallsSearch200Response.ts +1 -3
- package/src/models/EarningsCallsSearch200ResponseHitsInner.ts +1 -1
- package/src/models/HitMatch.ts +5 -16
- package/src/models/SearchCoverage.ts +1 -14
- package/src/models/SearchCoverageLeg.ts +1 -1
|
@@ -17,9 +17,7 @@ import { MatchSpanFromJSON, MatchSpanToJSON, } from './MatchSpan';
|
|
|
17
17
|
*/
|
|
18
18
|
export const HitMatchTypeEnum = {
|
|
19
19
|
Lexical: 'lexical',
|
|
20
|
-
Literal: 'literal'
|
|
21
|
-
Semantic: 'semantic',
|
|
22
|
-
Hybrid: 'hybrid'
|
|
20
|
+
Literal: 'literal'
|
|
23
21
|
};
|
|
24
22
|
/**
|
|
25
23
|
* Check if a given object implements the HitMatch interface.
|
|
@@ -29,8 +27,6 @@ export function instanceOfHitMatch(value) {
|
|
|
29
27
|
return false;
|
|
30
28
|
if (!('lexical_rank' in value) || value['lexical_rank'] === undefined)
|
|
31
29
|
return false;
|
|
32
|
-
if (!('semantic_rank' in value) || value['semantic_rank'] === undefined)
|
|
33
|
-
return false;
|
|
34
30
|
if (!('spans' in value) || value['spans'] === undefined)
|
|
35
31
|
return false;
|
|
36
32
|
return true;
|
|
@@ -45,7 +41,6 @@ export function HitMatchFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
45
41
|
return {
|
|
46
42
|
'type': json['type'],
|
|
47
43
|
'lexical_rank': json['lexical_rank'],
|
|
48
|
-
'semantic_rank': json['semantic_rank'],
|
|
49
44
|
'spans': (json['spans'].map(MatchSpanFromJSON)),
|
|
50
45
|
};
|
|
51
46
|
}
|
|
@@ -59,7 +54,6 @@ export function HitMatchToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
59
54
|
return {
|
|
60
55
|
'type': value['type'],
|
|
61
56
|
'lexical_rank': value['lexical_rank'],
|
|
62
|
-
'semantic_rank': value['semantic_rank'],
|
|
63
57
|
'spans': (value['spans'].map(MatchSpanToJSON)),
|
|
64
58
|
};
|
|
65
59
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { SearchCoverageLeg } from './SearchCoverageLeg';
|
|
13
13
|
/**
|
|
14
|
-
* How much of the searched scope the
|
|
14
|
+
* How much of the searched scope the text index covers
|
|
15
15
|
* @export
|
|
16
16
|
* @interface SearchCoverage
|
|
17
17
|
*/
|
|
@@ -28,12 +28,6 @@ export interface SearchCoverage {
|
|
|
28
28
|
* @memberof SearchCoverage
|
|
29
29
|
*/
|
|
30
30
|
lexical: SearchCoverageLeg | null;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {SearchCoverageLeg}
|
|
34
|
-
* @memberof SearchCoverage
|
|
35
|
-
*/
|
|
36
|
-
semantic: SearchCoverageLeg | null;
|
|
37
31
|
/**
|
|
38
32
|
* Why the answer may be incomplete
|
|
39
33
|
* @type {Array<SearchCoverageReasonsEnum>}
|
|
@@ -56,10 +50,6 @@ export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEn
|
|
|
56
50
|
export declare const SearchCoverageReasonsEnum: {
|
|
57
51
|
readonly LexicalBackfillPending: "lexical_backfill_pending";
|
|
58
52
|
readonly ProjectionFailed: "projection_failed";
|
|
59
|
-
readonly SemanticIndexMissing: "semantic_index_missing";
|
|
60
|
-
readonly SemanticBackfillPending: "semantic_backfill_pending";
|
|
61
|
-
readonly LexicalUnavailable: "lexical_unavailable";
|
|
62
|
-
readonly SemanticUnavailable: "semantic_unavailable";
|
|
63
53
|
readonly CoverageUnavailable: "coverage_unavailable";
|
|
64
54
|
};
|
|
65
55
|
export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
|
|
@@ -26,10 +26,6 @@ export const SearchCoverageCompletenessEnum = {
|
|
|
26
26
|
export const SearchCoverageReasonsEnum = {
|
|
27
27
|
LexicalBackfillPending: 'lexical_backfill_pending',
|
|
28
28
|
ProjectionFailed: 'projection_failed',
|
|
29
|
-
SemanticIndexMissing: 'semantic_index_missing',
|
|
30
|
-
SemanticBackfillPending: 'semantic_backfill_pending',
|
|
31
|
-
LexicalUnavailable: 'lexical_unavailable',
|
|
32
|
-
SemanticUnavailable: 'semantic_unavailable',
|
|
33
29
|
CoverageUnavailable: 'coverage_unavailable'
|
|
34
30
|
};
|
|
35
31
|
/**
|
|
@@ -40,8 +36,6 @@ export function instanceOfSearchCoverage(value) {
|
|
|
40
36
|
return false;
|
|
41
37
|
if (!('lexical' in value) || value['lexical'] === undefined)
|
|
42
38
|
return false;
|
|
43
|
-
if (!('semantic' in value) || value['semantic'] === undefined)
|
|
44
|
-
return false;
|
|
45
39
|
if (!('reasons' in value) || value['reasons'] === undefined)
|
|
46
40
|
return false;
|
|
47
41
|
return true;
|
|
@@ -56,7 +50,6 @@ export function SearchCoverageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
56
50
|
return {
|
|
57
51
|
'completeness': json['completeness'],
|
|
58
52
|
'lexical': SearchCoverageLegFromJSON(json['lexical']),
|
|
59
|
-
'semantic': SearchCoverageLegFromJSON(json['semantic']),
|
|
60
53
|
'reasons': json['reasons'],
|
|
61
54
|
};
|
|
62
55
|
}
|
|
@@ -70,7 +63,6 @@ export function SearchCoverageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
70
63
|
return {
|
|
71
64
|
'completeness': value['completeness'],
|
|
72
65
|
'lexical': SearchCoverageLegToJSON(value['lexical']),
|
|
73
|
-
'semantic': SearchCoverageLegToJSON(value['semantic']),
|
|
74
66
|
'reasons': value['reasons'],
|
|
75
67
|
};
|
|
76
68
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The
|
|
13
|
+
* The text index (lexical and literal); null when the counts could not be read
|
|
14
14
|
* @export
|
|
15
15
|
* @interface SearchCoverageLeg
|
|
16
16
|
*/
|
|
@@ -48,8 +48,6 @@ export interface EarningsCallsDocumentSearch200Response {
|
|
|
48
48
|
export declare const EarningsCallsDocumentSearch200ResponseModeEnum: {
|
|
49
49
|
readonly Lexical: "lexical";
|
|
50
50
|
readonly Literal: "literal";
|
|
51
|
-
readonly Semantic: "semantic";
|
|
52
|
-
readonly Hybrid: "hybrid";
|
|
53
51
|
};
|
|
54
52
|
export type EarningsCallsDocumentSearch200ResponseModeEnum = typeof EarningsCallsDocumentSearch200ResponseModeEnum[keyof typeof EarningsCallsDocumentSearch200ResponseModeEnum];
|
|
55
53
|
/**
|
|
@@ -26,9 +26,7 @@ const SearchCoverage_1 = require("./SearchCoverage");
|
|
|
26
26
|
*/
|
|
27
27
|
exports.EarningsCallsDocumentSearch200ResponseModeEnum = {
|
|
28
28
|
Lexical: 'lexical',
|
|
29
|
-
Literal: 'literal'
|
|
30
|
-
Semantic: 'semantic',
|
|
31
|
-
Hybrid: 'hybrid'
|
|
29
|
+
Literal: 'literal'
|
|
32
30
|
};
|
|
33
31
|
/**
|
|
34
32
|
* Check if a given object implements the EarningsCallsDocumentSearch200Response interface.
|
|
@@ -17,7 +17,7 @@ import type { HitMatch } from './HitMatch';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface EarningsCallsDocumentSearch200ResponseHitsInner {
|
|
19
19
|
/**
|
|
20
|
-
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
|
|
20
|
+
* Relevance per mode: lexical = ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest year first)
|
|
21
21
|
* @type {number}
|
|
22
22
|
* @memberof EarningsCallsDocumentSearch200ResponseHitsInner
|
|
23
23
|
*/
|
|
@@ -48,8 +48,6 @@ export interface EarningsCallsSearch200Response {
|
|
|
48
48
|
export declare const EarningsCallsSearch200ResponseModeEnum: {
|
|
49
49
|
readonly Lexical: "lexical";
|
|
50
50
|
readonly Literal: "literal";
|
|
51
|
-
readonly Semantic: "semantic";
|
|
52
|
-
readonly Hybrid: "hybrid";
|
|
53
51
|
};
|
|
54
52
|
export type EarningsCallsSearch200ResponseModeEnum = typeof EarningsCallsSearch200ResponseModeEnum[keyof typeof EarningsCallsSearch200ResponseModeEnum];
|
|
55
53
|
/**
|
|
@@ -26,9 +26,7 @@ const SearchCoverage_1 = require("./SearchCoverage");
|
|
|
26
26
|
*/
|
|
27
27
|
exports.EarningsCallsSearch200ResponseModeEnum = {
|
|
28
28
|
Lexical: 'lexical',
|
|
29
|
-
Literal: 'literal'
|
|
30
|
-
Semantic: 'semantic',
|
|
31
|
-
Hybrid: 'hybrid'
|
|
29
|
+
Literal: 'literal'
|
|
32
30
|
};
|
|
33
31
|
/**
|
|
34
32
|
* Check if a given object implements the EarningsCallsSearch200Response interface.
|
|
@@ -97,7 +97,7 @@ export interface EarningsCallsSearch200ResponseHitsInner {
|
|
|
97
97
|
*/
|
|
98
98
|
text_truncated: boolean;
|
|
99
99
|
/**
|
|
100
|
-
* Relevance per mode: lexical =
|
|
100
|
+
* Relevance per mode: lexical = BM25 with `identifier` / `event_id` (an answer attached to its question scores 0.99 × the question), else ts_rank_cd (4 decimals), literal = 0 (hits are ordered newest call first)
|
|
101
101
|
* @type {number}
|
|
102
102
|
* @memberof EarningsCallsSearch200ResponseHitsInner
|
|
103
103
|
*/
|
|
@@ -17,25 +17,19 @@ import type { MatchSpan } from './MatchSpan';
|
|
|
17
17
|
*/
|
|
18
18
|
export interface HitMatch {
|
|
19
19
|
/**
|
|
20
|
-
* The
|
|
20
|
+
* The mode that found the passage
|
|
21
21
|
* @type {HitMatchTypeEnum}
|
|
22
22
|
* @memberof HitMatch
|
|
23
23
|
*/
|
|
24
24
|
type: HitMatchTypeEnum;
|
|
25
25
|
/**
|
|
26
|
-
* 1-based rank
|
|
26
|
+
* 1-based rank of the passage in the answer
|
|
27
27
|
* @type {number}
|
|
28
28
|
* @memberof HitMatch
|
|
29
29
|
*/
|
|
30
|
-
lexical_rank: number
|
|
30
|
+
lexical_rank: number;
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {number}
|
|
34
|
-
* @memberof HitMatch
|
|
35
|
-
*/
|
|
36
|
-
semantic_rank: number | null;
|
|
37
|
-
/**
|
|
38
|
-
* Matched characters in `text`; empty for semantic matches
|
|
32
|
+
* Matched characters in `text`; empty for an answer attached after its matched question (scoped lexical transcript search)
|
|
39
33
|
* @type {Array<MatchSpan>}
|
|
40
34
|
* @memberof HitMatch
|
|
41
35
|
*/
|
|
@@ -47,8 +41,6 @@ export interface HitMatch {
|
|
|
47
41
|
export declare const HitMatchTypeEnum: {
|
|
48
42
|
readonly Lexical: "lexical";
|
|
49
43
|
readonly Literal: "literal";
|
|
50
|
-
readonly Semantic: "semantic";
|
|
51
|
-
readonly Hybrid: "hybrid";
|
|
52
44
|
};
|
|
53
45
|
export type HitMatchTypeEnum = typeof HitMatchTypeEnum[keyof typeof HitMatchTypeEnum];
|
|
54
46
|
/**
|
package/dist/models/HitMatch.js
CHANGED
|
@@ -25,9 +25,7 @@ const MatchSpan_1 = require("./MatchSpan");
|
|
|
25
25
|
*/
|
|
26
26
|
exports.HitMatchTypeEnum = {
|
|
27
27
|
Lexical: 'lexical',
|
|
28
|
-
Literal: 'literal'
|
|
29
|
-
Semantic: 'semantic',
|
|
30
|
-
Hybrid: 'hybrid'
|
|
28
|
+
Literal: 'literal'
|
|
31
29
|
};
|
|
32
30
|
/**
|
|
33
31
|
* Check if a given object implements the HitMatch interface.
|
|
@@ -37,8 +35,6 @@ function instanceOfHitMatch(value) {
|
|
|
37
35
|
return false;
|
|
38
36
|
if (!('lexical_rank' in value) || value['lexical_rank'] === undefined)
|
|
39
37
|
return false;
|
|
40
|
-
if (!('semantic_rank' in value) || value['semantic_rank'] === undefined)
|
|
41
|
-
return false;
|
|
42
38
|
if (!('spans' in value) || value['spans'] === undefined)
|
|
43
39
|
return false;
|
|
44
40
|
return true;
|
|
@@ -53,7 +49,6 @@ function HitMatchFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
53
49
|
return {
|
|
54
50
|
'type': json['type'],
|
|
55
51
|
'lexical_rank': json['lexical_rank'],
|
|
56
|
-
'semantic_rank': json['semantic_rank'],
|
|
57
52
|
'spans': (json['spans'].map(MatchSpan_1.MatchSpanFromJSON)),
|
|
58
53
|
};
|
|
59
54
|
}
|
|
@@ -67,7 +62,6 @@ function HitMatchToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
67
62
|
return {
|
|
68
63
|
'type': value['type'],
|
|
69
64
|
'lexical_rank': value['lexical_rank'],
|
|
70
|
-
'semantic_rank': value['semantic_rank'],
|
|
71
65
|
'spans': (value['spans'].map(MatchSpan_1.MatchSpanToJSON)),
|
|
72
66
|
};
|
|
73
67
|
}
|
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import type { SearchCoverageLeg } from './SearchCoverageLeg';
|
|
13
13
|
/**
|
|
14
|
-
* How much of the searched scope the
|
|
14
|
+
* How much of the searched scope the text index covers
|
|
15
15
|
* @export
|
|
16
16
|
* @interface SearchCoverage
|
|
17
17
|
*/
|
|
@@ -28,12 +28,6 @@ export interface SearchCoverage {
|
|
|
28
28
|
* @memberof SearchCoverage
|
|
29
29
|
*/
|
|
30
30
|
lexical: SearchCoverageLeg | null;
|
|
31
|
-
/**
|
|
32
|
-
*
|
|
33
|
-
* @type {SearchCoverageLeg}
|
|
34
|
-
* @memberof SearchCoverage
|
|
35
|
-
*/
|
|
36
|
-
semantic: SearchCoverageLeg | null;
|
|
37
31
|
/**
|
|
38
32
|
* Why the answer may be incomplete
|
|
39
33
|
* @type {Array<SearchCoverageReasonsEnum>}
|
|
@@ -56,10 +50,6 @@ export type SearchCoverageCompletenessEnum = typeof SearchCoverageCompletenessEn
|
|
|
56
50
|
export declare const SearchCoverageReasonsEnum: {
|
|
57
51
|
readonly LexicalBackfillPending: "lexical_backfill_pending";
|
|
58
52
|
readonly ProjectionFailed: "projection_failed";
|
|
59
|
-
readonly SemanticIndexMissing: "semantic_index_missing";
|
|
60
|
-
readonly SemanticBackfillPending: "semantic_backfill_pending";
|
|
61
|
-
readonly LexicalUnavailable: "lexical_unavailable";
|
|
62
|
-
readonly SemanticUnavailable: "semantic_unavailable";
|
|
63
53
|
readonly CoverageUnavailable: "coverage_unavailable";
|
|
64
54
|
};
|
|
65
55
|
export type SearchCoverageReasonsEnum = typeof SearchCoverageReasonsEnum[keyof typeof SearchCoverageReasonsEnum];
|
|
@@ -34,10 +34,6 @@ exports.SearchCoverageCompletenessEnum = {
|
|
|
34
34
|
exports.SearchCoverageReasonsEnum = {
|
|
35
35
|
LexicalBackfillPending: 'lexical_backfill_pending',
|
|
36
36
|
ProjectionFailed: 'projection_failed',
|
|
37
|
-
SemanticIndexMissing: 'semantic_index_missing',
|
|
38
|
-
SemanticBackfillPending: 'semantic_backfill_pending',
|
|
39
|
-
LexicalUnavailable: 'lexical_unavailable',
|
|
40
|
-
SemanticUnavailable: 'semantic_unavailable',
|
|
41
37
|
CoverageUnavailable: 'coverage_unavailable'
|
|
42
38
|
};
|
|
43
39
|
/**
|
|
@@ -48,8 +44,6 @@ function instanceOfSearchCoverage(value) {
|
|
|
48
44
|
return false;
|
|
49
45
|
if (!('lexical' in value) || value['lexical'] === undefined)
|
|
50
46
|
return false;
|
|
51
|
-
if (!('semantic' in value) || value['semantic'] === undefined)
|
|
52
|
-
return false;
|
|
53
47
|
if (!('reasons' in value) || value['reasons'] === undefined)
|
|
54
48
|
return false;
|
|
55
49
|
return true;
|
|
@@ -64,7 +58,6 @@ function SearchCoverageFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
64
58
|
return {
|
|
65
59
|
'completeness': json['completeness'],
|
|
66
60
|
'lexical': (0, SearchCoverageLeg_1.SearchCoverageLegFromJSON)(json['lexical']),
|
|
67
|
-
'semantic': (0, SearchCoverageLeg_1.SearchCoverageLegFromJSON)(json['semantic']),
|
|
68
61
|
'reasons': json['reasons'],
|
|
69
62
|
};
|
|
70
63
|
}
|
|
@@ -78,7 +71,6 @@ function SearchCoverageToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
78
71
|
return {
|
|
79
72
|
'completeness': value['completeness'],
|
|
80
73
|
'lexical': (0, SearchCoverageLeg_1.SearchCoverageLegToJSON)(value['lexical']),
|
|
81
|
-
'semantic': (0, SearchCoverageLeg_1.SearchCoverageLegToJSON)(value['semantic']),
|
|
82
74
|
'reasons': value['reasons'],
|
|
83
75
|
};
|
|
84
76
|
}
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
/**
|
|
13
|
-
* The
|
|
13
|
+
* The text index (lexical and literal); null when the counts could not be read
|
|
14
14
|
* @export
|
|
15
15
|
* @interface SearchCoverageLeg
|
|
16
16
|
*/
|
package/docs/EarningsCallsApi.md
CHANGED
|
@@ -601,7 +601,7 @@ example().catch(console.error);
|
|
|
601
601
|
|
|
602
602
|
Search investor documents
|
|
603
603
|
|
|
604
|
-
Search the page text of investor documents by keywords (default `mode=lexical`)
|
|
604
|
+
Search the page text of investor documents by keywords (default `mode=lexical`) or exact text (`literal`): the documents of earnings calls (CFO commentary, shareholder letters, data sheets, the company\'s own transcripts) and companies\' IR libraries (annual reports, proxy statements, ESG reports, investor-day decks). ### What you get - Up to 20 passages from company-published documents, with page numbers — not verified facts — and a signed URL of the file (open it at `#page=<page>`). - Filter by company (`identifier`), kind, IR section, year or table. - Each hit names the document\'s folder of the company\'s document tree (`group`, e.g. `earnings/fy2027/q2`, `group_label`, `category`), how it matched (`match`); the response says how much of the searched documents is indexed (`coverage`). ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; every word must match; ranked by `ts_rank_cd` (`websearch_to_tsquery`). Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for display: FREE.
|
|
605
605
|
|
|
606
606
|
### Example
|
|
607
607
|
|
|
@@ -621,10 +621,10 @@ async function example() {
|
|
|
621
621
|
const api = new EarningsCallsApi(config);
|
|
622
622
|
|
|
623
623
|
const body = {
|
|
624
|
-
// string | The keywords
|
|
624
|
+
// string | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for
|
|
625
625
|
q: Azure growth,
|
|
626
|
-
// 'lexical' | 'literal' |
|
|
627
|
-
mode:
|
|
626
|
+
// 'lexical' | 'literal' | lexical (keywords and phrases, default) or literal (exact characters) (optional)
|
|
627
|
+
mode: lexical,
|
|
628
628
|
// 'true' | 'false' | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) (optional)
|
|
629
629
|
caseSensitive: false,
|
|
630
630
|
// string | Search one company\'s documents (ticker or CIK, US only) (optional)
|
|
@@ -658,8 +658,8 @@ example().catch(console.error);
|
|
|
658
658
|
|
|
659
659
|
| Name | Type | Description | Notes |
|
|
660
660
|
|------------- | ------------- | ------------- | -------------|
|
|
661
|
-
| **q** | `string` | The keywords
|
|
662
|
-
| **mode** | `lexical`, `literal
|
|
661
|
+
| **q** | `string` | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for | [Defaults to `undefined`] |
|
|
662
|
+
| **mode** | `lexical`, `literal` | lexical (keywords and phrases, default) or literal (exact characters) | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
663
663
|
| **caseSensitive** | `true`, `false` | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
664
664
|
| **identifier** | `string` | Search one company\'s documents (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
|
|
665
665
|
| **kind** | `Array<string>` | Only these document kinds, comma-separated or repeated: annual_report, ceo_letter, proxy_statement, proxy_supplement, esg_report, conference_presentation, investor_day_deck, earnings_deck, fact_sheet, financial_data, shareholder_letter, company_transcript, cfo_commentary, governance, press_release, infographic, webcast, other, prepared_remarks, sec_filing | [Optional] |
|
|
@@ -689,7 +689,6 @@ example().catch(console.error);
|
|
|
689
689
|
| **400** | Bad Request - Invalid request parameters | - |
|
|
690
690
|
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
691
691
|
| **404** | Not Found - Resource not found | - |
|
|
692
|
-
| **429** | Rate limited (Retry-After) | - |
|
|
693
692
|
| **500** | Internal Server Error - Server error occurred | - |
|
|
694
693
|
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
695
694
|
|
|
@@ -1972,7 +1971,7 @@ example().catch(console.error);
|
|
|
1972
1971
|
|
|
1973
1972
|
Search earnings calls
|
|
1974
1973
|
|
|
1975
|
-
\"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`)
|
|
1974
|
+
\"Ask this call\": search earnings-call transcripts and slide text by keywords (default `mode=lexical`) or exact text (`literal`) — one call (`event_id`), one company (`identifier`) or every call (default: the last 365 days). ### What you get - Up to 8 passages with speaker and `start_ms`, how each matched (`match`) and the index coverage of the search (`coverage`). Cite `event_id` and `start_ms`. - On plans that include the audio and slides routes (PRO): `audio_url` opens the recording\'s permanent URL at the passage (`#t=<seconds>`; null while no recording is available) and `slide.image_url` (a signed URL) shows the slide. ### Event types - `event_type` (default `earnings_call`; `all` = every type) selects investor days, conferences or shareholder meetings too. ### Search modes - `lexical` (default): keyword search — English full text with stemming; quoted phrases, `OR` and `-word` work; scoped by `identifier` or `event_id`, a passage needs any of the words, ranked by BM25 (rarer words weigh more), and the answer to a matching analyst question follows right after it (its `match.spans` may be empty); without a scope every word must match, ranked by `ts_rank_cd`. Finance tokens such as `FY2027`, `10-K`, `Q3` or `EBITDA` match as written. - `literal`: the exact characters of the passage — no stemming, no fuzzy matching, `%` / `_` / `\\` match themselves; case-sensitive unless `case_sensitive=false` (only allowed with `mode=literal`; default `true`). A pattern under 3 characters needs `identifier` or `event_id`. Newest first; `score` is 0. - `match.spans` mark the matched characters in `text` (zero-based, end-exclusive Unicode code-point offsets); `text` is cut around the first match (`text_truncated`); `match.lexical_rank` is the hit\'s 1-based rank. Neither mode expands into fuzzy results. Both modes cost the same. ### Coverage - `coverage.completeness` = `complete` (every searched passage is indexed: no hits is a genuine no-result), `partial` (some passages are still being indexed or failed) or `unknown` (nothing of the searched scope is indexed yet, or the counts could not be read) — read it before treating an empty list as \"not found\". - `coverage.lexical` counts the searched transcripts or documents in the text index (`indexed`, `pending`, `failed`). `reasons` lists why the answer may be incomplete. The counts come from the indexing ledger: a transcript or document whose current version the index has not confirmed counts as `pending`; when they cannot be read, the hits are still returned with `completeness: unknown`, `lexical` null and `coverage_unavailable`. ### Changelog - 2026-10: modes added and the default mode changed from semantic to `lexical`. - 2026-11: modes `semantic` and `hybrid` removed; vector search is gone, pass `mode=lexical` (default) or `literal`. ### Errors - `400` for a `mode=lexical` query of stopwords only (no searchable words), for `case_sensitive` with any mode but `literal`, and for a `mode=literal` pattern under 3 characters without a scope (see Search modes). - `503 search_unavailable` (a search over its time limit — never an empty answer) carries `Retry-After`. - `503 search_disabled` while search is switched off. ### Freshness and coverage - Data is replicated from the capture pipeline with a lag of about a minute. - Only US earnings calls captured by Invinite are served. Minimum tier for rag: STANDARD.
|
|
1976
1975
|
|
|
1977
1976
|
### Example
|
|
1978
1977
|
|
|
@@ -1992,10 +1991,10 @@ async function example() {
|
|
|
1992
1991
|
const api = new EarningsCallsApi(config);
|
|
1993
1992
|
|
|
1994
1993
|
const body = {
|
|
1995
|
-
// string | The keywords
|
|
1994
|
+
// string | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for
|
|
1996
1995
|
q: Azure growth,
|
|
1997
|
-
// 'lexical' | 'literal' |
|
|
1998
|
-
mode:
|
|
1996
|
+
// 'lexical' | 'literal' | lexical (keywords and phrases, default) or literal (exact characters) (optional)
|
|
1997
|
+
mode: lexical,
|
|
1999
1998
|
// 'true' | 'false' | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) (optional)
|
|
2000
1999
|
caseSensitive: false,
|
|
2001
2000
|
// string | Search one call (optional)
|
|
@@ -2031,8 +2030,8 @@ example().catch(console.error);
|
|
|
2031
2030
|
|
|
2032
2031
|
| Name | Type | Description | Notes |
|
|
2033
2032
|
|------------- | ------------- | ------------- | -------------|
|
|
2034
|
-
| **q** | `string` | The keywords
|
|
2035
|
-
| **mode** | `lexical`, `literal
|
|
2033
|
+
| **q** | `string` | The keywords or phrases (mode=lexical) or exact text (mode=literal) to search for | [Defaults to `undefined`] |
|
|
2034
|
+
| **mode** | `lexical`, `literal` | lexical (keywords and phrases, default) or literal (exact characters) | [Optional] [Defaults to `'lexical'`] [Enum: lexical, literal] |
|
|
2036
2035
|
| **caseSensitive** | `true`, `false` | mode=literal only: \"false\" matches regardless of case (default \"true\": case-sensitive) | [Optional] [Defaults to `undefined`] [Enum: true, false] |
|
|
2037
2036
|
| **eventId** | `string` | Search one call | [Optional] [Defaults to `undefined`] |
|
|
2038
2037
|
| **identifier** | `string` | Search one company\'s calls (ticker or CIK, US only) | [Optional] [Defaults to `undefined`] |
|
|
@@ -2063,7 +2062,6 @@ example().catch(console.error);
|
|
|
2063
2062
|
| **400** | Bad Request - Invalid request parameters | - |
|
|
2064
2063
|
| **401** | Unauthorized - Missing or invalid API key | - |
|
|
2065
2064
|
| **404** | Not Found - Resource not found | - |
|
|
2066
|
-
| **429** | Rate limited (Retry-After) | - |
|
|
2067
2065
|
| **500** | Internal Server Error - Server error occurred | - |
|
|
2068
2066
|
| **503** | Service Unavailable - Temporarily unavailable or switched off | - |
|
|
2069
2067
|
|
package/docs/HitMatch.md
CHANGED
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`type` | string
|
|
11
11
|
`lexical_rank` | number
|
|
12
|
-
`semantic_rank` | number
|
|
13
12
|
`spans` | [Array<MatchSpan>](MatchSpan.md)
|
|
14
13
|
|
|
15
14
|
## Example
|
|
@@ -21,7 +20,6 @@ import type { HitMatch } from '@invinite-org/data-api-client'
|
|
|
21
20
|
const example = {
|
|
22
21
|
"type": null,
|
|
23
22
|
"lexical_rank": null,
|
|
24
|
-
"semantic_rank": null,
|
|
25
23
|
"spans": null,
|
|
26
24
|
} satisfies HitMatch
|
|
27
25
|
|
package/docs/SearchCoverage.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
|
|
2
2
|
# SearchCoverage
|
|
3
3
|
|
|
4
|
-
How much of the searched scope the
|
|
4
|
+
How much of the searched scope the text index covers
|
|
5
5
|
|
|
6
6
|
## Properties
|
|
7
7
|
|
|
@@ -9,7 +9,6 @@ Name | Type
|
|
|
9
9
|
------------ | -------------
|
|
10
10
|
`completeness` | string
|
|
11
11
|
`lexical` | [SearchCoverageLeg](SearchCoverageLeg.md)
|
|
12
|
-
`semantic` | [SearchCoverageLeg](SearchCoverageLeg.md)
|
|
13
12
|
`reasons` | Array<string>
|
|
14
13
|
|
|
15
14
|
## Example
|
|
@@ -21,7 +20,6 @@ import type { SearchCoverage } from '@invinite-org/data-api-client'
|
|
|
21
20
|
const example = {
|
|
22
21
|
"completeness": null,
|
|
23
22
|
"lexical": null,
|
|
24
|
-
"semantic": null,
|
|
25
23
|
"reasons": null,
|
|
26
24
|
} satisfies SearchCoverage
|
|
27
25
|
|