@convex-dev/agent 0.0.1-alpha.4 → 0.0.2

package/dist/esm/client/index.d.ts

@@ -1,11 +1,13 @@
 import type { EmbeddingModelV1, LanguageModelV1 } from "@ai-sdk/provider";
-import type { CoreMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, StepResult, StreamObjectResult, StreamTextResult, Tool, ToolChoice, ToolExecutionOptions, ToolSet } from "ai";
+import type { CoreMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, JSONValue, RepairTextFunction, StepResult, StreamObjectResult, StreamTextResult, TelemetrySettings, Tool, ToolChoice, ToolExecutionOptions, ToolSet, Message as UIMessage } from "ai";
 import { generateObject, generateText, streamObject, streamText } from "ai";
-import { api } from "../component/_generated/api";
-import { SearchOptions } from "../validators";
-import { RunActionCtx, RunMutationCtx, RunQueryCtx, UseApi } from "./types";
 import { ConvexToZod } from "convex-helpers/server/zod";
 import { Infer, Validator } from "convex/values";
+import { z } from "zod";
+import { api } from "../component/_generated/api";
+import { VectorDimension } from "../component/vector/tables";
+import { CallSettings, ProviderMetadata, ProviderOptions, SearchOptions } from "../validators";
+import { RunActionCtx, RunMutationCtx, RunQueryCtx, UseApi } from "./types";
 export type ContextOptions = {
     /**
      * Whether to include tool messages in the context.
@@ -50,10 +52,11 @@ export type ContextOptions = {
 };
 export type StorageOptions = {
     saveAllInputMessages?: boolean;
+    saveAnyInputMessages?: boolean;
     saveOutputMessages?: boolean;
 };
 export type GenerationOutputMetadata = {
-    messageId: string;
+    messageId?: string;
 };
 type CoreMessageMaybeWithId = CoreMessage & {
     id?: string | undefined;
@@ -62,7 +65,7 @@ export declare class Agent<AgentTools extends ToolSet> {
     component: UseApi<typeof api>;
     options: {
         name?: string;
-        thread: LanguageModelV1;
+        chat: LanguageModelV1;
         textEmbedding?: EmbeddingModelV1<string>;
         instructions?: string;
         tools?: AgentTools;
@@ -71,7 +74,7 @@ export declare class Agent<AgentTools extends ToolSet> {
     };
     constructor(component: UseApi<typeof api>, options: {
         name?: string;
-        thread: LanguageModelV1;
+        chat: LanguageModelV1;
         textEmbedding?: EmbeddingModelV1<string>;
         instructions?: string;
         tools?: AgentTools;
@@ -88,7 +91,7 @@ export declare class Agent<AgentTools extends ToolSet> {
      * @param args The thread metadata.
      * @returns The threadId of the new thread and the thread object.
      */
-    createThread(ctx: RunActionCtx, args: {
+    createThread(ctx: RunActionCtx, args?: {
         /**
          * The userId to associate with the thread. If not provided, the thread will be
          * anonymous.
@@ -121,7 +124,7 @@ export declare class Agent<AgentTools extends ToolSet> {
      * @param args The thread metadata.
      * @returns The threadId of the new thread.
      */
-    createThread(ctx: RunMutationCtx, args: {
+    createThread(ctx: RunMutationCtx, args?: {
         userId?: string;
         parentThreadIds?: string[];
         title?: string;
@@ -145,8 +148,13 @@ export declare class Agent<AgentTools extends ToolSet> {
         messages: CoreMessage[];
         parentMessageId?: string;
     } & ContextOptions): Promise<CoreMessage[]>;
+    getEmbeddings(messages: CoreMessage[]): Promise<{
+        vectors: (number[] | null)[];
+        dimension: VectorDimension;
+        model: string;
+    } | undefined>;
     saveMessages(ctx: RunMutationCtx, args: {
-        threadId?: string;
+        threadId: string;
         userId?: string;
         messages: CoreMessageMaybeWithId[];
         pending?: boolean;
@@ -191,40 +199,52 @@ export declare class Agent<AgentTools extends ToolSet> {
         userId?: string;
         threadId?: string;
     }, args: TextArgs<AgentTools, TOOLS, Parameters<typeof streamText<TOOLS, OUTPUT, PARTIAL_OUTPUT>>[0]>): Promise<StreamTextResult<TOOLS, PARTIAL_OUTPUT> & GenerationOutputMetadata>;
+    saveMessagesAndFetchContext<T extends {
+        prompt?: string;
+        messages?: CoreMessage[] | Omit<UIMessage, "id">[];
+        system?: string;
+    }>(ctx: RunActionCtx | RunMutationCtx, { userId, threadId, parentMessageId, saveAllInputMessages, system, ...args }: {
+        userId: string | undefined;
+        threadId: string | undefined;
+        parentMessageId?: string;
+        saveAllInputMessages?: boolean;
+        saveAnyInputMessages?: boolean;
+    } & ContextOptions & T): Promise<{
+        args: T;
+        messageId: string | undefined;
+    }>;
     generateObject<T>(ctx: RunActionCtx, { userId, threadId }: {
         userId?: string;
         threadId?: string;
-    }, args: Omit<Parameters<typeof generateObject>[0], "model"> & {
-        model?: LanguageModelV1;
-    } & {
-        parentMessageId?: string;
-    } & ContextOptions & StorageOptions): Promise<GenerateObjectResult<T> & GenerationOutputMetadata>;
+    }, args: OurObjectArgs<T>): Promise<GenerateObjectResult<T> & GenerationOutputMetadata>;
     streamObject<T>(ctx: RunMutationCtx, { userId, threadId }: {
         userId?: string;
         threadId?: string;
-    }, args: Omit<Parameters<typeof streamObject<T>>[0], "model"> & {
-        model?: LanguageModelV1;
-    } & {
-        parentMessageId?: string;
-    } & ContextOptions & StorageOptions): Promise<StreamObjectResult<DeepPartial<T>, T, never> & GenerationOutputMetadata>;
+    }, args: OurStreamObjectArgs<T>): Promise<StreamObjectResult<DeepPartial<T>, T, never> & GenerationOutputMetadata>;
+    saveObject(ctx: RunMutationCtx, args: {
+        threadId: string;
+        messageId: string;
+        result: GenerateObjectResult<unknown>;
+    }): Promise<void>;
     mergedContextOptions(opts: ContextOptions): ContextOptions;
     searchOptionsWithDefaults(contextOptions: ContextOptions, messages: CoreMessage[]): Promise<SearchOptions>;
     /**
      *
      */
-    asAction(spec: {
+    asAction(spec?: {
         contextOptions?: ContextOptions;
         maxSteps?: number;
     }): import("convex/server").RegisteredAction<"internal", {
         userId?: string | undefined;
         threadId?: string | undefined;
+        parentMessageId?: string | undefined;
+        maxRetries?: number | undefined;
         createThread?: {
-            title?: string | undefined;
             userId?: string | undefined;
+            title?: string | undefined;
             summary?: string | undefined;
             parentThreadIds?: string[] | undefined;
         } | undefined;
-        maxRetries?: number | undefined;
         contextOptions?: {
             includeToolCalls?: boolean | undefined;
             recentMessages?: number | undefined;
@@ -243,10 +263,6 @@ export declare class Agent<AgentTools extends ToolSet> {
             saveAllInputMessages?: boolean | undefined;
             saveAllOutputMessages?: boolean | undefined;
         } | undefined;
-        continueThread?: {
-            userId?: string | undefined;
-            threadId: string;
-        } | undefined;
         generateText?: {
             messages?: ({
                 providerOptions?: Record<string, any> | undefined;
@@ -331,7 +347,24 @@ export declare class Agent<AgentTools extends ToolSet> {
                 role: "system";
                 content: string;
             })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            toolChoice?: "required" | "auto" | "none" | {
+                type: "tool";
+                toolName: string;
+            } | undefined;
             maxSteps?: number | undefined;
+            experimental_continueSteps?: boolean | undefined;
             prompt?: string | undefined;
         } | undefined;
         streamText?: {
@@ -418,7 +451,24 @@ export declare class Agent<AgentTools extends ToolSet> {
                 role: "system";
                 content: string;
             })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            toolChoice?: "required" | "auto" | "none" | {
+                type: "tool";
+                toolName: string;
+            } | undefined;
             maxSteps?: number | undefined;
+            experimental_continueSteps?: boolean | undefined;
             prompt?: string | undefined;
         } | undefined;
         generateObject?: {
@@ -505,11 +555,25 @@ export declare class Agent<AgentTools extends ToolSet> {
                 role: "system";
                 content: string;
             })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
             prompt?: string | undefined;
-            output?: any;
-            mode?: "json" | undefined;
-        } | undefined;
-        streamObject?: {
+            output?: "object" | undefined;
+            schemaName?: string | undefined;
+            schemaDescription?: string | undefined;
+            mode?: "tool" | "auto" | "json" | undefined;
+            schema: any;
+        } | {
             messages?: ({
                 providerOptions?: Record<string, any> | undefined;
                 experimental_providerMetadata?: Record<string, any> | undefined;
@@ -593,65 +657,717 @@ export declare class Agent<AgentTools extends ToolSet> {
                 role: "system";
                 content: string;
             })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
             prompt?: string | undefined;
-            output?: any;
-            mode?: "json" | undefined;
+            output?: "array" | undefined;
+            schemaName?: string | undefined;
+            schemaDescription?: string | undefined;
+            mode?: "tool" | "auto" | "json" | undefined;
             schema: any;
+        } | {
+            messages?: ({
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "user";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    mimeType?: string | undefined;
+                    type: "image";
+                    image: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "assistant";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "reasoning";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "redacted-reasoning";
+                    data: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "tool-call";
+                    toolCallId: string;
+                    toolName: string;
+                    args: any;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "tool";
+                content: {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    args?: any;
+                    experimental_content?: ({
+                        type: "text";
+                        text: string;
+                    } | {
+                        mimeType?: string | undefined;
+                        type: "image";
+                        data: string;
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    type: "tool-result";
+                    toolCallId: string;
+                    toolName: string;
+                    result: any;
+                }[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "system";
+                content: string;
+            })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            prompt?: string | undefined;
+            output?: "enum" | undefined;
+            mode?: "tool" | "auto" | "json" | undefined;
+            enum: string[];
+        } | {
+            messages?: ({
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "user";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    mimeType?: string | undefined;
+                    type: "image";
+                    image: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "assistant";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "reasoning";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "redacted-reasoning";
+                    data: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "tool-call";
+                    toolCallId: string;
+                    toolName: string;
+                    args: any;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "tool";
+                content: {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    args?: any;
+                    experimental_content?: ({
+                        type: "text";
+                        text: string;
+                    } | {
+                        mimeType?: string | undefined;
+                        type: "image";
+                        data: string;
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    type: "tool-result";
+                    toolCallId: string;
+                    toolName: string;
+                    result: any;
+                }[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "system";
+                content: string;
+            })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            prompt?: string | undefined;
+            mode?: "json" | undefined;
+            output: "no-schema";
         } | undefined;
-    }, Promise<any>>;
-    /**
-     * Create a tool that can call this agent.
-     * @param spec The specification for the arguments to this agent.
-     *   They will be encoded as JSON and passed to the agent.
-     * @returns The agent as a tool that can be passed to other agents.
-     */
-    asTool(spec: {
-        description: string;
-        args: Validator<unknown, "required", string>;
-        contextOptions?: ContextOptions;
-        maxSteps?: number;
-    }): Tool<ConvexToZod<Validator<unknown, "required", string>>, string>;
-}
-export type ToolCtx = RunActionCtx & {
-    userId?: string;
-    threadId?: string;
-    messageId?: string;
-};
-/**
- * This is a wrapper around the ai.tool function that adds support for
- * userId and threadId to the tool, if they're called within a thread from an agent.
- * @param tool The AI tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
- * @returns The same tool, but with userId and threadId args support added.
- */
-export declare function createTool<V extends Validator<any, any, any>, RESULT>(convexTool: {
-    args: V;
-    description?: string;
-    handler: (ctx: ToolCtx, args: Infer<V>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
-    ctx?: ToolCtx;
-}): Tool<ConvexToZod<V>, RESULT>;
-type TextArgs<AgentTools extends ToolSet, TOOLS extends ToolSet, T extends {
-    toolChoice?: ToolChoice<TOOLS & AgentTools>;
-    tools?: TOOLS;
-    model: LanguageModelV1;
-}> = Omit<T, "toolChoice" | "tools" | "model"> & {
-    model?: LanguageModelV1;
-    parentMessageId?: string;
-} & {
-    tools?: TOOLS;
-    toolChoice?: ToolChoice<{
-        [key in keyof TOOLS | keyof AgentTools]: unknown;
-    }>;
-} & ContextOptions & StorageOptions;
-type ObjectArgs<T extends {
-    model: LanguageModelV1;
-}> = Omit<T, "model"> & {
-    model?: LanguageModelV1;
-} & ContextOptions & StorageOptions;
+        streamObject?: {
+            messages?: ({
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "user";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    mimeType?: string | undefined;
+                    type: "image";
+                    image: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "assistant";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "reasoning";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "redacted-reasoning";
+                    data: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "tool-call";
+                    toolCallId: string;
+                    toolName: string;
+                    args: any;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "tool";
+                content: {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    args?: any;
+                    experimental_content?: ({
+                        type: "text";
+                        text: string;
+                    } | {
+                        mimeType?: string | undefined;
+                        type: "image";
+                        data: string;
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    type: "tool-result";
+                    toolCallId: string;
+                    toolName: string;
+                    result: any;
+                }[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "system";
+                content: string;
+            })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            prompt?: string | undefined;
+            output?: "object" | undefined;
+            schemaName?: string | undefined;
+            schemaDescription?: string | undefined;
+            mode?: "tool" | "auto" | "json" | undefined;
+            schema: any;
+        } | {
+            messages?: ({
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "user";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    mimeType?: string | undefined;
+                    type: "image";
+                    image: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "assistant";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "reasoning";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "redacted-reasoning";
+                    data: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "tool-call";
+                    toolCallId: string;
+                    toolName: string;
+                    args: any;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "tool";
+                content: {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    args?: any;
+                    experimental_content?: ({
+                        type: "text";
+                        text: string;
+                    } | {
+                        mimeType?: string | undefined;
+                        type: "image";
+                        data: string;
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    type: "tool-result";
+                    toolCallId: string;
+                    toolName: string;
+                    result: any;
+                }[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "system";
+                content: string;
+            })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            prompt?: string | undefined;
+            output?: "array" | undefined;
+            schemaName?: string | undefined;
+            schemaDescription?: string | undefined;
+            mode?: "tool" | "auto" | "json" | undefined;
+            schema: any;
+        } | {
+            messages?: ({
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "user";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    mimeType?: string | undefined;
+                    type: "image";
+                    image: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "assistant";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "reasoning";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "redacted-reasoning";
+                    data: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "tool-call";
+                    toolCallId: string;
+                    toolName: string;
+                    args: any;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "tool";
+                content: {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    args?: any;
+                    experimental_content?: ({
+                        type: "text";
+                        text: string;
+                    } | {
+                        mimeType?: string | undefined;
+                        type: "image";
+                        data: string;
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    type: "tool-result";
+                    toolCallId: string;
+                    toolName: string;
+                    result: any;
+                }[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "system";
+                content: string;
+            })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            prompt?: string | undefined;
+            output?: "enum" | undefined;
+            mode?: "tool" | "auto" | "json" | undefined;
+            enum: string[];
+        } | {
+            messages?: ({
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "user";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    mimeType?: string | undefined;
+                    type: "image";
+                    image: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "assistant";
+                content: string | ({
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "text";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "file";
+                    mimeType: string;
+                    data: string | ArrayBuffer;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "reasoning";
+                    text: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "redacted-reasoning";
+                    data: string;
+                } | {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    type: "tool-call";
+                    toolCallId: string;
+                    toolName: string;
+                    args: any;
+                })[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "tool";
+                content: {
+                    providerOptions?: Record<string, any> | undefined;
+                    experimental_providerMetadata?: Record<string, any> | undefined;
+                    args?: any;
+                    experimental_content?: ({
+                        type: "text";
+                        text: string;
+                    } | {
+                        mimeType?: string | undefined;
+                        type: "image";
+                        data: string;
+                    })[] | undefined;
+                    isError?: boolean | undefined;
+                    type: "tool-result";
+                    toolCallId: string;
+                    toolName: string;
+                    result: any;
+                }[];
+            } | {
+                providerOptions?: Record<string, any> | undefined;
+                experimental_providerMetadata?: Record<string, any> | undefined;
+                role: "system";
+                content: string;
+            })[] | undefined;
+            providerOptions?: Record<string, any> | undefined;
+            experimental_providerMetadata?: Record<string, any> | undefined;
+            system?: string | undefined;
+            headers?: Record<string, string> | undefined;
+            maxTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+            prompt?: string | undefined;
+            mode?: "json" | undefined;
+            output: "no-schema";
+        } | undefined;
+    }, Promise<any>>;
+    /**
+     * Create a tool that can call this agent.
+     * @param spec The specification for the arguments to this agent.
+     *   They will be encoded as JSON and passed to the agent.
+     * @returns The agent as a tool that can be passed to other agents.
+     */
+    asTool(spec: {
+        description: string;
+        args: Validator<unknown, "required", string>;
+        contextOptions?: ContextOptions;
+        maxSteps?: number;
+    }): Tool<ConvexToZod<Validator<unknown, "required", string>>, string>;
+}
+export type ToolCtx = RunActionCtx & {
+    userId?: string;
+    threadId?: string;
+    messageId?: string;
+};
+/**
+ * This is a wrapper around the ai.tool function that adds support for
+ * userId and threadId to the tool, if they're called within a thread from an agent.
+ * @param tool The AI tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
+ * @returns The same tool, but with userId and threadId args support added.
+ */
+export declare function createTool<V extends Validator<any, any, any>, RESULT>(convexTool: {
+    args: V;
+    description?: string;
+    handler: (ctx: ToolCtx, args: Infer<V>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+    ctx?: ToolCtx;
+}): Tool<ConvexToZod<V>, RESULT>;
+type TextArgs<AgentTools extends ToolSet, TOOLS extends ToolSet, T extends {
+    toolChoice?: ToolChoice<TOOLS & AgentTools>;
+    tools?: TOOLS;
+    model: LanguageModelV1;
+}> = Omit<T, "toolChoice" | "tools" | "model"> & {
+    model?: LanguageModelV1;
+    parentMessageId?: string;
+} & {
+    tools?: TOOLS;
+    toolChoice?: ToolChoice<{
+        [key in keyof TOOLS | keyof AgentTools]: unknown;
+    }>;
+} & ContextOptions & StorageOptions;
+type BaseGenerateObjectOptions = StorageOptions & ContextOptions & CallSettings & {
+    model?: LanguageModelV1;
+    parentMessageId?: string;
+    system?: string;
+    prompt?: string;
+    messages?: CoreMessage[];
+    experimental_repairText?: RepairTextFunction;
+    experimental_telemetry?: TelemetrySettings;
+    providerOptions?: ProviderOptions;
+    experimental_providerMetadata?: ProviderMetadata;
+};
+type GenerateObjectObjectOptions<T extends Record<string, unknown>> = BaseGenerateObjectOptions & {
+    output: "object";
+    mode?: "auto" | "json" | "tool";
+    schema: z.Schema<T>;
+    schemaName?: string;
+    schemaDescription?: string;
+};
+type GenerateObjectArrayOptions<T> = BaseGenerateObjectOptions & {
+    output: "array";
+    mode?: "auto" | "json" | "tool";
+    schema: z.Schema<T>;
+    schemaName?: string;
+    schemaDescription?: string;
+};
+type GenerateObjectWithEnumOptions<T extends string> = BaseGenerateObjectOptions & {
+    output: "enum";
+    enum: Array<T>;
+    mode?: "auto" | "json" | "tool";
+};
+type GenerateObjectNoSchemaOptions = BaseGenerateObjectOptions & {
+    schema?: undefined;
+    mode?: "json";
+};
+type GenerateObjectArgs<T> = T extends Record<string, unknown> ? GenerateObjectObjectOptions<T> : T extends Array<unknown> ? GenerateObjectArrayOptions<T> : T extends string ? GenerateObjectWithEnumOptions<T> : GenerateObjectNoSchemaOptions;
+type StreamObjectArgs<T> = T extends Record<string, unknown> ? GenerateObjectObjectOptions<T> : T extends Array<unknown> ? GenerateObjectArrayOptions<T> : GenerateObjectNoSchemaOptions;
+type OurObjectArgs<T> = GenerateObjectArgs<T> & Pick<Parameters<typeof generateObject<any>>[0], "experimental_repairText" | "abortSignal">;
+type OurStreamObjectArgs<T> = StreamObjectArgs<T> & Pick<Parameters<typeof streamObject<T>>[0], "onError" | "onFinish" | "abortSignal">;
 interface Thread<AgentTools extends ToolSet> {
+    threadId: string;
     generateText<TOOLS extends ToolSet, OUTPUT = never, OUTPUT_PARTIAL = never>(args: TextArgs<AgentTools, TOOLS, Parameters<typeof generateText<TOOLS, OUTPUT, OUTPUT_PARTIAL>>[0]>): Promise<GenerateTextResult<TOOLS & AgentTools, OUTPUT> & GenerationOutputMetadata>;
     streamText<TOOLS extends ToolSet, OUTPUT = never, PARTIAL_OUTPUT = never>(args: TextArgs<AgentTools, TOOLS, Parameters<typeof streamText<TOOLS, OUTPUT, PARTIAL_OUTPUT>>[0]>): Promise<StreamTextResult<TOOLS & AgentTools, PARTIAL_OUTPUT> & GenerationOutputMetadata>;
-    generateObject<T>(args: ObjectArgs<Parameters<typeof generateObject>[0]>): Promise<GenerateObjectResult<T> & GenerationOutputMetadata>;
-    streamObject<T>(args: ObjectArgs<Parameters<typeof streamObject<T>>[0]>): Promise<StreamObjectResult<DeepPartial<T>, T, never> & GenerationOutputMetadata>;
+    generateObject<T>(args: OurObjectArgs<T>): Promise<GenerateObjectResult<T> & GenerationOutputMetadata>;
+    generateObject(args: GenerateObjectNoSchemaOptions): Promise<GenerateObjectResult<JSONValue> & GenerationOutputMetadata>;
+    streamObject<T>(args: OurStreamObjectArgs<T>): Promise<StreamObjectResult<DeepPartial<T>, T, never> & GenerationOutputMetadata>;
 }
 export {};
 //# sourceMappingURL=index.d.ts.map