@aventurevc/api-schemas 0.8.68 → 0.8.69
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.
|
@@ -6,7 +6,7 @@ const AgentHelpQuestionSchemaDefinition = z.object({
|
|
|
6
6
|
model: z.string().nullish(),
|
|
7
7
|
/** The question to answer, in natural language. */
|
|
8
8
|
question: z.string().max(2000),
|
|
9
|
-
/** True
|
|
9
|
+
/** 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. */
|
|
10
10
|
resolve: z.boolean().optional(),
|
|
11
11
|
/** Optional scope restricting which operations the answer may recommend; null means all. */
|
|
12
12
|
scope: HelpScopeSchema.nullish(),
|
package/dist/agent/help.js
CHANGED
|
@@ -10,7 +10,7 @@ const AgentHelpSchemaDefinition = z.object({
|
|
|
10
10
|
citation: z.array(HelpCitationSchema),
|
|
11
11
|
/** Confidence the answer is fully supported by the cited corpus. LOW signals an abstention. */
|
|
12
12
|
confidence: ConfidenceSchema,
|
|
13
|
-
/** The
|
|
13
|
+
/** The task or operation resolution when the question asked to resolve; absent for a generated answer. */
|
|
14
14
|
resolution: HelpResolutionSchema.nullish(),
|
|
15
15
|
});
|
|
16
16
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
/**
|
|
3
|
-
* Resolution of a request to
|
|
3
|
+
* Resolution of a request to a catalog task or an operation, clarification between candidates, or an abstention.
|
|
4
4
|
*
|
|
5
5
|
* @openapiSchema HelpResolution
|
|
6
6
|
* @endpoint POST /v1/agents/help
|
package/dist/help/resolution.js
CHANGED
|
@@ -3,7 +3,7 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { HelpCitationSchema } from "./citation.js";
|
|
4
4
|
import { HelpResolutionOutcomeSchema } from "./resolution-outcome.js";
|
|
5
5
|
/**
|
|
6
|
-
* Resolution of a request to
|
|
6
|
+
* Resolution of a request to a catalog task or an operation, clarification between candidates, or an abstention.
|
|
7
7
|
*
|
|
8
8
|
* @openapiSchema HelpResolution
|
|
9
9
|
* @endpoint POST /v1/agents/help
|
|
@@ -21,7 +21,7 @@ export const HelpResolutionSchema = z.object({
|
|
|
21
21
|
outcome: HelpResolutionOutcomeSchema,
|
|
22
22
|
/** Probability the decision model gave the chosen option (an operation, or none). */
|
|
23
23
|
probability: z.number().nullish(),
|
|
24
|
-
/** The chosen catalog task
|
|
24
|
+
/** The chosen catalog task for TASK_PLAN, or the task leading a CLARIFY; getHarnessTaskPlan reads its plan. */
|
|
25
25
|
taskKey: z.string().nullish(),
|
|
26
26
|
});
|
|
27
27
|
//# sourceMappingURL=resolution.js.map
|
package/dist/natural/search.js
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
import { z } from "zod/v4";
|
|
3
3
|
import { SearchModeSchema } from "../search/mode.js";
|
|
4
4
|
const NaturalSearchSchemaDefinition = z.object({
|
|
5
|
-
/** 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
|
|
5
|
+
/** 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). */
|
|
6
6
|
mode: SearchModeSchema.default("auto").optional(),
|
|
7
7
|
/** 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. */
|
|
8
8
|
model: z.string().nullish(),
|
package/dist/search/mode.d.ts
CHANGED
|
@@ -2,13 +2,14 @@ import { z } from "zod/v4";
|
|
|
2
2
|
declare const SearchModeSchemaDefinition: z.ZodUnion<readonly [z.ZodEnum<{
|
|
3
3
|
auto: "auto";
|
|
4
4
|
exact: "exact";
|
|
5
|
+
hybrid: "hybrid";
|
|
5
6
|
keyword: "keyword";
|
|
6
7
|
natural: "natural";
|
|
7
8
|
semantic: "semantic";
|
|
8
9
|
}>, z.ZodString]>;
|
|
9
10
|
type SearchModeDefinition = z.infer<typeof SearchModeSchemaDefinition>;
|
|
10
11
|
/**
|
|
11
|
-
* 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
|
|
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
13
|
*
|
|
13
14
|
* @openapiSchema SearchMode
|
|
14
15
|
* @endpoint GET /v1/search/link
|
package/dist/search/mode.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
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
3
|
const SearchModeSchemaDefinition = z.union([
|
|
4
|
-
z.enum(["auto", "exact", "keyword", "semantic", "natural"]),
|
|
4
|
+
z.enum(["auto", "exact", "keyword", "semantic", "natural", "hybrid"]),
|
|
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. Entity and person natural-search support every mode
|
|
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).
|
|
9
9
|
*
|
|
10
10
|
* @openapiSchema SearchMode
|
|
11
11
|
* @endpoint GET /v1/search/link
|