@aventurevc/api-schemas 0.8.143 → 0.8.145
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/openapi-component-manifest.js +5 -0
- package/dist/search/ai-overview-reference.d.ts +25 -0
- package/dist/search/ai-overview-reference.js +23 -0
- package/dist/search/ai-overview.d.ts +29 -0
- package/dist/search/ai-overview.js +20 -0
- package/dist/search/search.d.ts +1 -0
- package/dist/search/search.js +2 -0
- package/dist/web/search.d.ts +18 -0
- package/dist/web/search.js +3 -0
- package/package.json +1 -1
|
@@ -847,6 +847,11 @@ export const OPENAPI_COMPONENT_MANIFEST = Object.freeze({
|
|
|
847
847
|
ResolvedHandle: { modulePath: "resolved/handle", schemaName: "ResolvedHandleSchema" },
|
|
848
848
|
RoundLabel: { modulePath: "round/label", schemaName: "RoundLabelSchema" },
|
|
849
849
|
Search: { modulePath: "search/search", schemaName: "SearchSchema" },
|
|
850
|
+
SearchAiOverview: { modulePath: "search/ai-overview", schemaName: "SearchAiOverviewSchema" },
|
|
851
|
+
SearchAiOverviewReference: {
|
|
852
|
+
modulePath: "search/ai-overview-reference",
|
|
853
|
+
schemaName: "SearchAiOverviewReferenceSchema",
|
|
854
|
+
},
|
|
850
855
|
SearchAnswer: { modulePath: "search/answer", schemaName: "SearchAnswerSchema" },
|
|
851
856
|
SearchAnswerCitation: {
|
|
852
857
|
modulePath: "search/answer-citation",
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
declare const SearchAiOverviewReferenceSchemaDefinition: z.ZodObject<{
|
|
3
|
+
index: z.ZodInt;
|
|
4
|
+
snippet: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
5
|
+
source: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
6
|
+
title: z.ZodString;
|
|
7
|
+
url: z.ZodString;
|
|
8
|
+
}, z.core.$strip>;
|
|
9
|
+
type SearchAiOverviewReferenceDefinition = z.infer<typeof SearchAiOverviewReferenceSchemaDefinition>;
|
|
10
|
+
export interface SearchAiOverviewReferenceSchemaInput extends z.input<typeof SearchAiOverviewReferenceSchemaDefinition> {
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* One page Google's AI Overview cites
|
|
14
|
+
*
|
|
15
|
+
* @openapiSchema SearchAiOverviewReference
|
|
16
|
+
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
17
|
+
* @endpoint POST /v1/web/search
|
|
18
|
+
* @usedBySchema SearchAiOverviewSchema
|
|
19
|
+
* @contractShape search.ai-overview-reference
|
|
20
|
+
* @contractRole canonical
|
|
21
|
+
*/
|
|
22
|
+
export declare const SearchAiOverviewReferenceSchema: z.ZodType<SearchAiOverviewReferenceDefinition, SearchAiOverviewReferenceSchemaInput>;
|
|
23
|
+
export type SearchAiOverviewReference = z.infer<typeof SearchAiOverviewReferenceSchema>;
|
|
24
|
+
export {};
|
|
25
|
+
//# sourceMappingURL=ai-overview-reference.d.ts.map
|
|
@@ -0,0 +1,23 @@
|
|
|
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
|
+
const SearchAiOverviewReferenceSchemaDefinition = z.object({
|
|
4
|
+
/** Citation number the answer text uses as `[index]` */
|
|
5
|
+
index: z.int(),
|
|
6
|
+
snippet: z.string().nullish(),
|
|
7
|
+
/** Publisher name Google shows for the page */
|
|
8
|
+
source: z.string().nullish(),
|
|
9
|
+
title: z.string(),
|
|
10
|
+
url: z.string(),
|
|
11
|
+
});
|
|
12
|
+
/**
|
|
13
|
+
* One page Google's AI Overview cites
|
|
14
|
+
*
|
|
15
|
+
* @openapiSchema SearchAiOverviewReference
|
|
16
|
+
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
17
|
+
* @endpoint POST /v1/web/search
|
|
18
|
+
* @usedBySchema SearchAiOverviewSchema
|
|
19
|
+
* @contractShape search.ai-overview-reference
|
|
20
|
+
* @contractRole canonical
|
|
21
|
+
*/
|
|
22
|
+
export const SearchAiOverviewReferenceSchema = SearchAiOverviewReferenceSchemaDefinition;
|
|
23
|
+
//# sourceMappingURL=ai-overview-reference.js.map
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { z } from "zod/v4";
|
|
2
|
+
/**
|
|
3
|
+
* Google's AI Overview for a web search: its generated answer and the pages it cites
|
|
4
|
+
*
|
|
5
|
+
* @openapiSchema SearchAiOverview
|
|
6
|
+
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
7
|
+
* @endpoint POST /v1/web/search
|
|
8
|
+
* @usedBySchema WebSearchSchema
|
|
9
|
+
* @contractShape search.ai-overview
|
|
10
|
+
* @contractRole canonical
|
|
11
|
+
*/
|
|
12
|
+
export declare const SearchAiOverviewSchema: z.ZodObject<{
|
|
13
|
+
reference: z.ZodArray<z.ZodType<{
|
|
14
|
+
index: number;
|
|
15
|
+
snippet?: string | null | undefined;
|
|
16
|
+
source?: string | null | undefined;
|
|
17
|
+
title: string;
|
|
18
|
+
url: string;
|
|
19
|
+
}, import("./ai-overview-reference.ts").SearchAiOverviewReferenceSchemaInput, z.core.$ZodTypeInternals<{
|
|
20
|
+
index: number;
|
|
21
|
+
snippet?: string | null | undefined;
|
|
22
|
+
source?: string | null | undefined;
|
|
23
|
+
title: string;
|
|
24
|
+
url: string;
|
|
25
|
+
}, import("./ai-overview-reference.ts").SearchAiOverviewReferenceSchemaInput>>>;
|
|
26
|
+
text: z.ZodString;
|
|
27
|
+
}, z.core.$strip>;
|
|
28
|
+
export type SearchAiOverview = z.infer<typeof SearchAiOverviewSchema>;
|
|
29
|
+
//# sourceMappingURL=ai-overview.d.ts.map
|
|
@@ -0,0 +1,20 @@
|
|
|
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 { SearchAiOverviewReferenceSchema } from "./ai-overview-reference.js";
|
|
4
|
+
/**
|
|
5
|
+
* Google's AI Overview for a web search: its generated answer and the pages it cites
|
|
6
|
+
*
|
|
7
|
+
* @openapiSchema SearchAiOverview
|
|
8
|
+
* @endpoint GET /v1/web/searches/jobs/{jobId}
|
|
9
|
+
* @endpoint POST /v1/web/search
|
|
10
|
+
* @usedBySchema WebSearchSchema
|
|
11
|
+
* @contractShape search.ai-overview
|
|
12
|
+
* @contractRole canonical
|
|
13
|
+
*/
|
|
14
|
+
export const SearchAiOverviewSchema = z.object({
|
|
15
|
+
/** Pages the answer cites */
|
|
16
|
+
reference: z.array(SearchAiOverviewReferenceSchema),
|
|
17
|
+
/** Generated answer as Markdown in Google's block order; `[n]` cites the reference whose `index` is n */
|
|
18
|
+
text: z.string(),
|
|
19
|
+
});
|
|
20
|
+
//# sourceMappingURL=ai-overview.js.map
|
package/dist/search/search.d.ts
CHANGED
|
@@ -5,6 +5,7 @@ declare const SearchSchemaDefinition: z.ZodObject<{
|
|
|
5
5
|
cacheKey: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
6
6
|
catalogRevision: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
|
7
7
|
deep: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
8
|
+
deferredAiOverview: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
|
|
8
9
|
language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
9
10
|
region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
10
11
|
resultLimit: z.ZodOptional<z.ZodNullable<z.ZodInt>>;
|
package/dist/search/search.js
CHANGED
|
@@ -13,6 +13,8 @@ const SearchSchemaDefinition = z.object({
|
|
|
13
13
|
catalogRevision: z.int().nullish(),
|
|
14
14
|
/** Run Exa's slower, broader deep search instead of the default provider: higher recall for market and provider questions, about 3-6 s per search, answered synchronously (`Prefer: respond-async` does not apply). Charged like any search. */
|
|
15
15
|
deep: z.boolean().default(false).optional(),
|
|
16
|
+
/** Also fetch Google's AI Overview when Google defers it to a follow-up request, as it does for most company and person lookups: one extra SerpAPI search per overview not already stored, plus a fresh search first when the stored search is over an hour old (its one-minute overview token expired and SerpAPI's cache would return it unchanged). A fetch that returns no overview is not retried for six hours. An overview Google returns inline always comes back in `aiOverview` at no extra cost. Exa results never carry one. */
|
|
17
|
+
deferredAiOverview: z.boolean().default(false).optional(),
|
|
16
18
|
/** Search language code */
|
|
17
19
|
language: z.string().nullish(),
|
|
18
20
|
/** Search region code */
|
package/dist/web/search.d.ts
CHANGED
|
@@ -1,5 +1,21 @@
|
|
|
1
1
|
import { z } from "zod/v4";
|
|
2
2
|
declare const WebSearchSchemaDefinition: z.ZodObject<{
|
|
3
|
+
aiOverview: z.ZodOptional<z.ZodNullable<z.ZodObject<{
|
|
4
|
+
reference: z.ZodArray<z.ZodType<{
|
|
5
|
+
index: number;
|
|
6
|
+
snippet?: string | null | undefined;
|
|
7
|
+
source?: string | null | undefined;
|
|
8
|
+
title: string;
|
|
9
|
+
url: string;
|
|
10
|
+
}, import("../search/ai-overview-reference.ts").SearchAiOverviewReferenceSchemaInput, z.core.$ZodTypeInternals<{
|
|
11
|
+
index: number;
|
|
12
|
+
snippet?: string | null | undefined;
|
|
13
|
+
source?: string | null | undefined;
|
|
14
|
+
title: string;
|
|
15
|
+
url: string;
|
|
16
|
+
}, import("../search/ai-overview-reference.ts").SearchAiOverviewReferenceSchemaInput>>>;
|
|
17
|
+
text: z.ZodString;
|
|
18
|
+
}, z.core.$strip>>>;
|
|
3
19
|
document: z.ZodType<{
|
|
4
20
|
cacheHitCount: number;
|
|
5
21
|
createdAt: string;
|
|
@@ -48,6 +64,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
|
|
|
48
64
|
cacheKey?: string | null | undefined;
|
|
49
65
|
catalogRevision?: number | null | undefined;
|
|
50
66
|
deep?: boolean | undefined;
|
|
67
|
+
deferredAiOverview?: boolean | undefined;
|
|
51
68
|
language?: string | null | undefined;
|
|
52
69
|
region?: string | null | undefined;
|
|
53
70
|
resultLimit?: number | null | undefined;
|
|
@@ -65,6 +82,7 @@ declare const WebSearchSchemaDefinition: z.ZodObject<{
|
|
|
65
82
|
cacheKey?: string | null | undefined;
|
|
66
83
|
catalogRevision?: number | null | undefined;
|
|
67
84
|
deep?: boolean | undefined;
|
|
85
|
+
deferredAiOverview?: boolean | undefined;
|
|
68
86
|
language?: string | null | undefined;
|
|
69
87
|
region?: string | null | undefined;
|
|
70
88
|
resultLimit?: number | null | undefined;
|
package/dist/web/search.js
CHANGED
|
@@ -1,9 +1,12 @@
|
|
|
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
|
+
import { SearchAiOverviewSchema } from "../search/ai-overview.js";
|
|
3
4
|
import { SearchHitSchema } from "../search/hit.js";
|
|
4
5
|
import { SearchSchema } from "../search/search.js";
|
|
5
6
|
import { SourceDocumentListSchema } from "../source/document-list.js";
|
|
6
7
|
const WebSearchSchemaDefinition = z.object({
|
|
8
|
+
/** Google's AI Overview: returned whenever Google answers inline, or fetched on request with `deferredAiOverview`; null when Google produced none or deferred it unrequested */
|
|
9
|
+
aiOverview: SearchAiOverviewSchema.nullish(),
|
|
7
10
|
/** Source-document ledger row backing this result */
|
|
8
11
|
document: SourceDocumentListSchema,
|
|
9
12
|
/** Normalized result items in provider rank order */
|