@aventurevc/api-schemas 0.8.115 → 0.8.124
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/address/address.js +1 -1
- package/dist/address/association-role.d.ts +1 -1
- package/dist/address/association-role.js +1 -1
- package/dist/agent/help.d.ts +20 -4
- package/dist/datasource/data-source-type.d.ts +24 -0
- package/dist/datasource/data-source-type.js +24 -0
- package/dist/entity/enrichment.js +1 -1
- package/dist/entity/filter-sortable.d.ts +39 -0
- package/dist/entity/filter-sortable.js +42 -0
- package/dist/entity/filter.js +2 -2
- package/dist/entity/list-filter.js +2 -2
- package/dist/entity/natural-search.d.ts +2 -0
- package/dist/entity/person-association.js +1 -1
- package/dist/federated/natural-search.d.ts +12 -12
- package/dist/federated/natural-search.js +14 -11
- package/dist/federated/search.d.ts +4 -2
- package/dist/harness/task-plan-step.d.ts +8 -0
- package/dist/harness/task-plan-step.js +3 -0
- package/dist/harness/task-plan.d.ts +16 -0
- package/dist/harness/task-write-guidance.d.ts +21 -0
- package/dist/harness/task-write-guidance.js +27 -0
- package/dist/help/citation.d.ts +4 -2
- package/dist/help/resolution.d.ts +18 -2
- package/dist/help/source-type.d.ts +4 -2
- package/dist/help/source-type.js +11 -6
- package/dist/http/problem-detail.d.ts +12 -0
- package/dist/http/problem-detail.js +5 -0
- package/dist/link/search.d.ts +4 -2
- package/dist/lookup/job-mutation.js +1 -1
- package/dist/natural/search-result.d.ts +3 -2
- package/dist/natural/search.d.ts +1 -0
- package/dist/natural/search.js +3 -1
- package/dist/openapi-component-manifest.js +15 -0
- package/dist/person/natural-search.d.ts +2 -0
- package/dist/prose/problem.d.ts +24 -0
- package/dist/prose/problem.js +27 -0
- package/dist/prose/violation.d.ts +32 -0
- package/dist/prose/violation.js +24 -0
- package/dist/reasoning/effort.d.ts +1 -0
- package/dist/reasoning/effort.js +1 -0
- package/dist/research/snippet-type.d.ts +1 -0
- package/dist/research/snippet-type.js +2 -0
- package/dist/search/answer.d.ts +1 -0
- package/dist/search/answer.js +3 -1
- package/dist/search/cache-mode.d.ts +1 -0
- package/dist/search/cache-mode.js +1 -0
- package/dist/search/interpretation.d.ts +2 -2
- package/dist/search/layer.d.ts +2 -0
- package/dist/search/layer.js +2 -0
- package/dist/search/ordering-entity-filter-sortable.d.ts +2 -2
- package/dist/shared/search-mutation.d.ts +208 -0
- package/dist/shared/search-mutation.js +8 -0
- package/dist/shared/search.d.ts +4 -2
- package/dist/sort/order-entity-filter-sortable.d.ts +4 -2
- package/dist/sort/order-entity-filter-sortable.js +2 -19
- package/dist/suppression/reason.d.ts +17 -0
- package/dist/suppression/reason.js +16 -0
- package/package.json +1 -1
|
@@ -55,6 +55,7 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
55
55
|
origin_detail_capacity: "origin_detail_capacity";
|
|
56
56
|
origin_detail_shutdown: "origin_detail_shutdown";
|
|
57
57
|
primary_website_missing: "primary_website_missing";
|
|
58
|
+
prose_rejected: "prose_rejected";
|
|
58
59
|
r2_delete_failed: "r2_delete_failed";
|
|
59
60
|
r2_fetch_failed: "r2_fetch_failed";
|
|
60
61
|
r2_upload_failed: "r2_upload_failed";
|
|
@@ -243,6 +244,17 @@ declare const ProblemDetailSchemaDefinition: z.ZodObject<{
|
|
|
243
244
|
parseError: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
244
245
|
path: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
245
246
|
properties: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodType<import("./json-value.ts").JsonValue, unknown, z.core.$ZodTypeInternals<import("./json-value.ts").JsonValue, unknown>>>>;
|
|
247
|
+
proseViolation: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodType<{
|
|
248
|
+
overridable: boolean;
|
|
249
|
+
passage: string;
|
|
250
|
+
problem: string;
|
|
251
|
+
reason: string;
|
|
252
|
+
}, unknown, z.core.$ZodTypeInternals<{
|
|
253
|
+
overridable: boolean;
|
|
254
|
+
passage: string;
|
|
255
|
+
problem: string;
|
|
256
|
+
reason: string;
|
|
257
|
+
}, unknown>>>>>;
|
|
246
258
|
remaining: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
|
|
247
259
|
requiredRole: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
248
260
|
resetAt: z.ZodOptional<z.ZodNullable<z.ZodISODateTime>>;
|
|
@@ -3,6 +3,7 @@ import { z } from "zod/v4";
|
|
|
3
3
|
import { DomainConflictDetailsSchema } from "../domain/conflict-details.js";
|
|
4
4
|
import { JsonValueSchema } from "./json-value.js";
|
|
5
5
|
import { ProblemResolutionSchema } from "../problem/resolution.js";
|
|
6
|
+
import { ProseViolationSchema } from "../prose/violation.js";
|
|
6
7
|
import { CurrentSlugOwnerSchema } from "../redirect/current-slug-owner.js";
|
|
7
8
|
import { RedirectSlugPathSchema } from "../redirect/redirect-slug-path.js";
|
|
8
9
|
const ProblemDetailSchemaDefinition = z.object({
|
|
@@ -43,6 +44,8 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
43
44
|
"suspectedShellStrip",
|
|
44
45
|
/** Request prose looks shell-mangled around a money phrase: either shell expansion stripped a leading dollar sign ('50 million' where '$50 million' was meant) or an escape character survived into the text ('\$50 million', standalone '/$50 million'). Agent action: write '$' literally and re-send the JSON body from a file or stdin, or quote it so the shell does not expand '$'; use allowSuspectedShellStrip only when the value is intentional. */
|
|
45
46
|
"suspected_shell_strip",
|
|
47
|
+
/** Entity text or a research snippet was rejected by its prose judge or text contract. Agent action: rewrite every passage in ProblemDetail.proseViolation at once and resend the whole text; ProblemDetail.hint names the override only when every violation is overridable. */
|
|
48
|
+
"prose_rejected",
|
|
46
49
|
/** A URL was submitted to the wrong write surface. Agent action: move the URL to the specific surface named by ProblemDetail.hint/resolution, for example EntityUrl.urlType=ycombinator via entities urls create instead of News.newsUrlOriginal. */
|
|
47
50
|
"url_surface_misclassification",
|
|
48
51
|
/** JobRunr background worker is disabled in this environment. Agent action: stop (this is an admin/ops configuration condition, not a retriable user error). */
|
|
@@ -190,6 +193,8 @@ const ProblemDetailSchemaDefinition = z.object({
|
|
|
190
193
|
parseError: z.string().nullish(),
|
|
191
194
|
path: z.string().nullish(),
|
|
192
195
|
properties: z.record(z.string(), JsonValueSchema).optional(),
|
|
196
|
+
/** Every rejected passage of a PROSE_REJECTED write, once per problem it shows; absent for every other problem. */
|
|
197
|
+
proseViolation: z.array(ProseViolationSchema).nullish(),
|
|
193
198
|
/** Cap minus used for the limitType meter, never negative. */
|
|
194
199
|
remaining: z.number().int().nullish(),
|
|
195
200
|
requiredRole: z.string().nullish(),
|
package/dist/link/search.d.ts
CHANGED
|
@@ -11,6 +11,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
11
11
|
}[];
|
|
12
12
|
confidence: "HIGH" | "LOW" | "MEDIUM";
|
|
13
13
|
description?: string | null | undefined;
|
|
14
|
+
heading?: string | null | undefined;
|
|
14
15
|
paragraph: {
|
|
15
16
|
citation: {
|
|
16
17
|
entityId: string;
|
|
@@ -148,7 +149,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
148
149
|
sort: {
|
|
149
150
|
order: {
|
|
150
151
|
descending: boolean;
|
|
151
|
-
field:
|
|
152
|
+
field: string;
|
|
152
153
|
sortKey?: string | null | undefined;
|
|
153
154
|
}[];
|
|
154
155
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
@@ -3459,6 +3460,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
3459
3460
|
}[];
|
|
3460
3461
|
confidence: "HIGH" | "LOW" | "MEDIUM";
|
|
3461
3462
|
description?: string | null | undefined;
|
|
3463
|
+
heading?: string | null | undefined;
|
|
3462
3464
|
paragraph: {
|
|
3463
3465
|
citation: {
|
|
3464
3466
|
entityId: string;
|
|
@@ -3596,7 +3598,7 @@ declare const LinkSearchSchemaDefinition: z.ZodObject<{
|
|
|
3596
3598
|
sort: {
|
|
3597
3599
|
order: {
|
|
3598
3600
|
descending: boolean;
|
|
3599
|
-
field:
|
|
3601
|
+
field: string;
|
|
3600
3602
|
sortKey?: string | null | undefined;
|
|
3601
3603
|
}[];
|
|
3602
3604
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
@@ -5,7 +5,7 @@ import { LookupMentionSchema } from "./mention.js";
|
|
|
5
5
|
const LookupJobMutationSchemaDefinition = z.object({
|
|
6
6
|
/** Companies and people the caller already read, identified without sending the page or screenshot. Send them alone, without an article or file. On lookup jobs, maxNames is required and no shell records or enrichment are scheduled. */
|
|
7
7
|
mention: z.array(LookupMentionSchema).optional(),
|
|
8
|
-
/** Id of a recorded source document whose text is the article, such as an email recorded with POST /v1/research/source-documents; send it alone. Only POST /v1/lookup-mentions reads it. */
|
|
8
|
+
/** Id of a recorded source document whose text is the article, such as an email recorded with POST /v1/research/source-documents; send it alone. Only POST /v1/lookup-mentions reads it, for the admin key or RBAC EDIT_CACHE. */
|
|
9
9
|
sourceDocumentId: z.uuid().nullish(),
|
|
10
10
|
/** aVenture news id of the article; an id that names no stored article is an error. */
|
|
11
11
|
sourceNewsId: z.int().nullish(),
|
|
@@ -16,6 +16,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
16
16
|
MEDIUM: "MEDIUM";
|
|
17
17
|
}>;
|
|
18
18
|
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
19
|
+
heading: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
19
20
|
paragraph: z.ZodArray<z.ZodType<{
|
|
20
21
|
citation: {
|
|
21
22
|
entityId: string;
|
|
@@ -161,7 +162,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
161
162
|
sort: {
|
|
162
163
|
order: {
|
|
163
164
|
descending: boolean;
|
|
164
|
-
field:
|
|
165
|
+
field: string;
|
|
165
166
|
sortKey?: string | null | undefined;
|
|
166
167
|
}[];
|
|
167
168
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
@@ -291,7 +292,7 @@ declare const NaturalSearchResultSchemaDefinition: z.ZodObject<{
|
|
|
291
292
|
sort: {
|
|
292
293
|
order: {
|
|
293
294
|
descending: boolean;
|
|
294
|
-
field:
|
|
295
|
+
field: string;
|
|
295
296
|
sortKey?: string | null | undefined;
|
|
296
297
|
}[];
|
|
297
298
|
relevance?: "keyword" | "semantic" | null | undefined;
|
package/dist/natural/search.d.ts
CHANGED
package/dist/natural/search.js
CHANGED
|
@@ -4,7 +4,9 @@ import { ReasoningEffortSchema } from "../reasoning/effort.js";
|
|
|
4
4
|
import { SearchCacheModeSchema } from "../search/cache-mode.js";
|
|
5
5
|
import { SearchModeSchema } from "../search/mode.js";
|
|
6
6
|
const NaturalSearchSchemaDefinition = z.object({
|
|
7
|
-
/**
|
|
7
|
+
/** Optional chat model for the synthesis answer; null uses the catalog's search answer model. The same allowlist as `model` applies. The answer writes the page heading, title, and description, so this compares answer models without changing the catalog. */
|
|
8
|
+
answerModel: z.string().nullish(),
|
|
9
|
+
/** Search-stage cache policy. use reuses cached search work; bypass computes fresh without retaining outputs; refresh computes fresh and replaces normal entries. Record and immutable query-vector caches retain their own policy. Callers without private-data access always run use. */
|
|
8
10
|
cacheMode: SearchCacheModeSchema.default("use").optional(),
|
|
9
11
|
/** 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). */
|
|
10
12
|
mode: SearchModeSchema.default("auto").optional(),
|
|
@@ -185,6 +185,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
185
185
|
modulePath: "cursor/slice-shared-search-list",
|
|
186
186
|
schemaName: "CursorSliceSharedSearchListSchema",
|
|
187
187
|
},
|
|
188
|
+
DatasourceDataSourceType: {
|
|
189
|
+
modulePath: "datasource/data-source-type",
|
|
190
|
+
schemaName: "DatasourceDataSourceTypeSchema",
|
|
191
|
+
},
|
|
188
192
|
DatasourceProvenanceActorType: {
|
|
189
193
|
modulePath: "datasource/provenance-actor-type",
|
|
190
194
|
schemaName: "DatasourceProvenanceActorTypeSchema",
|
|
@@ -303,6 +307,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
303
307
|
modulePath: "entity/filter-search-result",
|
|
304
308
|
schemaName: "EntityFilterSearchResultSchema",
|
|
305
309
|
},
|
|
310
|
+
EntityFilterSortable: {
|
|
311
|
+
modulePath: "entity/filter-sortable",
|
|
312
|
+
schemaName: "EntityFilterSortableSchema",
|
|
313
|
+
},
|
|
306
314
|
EntityFilterUiMeta: {
|
|
307
315
|
modulePath: "entity/filter-ui-meta",
|
|
308
316
|
schemaName: "EntityFilterUiMetaSchema",
|
|
@@ -518,6 +526,10 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
518
526
|
schemaName: "HarnessTaskPlanStepSchema",
|
|
519
527
|
},
|
|
520
528
|
HarnessTaskStep: { modulePath: "harness/task-step", schemaName: "HarnessTaskStepSchema" },
|
|
529
|
+
HarnessTaskWriteGuidance: {
|
|
530
|
+
modulePath: "harness/task-write-guidance",
|
|
531
|
+
schemaName: "HarnessTaskWriteGuidanceSchema",
|
|
532
|
+
},
|
|
521
533
|
HelpCitation: { modulePath: "help/citation", schemaName: "HelpCitationSchema" },
|
|
522
534
|
HelpResolution: { modulePath: "help/resolution", schemaName: "HelpResolutionSchema" },
|
|
523
535
|
HelpResolutionOutcome: {
|
|
@@ -775,6 +787,8 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
775
787
|
ProblemDetail: { modulePath: "http/problem-detail", schemaName: "ProblemDetailSchema" },
|
|
776
788
|
ProblemResolution: { modulePath: "problem/resolution", schemaName: "ProblemResolutionSchema" },
|
|
777
789
|
ProblemType: { modulePath: "problem/type", schemaName: "ProblemTypeSchema" },
|
|
790
|
+
ProseProblem: { modulePath: "prose/problem", schemaName: "ProseProblemSchema" },
|
|
791
|
+
ProseViolation: { modulePath: "prose/violation", schemaName: "ProseViolationSchema" },
|
|
778
792
|
Publication: { modulePath: "publication/publication", schemaName: "PublicationSchema" },
|
|
779
793
|
PublicationFacet: { modulePath: "publication/facet", schemaName: "PublicationFacetSchema" },
|
|
780
794
|
PublicationRelation: {
|
|
@@ -902,6 +916,7 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
902
916
|
modulePath: "strict/url-lookup-conflict",
|
|
903
917
|
schemaName: "StrictUrlLookupConflictSchema",
|
|
904
918
|
},
|
|
919
|
+
SuppressionReason: { modulePath: "suppression/reason", schemaName: "SuppressionReasonSchema" },
|
|
905
920
|
SystemBuild: { modulePath: "system/system-build", schemaName: "SystemBuildSchema" },
|
|
906
921
|
SystemBuildDetail: {
|
|
907
922
|
modulePath: "system/system-build-detail",
|
|
@@ -265,12 +265,14 @@ declare const PersonNaturalSearchSchemaDefinition: z.ZodObject<{
|
|
|
265
265
|
status: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
266
266
|
}, z.core.$strip>>;
|
|
267
267
|
search: z.ZodType<{
|
|
268
|
+
answerModel?: string | null | undefined;
|
|
268
269
|
cacheMode?: "bypass" | "refresh" | "use" | undefined;
|
|
269
270
|
mode?: string | undefined;
|
|
270
271
|
model?: string | null | undefined;
|
|
271
272
|
query: string;
|
|
272
273
|
reasoningEffort?: string | null | undefined;
|
|
273
274
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
275
|
+
answerModel?: string | null | undefined;
|
|
274
276
|
cacheMode?: "bypass" | "refresh" | "use" | undefined;
|
|
275
277
|
mode?: string | undefined;
|
|
276
278
|
model?: string | null | undefined;
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Why a sentence or paragraph of entity text or a research snippet was rejected.
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema ProseProblem
|
|
6
|
+
* @standardProblemResponse
|
|
7
|
+
* @usedBySchema ProseViolationSchema
|
|
8
|
+
* @contractShape prose.problem
|
|
9
|
+
* @contractRole canonical
|
|
10
|
+
*/
|
|
11
|
+
export declare const ProseProblemSchema: z.ZodUnion<readonly [z.ZodEnum<{
|
|
12
|
+
disclaimer: "disclaimer";
|
|
13
|
+
factList: "factList";
|
|
14
|
+
legalSource: "legalSource";
|
|
15
|
+
mojibake: "mojibake";
|
|
16
|
+
record: "record";
|
|
17
|
+
source: "source";
|
|
18
|
+
structured: "structured";
|
|
19
|
+
temporal: "temporal";
|
|
20
|
+
textContract: "textContract";
|
|
21
|
+
voice: "voice";
|
|
22
|
+
}>, z.ZodString]>;
|
|
23
|
+
export type ProseProblem = z.infer<typeof ProseProblemSchema>;
|
|
24
|
+
//# sourceMappingURL=problem.d.ts.map
|
|
@@ -0,0 +1,27 @@
|
|
|
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
|
+
/**
|
|
4
|
+
* Why a sentence or paragraph of entity text or a research snippet was rejected.
|
|
5
|
+
*
|
|
6
|
+
* @openapiSchema ProseProblem
|
|
7
|
+
* @standardProblemResponse
|
|
8
|
+
* @usedBySchema ProseViolationSchema
|
|
9
|
+
* @contractShape prose.problem
|
|
10
|
+
* @contractRole canonical
|
|
11
|
+
*/
|
|
12
|
+
export const ProseProblemSchema = z.union([
|
|
13
|
+
z.enum([
|
|
14
|
+
"source",
|
|
15
|
+
"record",
|
|
16
|
+
"disclaimer",
|
|
17
|
+
"voice",
|
|
18
|
+
"structured",
|
|
19
|
+
"temporal",
|
|
20
|
+
"factList",
|
|
21
|
+
"mojibake",
|
|
22
|
+
"legalSource",
|
|
23
|
+
"textContract",
|
|
24
|
+
]),
|
|
25
|
+
z.string(),
|
|
26
|
+
]);
|
|
27
|
+
//# sourceMappingURL=problem.js.map
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
declare const ProseViolationSchemaDefinition: z.ZodObject<{
|
|
3
|
+
overridable: z.ZodBoolean;
|
|
4
|
+
passage: z.ZodString;
|
|
5
|
+
problem: z.ZodUnion<readonly [z.ZodEnum<{
|
|
6
|
+
disclaimer: "disclaimer";
|
|
7
|
+
factList: "factList";
|
|
8
|
+
legalSource: "legalSource";
|
|
9
|
+
mojibake: "mojibake";
|
|
10
|
+
record: "record";
|
|
11
|
+
source: "source";
|
|
12
|
+
structured: "structured";
|
|
13
|
+
temporal: "temporal";
|
|
14
|
+
textContract: "textContract";
|
|
15
|
+
voice: "voice";
|
|
16
|
+
}>, z.ZodString]>;
|
|
17
|
+
reason: z.ZodString;
|
|
18
|
+
}, z.core.$strip>;
|
|
19
|
+
type ProseViolationDefinition = z.infer<typeof ProseViolationSchemaDefinition>;
|
|
20
|
+
/**
|
|
21
|
+
* One rejected passage and one problem it shows; a passage with several problems appears once per problem.
|
|
22
|
+
*
|
|
23
|
+
* @openapiSchema ProseViolation
|
|
24
|
+
* @standardProblemResponse
|
|
25
|
+
* @usedBySchema ProblemDetailSchema
|
|
26
|
+
* @contractShape prose.violation
|
|
27
|
+
* @contractRole canonical
|
|
28
|
+
*/
|
|
29
|
+
export declare const ProseViolationSchema: z.ZodType<ProseViolationDefinition>;
|
|
30
|
+
export type ProseViolation = z.infer<typeof ProseViolationSchema>;
|
|
31
|
+
export {};
|
|
32
|
+
//# sourceMappingURL=violation.d.ts.map
|
|
@@ -0,0 +1,24 @@
|
|
|
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 { ProseProblemSchema } from "./problem.js";
|
|
4
|
+
const ProseViolationSchemaDefinition = z.object({
|
|
5
|
+
/** Whether proseOverrideReason can accept this problem; ProblemDetail.hint says when an override is allowed. */
|
|
6
|
+
overridable: z.boolean(),
|
|
7
|
+
/** The rejected sentence, the whole text for a text-contract violation, or the source URL for a legal-page source. */
|
|
8
|
+
passage: z.string(),
|
|
9
|
+
/** The problem this passage shows. */
|
|
10
|
+
problem: ProseProblemSchema,
|
|
11
|
+
/** Why the passage was rejected and how to fix it. */
|
|
12
|
+
reason: z.string(),
|
|
13
|
+
});
|
|
14
|
+
/**
|
|
15
|
+
* One rejected passage and one problem it shows; a passage with several problems appears once per problem.
|
|
16
|
+
*
|
|
17
|
+
* @openapiSchema ProseViolation
|
|
18
|
+
* @standardProblemResponse
|
|
19
|
+
* @usedBySchema ProblemDetailSchema
|
|
20
|
+
* @contractShape prose.violation
|
|
21
|
+
* @contractRole canonical
|
|
22
|
+
*/
|
|
23
|
+
export const ProseViolationSchema = ProseViolationSchemaDefinition;
|
|
24
|
+
//# sourceMappingURL=violation.js.map
|
|
@@ -8,6 +8,7 @@ import { z } from "zod/v4";
|
|
|
8
8
|
* @endpoint POST /v1/search
|
|
9
9
|
* @endpoint POST /v1/search/natural/entities
|
|
10
10
|
* @endpoint POST /v1/search/natural/people
|
|
11
|
+
* @endpoint POST /v1/search/shared
|
|
11
12
|
* @usedBySchema FederatedNaturalSearchSchema
|
|
12
13
|
* @usedBySchema NaturalSearchSchema
|
|
13
14
|
* @contractShape reasoning.effort
|
package/dist/reasoning/effort.js
CHANGED
|
@@ -9,6 +9,7 @@ import { z } from "zod/v4";
|
|
|
9
9
|
* @endpoint POST /v1/search
|
|
10
10
|
* @endpoint POST /v1/search/natural/entities
|
|
11
11
|
* @endpoint POST /v1/search/natural/people
|
|
12
|
+
* @endpoint POST /v1/search/shared
|
|
12
13
|
* @usedBySchema FederatedNaturalSearchSchema
|
|
13
14
|
* @usedBySchema NaturalSearchSchema
|
|
14
15
|
* @contractShape reasoning.effort
|
|
@@ -16,6 +16,7 @@ declare const ResearchSnippetTypeSchemaDefinition: z.ZodObject<{
|
|
|
16
16
|
recognized: z.ZodBoolean;
|
|
17
17
|
targetPath: z.ZodString;
|
|
18
18
|
typeValue: z.ZodString;
|
|
19
|
+
writeHint: z.ZodString;
|
|
19
20
|
}, z.core.$strip>;
|
|
20
21
|
type ResearchSnippetTypeDefinition = z.infer<typeof ResearchSnippetTypeSchemaDefinition>;
|
|
21
22
|
/**
|
|
@@ -20,6 +20,8 @@ const ResearchSnippetTypeSchemaDefinition = z.object({
|
|
|
20
20
|
targetPath: z.string(),
|
|
21
21
|
/** Canonical snippet type token used on the wire. */
|
|
22
22
|
typeValue: z.string(),
|
|
23
|
+
/** The strategic question this snippet type answers and how to shape it. Snippets are point-in-time strategic analysis of the company's position against its market and named alternatives: open with the judgment and cite dated, sourced details only as evidence for it, never as a fact list. */
|
|
24
|
+
writeHint: z.string(),
|
|
23
25
|
});
|
|
24
26
|
/**
|
|
25
27
|
* Canonical research snippet type with the governance rules write callers must satisfy.
|
package/dist/search/answer.d.ts
CHANGED
|
@@ -30,6 +30,7 @@ export declare const SearchAnswerSchema: z.ZodObject<{
|
|
|
30
30
|
MEDIUM: "MEDIUM";
|
|
31
31
|
}>;
|
|
32
32
|
description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
33
|
+
heading: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
33
34
|
paragraph: z.ZodArray<z.ZodType<{
|
|
34
35
|
citation: {
|
|
35
36
|
entityId: string;
|
package/dist/search/answer.js
CHANGED
|
@@ -25,6 +25,8 @@ export const SearchAnswerSchema = z.object({
|
|
|
25
25
|
confidence: ConfidenceSchema,
|
|
26
26
|
/** One- or two-sentence summary of at most 155 characters for a search-result snippet; absent when the answer abstains. */
|
|
27
27
|
description: z.string().nullish(),
|
|
28
|
+
/** The question as the answer page's heading: the asker's own words in title case, with record names in their stored casing; it never adds, drops, or corrects a word. Absent when the answer abstains. */
|
|
29
|
+
heading: z.string().nullish(),
|
|
28
30
|
/** The answer's paragraphs in reading order, each citing the evidence it rests on; empty when the answer abstains. A first paragraph without `topic` is the lead, written as a standalone answer of one or two sentences that reads complete when shown alone; later paragraphs expand it by topic without restating it. */
|
|
29
31
|
paragraph: z.array(SearchAnswerParagraphSchema),
|
|
30
32
|
/** Up to five follow-up searches grounded in the cited evidence; empty when the answer abstains. */
|
|
@@ -33,7 +35,7 @@ export const SearchAnswerSchema = z.object({
|
|
|
33
35
|
shareable: z.boolean(),
|
|
34
36
|
/** Every paragraph's text in reading order, separated by blank lines; read `paragraph` to place each citation beside the text it supports. */
|
|
35
37
|
text: z.string(),
|
|
36
|
-
/** Page title of at most 60 characters naming the answer's subject and scope, written by the same model call;
|
|
38
|
+
/** Page title of at most 60 characters naming the answer's subject, then the angle and scope its paragraphs cover, written by the same model call; pages show it as the subheading under `heading`. Absent when the answer abstains. */
|
|
37
39
|
title: z.string().nullish(),
|
|
38
40
|
});
|
|
39
41
|
//# sourceMappingURL=answer.js.map
|
|
@@ -8,6 +8,7 @@ import { z } from "zod/v4";
|
|
|
8
8
|
* @endpoint POST /v1/search
|
|
9
9
|
* @endpoint POST /v1/search/natural/entities
|
|
10
10
|
* @endpoint POST /v1/search/natural/people
|
|
11
|
+
* @endpoint POST /v1/search/shared
|
|
11
12
|
* @usedBySchema FederatedNaturalSearchSchema
|
|
12
13
|
* @usedBySchema NaturalSearchSchema
|
|
13
14
|
* @contractShape search.cache-mode
|
|
@@ -9,6 +9,7 @@ import { z } from "zod/v4";
|
|
|
9
9
|
* @endpoint POST /v1/search
|
|
10
10
|
* @endpoint POST /v1/search/natural/entities
|
|
11
11
|
* @endpoint POST /v1/search/natural/people
|
|
12
|
+
* @endpoint POST /v1/search/shared
|
|
12
13
|
* @usedBySchema FederatedNaturalSearchSchema
|
|
13
14
|
* @usedBySchema NaturalSearchSchema
|
|
14
15
|
* @contractShape search.cache-mode
|
|
@@ -244,14 +244,14 @@ declare const SearchInterpretationSchemaDefinition: z.ZodObject<{
|
|
|
244
244
|
sort: z.ZodType<{
|
|
245
245
|
order: {
|
|
246
246
|
descending: boolean;
|
|
247
|
-
field:
|
|
247
|
+
field: string;
|
|
248
248
|
sortKey?: string | null | undefined;
|
|
249
249
|
}[];
|
|
250
250
|
relevance?: "keyword" | "semantic" | null | undefined;
|
|
251
251
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
252
252
|
order: {
|
|
253
253
|
descending: boolean;
|
|
254
|
-
field:
|
|
254
|
+
field: string;
|
|
255
255
|
sortKey?: string | null | undefined;
|
|
256
256
|
}[];
|
|
257
257
|
relevance?: "keyword" | "semantic" | null | undefined;
|
package/dist/search/layer.d.ts
CHANGED
|
@@ -5,6 +5,8 @@ import { z } from "zod/v4";
|
|
|
5
5
|
* @openapiSchema SearchLayer
|
|
6
6
|
* @endpoint POST /v1/search
|
|
7
7
|
* @endpoint POST /v1/search/natural/entities
|
|
8
|
+
* @endpoint POST /v1/search/shared
|
|
9
|
+
* @usedBySchema SharedSearchMutationSchema
|
|
8
10
|
* @contractShape search.layer
|
|
9
11
|
* @contractRole canonical
|
|
10
12
|
*/
|
package/dist/search/layer.js
CHANGED
|
@@ -6,6 +6,8 @@ import { z } from "zod/v4";
|
|
|
6
6
|
* @openapiSchema SearchLayer
|
|
7
7
|
* @endpoint POST /v1/search
|
|
8
8
|
* @endpoint POST /v1/search/natural/entities
|
|
9
|
+
* @endpoint POST /v1/search/shared
|
|
10
|
+
* @usedBySchema SharedSearchMutationSchema
|
|
9
11
|
* @contractShape search.layer
|
|
10
12
|
* @contractRole canonical
|
|
11
13
|
*/
|
|
@@ -2,11 +2,11 @@ import { z } from "zod/v4";
|
|
|
2
2
|
declare const SearchOrderingEntityFilterSortableSchemaDefinition: z.ZodObject<{
|
|
3
3
|
order: z.ZodArray<z.ZodType<{
|
|
4
4
|
descending: boolean;
|
|
5
|
-
field:
|
|
5
|
+
field: string;
|
|
6
6
|
sortKey?: string | null | undefined;
|
|
7
7
|
}, unknown, z.core.$ZodTypeInternals<{
|
|
8
8
|
descending: boolean;
|
|
9
|
-
field:
|
|
9
|
+
field: string;
|
|
10
10
|
sortKey?: string | null | undefined;
|
|
11
11
|
}, unknown>>>;
|
|
12
12
|
relevance: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
|