@aventurevc/api-schemas 0.8.114 → 0.8.125
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/address/address.js +2 -2
- package/dist/address/association-role.d.ts +1 -1
- package/dist/address/association-role.js +1 -1
- package/dist/agent/help.d.ts +20 -4
- package/dist/datasource/data-source-type.d.ts +24 -0
- package/dist/datasource/data-source-type.js +24 -0
- package/dist/entity/detail.d.ts +2 -0
- package/dist/entity/enrichment.d.ts +1 -0
- package/dist/entity/enrichment.js +2 -0
- package/dist/entity/filter-sortable.d.ts +39 -0
- package/dist/entity/filter-sortable.js +42 -0
- package/dist/entity/filter.js +2 -2
- package/dist/entity/investor-participation.d.ts +2 -0
- package/dist/entity/list-filter.js +2 -2
- package/dist/entity/list.d.ts +2 -0
- package/dist/entity/natural-search.d.ts +2 -0
- package/dist/entity/person-association.js +1 -1
- package/dist/entity/resolution.d.ts +2 -0
- package/dist/entity/similarity-result.d.ts +2 -0
- package/dist/federated/natural-search.d.ts +12 -12
- package/dist/federated/natural-search.js +14 -11
- package/dist/federated/search.d.ts +12 -2
- package/dist/harness/task-plan-step.d.ts +8 -0
- package/dist/harness/task-plan-step.js +3 -0
- package/dist/harness/task-plan.d.ts +16 -0
- package/dist/harness/task-write-guidance.d.ts +21 -0
- package/dist/harness/task-write-guidance.js +27 -0
- package/dist/help/citation.d.ts +4 -2
- package/dist/help/resolution.d.ts +18 -2
- package/dist/help/source-type.d.ts +4 -2
- package/dist/help/source-type.js +11 -6
- package/dist/http/problem-detail.d.ts +12 -0
- package/dist/http/problem-detail.js +5 -0
- package/dist/link/search.d.ts +12 -2
- package/dist/lookup/job-mention.d.ts +2 -0
- package/dist/lookup/job-mutation.d.ts +2 -1
- package/dist/lookup/job-mutation.js +3 -1
- package/dist/lookup/job.d.ts +4 -0
- package/dist/mention/lookup.d.ts +2 -0
- package/dist/natural/search-result.d.ts +9 -2
- package/dist/natural/search.d.ts +1 -0
- package/dist/natural/search.js +3 -1
- package/dist/openapi-component-manifest.js +15 -0
- package/dist/pagination/schemas.d.ts +10 -0
- package/dist/person/natural-search.d.ts +2 -0
- package/dist/prose/problem.d.ts +24 -0
- package/dist/prose/problem.js +27 -0
- package/dist/prose/violation.d.ts +32 -0
- package/dist/prose/violation.js +24 -0
- package/dist/reasoning/effort.d.ts +1 -0
- package/dist/reasoning/effort.js +1 -0
- package/dist/research/snippet-type.d.ts +1 -0
- package/dist/research/snippet-type.js +2 -0
- package/dist/search/answer.d.ts +1 -0
- package/dist/search/answer.js +3 -1
- package/dist/search/cache-mode.d.ts +1 -0
- package/dist/search/cache-mode.js +1 -0
- package/dist/search/interpretation.d.ts +2 -2
- package/dist/search/layer.d.ts +2 -0
- package/dist/search/layer.js +2 -0
- package/dist/search/ordering-entity-filter-sortable.d.ts +2 -2
- package/dist/shared/search-mutation.d.ts +208 -0
- package/dist/shared/search-mutation.js +8 -0
- package/dist/shared/search.d.ts +12 -2
- package/dist/sort/order-entity-filter-sortable.d.ts +4 -2
- package/dist/sort/order-entity-filter-sortable.js +2 -19
- package/dist/suppression/reason.d.ts +17 -0
- package/dist/suppression/reason.js +16 -0
- package/package.json +1 -1
package/dist/address/address.js
CHANGED
|
@@ -61,11 +61,11 @@ export const AddressSchema = z.object({
|
|
|
61
61
|
createdAt: z.iso.datetime({ offset: true }).nullish(),
|
|
62
62
|
/** Single-line formatted address */
|
|
63
63
|
fullAddress: z.string().nullish(),
|
|
64
|
-
/**
|
|
64
|
+
/** Id of this listed row's first association; PATCH and DELETE address one association by its association[].id, so a row holding several roles needs one call each */
|
|
65
65
|
id: z.int().nullish(),
|
|
66
66
|
/** Deprecated aggregate compatibility flag; true when any association is current */
|
|
67
67
|
isCurrent: z.boolean().nullish(),
|
|
68
|
-
/** Deprecated legacy flag marking the
|
|
68
|
+
/** Deprecated legacy flag marking the current legal/registered seat (domicile), not the operating headquarters; read EntityEnrichment.headquartersAddressId for the headquarters */
|
|
69
69
|
isHq: z.boolean().nullish(),
|
|
70
70
|
/** Deprecated legacy flag marking the primary display address */
|
|
71
71
|
isPrimary: z.boolean().nullish(),
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Meaning of an entity or person address association.
|
|
3
|
+
* Meaning of an entity or person address association. Dominant is the operating headquarters; domicile is the legal or registered seat and is not evidence of operational presence; origin is the founding or historical location.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema AddressAssociationRole
|
|
6
6
|
* @endpoint GET /v1/entities
|
|
@@ -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
|
-
* Meaning of an entity or person address association.
|
|
4
|
+
* Meaning of an entity or person address association. Dominant is the operating headquarters; domicile is the legal or registered seat and is not evidence of operational presence; origin is the founding or historical location.
|
|
5
5
|
*
|
|
6
6
|
* @openapiSchema AddressAssociationRole
|
|
7
7
|
* @endpoint GET /v1/entities
|
package/dist/agent/help.d.ts
CHANGED
|
@@ -4,12 +4,12 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
|
|
|
4
4
|
citation: z.ZodArray<z.ZodType<{
|
|
5
5
|
excerpt: string;
|
|
6
6
|
sourceId: string;
|
|
7
|
-
sourceType:
|
|
7
|
+
sourceType: string;
|
|
8
8
|
sourceVersion?: string | null | undefined;
|
|
9
9
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
10
10
|
excerpt: string;
|
|
11
11
|
sourceId: string;
|
|
12
|
-
sourceType:
|
|
12
|
+
sourceType: string;
|
|
13
13
|
sourceVersion?: string | null | undefined;
|
|
14
14
|
}, unknown>>>;
|
|
15
15
|
confidence: z.ZodEnum<{
|
|
@@ -21,12 +21,12 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
|
|
|
21
21
|
candidate: z.ZodArray<z.ZodType<{
|
|
22
22
|
excerpt: string;
|
|
23
23
|
sourceId: string;
|
|
24
|
-
sourceType:
|
|
24
|
+
sourceType: string;
|
|
25
25
|
sourceVersion?: string | null | undefined;
|
|
26
26
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
27
27
|
excerpt: string;
|
|
28
28
|
sourceId: string;
|
|
29
|
-
sourceType:
|
|
29
|
+
sourceType: string;
|
|
30
30
|
sourceVersion?: string | null | undefined;
|
|
31
31
|
}, unknown>>>;
|
|
32
32
|
operationId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -58,6 +58,14 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
|
|
|
58
58
|
operationId: string;
|
|
59
59
|
stepKey: string;
|
|
60
60
|
};
|
|
61
|
+
writeGuidance?: {
|
|
62
|
+
body: string;
|
|
63
|
+
expectation: string;
|
|
64
|
+
method: string[];
|
|
65
|
+
override: string;
|
|
66
|
+
reject: string[];
|
|
67
|
+
typeCatalog: string;
|
|
68
|
+
} | null | undefined;
|
|
61
69
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
62
70
|
cliCommand: string;
|
|
63
71
|
mcpTool?: string | null | undefined;
|
|
@@ -66,6 +74,14 @@ declare const AgentHelpSchemaDefinition: z.ZodObject<{
|
|
|
66
74
|
operationId: string;
|
|
67
75
|
stepKey: string;
|
|
68
76
|
};
|
|
77
|
+
writeGuidance?: {
|
|
78
|
+
body: string;
|
|
79
|
+
expectation: string;
|
|
80
|
+
method: string[];
|
|
81
|
+
override: string;
|
|
82
|
+
reject: string[];
|
|
83
|
+
typeCatalog: string;
|
|
84
|
+
} | null | undefined;
|
|
69
85
|
}, unknown>>>;
|
|
70
86
|
taskKey: z.ZodString;
|
|
71
87
|
}, z.core.$strip>>>;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Full read/storage source type for field-level provenance rows. Write query parameters use DatasourceWritableDataSourceType.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema DatasourceDataSourceType
|
|
6
|
+
* @endpoint GET /v1/entities
|
|
7
|
+
* @contractShape datasource.data-source-type
|
|
8
|
+
* @contractRole canonical
|
|
9
|
+
*/
|
|
10
|
+
export declare const DatasourceDataSourceTypeSchema: z.ZodEnum<{
|
|
11
|
+
api: "api";
|
|
12
|
+
aventureStaff: "aventureStaff";
|
|
13
|
+
blogArticle: "blogArticle";
|
|
14
|
+
firstPartyWebsite: "firstPartyWebsite";
|
|
15
|
+
import: "import";
|
|
16
|
+
llm: "llm";
|
|
17
|
+
manual: "manual";
|
|
18
|
+
newsArticle: "newsArticle";
|
|
19
|
+
relatedPartyWebsite: "relatedPartyWebsite";
|
|
20
|
+
requestChangeForm: "requestChangeForm";
|
|
21
|
+
thirdPartyWebsite: "thirdPartyWebsite";
|
|
22
|
+
}>;
|
|
23
|
+
export type DatasourceDataSourceType = z.infer<typeof DatasourceDataSourceTypeSchema>;
|
|
24
|
+
//# sourceMappingURL=data-source-type.d.ts.map
|
|
@@ -0,0 +1,24 @@
|
|
|
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
|
+
* Full read/storage source type for field-level provenance rows. Write query parameters use DatasourceWritableDataSourceType.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema DatasourceDataSourceType
|
|
7
|
+
* @endpoint GET /v1/entities
|
|
8
|
+
* @contractShape datasource.data-source-type
|
|
9
|
+
* @contractRole canonical
|
|
10
|
+
*/
|
|
11
|
+
export const DatasourceDataSourceTypeSchema = z.enum([
|
|
12
|
+
"requestChangeForm",
|
|
13
|
+
"newsArticle",
|
|
14
|
+
"blogArticle",
|
|
15
|
+
"firstPartyWebsite",
|
|
16
|
+
"relatedPartyWebsite",
|
|
17
|
+
"thirdPartyWebsite",
|
|
18
|
+
"llm",
|
|
19
|
+
"aventureStaff",
|
|
20
|
+
"api",
|
|
21
|
+
"manual",
|
|
22
|
+
"import",
|
|
23
|
+
]);
|
|
24
|
+
//# sourceMappingURL=data-source-type.js.map
|
package/dist/entity/detail.d.ts
CHANGED
|
@@ -330,6 +330,7 @@ export declare const EntityDetailSchema: z.ZodObject<{
|
|
|
330
330
|
totalRaisedUsd?: number | null | undefined;
|
|
331
331
|
unconvertedRoundCount: number;
|
|
332
332
|
} | null | undefined;
|
|
333
|
+
headquartersAddressId?: number | null | undefined;
|
|
333
334
|
text: {
|
|
334
335
|
expanded?: string | null | undefined;
|
|
335
336
|
generatedDescription?: string | null | undefined;
|
|
@@ -611,6 +612,7 @@ export declare const EntityDetailSchema: z.ZodObject<{
|
|
|
611
612
|
totalRaisedUsd?: number | null | undefined;
|
|
612
613
|
unconvertedRoundCount: number;
|
|
613
614
|
} | null | undefined;
|
|
615
|
+
headquartersAddressId?: number | null | undefined;
|
|
614
616
|
text: {
|
|
615
617
|
expanded?: string | null | undefined;
|
|
616
618
|
generatedDescription?: string | null | undefined;
|
|
@@ -501,6 +501,7 @@ declare const EntityEnrichmentSchemaDefinition: z.ZodObject<{
|
|
|
501
501
|
totalRaisedUsd: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
502
502
|
unconvertedRoundCount: z.ZodInt;
|
|
503
503
|
}, z.core.$strip>>>;
|
|
504
|
+
headquartersAddressId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
504
505
|
text: z.ZodType<{
|
|
505
506
|
expanded?: string | null | undefined;
|
|
506
507
|
generatedDescription?: string | null | undefined;
|
|
@@ -10,6 +10,8 @@ const EntityEnrichmentSchemaDefinition = z.object({
|
|
|
10
10
|
/** Entity classification join projection for this read surface. Single-detail and full-detail batch reads include full history; list, default batch, and similar-entity reads may filter to current joins. Use GET /v1/entities/{entityId}/classifications?includeInactive=true for authoritative join history. */
|
|
11
11
|
classification: EntityClassificationSchema,
|
|
12
12
|
fundingDetail: EntityFundingDetailSchema.nullish(),
|
|
13
|
+
/** Address id of the current headquarters: the current dominant (operating) address; absent when none is on record, even when a domicile (legal seat) exists. Read this instead of the deprecated isHq flag, which marks the legal seat. */
|
|
14
|
+
headquartersAddressId: z.int().nullish(),
|
|
13
15
|
text: EntityTextBundleSchema,
|
|
14
16
|
/** URL link filter values */
|
|
15
17
|
urlLink: z.array(EntityUrlLinkSchema),
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Entity filter sortable
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema EntityFilterSortable
|
|
6
|
+
* @endpoint GET /v1/search/link
|
|
7
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
8
|
+
* @endpoint GET /v1/search/shared/{id}
|
|
9
|
+
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
10
|
+
* @endpoint POST /v1/search
|
|
11
|
+
* @endpoint POST /v1/search/natural/entities
|
|
12
|
+
* @endpoint POST /v1/search/shared
|
|
13
|
+
* @usedBySchema SortOrderEntityFilterSortableSchema
|
|
14
|
+
* @contractShape entity.filter-sortable
|
|
15
|
+
* @contractRole canonical
|
|
16
|
+
*/
|
|
17
|
+
export declare const EntityFilterSortableSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
18
|
+
ACCELERATOR_BRAND: "ACCELERATOR_BRAND";
|
|
19
|
+
ACCELERATOR_COHORT: "ACCELERATOR_COHORT";
|
|
20
|
+
AMOUNT_INVESTED: "AMOUNT_INVESTED";
|
|
21
|
+
CREATED_AT: "CREATED_AT";
|
|
22
|
+
DATA_COMPLETION_COVERAGE: "DATA_COMPLETION_COVERAGE";
|
|
23
|
+
EMPLOYEE_COUNT: "EMPLOYEE_COUNT";
|
|
24
|
+
HEADQUARTERS_COUNTRY: "HEADQUARTERS_COUNTRY";
|
|
25
|
+
ID: "ID";
|
|
26
|
+
LATEST_VALUATION: "LATEST_VALUATION";
|
|
27
|
+
MOST_RECENT_AMOUNT: "MOST_RECENT_AMOUNT";
|
|
28
|
+
MOST_RECENT_DATE: "MOST_RECENT_DATE";
|
|
29
|
+
NAME_BRAND: "NAME_BRAND";
|
|
30
|
+
NEXT_DUE_AT: "NEXT_DUE_AT";
|
|
31
|
+
RECENT_INVESTMENT_AT: "RECENT_INVESTMENT_AT";
|
|
32
|
+
STAGE: "STAGE";
|
|
33
|
+
STATUS_OPERATING: "STATUS_OPERATING";
|
|
34
|
+
TOTAL_RAISED: "TOTAL_RAISED";
|
|
35
|
+
UPDATED_AT: "UPDATED_AT";
|
|
36
|
+
YEAR_FOUNDED: "YEAR_FOUNDED";
|
|
37
|
+
}>, z.ZodString]>;
|
|
38
|
+
export type EntityFilterSortable = z.infer<typeof EntityFilterSortableSchema>;
|
|
39
|
+
//# sourceMappingURL=filter-sortable.d.ts.map
|
|
@@ -0,0 +1,42 @@
|
|
|
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
|
+
* Entity filter sortable
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema EntityFilterSortable
|
|
7
|
+
* @endpoint GET /v1/search/link
|
|
8
|
+
* @endpoint GET /v1/search/link/jobs/{jobId}
|
|
9
|
+
* @endpoint GET /v1/search/shared/{id}
|
|
10
|
+
* @endpoint GET /v1/search/shared/slug/{slug}
|
|
11
|
+
* @endpoint POST /v1/search
|
|
12
|
+
* @endpoint POST /v1/search/natural/entities
|
|
13
|
+
* @endpoint POST /v1/search/shared
|
|
14
|
+
* @usedBySchema SortOrderEntityFilterSortableSchema
|
|
15
|
+
* @contractShape entity.filter-sortable
|
|
16
|
+
* @contractRole canonical
|
|
17
|
+
*/
|
|
18
|
+
export const EntityFilterSortableSchema = z.union([
|
|
19
|
+
z.enum([
|
|
20
|
+
"ID",
|
|
21
|
+
"NAME_BRAND",
|
|
22
|
+
"YEAR_FOUNDED",
|
|
23
|
+
"STATUS_OPERATING",
|
|
24
|
+
"UPDATED_AT",
|
|
25
|
+
"CREATED_AT",
|
|
26
|
+
"NEXT_DUE_AT",
|
|
27
|
+
"DATA_COMPLETION_COVERAGE",
|
|
28
|
+
"TOTAL_RAISED",
|
|
29
|
+
"AMOUNT_INVESTED",
|
|
30
|
+
"RECENT_INVESTMENT_AT",
|
|
31
|
+
"STAGE",
|
|
32
|
+
"MOST_RECENT_AMOUNT",
|
|
33
|
+
"LATEST_VALUATION",
|
|
34
|
+
"MOST_RECENT_DATE",
|
|
35
|
+
"ACCELERATOR_BRAND",
|
|
36
|
+
"ACCELERATOR_COHORT",
|
|
37
|
+
"HEADQUARTERS_COUNTRY",
|
|
38
|
+
"EMPLOYEE_COUNT",
|
|
39
|
+
]),
|
|
40
|
+
z.string(),
|
|
41
|
+
]);
|
|
42
|
+
//# sourceMappingURL=filter-sortable.js.map
|
package/dist/entity/filter.js
CHANGED
|
@@ -83,7 +83,7 @@ export const EntityFilterSchema = z.strictObject({
|
|
|
83
83
|
portfolioHeadquartersCountry: z.array(z.string()).optional(),
|
|
84
84
|
/** Portfolio-company headquarters state or region values. */
|
|
85
85
|
portfolioHeadquartersState: z.array(z.string()).optional(),
|
|
86
|
-
/**
|
|
86
|
+
/** Server-owned list quality gate. */
|
|
87
87
|
qualityGate: EntityListQualityGateSchema.optional(),
|
|
88
88
|
/** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
|
|
89
89
|
rankByProminence: z.boolean().nullish(),
|
|
@@ -100,7 +100,7 @@ export const EntityFilterSchema = z.strictObject({
|
|
|
100
100
|
suppressLateStage: z.boolean().nullish(),
|
|
101
101
|
/** Suppress entities with terminal operating status. */
|
|
102
102
|
suppressNonOperating: z.boolean().nullish(),
|
|
103
|
-
/** Suppress entities
|
|
103
|
+
/** Suppress entities with zero or unknown USD total raised. */
|
|
104
104
|
suppressZeroTotalRaised: z.boolean().nullish(),
|
|
105
105
|
/** General classification tag values. */
|
|
106
106
|
tag: z.array(z.string()).optional(),
|
|
@@ -308,6 +308,7 @@ declare const EntityInvestorParticipationSchemaDefinition: z.ZodObject<{
|
|
|
308
308
|
totalRaisedUsd?: number | null | undefined;
|
|
309
309
|
unconvertedRoundCount: number;
|
|
310
310
|
} | null | undefined;
|
|
311
|
+
headquartersAddressId?: number | null | undefined;
|
|
311
312
|
text: {
|
|
312
313
|
expanded?: string | null | undefined;
|
|
313
314
|
generatedDescription?: string | null | undefined;
|
|
@@ -589,6 +590,7 @@ declare const EntityInvestorParticipationSchemaDefinition: z.ZodObject<{
|
|
|
589
590
|
totalRaisedUsd?: number | null | undefined;
|
|
590
591
|
unconvertedRoundCount: number;
|
|
591
592
|
} | null | undefined;
|
|
593
|
+
headquartersAddressId?: number | null | undefined;
|
|
592
594
|
text: {
|
|
593
595
|
expanded?: string | null | undefined;
|
|
594
596
|
generatedDescription?: string | null | undefined;
|
|
@@ -61,7 +61,7 @@ const EntityListFilterSchemaDefinition = z.strictObject({
|
|
|
61
61
|
portfolioHeadquartersCountry: z.array(z.string()).optional(),
|
|
62
62
|
/** Portfolio-company headquarters state or region values. */
|
|
63
63
|
portfolioHeadquartersState: z.array(z.string()).optional(),
|
|
64
|
-
/**
|
|
64
|
+
/** Server-owned list quality gate. */
|
|
65
65
|
qualityGate: EntityListQualityGateSchema.optional(),
|
|
66
66
|
/** Rank most prominent first (funding, stage, headcount, momentum, recent news, investor breadth), ahead of sort: what best, top, or most promising mean. */
|
|
67
67
|
rankByProminence: z.boolean().nullish(),
|
|
@@ -80,7 +80,7 @@ const EntityListFilterSchemaDefinition = z.strictObject({
|
|
|
80
80
|
suppressLateStage: z.boolean().nullish(),
|
|
81
81
|
/** Suppress entities with terminal operating status. */
|
|
82
82
|
suppressNonOperating: z.boolean().nullish(),
|
|
83
|
-
/** Suppress entities
|
|
83
|
+
/** Suppress entities with zero or unknown USD total raised. */
|
|
84
84
|
suppressZeroTotalRaised: z.boolean().nullish(),
|
|
85
85
|
/** General classification tag values. */
|
|
86
86
|
tag: z.array(z.string()).optional(),
|
package/dist/entity/list.d.ts
CHANGED
|
@@ -307,6 +307,7 @@ declare const EntityListSchemaDefinition: z.ZodObject<{
|
|
|
307
307
|
totalRaisedUsd?: number | null | undefined;
|
|
308
308
|
unconvertedRoundCount: number;
|
|
309
309
|
} | null | undefined;
|
|
310
|
+
headquartersAddressId?: number | null | undefined;
|
|
310
311
|
text: {
|
|
311
312
|
expanded?: string | null | undefined;
|
|
312
313
|
generatedDescription?: string | null | undefined;
|
|
@@ -588,6 +589,7 @@ declare const EntityListSchemaDefinition: z.ZodObject<{
|
|
|
588
589
|
totalRaisedUsd?: number | null | undefined;
|
|
589
590
|
unconvertedRoundCount: number;
|
|
590
591
|
} | null | undefined;
|
|
592
|
+
headquartersAddressId?: number | null | undefined;
|
|
591
593
|
text: {
|
|
592
594
|
expanded?: string | null | undefined;
|
|
593
595
|
generatedDescription?: string | null | undefined;
|
|
@@ -174,12 +174,14 @@ declare const EntityNaturalSearchSchemaDefinition: z.ZodObject<{
|
|
|
174
174
|
}, unknown>>>>;
|
|
175
175
|
}, z.core.$strict>>;
|
|
176
176
|
search: z.ZodType<{
|
|
177
|
+
answerModel?: string | null | undefined;
|
|
177
178
|
cacheMode?: "bypass" | "refresh" | "use" | undefined;
|
|
178
179
|
mode?: string | undefined;
|
|
179
180
|
model?: string | null | undefined;
|
|
180
181
|
query: string;
|
|
181
182
|
reasoningEffort?: string | null | undefined;
|
|
182
183
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
184
|
+
answerModel?: string | null | undefined;
|
|
183
185
|
cacheMode?: "bypass" | "refresh" | "use" | undefined;
|
|
184
186
|
mode?: string | undefined;
|
|
185
187
|
model?: string | null | undefined;
|
|
@@ -44,7 +44,7 @@ export const EntityPersonAssociationSchema = z.object({
|
|
|
44
44
|
.string()
|
|
45
45
|
.regex(/^(?!0000)[0-9]{4}(?:-(?:0[1-9]|1[0-2])(?:-(?:0[1-9]|[12][0-9]|3[01])(?:T(?:[01][0-9]|2[0-3]):[0-5][0-9](?::[0-5][0-9](?:\.[0-9]{1,9})?)?(?:Z|[+-][0-9]{2}:[0-5][0-9]))?)?)?$/)
|
|
46
46
|
.nullish(),
|
|
47
|
-
/** Entity addresses carried on the association projection */
|
|
47
|
+
/** Entity addresses carried on the association projection. Person detail carries at most one: the entity's current headquarters, else its most recently updated current address; GET /v1/entities/{entityId}/addresses lists them all */
|
|
48
48
|
entityAddress: z.array(AddressSchema),
|
|
49
49
|
/** Associated entity id */
|
|
50
50
|
entityId: z.uuid(),
|
|
@@ -309,6 +309,7 @@ declare const EntityResolutionSchemaDefinition: z.ZodObject<{
|
|
|
309
309
|
totalRaisedUsd?: number | null | undefined;
|
|
310
310
|
unconvertedRoundCount: number;
|
|
311
311
|
} | null | undefined;
|
|
312
|
+
headquartersAddressId?: number | null | undefined;
|
|
312
313
|
text: {
|
|
313
314
|
expanded?: string | null | undefined;
|
|
314
315
|
generatedDescription?: string | null | undefined;
|
|
@@ -590,6 +591,7 @@ declare const EntityResolutionSchemaDefinition: z.ZodObject<{
|
|
|
590
591
|
totalRaisedUsd?: number | null | undefined;
|
|
591
592
|
unconvertedRoundCount: number;
|
|
592
593
|
} | null | undefined;
|
|
594
|
+
headquartersAddressId?: number | null | undefined;
|
|
593
595
|
text: {
|
|
594
596
|
expanded?: string | null | undefined;
|
|
595
597
|
generatedDescription?: string | null | undefined;
|
|
@@ -290,6 +290,7 @@ declare const EntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
290
290
|
totalRaisedUsd?: number | null | undefined;
|
|
291
291
|
unconvertedRoundCount: number;
|
|
292
292
|
} | null | undefined;
|
|
293
|
+
headquartersAddressId?: number | null | undefined;
|
|
293
294
|
text: {
|
|
294
295
|
expanded?: string | null | undefined;
|
|
295
296
|
generatedDescription?: string | null | undefined;
|
|
@@ -767,6 +768,7 @@ declare const EntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
767
768
|
totalRaisedUsd?: number | null | undefined;
|
|
768
769
|
unconvertedRoundCount: number;
|
|
769
770
|
} | null | undefined;
|
|
771
|
+
headquartersAddressId?: number | null | undefined;
|
|
770
772
|
text: {
|
|
771
773
|
expanded?: string | null | undefined;
|
|
772
774
|
generatedDescription?: string | null | undefined;
|
|
@@ -1,5 +1,16 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
|
-
|
|
2
|
+
/**
|
|
3
|
+
* Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema FederatedNaturalSearch
|
|
6
|
+
* @endpoint POST /v1/search
|
|
7
|
+
* @endpoint POST /v1/search/shared
|
|
8
|
+
* @usedBySchema SharedSearchMutationSchema
|
|
9
|
+
* @contractShape federated.natural-search
|
|
10
|
+
* @contractRole canonical
|
|
11
|
+
*/
|
|
12
|
+
export declare const FederatedNaturalSearchSchema: z.ZodObject<{
|
|
13
|
+
answerModel: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3
14
|
cacheMode: z.ZodOptional<z.ZodDefault<z.ZodEnum<{
|
|
4
15
|
bypass: "bypass";
|
|
5
16
|
refresh: "refresh";
|
|
@@ -199,16 +210,5 @@ declare const FederatedNaturalSearchSchemaDefinition: z.ZodObject<{
|
|
|
199
210
|
xhigh: "xhigh";
|
|
200
211
|
}>, z.ZodString]>>>;
|
|
201
212
|
}, z.core.$strip>;
|
|
202
|
-
type FederatedNaturalSearchDefinition = z.infer<typeof FederatedNaturalSearchSchemaDefinition>;
|
|
203
|
-
/**
|
|
204
|
-
* Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
|
|
205
|
-
*
|
|
206
|
-
* @openapiSchema FederatedNaturalSearch
|
|
207
|
-
* @endpoint POST /v1/search
|
|
208
|
-
* @contractShape federated.natural-search
|
|
209
|
-
* @contractRole canonical
|
|
210
|
-
*/
|
|
211
|
-
export declare const FederatedNaturalSearchSchema: z.ZodType<FederatedNaturalSearchDefinition>;
|
|
212
213
|
export type FederatedNaturalSearch = z.infer<typeof FederatedNaturalSearchSchema>;
|
|
213
|
-
export {};
|
|
214
214
|
//# sourceMappingURL=natural-search.d.ts.map
|
|
@@ -4,8 +4,20 @@ import { EntityFilterSchema } from "../entity/filter.js";
|
|
|
4
4
|
import { ReasoningEffortSchema } from "../reasoning/effort.js";
|
|
5
5
|
import { SearchCacheModeSchema } from "../search/cache-mode.js";
|
|
6
6
|
import { SearchModeSchema } from "../search/mode.js";
|
|
7
|
-
|
|
8
|
-
|
|
7
|
+
/**
|
|
8
|
+
* Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
|
|
9
|
+
*
|
|
10
|
+
* @openapiSchema FederatedNaturalSearch
|
|
11
|
+
* @endpoint POST /v1/search
|
|
12
|
+
* @endpoint POST /v1/search/shared
|
|
13
|
+
* @usedBySchema SharedSearchMutationSchema
|
|
14
|
+
* @contractShape federated.natural-search
|
|
15
|
+
* @contractRole canonical
|
|
16
|
+
*/
|
|
17
|
+
export const FederatedNaturalSearchSchema = z.object({
|
|
18
|
+
/** Optional chat model for the synthesis answer; null uses the catalog's search answer model. The same allowlist as `model` applies. The answer writes the page heading, title, and description, so this compares answer models without changing the catalog. */
|
|
19
|
+
answerModel: z.string().nullish(),
|
|
20
|
+
/** Search-stage cache policy. use reuses cached search work; bypass computes fresh without retaining outputs; refresh computes fresh and replaces normal entries. Record and immutable query-vector caches retain their own policy. Callers without private-data access always run use. */
|
|
9
21
|
cacheMode: SearchCacheModeSchema.default("use").optional(),
|
|
10
22
|
/** Explicit entity constraints for the entity scope only, as on POST /v1/search/natural/entities: caller-supplied fields override planner values. The person and news scopes ignore it. */
|
|
11
23
|
entityFilter: EntityFilterSchema.optional(),
|
|
@@ -22,13 +34,4 @@ const FederatedNaturalSearchSchemaDefinition = z.object({
|
|
|
22
34
|
/** Optional reasoning effort for every model call this search makes: the query planner and the synthesis answer. Each call sends the nearest level its model supports, the lower one on a tie. Callers without private-data access are capped at `medium`. Null keeps the configured per-call and per-model defaults. */
|
|
23
35
|
reasoningEffort: ReasoningEffortSchema.nullish(),
|
|
24
36
|
});
|
|
25
|
-
/**
|
|
26
|
-
* Plain-English search across companies, people, and news, plus optional per-scope entity constraints and page sizes.
|
|
27
|
-
*
|
|
28
|
-
* @openapiSchema FederatedNaturalSearch
|
|
29
|
-
* @endpoint POST /v1/search
|
|
30
|
-
* @contractShape federated.natural-search
|
|
31
|
-
* @contractRole canonical
|
|
32
|
-
*/
|
|
33
|
-
export const FederatedNaturalSearchSchema = FederatedNaturalSearchSchemaDefinition;
|
|
34
37
|
//# sourceMappingURL=natural-search.js.map
|
|
@@ -9,6 +9,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
9
9
|
}[];
|
|
10
10
|
confidence: "HIGH" | "LOW" | "MEDIUM";
|
|
11
11
|
description?: string | null | undefined;
|
|
12
|
+
heading?: string | null | undefined;
|
|
12
13
|
paragraph: {
|
|
13
14
|
citation: {
|
|
14
15
|
entityId: string;
|
|
@@ -146,7 +147,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
146
147
|
sort: {
|
|
147
148
|
order: {
|
|
148
149
|
descending: boolean;
|
|
149
|
-
field:
|
|
150
|
+
field: string;
|
|
150
151
|
sortKey?: string | null | undefined;
|
|
151
152
|
}[];
|
|
152
153
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
@@ -618,6 +619,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
618
619
|
totalRaisedUsd?: number | null | undefined;
|
|
619
620
|
unconvertedRoundCount: number;
|
|
620
621
|
} | null | undefined;
|
|
622
|
+
headquartersAddressId?: number | null | undefined;
|
|
621
623
|
text: {
|
|
622
624
|
expanded?: string | null | undefined;
|
|
623
625
|
generatedDescription?: string | null | undefined;
|
|
@@ -1111,6 +1113,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
1111
1113
|
totalRaisedUsd?: number | null | undefined;
|
|
1112
1114
|
unconvertedRoundCount: number;
|
|
1113
1115
|
} | null | undefined;
|
|
1116
|
+
headquartersAddressId?: number | null | undefined;
|
|
1114
1117
|
text: {
|
|
1115
1118
|
expanded?: string | null | undefined;
|
|
1116
1119
|
generatedDescription?: string | null | undefined;
|
|
@@ -1595,6 +1598,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
1595
1598
|
totalRaisedUsd?: number | null | undefined;
|
|
1596
1599
|
unconvertedRoundCount: number;
|
|
1597
1600
|
} | null | undefined;
|
|
1601
|
+
headquartersAddressId?: number | null | undefined;
|
|
1598
1602
|
text: {
|
|
1599
1603
|
expanded?: string | null | undefined;
|
|
1600
1604
|
generatedDescription?: string | null | undefined;
|
|
@@ -1792,6 +1796,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
1792
1796
|
}[];
|
|
1793
1797
|
confidence: "HIGH" | "LOW" | "MEDIUM";
|
|
1794
1798
|
description?: string | null | undefined;
|
|
1799
|
+
heading?: string | null | undefined;
|
|
1795
1800
|
paragraph: {
|
|
1796
1801
|
citation: {
|
|
1797
1802
|
entityId: string;
|
|
@@ -1929,7 +1934,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
1929
1934
|
sort: {
|
|
1930
1935
|
order: {
|
|
1931
1936
|
descending: boolean;
|
|
1932
|
-
field:
|
|
1937
|
+
field: string;
|
|
1933
1938
|
sortKey?: string | null | undefined;
|
|
1934
1939
|
}[];
|
|
1935
1940
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
@@ -2401,6 +2406,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
2401
2406
|
totalRaisedUsd?: number | null | undefined;
|
|
2402
2407
|
unconvertedRoundCount: number;
|
|
2403
2408
|
} | null | undefined;
|
|
2409
|
+
headquartersAddressId?: number | null | undefined;
|
|
2404
2410
|
text: {
|
|
2405
2411
|
expanded?: string | null | undefined;
|
|
2406
2412
|
generatedDescription?: string | null | undefined;
|
|
@@ -2894,6 +2900,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
2894
2900
|
totalRaisedUsd?: number | null | undefined;
|
|
2895
2901
|
unconvertedRoundCount: number;
|
|
2896
2902
|
} | null | undefined;
|
|
2903
|
+
headquartersAddressId?: number | null | undefined;
|
|
2897
2904
|
text: {
|
|
2898
2905
|
expanded?: string | null | undefined;
|
|
2899
2906
|
generatedDescription?: string | null | undefined;
|
|
@@ -3378,6 +3385,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
3378
3385
|
totalRaisedUsd?: number | null | undefined;
|
|
3379
3386
|
unconvertedRoundCount: number;
|
|
3380
3387
|
} | null | undefined;
|
|
3388
|
+
headquartersAddressId?: number | null | undefined;
|
|
3381
3389
|
text: {
|
|
3382
3390
|
expanded?: string | null | undefined;
|
|
3383
3391
|
generatedDescription?: string | null | undefined;
|
|
@@ -3875,6 +3883,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
3875
3883
|
totalRaisedUsd?: number | null | undefined;
|
|
3876
3884
|
unconvertedRoundCount: number;
|
|
3877
3885
|
} | null | undefined;
|
|
3886
|
+
headquartersAddressId?: number | null | undefined;
|
|
3878
3887
|
text: {
|
|
3879
3888
|
expanded?: string | null | undefined;
|
|
3880
3889
|
generatedDescription?: string | null | undefined;
|
|
@@ -4156,6 +4165,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
4156
4165
|
totalRaisedUsd?: number | null | undefined;
|
|
4157
4166
|
unconvertedRoundCount: number;
|
|
4158
4167
|
} | null | undefined;
|
|
4168
|
+
headquartersAddressId?: number | null | undefined;
|
|
4159
4169
|
text: {
|
|
4160
4170
|
expanded?: string | null | undefined;
|
|
4161
4171
|
generatedDescription?: string | null | undefined;
|
|
@@ -11,6 +11,14 @@ declare const HarnessTaskPlanStepSchemaDefinition: z.ZodObject<{
|
|
|
11
11
|
operationId: string;
|
|
12
12
|
stepKey: string;
|
|
13
13
|
}, unknown>>;
|
|
14
|
+
writeGuidance: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
15
|
+
body: z.ZodString;
|
|
16
|
+
expectation: z.ZodString;
|
|
17
|
+
method: z.ZodArray<z.ZodString>;
|
|
18
|
+
override: z.ZodString;
|
|
19
|
+
reject: z.ZodArray<z.ZodString>;
|
|
20
|
+
typeCatalog: z.ZodString;
|
|
21
|
+
}, z.core.$strip>>>;
|
|
14
22
|
}, z.core.$strip>;
|
|
15
23
|
type HarnessTaskPlanStepDefinition = z.infer<typeof HarnessTaskPlanStepSchemaDefinition>;
|
|
16
24
|
/**
|
|
@@ -1,6 +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
|
import { HarnessTaskStepSchema } from "./task-step.js";
|
|
4
|
+
import { HarnessTaskWriteGuidanceSchema } from "./task-write-guidance.js";
|
|
4
5
|
const HarnessTaskPlanStepSchemaDefinition = z.object({
|
|
5
6
|
/** CLI command path that runs the step's operation; the caller supplies required flags. */
|
|
6
7
|
cliCommand: z.string(),
|
|
@@ -8,6 +9,8 @@ const HarnessTaskPlanStepSchemaDefinition = z.object({
|
|
|
8
9
|
mcpTool: z.string().nullish(),
|
|
9
10
|
/** The stored step. */
|
|
10
11
|
step: HarnessTaskStepSchema,
|
|
12
|
+
/** What the server expects of the prose this step writes, derived from the operation's judged prose type when the plan is read; null when the step writes no judged prose. */
|
|
13
|
+
writeGuidance: HarnessTaskWriteGuidanceSchema.nullish(),
|
|
11
14
|
});
|
|
12
15
|
/**
|
|
13
16
|
* One task step with the CLI command and MCP tool that run its operation.
|
|
@@ -29,6 +29,14 @@ export declare const HarnessTaskPlanSchema: z.ZodObject<{
|
|
|
29
29
|
operationId: string;
|
|
30
30
|
stepKey: string;
|
|
31
31
|
};
|
|
32
|
+
writeGuidance?: {
|
|
33
|
+
body: string;
|
|
34
|
+
expectation: string;
|
|
35
|
+
method: string[];
|
|
36
|
+
override: string;
|
|
37
|
+
reject: string[];
|
|
38
|
+
typeCatalog: string;
|
|
39
|
+
} | null | undefined;
|
|
32
40
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
33
41
|
cliCommand: string;
|
|
34
42
|
mcpTool?: string | null | undefined;
|
|
@@ -37,6 +45,14 @@ export declare const HarnessTaskPlanSchema: z.ZodObject<{
|
|
|
37
45
|
operationId: string;
|
|
38
46
|
stepKey: string;
|
|
39
47
|
};
|
|
48
|
+
writeGuidance?: {
|
|
49
|
+
body: string;
|
|
50
|
+
expectation: string;
|
|
51
|
+
method: string[];
|
|
52
|
+
override: string;
|
|
53
|
+
reject: string[];
|
|
54
|
+
typeCatalog: string;
|
|
55
|
+
} | null | undefined;
|
|
40
56
|
}, unknown>>>;
|
|
41
57
|
taskKey: z.ZodString;
|
|
42
58
|
}, z.core.$strip>;
|