@aventurevc/api-schemas 0.8.33 → 0.8.35
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/enrichment/batch.js +1 -1
- package/dist/enrichment/prompt.d.ts +18 -0
- package/dist/enrichment/prompt.js +17 -0
- package/dist/entity/type.d.ts +1 -0
- package/dist/entity/type.js +1 -0
- package/dist/identification/candidate.js +2 -2
- package/dist/identification/identification.d.ts +1 -1
- package/dist/identification/identification.js +2 -2
- package/dist/identification/subject.d.ts +13 -1
- package/dist/identification/subject.js +6 -1
- package/dist/openapi-component-manifest.js +1 -0
- package/dist/system/status.d.ts +7 -1
- package/dist/system/status.js +13 -1
- package/package.json +1 -1
package/dist/enrichment/batch.js
CHANGED
|
@@ -13,7 +13,7 @@ const EnrichmentBatchSchemaDefinition = z.object({
|
|
|
13
13
|
/** Task preset keys that scope or emphasize every run; at least one is required when mode is INDIVIDUAL, and an unknown key is a 400 */
|
|
14
14
|
taskPresetKey: z.array(z.string()).nullish(),
|
|
15
15
|
/** Plain-language instruction for every run, such as which facts or sources to check first */
|
|
16
|
-
userPrompt: z.string().nullish(),
|
|
16
|
+
userPrompt: z.string().max(2000).nullish(),
|
|
17
17
|
});
|
|
18
18
|
/**
|
|
19
19
|
* Existing records to enrich in one call, with the run options every run shares
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
declare const EnrichmentPromptSchemaDefinition: z.ZodObject<{
|
|
3
|
+
userPrompt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
4
|
+
}, z.core.$strip>;
|
|
5
|
+
type EnrichmentPromptDefinition = z.infer<typeof EnrichmentPromptSchemaDefinition>;
|
|
6
|
+
/**
|
|
7
|
+
* Optional steering for one company or person enrichment run
|
|
8
|
+
*
|
|
9
|
+
* @openapiSchema EnrichmentPrompt
|
|
10
|
+
* @endpoint POST /v1/entities/{entityId}/enrichments
|
|
11
|
+
* @endpoint POST /v1/people/{personId}/enrichments
|
|
12
|
+
* @contractShape enrichment.prompt
|
|
13
|
+
* @contractRole canonical
|
|
14
|
+
*/
|
|
15
|
+
export declare const EnrichmentPromptSchema: z.ZodType<EnrichmentPromptDefinition>;
|
|
16
|
+
export type EnrichmentPrompt = z.infer<typeof EnrichmentPromptSchema>;
|
|
17
|
+
export {};
|
|
18
|
+
//# sourceMappingURL=prompt.d.ts.map
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
// LLM AGENTS MAY NOT EDIT THIS FILE UNDER ANY CIRCUMSTANCES. DO NOT EDIT - generated from Kotlin data classes via OpenAPI. Edit the backend owner and run: make docs-openapi && make docs-zod
|
|
2
|
+
import { z } from "zod/v4";
|
|
3
|
+
const EnrichmentPromptSchemaDefinition = z.object({
|
|
4
|
+
/** Plain-language instruction for this run, such as which facts or sources to check first */
|
|
5
|
+
userPrompt: z.string().max(2000).nullish(),
|
|
6
|
+
});
|
|
7
|
+
/**
|
|
8
|
+
* Optional steering for one company or person enrichment run
|
|
9
|
+
*
|
|
10
|
+
* @openapiSchema EnrichmentPrompt
|
|
11
|
+
* @endpoint POST /v1/entities/{entityId}/enrichments
|
|
12
|
+
* @endpoint POST /v1/people/{personId}/enrichments
|
|
13
|
+
* @contractShape enrichment.prompt
|
|
14
|
+
* @contractRole canonical
|
|
15
|
+
*/
|
|
16
|
+
export const EnrichmentPromptSchema = EnrichmentPromptSchemaDefinition;
|
|
17
|
+
//# sourceMappingURL=prompt.js.map
|
package/dist/entity/type.d.ts
CHANGED
|
@@ -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
|
package/dist/entity/type.js
CHANGED
|
@@ -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
|
|
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
|
-
/**
|
|
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
|
|
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
|
|
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
|
-
/**
|
|
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. Invalid for a person lookup. */
|
|
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
|
|
@@ -198,6 +198,7 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
198
198
|
Enrichment: { modulePath: "enrichment/enrichment", schemaName: "EnrichmentSchema" },
|
|
199
199
|
EnrichmentBatch: { modulePath: "enrichment/batch", schemaName: "EnrichmentBatchSchema" },
|
|
200
200
|
EnrichmentMode: { modulePath: "enrichment/mode", schemaName: "EnrichmentModeSchema" },
|
|
201
|
+
EnrichmentPrompt: { modulePath: "enrichment/prompt", schemaName: "EnrichmentPromptSchema" },
|
|
201
202
|
EnrichmentRefusalType: {
|
|
202
203
|
modulePath: "enrichment/refusal-type",
|
|
203
204
|
schemaName: "EnrichmentRefusalTypeSchema",
|
package/dist/system/status.d.ts
CHANGED
|
@@ -1,7 +1,13 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const SystemStatusSchemaDefinition: z.ZodObject<{
|
|
3
|
+
latestIosBuild: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
4
|
+
latestIosVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
5
|
+
latestMacosBuild: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
6
|
+
latestMacosVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
3
7
|
minimumIosBuild: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
4
8
|
minimumIosVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
9
|
+
minimumMacosBuild: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
10
|
+
minimumMacosVersion: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
5
11
|
operationFingerprint: z.ZodString;
|
|
6
12
|
uptime: z.ZodType<{
|
|
7
13
|
availability?: number | null | undefined;
|
|
@@ -17,7 +23,7 @@ declare const SystemStatusSchemaDefinition: z.ZodObject<{
|
|
|
17
23
|
}, z.core.$strip>;
|
|
18
24
|
type SystemStatusDefinition = z.infer<typeof SystemStatusSchemaDefinition>;
|
|
19
25
|
/**
|
|
20
|
-
* Uptime SLA, served-operation identity, and
|
|
26
|
+
* Uptime SLA, served-operation identity, and Apple app update policy
|
|
21
27
|
*
|
|
22
28
|
* @openapiSchema SystemStatus
|
|
23
29
|
* @endpoint GET /v1/status
|
package/dist/system/status.js
CHANGED
|
@@ -2,17 +2,29 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { UptimeSchema } from "../uptime/uptime.js";
|
|
4
4
|
const SystemStatusSchemaDefinition = z.object({
|
|
5
|
+
/** Latest available App Store iOS build number within that version */
|
|
6
|
+
latestIosBuild: z.int().nullish(),
|
|
7
|
+
/** Latest available App Store iOS marketing version; empty disables the optional update prompt */
|
|
8
|
+
latestIosVersion: z.string().nullish(),
|
|
9
|
+
/** Latest available App Store macOS build number within that version */
|
|
10
|
+
latestMacosBuild: z.int().nullish(),
|
|
11
|
+
/** Latest available App Store macOS marketing version; empty disables the optional update prompt */
|
|
12
|
+
latestMacosVersion: z.string().nullish(),
|
|
5
13
|
/** Minimum supported App Store iOS build number within the minimum version */
|
|
6
14
|
minimumIosBuild: z.int().nullish(),
|
|
7
15
|
/** Minimum supported App Store iOS marketing version; empty disables update enforcement */
|
|
8
16
|
minimumIosVersion: z.string().nullish(),
|
|
17
|
+
/** Minimum supported App Store macOS build number within that version */
|
|
18
|
+
minimumMacosBuild: z.int().nullish(),
|
|
19
|
+
/** Minimum supported App Store macOS marketing version; empty disables update enforcement */
|
|
20
|
+
minimumMacosVersion: z.string().nullish(),
|
|
9
21
|
/** Short hash identifying the exact set of operations this deployment serves. A generated client stamps the same value from the OpenAPI document it was built from; an unequal value means the client catalog is stale. `vc.aventure.application.usecase.system.status.OperationInventory` owns how it is computed. */
|
|
10
22
|
operationFingerprint: z.string(),
|
|
11
23
|
/** Uptime SLA data from external uptime monitoring */
|
|
12
24
|
uptime: UptimeSchema,
|
|
13
25
|
});
|
|
14
26
|
/**
|
|
15
|
-
* Uptime SLA, served-operation identity, and
|
|
27
|
+
* Uptime SLA, served-operation identity, and Apple app update policy
|
|
16
28
|
*
|
|
17
29
|
* @openapiSchema SystemStatus
|
|
18
30
|
* @endpoint GET /v1/status
|