@aventurevc/api-schemas 0.8.62 → 0.8.63

package/dist/search/evidence-source.js

@@ -0,0 +1,21 @@
+// 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";
+/**
+ * Owner of search evidence: `entityRecord` is the entity's structured record, `researchSnippet` an entity research snippet, `newsArticle` a news article linked to the entity.
+ *
+ * @openapiSchema SearchEvidenceSource
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchAnswerCitationSchema
+ * @usedBySchema SearchPassageSchema
+ * @contractShape search.evidence-source
+ * @contractRole canonical
+ */
+export const SearchEvidenceSourceSchema = z.enum([
+    "entityRecord",
+    "researchSnippet",
+    "newsArticle",
+]);
+//# sourceMappingURL=evidence-source.js.map

package/dist/search/intent.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod/v4";
+/**
+ * Question shape the planner read from a natural-language search. `discovery` lists entities matching a description; `profile` asks what a named entity does, offers, or how it stands; `peer` asks for a named entity's competitors or look-alikes; `comparison` asks how two or more named entities compare.
+ *
+ * @openapiSchema SearchIntent
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchInterpretationSchema
+ * @contractShape search.intent
+ * @contractRole canonical
+ */
+export declare const SearchIntentSchema: z.ZodEnum<{
+    comparison: "comparison";
+    discovery: "discovery";
+    peer: "peer";
+    profile: "profile";
+}>;
+export type SearchIntent = z.infer<typeof SearchIntentSchema>;
+//# sourceMappingURL=intent.d.ts.map

package/dist/search/intent.js

@@ -0,0 +1,16 @@
+// 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";
+/**
+ * Question shape the planner read from a natural-language search. `discovery` lists entities matching a description; `profile` asks what a named entity does, offers, or how it stands; `peer` asks for a named entity's competitors or look-alikes; `comparison` asks how two or more named entities compare.
+ *
+ * @openapiSchema SearchIntent
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchInterpretationSchema
+ * @contractShape search.intent
+ * @contractRole canonical
+ */
+export const SearchIntentSchema = z.enum(["discovery", "profile", "peer", "comparison"]);
+//# sourceMappingURL=intent.js.map

package/dist/search/interpretation.d.ts

@@ -210,6 +210,12 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
             min?: number | null | undefined;
         }[] | undefined;
     }, unknown>>;
+    intent: z.ZodEnum<{
+        comparison: "comparison";
+        discovery: "discovery";
+        peer: "peer";
+        profile: "profile";
+    }>;
     interpretation: z.ZodString;
     sort: z.ZodType<{
         order: {
@@ -224,6 +230,7 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
         }[];
         relevance?: "keyword" | "semantic" | null | undefined;
     }, unknown>>;
+    subjectEntityName: z.ZodArray<z.ZodString>;
     unsupported: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 type SearchInterpretationDefinition = z.infer<typeof SearchInterpretationSchemaDefinition>;

package/dist/search/interpretation.js

@@ -2,6 +2,7 @@
 import { z } from "zod/v4";
 import { ConfidenceSchema } from "../confidence/confidence.js";
 import { EntityListFilterSchema } from "../entity/list-filter.js";
