@aventurevc/api-schemas 0.8.32 → 0.8.34

package/dist/entity/type.d.ts

@@ -9,6 +9,7 @@ import { z } from "zod/v4";
  * @usedBySchema EntityPersonAssociationSchema
  * @usedBySchema EntitySchema
  * @usedBySchema EntityTypeGroupMembershipSchema
+ * @usedBySchema IdentificationSubjectSchema
  * @usedBySchema NewsResolvedEntityLinkSchema
  * @usedBySchema PersonListArrayFilterSchema
  * @usedBySchema SearchDuplicateCandidateScoreSchema

package/dist/entity/type.js

@@ -10,6 +10,7 @@ import { z } from "zod/v4";
  * @usedBySchema EntityPersonAssociationSchema
  * @usedBySchema EntitySchema
  * @usedBySchema EntityTypeGroupMembershipSchema
+ * @usedBySchema IdentificationSubjectSchema
  * @usedBySchema NewsResolvedEntityLinkSchema
  * @usedBySchema PersonListArrayFilterSchema
  * @usedBySchema SearchDuplicateCandidateScoreSchema

package/dist/identification/candidate.js

@@ -17,13 +17,13 @@ import { SearchDuplicateCandidateScoreSchema } from "../search/duplicate-candida
  * @contractRole canonical
  */
 export const IdentificationCandidateSchema = z.object({
-    /** Percentage, 0 to 100, of the company's required completion-floor slots that pass, as last computed by the background coverage sweep; GET /v1/entities/{entityId}/coverage returns the live per-slot detail. Absent for people, who have no completion floor, and for companies not yet computed. */
+    /** Percentage, 0 to 100, of the entity's required completion-floor slots that pass, as last computed by the background coverage sweep; GET /v1/entities/{entityId}/coverage returns the live per-slot detail. Absent for people, who have no completion floor, and for entities not yet computed. */
     dataCompletionCoverage: z.int().min(0).max(100).nullish(),
     /** How this record was checked as the picked record stored again; absent when it was not checked. */
     duplicateBasis: z.enum(["STUB", "SHARED_FACT", "JUDGED"]).nullish(),
     /** Decision-model probability, 0 to 1, that this record is the picked record stored again; present only when duplicateBasis is JUDGED. */
     duplicateProbability: z.number().nullish(),
-    /** Whether the record is a company (entityId) or a person (personId); read it with GET /v1/entities/{entityId} or GET /v1/people/{personId}. */
+    /** 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}. */
     owner: EntityPersonOwnerSchema,
     /** Decision-model probability, 0 to 1, that this record is the subject; absent when the answer came from URL proof or the model did not judge this record. */
     probability: z.number().nullish(),

package/dist/identification/identification.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Which existing company or person record a subject is, how that was settled, and the candidates considered, most probable first.
+ * Which existing entity or person satisfies the requested identity, type, and provider scope, how that was settled, and the candidates considered, most probable first.
  *
  * @openapiSchema Identification
  * @endpoint GET /v1/lookup

package/dist/identification/identification.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 import { IdentificationCandidateSchema } from "./candidate.js";
 /**
- * Which existing company or person record a subject is, how that was settled, and the candidates considered, most probable first.
+ * Which existing entity or person satisfies the requested identity, type, and provider scope, how that was settled, and the candidates considered, most probable first.
  *
  * @openapiSchema Identification
  * @endpoint GET /v1/lookup
@@ -32,7 +32,7 @@ export const IdentificationSchema = z.object({
     officialUrl: z.string().nullish(),
     /** The ladder step that settled the answer. */
     stage: z.enum(["DETERMINISTIC", "JUDGMENT", "WEB_EVIDENCE"]),
-    /** What the caller does next: act on match, create, or ask the user. */
+    /** Use the scoped match, record scoped absence, or refine an ambiguous identity with evidence. */
     status: z.enum(["MATCHED", "NO_MATCH", "NEEDS_REVIEW"]),
 });
 //# sourceMappingURL=identification.js.map

package/dist/identification/subject.d.ts

