@convex-dev/agent 0.1.1-alpha.0 → 0.1.2-alpha.0

package/README.md

@@ -17,11 +17,17 @@ AI Agent framework built on Convex.
   Enables long-lived, durable workflows defined as code.
 - Reactive & realtime updates from asynchronous functions / workflows.
 - Support for streaming text and storing the final result.
+  See [examples/chat-streaming](./examples/chat-streaming/README.md).
 - Optionally filter tool calls out of the thread history.
 
 [Read the associated Stack post here](https://stack.convex.dev/ai-agents).
 
-Example usage:
+Play with the [examples](./examples) by cloning this repo and running:
+```sh
+npm run example
+```
+
+## Example usage:
 
 ```ts
 // Define an agent similarly to the AI SDK
@@ -128,8 +134,6 @@ const supportAgent = new Agent(components.agent, {
   // The default system prompt if not overriden.
   instructions: "You are a helpful assistant.",
   tools: {
-    // Standard AI SDK tool
-    myTool: tool({ description, parameters, execute: () => {}}),
     // Convex tool
     myConvexTool: createTool({
       description: "My Convex tool",
@@ -139,6 +143,8 @@ const supportAgent = new Agent(components.agent, {
         return "Hello, world!";
       },
     }),
+    // Standard AI SDK tool
+    myTool: tool({ description, parameters, execute: () => {}}),
   },
   // Embedding model to power vector search of message history (RAG).
   textEmbedding: openai.embedding("text-embedding-3-small"),

package/dist/commonjs/client/createTool.d.ts

@@ -0,0 +1,49 @@
+import { Schema, Tool } from "ai";
+import { ToolExecutionOptions } from "ai";
+import { ToolSet } from "ai";
+import { z } from "zod";
+import { RunActionCtx } from "./types.js";
+import { Agent } from "./index.js";
+export type ToolCtx<TOOLS extends ToolSet = ToolSet> = RunActionCtx & {
+    agent: Agent<TOOLS>;
+    userId?: string;
+    threadId?: string;
+    messageId?: string;
+};
+/**
+ * This is a wrapper around the ai.tool function that adds extra context to the
+ * tool call, including the action context, userId, threadId, and messageId.
+ * @param tool The tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
+ * but swap parameters for args and handler for execute.
+ * @returns A tool to be used with the AI SDK.
+ */
+export declare function createTool<PARAMETERS extends ToolParameters, RESULT>(t: {
+    /**
+    An optional description of what the tool does.
+    Will be used by the language model to decide whether to use the tool.
+    Not used for provider-defined tools.
+       */
+    description?: string;
+    /**
+    The schema of the input that the tool expects. The language model will use this to generate the input.
+    It is also used to validate the output of the language model.
+    Use descriptions to make the input understandable for the language model.
+       */
+    args: PARAMETERS;
+    /**
+    An async function that is called with the arguments from the tool call and produces a result.
+    If not provided, the tool will not be executed automatically.
+  
+    @args is the input of the tool call.
+    @options.abortSignal is a signal that can be used to abort the tool call.
+       */
+    handler: (ctx: ToolCtx, args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+    ctx?: ToolCtx;
+}): Tool<PARAMETERS, RESULT> & {
+    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+};
+export declare function wrapTools(ctx: ToolCtx, ...toolSets: (ToolSet | undefined)[]): ToolSet;
+type ToolParameters = z.ZodTypeAny | Schema<any>;
+type inferParameters<PARAMETERS extends ToolParameters> = PARAMETERS extends Schema<any> ? PARAMETERS["_type"] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
+export {};
+//# sourceMappingURL=createTool.d.ts.map

package/dist/commonjs/client/createTool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../../src/client/createTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAClC,OAAO,EAAE,oBAAoB,EAAE,MAAM,IAAI,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAC7B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEnC,MAAM,MAAM,OAAO,CAAC,KAAK,SAAS,OAAO,GAAG,OAAO,IAAI,YAAY,GAAG;IACpE,KAAK,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,UAAU,SAAS,cAAc,EAAE,MAAM,EAAE,CAAC,EAAE;IACvE;;;;SAIK;IACL,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;SAIK;IACL,IAAI,EAAE,UAAU,CAAC;IACjB;;;;;;SAMK;IACL,OAAO,EAAE,CACP,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC,EACjC,OAAO,EAAE,oBAAoB,KAC1B,WAAW,CAAC,MAAM,CAAC,CAAC;IACzB,GAAG,CAAC,EAAE,OAAO,CAAC;CACf,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;IAC7B,OAAO,EAAE,CACP,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC,EACjC,OAAO,EAAE,oBAAoB,KAC1B,WAAW,CAAC,MAAM,CAAC,CAAC;CAC1B,CAqBA;AAED,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,QAAQ,EAAE,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GACnC,OAAO,CAiBT;AAID,KAAK,cAAc,GAAG,CAAC,CAAC,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;AACjD,KAAK,eAAe,CAAC,UAAU,SAAS,cAAc,IAEpD,UAAU,SAAS,MAAM,CAAC,GAAG,CAAC,GAC1B,UAAU,CAAC,OAAO,CAAC,GACnB,UAAU,SAAS,CAAC,CAAC,UAAU,GAC7B,CAAC,CAAC,KAAK,CAAC,UAAU,CAAC,GACnB,KAAK,CAAC"}

package/dist/commonjs/client/createTool.js

@@ -0,0 +1,45 @@
+import { tool } from "ai";
+/**
+ * This is a wrapper around the ai.tool function that adds extra context to the
+ * tool call, including the action context, userId, threadId, and messageId.
+ * @param tool The tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
+ * but swap parameters for args and handler for execute.
+ * @returns A tool to be used with the AI SDK.
+ */
+export function createTool(t) {
+    const args = {
+        __acceptsCtx: true,
+        ctx: t.ctx,
+        description: t.description,
+        parameters: t.args,
+        async execute(args, options) {
+            if (!this.ctx) {
+                throw new Error("To use a Convex tool, you must either provide the ctx" +
+                    " at definition time (dynamically in an action), or use the Agent to" +
+                    " call it (which injects the ctx, userId and threadId)");
+            }
+            return t.handler(this.ctx, args, options);
+        },
+    };
+    return tool(args);
+}
+export function wrapTools(ctx, ...toolSets) {
+    const output = {};
+    for (const toolSet of toolSets) {
+        if (!toolSet) {
+            continue;
+        }
+        for (const [name, tool] of Object.entries(toolSet)) {
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            if (!tool.__acceptsCtx) {
+                output[name] = tool;
+            }
+            else {
+                const out = { ...tool, ctx };
+                output[name] = out;
+            }
+        }
+    }
+    return output;
+}
+//# sourceMappingURL=createTool.js.map

package/dist/commonjs/client/createTool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createTool.js","sourceRoot":"","sources":["../../../src/client/createTool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAe1B;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAA4C,CA0BrE;IAMC,MAAM,IAAI,GAAG;QACX,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,CAAC,CAAC,GAAG;QACV,WAAW,EAAE,CAAC,CAAC,WAAW;QAC1B,UAAU,EAAE,CAAC,CAAC,IAAI;QAClB,KAAK,CAAC,OAAO,CACX,IAAiC,EACjC,OAA6B;YAE7B,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CACb,uDAAuD;oBACrD,qEAAqE;oBACrE,uDAAuD,CAC1D,CAAC;YACJ,CAAC;YACD,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAC5C,CAAC;KACF,CAAC;IACF,OAAO,IAAI,CAAC,IAAI,CAAC,CAAC;AACpB,CAAC;AAED,MAAM,UAAU,SAAS,CACvB,GAAY,EACZ,GAAG,QAAiC;IAEpC,MAAM,MAAM,GAAG,EAAa,CAAC;IAC7B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;QAC/B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,SAAS;QACX,CAAC;QACD,KAAK,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,8DAA8D;YAC9D,IAAI,CAAE,IAAY,CAAC,YAAY,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,MAAM,GAAG,GAAG,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,CAAC;gBAC7B,MAAM,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC;YACrB,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC"}

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

@@ -1,105 +1,18 @@
 import type { EmbeddingModelV1, LanguageModelV1 } from "@ai-sdk/provider";
-import type { CoreMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, JSONValue, RepairTextFunction, Schema, StepResult, StreamObjectResult, StreamTextResult, TelemetrySettings, Tool, ToolChoice, ToolExecutionOptions, ToolSet, UIMessage } from "ai";
-import { generateObject, generateText, streamObject, streamText } from "ai";
-import { z } from "zod";
-import { Mounts } from "../component/_generated/api.js";
+import type { CoreMessage, DeepPartial, GenerateObjectResult, GenerateTextResult, StepResult, StreamObjectResult, StreamTextResult, ToolSet } from "ai";
+import { PaginationOptions, PaginationResult } from "convex/server";
 import { type VectorDimension } from "../component/vector/tables.js";
 import { type AIMessageWithoutId } from "../mapping.js";
 import { extractText, isTool } from "../shared.js";
-import { type CallSettings, type MessageWithMetadata as InnerMessageWithMetadata, type ProviderMetadata, type ProviderOptions, type SearchOptions, type Usage } from "../validators.js";
-import type { OpaqueIds, RunActionCtx, RunMutationCtx, RunQueryCtx, UseApi } from "./types.js";
+import { type MessageWithMetadata as InnerMessageWithMetadata, type MessageStatus, type ProviderMetadata, type SearchOptions, type StreamArgs, type Usage } from "../validators.js";
+import type { AgentComponent, ContextOptions, GenerationOutputMetadata, OpaqueIds, Options, OurObjectArgs, OurStreamObjectArgs, RunActionCtx, RunMutationCtx, RunQueryCtx, StorageOptions, StreamingTextArgs, SyncStreamsReturnValue, TextArgs, Thread, UsageHandler } from "./types.js";
 import type { MessageDoc, ThreadDoc } from "../component/schema.js";
+import { createTool } from "./createTool.js";
+import { StreamingOptions } from "./streaming.js";
 export { vMessageDoc, vThreadDoc } from "../component/schema.js";
-export { extractText, isTool };
-export type { Usage, ProviderMetadata, MessageDoc, ThreadDoc };
-export { 
-/** @deprecated Use vPaginationResult instead. */
-paginationResultValidator, paginationResultValidator as vPaginationResult, vContextOptions, vUsage, vProviderMetadata, vUserMessage, vAssistantMessage, vToolMessage, vStorageOptions, vSystemMessage, vMessage, } from "../validators.js";
-/**
- * Options to configure what messages are fetched as context,
- * automatically with thread.generateText, or directly via search.
- */
-export type ContextOptions = {
-    /** @deprecated Use excludeToolMessages instead. */
-    includeToolCalls?: boolean;
-    /**
-     * Whether to include tool messages in the context.
-     * By default, tool calls and results are not included.
-     */
-    excludeToolMessages?: boolean;
-    /**
-     * How many recent messages to include. These are added after the search
-     * messages, and do not count against the search limit.
-     * Default: 100
-     */
-    recentMessages?: number;
-    /**
-     * Options for searching messages.
-     */
-    searchOptions?: {
-        /**
-         * The maximum number of messages to fetch. Default is 10.
-         */
-        limit: number;
-        /**
-         * Whether to use text search to find messages. Default is false.
-         */
-        textSearch?: boolean;
-        /**
-         * Whether to use vector search to find messages. Default is false.
-         * At least one of textSearch or vectorSearch must be true.
-         */
-        vectorSearch?: boolean;
-        /**
-         * What messages around the search results to include.
-         * Default: { before: 2, after: 1 }
-         * (two before, and one after each message found in the search)
-         * Note, this is after the limit is applied.
-         * By default this will quadruple the number of messages fetched.
-         */
-        messageRange?: {
-            before: number;
-            after: number;
-        };
-    };
-    /**
-     * Whether to search across other threads for relevant messages.
-     * By default, only the current thread is searched.
-     */
-    searchOtherThreads?: boolean;
-};
-/**
- * Options to configure the automatic saving of messages
- * when generating text / objects in a thread.
- */
-export type StorageOptions = {
-    /**
-     * Defaults to false, allowing you to pass in arbitrary context that will
-     * be in addition to automatically fetched content.
-     * Pass true to have all input messages saved to the thread history.
-     */
-    saveAllInputMessages?: boolean;
-    /** Defaults to true, saving the prompt, or last message passed to generateText. */
-    saveAnyInputMessages?: boolean;
-    /** Defaults to true. Whether to save messages generated while chatting. */
-    saveOutputMessages?: boolean;
-};
-export type GenerationOutputMetadata = {
-    messageId?: string;
-};
-type CoreMessageMaybeWithId = CoreMessage & {
-    id?: string | undefined;
-};
-export type UsageHandler = (ctx: RunActionCtx, args: {
-    userId: string | undefined;
-    threadId: string | undefined;
-    agentName: string | undefined;
-    usage: Usage;
-    providerMetadata: ProviderMetadata | undefined;
-    model: string;
-    provider: string;
-}) => void | Promise<void>;
-export type AgentComponent = UseApi<Mounts>;
+export { vAssistantMessage, vContextOptions, vMessage, vPaginationResult, vProviderMetadata, vStorageOptions, vStreamArgs, vSystemMessage, vToolMessage, vUsage, vUserMessage, } from "../validators.js";
+export { createTool, extractText, isTool };
+export type { AgentComponent, ContextOptions, MessageDoc, ProviderMetadata, StorageOptions, SyncStreamsReturnValue, Thread, ThreadDoc, Usage, UsageHandler, };
 export declare class Agent<AgentTools extends ToolSet> {
     component: AgentComponent;
     options: {
@@ -333,6 +246,34 @@ export declare class Agent<AgentTools extends ToolSet> {
     }): Promise<{
         thread: Thread<ThreadTools extends undefined ? AgentTools : ThreadTools>;
     }>;
+    /**
+     * List messages from a thread.
+     * @param ctx A ctx object from a query, mutation, or action.
+     * @param args.threadId The thread to list messages from.
+     * @param args.paginationOpts Pagination options (e.g. via usePaginatedQuery).
+     * @param args.excludeToolMessages Whether to exclude tool messages.
+     *   False by default.
+     * @param args.statuses What statuses to include. All by default.
+     * @returns The MessageDoc's in a format compatible with usePaginatedQuery.
+     */
+    listMessages(ctx: RunQueryCtx, args: {
+        threadId: string;
+        paginationOpts: PaginationOptions;
+        excludeToolMessages?: boolean;
+        statuses?: MessageStatus[];
+    }): Promise<PaginationResult<MessageDoc>>;
+    /**
+     * A function that handles fetching stream deltas, used with the React hooks
+     * `useThreadMessages` or `useStreamingThreadMessages`.
+     * @param ctx A ctx object from a query, mutation, or action.
+     * @param args.threadId The thread to sync streams for.
+     * @param args.streamArgs The stream arguments with per-stream cursors.
+     * @returns The deltas for each stream from their existing cursor.
+     */
+    syncStreams(ctx: RunQueryCtx, args: {
+        threadId: string;
+        streamArgs: StreamArgs | undefined;
+    }): Promise<SyncStreamsReturnValue | undefined>;
     /**
      * Fetch the context messages for a thread.
      * @param ctx Either a query, mutation, or action ctx.
@@ -363,6 +304,19 @@ export declare class Agent<AgentTools extends ToolSet> {
         dimension: VectorDimension;
         model: string;
     } | undefined>;
+    saveMessage(ctx: RunMutationCtx, args: {
+        threadId: string;
+        userId?: string;
+        metadata?: Omit<MessageWithMetadata, "message">;
+    } & ({
+        prompt?: undefined;
+        message: CoreMessage;
+    } | {
+        prompt: string;
+        message?: undefined;
+    })): Promise<{
+        messageId: string;
+    }>;
     /**
      * Explicitly save messages associated with the thread (& user if provided)
      * @param ctx The ctx parameter to a mutation or action.
@@ -399,7 +353,7 @@ export declare class Agent<AgentTools extends ToolSet> {
         failPendingSteps?: boolean;
     }): Promise<{
         lastMessageId: string;
-        messageIds: string[];
+        messages: MessageDoc[];
     }>;
     /**
      * Save messages to the thread.
@@ -566,7 +520,7 @@ export declare class Agent<AgentTools extends ToolSet> {
          * Defaults to the chat provider for the Agent.
          */
         provider?: string;
-    }): Promise<void>;
+    }): Promise<MessageDoc[]>;
     /**
      * Commit or rollback a message that was pending.
      * This is done automatically when saving messages by default.
@@ -634,7 +588,19 @@ export declare class Agent<AgentTools extends ToolSet> {
      * The {@link ContextOptions} and {@link StorageOptions}
      * options to use for fetching contextual messages and saving input/output messages.
      */
-    options?: Options): Promise<StreamTextResult<TOOLS extends undefined ? AgentTools : TOOLS, PARTIAL_OUTPUT> & GenerationOutputMetadata>;
+    options?: Options & {
+        /**
+         * Whether to save incremental data (deltas) from streaming responses.
+         * Defaults to false.
+         * If false, it will not save any deltas to the database.
+         * If true, it will save deltas with {@link DEFAULT_STREAMING_OPTIONS}.
+         *
+         * Regardless of this option, when streaming you are able to use this
+         * `streamText` function as you would with the "ai" package's version:
+         * iterating over the text, streaming it over HTTP, etc.
+         */
+        saveStreamDeltas?: boolean | StreamingOptions;
+    }): Promise<StreamTextResult<TOOLS extends undefined ? AgentTools : TOOLS, PARTIAL_OUTPUT> & GenerationOutputMetadata>;
     _saveMessagesAndFetchContext<T extends {
         id?: string;
         prompt?: string;
@@ -651,6 +617,8 @@ export declare class Agent<AgentTools extends ToolSet> {
             model: LanguageModelV1;
         };
         messageId: string | undefined;
+        order: number | undefined;
+        stepOrder: number | undefined;
     }>;
     /**
      * This behaves like {@link generateObject} from the "ai" package except that
@@ -708,8 +676,8 @@ export declare class Agent<AgentTools extends ToolSet> {
         result: GenerateObjectResult<unknown>;
         metadata?: Omit<MessageWithMetadata, "message">;
     }): Promise<void>;
-    mergedContextOptions(opts: ContextOptions | undefined): ContextOptions;
-    searchOptionsWithDefaults(contextOptions: ContextOptions, messages: CoreMessage[]): Promise<SearchOptions>;
+    _mergedContextOptions(opts: ContextOptions | undefined): ContextOptions;
+    _searchOptionsWithDefaults(contextOptions: ContextOptions, messages: CoreMessage[]): Promise<SearchOptions>;
     /**
      * Create a mutation that creates a thread so you can call it from a Workflow.
      * e.g.
@@ -742,9 +710,30 @@ export declare class Agent<AgentTools extends ToolSet> {
      *   {@link ContextOptions}, {@link StorageOptions}, and maxSteps.
      */
     asTextAction(spec?: {
+        /**
+         * The maximum number of steps to take in this action.
+         * Defaults to the {@link Agent.maxSteps} option.
+         */
         maxSteps?: number;
+        /**
+         * The {@link ContextOptions} to use for fetching contextual messages and
+         * saving input/output messages.
+         * Defaults to the {@link Agent.contextOptions} option.
+         */
         contextOptions?: ContextOptions;
+        /**
+         * The {@link StorageOptions} to use for saving input/output messages.
+         * Defaults to the {@link Agent.storageOptions} option.
+         */
         storageOptions?: StorageOptions;
+        /**
+         * Whether to stream the text.
+         * If false, it will generate the text in a single call. (default)
+         * If true or {@link StreamingOptions}, it will stream the text from the LLM
+         * and save the chunks to the database with the options you specify, or the
+         * defaults if you pass true.
+         */
+        stream?: boolean | StreamingOptions;
     }): import("convex/server").RegisteredAction<"internal", {
         userId?: string | undefined;
         threadId?: string | undefined;
@@ -830,6 +819,7 @@ export declare class Agent<AgentTools extends ToolSet> {
         frequencyPenalty?: number | undefined;
         seed?: number | undefined;
         maxRetries?: number | undefined;
+        stream?: boolean | undefined;
         toolChoice?: "required" | "auto" | "none" | {
             type: "tool";
             toolName: string;
@@ -837,6 +827,7 @@ export declare class Agent<AgentTools extends ToolSet> {
         maxSteps?: number | undefined;
         experimental_continueSteps?: boolean | undefined;
         prompt?: string | undefined;
+        promptMessageId?: string | undefined;
         contextOptions?: {
             excludeToolMessages?: boolean | undefined;
             recentMessages?: number | undefined;
@@ -856,7 +847,11 @@ export declare class Agent<AgentTools extends ToolSet> {
             saveAnyInputMessages?: boolean | undefined;
             saveOutputMessages?: boolean | undefined;
         } | undefined;
-    }, Promise<string>>;
+    }, Promise<{
+        text: string;
+        finishReason: import("@ai-sdk/provider").LanguageModelV1FinishReason;
+        messageId: string | 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.
@@ -955,6 +950,7 @@ export declare class Agent<AgentTools extends ToolSet> {
         seed?: number | undefined;
         maxRetries?: number | undefined;
         prompt?: string | undefined;
+        promptMessageId?: string | undefined;
         contextOptions?: {
             excludeToolMessages?: boolean | undefined;
             recentMessages?: number | undefined;
@@ -1108,225 +1104,8 @@ export declare function filterOutOrphanedToolMessages(docs: MessageDoc[]): {
     tool: boolean;
     _id: string;
 }[];
-export type ToolCtx = RunActionCtx & {
-    userId?: string;
-    threadId?: string;
-    messageId?: string;
-};
-type ToolParameters = z.ZodTypeAny | Schema<any>;
-type inferParameters<PARAMETERS extends ToolParameters> = PARAMETERS extends Schema<any> ? PARAMETERS["_type"] : PARAMETERS extends z.ZodTypeAny ? z.infer<PARAMETERS> : never;
-/**
- * This is a wrapper around the ai.tool function that adds extra context to the
- * tool call, including the action context, userId, threadId, and messageId.
- * @param tool The tool. See https://sdk.vercel.ai/docs/ai-sdk-core/tools-and-tool-calling
- * but swap parameters for args and handler for execute.
- * @returns A tool to be used with the AI SDK.
- */
-export declare function createTool<PARAMETERS extends ToolParameters, RESULT>(t: {
-    /**
-    An optional description of what the tool does.
-    Will be used by the language model to decide whether to use the tool.
-    Not used for provider-defined tools.
-       */
-    description?: string;
-    /**
-    The schema of the input that the tool expects. The language model will use this to generate the input.
-    It is also used to validate the output of the language model.
-    Use descriptions to make the input understandable for the language model.
-       */
-    args: PARAMETERS;
-    /**
-    An async function that is called with the arguments from the tool call and produces a result.
-    If not provided, the tool will not be executed automatically.
-  
-    @args is the input of the tool call.
-    @options.abortSignal is a signal that can be used to abort the tool call.
-       */
-    handler: (ctx: ToolCtx, args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
-    ctx?: ToolCtx;
-}): Tool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
-};
-type Options = {
-    /**
-     * The context options to use for passing in message history to the LLM.
-     */
-    contextOptions?: ContextOptions;
-    /**
-     * The storage options to use for saving the input and output messages to the thread.
-     */
-    storageOptions?: StorageOptions;
-};
-type TextArgs<AgentTools extends ToolSet, TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, OUTPUT_PARTIAL = never> = Omit<Parameters<typeof generateText<TOOLS extends undefined ? AgentTools : TOOLS, OUTPUT, OUTPUT_PARTIAL>>[0], "toolChoice" | "tools" | "model"> & {
-    /**
-     * If provided, this message will be used as the "prompt" for the LLM call,
-     * instead of the prompt or messages.
-     * This is useful if you want to first save a user message, then use it as
-     * the prompt for the LLM call in another call.
-     */
-    promptMessageId?: string;
-    /**
-     * The model to use for the tool calls. This will override the model specified
-     * in the Agent constructor.
-     */
-    model?: LanguageModelV1;
-    /**
-     * The tools to use for the tool calls. This will override tools specified
-     * in the Agent constructor or createThread / continueThread.
-     */
-    tools?: TOOLS;
-    /**
-     * The tool choice to use for the tool calls. This must be one of the tools
-     * specified in the tools array. e.g. {toolName: "getWeather", type: "tool"}
-     */
-    toolChoice?: ToolChoice<TOOLS extends undefined ? AgentTools : TOOLS>;
-};
-type StreamingTextArgs<AgentTools extends ToolSet, TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, OUTPUT_PARTIAL = never> = Omit<Parameters<typeof streamText<TOOLS extends undefined ? AgentTools : TOOLS, OUTPUT, OUTPUT_PARTIAL>>[0], "toolChoice" | "tools" | "model"> & {
-    /**
-     * The model to use for the tool calls. This will override the model specified
-     * in the Agent constructor.
-     */
-    model?: LanguageModelV1;
-    /**
-     * The tools to use for the tool calls. This will override tools specified
-     * in the Agent constructor or createThread / continueThread.
-     */
-    tools?: TOOLS;
-    /**
-     * The tool choice to use for the tool calls. This must be one of the tools
-     * specified in the tools array. e.g. {toolName: "getWeather", type: "tool"}
-     */
-    toolChoice?: ToolChoice<TOOLS extends undefined ? AgentTools : TOOLS>;
-};
-type BaseGenerateObjectOptions = CallSettings & {
-    /**
-     * The model to use for the object generation. This will override the model
-     * specified in the Agent constructor.
-     */
-    model?: LanguageModelV1;
-    /**
-     * The system prompt to use for the object generation. This will override the
-     * system prompt specified in the Agent constructor.
-     */
-    system?: string;
-    /**
-     * The prompt to the LLM to use for the object generation.
-     * Specify this or messages, but not both.
-     */
-    prompt?: string;
-    /**
-     * The messages to use for the object generation.
-     * Note: recent messages are automatically added based on the thread it's
-     * associated with and your contextOptions.
-     */
-    messages?: CoreMessage[];
-    /**
-     * The message to use as the "prompt" for the object generation.
-     * If this is provided, it will be used instead of the prompt or messages.
-     * This is useful if you want to first save a user message, then use it as
-     * the prompt for the object generation in another call.
-     */
-    promptMessageId?: string;
-    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">;
-type ThreadOutputMetadata = GenerationOutputMetadata & {
-    messageId: string;
-};
-/**
- * The interface for a thread returned from {@link createThread} or {@link continueThread}.
- * This is contextual to a thread and/or user.
- */
-interface Thread<DefaultTools extends ToolSet> {
-    /**
-     * The target threadId, from the startThread or continueThread initializers.
-     */
-    threadId: string;
-    /**
-     * 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
-     * resulting messages to the thread, if specified.
-     * Use {@link continueThread} to get a version of this function already scoped
-     * to a thread (and optionally userId).
-     * @param args The arguments to the generateText function, along with extra controls
-     * for the {@link ContextOptions} and {@link StorageOptions}.
-     * @returns The result of the generateText function.
-     */
-    generateText<TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, OUTPUT_PARTIAL = never>(args: TextArgs<TOOLS extends undefined ? DefaultTools : TOOLS, TOOLS, OUTPUT, OUTPUT_PARTIAL>, options?: Options): Promise<GenerateTextResult<TOOLS extends undefined ? DefaultTools : TOOLS, OUTPUT> & ThreadOutputMetadata>;
-    /**
-     * This behaves like {@link streamText} from the "ai" package except that
-     * it add context based on the userId and threadId and saves the input and
-     * resulting messages to the thread, if specified.
-     * Use {@link continueThread} to get a version of this function already scoped
-     * to a thread (and optionally userId).
-     * @param args The arguments to the streamText function, along with extra controls
-     * for the {@link ContextOptions} and {@link StorageOptions}.
-     * @returns The result of the streamText function.
-     */
-    streamText<TOOLS extends ToolSet | undefined = undefined, OUTPUT = never, PARTIAL_OUTPUT = never>(args: StreamingTextArgs<TOOLS extends undefined ? DefaultTools : TOOLS, TOOLS, OUTPUT, PARTIAL_OUTPUT>, options?: Options): Promise<StreamTextResult<TOOLS extends undefined ? DefaultTools : TOOLS, PARTIAL_OUTPUT> & ThreadOutputMetadata>;
-    /**
-     * This behaves like {@link generateObject} from the "ai" package except that
-     * it add context based on the userId and threadId and saves the input and
-     * resulting messages to the thread, if specified. This overload is for objects, arrays, and enums.
-     * Use {@link continueThread} to get a version of this function already scoped
-     * to a thread (and optionally userId).
-     * @param args The arguments to the generateObject function, along with extra controls
-     * for the {@link ContextOptions} and {@link StorageOptions}.
-     * @returns The result of the generateObject function.
-     */
-    generateObject<T>(args: OurObjectArgs<T>, options?: Options): Promise<GenerateObjectResult<T> & ThreadOutputMetadata>;
-    /**
-     * This behaves like {@link generateObject} from the "ai" package except that
-     * it add context based on the userId and threadId and saves the input and
-     * resulting messages to the thread, if specified. This overload is for when there's no schema.
-     * Use {@link continueThread} to get a version of this function already scoped
-     * to a thread (and optionally userId).
-     * @param args The arguments to the generateObject function, along with extra controls
-     * for the {@link ContextOptions} and {@link StorageOptions}.
-     * @returns The result of the generateObject function.
-     */
-    generateObject(args: GenerateObjectNoSchemaOptions, options?: Options): Promise<GenerateObjectResult<JSONValue> & ThreadOutputMetadata>;
-    /**
-     * This behaves like {@link streamObject} from the "ai" package except that
-     * it add context based on the userId and threadId and saves the input and
-     * resulting messages to the thread, if specified.
-     * Use {@link continueThread} to get a version of this function already scoped
-     * to a thread (and optionally userId).
-     * @param args The arguments to the streamObject function, along with extra controls
-     * for the {@link ContextOptions} and {@link StorageOptions}.
-     * @returns The result of the streamObject function.
-     */
-    streamObject<T>(args: OurStreamObjectArgs<T>, options?: Options): Promise<StreamObjectResult<DeepPartial<T>, T, never> & ThreadOutputMetadata>;
-}
 type MessageWithMetadata = OpaqueIds<InnerMessageWithMetadata>;
-export declare function toUIMessages(messages: MessageDoc[]): UIMessage[];
+type CoreMessageMaybeWithId = CoreMessage & {
+    id?: string | undefined;
+};
 //# sourceMappingURL=index.d.ts.map