@aventurevc/api-schemas 0.8.364 → 0.8.365
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/agent/help-question.js +1 -1
- package/dist/entity/list.d.ts +1 -0
- package/dist/entity/list.js +2 -0
- package/dist/entity/similarity-result.d.ts +2 -0
- package/dist/federated/natural-search.js +2 -2
- package/dist/federated/search.d.ts +6 -0
- package/dist/identification/subject.d.ts +1 -0
- package/dist/identification/subject.js +3 -1
- package/dist/link/search.d.ts +6 -0
- package/dist/lookup/job-mention.d.ts +2 -0
- package/dist/lookup/job-mutation.d.ts +1 -0
- package/dist/lookup/job.d.ts +4 -0
- package/dist/mention/lookup.d.ts +2 -0
- package/dist/natural/search-result.d.ts +6 -0
- package/dist/natural/search.js +2 -2
- package/dist/pagination/schemas.d.ts +6 -0
- package/dist/shared/search.d.ts +6 -0
- package/package.json +1 -1
package/dist/address/address.js
CHANGED
|
@@ -72,9 +72,9 @@ export const AddressSchema = z.object({
|
|
|
72
72
|
id: z.int().nullish(),
|
|
73
73
|
/** Deprecated aggregate compatibility flag; true when any association is current */
|
|
74
74
|
isCurrent: z.boolean().nullish(),
|
|
75
|
-
/** Deprecated legacy flag marking the current legal/registered seat (domicile), not the operating HQ.
|
|
75
|
+
/** Deprecated legacy flag marking the current legal/registered seat (domicile), not the operating HQ; it retires on 2027-02-05. Read a current association[].role of domicile for the legal seat, and match enrichment.headquartersAddressId to enrichment.address[].id for the operating headquarters. */
|
|
76
76
|
isHq: z.boolean().nullish(),
|
|
77
|
-
/** Deprecated legacy flag marking the
|
|
77
|
+
/** Deprecated legacy flag marking the current operating headquarters (dominant); it retires on 2027-02-05. Match enrichment.headquartersAddressId to enrichment.address[].id, or read a current association[].role of dominant. */
|
|
78
78
|
isPrimary: z.boolean().nullish(),
|
|
79
79
|
latitude: z.number().nullish(),
|
|
80
80
|
longitude: z.number().nullish(),
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { HelpScopeSchema } from "../help/scope.js";
|
|
4
4
|
const AgentHelpQuestionSchemaDefinition = z.object({
|
|
5
|
-
/** Optional supported model for the answer.
|
|
5
|
+
/** Optional supported model id for the answer. Leave the field out for the server's model; a value that is not a supported model id answers 422. */
|
|
6
6
|
model: z.string().nullish(),
|
|
7
7
|
/** The question to answer, in natural language. */
|
|
8
8
|
question: z.string().min(1),
|
package/dist/entity/list.d.ts
CHANGED
|
@@ -146,6 +146,7 @@ declare const EntityListSchemaDefinition: z.ZodObject<{
|
|
|
146
146
|
}>;
|
|
147
147
|
updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
148
148
|
}, z.core.$strip>;
|
|
149
|
+
coveringRunId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
149
150
|
enrichment: z.ZodType<{
|
|
150
151
|
address: {
|
|
151
152
|
address?: number | null | undefined;
|
package/dist/entity/list.js
CHANGED
|
@@ -12,6 +12,8 @@ const EntityListSchemaDefinition = z.object({
|
|
|
12
12
|
acquirer: EntitySchema.nullish(),
|
|
13
13
|
/** Flat entity core — identity, naming, status, image, and source metadata */
|
|
14
14
|
core: EntitySchema,
|
|
15
|
+
/** The queued or running full-research run covering this record, whoever filed it; set only on federated search result and subject rows, null when none and on every other list read. */
|
|
16
|
+
coveringRunId: z.uuid().nullish(),
|
|
15
17
|
/** Supplemental entity data — addresses, classification tags, funding, text content, and URL links */
|
|
16
18
|
enrichment: EntityEnrichmentSchema,
|
|
17
19
|
/** Fundraise rounds associated with this entity */
|
|
@@ -89,6 +89,7 @@ declare const EntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
89
89
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
90
90
|
updatedAt?: string | null | undefined;
|
|
91
91
|
};
|
|
92
|
+
coveringRunId?: string | null | undefined;
|
|
92
93
|
enrichment: {
|
|
93
94
|
address: {
|
|
94
95
|
address?: number | null | undefined;
|
|
@@ -823,6 +824,7 @@ declare const EntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
823
824
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
824
825
|
updatedAt?: string | null | undefined;
|
|
825
826
|
};
|
|
827
|
+
coveringRunId?: string | null | undefined;
|
|
826
828
|
enrichment: {
|
|
827
829
|
address: {
|
|
828
830
|
address?: number | null | undefined;
|
|
@@ -6,7 +6,7 @@ import { SearchCacheModeSchema } from "../search/cache-mode.js";
|
|
|
6
6
|
import { SearchFreshnessSchema } from "../search/freshness.js";
|
|
7
7
|
import { SearchModeSchema } from "../search/mode.js";
|
|
8
8
|
const FederatedNaturalSearchSchemaDefinition = z.object({
|
|
9
|
-
/** Optional supported model for the written answer, which also supplies the page heading, title, and description.
|
|
9
|
+
/** Optional supported model id for the written answer, which also supplies the page heading, title, and description. Leave the field out for the server's model; a value that is not a supported model id answers 422. */
|
|
10
10
|
answerModel: z.string().nullish(),
|
|
11
11
|
/** Cache policy. use reuses earlier search work; bypass and refresh compute fresh results and are honored only for accounts with private-data access. */
|
|
12
12
|
cacheMode: SearchCacheModeSchema.default("use").optional(),
|
|
@@ -16,7 +16,7 @@ const FederatedNaturalSearchSchemaDefinition = z.object({
|
|
|
16
16
|
freshness: SearchFreshnessSchema.default("auto").optional(),
|
|
17
17
|
/** Search strategy to run. Defaults to `auto`: the fast name layer runs first (a single-token query as keyword search, a multiword query as an exact normalized name) and the language-model planner runs only on a miss, so name lookups never pay for planning. Any other value forces exactly that strategy: `exact` and `keyword` skip planner model resolution and its rate limit. Entity and person natural-search take every value but `hybrid`; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword`, `semantic`, and `hybrid` (`semantic` and `hybrid` only for one entity's or person's content). */
|
|
18
18
|
mode: SearchModeSchema.default("auto").optional(),
|
|
19
|
-
/** Optional supported model for planning the search.
|
|
19
|
+
/** Optional supported model id for planning the search. Leave the field out for the server's model; a value that is not a supported model id answers 422. */
|
|
20
20
|
model: z.string().nullish(),
|
|
21
21
|
/** Model catalog revision this search uses for its model defaults and inference policy; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
|
|
22
22
|
modelCatalogRevision: z.int().nullish(),
|
|
@@ -899,6 +899,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
899
899
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
900
900
|
updatedAt?: string | null | undefined;
|
|
901
901
|
};
|
|
902
|
+
coveringRunId?: string | null | undefined;
|
|
902
903
|
enrichment: {
|
|
903
904
|
address: {
|
|
904
905
|
address?: number | null | undefined;
|
|
@@ -1650,6 +1651,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
1650
1651
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
1651
1652
|
updatedAt?: string | null | undefined;
|
|
1652
1653
|
};
|
|
1654
|
+
coveringRunId?: string | null | undefined;
|
|
1653
1655
|
enrichment: {
|
|
1654
1656
|
address: {
|
|
1655
1657
|
address?: number | null | undefined;
|
|
@@ -2391,6 +2393,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
2391
2393
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
2392
2394
|
updatedAt?: string | null | undefined;
|
|
2393
2395
|
};
|
|
2396
|
+
coveringRunId?: string | null | undefined;
|
|
2394
2397
|
enrichment: {
|
|
2395
2398
|
address: {
|
|
2396
2399
|
address?: number | null | undefined;
|
|
@@ -3936,6 +3939,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
3936
3939
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
3937
3940
|
updatedAt?: string | null | undefined;
|
|
3938
3941
|
};
|
|
3942
|
+
coveringRunId?: string | null | undefined;
|
|
3939
3943
|
enrichment: {
|
|
3940
3944
|
address: {
|
|
3941
3945
|
address?: number | null | undefined;
|
|
@@ -4687,6 +4691,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
4687
4691
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
4688
4692
|
updatedAt?: string | null | undefined;
|
|
4689
4693
|
};
|
|
4694
|
+
coveringRunId?: string | null | undefined;
|
|
4690
4695
|
enrichment: {
|
|
4691
4696
|
address: {
|
|
4692
4697
|
address?: number | null | undefined;
|
|
@@ -5428,6 +5433,7 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
|
|
|
5428
5433
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
5429
5434
|
updatedAt?: string | null | undefined;
|
|
5430
5435
|
};
|
|
5436
|
+
coveringRunId?: string | null | undefined;
|
|
5431
5437
|
enrichment: {
|
|
5432
5438
|
address: {
|
|
5433
5439
|
address?: number | null | undefined;
|
|
@@ -71,6 +71,7 @@ export declare const IdentificationSubjectSchema: z.ZodObject<{
|
|
|
71
71
|
}>>>;
|
|
72
72
|
location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
73
73
|
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
74
|
+
productServiceProviderId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
74
75
|
providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
75
76
|
role: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
76
77
|
INVESTOR: "INVESTOR";
|
|
@@ -27,13 +27,15 @@ export const IdentificationSubjectSchema = z.object({
|
|
|
27
27
|
/** Companies the subject is known to work at; a person filing accepts a LinkedIn profile only when one of them appears in the profile's employer fields. */
|
|
28
28
|
employer: z.array(z.string()).max(10).optional(),
|
|
29
29
|
filing: RegistryFilingSchema.nullish(),
|
|
30
|
-
/** Kind of record to identify when you know it: ENTITY for companies, funds, and firms (and their products or services); PERSON for people. Only that kind is looked up; typeRecord or
|
|
30
|
+
/** Kind of record to identify when you know it: ENTITY for companies, funds, and firms (and their products or services); PERSON for people. Only that kind is looked up; typeRecord or productServiceProviderId implies ENTITY. */
|
|
31
31
|
kind: z.enum(["ENTITY", "PERSON"]).nullish(),
|
|
32
32
|
/** City, region, or country, such as Austin, TX. Tells namesakes apart; not proof on its own. */
|
|
33
33
|
location: z.string().max(2000).nullish(),
|
|
34
34
|
/** Name exactly as the source writes it, such as Acme AI or Jane Doe. Send name, url, or both; a name that is an absolute http(s) URL is read as url. */
|
|
35
35
|
name: z.string().max(200).nullish(),
|
|
36
36
|
/** Provider entity id for a Product or Service lookup. Omit it when the provider is unknown. With no typeRecord, searches both Product and Service. Invalid for a company type or a person lookup. */
|
|
37
|
+
productServiceProviderId: z.uuid().nullish(),
|
|
38
|
+
/** Deprecated: send productServiceProviderId, the name the entity duplicate-check and create routes use. Still read as productServiceProviderId; a request that sends it answers with Deprecation and Sunset headers. */
|
|
37
39
|
providerId: z.uuid().nullish(),
|
|
38
40
|
/** Part the subject plays in the source: INVESTOR when the source lists it as an investor. Unlike typeRecord it keeps every record type a candidate, so a Company or Nonprofit that invests can still match. With it, a lookup with no url, filing, or sourceIdentifier binds a same-named Investment Firm or Fund over a record that does not invest; without a sourceNewsId it also answers NEEDS_REVIEW when the bound record shares its name with another live firm, or a visible record of its type family, unless the location's place names only the bound record's address and every namesake stores one. Without it, an Investment Firm or Fund typeRecord applies the firm preference alone. Omit it otherwise. */
|
|
39
41
|
role: z.enum(["INVESTOR"]).nullish(),
|
package/dist/link/search.d.ts
CHANGED
|
@@ -901,6 +901,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
901
901
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
902
902
|
updatedAt?: string | null | undefined;
|
|
903
903
|
};
|
|
904
|
+
coveringRunId?: string | null | undefined;
|
|
904
905
|
enrichment: {
|
|
905
906
|
address: {
|
|
906
907
|
address?: number | null | undefined;
|
|
@@ -1652,6 +1653,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
1652
1653
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
1653
1654
|
updatedAt?: string | null | undefined;
|
|
1654
1655
|
};
|
|
1656
|
+
coveringRunId?: string | null | undefined;
|
|
1655
1657
|
enrichment: {
|
|
1656
1658
|
address: {
|
|
1657
1659
|
address?: number | null | undefined;
|
|
@@ -2393,6 +2395,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
2393
2395
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
2394
2396
|
updatedAt?: string | null | undefined;
|
|
2395
2397
|
};
|
|
2398
|
+
coveringRunId?: string | null | undefined;
|
|
2396
2399
|
enrichment: {
|
|
2397
2400
|
address: {
|
|
2398
2401
|
address?: number | null | undefined;
|
|
@@ -8135,6 +8138,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
8135
8138
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
8136
8139
|
updatedAt?: string | null | undefined;
|
|
8137
8140
|
};
|
|
8141
|
+
coveringRunId?: string | null | undefined;
|
|
8138
8142
|
enrichment: {
|
|
8139
8143
|
address: {
|
|
8140
8144
|
address?: number | null | undefined;
|
|
@@ -8886,6 +8890,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
8886
8890
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
8887
8891
|
updatedAt?: string | null | undefined;
|
|
8888
8892
|
};
|
|
8893
|
+
coveringRunId?: string | null | undefined;
|
|
8889
8894
|
enrichment: {
|
|
8890
8895
|
address: {
|
|
8891
8896
|
address?: number | null | undefined;
|
|
@@ -9627,6 +9632,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
9627
9632
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
9628
9633
|
updatedAt?: string | null | undefined;
|
|
9629
9634
|
};
|
|
9635
|
+
coveringRunId?: string | null | undefined;
|
|
9630
9636
|
enrichment: {
|
|
9631
9637
|
address: {
|
|
9632
9638
|
address?: number | null | undefined;
|
|
@@ -90,6 +90,7 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
|
|
|
90
90
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
91
91
|
updatedAt?: string | null | undefined;
|
|
92
92
|
};
|
|
93
|
+
coveringRunId?: string | null | undefined;
|
|
93
94
|
enrichment: {
|
|
94
95
|
address: {
|
|
95
96
|
address?: number | null | undefined;
|
|
@@ -824,6 +825,7 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
|
|
|
824
825
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
825
826
|
updatedAt?: string | null | undefined;
|
|
826
827
|
};
|
|
828
|
+
coveringRunId?: string | null | undefined;
|
|
827
829
|
enrichment: {
|
|
828
830
|
address: {
|
|
829
831
|
address?: number | null | undefined;
|
|
@@ -72,6 +72,7 @@ declare const LookupJobMutationSchemaDefinition: z.ZodObject<{
|
|
|
72
72
|
}>>>;
|
|
73
73
|
location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
74
74
|
name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
75
|
+
productServiceProviderId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
75
76
|
providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
|
|
76
77
|
role: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|
|
77
78
|
INVESTOR: "INVESTOR";
|
package/dist/lookup/job.d.ts
CHANGED
|
@@ -337,6 +337,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
337
337
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
338
338
|
updatedAt?: string | null | undefined;
|
|
339
339
|
};
|
|
340
|
+
coveringRunId?: string | null | undefined;
|
|
340
341
|
enrichment: {
|
|
341
342
|
address: {
|
|
342
343
|
address?: number | null | undefined;
|
|
@@ -1266,6 +1267,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1266
1267
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
1267
1268
|
updatedAt?: string | null | undefined;
|
|
1268
1269
|
};
|
|
1270
|
+
coveringRunId?: string | null | undefined;
|
|
1269
1271
|
enrichment: {
|
|
1270
1272
|
address: {
|
|
1271
1273
|
address?: number | null | undefined;
|
|
@@ -2215,6 +2217,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
2215
2217
|
kind?: "ENTITY" | "PERSON" | null | undefined;
|
|
2216
2218
|
location?: string | null | undefined;
|
|
2217
2219
|
name?: string | null | undefined;
|
|
2220
|
+
productServiceProviderId?: string | null | undefined;
|
|
2218
2221
|
providerId?: string | null | undefined;
|
|
2219
2222
|
role?: "INVESTOR" | null | undefined;
|
|
2220
2223
|
sourceDocumentId?: string | null | undefined;
|
|
@@ -2280,6 +2283,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
2280
2283
|
kind?: "ENTITY" | "PERSON" | null | undefined;
|
|
2281
2284
|
location?: string | null | undefined;
|
|
2282
2285
|
name?: string | null | undefined;
|
|
2286
|
+
productServiceProviderId?: string | null | undefined;
|
|
2283
2287
|
providerId?: string | null | undefined;
|
|
2284
2288
|
role?: "INVESTOR" | null | undefined;
|
|
2285
2289
|
sourceDocumentId?: string | null | undefined;
|
package/dist/mention/lookup.d.ts
CHANGED
|
@@ -97,6 +97,7 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
97
97
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
98
98
|
updatedAt?: string | null | undefined;
|
|
99
99
|
};
|
|
100
|
+
coveringRunId?: string | null | undefined;
|
|
100
101
|
enrichment: {
|
|
101
102
|
address: {
|
|
102
103
|
address?: number | null | undefined;
|
|
@@ -1026,6 +1027,7 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
1026
1027
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
1027
1028
|
updatedAt?: string | null | undefined;
|
|
1028
1029
|
};
|
|
1030
|
+
coveringRunId?: string | null | undefined;
|
|
1029
1031
|
enrichment: {
|
|
1030
1032
|
address: {
|
|
1031
1033
|
address?: number | null | undefined;
|
|
@@ -1693,6 +1693,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
1693
1693
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
1694
1694
|
updatedAt?: string | null | undefined;
|
|
1695
1695
|
};
|
|
1696
|
+
coveringRunId?: string | null | undefined;
|
|
1696
1697
|
enrichment: {
|
|
1697
1698
|
address: {
|
|
1698
1699
|
address?: number | null | undefined;
|
|
@@ -2441,6 +2442,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
2441
2442
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
2442
2443
|
updatedAt?: string | null | undefined;
|
|
2443
2444
|
};
|
|
2445
|
+
coveringRunId?: string | null | undefined;
|
|
2444
2446
|
enrichment: {
|
|
2445
2447
|
address: {
|
|
2446
2448
|
address?: number | null | undefined;
|
|
@@ -3192,6 +3194,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
3192
3194
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
3193
3195
|
updatedAt?: string | null | undefined;
|
|
3194
3196
|
};
|
|
3197
|
+
coveringRunId?: string | null | undefined;
|
|
3195
3198
|
enrichment: {
|
|
3196
3199
|
address: {
|
|
3197
3200
|
address?: number | null | undefined;
|
|
@@ -3932,6 +3935,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
3932
3935
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
3933
3936
|
updatedAt?: string | null | undefined;
|
|
3934
3937
|
};
|
|
3938
|
+
coveringRunId?: string | null | undefined;
|
|
3935
3939
|
enrichment: {
|
|
3936
3940
|
address: {
|
|
3937
3941
|
address?: number | null | undefined;
|
|
@@ -4673,6 +4677,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
4673
4677
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
4674
4678
|
updatedAt?: string | null | undefined;
|
|
4675
4679
|
};
|
|
4680
|
+
coveringRunId?: string | null | undefined;
|
|
4676
4681
|
enrichment: {
|
|
4677
4682
|
address: {
|
|
4678
4683
|
address?: number | null | undefined;
|
|
@@ -5407,6 +5412,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
5407
5412
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
5408
5413
|
updatedAt?: string | null | undefined;
|
|
5409
5414
|
};
|
|
5415
|
+
coveringRunId?: string | null | undefined;
|
|
5410
5416
|
enrichment: {
|
|
5411
5417
|
address: {
|
|
5412
5418
|
address?: number | null | undefined;
|
package/dist/natural/search.js
CHANGED
|
@@ -5,7 +5,7 @@ import { SearchCacheModeSchema } from "../search/cache-mode.js";
|
|
|
5
5
|
import { SearchFreshnessSchema } from "../search/freshness.js";
|
|
6
6
|
import { SearchModeSchema } from "../search/mode.js";
|
|
7
7
|
const NaturalSearchSchemaDefinition = z.object({
|
|
8
|
-
/** Optional supported model for the written answer, which also supplies the page heading, title, and description.
|
|
8
|
+
/** Optional supported model id for the written answer, which also supplies the page heading, title, and description. Leave the field out for the server's model; a value that is not a supported model id answers 422. */
|
|
9
9
|
answerModel: z.string().nullish(),
|
|
10
10
|
/** Cache policy. use reuses earlier search work; bypass and refresh compute fresh results and are honored only for accounts with private-data access. */
|
|
11
11
|
cacheMode: SearchCacheModeSchema.default("use").optional(),
|
|
@@ -13,7 +13,7 @@ const NaturalSearchSchemaDefinition = z.object({
|
|
|
13
13
|
freshness: SearchFreshnessSchema.default("auto").optional(),
|
|
14
14
|
/** Search strategy to run. Defaults to `auto`: the fast name layer runs first (a single-token query as keyword search, a multiword query as an exact normalized name) and the language-model planner runs only on a miss, so name lookups never pay for planning. Any other value forces exactly that strategy: `exact` and `keyword` skip planner model resolution and its rate limit. Entity and person natural-search take every value but `hybrid`; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword`, `semantic`, and `hybrid` (`semantic` and `hybrid` only for one entity's or person's content). */
|
|
15
15
|
mode: SearchModeSchema.default("auto").optional(),
|
|
16
|
-
/** Optional supported model for planning the search.
|
|
16
|
+
/** Optional supported model id for planning the search. Leave the field out for the server's model; a value that is not a supported model id answers 422. */
|
|
17
17
|
model: z.string().nullish(),
|
|
18
18
|
/** Model catalog revision this search uses for its model defaults and inference policy; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
|
|
19
19
|
modelCatalogRevision: z.int().nullish(),
|
|
@@ -10080,6 +10080,7 @@ declare const PageEntityListSchemaDefinition: z.ZodObject<{
|
|
|
10080
10080
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
10081
10081
|
updatedAt?: string | null | undefined;
|
|
10082
10082
|
};
|
|
10083
|
+
coveringRunId?: string | null | undefined;
|
|
10083
10084
|
enrichment: {
|
|
10084
10085
|
address: {
|
|
10085
10086
|
address?: number | null | undefined;
|
|
@@ -10814,6 +10815,7 @@ declare const PageEntityListSchemaDefinition: z.ZodObject<{
|
|
|
10814
10815
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
10815
10816
|
updatedAt?: string | null | undefined;
|
|
10816
10817
|
};
|
|
10818
|
+
coveringRunId?: string | null | undefined;
|
|
10817
10819
|
enrichment: {
|
|
10818
10820
|
address: {
|
|
10819
10821
|
address?: number | null | undefined;
|
|
@@ -12336,6 +12338,7 @@ declare const PageEntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
12336
12338
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
12337
12339
|
updatedAt?: string | null | undefined;
|
|
12338
12340
|
};
|
|
12341
|
+
coveringRunId?: string | null | undefined;
|
|
12339
12342
|
enrichment: {
|
|
12340
12343
|
address: {
|
|
12341
12344
|
address?: number | null | undefined;
|
|
@@ -13084,6 +13087,7 @@ declare const PageEntitySimilarityResultSchemaDefinition: z.ZodObject<{
|
|
|
13084
13087
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
13085
13088
|
updatedAt?: string | null | undefined;
|
|
13086
13089
|
};
|
|
13090
|
+
coveringRunId?: string | null | undefined;
|
|
13087
13091
|
enrichment: {
|
|
13088
13092
|
address: {
|
|
13089
13093
|
address?: number | null | undefined;
|
|
@@ -21051,6 +21055,7 @@ declare const PageResultEntityListSchemaDefinition: z.ZodObject<{
|
|
|
21051
21055
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
21052
21056
|
updatedAt?: string | null | undefined;
|
|
21053
21057
|
};
|
|
21058
|
+
coveringRunId?: string | null | undefined;
|
|
21054
21059
|
enrichment: {
|
|
21055
21060
|
address: {
|
|
21056
21061
|
address?: number | null | undefined;
|
|
@@ -21785,6 +21790,7 @@ declare const PageResultEntityListSchemaDefinition: z.ZodObject<{
|
|
|
21785
21790
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
21786
21791
|
updatedAt?: string | null | undefined;
|
|
21787
21792
|
};
|
|
21793
|
+
coveringRunId?: string | null | undefined;
|
|
21788
21794
|
enrichment: {
|
|
21789
21795
|
address: {
|
|
21790
21796
|
address?: number | null | undefined;
|
package/dist/shared/search.d.ts
CHANGED
|
@@ -912,6 +912,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
|
|
|
912
912
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
913
913
|
updatedAt?: string | null | undefined;
|
|
914
914
|
};
|
|
915
|
+
coveringRunId?: string | null | undefined;
|
|
915
916
|
enrichment: {
|
|
916
917
|
address: {
|
|
917
918
|
address?: number | null | undefined;
|
|
@@ -1663,6 +1664,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
|
|
|
1663
1664
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
1664
1665
|
updatedAt?: string | null | undefined;
|
|
1665
1666
|
};
|
|
1667
|
+
coveringRunId?: string | null | undefined;
|
|
1666
1668
|
enrichment: {
|
|
1667
1669
|
address: {
|
|
1668
1670
|
address?: number | null | undefined;
|
|
@@ -2404,6 +2406,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
|
|
|
2404
2406
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
2405
2407
|
updatedAt?: string | null | undefined;
|
|
2406
2408
|
};
|
|
2409
|
+
coveringRunId?: string | null | undefined;
|
|
2407
2410
|
enrichment: {
|
|
2408
2411
|
address: {
|
|
2409
2412
|
address?: number | null | undefined;
|
|
@@ -8146,6 +8149,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
|
|
|
8146
8149
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
8147
8150
|
updatedAt?: string | null | undefined;
|
|
8148
8151
|
};
|
|
8152
|
+
coveringRunId?: string | null | undefined;
|
|
8149
8153
|
enrichment: {
|
|
8150
8154
|
address: {
|
|
8151
8155
|
address?: number | null | undefined;
|
|
@@ -8897,6 +8901,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
|
|
|
8897
8901
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
8898
8902
|
updatedAt?: string | null | undefined;
|
|
8899
8903
|
};
|
|
8904
|
+
coveringRunId?: string | null | undefined;
|
|
8900
8905
|
enrichment: {
|
|
8901
8906
|
address: {
|
|
8902
8907
|
address?: number | null | undefined;
|
|
@@ -9638,6 +9643,7 @@ declare const SharedSearchSchemaDefinition: z.ZodObject<{
|
|
|
9638
9643
|
typeRecord: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service";
|
|
9639
9644
|
updatedAt?: string | null | undefined;
|
|
9640
9645
|
};
|
|
9646
|
+
coveringRunId?: string | null | undefined;
|
|
9641
9647
|
enrichment: {
|
|
9642
9648
|
address: {
|
|
9643
9649
|
address?: number | null | undefined;
|