@@ -3,13 +3,25 @@ declare const IdentificationSubjectSchemaDefinition: z.ZodObject<{
     context: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     name: z.ZodString;
+    providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
     sourceNewsId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    typeRecord: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        "Business Line": "Business Line";
+        Company: "Company";
+        Fund: "Fund";
+        Government: "Government";
+        "Investment Firm": "Investment Firm";
+        Nonprofit: "Nonprofit";
+        Organization: "Organization";
+        Product: "Product";
+        Service: "Service";
+    }>>>;
     url: z.ZodOptional<z.ZodArray<z.ZodString>>;
 }, z.core.$strip>;
 type IdentificationSubjectDefinition = z.infer<typeof IdentificationSubjectSchemaDefinition>;
 /**
- * The company or person to identify. Send the name plus every URL, location, and source you have; a website or profile URL usually settles the answer without any model call.
+ * The company, Product, Service, or person to identify. Send the name plus every URL, location, and source you have; a website or profile URL usually settles the answer without any model call.
  *
  * @openapiSchema IdentificationSubject
  * @endpoint POST /v1/entities/lookup

package/dist/identification/subject.js

@@ -1,5 +1,6 @@
 // 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
 import { z } from "zod/v4";
+import { EntityTypeSchema } from "../entity/type.js";
 const IdentificationSubjectSchemaDefinition = z.object({
     /** Specific facts in plain words: product, industry, employer and title, or founder names. Generic words like startup add nothing. */
     context: z.string().max(2000).nullish(),
@@ -7,15 +8,19 @@ const IdentificationSubjectSchemaDefinition = z.object({
     location: z.string().max(2000).nullish(),
     /** Name exactly as the source writes it, such as Acme AI or Jane Doe. Required even when url is sent; to read a record from only a URL (an aVenture page, website, or domain) use the exact read instead: entities lookup-exact get --url, or people lookup-exact get --url for a person. */
     name: z.string().max(200),
+    /** 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. */
+    providerId: z.uuid().nullish(),
     /** aVenture news id of the article that mentions the subject; an unknown id is a 400. */
     sourceNewsId: z.int().nullish(),
     /** URL of the article that mentions the subject; read from aVenture news when stored there, otherwise fetched. */
     sourceUrl: z.string().max(2000).nullish(),
+    /** Entity type to identify. A Product or Service never matches its provider organization, but a record stored under a neighboring type of the same family (Product or Service; Fund, Investment Firm, or Company) still matches, and a Business Line lookup sees both families. */
+    typeRecord: EntityTypeSchema.nullish(),
     /** URLs the subject owns: its website, its LinkedIn company or person profile, or a registry page. At most 10. Put articles in sourceUrl. */
     url: z.array(z.string()).max(10).optional(),
 });
 /**
- * The company or person to identify. Send the name plus every URL, location, and source you have; a website or profile URL usually settles the answer without any model call.
+ * The company, Product, Service, or person to identify. Send the name plus every URL, location, and source you have; a website or profile URL usually settles the answer without any model call.
  *
  * @openapiSchema IdentificationSubject
  * @endpoint POST /v1/entities/lookup

package/dist/lookup/job-mention.d.ts

@@ -1169,7 +1169,7 @@ declare const LookupJobMentionSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type LookupJobMentionDefinition = z.infer<typeof LookupJobMentionSchemaDefinition>;
 /**
- * One company or person a source names, which stored record it is, and, from a lookup job or a streaming lookup, the hidden shell record filed for it when it is new.
+ * One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the hidden shell record filed when it is new. Bulk lookup only identifies names and files no shells.
  *
  * @openapiSchema LookupJobMention
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job-mention.js

@@ -19,13 +19,13 @@ const LookupJobMentionSchemaDefinition = z.object({
     name: z.string(),
     /** POST /v1/lookup-mentions only: the candidate people as search results show them, ranked like entity. */
     person: z.array(PersonSchema),
