@aventurevc/api-schemas 0.8.61 → 0.8.63
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/confidence/confidence.d.ts +1 -0
- package/dist/confidence/confidence.js +1 -0
- package/dist/content/embedding-match.d.ts +4 -2
- package/dist/content/source-type.d.ts +4 -2
- package/dist/content/source-type.js +16 -11
- package/dist/entity/accelerator-participation.d.ts +9 -5
- package/dist/entity/acquisition.d.ts +18 -10
- package/dist/entity/brand.d.ts +9 -5
- package/dist/entity/detail.d.ts +11 -7
- package/dist/entity/entity.d.ts +9 -5
- package/dist/entity/fundraise-transaction-entity.d.ts +9 -5
- package/dist/entity/fundraise-transaction.d.ts +9 -5
- package/dist/entity/fundraise.d.ts +9 -5
- package/dist/entity/image.d.ts +8 -5
- package/dist/entity/image.js +7 -6
- package/dist/entity/investor-participation.d.ts +11 -7
- package/dist/entity/list.d.ts +14 -7
- package/dist/entity/list.js +1 -0
- package/dist/entity/person-association.d.ts +16 -9
- package/dist/entity/relationship.d.ts +9 -5
- package/dist/entity/resolution.d.ts +11 -7
- package/dist/entity/similarity-context.d.ts +4 -0
- package/dist/entity/similarity-context.js +4 -0
- package/dist/entity/similarity-origin.d.ts +4 -0
- package/dist/entity/similarity-origin.js +4 -0
- package/dist/entity/similarity-result.d.ts +7 -2
- package/dist/entity/similarity-result.js +5 -0
- package/dist/entity/similarity-summary.d.ts +9 -5
- package/dist/federated/search.d.ts +2097 -127
- package/dist/harness/run-detail.d.ts +18 -10
- package/dist/link/search.d.ts +2186 -216
- package/dist/lookup/job-mention.d.ts +4 -4
- package/dist/lookup/job.d.ts +4 -4
- package/dist/media/upload.d.ts +14 -11
- package/dist/media/upload.js +12 -11
- package/dist/mention/lookup.d.ts +4 -4
- package/dist/natural/search-result.d.ts +1982 -16
- package/dist/natural/search-result.js +12 -0
- package/dist/news/detail.d.ts +13 -10
- package/dist/news/detail.js +11 -10
- package/dist/openapi-component-manifest.js +12 -0
- package/dist/pagination/schemas.d.ts +54 -39
- package/dist/person/detail.d.ts +18 -11
- package/dist/person/graph-career-context.d.ts +9 -5
- package/dist/person/graph-co-investor.d.ts +9 -5
- package/dist/person/graph-member.d.ts +7 -4
- package/dist/person/graph-similar-entity.d.ts +9 -5
- package/dist/person/image.d.ts +7 -4
- package/dist/person/image.js +6 -5
- package/dist/person/invested-company.d.ts +9 -5
- package/dist/person/investment.d.ts +9 -5
- package/dist/person/investor-participation.d.ts +2 -2
- package/dist/person/natural-search-result.d.ts +2 -2
- package/dist/person/person.d.ts +11 -6
- package/dist/person/similarity-result.d.ts +18 -11
- package/dist/search/answer-citation.d.ts +27 -0
- package/dist/search/answer-citation.js +25 -0
- package/dist/search/answer.d.ts +32 -0
- package/dist/search/answer.js +25 -0
- package/dist/search/evidence-source.d.ts +21 -0
- package/dist/search/evidence-source.js +21 -0
- package/dist/search/intent.d.ts +21 -0
- package/dist/search/intent.js +16 -0
- package/dist/search/interpretation.d.ts +7 -0
- package/dist/search/interpretation.js +5 -0
- package/dist/search/layer.d.ts +15 -0
- package/dist/search/layer.js +12 -0
- package/dist/search/mode.d.ts +1 -1
- package/dist/search/mode.js +1 -1
- package/dist/search/passage.d.ts +32 -0
- package/dist/search/passage.js +35 -0
- package/package.json +1 -1
|
@@ -178,7 +178,7 @@ declare const PersonNaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
178
178
|
sourceId: string;
|
|
179
179
|
sourceJson: string;
|
|
180
180
|
sourceText: string;
|
|
181
|
-
sourceType:
|
|
181
|
+
sourceType: string;
|
|
182
182
|
} | null | undefined;
|
|
183
183
|
slug: string;
|
|
184
184
|
suffix?: string | null | undefined;
|
|
@@ -224,7 +224,7 @@ declare const PersonNaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
224
224
|
sourceId: string;
|
|
225
225
|
sourceJson: string;
|
|
226
226
|
sourceText: string;
|
|
227
|
-
sourceType:
|
|
227
|
+
sourceType: string;
|
|
228
228
|
} | null | undefined;
|
|
229
229
|
slug: string;
|
|
230
230
|
suffix?: string | null | undefined;
|
package/dist/person/person.d.ts
CHANGED
|
@@ -3,10 +3,13 @@ declare const PersonSchemaDefinition: z.ZodObject<{
|
|
|
3
3
|
createdAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
4
4
|
gender: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
5
5
|
id: z.ZodUUID;
|
|
6
|
-
image: z.
|
|
7
|
-
isMonogram:
|
|
8
|
-
picture
|
|
9
|
-
}, z.core.$
|
|
6
|
+
image: z.ZodType<{
|
|
7
|
+
isMonogram: boolean;
|
|
8
|
+
picture?: string | null | undefined;
|
|
9
|
+
}, unknown, z.core.$ZodTypeInternals<{
|
|
10
|
+
isMonogram: boolean;
|
|
11
|
+
picture?: string | null | undefined;
|
|
12
|
+
}, unknown>>;
|
|
10
13
|
lastModifiedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
11
14
|
nameAlias: z.ZodArray<z.ZodType<{
|
|
12
15
|
displayable?: boolean | null | undefined;
|
|
@@ -33,7 +36,7 @@ declare const PersonSchemaDefinition: z.ZodObject<{
|
|
|
33
36
|
sourceId: z.ZodString;
|
|
34
37
|
sourceJson: z.ZodString;
|
|
35
38
|
sourceText: z.ZodString;
|
|
36
|
-
sourceType: z.ZodEnum<{
|
|
39
|
+
sourceType: z.ZodUnion<readonly [z.ZodEnum<{
|
|
37
40
|
agentHelpDoc: "agentHelpDoc";
|
|
38
41
|
blogPost: "blogPost";
|
|
39
42
|
classificationCode: "classificationCode";
|
|
@@ -42,9 +45,11 @@ declare const PersonSchemaDefinition: z.ZodObject<{
|
|
|
42
45
|
newsArticle: "newsArticle";
|
|
43
46
|
person: "person";
|
|
44
47
|
product: "product";
|
|
48
|
+
researchSnippet: "researchSnippet";
|
|
45
49
|
service: "service";
|
|
50
|
+
sourceDocument: "sourceDocument";
|
|
46
51
|
text: "text";
|
|
47
|
-
}>;
|
|
52
|
+
}>, z.ZodString]>;
|
|
48
53
|
}, z.core.$strip>>>;
|
|
49
54
|
slug: z.ZodString;
|
|
50
55
|
suffix: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -52,11 +52,15 @@ declare const PersonSimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
52
52
|
updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
53
53
|
}, z.core.$strip>>;
|
|
54
54
|
entityId: z.ZodUUID;
|
|
55
|
-
entityLogo: z.
|
|
56
|
-
isMonogram:
|
|
57
|
-
logo
|
|
58
|
-
logoSquare
|
|
59
|
-
}, z.core.$
|
|
55
|
+
entityLogo: z.ZodType<{
|
|
56
|
+
isMonogram: boolean;
|
|
57
|
+
logo?: string | null | undefined;
|
|
58
|
+
logoSquare?: string | null | undefined;
|
|
59
|
+
}, unknown, z.core.$ZodTypeInternals<{
|
|
60
|
+
isMonogram: boolean;
|
|
61
|
+
logo?: string | null | undefined;
|
|
62
|
+
logoSquare?: string | null | undefined;
|
|
63
|
+
}, unknown>>;
|
|
60
64
|
entityName: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
61
65
|
entityOperatingStatus: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
62
66
|
entitySlug: z.ZodString;
|
|
@@ -156,10 +160,13 @@ declare const PersonSimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
156
160
|
updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
157
161
|
}, z.core.$strip>>;
|
|
158
162
|
personId: z.ZodUUID;
|
|
159
|
-
personImage: z.
|
|
160
|
-
isMonogram:
|
|
161
|
-
picture
|
|
162
|
-
}, z.core.$
|
|
163
|
+
personImage: z.ZodType<{
|
|
164
|
+
isMonogram: boolean;
|
|
165
|
+
picture?: string | null | undefined;
|
|
166
|
+
}, unknown, z.core.$ZodTypeInternals<{
|
|
167
|
+
isMonogram: boolean;
|
|
168
|
+
picture?: string | null | undefined;
|
|
169
|
+
}, unknown>>;
|
|
163
170
|
personName: z.ZodString;
|
|
164
171
|
personSlug: z.ZodString;
|
|
165
172
|
personUrlLink: z.ZodArray<z.ZodType<{
|
|
@@ -234,7 +241,7 @@ declare const PersonSimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
234
241
|
sourceId: string;
|
|
235
242
|
sourceJson: string;
|
|
236
243
|
sourceText: string;
|
|
237
|
-
sourceType:
|
|
244
|
+
sourceType: string;
|
|
238
245
|
} | null | undefined;
|
|
239
246
|
slug: string;
|
|
240
247
|
suffix?: string | null | undefined;
|
|
@@ -274,7 +281,7 @@ declare const PersonSimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
274
281
|
sourceId: string;
|
|
275
282
|
sourceJson: string;
|
|
276
283
|
sourceText: string;
|
|
277
|
-
sourceType:
|
|
284
|
+
sourceType: string;
|
|
278
285
|
} | null | undefined;
|
|
279
286
|
slug: string;
|
|
280
287
|
suffix?: string | null | undefined;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
declare const SearchAnswerCitationSchemaDefinition: z.ZodObject<{
|
|
3
|
+
entityId: z.ZodUUID;
|
|
4
|
+
source: z.ZodEnum<{
|
|
5
|
+
entityRecord: "entityRecord";
|
|
6
|
+
newsArticle: "newsArticle";
|
|
7
|
+
researchSnippet: "researchSnippet";
|
|
8
|
+
}>;
|
|
9
|
+
sourceId: z.ZodString;
|
|
10
|
+
}, z.core.$strip>;
|
|
11
|
+
type SearchAnswerCitationDefinition = z.infer<typeof SearchAnswerCitationSchemaDefinition>;
|
|
12
|
+
/**
|
|
13
|
+
* One piece of evidence an answer cites, by its owning record.
|
|
14
|
+
*
|
|
15
|
+
* @openapiSchema SearchAnswerCitation
|
|
16
|
+
* @endpoint GET /v1/search/link
|
|
17
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
18
|
+
* @endpoint POST /v1/search
|
|
19
|
+
* @endpoint POST /v1/search/natural/entities
|
|
20
|
+
* @usedBySchema SearchAnswerSchema
|
|
21
|
+
* @contractShape search.answer-citation
|
|
22
|
+
* @contractRole canonical
|
|
23
|
+
*/
|
|
24
|
+
export declare const SearchAnswerCitationSchema: z.ZodType<SearchAnswerCitationDefinition>;
|
|
25
|
+
export type SearchAnswerCitation = z.infer<typeof SearchAnswerCitationSchema>;
|
|
26
|
+
export {};
|
|
27
|
+
//# sourceMappingURL=answer-citation.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
import { SearchEvidenceSourceSchema } from "./evidence-source.js";
|
|
4
|
+
const SearchAnswerCitationSchemaDefinition = z.object({
|
|
5
|
+
/** Entity the evidence is about. */
|
|
6
|
+
entityId: z.uuid(),
|
|
7
|
+
/** Record that owns the cited evidence. */
|
|
8
|
+
source: SearchEvidenceSourceSchema,
|
|
9
|
+
/** Entity id for `entityRecord`, else the snippet or news article id from `passage`. */
|
|
10
|
+
sourceId: z.string(),
|
|
11
|
+
});
|
|
12
|
+
/**
|
|
13
|
+
* One piece of evidence an answer cites, by its owning record.
|
|
14
|
+
*
|
|
15
|
+
* @openapiSchema SearchAnswerCitation
|
|
16
|
+
* @endpoint GET /v1/search/link
|
|
17
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
18
|
+
* @endpoint POST /v1/search
|
|
19
|
+
* @endpoint POST /v1/search/natural/entities
|
|
20
|
+
* @usedBySchema SearchAnswerSchema
|
|
21
|
+
* @contractShape search.answer-citation
|
|
22
|
+
* @contractRole canonical
|
|
23
|
+
*/
|
|
24
|
+
export const SearchAnswerCitationSchema = SearchAnswerCitationSchemaDefinition;
|
|
25
|
+
//# sourceMappingURL=answer-citation.js.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Written answer to a natural-language question, grounded only in the response's entity records and passages. LOW confidence with no citation means the evidence does not answer the question.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema SearchAnswer
|
|
6
|
+
* @endpoint GET /v1/search/link
|
|
7
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
8
|
+
* @endpoint POST /v1/search
|
|
9
|
+
* @endpoint POST /v1/search/natural/entities
|
|
10
|
+
* @usedBySchema NaturalSearchResultSchema
|
|
11
|
+
* @contractShape search.answer
|
|
12
|
+
* @contractRole canonical
|
|
13
|
+
*/
|
|
14
|
+
export declare const SearchAnswerSchema: z.ZodObject<{
|
|
15
|
+
citation: z.ZodArray<z.ZodType<{
|
|
16
|
+
entityId: string;
|
|
17
|
+
source: "entityRecord" | "newsArticle" | "researchSnippet";
|
|
18
|
+
sourceId: string;
|
|
19
|
+
}, unknown, z.core.$ZodTypeInternals<{
|
|
20
|
+
entityId: string;
|
|
21
|
+
source: "entityRecord" | "newsArticle" | "researchSnippet";
|
|
22
|
+
sourceId: string;
|
|
23
|
+
}, unknown>>>;
|
|
24
|
+
confidence: z.ZodEnum<{
|
|
25
|
+
HIGH: "HIGH";
|
|
26
|
+
LOW: "LOW";
|
|
27
|
+
MEDIUM: "MEDIUM";
|
|
28
|
+
}>;
|
|
29
|
+
text: z.ZodString;
|
|
30
|
+
}, z.core.$strip>;
|
|
31
|
+
export type SearchAnswer = z.infer<typeof SearchAnswerSchema>;
|
|
32
|
+
//# sourceMappingURL=answer.d.ts.map
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
import { ConfidenceSchema } from "../confidence/confidence.js";
|
|
4
|
+
import { SearchAnswerCitationSchema } from "./answer-citation.js";
|
|
5
|
+
/**
|
|
6
|
+
* Written answer to a natural-language question, grounded only in the response's entity records and passages. LOW confidence with no citation means the evidence does not answer the question.
|
|
7
|
+
*
|
|
8
|
+
* @openapiSchema SearchAnswer
|
|
9
|
+
* @endpoint GET /v1/search/link
|
|
10
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
11
|
+
* @endpoint POST /v1/search
|
|
12
|
+
* @endpoint POST /v1/search/natural/entities
|
|
13
|
+
* @usedBySchema NaturalSearchResultSchema
|
|
14
|
+
* @contractShape search.answer
|
|
15
|
+
* @contractRole canonical
|
|
16
|
+
*/
|
|
17
|
+
export const SearchAnswerSchema = z.object({
|
|
18
|
+
/** Evidence each claim rests on, in first-use order. */
|
|
19
|
+
citation: z.array(SearchAnswerCitationSchema),
|
|
20
|
+
/** How fully the cited evidence answers the question. */
|
|
21
|
+
confidence: ConfidenceSchema,
|
|
22
|
+
/** Answer text in plain prose. */
|
|
23
|
+
text: z.string(),
|
|
24
|
+
});
|
|
25
|
+
//# sourceMappingURL=answer.js.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Owner of search evidence: `entityRecord` is the entity's structured record, `researchSnippet` an entity research snippet, `newsArticle` a news article linked to the entity.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema SearchEvidenceSource
|
|
6
|
+
* @endpoint GET /v1/search/link
|
|
7
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
8
|
+
* @endpoint POST /v1/search
|
|
9
|
+
* @endpoint POST /v1/search/natural/entities
|
|
10
|
+
* @usedBySchema SearchAnswerCitationSchema
|
|
11
|
+
* @usedBySchema SearchPassageSchema
|
|
12
|
+
* @contractShape search.evidence-source
|
|
13
|
+
* @contractRole canonical
|
|
14
|
+
*/
|
|
15
|
+
export declare const SearchEvidenceSourceSchema: z.ZodEnum<{
|
|
16
|
+
entityRecord: "entityRecord";
|
|
17
|
+
newsArticle: "newsArticle";
|
|
18
|
+
researchSnippet: "researchSnippet";
|
|
19
|
+
}>;
|
|
20
|
+
export type SearchEvidenceSource = z.infer<typeof SearchEvidenceSourceSchema>;
|
|
21
|
+
//# sourceMappingURL=evidence-source.d.ts.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
/**
|
|
4
|
+
* Owner of search evidence: `entityRecord` is the entity's structured record, `researchSnippet` an entity research snippet, `newsArticle` a news article linked to the entity.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema SearchEvidenceSource
|
|
7
|
+
* @endpoint GET /v1/search/link
|
|
8
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
9
|
+
* @endpoint POST /v1/search
|
|
10
|
+
* @endpoint POST /v1/search/natural/entities
|
|
11
|
+
* @usedBySchema SearchAnswerCitationSchema
|
|
12
|
+
* @usedBySchema SearchPassageSchema
|
|
13
|
+
* @contractShape search.evidence-source
|
|
14
|
+
* @contractRole canonical
|
|
15
|
+
*/
|
|
16
|
+
export const SearchEvidenceSourceSchema = z.enum([
|
|
17
|
+
"entityRecord",
|
|
18
|
+
"researchSnippet",
|
|
19
|
+
"newsArticle",
|
|
20
|
+
]);
|
|
21
|
+
//# sourceMappingURL=evidence-source.js.map
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Question shape the planner read from a natural-language search. `discovery` lists entities matching a description; `profile` asks what a named entity does, offers, or how it stands; `peer` asks for a named entity's competitors or look-alikes; `comparison` asks how two or more named entities compare.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema SearchIntent
|
|
6
|
+
* @endpoint GET /v1/search/link
|
|
7
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
8
|
+
* @endpoint POST /v1/search
|
|
9
|
+
* @endpoint POST /v1/search/natural/entities
|
|
10
|
+
* @usedBySchema SearchInterpretationSchema
|
|
11
|
+
* @contractShape search.intent
|
|
12
|
+
* @contractRole canonical
|
|
13
|
+
*/
|
|
14
|
+
export declare const SearchIntentSchema: z.ZodEnum<{
|
|
15
|
+
comparison: "comparison";
|
|
16
|
+
discovery: "discovery";
|
|
17
|
+
peer: "peer";
|
|
18
|
+
profile: "profile";
|
|
19
|
+
}>;
|
|
20
|
+
export type SearchIntent = z.infer<typeof SearchIntentSchema>;
|
|
21
|
+
//# sourceMappingURL=intent.d.ts.map
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
/**
|
|
4
|
+
* Question shape the planner read from a natural-language search. `discovery` lists entities matching a description; `profile` asks what a named entity does, offers, or how it stands; `peer` asks for a named entity's competitors or look-alikes; `comparison` asks how two or more named entities compare.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema SearchIntent
|
|
7
|
+
* @endpoint GET /v1/search/link
|
|
8
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
9
|
+
* @endpoint POST /v1/search
|
|
10
|
+
* @endpoint POST /v1/search/natural/entities
|
|
11
|
+
* @usedBySchema SearchInterpretationSchema
|
|
12
|
+
* @contractShape search.intent
|
|
13
|
+
* @contractRole canonical
|
|
14
|
+
*/
|
|
15
|
+
export const SearchIntentSchema = z.enum(["discovery", "profile", "peer", "comparison"]);
|
|
16
|
+
//# sourceMappingURL=intent.js.map
|
|
@@ -210,6 +210,12 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
|
|
|
210
210
|
min?: number | null | undefined;
|
|
211
211
|
}[] | undefined;
|
|
212
212
|
}, unknown>>;
|
|
213
|
+
intent: z.ZodEnum<{
|
|
214
|
+
comparison: "comparison";
|
|
215
|
+
discovery: "discovery";
|
|
216
|
+
peer: "peer";
|
|
217
|
+
profile: "profile";
|
|
218
|
+
}>;
|
|
213
219
|
interpretation: z.ZodString;
|
|
214
220
|
sort: z.ZodType<{
|
|
215
221
|
order: {
|
|
@@ -224,6 +230,7 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
|
|
|
224
230
|
}[];
|
|
225
231
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
226
232
|
}, unknown>>;
|
|
233
|
+
subjectEntityName: z.ZodArray<z.ZodString>;
|
|
227
234
|
unsupported: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
228
235
|
}, z.core.$strip>;
|
|
229
236
|
type SearchInterpretationDefinition = z.infer<typeof SearchInterpretationSchemaDefinition>;
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { ConfidenceSchema } from "../confidence/confidence.js";
|
|
4
4
|
import { EntityListFilterSchema } from "../entity/list-filter.js";
|
|
5
|
+
import { SearchIntentSchema } from "./intent.js";
|
|
5
6
|
import { SearchModeExecutionSchema } from "./mode-execution.js";
|
|
6
7
|
import { SearchOrderingEntityFilterSortableSchema } from "./ordering-entity-filter-sortable.js";
|
|
7
8
|
const SearchInterpretationSchemaDefinition = z.object({
|
|
@@ -13,10 +14,14 @@ const SearchInterpretationSchemaDefinition = z.object({
|
|
|
13
14
|
fallbackUsed: z.boolean(),
|
|
14
15
|
/** Canonical entity filter generated from the natural-language query. */
|
|
15
16
|
filter: EntityListFilterSchema,
|
|
17
|
+
/** Question shape the planner read from the query. */
|
|
18
|
+
intent: SearchIntentSchema,
|
|
16
19
|
/** Human-readable summary of how the query was interpreted. */
|
|
17
20
|
interpretation: z.string(),
|
|
18
21
|
/** Ordering applied to the result page: the relevance rank that ran first, if any, then the sortable-column terms. */
|
|
19
22
|
sort: SearchOrderingEntityFilterSortableSchema,
|
|
23
|
+
/** Brand or legal names of the entities the question is about, as written in the query; empty for discovery questions. */
|
|
24
|
+
subjectEntityName: z.array(z.string()),
|
|
20
25
|
/** Constraint the planner could not translate into the canonical EntityFilter contract; null when every material constraint was supported. */
|
|
21
26
|
unsupported: z.string().nullish(),
|
|
22
27
|
});
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Optional answer layer for a natural-language entity search. `passage` adds the text passages, from public research snippets and linked news, that best answer the question about the subject entities, their peers, or the top results; `synthesis` adds a written answer grounded only in those records and passages, citing each, and implies `passage`.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema SearchLayer
|
|
6
|
+
* @endpoint POST /v1/search/natural/entities
|
|
7
|
+
* @contractShape search.layer
|
|
8
|
+
* @contractRole canonical
|
|
9
|
+
*/
|
|
10
|
+
export declare const SearchLayerSchema: z.ZodEnum<{
|
|
11
|
+
passage: "passage";
|
|
12
|
+
synthesis: "synthesis";
|
|
13
|
+
}>;
|
|
14
|
+
export type SearchLayer = z.infer<typeof SearchLayerSchema>;
|
|
15
|
+
//# sourceMappingURL=layer.d.ts.map
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
/**
|
|
4
|
+
* Optional answer layer for a natural-language entity search. `passage` adds the text passages, from public research snippets and linked news, that best answer the question about the subject entities, their peers, or the top results; `synthesis` adds a written answer grounded only in those records and passages, citing each, and implies `passage`.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema SearchLayer
|
|
7
|
+
* @endpoint POST /v1/search/natural/entities
|
|
8
|
+
* @contractShape search.layer
|
|
9
|
+
* @contractRole canonical
|
|
10
|
+
*/
|
|
11
|
+
export const SearchLayerSchema = z.enum(["passage", "synthesis"]);
|
|
12
|
+
//# sourceMappingURL=layer.js.map
|
package/dist/search/mode.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts
|
|
3
|
+
* Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword` (the full text of articles, posts, and fetched pages), and `semantic` (one entity's or person's library pages by vector similarity of their fetched bodies).
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema SearchMode
|
|
6
6
|
* @endpoint GET /v1/search/link
|
package/dist/search/mode.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
/**
|
|
4
|
-
* Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts
|
|
4
|
+
* Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword` (the full text of articles, posts, and fetched pages), and `semantic` (one entity's or person's library pages by vector similarity of their fetched bodies).
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema SearchMode
|
|
7
7
|
* @endpoint GET /v1/search/link
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
declare const SearchPassageSchemaDefinition: z.ZodObject<{
|
|
3
|
+
entityId: z.ZodUUID;
|
|
4
|
+
label: z.ZodString;
|
|
5
|
+
publishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
6
|
+
score: z.ZodNumber;
|
|
7
|
+
source: z.ZodEnum<{
|
|
8
|
+
entityRecord: "entityRecord";
|
|
9
|
+
newsArticle: "newsArticle";
|
|
10
|
+
researchSnippet: "researchSnippet";
|
|
11
|
+
}>;
|
|
12
|
+
sourceId: z.ZodString;
|
|
13
|
+
text: z.ZodString;
|
|
14
|
+
url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
15
|
+
}, z.core.$strip>;
|
|
16
|
+
type SearchPassageDefinition = z.infer<typeof SearchPassageSchemaDefinition>;
|
|
17
|
+
/**
|
|
18
|
+
* Text passage ranked by semantic closeness to a natural-language question, read from its owning record.
|
|
19
|
+
*
|
|
20
|
+
* @openapiSchema SearchPassage
|
|
21
|
+
* @endpoint GET /v1/search/link
|
|
22
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
23
|
+
* @endpoint POST /v1/search
|
|
24
|
+
* @endpoint POST /v1/search/natural/entities
|
|
25
|
+
* @usedBySchema NaturalSearchResultSchema
|
|
26
|
+
* @contractShape search.passage
|
|
27
|
+
* @contractRole canonical
|
|
28
|
+
*/
|
|
29
|
+
export declare const SearchPassageSchema: z.ZodType<SearchPassageDefinition>;
|
|
30
|
+
export type SearchPassage = z.infer<typeof SearchPassageSchema>;
|
|
31
|
+
export {};
|
|
32
|
+
//# sourceMappingURL=passage.d.ts.map
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
import { SearchEvidenceSourceSchema } from "./evidence-source.js";
|
|
4
|
+
const SearchPassageSchemaDefinition = z.object({
|
|
5
|
+
/** Entity the passage is about. */
|
|
6
|
+
entityId: z.uuid(),
|
|
7
|
+
/** Snippet type key for research snippets, or the article title for news articles. */
|
|
8
|
+
label: z.string(),
|
|
9
|
+
/** Article publication time for news passages; null for snippets. */
|
|
10
|
+
publishedAt: z.iso.datetime({ offset: true }).nullish(),
|
|
11
|
+
/** Cosine similarity between the question and the passage; higher is closer. Compare scores only within one response. */
|
|
12
|
+
score: z.number(),
|
|
13
|
+
/** Record type that owns the passage text. */
|
|
14
|
+
source: SearchEvidenceSourceSchema,
|
|
15
|
+
/** Identifier of the owning snippet or news article. */
|
|
16
|
+
sourceId: z.string(),
|
|
17
|
+
/** Passage text: the snippet, or the article summary or excerpt. */
|
|
18
|
+
text: z.string(),
|
|
19
|
+
/** Original article URL for news passages; null for snippets. */
|
|
20
|
+
url: z.string().nullish(),
|
|
21
|
+
});
|
|
22
|
+
/**
|
|
23
|
+
* Text passage ranked by semantic closeness to a natural-language question, read from its owning record.
|
|
24
|
+
*
|
|
25
|
+
* @openapiSchema SearchPassage
|
|
26
|
+
* @endpoint GET /v1/search/link
|
|
27
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
28
|
+
* @endpoint POST /v1/search
|
|
29
|
+
* @endpoint POST /v1/search/natural/entities
|
|
30
|
+
* @usedBySchema NaturalSearchResultSchema
|
|
31
|
+
* @contractShape search.passage
|
|
32
|
+
* @contractRole canonical
|
|
33
|
+
*/
|
|
34
|
+
export const SearchPassageSchema = SearchPassageSchemaDefinition;
|
|
35
|
+
//# sourceMappingURL=passage.js.map
|