+import { SearchIntentSchema } from "./intent.js";
 import { SearchModeExecutionSchema } from "./mode-execution.js";
 import { SearchOrderingEntityFilterSortableSchema } from "./ordering-entity-filter-sortable.js";
 const SearchInterpretationSchemaDefinition = z.object({
@@ -13,10 +14,14 @@ const SearchInterpretationSchemaDefinition = z.object({
     fallbackUsed: z.boolean(),
     /** Canonical entity filter generated from the natural-language query. */
     filter: EntityListFilterSchema,
+    /** Question shape the planner read from the query. */
+    intent: SearchIntentSchema,
     /** Human-readable summary of how the query was interpreted. */
     interpretation: z.string(),
     /** Ordering applied to the result page: the relevance rank that ran first, if any, then the sortable-column terms. */
     sort: SearchOrderingEntityFilterSortableSchema,
+    /** Brand or legal names of the entities the question is about, as written in the query; empty for discovery questions. */
+    subjectEntityName: z.array(z.string()),
     /** Constraint the planner could not translate into the canonical EntityFilter contract; null when every material constraint was supported. */
     unsupported: z.string().nullish(),
 });

package/dist/search/layer.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod/v4";
+/**
+ * Optional answer layer for a natural-language entity search. `passage` adds the text passages, from public research snippets and linked news, that best answer the question about the subject entities, their peers, or the top results; `synthesis` adds a written answer grounded only in those records and passages, citing each, and implies `passage`.
+ *
+ * @openapiSchema SearchLayer
+ * @endpoint POST /v1/search/natural/entities
+ * @contractShape search.layer
+ * @contractRole canonical
+ */
+export declare const SearchLayerSchema: z.ZodEnum<{
+    passage: "passage";
+    synthesis: "synthesis";
+}>;
+export type SearchLayer = z.infer<typeof SearchLayerSchema>;
+//# sourceMappingURL=layer.d.ts.map

package/dist/search/layer.js

@@ -0,0 +1,12 @@
+// 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";
+/**
+ * Optional answer layer for a natural-language entity search. `passage` adds the text passages, from public research snippets and linked news, that best answer the question about the subject entities, their peers, or the top results; `synthesis` adds a written answer grounded only in those records and passages, citing each, and implies `passage`.
+ *
+ * @openapiSchema SearchLayer
+ * @endpoint POST /v1/search/natural/entities
+ * @contractShape search.layer
+ * @contractRole canonical
+ */
+export const SearchLayerSchema = z.enum(["passage", "synthesis"]);
+//# sourceMappingURL=layer.js.map

package/dist/search/mode.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts `auto` and `keyword`, where `keyword` ranks the full text of articles, posts, and fetched pages.
+ * Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword` (the full text of articles, posts, and fetched pages), and `semantic` (one entity's or person's library pages by vector similarity of their fetched bodies).
  *
  * @openapiSchema SearchMode
  * @endpoint GET /v1/search/link

package/dist/search/mode.js

@@ -1,7 +1,7 @@
 // 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";
 /**
- * Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts `auto` and `keyword`, where `keyword` ranks the full text of articles, posts, and fetched pages.
+ * Search strategy for a natural-language search request. `auto` keeps the server pipeline (exact-name shortcut first, planner otherwise); `exact` matches entity or person names exactly with no planner and no embedding; `keyword` runs full-text search; `semantic` runs vector similarity; `natural` always runs the language-model planner. Entity and person natural-search support every mode; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword` (the full text of articles, posts, and fetched pages), and `semantic` (one entity's or person's library pages by vector similarity of their fetched bodies).
  *
  * @openapiSchema SearchMode
  * @endpoint GET /v1/search/link

package/dist/search/passage.d.ts

@@ -0,0 +1,32 @@
+import { z } from "zod/v4";
+declare const SearchPassageSchemaDefinition: z.ZodObject<{
+    entityId: z.ZodUUID;
+    label: z.ZodString;
+    publishedAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
+    score: z.ZodNumber;
+    source: z.ZodEnum<{
+        entityRecord: "entityRecord";
+        newsArticle: "newsArticle";
+        researchSnippet: "researchSnippet";
+    }>;
+    sourceId: z.ZodString;
+    text: z.ZodString;
+    url: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+type SearchPassageDefinition = z.infer<typeof SearchPassageSchemaDefinition>;
+/**
+ * Text passage ranked by semantic closeness to a natural-language question, read from its owning record.
+ *
+ * @openapiSchema SearchPassage
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema NaturalSearchResultSchema
+ * @contractShape search.passage
+ * @contractRole canonical
+ */
+export declare const SearchPassageSchema: z.ZodType<SearchPassageDefinition>;
+export type SearchPassage = z.infer<typeof SearchPassageSchema>;
+export {};
+//# sourceMappingURL=passage.d.ts.map

package/dist/search/passage.js

@@ -0,0 +1,35 @@
+// 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 { SearchEvidenceSourceSchema } from "./evidence-source.js";
+const SearchPassageSchemaDefinition = z.object({
+    /** Entity the passage is about. */
+    entityId: z.uuid(),
+    /** Snippet type key for research snippets, or the article title for news articles. */
+    label: z.string(),
+    /** Article publication time for news passages; null for snippets. */
+    publishedAt: z.iso.datetime({ offset: true }).nullish(),
+    /** Cosine similarity between the question and the passage; higher is closer. Compare scores only within one response. */
+    score: z.number(),
+    /** Record type that owns the passage text. */
+    source: SearchEvidenceSourceSchema,
+    /** Identifier of the owning snippet or news article. */
+    sourceId: z.string(),
+    /** Passage text: the snippet, or the article summary or excerpt. */
+    text: z.string(),
+    /** Original article URL for news passages; null for snippets. */
+    url: z.string().nullish(),
+});
+/**
+ * Text passage ranked by semantic closeness to a natural-language question, read from its owning record.
+ *
+ * @openapiSchema SearchPassage
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema NaturalSearchResultSchema
+ * @contractShape search.passage
+ * @contractRole canonical
+ */
+export const SearchPassageSchema = SearchPassageSchemaDefinition;
+//# sourceMappingURL=passage.js.map

package/package.json

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