-    /** The hidden record filed for a NO_MATCH name whose own site web search found and whose live page names it, or the stored hidden record that already holds that site. A background enrichment run graduates or merges it (enrichmentRunId). Absent when no record was filed. */
+    /** The hidden record filed for a NO_MATCH name when web search finds its own site and the live page names it, or the stored hidden record already holding that site. An article job also requires its article as an independent source. A background enrichment run graduates or merges it (enrichmentRunId). Absent for bulk lookups. */
     shell: EntityPersonOwnerSchema.nullish(),
     /** One sentence on why no shell was filed for a NO_MATCH name; absent otherwise. */
     shellDetail: z.string().nullish(),
 });
 /**
- * One company or person a source names, which stored record it is, and, from a lookup job or a streaming lookup, the hidden shell record filed for it when it is new.
+ * One company or person a source names, which stored record it is, and, from a standard article job or streaming lookup, the hidden shell record filed when it is new. Bulk lookup only identifies names and files no shells.
  *
  * @openapiSchema LookupJobMention
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job-mutation.d.ts

@@ -14,7 +14,7 @@ declare const LookupJobMutationSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type LookupJobMutationDefinition = z.infer<typeof LookupJobMutationSchemaDefinition>;
 /**
- * The article whose companies and people a lookup job identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup-mentions also takes mention instead.
+ * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; lookup-only bulk jobs and POST /v1/lookup-mentions also accept mention instead.
  *
  * @openapiSchema LookupJobMutation
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job-mutation.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 import { LookupMentionSchema } from "./mention.js";
 const LookupJobMutationSchemaDefinition = z.object({
-    /** POST /v1/lookup-mentions only: the companies and people a caller already read from a page or screenshot it keeps on its device, identified without either being sent. Send it alone, without sourceUrl, sourceNewsId, or a file. Any signed-in user may send it, with or without a plan. */
+    /** 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 shell records or enrichment are scheduled. */
     mention: z.array(LookupMentionSchema).optional(),
     /** aVenture news id of the article; an id that names no stored article is an error. */
     sourceNewsId: z.int().nullish(),
@@ -10,7 +10,7 @@ const LookupJobMutationSchemaDefinition = z.object({
     sourceUrl: z.string().max(2000).nullish(),
 });
 /**
- * The article whose companies and people a lookup job identifies. Send sourceUrl, sourceNewsId, or both; POST /v1/lookup-mentions also takes mention instead.
+ * The article whose companies and people a lookup identifies. Send sourceUrl, sourceNewsId, or both; lookup-only bulk jobs and POST /v1/lookup-mentions also accept mention instead.
  *
  * @openapiSchema LookupJobMutation
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job.d.ts

@@ -3,6 +3,8 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
     createdAt: z.ZodISODateTime;
     failureReason: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     jobId: z.ZodUUID;
+    limitReached: z.ZodBoolean;
+    maxNames: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
     mention: z.ZodArray<z.ZodType<{
         enrichmentRunId?: string | null | undefined;
         entity: {
@@ -1204,6 +1206,8 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
         } | null | undefined;
         shellDetail?: string | null | undefined;
     }, unknown>>>;
+    namesFound: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
+    namesProcessed: z.ZodInt;
     source: z.ZodType<{
         mention?: {
             name: string;
@@ -1233,7 +1237,7 @@ declare const LookupJobSchemaDefinition: z.ZodObject<{
 }, z.core.$strip>;
 type LookupJobDefinition = z.infer<typeof LookupJobSchemaDefinition>;
 /**
- * An async lookup job's state and, once COMPLETED, every company and person the article names, each identified against stored records.
+ * An async lookup job's state and, once COMPLETED, identified companies and people from its article or supplied names.
  *
  * @openapiSchema LookupJob
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/dist/lookup/job.js

@@ -10,9 +10,17 @@ const LookupJobSchemaDefinition = z.object({
     failureReason: z.string().nullish(),
     /** Lookup job id. */
     jobId: z.uuid(),
-    /** Each distinct company and person the article names; empty until COMPLETED. */
+    /** True when a bulk lookup returned its name bound; more names may remain. False does not prove that extraction found every name on a page. */
+    limitReached: z.boolean(),
+    /** Bulk lookup name bound; absent for legacy article jobs. */
+    maxNames: z.int().nullish(),
+    /** Each identified company and person; bulk results are available while running. */
     mention: z.array(LookupJobMentionSchema),
-    /** The article the job reads. */
+    /** Distinct names found for a bulk lookup; absent on standard jobs. */
+    namesFound: z.int().nullish(),
+    /** Names processed so far, including per-name failures. */
+    namesProcessed: z.int(),
+    /** The article the job reads or names supplied for a bulk lookup. */
     source: LookupJobMutationSchema,
     /** Current job state. */
     state: JobStateSchema,
@@ -20,7 +28,7 @@ const LookupJobSchemaDefinition = z.object({
     updatedAt: z.iso.datetime({ offset: true }),
 });
 /**
- * An async lookup job's state and, once COMPLETED, every company and person the article names, each identified against stored records.
+ * An async lookup job's state and, once COMPLETED, identified companies and people from its article or supplied names.
  *
  * @openapiSchema LookupJob
  * @endpoint GET /v1/lookup-jobs/{jobId}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aventurevc/api-schemas",
-  "version": "0.8.32",
+  "version": "0.8.34",
   "private": false,
   "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
   "license": "Apache-2.0",