@convex-dev/agent 0.1.18 → 0.2.0-alpha.2

package/dist/client/index.d.ts

@@ -1,25 +1,27 @@
-import type { EmbeddingModelV1, LanguageModelV1 } from "@ai-sdk/provider";
-import type { CoreMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, StepResult, StreamObjectResult, StreamTextResult, ToolSet } from "ai";
+import type { LanguageModelV2 } from "@ai-sdk/provider";
+import type { ModelMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, StepResult, StreamObjectResult, StreamTextResult, ToolSet, StopCondition, Schema, LanguageModel, EmbeddingModel, CallSettings } from "ai";
 import { type GenericActionCtx, type GenericDataModel, type PaginationOptions, type PaginationResult } from "convex/server";
 import type { MessageDoc, ThreadDoc } from "../component/schema.js";
 import type { threadFieldsSupportingPatch } from "../component/threads.js";
 import { type VectorDimension } from "../component/vector/tables.js";
-import { type AIMessageWithoutId } from "../mapping.js";
 import { extractText, isTool } from "../shared.js";
-import { type MessageEmbeddings, type MessageStatus, type MessageWithMetadata, type ProviderMetadata, type StreamArgs, type Usage } from "../validators.js";
+import { type Message, type MessageStatus, type MessageWithMetadata, type ProviderMetadata, type StreamArgs, type Usage } from "../validators.js";
 import { createTool } from "./createTool.js";
-import { listMessages } from "./listMessages.js";
-import { fetchContextMessages } from "./search.js";
-import { type StreamingOptions, syncStreams } from "./streaming.js";
+import { type SaveMessageArgs, type SaveMessagesArgs } from "./messages.js";
+import { type StreamingOptions } from "./streaming.js";
 import type { ActionCtx, AgentComponent, ContextOptions, GenerationOutputMetadata, Options, OurObjectArgs, OurStreamObjectArgs, RawRequestResponseHandler, RunActionCtx, RunMutationCtx, RunQueryCtx, StorageOptions, StreamingTextArgs, SyncStreamsReturnValue, TextArgs, Thread, UsageHandler } from "./types.js";
+import type z from "zod/v3";
+export { stepCountIs } from "ai";
 export { vMessageDoc, vThreadDoc } from "../component/schema.js";
-export { serializeDataOrUrl } from "../mapping.js";
+export { serializeDataOrUrl, deserializeMessage, serializeMessage, } from "../mapping.js";
 export { vAssistantMessage, vContextOptions, vMessage, vPaginationResult, vProviderMetadata, vStorageOptions, vStreamArgs, vSystemMessage, vToolMessage, vUsage, vUserMessage, } from "../validators.js";
 export type { ToolCtx } from "./createTool.js";
 export { getFile, storeFile } from "./files.js";
-export { filterOutOrphanedToolMessages } from "./search.js";
-export { abortStream, listStreams } from "./streaming.js";
-export { createTool, extractText, fetchContextMessages, isTool, listMessages, syncStreams, };
+export { filterOutOrphanedToolMessages, fetchContextMessages, } from "./search.js";
+export { abortStream, listStreams, syncStreams } from "./streaming.js";
+export { listMessages, saveMessage, saveMessages, type SaveMessageArgs, type SaveMessagesArgs, } from "./messages.js";
+export { createThread, getThreadMetadata } from "./threads.js";
+export { createTool, extractText, isTool };
 export { definePlaygroundAPI, type PlaygroundAPI, type AgentsFn, } from "./definePlaygroundAPI.js";
 export type { AgentComponent, ContextOptions, MessageDoc, ProviderMetadata, RawRequestResponseHandler, StorageOptions, StreamArgs, SyncStreamsReturnValue, Thread, ThreadDoc, Usage, UsageHandler, };
 export declare class Agent<
