@aventurevc/api-schemas 0.8.68 → 0.8.70

package/dist/agent/help-question.js

@@ -6,7 +6,7 @@ const AgentHelpQuestionSchemaDefinition = z.object({
     model: z.string().nullish(),
     /** The question to answer, in natural language. */
     question: z.string().max(2000),
-    /** True resolves the question to one runnable operation instead of answering it: the response carries a resolution (operation advice, clarify, or abstain) and no generated answer. Resolving calls no chat model, ignores model, and draws on its own per-caller limit instead of the answer quota. */
+    /** True selects a catalog task or recommends an operation instead of composing an answer. Outcomes are TASK_PLAN, OPERATION_ADVICE, CLARIFY, or ABSTAIN. Resolve uses retrieval and a model decision, ignores model, and draws on its own per-caller limit instead of the answer quota. */
     resolve: z.boolean().optional(),
     /** Optional scope restricting which operations the answer may recommend; null means all. */
     scope: HelpScopeSchema.nullish(),

package/dist/agent/help.js

@@ -10,7 +10,7 @@ const AgentHelpSchemaDefinition = z.object({
     citation: z.array(HelpCitationSchema),
     /** Confidence the answer is fully supported by the cited corpus. LOW signals an abstention. */
     confidence: ConfidenceSchema,
-    /** The resolved operation when the question asked to resolve; absent for a generated answer. */
+    /** The task or operation resolution when the question asked to resolve; absent for a generated answer. */
     resolution: HelpResolutionSchema.nullish(),
 });
 /**

package/dist/federated/search.d.ts

@@ -8,6 +8,16 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
                 sourceId: string;
             }[];
             confidence: "HIGH" | "LOW" | "MEDIUM";
+            paragraph: {
+                citation: {
+                    entityId: string;
+                    source: "entityRecord" | "newsArticle" | "researchSnippet";
+                    sourceId: string;
+                }[];
+                text: string;
+                topic?: string | null | undefined;
+            }[];
+            relatedQuery: string[];
             text: string;
         } | null | undefined;
         interpretation: {
@@ -2071,6 +2081,16 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
                 sourceId: string;
             }[];
             confidence: "HIGH" | "LOW" | "MEDIUM";
+            paragraph: {
+                citation: {
+                    entityId: string;
+                    source: "entityRecord" | "newsArticle" | "researchSnippet";
+                    sourceId: string;
+                }[];
+                text: string;
+                topic?: string | null | undefined;
+            }[];
+            relatedQuery: string[];
             text: string;
         } | null | undefined;
         interpretation: {

package/dist/help/resolution.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Resolution of a request to one operation: advice naming it, a clarification between candidates, or an abstention.
+ * Resolution of a request to a catalog task or an operation, clarification between candidates, or an abstention.
  *
  * @openapiSchema HelpResolution
  * @endpoint POST /v1/agents/help

package/dist/help/resolution.js

@@ -3,7 +3,7 @@ import { z } from "zod/v4";
 import { HelpCitationSchema } from "./citation.js";
 import { HelpResolutionOutcomeSchema } from "./resolution-outcome.js";
 /**
- * Resolution of a request to one operation: advice naming it, a clarification between candidates, or an abstention.
+ * Resolution of a request to a catalog task or an operation, clarification between candidates, or an abstention.
  *
  * @openapiSchema HelpResolution
  * @endpoint POST /v1/agents/help
@@ -19,9 +19,9 @@ export const HelpResolutionSchema = z.object({
     operationId: z.string().nullish(),
     /** Which of the mutually exclusive resolve outcomes was reached. */
     outcome: HelpResolutionOutcomeSchema,
-    /** Probability the decision model gave the chosen option (an operation, or none). */
+    /** Probability the decision model gave its chosen option (an operation, a task, several, or none); informational, the choice alone decides the outcome. */
     probability: z.number().nullish(),
-    /** The chosen catalog task; present only for TASK_PLAN. getHarnessTaskPlan reads its plan. */
+    /** The chosen catalog task for TASK_PLAN, or the task leading a CLARIFY; getHarnessTaskPlan reads its plan. */
     taskKey: z.string().nullish(),
 });
 //# sourceMappingURL=resolution.js.map

