@aventurevc/api-schemas 0.8.173 → 0.8.175
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/agent/help-question.d.ts +1 -1
- package/dist/agent/help-question.js +4 -4
- package/dist/agent/help.d.ts +1 -1
- package/dist/agent/help.js +1 -1
- package/dist/classification/catalog-bucket.js +2 -2
- package/dist/classification/catalog.d.ts +1 -1
- package/dist/classification/catalog.js +1 -1
- package/dist/classification/inactive-tag-details.d.ts +7 -0
- package/dist/classification/inactive-tag-details.js +4 -1
- package/dist/domain/conflict-details.d.ts +11 -1
- package/dist/domain/conflict-details.js +1 -1
- package/dist/domain/conflict-type.d.ts +24 -0
- package/dist/domain/conflict-type.js +27 -0
- package/dist/duplicate/create-review.d.ts +7 -0
- package/dist/duplicate/create-review.js +3 -0
- package/dist/enrichment/mode.d.ts +2 -2
- package/dist/enrichment/mode.js +2 -2
- package/dist/entity/alias-type.d.ts +1 -1
- package/dist/entity/alias-type.js +1 -1
- package/dist/entity/classification-suggestion.d.ts +1 -1
- package/dist/entity/classification-suggestion.js +3 -3
- package/dist/entity/classification.d.ts +1 -1
- package/dist/entity/classification.js +2 -2
- package/dist/entity/enrichment.js +1 -1
- package/dist/entity/entity.d.ts +2 -2
- package/dist/entity/entity.js +2 -2
- package/dist/entity/image.d.ts +1 -1
- package/dist/entity/image.js +1 -1
- package/dist/entity/investments-param.d.ts +0 -1
- package/dist/entity/investments-param.js +0 -2
- package/dist/entity/investors-param.d.ts +0 -1
- package/dist/entity/investors-param.js +0 -2
- package/dist/entity/lookup-batch-param.d.ts +0 -1
- package/dist/entity/lookup-batch-param.js +0 -2
- package/dist/entity/lookup-exact-param.d.ts +0 -1
- package/dist/entity/lookup-exact-param.js +0 -2
- package/dist/entity/name-alias-entity-alias-type.d.ts +1 -1
- package/dist/entity/name-alias-entity-alias-type.js +1 -1
- package/dist/entity/people-param.d.ts +0 -1
- package/dist/entity/people-param.js +0 -2
- package/dist/entity/relationship.js +3 -3
- package/dist/entity/research-detail.d.ts +1 -1
- package/dist/entity/research-detail.js +1 -1
- package/dist/entity/search-param.d.ts +0 -1
- package/dist/entity/search-param.js +1 -3
- package/dist/entity/sitemap.d.ts +1 -1
- package/dist/entity/sitemap.js +1 -1
- package/dist/entity/tag.d.ts +1 -1
- package/dist/entity/tag.js +8 -8
- package/dist/entity/valuation-data-confidence.d.ts +1 -1
- package/dist/entity/valuation-data-confidence.js +1 -1
- package/dist/federated/natural-search.js +4 -4
- package/dist/harness/chassis.d.ts +2 -2
- package/dist/harness/chassis.js +2 -2
- package/dist/harness/llm-api.d.ts +2 -2
- package/dist/harness/llm-api.js +2 -2
- package/dist/harness/run-create.d.ts +1 -1
- package/dist/harness/run-create.js +1 -1
- package/dist/harness/run-detail.d.ts +2 -2
- package/dist/harness/run-detail.js +5 -5
- package/dist/harness/run-environment.d.ts +2 -5
- package/dist/harness/run-environment.js +2 -5
- package/dist/harness/run-lane.d.ts +2 -2
- package/dist/harness/run-lane.js +2 -2
- package/dist/harness/run-progress.d.ts +1 -1
- package/dist/harness/run-progress.js +2 -2
- package/dist/harness/run-status.d.ts +3 -3
- package/dist/harness/run-status.js +3 -3
- package/dist/harness/run-type.d.ts +3 -3
- package/dist/harness/run-type.js +3 -3
- package/dist/harness/run.d.ts +3 -3
- package/dist/harness/run.js +10 -10
- package/dist/http/problem-detail.d.ts +10 -0
- package/dist/http/problem-detail.js +18 -3
- package/dist/identification/candidate.js +3 -3
- package/dist/identification/identification.d.ts +2 -4
- package/dist/identification/identification.js +7 -11
- package/dist/lookup/job-mention.d.ts +3 -5
- package/dist/lookup/job-mention.js +4 -4
- package/dist/lookup/job-mutation.js +2 -2
- package/dist/lookup/job.d.ts +4 -10
- package/dist/lookup/mention.js +1 -1
- package/dist/media/upload.js +1 -1
- package/dist/mention/lookup.d.ts +2 -6
- package/dist/natural/search-result.js +1 -1
- package/dist/natural/search.js +4 -4
- package/dist/news/resolved-entity-link.js +1 -0
- package/dist/news/source-url-conflict.d.ts +7 -0
- package/dist/news/source-url-conflict.js +3 -0
- package/dist/openapi-component-manifest.js +4 -9
- package/dist/person/lookup-batch-param.d.ts +0 -1
- package/dist/person/lookup-batch-param.js +0 -2
- package/dist/person/lookup-exact-param.d.ts +0 -1
- package/dist/person/lookup-exact-param.js +0 -2
- package/dist/person/natural-search-result.js +1 -1
- package/dist/person/search-param.d.ts +0 -1
- package/dist/person/search-param.js +0 -2
- package/dist/research/finding.d.ts +1 -1
- package/dist/research/finding.js +1 -1
- package/dist/search/search.d.ts +0 -8
- package/dist/search/search.js +4 -11
- package/dist/standardized/classification.d.ts +1 -1
- package/dist/standardized/classification.js +4 -4
- package/dist/strict/url-lookup-conflict.d.ts +7 -0
- package/dist/strict/url-lookup-conflict.js +3 -0
- package/dist/system/status.js +1 -1
- package/dist/url/duplicate-conflict.d.ts +7 -0
- package/dist/url/duplicate-conflict.js +3 -0
- package/dist/url/duplicate-join.d.ts +1 -1
- package/dist/url/duplicate-join.js +2 -2
- package/dist/web/search.d.ts +0 -6
- package/package.json +1 -1
- package/dist/datasource/data-source-type.d.ts +0 -24
- package/dist/datasource/data-source-type.js +0 -24
- package/dist/datasource/provenance-actor-type.d.ts +0 -15
- package/dist/datasource/provenance-actor-type.js +0 -12
- package/dist/suppression/reason.d.ts +0 -17
- package/dist/suppression/reason.js +0 -16
package/dist/harness/run.js
CHANGED
|
@@ -8,14 +8,14 @@ import { HarnessRunLaneSchema } from "./run-lane.js";
|
|
|
8
8
|
import { HarnessRunStatusSchema } from "./run-status.js";
|
|
9
9
|
import { HarnessRunTypeSchema } from "./run-type.js";
|
|
10
10
|
/**
|
|
11
|
-
* One
|
|
11
|
+
* One research run on a company, Product, Service, or person
|
|
12
12
|
*
|
|
13
13
|
* @openapiSchema HarnessRun
|
|
14
|
-
* @endpoint GET /v1/
|
|
14
|
+
* @endpoint GET /v1/research-runs/{runId}
|
|
15
15
|
* @endpoint POST /v1/enrichments
|
|
16
16
|
* @endpoint POST /v1/entities/{entityId}/enrichments
|
|
17
|
-
* @endpoint POST /v1/harness/runs
|
|
18
17
|
* @endpoint POST /v1/people/{personId}/enrichments
|
|
18
|
+
* @endpoint POST /v1/research-runs
|
|
19
19
|
* @usedBySchema EnrichmentSchema
|
|
20
20
|
* @usedBySchema HarnessRunDetailSchema
|
|
21
21
|
* @contractShape harness.run
|
|
@@ -30,11 +30,11 @@ export const HarnessRunSchema = z.object({
|
|
|
30
30
|
chassisRouted: z.boolean(),
|
|
31
31
|
/** Creation timestamp */
|
|
32
32
|
createdAt: z.iso.datetime({ offset: true }),
|
|
33
|
-
/**
|
|
33
|
+
/** Slug of the profile the run produced */
|
|
34
34
|
entitySlug: z.string().nullish(),
|
|
35
35
|
/** API environment */
|
|
36
36
|
environment: HarnessRunEnvironmentSchema,
|
|
37
|
-
/**
|
|
37
|
+
/** Why the run failed; null unless failed */
|
|
38
38
|
error: z.string().nullish(),
|
|
39
39
|
/** Typed terminal-failure class from the harness retry classifier (e.g. runtime_cap, escalated, provider_capacity, context_overflow); null unless failed */
|
|
40
40
|
failureClass: z.string().nullish(),
|
|
@@ -58,7 +58,7 @@ export const HarnessRunSchema = z.object({
|
|
|
58
58
|
maxScoutConcurrent: z.int(),
|
|
59
59
|
/** Enrichment breadth selected for this run */
|
|
60
60
|
mode: EnrichmentModeSchema,
|
|
61
|
-
/**
|
|
61
|
+
/** Model the run uses */
|
|
62
62
|
model: z.string(),
|
|
63
63
|
/** Earliest re-claim time when waiting on retry backoff */
|
|
64
64
|
nextAttemptAt: z.iso.datetime({ offset: true }).nullish(),
|
|
@@ -70,15 +70,15 @@ export const HarnessRunSchema = z.object({
|
|
|
70
70
|
status: HarnessRunStatusSchema,
|
|
71
71
|
/** Read-only research, cohort, and completion sub-agent model id */
|
|
72
72
|
subagentModel: z.string(),
|
|
73
|
-
/**
|
|
73
|
+
/** Research presets filed with the run */
|
|
74
74
|
taskPresetKey: z.array(z.string()).nullish(),
|
|
75
|
-
/** Run kind
|
|
75
|
+
/** Run kind: ENRICHMENT for a research request a caller filed, TASK for a narrower run aVenture scheduled */
|
|
76
76
|
type: HarnessRunTypeSchema,
|
|
77
77
|
/** Last update timestamp */
|
|
78
78
|
updatedAt: z.iso.datetime({ offset: true }),
|
|
79
|
-
/**
|
|
79
|
+
/** URL of the company, Product, Service, or person under research */
|
|
80
80
|
url: z.string(),
|
|
81
|
-
/** Optional
|
|
81
|
+
/** Optional instructions filed with the run */
|
|
82
82
|
userPrompt: z.string().nullish(),
|
|
83
83
|
});
|
|
84
84
|
//# sourceMappingURL=run.js.map
|
|
@@ -98,6 +98,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
98
98
|
}, z.core.$strip>>>;
|
|
99
99
|
detail: z.ZodOptional<z.ZodString>;
|
|
100
100
|
details: z.ZodOptional<z.ZodNullable<z.ZodUnion<readonly [z.ZodType<{
|
|
101
|
+
conflictType?: string | undefined;
|
|
101
102
|
existingJoin: {
|
|
102
103
|
owner: {
|
|
103
104
|
entityId?: string | null | undefined;
|
|
@@ -115,6 +116,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
115
116
|
url: string;
|
|
116
117
|
urlType: string;
|
|
117
118
|
}, import("../url/duplicate-conflict.ts").UrlDuplicateConflictSchemaInput, z.core.$ZodTypeInternals<{
|
|
119
|
+
conflictType?: string | undefined;
|
|
118
120
|
existingJoin: {
|
|
119
121
|
owner: {
|
|
120
122
|
entityId?: string | null | undefined;
|
|
@@ -134,6 +136,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
134
136
|
}, import("../url/duplicate-conflict.ts").UrlDuplicateConflictSchemaInput>>, z.ZodType<{
|
|
135
137
|
candidateEntityId: string[];
|
|
136
138
|
candidatePersonId: string[];
|
|
139
|
+
conflictType?: string | undefined;
|
|
137
140
|
hint: string;
|
|
138
141
|
normalizedUrl?: string | null | undefined;
|
|
139
142
|
url: string;
|
|
@@ -141,6 +144,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
141
144
|
}, import("../strict/url-lookup-conflict.ts").StrictUrlLookupConflictSchemaInput, z.core.$ZodTypeInternals<{
|
|
142
145
|
candidateEntityId: string[];
|
|
143
146
|
candidatePersonId: string[];
|
|
147
|
+
conflictType?: string | undefined;
|
|
144
148
|
hint: string;
|
|
145
149
|
normalizedUrl?: string | null | undefined;
|
|
146
150
|
url: string;
|
|
@@ -157,6 +161,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
157
161
|
slug?: string | null | undefined;
|
|
158
162
|
typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
|
|
159
163
|
}[] | null | undefined;
|
|
164
|
+
conflictType?: string | undefined;
|
|
160
165
|
newsCandidate?: {
|
|
161
166
|
externalId?: string | null | undefined;
|
|
162
167
|
id: number;
|
|
@@ -178,6 +183,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
178
183
|
slug?: string | null | undefined;
|
|
179
184
|
typeRecord?: "Business Line" | "Company" | "Fund" | "Government" | "Investment Firm" | "Nonprofit" | "Organization" | "Product" | "Service" | null | undefined;
|
|
180
185
|
}[] | null | undefined;
|
|
186
|
+
conflictType?: string | undefined;
|
|
181
187
|
newsCandidate?: {
|
|
182
188
|
externalId?: string | null | undefined;
|
|
183
189
|
id: number;
|
|
@@ -189,20 +195,24 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
189
195
|
threshold: number;
|
|
190
196
|
}, import("../duplicate/create-review.ts").DuplicateCreateReviewSchemaInput>>, z.ZodType<{
|
|
191
197
|
availableOverrides: ("ATTACH_INACTIVE" | "REACTIVATE")[];
|
|
198
|
+
conflictType?: string | undefined;
|
|
192
199
|
slug: string;
|
|
193
200
|
tagId: number;
|
|
194
201
|
}, import("../classification/inactive-tag-details.ts").ClassificationInactiveTagDetailsSchemaInput, z.core.$ZodTypeInternals<{
|
|
195
202
|
availableOverrides: ("ATTACH_INACTIVE" | "REACTIVATE")[];
|
|
203
|
+
conflictType?: string | undefined;
|
|
196
204
|
slug: string;
|
|
197
205
|
tagId: number;
|
|
198
206
|
}, import("../classification/inactive-tag-details.ts").ClassificationInactiveTagDetailsSchemaInput>>, z.ZodType<{
|
|
199
207
|
conflictingArticleId: number;
|
|
200
208
|
conflictingArticleSlug: string;
|
|
201
209
|
conflictingArticleTitle: string;
|
|
210
|
+
conflictType?: string | undefined;
|
|
202
211
|
}, import("../news/source-url-conflict.ts").NewsSourceUrlConflictSchemaInput, z.core.$ZodTypeInternals<{
|
|
203
212
|
conflictingArticleId: number;
|
|
204
213
|
conflictingArticleSlug: string;
|
|
205
214
|
conflictingArticleTitle: string;
|
|
215
|
+
conflictType?: string | undefined;
|
|
206
216
|
}, import("../news/source-url-conflict.ts").NewsSourceUrlConflictSchemaInput>>]>>>;
|
|
207
217
|
error: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
|
|
208
218
|
existingRecordId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
@@ -12,7 +12,7 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
12
12
|
.enum(["COMPANY", "PERSON", "ENTITY_VIEW", "ENTITY_BRAND", "PERSON_VIEW", "WEB_SEARCH"])
|
|
13
13
|
.nullish(),
|
|
14
14
|
circuitBreaker: z.string().nullish(),
|
|
15
|
-
/** Machine-readable secondary code on ProblemDetail.code. Agents should branch on this value when the HTTP status alone does not identify the recovery path. Code groups include auth/session, rate limiting, job infrastructure, RBAC, external providers, image processing, R2 storage, search, and inference. Many codes
|
|
15
|
+
/** Machine-readable secondary code on ProblemDetail.code. Agents should branch on this value when the HTTP status alone does not identify the recovery path. Code groups include auth/session, rate limiting, job infrastructure, RBAC, external providers, image processing, R2 storage, search, and inference. Many codes describe server-side conditions a caller cannot fix: surface the error and stop rather than retry. */
|
|
16
16
|
code: z
|
|
17
17
|
.union([
|
|
18
18
|
z.enum([
|
|
@@ -162,7 +162,7 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
162
162
|
.nullish(),
|
|
163
163
|
conflictingRecord: CurrentSlugOwnerSchema.nullish(),
|
|
164
164
|
detail: z.string().optional(),
|
|
165
|
-
/** Structured conflict details.
|
|
165
|
+
/** Structured conflict details. A possible duplicate or an ambiguous lookup returns its candidate records; score and threshold rank the candidates and do not prove that the requested record is absent. */
|
|
166
166
|
details: DomainConflictDetailsSchema.nullish(),
|
|
167
167
|
error: z.record(z.string(), z.string()).nullish(),
|
|
168
168
|
/** On a duplicate 409, the id of the stored record the request collided with; read or update that record instead of creating it again. Absent when the conflict names no single stored record. */
|
|
@@ -170,7 +170,7 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
170
170
|
existingRedirect: RedirectSlugPathSchema.nullish(),
|
|
171
171
|
feId: z.string().nullish(),
|
|
172
172
|
field: z.string().nullish(),
|
|
173
|
-
/**
|
|
173
|
+
/** Research request ids a batch filed or reused for its other records before returning this error; absent for every other error. */
|
|
174
174
|
filedRunId: z.array(z.uuid()).nullish(),
|
|
175
175
|
hammingDistance: z.number().int().nullish(),
|
|
176
176
|
hint: z.string().nullish(),
|
|
@@ -180,20 +180,35 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
180
180
|
/** Which meter refused the request; names what limit/used/remaining count. */
|
|
181
181
|
limitType: z
|
|
182
182
|
.enum([
|
|
183
|
+
/** Too many form submissions from this client; retry after retryAfterSeconds. */
|
|
183
184
|
"FORM",
|
|
185
|
+
/** The service-wide request rate is exhausted; retry after retryAfterSeconds. */
|
|
184
186
|
"GLOBAL",
|
|
187
|
+
/** Too many requests from this client's network; retry after retryAfterSeconds. */
|
|
185
188
|
"SUBNET",
|
|
189
|
+
/** Too many requests from this client's address; retry after retryAfterSeconds. */
|
|
186
190
|
"IP",
|
|
191
|
+
/** A request-rate limit refused the request; retry after retryAfterSeconds. */
|
|
187
192
|
"UNKNOWN",
|
|
193
|
+
/** The service is handling too many requests at once; retry after a short backoff. */
|
|
188
194
|
"RESILIENCE4J",
|
|
195
|
+
/** Too many live web searches; retry after retryAfterSeconds. */
|
|
189
196
|
"WEB_SEARCH",
|
|
197
|
+
/** Too many help questions; retry after retryAfterSeconds. */
|
|
190
198
|
"AGENT_HELP",
|
|
199
|
+
/** Too many natural-language searches; retry after retryAfterSeconds. */
|
|
191
200
|
"NATURAL_SEARCH",
|
|
201
|
+
/** The plan's monthly research allowance is used up. It refills at resetAt, often weeks away: stop rather than retry. */
|
|
192
202
|
"BILLING_ALLOWANCE",
|
|
203
|
+
/** The additional-usage spend cap or prepaid credit is used up, counted in cents: stop rather than retry until the cap is raised or credit is added. */
|
|
193
204
|
"BILLING_ADDITIONAL_USAGE",
|
|
205
|
+
/** Too many command-line sign-in requests; retry after retryAfterSeconds. */
|
|
194
206
|
"CLERK_PUBLIC_ADMISSION",
|
|
207
|
+
/** Too many sign-in page load reports; retry after retryAfterSeconds. */
|
|
195
208
|
"CLERK_SCRIPT_LOAD",
|
|
209
|
+
/** Not currently sent. If seen, retry after retryAfterSeconds. */
|
|
196
210
|
"ORIGIN_DETAIL",
|
|
211
|
+
/** A model service this request depends on is at capacity; retry after retryAfterSeconds. */
|
|
197
212
|
"INFERENCE_PROVIDER",
|
|
198
213
|
])
|
|
199
214
|
.nullish(),
|
|
@@ -17,9 +17,9 @@ import { SearchDuplicateCandidateScoreSchema } from "../search/duplicate-candida
|
|
|
17
17
|
* @contractRole canonical
|
|
18
18
|
*/
|
|
19
19
|
export const IdentificationCandidateSchema = z.object({
|
|
20
|
-
/** When the record was created. A
|
|
20
|
+
/** When the record was created. A record created moments before the lookup is newly added and not yet researched. */
|
|
21
21
|
createdAt: z.iso.datetime({ offset: true }).nullish(),
|
|
22
|
-
/** Percentage, 0 to 100, of
|
|
22
|
+
/** Percentage, 0 to 100, of this company's core profile facts that aVenture holds, as last computed. It measures how complete the record is, not how likely it is the subject. Absent for people and for companies not yet computed. */
|
|
23
23
|
dataCompletionCoverage: z.int().min(0).max(100).nullish(),
|
|
24
24
|
/** Whether this record's stored website agrees with a url the subject supplied; see IdentificationDomainAgreement. */
|
|
25
25
|
domainAgreement: z.enum(["MATCH", "CONFLICT", "UNKNOWN"]).nullish(),
|
|
@@ -31,7 +31,7 @@ export const IdentificationCandidateSchema = z.object({
|
|
|
31
31
|
foundedYear: z.int().nullish(),
|
|
32
32
|
/** Entity identity (entityId) or person identity (personId). record.typeRecord distinguishes a company, product, or service; read it with GET /v1/entities/{entityId} or GET /v1/people/{personId}. */
|
|
33
33
|
owner: EntityPersonOwnerSchema,
|
|
34
|
-
/**
|
|
34
|
+
/** Confidence, 0 to 1, that this record is the subject: the one confidence to act on. Absent when an exact id, URL, slug, or registry-id match settled the answer, which needs no confidence, or when this record was not compared. */
|
|
35
35
|
probability: z.number().nullish(),
|
|
36
36
|
/** The record with its duplicate-check score and reasons; score 0 with no reason means only vector similarity proposed it. */
|
|
37
37
|
record: SearchDuplicateCandidateScoreSchema,
|
|
@@ -194,14 +194,12 @@ export declare const IdentificationSchema: z.ZodObject<{
|
|
|
194
194
|
updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
195
195
|
website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
196
196
|
}, z.core.$strip>>>;
|
|
197
|
-
matchConfidence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
198
|
-
matchEvidenceProbability: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
199
197
|
officialUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
200
|
-
stage: z.ZodEnum<{
|
|
198
|
+
stage: z.ZodOptional<z.ZodEnum<{
|
|
201
199
|
DETERMINISTIC: "DETERMINISTIC";
|
|
202
200
|
JUDGMENT: "JUDGMENT";
|
|
203
201
|
WEB_EVIDENCE: "WEB_EVIDENCE";
|
|
204
|
-
}
|
|
202
|
+
}>>;
|
|
205
203
|
status: z.ZodEnum<{
|
|
206
204
|
MATCHED: "MATCHED";
|
|
207
205
|
NEEDS_REVIEW: "NEEDS_REVIEW";
|
|
@@ -19,26 +19,22 @@ import { IdentificationCandidateSchema } from "./candidate.js";
|
|
|
19
19
|
export const IdentificationSchema = z.object({
|
|
20
20
|
/** Records considered, most probable first. */
|
|
21
21
|
candidate: z.array(IdentificationCandidateSchema),
|
|
22
|
-
/** With fileOnMiss=true, the
|
|
22
|
+
/** With fileOnMiss=true, the new record this NO_MATCH created, or the existing one that already held its website. Absent otherwise. */
|
|
23
23
|
created: IdentificationCandidateSchema.nullish(),
|
|
24
24
|
/** One sentence naming what settled the answer or what the user must decide. */
|
|
25
25
|
detail: z.string(),
|
|
26
|
-
/** Other
|
|
26
|
+
/** Other records that appear to describe the same subject as match. Empty when none were found. */
|
|
27
27
|
duplicate: z.array(IdentificationCandidateSchema),
|
|
28
|
-
/**
|
|
28
|
+
/** Research request filed for the created record; absent without created, and when the record is already public. */
|
|
29
29
|
enrichmentRunId: z.uuid().nullish(),
|
|
30
|
-
/** true when
|
|
30
|
+
/** true when the match was settled on a second, slower review; confirm it before relying on it. Absent otherwise. */
|
|
31
31
|
languageModelSettled: z.boolean().nullish(),
|
|
32
32
|
/** The matched record when status is MATCHED. */
|
|
33
33
|
match: IdentificationCandidateSchema.nullish(),
|
|
34
|
-
/**
|
|
35
|
-
matchConfidence: z.number().nullish(),
|
|
36
|
-
/** Decision-model probability, 0 to 1, that the evidence can tell the subject apart from namesakes. Absent when no judgment ran. The kind-agnostic lookup reports the side whose answer it returns. */
|
|
37
|
-
matchEvidenceProbability: z.number().nullish(),
|
|
38
|
-
/** The subject's own website or profile page found in web search. Use it as the website when creating the record only if it is the subject's own domain, not a LinkedIn, Crunchbase, or other profile page. */
|
|
34
|
+
/** The subject's own website or profile page found in web search; it may be a profile page on another site rather than the subject's own domain. */
|
|
39
35
|
officialUrl: z.string().nullish(),
|
|
40
|
-
/**
|
|
41
|
-
stage: z.enum(["DETERMINISTIC", "JUDGMENT", "WEB_EVIDENCE"]),
|
|
36
|
+
/** How the answer was settled; informational, so act on status instead. */
|
|
37
|
+
stage: z.enum(["DETERMINISTIC", "JUDGMENT", "WEB_EVIDENCE"]).optional(),
|
|
42
38
|
/** Use the scoped match, record scoped absence, or refine an ambiguous identity with evidence. */
|
|
43
39
|
status: z.enum(["MATCHED", "NO_MATCH", "NEEDS_REVIEW"]),
|
|
44
40
|
});
|
|
@@ -1143,14 +1143,12 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
|
|
|
1143
1143
|
updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
1144
1144
|
website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1145
1145
|
}, z.core.$strip>>>;
|
|
1146
|
-
matchConfidence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1147
|
-
matchEvidenceProbability: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
1148
1146
|
officialUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
1149
|
-
stage: z.ZodEnum<{
|
|
1147
|
+
stage: z.ZodOptional<z.ZodEnum<{
|
|
1150
1148
|
DETERMINISTIC: "DETERMINISTIC";
|
|
1151
1149
|
JUDGMENT: "JUDGMENT";
|
|
1152
1150
|
WEB_EVIDENCE: "WEB_EVIDENCE";
|
|
1153
|
-
}
|
|
1151
|
+
}>>;
|
|
1154
1152
|
status: z.ZodEnum<{
|
|
1155
1153
|
MATCHED: "MATCHED";
|
|
1156
1154
|
NEEDS_REVIEW: "NEEDS_REVIEW";
|
|
@@ -1250,7 +1248,7 @@ type LookupJobMentionDefinition = z.infer<typeof LookupJobMentionSchemaDefinitio
|
|
|
1250
1248
|
export interface LookupJobMentionSchemaInput extends z.input<typeof LookupJobMentionSchemaDefinition> {
|
|
1251
1249
|
}
|
|
1252
1250
|
/**
|
|
1253
|
-
* One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the
|
|
1251
|
+
* One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the new unpublished record created when it is new. Bulk lookup only identifies names and creates no records.
|
|
1254
1252
|
*
|
|
1255
1253
|
* @openapiSchema LookupJobMention
|
|
1256
1254
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
@@ -5,7 +5,7 @@ import { EntityPersonOwnerSchema } from "../entity/person-owner.js";
|
|
|
5
5
|
import { IdentificationSchema } from "../identification/identification.js";
|
|
6
6
|
import { PersonSchema } from "../person/person.js";
|
|
7
7
|
const LookupJobMentionSchemaDefinition = z.object({
|
|
8
|
-
/**
|
|
8
|
+
/** Research request filed for this mention, if any. */
|
|
9
9
|
enrichmentRunId: z.uuid().nullish(),
|
|
10
10
|
/** POST /v1/lookup-mentions only: the candidate companies as search results show them, the match first, then by decision-model probability and duplicate-check score. */
|
|
11
11
|
entity: z.array(EntityListSchema),
|
|
@@ -19,13 +19,13 @@ const LookupJobMentionSchemaDefinition = z.object({
|
|
|
19
19
|
name: z.string(),
|
|
20
20
|
/** POST /v1/lookup-mentions only: the candidate people as search results show them, ranked like entity. */
|
|
21
21
|
person: z.array(PersonSchema),
|
|
22
|
-
/**
|
|
22
|
+
/** New unpublished record aVenture created for a NO_MATCH name that the article and another live page both name. enrichmentRunId names the research already filed for it; to file research yourself, send its entityId to POST /v1/entities/{entityId}/enrichments or its personId to POST /v1/people/{personId}/enrichments. */
|
|
23
23
|
shell: EntityPersonOwnerSchema.nullish(),
|
|
24
|
-
/**
|
|
24
|
+
/** Why no new record was created for this NO_MATCH name. */
|
|
25
25
|
shellDetail: z.string().nullish(),
|
|
26
26
|
});
|
|
27
27
|
/**
|
|
28
|
-
* One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the
|
|
28
|
+
* One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the new unpublished record created when it is new. Bulk lookup only identifies names and creates no records.
|
|
29
29
|
*
|
|
30
30
|
* @openapiSchema LookupJobMention
|
|
31
31
|
* @endpoint GET /v1/lookup-jobs/{jobId}
|
|
@@ -3,11 +3,11 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { IdentificationSubjectSchema } from "../identification/subject.js";
|
|
4
4
|
import { LookupMentionSchema } from "./mention.js";
|
|
5
5
|
const LookupJobMutationSchemaDefinition = z.object({
|
|
6
|
-
/** Companies and people the caller already read, identified without sending the page or screenshot. Send them alone, without an article or file. On lookup jobs, maxNames is required and no
|
|
6
|
+
/** Companies and people the caller already read, identified without sending the page or screenshot. Send them alone, without an article or file. On lookup jobs, maxNames is required and no records are created and no research is requested. */
|
|
7
7
|
mention: z.array(LookupMentionSchema).optional(),
|
|
8
8
|
/** POST /v1/lookup-mentions only: true answers each name with only its name, mentionType, failureReason, and identification status, stage, match, officialUrl, and detail: no entity or person rows and empty candidate and duplicate lists. Defaults to false, the full answer. */
|
|
9
9
|
omitRecords: z.boolean().optional(),
|
|
10
|
-
/** Id of a
|
|
10
|
+
/** Id of a stored source document whose text is the article; send it alone. Only POST /v1/lookup-mentions reads it, and only for accounts with editing rights. */
|
|
11
11
|
sourceDocumentId: z.uuid().nullish(),
|
|
12
12
|
/** aVenture news id of the article; an id that names no stored article is an error. */
|
|
13
13
|
sourceNewsId: z.int().nullish(),
|
package/dist/lookup/job.d.ts
CHANGED
|
@@ -182,14 +182,12 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
182
182
|
updatedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
183
183
|
website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
184
184
|
}, z.core.$strip>>>;
|
|
185
|
-
matchConfidence: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
186
|
-
matchEvidenceProbability: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
187
185
|
officialUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
188
|
-
stage: z.ZodEnum<{
|
|
186
|
+
stage: z.ZodOptional<z.ZodEnum<{
|
|
189
187
|
DETERMINISTIC: "DETERMINISTIC";
|
|
190
188
|
JUDGMENT: "JUDGMENT";
|
|
191
189
|
WEB_EVIDENCE: "WEB_EVIDENCE";
|
|
192
|
-
}
|
|
190
|
+
}>>;
|
|
193
191
|
status: z.ZodEnum<{
|
|
194
192
|
MATCHED: "MATCHED";
|
|
195
193
|
NEEDS_REVIEW: "NEEDS_REVIEW";
|
|
@@ -791,10 +789,8 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
791
789
|
updatedAt?: string | null | undefined;
|
|
792
790
|
website?: string | null | undefined;
|
|
793
791
|
} | null | undefined;
|
|
794
|
-
matchConfidence?: number | null | undefined;
|
|
795
|
-
matchEvidenceProbability?: number | null | undefined;
|
|
796
792
|
officialUrl?: string | null | undefined;
|
|
797
|
-
stage
|
|
793
|
+
stage?: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE" | undefined;
|
|
798
794
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
799
795
|
} | null | undefined;
|
|
800
796
|
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
@@ -1435,10 +1431,8 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
|
|
|
1435
1431
|
updatedAt?: string | null | undefined;
|
|
1436
1432
|
website?: string | null | undefined;
|
|
1437
1433
|
} | null | undefined;
|
|
1438
|
-
matchConfidence?: number | null | undefined;
|
|
1439
|
-
matchEvidenceProbability?: number | null | undefined;
|
|
1440
1434
|
officialUrl?: string | null | undefined;
|
|
1441
|
-
stage
|
|
1435
|
+
stage?: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE" | undefined;
|
|
1442
1436
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
1443
1437
|
} | null | undefined;
|
|
1444
1438
|
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
package/dist/lookup/mention.js
CHANGED
|
@@ -7,7 +7,7 @@ const LookupMentionSchemaDefinition = z.object({
|
|
|
7
7
|
providerName: z.string().nullish(),
|
|
8
8
|
/** Ignored: the lookup searches by name. Still accepted so callers that send it keep working; omit it. */
|
|
9
9
|
searchQuery: z.string().optional(),
|
|
10
|
-
/** Whether the source names a company, a Product or Service (PRODUCT_SERVICE), or a person. A Product or Service resolves like a company first, then among Product and Service records when that finds no match, and never
|
|
10
|
+
/** Whether the source names a company, a Product or Service (PRODUCT_SERVICE), or a person. A Product or Service resolves like a company first, then among Product and Service records when that finds no match, and never creates a new record. */
|
|
11
11
|
type: z.enum(["COMPANY", "PERSON", "PRODUCT_SERVICE"]),
|
|
12
12
|
});
|
|
13
13
|
/**
|
package/dist/media/upload.js
CHANGED
|
@@ -7,7 +7,7 @@ const MediaUploadSchemaDefinition = z.object({
|
|
|
7
7
|
accuracy: LogoAccuracySchema.nullish(),
|
|
8
8
|
/** Resolved API CDN URL */
|
|
9
9
|
cdnUrl: z.string(),
|
|
10
|
-
/** Earliest
|
|
10
|
+
/** Earliest time this company, person, or news item received an image in this slot. */
|
|
11
11
|
firstUploadedAt: z.iso.datetime({ offset: true }).nullish(),
|
|
12
12
|
/** Target media domain */
|
|
13
13
|
mediaType: MediaObjectTypeSchema,
|
package/dist/mention/lookup.d.ts
CHANGED
|
@@ -592,10 +592,8 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
592
592
|
updatedAt?: string | null | undefined;
|
|
593
593
|
website?: string | null | undefined;
|
|
594
594
|
} | null | undefined;
|
|
595
|
-
matchConfidence?: number | null | undefined;
|
|
596
|
-
matchEvidenceProbability?: number | null | undefined;
|
|
597
595
|
officialUrl?: string | null | undefined;
|
|
598
|
-
stage
|
|
596
|
+
stage?: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE" | undefined;
|
|
599
597
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
600
598
|
} | null | undefined;
|
|
601
599
|
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
@@ -1236,10 +1234,8 @@ declare const MentionLookupSchemaDefinition: z.ZodObject<{
|
|
|
1236
1234
|
updatedAt?: string | null | undefined;
|
|
1237
1235
|
website?: string | null | undefined;
|
|
1238
1236
|
} | null | undefined;
|
|
1239
|
-
matchConfidence?: number | null | undefined;
|
|
1240
|
-
matchEvidenceProbability?: number | null | undefined;
|
|
1241
1237
|
officialUrl?: string | null | undefined;
|
|
1242
|
-
stage
|
|
1238
|
+
stage?: "DETERMINISTIC" | "JUDGMENT" | "WEB_EVIDENCE" | undefined;
|
|
1243
1239
|
status: "MATCHED" | "NEEDS_REVIEW" | "NO_MATCH";
|
|
1244
1240
|
} | null | undefined;
|
|
1245
1241
|
mentionType: "COMPANY" | "PERSON" | "PRODUCT_SERVICE";
|
|
@@ -25,7 +25,7 @@ const NaturalSearchResultSchemaDefinition = z.object({
|
|
|
25
25
|
pendingWebQuery: z.array(z.string()),
|
|
26
26
|
/** Entity list page returned by the canonical entity list engine. */
|
|
27
27
|
result: PageResultEntityListSchema,
|
|
28
|
-
/** Id of this search's stored record
|
|
28
|
+
/** Id of this search's stored record. Null when the search was not recorded. */
|
|
29
29
|
searchRequestId: z.uuid().nullish(),
|
|
30
30
|
/** Entities the question is about, one per resolved subject name, in query order; empty when the question names none or none resolves. */
|
|
31
31
|
subject: z.array(EntityListSchema),
|
package/dist/natural/search.js
CHANGED
|
@@ -4,17 +4,17 @@ import { ReasoningEffortSchema } from "../reasoning/effort.js";
|
|
|
4
4
|
import { SearchCacheModeSchema } from "../search/cache-mode.js";
|
|
5
5
|
import { SearchModeSchema } from "../search/mode.js";
|
|
6
6
|
const NaturalSearchSchemaDefinition = z.object({
|
|
7
|
-
/** Optional
|
|
7
|
+
/** Optional supported model for the written answer, which also supplies the page heading, title, and description. Omit it to use the default; an unsupported model answers 422. */
|
|
8
8
|
answerModel: z.string().nullish(),
|
|
9
|
-
/**
|
|
9
|
+
/** Cache policy. use reuses earlier search work; bypass and refresh compute fresh results and are honored only for accounts with private-data access. */
|
|
10
10
|
cacheMode: SearchCacheModeSchema.default("use").optional(),
|
|
11
11
|
/** 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). */
|
|
12
12
|
mode: SearchModeSchema.default("auto").optional(),
|
|
13
|
-
/** Optional
|
|
13
|
+
/** Optional supported model for planning the search. Omit it to use the default; an unsupported model answers 422. */
|
|
14
14
|
model: z.string().nullish(),
|
|
15
15
|
/** Plain-English search request. */
|
|
16
16
|
query: z.string().min(1),
|
|
17
|
-
/** 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.
|
|
17
|
+
/** 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. Accounts without private-data access are capped at `medium`; higher values are lowered. */
|
|
18
18
|
reasoningEffort: ReasoningEffortSchema.nullish(),
|
|
19
19
|
/** Search catalog revision this search reads its qualifier prompts and startup vocabulary from, to compare catalog edits; null reads the current revision. Callers without private-data access always read the current revision. An unknown revision returns 404. */
|
|
20
20
|
searchCatalogRevision: z.int().nullish(),
|
|
@@ -7,6 +7,7 @@ const NewsResolvedEntityLinkSchemaDefinition = z.object({
|
|
|
7
7
|
/** Canonical entity UUID */
|
|
8
8
|
entityId: z.uuid(),
|
|
9
9
|
href: z.string().nullish(),
|
|
10
|
+
/** True when href links to this entity's aVenture page; false when the entity has no page to link to. */
|
|
10
11
|
internal: z.boolean(),
|
|
11
12
|
matchStatus: NewsMatchStatusSchema.nullish(),
|
|
12
13
|
mention: z.string().nullish(),
|
|
@@ -3,6 +3,13 @@ declare const NewsSourceUrlConflictSchemaDefinition: z.ZodObject<{
|
|
|
3
3
|
conflictingArticleId: z.ZodInt;
|
|
4
4
|
conflictingArticleSlug: z.ZodString;
|
|
5
5
|
conflictingArticleTitle: z.ZodString;
|
|
6
|
+
conflictType: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
|
|
7
|
+
CLASSIFICATION_INACTIVE_TAG: "CLASSIFICATION_INACTIVE_TAG";
|
|
8
|
+
DUPLICATE_CREATE_REVIEW: "DUPLICATE_CREATE_REVIEW";
|
|
9
|
+
NEWS_SOURCE_URL: "NEWS_SOURCE_URL";
|
|
10
|
+
STRICT_URL_LOOKUP: "STRICT_URL_LOOKUP";
|
|
11
|
+
URL_DUPLICATE: "URL_DUPLICATE";
|
|
12
|
+
}>, z.ZodString]>>;
|
|
6
13
|
}, z.core.$strip>;
|
|
7
14
|
type NewsSourceUrlConflictDefinition = z.infer<typeof NewsSourceUrlConflictSchemaDefinition>;
|
|
8
15
|
export interface NewsSourceUrlConflictSchemaInput extends z.input<typeof NewsSourceUrlConflictSchemaDefinition> {
|
|
@@ -1,5 +1,6 @@
|
|
|
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
|
+
import { DomainConflictTypeSchema } from "../domain/conflict-type.js";
|
|
3
4
|
const NewsSourceUrlConflictSchemaDefinition = z.object({
|
|
4
5
|
/** Existing article id (NewsId.value) that already owns this publication + URL pair. */
|
|
5
6
|
conflictingArticleId: z.int(),
|
|
@@ -7,6 +8,8 @@ const NewsSourceUrlConflictSchemaDefinition = z.object({
|
|
|
7
8
|
conflictingArticleSlug: z.string(),
|
|
8
9
|
/** Existing article title for human-readable diagnostics. */
|
|
9
10
|
conflictingArticleTitle: z.string(),
|
|
11
|
+
/** Conflict kind that identifies this details shape. */
|
|
12
|
+
conflictType: DomainConflictTypeSchema.optional(),
|
|
10
13
|
});
|
|
11
14
|
/**
|
|
12
15
|
* Typed extension on ProblemDetail.details for HTTP 409 when a news mutation's publication + newsUrlOriginal pair already belongs to another article. The returned fields identify the existing article so the caller can read/update it instead of creating a duplicate.
|
|
@@ -215,14 +215,6 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
215
215
|
modulePath: "cursor/slice-shared-search-list",
|
|
216
216
|
schemaName: "CursorSliceSharedSearchListSchema",
|
|
217
217
|
},
|
|
218
|
-
DatasourceDataSourceType: {
|
|
219
|
-
modulePath: "datasource/data-source-type",
|
|
220
|
-
schemaName: "DatasourceDataSourceTypeSchema",
|
|
221
|
-
},
|
|
222
|
-
DatasourceProvenanceActorType: {
|
|
223
|
-
modulePath: "datasource/provenance-actor-type",
|
|
224
|
-
schemaName: "DatasourceProvenanceActorTypeSchema",
|
|
225
|
-
},
|
|
226
218
|
DatasourceSourceMetadata: {
|
|
227
219
|
modulePath: "datasource/source-metadata",
|
|
228
220
|
schemaName: "DatasourceSourceMetadataSchema",
|
|
@@ -233,6 +225,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
233
225
|
modulePath: "domain/conflict-details",
|
|
234
226
|
schemaName: "DomainConflictDetailsSchema",
|
|
235
227
|
},
|
|
228
|
+
DomainConflictType: {
|
|
229
|
+
modulePath: "domain/conflict-type",
|
|
230
|
+
schemaName: "DomainConflictTypeSchema",
|
|
231
|
+
},
|
|
236
232
|
DuplicateCreateReview: {
|
|
237
233
|
modulePath: "duplicate/create-review",
|
|
238
234
|
schemaName: "DuplicateCreateReviewSchema",
|
|
@@ -982,7 +978,6 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
982
978
|
modulePath: "strict/url-lookup-conflict",
|
|
983
979
|
schemaName: "StrictUrlLookupConflictSchema",
|
|
984
980
|
},
|
|
985
|
-
SuppressionReason: { modulePath: "suppression/reason", schemaName: "SuppressionReasonSchema" },
|
|
986
981
|
SystemBuild: { modulePath: "system/system-build", schemaName: "SystemBuildSchema" },
|
|
987
982
|
SystemBuildDetail: {
|
|
988
983
|
modulePath: "system/system-build-detail",
|
|
@@ -10,7 +10,6 @@ export declare const PERSON_LOOKUP_BATCH_ENDPOINT: "/v1/people/lookup-batch";
|
|
|
10
10
|
* @contractRole canonical
|
|
11
11
|
*/
|
|
12
12
|
export declare const PersonLookupBatchParamSchema: z.ZodObject<{
|
|
13
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
14
13
|
page: z.ZodOptional<z.ZodInt>;
|
|
15
14
|
size: z.ZodOptional<z.ZodInt>;
|
|
16
15
|
}, z.core.$strip>;
|
|
@@ -11,8 +11,6 @@ export const PERSON_LOOKUP_BATCH_ENDPOINT = "/v1/people/lookup-batch";
|
|
|
11
11
|
* @contractRole canonical
|
|
12
12
|
*/
|
|
13
13
|
export const PersonLookupBatchParamSchema = z.object({
|
|
14
|
-
/** Includes private fields when the caller has private-visibility authority. Omit to use the caller's default visibility. */
|
|
15
|
-
includePrivate: z.boolean().optional(),
|
|
16
14
|
/** Zero-based page index (0..N); omit page and size for the full batch. */
|
|
17
15
|
page: z.int().optional(),
|
|
18
16
|
/** The size of the page to be returned; omit page and size for the full batch. */
|
|
@@ -12,7 +12,6 @@ export declare const PERSON_LOOKUP_EXACT_ENDPOINT: "/v1/people/lookup-exact";
|
|
|
12
12
|
export declare const PersonLookupExactParamSchema: z.ZodObject<{
|
|
13
13
|
includeAddress: z.ZodOptional<z.ZodBoolean>;
|
|
14
14
|
includeAssociation: z.ZodOptional<z.ZodBoolean>;
|
|
15
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
16
15
|
includeUrl: z.ZodOptional<z.ZodBoolean>;
|
|
17
16
|
location: z.ZodOptional<z.ZodString>;
|
|
18
17
|
maxAssociations: z.ZodOptional<z.ZodInt>;
|
|
@@ -15,8 +15,6 @@ export const PersonLookupExactParamSchema = z.object({
|
|
|
15
15
|
includeAddress: z.boolean().optional(),
|
|
16
16
|
/** Projection qualifier — include association values (default: true). Set false to omit association array. */
|
|
17
17
|
includeAssociation: z.boolean().optional(),
|
|
18
|
-
/** Includes hidden or off-sitemap people and private fields when the caller has private-visibility authority. */
|
|
19
|
-
includePrivate: z.boolean().optional(),
|
|
20
18
|
/** Projection qualifier — include URL link values in response (default: true). Set false to omit urlLink array. */
|
|
21
19
|
includeUrl: z.boolean().optional(),
|
|
22
20
|
/** Group C — candidate lookup signal: person location (city, state, country). Combine with other group-C signals for bounded search. Mutually exclusive with id and slug; may be combined with url for fallback. */
|
|
@@ -10,7 +10,7 @@ const PersonNaturalSearchResultSchemaDefinition = z.object({
|
|
|
10
10
|
investment: z.array(SearchInvestmentSchema),
|
|
11
11
|
/** Person page returned by the canonical person list engine. */
|
|
12
12
|
result: PageResultPersonSchema,
|
|
13
|
-
/** Id of this search's stored record
|
|
13
|
+
/** Id of this search's stored record. Null when the search was not recorded. */
|
|
14
14
|
searchRequestId: z.uuid().nullish(),
|
|
15
15
|
});
|
|
16
16
|
/**
|
|
@@ -16,7 +16,6 @@ export declare const PersonSearchParamSchema: z.ZodObject<{
|
|
|
16
16
|
countOnly: z.ZodOptional<z.ZodBoolean>;
|
|
17
17
|
cursor: z.ZodOptional<z.ZodString>;
|
|
18
18
|
hasImageFirst: z.ZodOptional<z.ZodBoolean>;
|
|
19
|
-
includePrivate: z.ZodOptional<z.ZodBoolean>;
|
|
20
19
|
permitMonogram: z.ZodOptional<z.ZodBoolean>;
|
|
21
20
|
}, z.core.$strip>;
|
|
22
21
|
export type PersonSearchParam = z.infer<typeof PersonSearchParamSchema>;
|