@aventurevc/api-schemas 0.8.33 → 0.8.34

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.
@@ -9,6 +9,7 @@ import { z } from "zod/v4";
9
9
  * @usedBySchema EntityPersonAssociationSchema
10
10
  * @usedBySchema EntitySchema
11
11
  * @usedBySchema EntityTypeGroupMembershipSchema
12
+ * @usedBySchema IdentificationSubjectSchema
12
13
  * @usedBySchema NewsResolvedEntityLinkSchema
13
14
  * @usedBySchema PersonListArrayFilterSchema
14
15
  * @usedBySchema SearchDuplicateCandidateScoreSchema
@@ -10,6 +10,7 @@ import { z } from "zod/v4";
10
10
  * @usedBySchema EntityPersonAssociationSchema
11
11
  * @usedBySchema EntitySchema
12
12
  * @usedBySchema EntityTypeGroupMembershipSchema
13
+ * @usedBySchema IdentificationSubjectSchema
13
14
  * @usedBySchema NewsResolvedEntityLinkSchema
14
15
  * @usedBySchema PersonListArrayFilterSchema
15
16
  * @usedBySchema SearchDuplicateCandidateScoreSchema
@@ -17,13 +17,13 @@ import { SearchDuplicateCandidateScoreSchema } from "../search/duplicate-candida
17
17
  * @contractRole canonical
18
18
  */
19
19
  export const IdentificationCandidateSchema = z.object({
20
- /** 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. */
20
+ /** 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. */
21
21
  dataCompletionCoverage: z.int().min(0).max(100).nullish(),
22
22
  /** How this record was checked as the picked record stored again; absent when it was not checked. */
23
23
  duplicateBasis: z.enum(["STUB", "SHARED_FACT", "JUDGED"]).nullish(),
24
24
  /** Decision-model probability, 0 to 1, that this record is the picked record stored again; present only when duplicateBasis is JUDGED. */
25
25
  duplicateProbability: z.number().nullish(),
26
- /** Whether the record is a company (entityId) or a person (personId); read it with GET /v1/entities/{entityId} or GET /v1/people/{personId}. */
26
+ /** 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}. */
27
27
  owner: EntityPersonOwnerSchema,
28
28
  /** 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. */
29
29
  probability: z.number().nullish(),
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * Which existing company or person record a subject is, how that was settled, and the candidates considered, most probable first.
3
+ * Which existing entity or person satisfies the requested identity, type, and provider scope, how that was settled, and the candidates considered, most probable first.
4
4
  *
5
5
  * @openapiSchema Identification
6
6
  * @endpoint GET /v1/lookup
@@ -2,7 +2,7 @@
2
2
  import { z } from "zod/v4";
3
3
  import { IdentificationCandidateSchema } from "./candidate.js";
4
4
  /**
5
- * Which existing company or person record a subject is, how that was settled, and the candidates considered, most probable first.
5
+ * Which existing entity or person satisfies the requested identity, type, and provider scope, how that was settled, and the candidates considered, most probable first.
6
6
  *
7
7
  * @openapiSchema Identification
8
8
  * @endpoint GET /v1/lookup
@@ -32,7 +32,7 @@ export const IdentificationSchema = z.object({
32
32
  officialUrl: z.string().nullish(),
33
33
  /** The ladder step that settled the answer. */
34
34
  stage: z.enum(["DETERMINISTIC", "JUDGMENT", "WEB_EVIDENCE"]),
35
- /** What the caller does next: act on match, create, or ask the user. */
35
+ /** Use the scoped match, record scoped absence, or refine an ambiguous identity with evidence. */
36
36
  status: z.enum(["MATCHED", "NO_MATCH", "NEEDS_REVIEW"]),
37
37
  });
38
38
  //# sourceMappingURL=identification.js.map
@@ -3,13 +3,25 @@ declare const IdentificationSubjectSchemaDefinition: z.ZodObject<{
3
3
  context: z.ZodOptional<z.ZodNullable<z.ZodString>>;
4
4
  location: z.ZodOptional<z.ZodNullable<z.ZodString>>;
5
5
  name: z.ZodString;
6
+ providerId: z.ZodOptional<z.ZodNullable<z.ZodUUID>>;
6
7
  sourceNewsId: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
7
8
  sourceUrl: z.ZodOptional<z.ZodNullable<z.ZodString>>;
9
+ typeRecord: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
10
+ "Business Line": "Business Line";
11
+ Company: "Company";
12
+ Fund: "Fund";
13
+ Government: "Government";
14
+ "Investment Firm": "Investment Firm";
15
+ Nonprofit: "Nonprofit";
16
+ Organization: "Organization";
17
+ Product: "Product";
18
+ Service: "Service";
19
+ }>>>;
8
20
  url: z.ZodOptional<z.ZodArray<z.ZodString>>;
9
21
  }, z.core.$strip>;
10
22
  type IdentificationSubjectDefinition = z.infer<typeof IdentificationSubjectSchemaDefinition>;
11
23
  /**
12
- * 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.
24
+ * 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.
13
25
  *
14
26
  * @openapiSchema IdentificationSubject
15
27
  * @endpoint POST /v1/entities/lookup
@@ -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 { EntityTypeSchema } from "../entity/type.js";
3
4
  const IdentificationSubjectSchemaDefinition = z.object({
4
5
  /** Specific facts in plain words: product, industry, employer and title, or founder names. Generic words like startup add nothing. */
5
6
  context: z.string().max(2000).nullish(),
@@ -7,15 +8,19 @@ const IdentificationSubjectSchemaDefinition = z.object({
7
8
  location: z.string().max(2000).nullish(),
8
9
  /** 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. */
9
10
  name: z.string().max(200),
11
+ /** 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. */
12
+ providerId: z.uuid().nullish(),
10
13
  /** aVenture news id of the article that mentions the subject; an unknown id is a 400. */
11
14
  sourceNewsId: z.int().nullish(),
12
15
  /** URL of the article that mentions the subject; read from aVenture news when stored there, otherwise fetched. */
13
16
  sourceUrl: z.string().max(2000).nullish(),
17
+ /** 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. */
18
+ typeRecord: EntityTypeSchema.nullish(),
14
19
  /** URLs the subject owns: its website, its LinkedIn company or person profile, or a registry page. At most 10. Put articles in sourceUrl. */
15
20
  url: z.array(z.string()).max(10).optional(),
16
21
  });
17
22
  /**
18
- * 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.
23
+ * 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.
19
24
  *
20
25
  * @openapiSchema IdentificationSubject
21
26
  * @endpoint POST /v1/entities/lookup
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.33",
3
+ "version": "0.8.34",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",