@convex-dev/agent
Version:
A agent component for Convex.
735 lines • 1.36 MB
TypeScript
import type { Infer, Validator, Value } from "convex/values";
export declare const vProviderOptions: import("convex/values").VRecord<Record<string, Record<string, any>>, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "required", string>;
declare const providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
export type ProviderOptions = Infer<typeof providerOptions>;
export declare const vProviderMetadata: import("convex/values").VRecord<Record<string, Record<string, any>>, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "required", string>;
declare const providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
export type ProviderMetadata = Infer<typeof providerMetadata>;
export declare const vThreadStatus: import("convex/values").VUnion<"active" | "archived", [import("convex/values").VLiteral<"active", "required">, import("convex/values").VLiteral<"archived", "required">], "required", never>;
export declare const vMessageStatus: import("convex/values").VUnion<"pending" | "success" | "failed", [import("convex/values").VLiteral<"pending", "required">, import("convex/values").VLiteral<"success", "required">, import("convex/values").VLiteral<"failed", "required">], "required", never>;
export type MessageStatus = Infer<typeof vMessageStatus>;
export declare const vRole: import("convex/values").VUnion<"user" | "assistant" | "tool" | "system", [import("convex/values").VLiteral<"system", "required">, import("convex/values").VLiteral<"user", "required">, import("convex/values").VLiteral<"assistant", "required">, import("convex/values").VLiteral<"tool", "required">], "required", never>;
export declare const vTextPart: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
}, {
type: import("convex/values").VLiteral<"text", "required">;
text: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "text" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}`>;
export declare const vImagePart: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
type: "image";
image: string | ArrayBuffer;
}, {
type: import("convex/values").VLiteral<"image", "required">;
image: import("convex/values").VUnion<string | ArrayBuffer, [import("convex/values").VString<string, "required">, import("convex/values").VBytes<ArrayBuffer, "required">], "required", never>;
mediaType: import("convex/values").VString<string | undefined, "optional">;
/** @deprecated Use `mediaType` instead. */
mimeType: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "image" | "mediaType" | "mimeType">;
export declare const vFilePart: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
filename?: string | undefined;
type: "file";
data: string | ArrayBuffer;
}, {
type: import("convex/values").VLiteral<"file", "required">;
data: import("convex/values").VUnion<string | ArrayBuffer, [import("convex/values").VString<string, "required">, import("convex/values").VBytes<ArrayBuffer, "required">], "required", never>;
filename: import("convex/values").VString<string | undefined, "optional">;
mediaType: import("convex/values").VString<string | undefined, "optional">;
/** @deprecated Use `mediaType` instead. */
mimeType: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "mediaType" | "mimeType" | "data" | "filename">;
export declare const vUserContent: import("convex/values").VUnion<string | ({
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
type: "image";
image: string | ArrayBuffer;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
filename?: string | undefined;
type: "file";
data: string | ArrayBuffer;
})[], [import("convex/values").VString<string, "required">, import("convex/values").VArray<({
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
type: "image";
image: string | ArrayBuffer;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
filename?: string | undefined;
type: "file";
data: string | ArrayBuffer;
})[], import("convex/values").VUnion<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
type: "image";
image: string | ArrayBuffer;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
filename?: string | undefined;
type: "file";
data: string | ArrayBuffer;
}, [import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
}, {
type: import("convex/values").VLiteral<"text", "required">;
text: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "text" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}`>, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
type: "image";
image: string | ArrayBuffer;
}, {
type: import("convex/values").VLiteral<"image", "required">;
image: import("convex/values").VUnion<string | ArrayBuffer, [import("convex/values").VString<string, "required">, import("convex/values").VBytes<ArrayBuffer, "required">], "required", never>;
mediaType: import("convex/values").VString<string | undefined, "optional">;
/** @deprecated Use `mediaType` instead. */
mimeType: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "image" | "mediaType" | "mimeType">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
mediaType?: string | undefined;
mimeType?: string | undefined;
filename?: string | undefined;
type: "file";
data: string | ArrayBuffer;
}, {
type: import("convex/values").VLiteral<"file", "required">;
data: import("convex/values").VUnion<string | ArrayBuffer, [import("convex/values").VString<string, "required">, import("convex/values").VBytes<ArrayBuffer, "required">], "required", never>;
filename: import("convex/values").VString<string | undefined, "optional">;
mediaType: import("convex/values").VString<string | undefined, "optional">;
/** @deprecated Use `mediaType` instead. */
mimeType: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "mediaType" | "mimeType" | "data" | "filename">], "required", "type" | "providerOptions" | "text" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "image" | "mediaType" | "mimeType" | "data" | "filename">, "required">], "required", never>;
export declare const vReasoningPart: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
signature?: string | undefined;
type: "reasoning";
text: string;
}, {
type: import("convex/values").VLiteral<"reasoning", "required">;
text: import("convex/values").VString<string, "required">;
signature: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "text" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "signature">;
export declare const vRedactedReasoningPart: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "redacted-reasoning";
data: string;
}, {
type: import("convex/values").VLiteral<"redacted-reasoning", "required">;
data: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "data">;
export declare const vReasoningDetails: import("convex/values").VArray<({
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
signature?: string | undefined;
type: "reasoning";
text: string;
} | {
signature?: string | undefined;
type: "text";
text: string;
} | {
type: "redacted";
data: string;
})[], import("convex/values").VUnion<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
signature?: string | undefined;
type: "reasoning";
text: string;
} | {
signature?: string | undefined;
type: "text";
text: string;
} | {
type: "redacted";
data: string;
}, [import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
signature?: string | undefined;
type: "reasoning";
text: string;
}, {
type: import("convex/values").VLiteral<"reasoning", "required">;
text: import("convex/values").VString<string, "required">;
signature: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "text" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "signature">, import("convex/values").VObject<{
signature?: string | undefined;
type: "text";
text: string;
}, {
type: import("convex/values").VLiteral<"text", "required">;
text: import("convex/values").VString<string, "required">;
signature: import("convex/values").VString<string | undefined, "optional">;
}, "required", "type" | "text" | "signature">, import("convex/values").VObject<{
type: "redacted";
data: string;
}, {
type: import("convex/values").VLiteral<"redacted", "required">;
data: import("convex/values").VString<string, "required">;
}, "required", "type" | "data">], "required", "type" | "providerOptions" | "text" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "data" | "signature">, "required">;
export declare const vSourcePart: import("convex/values").VUnion<{
title?: string | undefined;
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
id: string;
type: "source";
url: string;
sourceType: "url";
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
id: string;
title: string;
type: "source";
mediaType: string;
sourceType: "document";
}, [import("convex/values").VObject<{
title?: string | undefined;
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
id: string;
type: "source";
url: string;
sourceType: "url";
}, {
type: import("convex/values").VLiteral<"source", "required">;
sourceType: import("convex/values").VLiteral<"url", "required">;
id: import("convex/values").VString<string, "required">;
url: import("convex/values").VString<string, "required">;
title: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "id" | "title" | "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "url" | "sourceType">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
id: string;
title: string;
type: "source";
mediaType: string;
sourceType: "document";
}, {
type: import("convex/values").VLiteral<"source", "required">;
sourceType: import("convex/values").VLiteral<"document", "required">;
id: import("convex/values").VString<string, "required">;
mediaType: import("convex/values").VString<string, "required">;
title: import("convex/values").VString<string, "required">;
filename: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "id" | "title" | "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "mediaType" | "filename" | "sourceType">], "required", "id" | "title" | "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "mediaType" | "filename" | "url" | "sourceType">;
export type SourcePart = Infer<typeof vSourcePart>;
export declare const vToolCallPart: import("convex/values").VUnion<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
args?: any;
providerExecuted?: boolean | undefined;
type: "tool-call";
toolCallId: string;
toolName: string;
input: any;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
input?: any;
providerExecuted?: boolean | undefined;
type: "tool-call";
toolCallId: string;
toolName: string;
args: any;
}, [import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
args?: any;
providerExecuted?: boolean | undefined;
type: "tool-call";
toolCallId: string;
toolName: string;
input: any;
}, {
type: import("convex/values").VLiteral<"tool-call", "required">;
toolCallId: import("convex/values").VString<string, "required">;
toolName: import("convex/values").VString<string, "required">;
input: import("convex/values").VAny<any, "required", string>;
/** @deprecated Use `input` instead. */
args: import("convex/values").VAny<any, "optional", string>;
providerExecuted: import("convex/values").VBoolean<boolean | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "toolCallId" | "toolName" | "input" | "args" | "providerExecuted" | `input.${string}` | `args.${string}`>, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
input?: any;
providerExecuted?: boolean | undefined;
type: "tool-call";
toolCallId: string;
toolName: string;
args: any;
}, {
type: import("convex/values").VLiteral<"tool-call", "required">;
toolCallId: import("convex/values").VString<string, "required">;
toolName: import("convex/values").VString<string, "required">;
/** @deprecated Use `input` instead. */
args: import("convex/values").VAny<any, "required", string>;
input: import("convex/values").VAny<any, "optional", string>;
providerExecuted: import("convex/values").VBoolean<boolean | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "toolCallId" | "toolName" | "input" | "args" | "providerExecuted" | `input.${string}` | `args.${string}`>], "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "toolCallId" | "toolName" | "input" | "args" | "providerExecuted" | `input.${string}` | `args.${string}`>;
export declare const vToolResultOutput: import("convex/values").VUnion<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
value: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "json";
value: any;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "error-text";
value: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "error-json";
value: any;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
reason?: string | undefined;
type: "execution-denied";
} | {
type: "content";
value: ({
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
type: "media";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
type: "file-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "custom";
})[];
}, [import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
value: string;
}, {
type: import("convex/values").VLiteral<"text", "required">;
value: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "value">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "json";
value: any;
}, {
type: import("convex/values").VLiteral<"json", "required">;
value: import("convex/values").VAny<any, "required", string>;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "value" | `value.${string}`>, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "error-text";
value: string;
}, {
type: import("convex/values").VLiteral<"error-text", "required">;
value: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "value">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "error-json";
value: any;
}, {
type: import("convex/values").VLiteral<"error-json", "required">;
value: import("convex/values").VAny<any, "required", string>;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "value" | `value.${string}`>, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
reason?: string | undefined;
type: "execution-denied";
}, {
type: import("convex/values").VLiteral<"execution-denied", "required">;
reason: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "reason">, import("convex/values").VObject<{
type: "content";
value: ({
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
type: "media";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
type: "file-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "custom";
})[];
}, {
type: import("convex/values").VLiteral<"content", "required">;
value: import("convex/values").VArray<({
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
type: "media";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
type: "file-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "custom";
})[], import("convex/values").VUnion<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
} | {
type: "media";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
type: "file-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-data";
mediaType: string;
data: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-url";
url: string;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-file-id";
fileId: string | Record<string, string>;
} | {
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "custom";
}, [import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "text";
text: string;
}, {
type: import("convex/values").VLiteral<"text", "required">;
text: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "text" | `providerOptions.${string}`>, import("convex/values").VObject<{
type: "media";
mediaType: string;
data: string;
}, {
type: import("convex/values").VLiteral<"media", "required">;
data: import("convex/values").VString<string, "required">;
mediaType: import("convex/values").VString<string, "required">;
}, "required", "type" | "mediaType" | "data">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
filename?: string | undefined;
type: "file-data";
mediaType: string;
data: string;
}, {
type: import("convex/values").VLiteral<"file-data", "required">;
/** Base-64 encoded */
data: import("convex/values").VString<string, "required">;
/**
* IANA media type.
* @see https://www.iana.org/assignments/media-types/media-types.xhtml
*/
mediaType: import("convex/values").VString<string, "required">;
filename: import("convex/values").VString<string | undefined, "optional">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "mediaType" | "data" | "filename">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-url";
url: string;
}, {
type: import("convex/values").VLiteral<"file-url", "required">;
url: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "url">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "file-id";
fileId: string | Record<string, string>;
}, {
type: import("convex/values").VLiteral<"file-id", "required">;
/**
* ID of the file.
*
* If you use multiple providers, you need to
* specify the provider specific ids using
* the Record option. The key is the provider
* name, e.g. 'openai' or 'anthropic'.
*/
fileId: import("convex/values").VUnion<string | Record<string, string>, [import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, string>, import("convex/values").VString<string, "required">, import("convex/values").VString<string, "required">, "required", string>], "required", string>;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "fileId" | `fileId.${string}`>, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-data";
mediaType: string;
data: string;
}, {
type: import("convex/values").VLiteral<"image-data", "required">;
data: import("convex/values").VString<string, "required">;
/**
* IANA media type.
* @see https://www.iana.org/assignments/media-types/media-types.xhtml
*/
mediaType: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "mediaType" | "data">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-url";
url: string;
}, {
type: import("convex/values").VLiteral<"image-url", "required">;
url: import("convex/values").VString<string, "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "url">, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "image-file-id";
fileId: string | Record<string, string>;
}, {
/**
* Images that are referenced using a provider file id.
*/
type: import("convex/values").VLiteral<"image-file-id", "required">;
/**
* Image that is referenced using a provider file id.
*
* If you use multiple providers, you need to
* specify the provider specific ids using
* the Record option. The key is the provider
* name, e.g. 'openai' or 'anthropic'.
*/
fileId: import("convex/values").VUnion<string | Record<string, string>, [import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, string>, import("convex/values").VString<string, "required">, import("convex/values").VString<string, "required">, "required", string>], "required", string>;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}` | "fileId" | `fileId.${string}`>, import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
type: "custom";
}, {
/**
* Custom content part. This can be used to implement
* provider-specific content parts.
*/
type: import("convex/values").VLiteral<"custom", "required">;
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | `providerOptions.${string}`>], "required", "type" | "providerOptions" | "text" | `providerOptions.${string}` | "mediaType" | "data" | "filename" | "url" | "fileId" | `fileId.${string}`>, "required">;
}, "required", "type" | "value">], "required", "type" | "providerOptions" | `providerOptions.${string}` | "value" | `value.${string}` | "reason">;
/**
* Tool approval request prompt part.
*/
export declare const vToolApprovalRequest: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
type: "tool-approval-request";
toolCallId: string;
approvalId: string;
}, {
type: import("convex/values").VLiteral<"tool-approval-request", "required">;
/**
* ID of the tool approval.
*/
approvalId: import("convex/values").VString<string, "required">;
/**
* ID of the tool call that the approval request is for.
*/
toolCallId: import("convex/values").VString<string, "required">;
/** @todo Should we continue to include? */
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
/** @todo Should we continue to include? */
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "toolCallId" | "approvalId">;
/**
* Tool approval response prompt part.
*/
export declare const vToolApprovalResponse: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
providerExecuted?: boolean | undefined;
reason?: string | undefined;
type: "tool-approval-response";
approvalId: string;
approved: boolean;
}, {
type: import("convex/values").VLiteral<"tool-approval-response", "required">;
/**
* ID of the tool approval.
*/
approvalId: import("convex/values").VString<string, "required">;
/**
* Flag indicating whether the approval was granted or denied.
*/
approved: import("convex/values").VBoolean<boolean, "required">;
/**
* Optional reason for the approval or denial.
*/
reason: import("convex/values").VString<string | undefined, "optional">;
/**
* Flag indicating whether the tool call is provider-executed.
* Only provider-executed tool approval responses should be sent to the model.
*/
providerExecuted: import("convex/values").VBoolean<boolean | undefined, "optional">;
/** @todo Should we continue to include? */
providerMetadata: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
/** @todo Should we continue to include? */
providerOptions: import("convex/values").VRecord<Record<string, Record<string, any>> | undefined, import("convex/values").VString<string, "required">, import("convex/values").VRecord<Record<string, any>, import("convex/values").VString<string, "required">, import("convex/values").VAny<any, "required", string>, "required", string>, "optional", string>;
}, "required", "type" | "providerOptions" | "providerMetadata" | `providerOptions.${string}` | `providerMetadata.${string}` | "providerExecuted" | "reason" | "approvalId" | "approved">;
export declare const vToolResultPart: import("convex/values").VObject<{
providerOptions?: Record<string, Record<string, any>> | undefined;
providerMetadata?: Record<string, Record<string, any>> | undefined;
args?: any;
providerExecuted?: boolean | undefined;
output?: {
providerOptions?: Record<string, Record