@aventurevc/api-schemas 0.8.69 → 0.8.70

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.
@@ -8,6 +8,16 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
8
8
  sourceId: string;
9
9
  }[];
10
10
  confidence: "HIGH" | "LOW" | "MEDIUM";
11
+ paragraph: {
12
+ citation: {
13
+ entityId: string;
14
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
15
+ sourceId: string;
16
+ }[];
17
+ text: string;
18
+ topic?: string | null | undefined;
19
+ }[];
20
+ relatedQuery: string[];
11
21
  text: string;
12
22
  } | null | undefined;
13
23
  interpretation: {
@@ -2071,6 +2081,16 @@ declare const FederatedSearchSchemaDefinition: z.ZodObject<{
2071
2081
  sourceId: string;
2072
2082
  }[];
2073
2083
  confidence: "HIGH" | "LOW" | "MEDIUM";
2084
+ paragraph: {
2085
+ citation: {
2086
+ entityId: string;
2087
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
2088
+ sourceId: string;
2089
+ }[];
2090
+ text: string;
2091
+ topic?: string | null | undefined;
2092
+ }[];
2093
+ relatedQuery: string[];
2074
2094
  text: string;
2075
2095
  } | null | undefined;
2076
2096
  interpretation: {
@@ -19,7 +19,7 @@ export const HelpResolutionSchema = z.object({
19
19
  operationId: z.string().nullish(),
20
20
  /** Which of the mutually exclusive resolve outcomes was reached. */
21
21
  outcome: HelpResolutionOutcomeSchema,
22
- /** Probability the decision model gave the chosen option (an operation, or none). */
22
+ /** Probability the decision model gave its chosen option (an operation, a task, several, or none); informational, the choice alone decides the outcome. */
23
23
  probability: z.number().nullish(),
24
24
  /** The chosen catalog task for TASK_PLAN, or the task leading a CLARIFY; getHarnessTaskPlan reads its plan. */
25
25
  taskKey: z.string().nullish(),
@@ -10,6 +10,16 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
10
10
  sourceId: string;
11
11
  }[];
12
12
  confidence: "HIGH" | "LOW" | "MEDIUM";
13
+ paragraph: {
14
+ citation: {
15
+ entityId: string;
16
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
17
+ sourceId: string;
18
+ }[];
19
+ text: string;
20
+ topic?: string | null | undefined;
21
+ }[];
22
+ relatedQuery: string[];
13
23
  text: string;
14
24
  } | null | undefined;
15
25
  interpretation: {
@@ -2233,6 +2243,16 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
2233
2243
  sourceId: string;
2234
2244
  }[];
2235
2245
  confidence: "HIGH" | "LOW" | "MEDIUM";
2246
+ paragraph: {
2247
+ citation: {
2248
+ entityId: string;
2249
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
2250
+ sourceId: string;
2251
+ }[];
2252
+ text: string;
2253
+ topic?: string | null | undefined;
2254
+ }[];
2255
+ relatedQuery: string[];
2236
2256
  text: string;
2237
2257
  } | null | undefined;
2238
2258
  interpretation: {
@@ -15,6 +15,24 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
15
15
  LOW: "LOW";
16
16
  MEDIUM: "MEDIUM";
17
17
  }>;
18
+ paragraph: z.ZodArray<z.ZodType<{
19
+ citation: {
20
+ entityId: string;
21
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
22
+ sourceId: string;
23
+ }[];
24
+ text: string;
25
+ topic?: string | null | undefined;
26
+ }, unknown, z.core.$ZodTypeInternals<{
27
+ citation: {
28
+ entityId: string;
29
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
30
+ sourceId: string;
31
+ }[];
32
+ text: string;
33
+ topic?: string | null | undefined;
34
+ }, unknown>>>;
35
+ relatedQuery: z.ZodArray<z.ZodString>;
18
36
  text: z.ZodString;
19
37
  }, z.core.$strip>>>;
20
38
  interpretation: z.ZodType<{
@@ -799,6 +799,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
799
799
  modulePath: "search/answer-citation",
800
800
  schemaName: "SearchAnswerCitationSchema",
801
801
  },
