@convex-dev/agent 0.1.18-alpha.1 → 0.5.0-alpha.1

package/dist/client/createTool.d.ts

@@ -1,7 +1,8 @@
-import type { Schema, Tool, ToolExecutionOptions, ToolSet } from "ai";
+import type { Schema, Tool, ToolCallOptions, ToolSet } from "ai";
 import { z } from "zod";
 import type { Agent } from "./index.js";
 import type { GenericActionCtx, GenericDataModel } from "convex/server";
+import type { ProviderOptions } from "../validators.js";
 export type ToolCtx<DataModel extends GenericDataModel = GenericDataModel> = GenericActionCtx<DataModel> & {
     agent: Agent;
     userId?: string;
@@ -15,7 +16,7 @@ export type ToolCtx<DataModel extends GenericDataModel = GenericDataModel> = Gen
  * 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, Ctx extends ToolCtx = ToolCtx>(t: {
+export declare function createTool<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx>(def: {
     /**
     An optional description of what the tool does.
     Will be used by the language model to decide whether to use the tool.
@@ -27,7 +28,7 @@ export declare function createTool<PARAMETERS extends ToolParameters, RESULT, Ct
     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;
+    args: ToolParameters<INPUT>;
     /**
     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.
@@ -35,13 +36,33 @@ export declare function createTool<PARAMETERS extends ToolParameters, RESULT, Ct
     @args is the input of the tool call.
     @options.abortSignal is a signal that can be used to abort the tool call.
        */
-    handler: (ctx: Ctx, args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
+    handler: (ctx: Ctx, args: INPUT, options: ToolCallOptions) => PromiseLike<OUTPUT>;
+    /**
+     * Provide the context to use, e.g. when defining the tool at runtime.
+     */
     ctx?: Ctx;
-}): Tool<PARAMETERS, RESULT> & {
-    execute: (args: inferParameters<PARAMETERS>, options: ToolExecutionOptions) => PromiseLike<RESULT>;
-};
+    /**
+     * Optional function that is called when the argument streaming starts.
+     * Only called when the tool is used in a streaming context.
+     */
+    onInputStart?: (ctx: Ctx, options: ToolCallOptions) => void | PromiseLike<void>;
+    /**
+     * Optional function that is called when an argument streaming delta is available.
+     * Only called when the tool is used in a streaming context.
+     */
+    onInputDelta?: (ctx: Ctx, options: {
+        inputTextDelta: string;
+    } & ToolCallOptions) => void | PromiseLike<void>;
+    /**
+     * Optional function that is called when a tool call can be started,
+     * even if the execute function is not provided.
+     */
+    onInputAvailable?: (ctx: Ctx, options: {
+        input: [INPUT] extends [never] ? undefined : INPUT;
+    } & ToolCallOptions) => void | PromiseLike<void>;
+    providerOptions?: ProviderOptions;
+}): Tool<INPUT, OUTPUT>;
 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;
+type ToolParameters<T> = z.Schema<T> | Schema<T>;
 export {};
 //# sourceMappingURL=createTool.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAEtE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAExE,MAAM,MAAM,OAAO,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,IACvE,gBAAgB,CAAC,SAAS,CAAC,GAAG;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ;;;;;;GAMG;AACH,wBAAgB,UAAU,CACxB,UAAU,SAAS,cAAc,EACjC,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,EAC7B,CAAC,EAAE;IACH;;;;SAIK;IACL,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;SAIK;IACL,IAAI,EAAE,UAAU,CAAC;IACjB;;;;;;SAMK;IACL,OAAO,EAAE,CACP,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC,EACjC,OAAO,EAAE,oBAAoB,KAC1B,WAAW,CAAC,MAAM,CAAC,CAAC;IACzB,GAAG,CAAC,EAAE,GAAG,CAAC;CACX,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"}
+{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,eAAe,EAAE,OAAO,EAAE,MAAM,IAAI,CAAC;AAEjE,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAExD,MAAM,MAAM,OAAO,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,IACvE,gBAAgB,CAAC,SAAS,CAAC,GAAG;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,OAAO,GAAG,OAAO,EAAE,GAAG,EAAE;IAC5E;;;;SAIK;IACL,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;SAIK;IACL,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC5B;;;;;;SAMK;IACL,OAAO,EAAE,CACP,GAAG,EAAE,GAAG,EACR,IAAI,EAAE,KAAK,EACX,OAAO,EAAE,eAAe,KACrB,WAAW,CAAC,MAAM,CAAC,CAAC;IACzB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,eAAe,KACrB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP,cAAc,EAAE,MAAM,CAAC;KACxB,GAAG,eAAe,KAChB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,gBAAgB,CAAC,EAAE,CACjB,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,SAAS,GAAG,KAAK,CAAC;KACpD,GAAG,eAAe,KAChB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAG9B,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,GAAG,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CA6BtB;AAOD,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,QAAQ,EAAE,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GACnC,OAAO,CAiBT;AAGD,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC"}

package/dist/client/createTool.js

@@ -7,22 +7,37 @@ import { z } from "zod";
  * 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 = {
+export function createTool(def) {
+    const t = tool({
+        type: "function",
         __acceptsCtx: true,
-        ctx: t.ctx,
-        description: t.description,
-        parameters: t.args,
+        ctx: def.ctx,
+        description: def.description,
+        inputSchema: def.args,
         async execute(args, options) {
-            if (!this.ctx) {
+            if (!getCtx(this)) {
                 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 def.handler(getCtx(this), args, options);
         },
-    };
-    return tool(args);
+        providerOptions: def.providerOptions,
+    });
+    if (def.onInputStart) {
+        t.onInputStart = def.onInputStart.bind(t, getCtx(t));
+    }
+    if (def.onInputDelta) {
+        t.onInputDelta = def.onInputDelta.bind(t, getCtx(t));
+    }
+    if (def.onInputAvailable) {
+        t.onInputAvailable = def.onInputAvailable.bind(t, getCtx(t));
+    }
+    return t;
+}
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function getCtx(tool) {
+    return tool.ctx;
 }
 export function wrapTools(ctx, ...toolSets) {
     const output = {};

package/dist/client/createTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"createTool.js","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAYxB;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAIxB,CA0BD;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"}
+{"version":3,"file":"createTool.js","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAA+C,GA4DxE;IACC,MAAM,CAAC,GAAG,IAAI,CAAC;QACb,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,WAAW,EAAE,GAAG,CAAC,IAAI;QACrB,KAAK,CAAC,OAAO,CAAC,IAAW,EAAE,OAAwB;YACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;oBACrD,qEAAqE;oBACrE,uDAAuD,CAC1D,CAAC;YACJ,CAAC;YACD,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;QAClD,CAAC;QACD,eAAe,EAAE,GAAG,CAAC,eAAe;KACrC,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,CAAC,CAAC,YAAY,GAAG,GAAG,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IACvD,CAAC;IACD,IAAI,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzB,CAAC,CAAC,gBAAgB,GAAG,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC;IAC/D,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,8DAA8D;AAC9D,SAAS,MAAM,CAAsB,IAAS;IAC5C,OAAQ,IAAqB,CAAC,GAAG,CAAC;AACpC,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/client/definePlaygroundAPI.d.ts

@@ -1,5 +1,5 @@
-import { type GenericDataModel, type GenericQueryCtx, type ApiFromModules, type GenericActionCtx } from "convex/server";
-import { type AgentComponent, type Agent } from "./index.js";
+import { type ApiFromModules, type GenericActionCtx, type GenericDataModel, type GenericQueryCtx } from "convex/server";
+import { type Agent, type AgentComponent } from "./index.js";
 export type PlaygroundAPI = ApiFromModules<{
     playground: ReturnType<typeof definePlaygroundAPI>;
 }>["playground"];
@@ -73,203 +73,153 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             numItems: number;
             cursor: string | null;
         };
-    }, Promise<{
-        continueCursor: string;
-        isDone: boolean;
-        page: {
-            _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";
+    }, Promise<import("convex/server").PaginationResult<{
+        id?: string | undefined;
+        userId?: string | undefined;
+        embeddingId?: string | undefined;
+        fileIds?: string[] | undefined;
+        error?: string | undefined;
+        agentName?: string | undefined;
+        model?: string | undefined;
+        provider?: string | undefined;
+        providerOptions?: Record<string, Record<string, any>> | undefined;
+        message?: {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "user";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
             } | {
-                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";
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                mimeType?: string | undefined;
+                type: "image";
+                image: string | ArrayBuffer;
             } | {
-                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";
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                filename?: string | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "assistant";
+            content: string | ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "text";
+                text: string;
             } | {
-                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?: ({
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                filename?: string | undefined;
+                type: "file";
+                mimeType: string;
+                data: string | ArrayBuffer;
+            } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
                 signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
+                type: "reasoning";
                 text: string;
-                type: "text";
             } | {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                type: "redacted-reasoning";
                 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;
-        }[];
-        pageStatus?: "SplitRecommended" | "SplitRequired" | null | undefined;
-        splitCursor?: string | null | undefined;
-    }>>;
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                providerExecuted?: boolean | undefined;
+                type: "tool-call";
+                toolCallId: string;
+                toolName: string;
+                args: any;
+            })[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "tool";
+            content: {
+                providerOptions?: Record<string, Record<string, any>> | undefined;
+                args?: any;
+                providerExecuted?: boolean | undefined;
+                isError?: boolean | undefined;
+                experimental_content?: ({
+                    type: "text";
+                    text: string;
+                } | {
+                    mimeType?: string | undefined;
+                    type: "image";
+                    data: string;
+                })[] | undefined;
+                type: "tool-result";
+                toolCallId: string;
+                toolName: string;
+                result: any;
+            }[];
+        } | {
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            role: "system";
+            content: string;
+        } | undefined;
+        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?: ({
+            title?: string | undefined;
+            type?: "source" | undefined;
+            providerOptions?: Record<string, Record<string, any>> | undefined;
+            url?: string | undefined;
+            id: string;
+            sourceType: "url";
+        } | {
+            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;
+        } | {
+            type: "redacted";
+            data: string;
+        })[] | undefined;
+        warnings?: ({
+            details?: string | undefined;
+            type: "unsupported-setting";
+            setting: string;
+        } | {
+            details?: string | undefined;
+            type: "unsupported-tool";
+            tool: any;
+        } | {
+            type: "other";
+            message: string;
+        })[] | undefined;
+        finishReason?: "length" | "error" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
+        _id: string;
+        _creationTime: number;
+        status: "pending" | "success" | "failed";
+        order: number;
+        threadId: string;
+        stepOrder: number;
+        tool: boolean;
+    }>>>;
     listAgents: import("convex/server").RegisteredQuery<"public", {
         userId?: string | undefined;
         threadId?: string | undefined;
@@ -279,7 +229,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
         instructions: string | undefined;
         contextOptions: import("./types.js").ContextOptions | undefined;
         storageOptions: import("./types.js").StorageOptions | undefined;
-        maxSteps: number | undefined;
         maxRetries: number | undefined;
         tools: string[];
     }[]>>;
@@ -329,6 +278,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
                 type: "reasoning";
                 text: string;
             } | {
@@ -337,6 +287,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 data: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                providerExecuted?: boolean | undefined;
                 type: "tool-call";
                 toolCallId: string;
                 toolName: string;
@@ -348,6 +299,8 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             content: {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 args?: any;
+                providerExecuted?: boolean | undefined;
+                isError?: boolean | undefined;
                 experimental_content?: ({
                     type: "text";
                     text: string;
@@ -356,7 +309,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                     type: "image";
                     data: string;
                 })[] | undefined;
-                isError?: boolean | undefined;
                 type: "tool-result";
                 toolCallId: string;
                 toolName: string;
@@ -391,7 +343,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
         agentName: string;
         apiKey: string;
     }, Promise<{
-        messageId: string;
+        messageId: string | undefined;
         text: string;
     }>>;
     fetchPromptContext: import("convex/server").RegisteredAction<"public", {
@@ -434,6 +386,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
                 type: "reasoning";
                 text: string;
             } | {
@@ -442,6 +395,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 data: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                providerExecuted?: boolean | undefined;
                 type: "tool-call";
                 toolCallId: string;
                 toolName: string;
@@ -453,6 +407,8 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             content: {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 args?: any;
+                providerExecuted?: boolean | undefined;
+                isError?: boolean | undefined;
                 experimental_content?: ({
                     type: "text";
                     text: string;
@@ -461,7 +417,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                     type: "image";
                     data: string;
                 })[] | undefined;
-                isError?: boolean | undefined;
                 type: "tool-result";
                 toolCallId: string;
                 toolName: string;
@@ -533,6 +488,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 signature?: string | undefined;
+                state?: "streaming" | "done" | undefined;
                 type: "reasoning";
                 text: string;
             } | {
@@ -541,6 +497,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 data: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
+                providerExecuted?: boolean | undefined;
                 type: "tool-call";
                 toolCallId: string;
                 toolName: string;
@@ -552,6 +509,8 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             content: {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 args?: any;
+                providerExecuted?: boolean | undefined;
+                isError?: boolean | undefined;
                 experimental_content?: ({
                     type: "text";
                     text: string;
@@ -560,7 +519,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                     type: "image";
                     data: string;
                 })[] | undefined;
-                isError?: boolean | undefined;
                 type: "tool-result";
                 toolCallId: string;
                 toolName: string;
@@ -574,19 +532,36 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
         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;

package/dist/client/definePlaygroundAPI.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definePlaygroundAPI.d.ts","sourceRoot":"","sources":["../../src/client/definePlaygroundAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACpB,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EAOL,KAAK,cAAc,EACnB,KAAK,KAAK,EACX,MAAM,YAAY,CAAC;AAGpB,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;CACpD,CAAC,CAAC,YAAY,CAAC,CAAC;AAEjB,MAAM,MAAM,QAAQ,CAAC,SAAS,SAAS,gBAAgB,IAAI,CACzD,GAAG,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,SAAS,CAAC,EAC7D,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,KAC/D,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;AAGhC,wBAAgB,mBAAmB,CAAC,SAAS,SAAS,gBAAgB,EACpE,SAAS,EAAE,cAAc,EACzB,EACE,MAAM,EAAE,UAAU,EAClB,cAAc,GACf,EAAE;IACD,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,CACf,GAAG,EAAE,eAAe,CAAC,SAAS,CAAC,EAC/B,MAAM,EAAE,MAAM,KACX,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAiSF"}
+{"version":3,"file":"definePlaygroundAPI.d.ts","sourceRoot":"","sources":["../../src/client/definePlaygroundAPI.ts"],"names":[],"mappings":"AAAA,OAAO,EAKL,KAAK,cAAc,EACnB,KAAK,gBAAgB,EACrB,KAAK,gBAAgB,EACrB,KAAK,eAAe,EACrB,MAAM,eAAe,CAAC;AAEvB,OAAO,EAUL,KAAK,KAAK,EACV,KAAK,cAAc,EACpB,MAAM,YAAY,CAAC;AAEpB,MAAM,MAAM,aAAa,GAAG,cAAc,CAAC;IACzC,UAAU,EAAE,UAAU,CAAC,OAAO,mBAAmB,CAAC,CAAC;CACpD,CAAC,CAAC,YAAY,CAAC,CAAC;AAEjB,MAAM,MAAM,QAAQ,CAAC,SAAS,SAAS,gBAAgB,IAAI,CACzD,GAAG,EAAE,gBAAgB,CAAC,SAAS,CAAC,GAAG,eAAe,CAAC,SAAS,CAAC,EAC7D,IAAI,EAAE;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,KAC/D,KAAK,EAAE,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC;AAGhC,wBAAgB,mBAAmB,CAAC,SAAS,SAAS,gBAAgB,EACpE,SAAS,EAAE,cAAc,EACzB,EACE,MAAM,EAAE,UAAU,EAClB,cAAc,GACf,EAAE;IACD,MAAM,EAAE,KAAK,EAAE,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;IACtC,cAAc,CAAC,EAAE,CACf,GAAG,EAAE,eAAe,CAAC,SAAS,CAAC,EAC/B,MAAM,EAAE,MAAM,KACX,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;CAC/B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6RF"}