package/dist/link/search.d.ts

@@ -10,6 +10,16 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
                     sourceId: string;
                 }[];
                 confidence: "HIGH" | "LOW" | "MEDIUM";
+                paragraph: {
+                    citation: {
+                        entityId: string;
+                        source: "entityRecord" | "newsArticle" | "researchSnippet";
+                        sourceId: string;
+                    }[];
+                    text: string;
+                    topic?: string | null | undefined;
+                }[];
+                relatedQuery: string[];
                 text: string;
             } | null | undefined;
             interpretation: {
@@ -2233,6 +2243,16 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
                     sourceId: string;
                 }[];
                 confidence: "HIGH" | "LOW" | "MEDIUM";
+                paragraph: {
+                    citation: {
+                        entityId: string;
+                        source: "entityRecord" | "newsArticle" | "researchSnippet";
+                        sourceId: string;
+                    }[];
+                    text: string;
+                    topic?: string | null | undefined;
+                }[];
+                relatedQuery: string[];
                 text: string;
             } | null | undefined;
             interpretation: {

package/dist/natural/search-result.d.ts

@@ -15,6 +15,24 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
             LOW: "LOW";
             MEDIUM: "MEDIUM";
         }>;
+        paragraph: z.ZodArray<z.ZodType<{
+            citation: {
+                entityId: string;
+                source: "entityRecord" | "newsArticle" | "researchSnippet";
+                sourceId: string;
+            }[];
+            text: string;
+            topic?: string | null | undefined;
+        }, unknown, z.core.$ZodTypeInternals<{
+            citation: {
+                entityId: string;
+                source: "entityRecord" | "newsArticle" | "researchSnippet";
+                sourceId: string;
+            }[];
+            text: string;
+            topic?: string | null | undefined;
+        }, unknown>>>;
+        relatedQuery: z.ZodArray<z.ZodString>;
         text: z.ZodString;
     }, z.core.$strip>>>;
     interpretation: z.ZodType<{

package/dist/natural/search.js

@@ -2,7 +2,7 @@
 import { z } from "zod/v4";
 import { SearchModeSchema } from "../search/mode.js";
 const NaturalSearchSchemaDefinition = z.object({
-    /** 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; news and federated search accept only `auto` and `keyword`; content search accepts `auto`, `keyword`, and `semantic` (`semantic` only for one entity's or person's content). */
+    /** 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). */
     mode: SearchModeSchema.default("auto").optional(),
     /** Optional chat model for planning; null uses the configured natural-search default. A caller without admin authority may only choose an allowlisted model; admin callers are unrestricted. */
     model: z.string().nullish(),

package/dist/openapi-component-manifest.js

@@ -799,6 +799,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
         modulePath: "search/answer-citation",
         schemaName: "SearchAnswerCitationSchema",
     },
+    SearchAnswerParagraph: {
+        modulePath: "search/answer-paragraph",
+        schemaName: "SearchAnswerParagraphSchema",
+    },
     SearchDuplicateCandidateScore: {
         modulePath: "search/duplicate-candidate-score",
         schemaName: "SearchDuplicateCandidateScoreSchema",

package/dist/search/answer-citation.d.ts

@@ -17,6 +17,7 @@ type SearchAnswerCitationDefinition = z.infer<typeof SearchAnswerCitationSchemaD
  * @endpoint GET /v1/search/link/jobs/{jobId}
  * @endpoint POST /v1/search
  * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchAnswerParagraphSchema
  * @usedBySchema SearchAnswerSchema
  * @contractShape search.answer-citation
  * @contractRole canonical

package/dist/search/answer-citation.js

@@ -17,6 +17,7 @@ const SearchAnswerCitationSchemaDefinition = z.object({
  * @endpoint GET /v1/search/link/jobs/{jobId}
  * @endpoint POST /v1/search
  * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchAnswerParagraphSchema
  * @usedBySchema SearchAnswerSchema
  * @contractShape search.answer-citation
  * @contractRole canonical

package/dist/search/answer-paragraph.d.ts

@@ -0,0 +1,31 @@
+import { z } from "zod/v4";
+declare const SearchAnswerParagraphSchemaDefinition: z.ZodObject<{
+    citation: z.ZodArray<z.ZodType<{
+        entityId: string;
+        source: "entityRecord" | "newsArticle" | "researchSnippet";
+        sourceId: string;
+    }, unknown, z.core.$ZodTypeInternals<{
+        entityId: string;
+        source: "entityRecord" | "newsArticle" | "researchSnippet";
+        sourceId: string;
+    }, unknown>>>;
+    text: z.ZodString;
+    topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+type SearchAnswerParagraphDefinition = z.infer<typeof SearchAnswerParagraphSchemaDefinition>;
+/**
+ * One paragraph of an answer and the evidence it rests on.
+ *
+ * @openapiSchema SearchAnswerParagraph
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchAnswerSchema
+ * @contractShape search.answer-paragraph
+ * @contractRole canonical
+ */
+export declare const SearchAnswerParagraphSchema: z.ZodType<SearchAnswerParagraphDefinition>;
+export type SearchAnswerParagraph = z.infer<typeof SearchAnswerParagraphSchema>;
+export {};
+//# sourceMappingURL=answer-paragraph.d.ts.map

package/dist/search/answer-paragraph.js

@@ -0,0 +1,25 @@
+// 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 { SearchAnswerCitationSchema } from "./answer-citation.js";
+const SearchAnswerParagraphSchemaDefinition = z.object({
+    /** Evidence this paragraph rests on, most important first. */
+    citation: z.array(SearchAnswerCitationSchema),
+    /** Paragraph text in plain prose. */
+    text: z.string(),
+    /** Short label naming the category, market, or segment this paragraph covers, such as "Smartphones · North America"; absent on the lead paragraph. */
+    topic: z.string().nullish(),
+});
+/**
+ * One paragraph of an answer and the evidence it rests on.
+ *
+ * @openapiSchema SearchAnswerParagraph
+ * @endpoint GET /v1/search/link
+ * @endpoint GET /v1/search/link/jobs/{jobId}
+ * @endpoint POST /v1/search
+ * @endpoint POST /v1/search/natural/entities
+ * @usedBySchema SearchAnswerSchema
+ * @contractShape search.answer-paragraph
+ * @contractRole canonical
+ */
+export const SearchAnswerParagraphSchema = SearchAnswerParagraphSchemaDefinition;
+//# sourceMappingURL=answer-paragraph.js.map

package/dist/search/answer.d.ts

@@ -1,6 +1,6 @@
 import { z } from "zod/v4";
 /**
- * Written answer to a natural-language question, grounded only in the response's entity records and passages. LOW confidence with no citation means the evidence does not answer the question.
+ * Written answer to a natural-language question, grounded only in the response's entity records and passages. LOW confidence with no paragraph means the evidence does not answer the question.
  *
  * @openapiSchema SearchAnswer
  * @endpoint GET /v1/search/link
@@ -26,6 +26,24 @@ export declare const SearchAnswerSchema: z.ZodObject<{
         LOW: "LOW";
         MEDIUM: "MEDIUM";
     }>;
+    paragraph: z.ZodArray<z.ZodType<{
+        citation: {
+            entityId: string;
+            source: "entityRecord" | "newsArticle" | "researchSnippet";
+            sourceId: string;
+        }[];
+        text: string;
+        topic?: string | null | undefined;
+    }, unknown, z.core.$ZodTypeInternals<{
+        citation: {
+            entityId: string;
+            source: "entityRecord" | "newsArticle" | "researchSnippet";
+            sourceId: string;
+        }[];
+        text: string;
+        topic?: string | null | undefined;
+    }, unknown>>>;
+    relatedQuery: z.ZodArray<z.ZodString>;
     text: z.ZodString;
 }, z.core.$strip>;
 export type SearchAnswer = z.infer<typeof SearchAnswerSchema>;

package/dist/search/answer.js

@@ -2,8 +2,9 @@
 import { z } from "zod/v4";
 import { ConfidenceSchema } from "../confidence/confidence.js";
 import { SearchAnswerCitationSchema } from "./answer-citation.js";
+import { SearchAnswerParagraphSchema } from "./answer-paragraph.js";
 /**
- * Written answer to a natural-language question, grounded only in the response's entity records and passages. LOW confidence with no citation means the evidence does not answer the question.
+ * Written answer to a natural-language question, grounded only in the response's entity records and passages. LOW confidence with no paragraph means the evidence does not answer the question.
  *
  * @openapiSchema SearchAnswer
  * @endpoint GET /v1/search/link
@@ -15,11 +16,15 @@ import { SearchAnswerCitationSchema } from "./answer-citation.js";
  * @contractRole canonical
  */
 export const SearchAnswerSchema = z.object({
-    /** Evidence each claim rests on, in first-use order. */
+    /** Evidence the paragraphs cite, in first-use order. */
     citation: z.array(SearchAnswerCitationSchema),
     /** How fully the cited evidence answers the question. */
     confidence: ConfidenceSchema,
-    /** Answer text in plain prose. */
+    /** The answer's paragraphs in reading order, each citing the evidence it rests on; empty when the answer abstains. */
+    paragraph: z.array(SearchAnswerParagraphSchema),
+    /** Up to five follow-up searches grounded in the cited evidence; empty when the answer abstains. */
+    relatedQuery: z.array(z.string()),
+    /** Every paragraph's text in reading order, separated by blank lines; read `paragraph` to place each citation beside the text it supports. */
     text: z.string(),
 });
 //# sourceMappingURL=answer.js.map

package/dist/search/mode.d.ts

@@ -2,13 +2,14 @@ import { z } from "zod/v4";
 declare const SearchModeSchemaDefinition: z.ZodUnion<readonly [z.ZodEnum<{
     auto: "auto";
     exact: "exact";
+    hybrid: "hybrid";
     keyword: "keyword";
     natural: "natural";
     semantic: "semantic";
 }>, z.ZodString]>;
 type SearchModeDefinition = z.infer<typeof SearchModeSchemaDefinition>;
 /**
- * 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` (topic, type, relation, and year words become filters and any other words rank by full text), `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).
+ * 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; `hybrid` fuses keyword and semantic rankings by reciprocal rank. Entity and person natural-search support every mode but `hybrid`; news and federated search accept only `auto` and `keyword`; content search accepts `auto` (topic, type, relation, and year words become filters and any other words rank by full text), `keyword` (the full text of articles, posts, and fetched pages), `semantic` (one entity's or person's library pages by vector similarity of their fetched bodies), and `hybrid` (that owner's keyword and semantic rankings fused; each ranking is cut at the largest page size, so a hybrid search returns at most twice that many items, and it orders by fused rank only, ignoring `sort`).
  *
  * @openapiSchema SearchMode
  * @endpoint GET /v1/search/link

package/dist/search/mode.js

@@ -1,11 +1,11 @@
 // 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";
 const SearchModeSchemaDefinition = z.union([
-    z.enum(["auto", "exact", "keyword", "semantic", "natural"]),
+    z.enum(["auto", "exact", "keyword", "semantic", "natural", "hybrid"]),
     z.string(),
 ]);
 /**
- * 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` (topic, type, relation, and year words become filters and any other words rank by full text), `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).
+ * 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; `hybrid` fuses keyword and semantic rankings by reciprocal rank. Entity and person natural-search support every mode but `hybrid`; news and federated search accept only `auto` and `keyword`; content search accepts `auto` (topic, type, relation, and year words become filters and any other words rank by full text), `keyword` (the full text of articles, posts, and fetched pages), `semantic` (one entity's or person's library pages by vector similarity of their fetched bodies), and `hybrid` (that owner's keyword and semantic rankings fused; each ranking is cut at the largest page size, so a hybrid search returns at most twice that many items, and it orders by fused rank only, ignoring `sort`).
  *
  * @openapiSchema SearchMode
  * @endpoint GET /v1/search/link

package/package.json

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