802
+ SearchAnswerParagraph: {
803
+ modulePath: "search/answer-paragraph",
804
+ schemaName: "SearchAnswerParagraphSchema",
805
+ },
802
806
  SearchDuplicateCandidateScore: {
803
807
  modulePath: "search/duplicate-candidate-score",
804
808
  schemaName: "SearchDuplicateCandidateScoreSchema",
@@ -17,6 +17,7 @@ type SearchAnswerCitationDefinition = z.infer<typeof SearchAnswerCitationSchemaD
17
17
  * @endpoint GET /v1/search/link/jobs/{jobId}
18
18
  * @endpoint POST /v1/search
19
19
  * @endpoint POST /v1/search/natural/entities
20
+ * @usedBySchema SearchAnswerParagraphSchema
20
21
  * @usedBySchema SearchAnswerSchema
21
22
  * @contractShape search.answer-citation
22
23
  * @contractRole canonical
@@ -17,6 +17,7 @@ const SearchAnswerCitationSchemaDefinition = z.object({
17
17
  * @endpoint GET /v1/search/link/jobs/{jobId}
18
18
  * @endpoint POST /v1/search
19
19
  * @endpoint POST /v1/search/natural/entities
20
+ * @usedBySchema SearchAnswerParagraphSchema
20
21
  * @usedBySchema SearchAnswerSchema
21
22
  * @contractShape search.answer-citation
22
23
  * @contractRole canonical
@@ -0,0 +1,31 @@
1
+ import { z } from "zod/v4";
2
+ declare const SearchAnswerParagraphSchemaDefinition: z.ZodObject<{
3
+ citation: z.ZodArray<z.ZodType<{
4
+ entityId: string;
5
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
6
+ sourceId: string;
7
+ }, unknown, z.core.$ZodTypeInternals<{
8
+ entityId: string;
9
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
10
+ sourceId: string;
11
+ }, unknown>>>;
12
+ text: z.ZodString;
13
+ topic: z.ZodOptional<z.ZodNullable<z.ZodString>>;
14
+ }, z.core.$strip>;
15
+ type SearchAnswerParagraphDefinition = z.infer<typeof SearchAnswerParagraphSchemaDefinition>;
16
+ /**
17
+ * One paragraph of an answer and the evidence it rests on.
18
+ *
19
+ * @openapiSchema SearchAnswerParagraph
20
+ * @endpoint GET /v1/search/link
21
+ * @endpoint GET /v1/search/link/jobs/{jobId}
22
+ * @endpoint POST /v1/search
23
+ * @endpoint POST /v1/search/natural/entities
24
+ * @usedBySchema SearchAnswerSchema
25
+ * @contractShape search.answer-paragraph
26
+ * @contractRole canonical
27
+ */
28
+ export declare const SearchAnswerParagraphSchema: z.ZodType<SearchAnswerParagraphDefinition>;
29
+ export type SearchAnswerParagraph = z.infer<typeof SearchAnswerParagraphSchema>;
30
+ export {};
31
+ //# sourceMappingURL=answer-paragraph.d.ts.map
@@ -0,0 +1,25 @@
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
+ import { SearchAnswerCitationSchema } from "./answer-citation.js";
4
+ const SearchAnswerParagraphSchemaDefinition = z.object({
5
+ /** Evidence this paragraph rests on, most important first. */
6
+ citation: z.array(SearchAnswerCitationSchema),
7
+ /** Paragraph text in plain prose. */
8
+ text: z.string(),
9
+ /** Short label naming the category, market, or segment this paragraph covers, such as "Smartphones · North America"; absent on the lead paragraph. */
10
+ topic: z.string().nullish(),
11
+ });
12
+ /**
13
+ * One paragraph of an answer and the evidence it rests on.
14
+ *
15
+ * @openapiSchema SearchAnswerParagraph
16
+ * @endpoint GET /v1/search/link
17
+ * @endpoint GET /v1/search/link/jobs/{jobId}
18
+ * @endpoint POST /v1/search
19
+ * @endpoint POST /v1/search/natural/entities
20
+ * @usedBySchema SearchAnswerSchema
21
+ * @contractShape search.answer-paragraph
22
+ * @contractRole canonical
23
+ */
24
+ export const SearchAnswerParagraphSchema = SearchAnswerParagraphSchemaDefinition;
25
+ //# sourceMappingURL=answer-paragraph.js.map
@@ -1,6 +1,6 @@
1
1
  import { z } from "zod/v4";
2
2
  /**
3
- * 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.
3
+ * 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.
4
4
  *
5
5
  * @openapiSchema SearchAnswer
6
6
  * @endpoint GET /v1/search/link
@@ -26,6 +26,24 @@ export declare const SearchAnswerSchema: z.ZodObject<{
26
26
  LOW: "LOW";
27
27
  MEDIUM: "MEDIUM";
28
28
  }>;
29
+ paragraph: z.ZodArray<z.ZodType<{
30
+ citation: {
31
+ entityId: string;
32
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
33
+ sourceId: string;
34
+ }[];
35
+ text: string;
36
+ topic?: string | null | undefined;
37
+ }, unknown, z.core.$ZodTypeInternals<{
38
+ citation: {
39
+ entityId: string;
40
+ source: "entityRecord" | "newsArticle" | "researchSnippet";
41
+ sourceId: string;
42
+ }[];
43
+ text: string;
44
+ topic?: string | null | undefined;
45
+ }, unknown>>>;
46
+ relatedQuery: z.ZodArray<z.ZodString>;
29
47
  text: z.ZodString;
30
48
  }, z.core.$strip>;
31
49
  export type SearchAnswer = z.infer<typeof SearchAnswerSchema>;
@@ -2,8 +2,9 @@
2
2
  import { z } from "zod/v4";
3
3
  import { ConfidenceSchema } from "../confidence/confidence.js";
4
4
  import { SearchAnswerCitationSchema } from "./answer-citation.js";
5
+ import { SearchAnswerParagraphSchema } from "./answer-paragraph.js";
5
6
  /**
6
- * 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.
7
+ * 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.
7
8
  *
8
9
  * @openapiSchema SearchAnswer
9
10
  * @endpoint GET /v1/search/link
@@ -15,11 +16,15 @@ import { SearchAnswerCitationSchema } from "./answer-citation.js";
15
16
  * @contractRole canonical
16
17
  */
17
18
  export const SearchAnswerSchema = z.object({
18
- /** Evidence each claim rests on, in first-use order. */
19
+ /** Evidence the paragraphs cite, in first-use order. */
19
20
  citation: z.array(SearchAnswerCitationSchema),
20
21
  /** How fully the cited evidence answers the question. */
21
22
  confidence: ConfidenceSchema,
22
- /** Answer text in plain prose. */
23
+ /** The answer's paragraphs in reading order, each citing the evidence it rests on; empty when the answer abstains. */
24
+ paragraph: z.array(SearchAnswerParagraphSchema),
25
+ /** Up to five follow-up searches grounded in the cited evidence; empty when the answer abstains. */
26
+ relatedQuery: z.array(z.string()),
27
+ /** Every paragraph's text in reading order, separated by blank lines; read `paragraph` to place each citation beside the text it supports. */
23
28
  text: z.string(),
24
29
  });
25
30
  //# sourceMappingURL=answer.js.map
@@ -9,7 +9,7 @@ declare const SearchModeSchemaDefinition: z.ZodUnion<readonly [z.ZodEnum<{
9
9
  }>, z.ZodString]>;
10
10
  type SearchModeDefinition = z.infer<typeof SearchModeSchemaDefinition>;
11
11
  /**
12
- * 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).
12
+ * 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`).
13
13
  *
14
14
  * @openapiSchema SearchMode
15
15
  * @endpoint GET /v1/search/link
@@ -5,7 +5,7 @@ const SearchModeSchemaDefinition = z.union([
5
5
  z.string(),
6
6
  ]);
7
7
  /**
8
- * 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).
8
+ * 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`).
9
9
  *
10
10
  * @openapiSchema SearchMode
11
11
  * @endpoint GET /v1/search/link
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aventurevc/api-schemas",
3
- "version": "0.8.69",
3
+ "version": "0.8.70",
4
4
  "private": false,
5
5
  "description": "Zod v4 schemas and TypeScript types for the aVenture API.",
6
6
  "license": "Apache-2.0",