@@ -57,7 +59,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
          * const myAgent = new Agent(components.agent, {
          *   chat: openai.chat("gpt-4o-mini"),
          */
-        chat: LanguageModelV1;
+        chat: LanguageModel;
         /**
          * The model to use for text embeddings. Optional.
          * If specified, it will use this for generating vector embeddings
@@ -68,7 +70,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
          * const myAgent = new Agent(components.agent, {
          *   textEmbedding: openai.embedding("text-embedding-3-small")
          */
-        textEmbedding?: EmbeddingModelV1<string>;
+        textEmbedding?: EmbeddingModel<string>;
         /**
          * The default system prompt to put in each request.
          * Override per-prompt by passing the "system" parameter.
@@ -94,14 +96,15 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         storageOptions?: StorageOptions;
         /**
          * When generating or streaming text with tools available, this
-         * determines the default max number of iterations.
+         * determines when to stop. Defaults to stepCountIs(1).
          */
-        maxSteps?: number;
+        stopWhen?: StopCondition<AgentTools> | Array<StopCondition<AgentTools>>;
         /**
-         * The maximum number of calls to make to an LLM in case it fails.
-         * This can be overridden at each generate/stream callsite.
+         * The default settings to use for the LLM calls.
+         * This can be overridden at each generate/stream callsite on a per-field
+         * basis. To clear a default setting, you'll need to pass `undefined`.
          */
-        maxRetries?: number;
+        callSettings?: CallSettings;
         /**
          * The usage handler to use for this agent.
          */
@@ -125,7 +128,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
          * const myAgent = new Agent(components.agent, {
          *   chat: openai.chat("gpt-4o-mini"),
          */
-        chat: LanguageModelV1;
+        chat: LanguageModel;
         /**
          * The model to use for text embeddings. Optional.
          * If specified, it will use this for generating vector embeddings
@@ -136,7 +139,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
          * const myAgent = new Agent(components.agent, {
          *   textEmbedding: openai.embedding("text-embedding-3-small")
          */
-        textEmbedding?: EmbeddingModelV1<string>;
+        textEmbedding?: EmbeddingModel<string>;
         /**
          * The default system prompt to put in each request.
          * Override per-prompt by passing the "system" parameter.
@@ -162,14 +165,15 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         storageOptions?: StorageOptions;
         /**
          * When generating or streaming text with tools available, this
-         * determines the default max number of iterations.
+         * determines when to stop. Defaults to stepCountIs(1).
          */
-        maxSteps?: number;
+        stopWhen?: StopCondition<AgentTools> | Array<StopCondition<AgentTools>>;
         /**
-         * The maximum number of calls to make to an LLM in case it fails.
-         * This can be overridden at each generate/stream callsite.
+         * The default settings to use for the LLM calls.
+         * This can be overridden at each generate/stream callsite on a per-field
+         * basis. To clear a default setting, you'll need to pass `undefined`.
          */
-        maxRetries?: number;
+        callSettings?: CallSettings;
         /**
          * The usage handler to use for this agent.
          */
@@ -285,16 +289,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
     }): Promise<{
         thread: Thread<ThreadTools extends undefined ? AgentTools : ThreadTools>;
     }>;
-    /**
-     * Search for threads by title, paginated.
-     * @param ctx The context passed from the query/mutation/action.
-     * @returns The threads matching the search, paginated.
-     */
-    searchThreadTitles(ctx: RunQueryCtx, { userId, query, limit, }: {
-        userId?: string | undefined;
-        query: string;
-        limit?: number;
-    }): Promise<ThreadDoc[]>;
     /**
      * This behaves like {@link generateText} from the "ai" package except that
      * it add context based on the userId and threadId and saves the input and
@@ -382,7 +376,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
      * Use {@link continueThread} to get a version of this function already scoped
      * to a thread (and optionally userId).
      */
-    streamObject<T>(ctx: ActionCtx, { userId: argsUserId, threadId, ...usageHandler }: {
+    streamObject<T extends z.Schema | Schema>(ctx: ActionCtx, { userId: argsUserId, threadId, ...usageHandler }: {
         userId?: string | null;
         threadId?: string;
         usageHandler?: UsageHandler;
@@ -458,6 +452,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     signature?: string | undefined;
+                    state?: "streaming" | "done" | undefined;
                     type: "reasoning";
                     text: string;
                 } | {
@@ -466,6 +461,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                     data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
+                    providerExecuted?: boolean | undefined;
                     type: "tool-call";
                     toolCallId: string;
                     toolName: string;
@@ -477,6 +473,8 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                 content: {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     args?: any;
+                    providerExecuted?: boolean | undefined;
+                    isError?: boolean | undefined;
                     experimental_content?: ({
                         type: "text";
                         text: string;
@@ -485,7 +483,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                         type: "image";
                         data: string;
                     })[] | undefined;
-                    isError?: boolean | undefined;
                     type: "tool-result";
                     toolCallId: string;
                     toolName: string;
@@ -499,19 +496,36 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             text?: string | undefined;
             reasoning?: string | undefined;
             usage?: {
+                reasoningTokens?: number | undefined;
+                cachedInputTokens?: number | undefined;
                 promptTokens: number;
                 completionTokens: number;
                 totalTokens: number;
             } | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
-            sources?: {
+            sources?: ({
                 title?: string | undefined;
+                type?: "source" | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                url?: string | undefined;
                 id: string;
                 sourceType: "url";
-                url: string;
-            }[] | undefined;
+            } | {
+                filename?: string | undefined;
+                providerMetadata?: Record<string, Record<string, any>> | undefined;
+                id: string;
+                title: string;
+                type: "source";
+                sourceType: "document";
+                mediaType: string;
+            })[] | undefined;
             reasoningDetails?: ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
+                type: "reasoning";
+                text: string;
+            } | {
                 signature?: string | undefined;
                 type: "text";
                 text: string;
@@ -558,7 +572,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
          */
         skipEmbeddings?: boolean;
     }): Promise<{
-        lastMessageId: string;
         messages: MessageDoc[];
     }>;
     /**
@@ -601,7 +614,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
     fetchContextMessages(ctx: RunQueryCtx | RunActionCtx, args: {
         userId: string | undefined;
         threadId: string | undefined;
-        messages: CoreMessage[];
+        messages: (ModelMessage | Message)[];
         /**
          * If provided, it will search for messages up to and including this message.
          * Note: if this is far in the past, text and vector search results may be more
@@ -638,7 +651,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
     generateEmbeddings(ctx: RunActionCtx, { userId, threadId, }: {
         userId: string | undefined;
         threadId: string | undefined;
-    }, messages: CoreMessage[]): Promise<{
+    }, messages: (ModelMessage | Message)[]): Promise<{
         vectors: (number[] | null)[];
         dimension: VectorDimension;
         model: string;
@@ -682,7 +695,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         provider?: string;
     }): Promise<{
         messages: MessageDoc[];
-        pending?: MessageDoc;
     }>;
     /**
      * Manually save the result of a generateObject call to the thread.
@@ -699,7 +711,9 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         provider: string | undefined;
         result: GenerateObjectResult<unknown>;
         metadata?: Omit<MessageWithMetadata, "message">;
-    }): Promise<void>;
+    }): Promise<{
+        messages: MessageDoc[];
+    }>;
     /**
      * Commit or rollback a message that was pending.
      * This is done automatically when saving messages by default.
@@ -728,9 +742,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         messageId: string;
         patch: {
             /** The message to replace the existing message. */
-            message: CoreMessage & {
-                id?: string;
-            };
+            message: ModelMessage | Message;
             /** The status to set on the message. */
             status: "success" | "error";
             /** The error message to set on the message. */
@@ -838,23 +850,23 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
     }): Promise<void>;
     _saveMessagesAndFetchContext<T extends {
         id?: string;
-        prompt?: string;
-        messages?: CoreMessage[] | AIMessageWithoutId[];
+        prompt?: string | (ModelMessage | Message)[];
+        messages?: (ModelMessage | Message)[];
         system?: string;
         promptMessageId?: string;
-        model?: LanguageModelV1;
-        maxRetries?: number;
+        model?: LanguageModelV2;
     }>(ctx: RunActionCtx, args: T, { userId: argsUserId, threadId, contextOptions, storageOptions, }: {
         userId: string | undefined;
         threadId: string | undefined;
     } & Options): Promise<{
         args: T & {
-            model: LanguageModelV1;
+            model: LanguageModelV2;
         };
         userId: string | undefined;
         messageId: string | undefined;
         order: number | undefined;
         stepOrder: number | undefined;
+        savedMessages: MessageDoc[] | undefined;
     }>;
     doEmbed(ctx: RunActionCtx, options: {
         userId: string | undefined;
@@ -911,14 +923,14 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
      * Create an action out of this agent so you can call it from workflows or other actions
      * without a wrapping function.
      * @param spec Configuration for the agent acting as an action, including
-     *   {@link ContextOptions}, {@link StorageOptions}, and maxSteps.
+     *   {@link ContextOptions}, {@link StorageOptions}, and {@link stopWhen}.
      */
     asTextAction<DataModel extends GenericDataModel>(spec?: {
         /**
-         * The maximum number of steps to take in this action.
-         * Defaults to the {@link Agent.maxSteps} option.
+         * When to stop generating text.
+         * Defaults to the {@link Agent["options"].stopWhen} option.
          */
-        maxSteps?: number;
+        stopWhen?: StopCondition<AgentTools> | Array<StopCondition<AgentTools>>;
         /**
          * The {@link ContextOptions} to use for fetching contextual messages and
          * saving input/output messages.
@@ -1001,6 +1013,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
                 type: "reasoning";
                 text: string;
             } | {
@@ -1009,6 +1022,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                 data: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                providerExecuted?: boolean | undefined;
                 type: "tool-call";
                 toolCallId: string;
                 toolName: string;
@@ -1020,6 +1034,8 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             content: {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 args?: any;
+                providerExecuted?: boolean | undefined;
+                isError?: boolean | undefined;
                 experimental_content?: ({
                     type: "text";
                     text: string;
@@ -1028,7 +1044,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                     type: "image";
                     data: string;
                 })[] | undefined;
-                isError?: boolean | undefined;
                 type: "tool-result";
                 toolCallId: string;
                 toolName: string;
@@ -1039,15 +1054,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             role: "system";
             content: 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;
         stream?: boolean | undefined;
         toolChoice?: "required" | "none" | "auto" | {
             type: "tool";
@@ -1075,29 +1081,39 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         storageOptions?: {
             saveMessages?: "all" | "none" | "promptAndOutput" | undefined;
         } | undefined;
+        callSettings?: {
+            headers?: Record<string, string> | undefined;
+            maxOutputTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            stopSequences?: string[] | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+        } | undefined;
     }, Promise<{
         text: string;
         messageId: string | undefined;
         order: number | undefined;
-        finishReason: import("@ai-sdk/provider").LanguageModelV1FinishReason;
-        warnings: Promise<import("@ai-sdk/provider").LanguageModelV1CallWarning[] | undefined>;
+        finishReason: import("@ai-sdk/provider").LanguageModelV2FinishReason;
+        warnings: Promise<import("@ai-sdk/provider").LanguageModelV2CallWarning[] | undefined>;
     } | {
         text: string;
         messageId: string | undefined;
         order: number | undefined;
-        finishReason: import("@ai-sdk/provider").LanguageModelV1FinishReason;
-        warnings: import("@ai-sdk/provider").LanguageModelV1CallWarning[] | undefined;
+        finishReason: import("@ai-sdk/provider").LanguageModelV2FinishReason;
+        warnings: import("@ai-sdk/provider").LanguageModelV2CallWarning[] | undefined;
     }>>;
     /**
      * Create an action that generates an object out of this agent so you can call
      * it from workflows or other actions without a wrapping function.
      * @param spec Configuration for the agent acting as an action, including
      * the normal parameters to {@link generateObject}, plus {@link ContextOptions}
-     * and maxSteps.
+     * and stopWhen.
      */
-    asObjectAction<T>(spec: OurObjectArgs<T> & {
-        maxSteps?: number;
-    }, options?: {
+    asObjectAction<T>(spec: OurObjectArgs<T>, options?: {
         contextOptions?: ContextOptions;
         storageOptions?: StorageOptions;
     }): import("convex/server").RegisteredAction<"internal", {
@@ -1140,6 +1156,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
                 type: "reasoning";
                 text: string;
             } | {
@@ -1148,6 +1165,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                 data: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                providerExecuted?: boolean | undefined;
                 type: "tool-call";
                 toolCallId: string;
                 toolName: string;
@@ -1159,6 +1177,8 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             content: {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 args?: any;
+                providerExecuted?: boolean | undefined;
+                isError?: boolean | undefined;
                 experimental_content?: ({
                     type: "text";
                     text: string;
@@ -1167,7 +1187,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                     type: "image";
                     data: string;
                 })[] | undefined;
-                isError?: boolean | undefined;
                 type: "tool-result";
                 toolCallId: string;
                 toolName: string;
@@ -1178,15 +1197,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             role: "system";
             content: 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;
         promptMessageId?: string | undefined;
         contextOptions?: {
@@ -1207,12 +1217,24 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         storageOptions?: {
             saveMessages?: "all" | "none" | "promptAndOutput" | undefined;
         } | undefined;
+        callSettings?: {
+            headers?: Record<string, string> | undefined;
+            maxOutputTokens?: number | undefined;
+            temperature?: number | undefined;
+            topP?: number | undefined;
+            topK?: number | undefined;
+            presencePenalty?: number | undefined;
+            frequencyPenalty?: number | undefined;
+            stopSequences?: string[] | undefined;
+            seed?: number | undefined;
+            maxRetries?: number | undefined;
+        } | undefined;
     }, Promise<{
         object: T;
         messageId: string | undefined;
         order: number | undefined;
-        finishReason: import("@ai-sdk/provider").LanguageModelV1FinishReason;
-        warnings: import("@ai-sdk/provider").LanguageModelV1CallWarning[] | undefined;
+        finishReason: import("@ai-sdk/provider").LanguageModelV2FinishReason;
+        warnings: import("@ai-sdk/provider").LanguageModelV2CallWarning[] | undefined;
     }>>;
     /**
      * Save messages to the thread.
@@ -1236,12 +1258,15 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
      */
     asSaveMessagesMutation(): import("convex/server").RegisteredMutation<"internal", {
         userId?: string | undefined;
-        pending?: boolean | undefined;
         promptMessageId?: string | undefined;
+        embeddings?: {
+            model: string;
+            vectors: (number[] | null)[];
+        } | undefined;
         failPendingSteps?: boolean | undefined;
         threadId: string;
         messages: {
-            id?: string | undefined;
+            status?: "pending" | "success" | "failed" | undefined;
             fileIds?: string[] | undefined;
             error?: string | undefined;
             model?: string | undefined;
@@ -1249,19 +1274,36 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
             text?: string | undefined;
             reasoning?: string | undefined;
             usage?: {
+                reasoningTokens?: number | undefined;
+                cachedInputTokens?: number | undefined;
                 promptTokens: number;
                 completionTokens: number;
                 totalTokens: number;
             } | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
-            sources?: {
+            sources?: ({
                 title?: string | undefined;
+                type?: "source" | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                url?: string | undefined;
                 id: string;
                 sourceType: "url";
-                url: string;
-            }[] | undefined;
+            } | {
+                filename?: string | undefined;
+                providerMetadata?: Record<string, Record<string, any>> | undefined;
+                id: string;
+                title: string;
+                type: "source";
+                sourceType: "document";
+                mediaType: string;
+            })[] | undefined;
             reasoningDetails?: ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
+                type: "reasoning";
+                text: string;
+            } | {
                 signature?: string | undefined;
                 type: "text";
                 text: string;
@@ -1317,6 +1359,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     signature?: string | undefined;
+                    state?: "streaming" | "done" | undefined;
                     type: "reasoning";
                     text: string;
                 } | {
@@ -1325,6 +1368,7 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                     data: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
+                    providerExecuted?: boolean | undefined;
                     type: "tool-call";
                     toolCallId: string;
                     toolName: string;
@@ -1336,6 +1380,8 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                 content: {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     args?: any;
+                    providerExecuted?: boolean | undefined;
+                    isError?: boolean | undefined;
                     experimental_content?: ({
                         type: "text";
                         text: string;
@@ -1344,7 +1390,6 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
                         type: "image";
                         data: string;
                     })[] | undefined;
-                    isError?: boolean | undefined;
                     type: "tool-result";
                     toolCallId: string;
                     toolName: string;
@@ -1358,497 +1403,11 @@ CustomCtx extends object = object, AgentTools extends ToolSet = any> {
         }[];
     }, Promise<{
         lastMessageId: string;
-        messageIds: string[];
+        messages: {
+            _id: string;
+            order: number;
+            stepOrder: number;
+        }[];
     }>>;
 }
-type CoreMessageMaybeWithId = CoreMessage & {
-    id?: string | undefined;
-};
-/**
- * Create a thread to store messages with an Agent.
- * @param ctx The context from a mutation or action.
- * @param component The Agent component, usually `components.agent`.
- * @param args The associated thread metadata.
- * @returns The id of the created thread.
- */
-export declare function createThread(ctx: RunMutationCtx, component: AgentComponent, args?: {
-    userId?: string | null;
-    title?: string;
-    summary?: string;
-}): Promise<string>;
-/**
- * Get the metadata for a thread.
- * @param ctx A ctx object from a query, mutation, or action.
- * @param args.threadId The thread to get the metadata for.
- * @returns The metadata for the thread.
- */
-export declare function getThreadMetadata(ctx: RunQueryCtx, component: AgentComponent, args: {
-    threadId: string;
-}): Promise<ThreadDoc>;
-type SaveMessagesArgs = {
-    threadId: string;
-    userId?: string | null;
-    /**
-     * The message that these messages are in response to. They will be
-     * the same "order" as this message, at increasing stepOrder(s).
-     */
-    promptMessageId?: string;
-    /**
-     * The messages to save.
-     */
-    messages: CoreMessageMaybeWithId[];
-    /**
-     * Metadata to save with the messages. Each element corresponds to the
-     * message at the same index.
-     */
-    metadata?: Omit<MessageWithMetadata, "message">[];
-    /**
-     * If false, it will "commit" the messages immediately.
-     * If true, it will mark them as pending until the final step has finished.
-     * Defaults to false.
-     */
-    pending?: boolean;
-    /**
-     * If true, it will fail any pending steps.
-     * Defaults to false.
-     */
-    failPendingSteps?: boolean;
-    /**
-     * The embeddings to save with the messages.
-     */
-    embeddings?: Omit<MessageEmbeddings, "dimension">;
-};
-/**
- * Explicitly save messages associated with the thread (& user if provided)
- */
-export declare function saveMessages(ctx: RunMutationCtx, component: AgentComponent, args: SaveMessagesArgs & {
-    /**
-     * The agent name to associate with the messages.
-     */
-    agentName?: string;
-}): Promise<{
-    lastMessageId: string;
-    messages: {
-        _creationTime: number;
-        _id: string;
-        agentName?: string | undefined;
-        embeddingId?: string | undefined;
-        error?: string | undefined;
-        fileIds?: string[] | undefined;
-        finishReason?: "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other" | "unknown" | undefined;
-        id?: string | undefined;
-        message?: {
-            content: string | ({
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                text: string;
-                type: "text";
-            } | {
-                image: string | ArrayBuffer;
-                mimeType?: string | undefined;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "image";
-            } | {
-                data: string | ArrayBuffer;
-                filename?: string | undefined;
-                mimeType: string;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "file";
-            })[];
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "user";
-        } | {
-            content: string | ({
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                text: string;
-                type: "text";
-            } | {
-                data: string | ArrayBuffer;
-                filename?: string | undefined;
-                mimeType: string;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "file";
-            } | {
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                signature?: string | undefined;
-                text: string;
-                type: "reasoning";
-            } | {
-                data: string;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "redacted-reasoning";
-            } | {
-                args: any;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                toolCallId: string;
-                toolName: string;
-                type: "tool-call";
-            })[];
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "assistant";
-        } | {
-            content: {
-                args?: any;
-                experimental_content?: ({
-                    text: string;
-                    type: "text";
-                } | {
-                    data: string;
-                    mimeType?: string | undefined;
-                    type: "image";
-                })[] | undefined;
-                isError?: boolean | undefined;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                result: any;
-                toolCallId: string;
-                toolName: string;
-                type: "tool-result";
-            }[];
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "tool";
-        } | {
-            content: string;
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "system";
-        } | undefined;
-        model?: string | undefined;
-        order: number;
-        provider?: string | undefined;
-        providerMetadata?: {
-            [x: string]: {
-                [x: string]: any;
-            };
-        } | undefined;
-        providerOptions?: {
-            [x: string]: {
-                [x: string]: any;
-            };
-        } | undefined;
-        reasoning?: string | undefined;
-        reasoningDetails?: ({
-            signature?: string | undefined;
-            text: string;
-            type: "text";
-        } | {
-            data: string;
-            type: "redacted";
-        })[] | undefined;
-        sources?: {
-            id: string;
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            sourceType: "url";
-            title?: string | undefined;
-            url: string;
-        }[] | undefined;
-        status: "pending" | "success" | "failed";
-        stepOrder: number;
-        text?: string | undefined;
-        threadId: string;
-        tool: boolean;
-        usage?: {
-            completionTokens: number;
-            promptTokens: number;
-            totalTokens: number;
-        } | undefined;
-        userId?: string | undefined;
-        warnings?: ({
-            details?: string | undefined;
-            setting: string;
-            type: "unsupported-setting";
-        } | {
-            details?: string | undefined;
-            tool: any;
-            type: "unsupported-tool";
-        } | {
-            message: string;
-            type: "other";
-        })[] | undefined;
-    }[];
-}>;
-type SaveMessageArgs = {
-    threadId: string;
-    userId?: string | null;
-    /**
-     * Metadata to save with the messages. Each element corresponds to the
-     * message at the same index.
-     */
-    metadata?: Omit<MessageWithMetadata, "message">;
-    /**
-     * The embedding to save with the message.
-     */
-    embedding?: {
-        vector: number[];
-        model: string;
-    };
-} & ({
-    prompt?: undefined;
-    /**
-     * The message to save.
-     */
-    message: CoreMessage;
-} | {
-    prompt: string;
-    message?: undefined;
-});
-/**
- * Save a message to the thread.
- * @param ctx A ctx object from a mutation or action.
- * @param args The message and what to associate it with (user / thread)
- * You can pass extra metadata alongside the message, e.g. associated fileIds.
- * @returns The messageId of the saved message.
- */
-export declare function saveMessage(ctx: RunMutationCtx, component: AgentComponent, args: SaveMessageArgs & {
-    /**
-     * The agent name to associate with the message.
-     */
-    agentName?: string;
-}): Promise<{
-    messageId: string;
-    message: {
-        _creationTime: number;
-        _id: string;
-        agentName?: string | undefined;
-        embeddingId?: string | undefined;
-        error?: string | undefined;
-        fileIds?: string[] | undefined;
-        finishReason?: "stop" | "length" | "content-filter" | "tool-calls" | "error" | "other" | "unknown" | undefined;
-        id?: string | undefined;
-        message?: {
-            content: string | ({
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                text: string;
-                type: "text";
-            } | {
-                image: string | ArrayBuffer;
-                mimeType?: string | undefined;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "image";
-            } | {
-                data: string | ArrayBuffer;
-                filename?: string | undefined;
-                mimeType: string;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "file";
-            })[];
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "user";
-        } | {
-            content: string | ({
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                text: string;
-                type: "text";
-            } | {
-                data: string | ArrayBuffer;
-                filename?: string | undefined;
-                mimeType: string;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "file";
-            } | {
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                signature?: string | undefined;
-                text: string;
-                type: "reasoning";
-            } | {
-                data: string;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                type: "redacted-reasoning";
-            } | {
-                args: any;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                toolCallId: string;
-                toolName: string;
-                type: "tool-call";
-            })[];
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "assistant";
-        } | {
-            content: {
-                args?: any;
-                experimental_content?: ({
-                    text: string;
-                    type: "text";
-                } | {
-                    data: string;
-                    mimeType?: string | undefined;
-                    type: "image";
-                })[] | undefined;
-                isError?: boolean | undefined;
-                providerOptions?: {
-                    [x: string]: {
-                        [x: string]: any;
-                    };
-                } | undefined;
-                result: any;
-                toolCallId: string;
-                toolName: string;
-                type: "tool-result";
-            }[];
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "tool";
-        } | {
-            content: string;
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            role: "system";
-        } | undefined;
-        model?: string | undefined;
-        order: number;
-        provider?: string | undefined;
-        providerMetadata?: {
-            [x: string]: {
-                [x: string]: any;
-            };
-        } | undefined;
-        providerOptions?: {
-            [x: string]: {
-                [x: string]: any;
-            };
-        } | undefined;
-        reasoning?: string | undefined;
-        reasoningDetails?: ({
-            signature?: string | undefined;
-            text: string;
-            type: "text";
-        } | {
-            data: string;
-            type: "redacted";
-        })[] | undefined;
-        sources?: {
-            id: string;
-            providerOptions?: {
-                [x: string]: {
-                    [x: string]: any;
-                };
-            } | undefined;
-            sourceType: "url";
-            title?: string | undefined;
-            url: string;
-        }[] | undefined;
-        status: "pending" | "success" | "failed";
-        stepOrder: number;
-        text?: string | undefined;
-        threadId: string;
-        tool: boolean;
-        usage?: {
-            completionTokens: number;
-            promptTokens: number;
-            totalTokens: number;
-        } | undefined;
-        userId?: string | undefined;
-        warnings?: ({
-            details?: string | undefined;
-            setting: string;
-            type: "unsupported-setting";
-        } | {
-            details?: string | undefined;
-            tool: any;
-            type: "unsupported-tool";
-        } | {
-            message: string;
-            type: "other";
-        })[] | undefined;
-    };
-}>;
 //# sourceMappingURL=index.d.ts.map