@convex-dev/agent 0.6.0-alpha.0 → 0.6.0-alpha.1

package/MIGRATION.md

@@ -0,0 +1,153 @@
+# Migration Guide: v0.3.x to v0.6.0 (AI SDK v6)
+
+This guide helps you upgrade from @convex-dev/agent v0.3.x to v0.6.0.
+
+## Step 1: Update dependencies
+
+Update all AI SDK packages **together** to avoid peer dependency conflicts:
+
+```bash
+npm install @convex-dev/agent@^0.6.0 ai@^6.0.35 @ai-sdk/provider-utils@^4.0.6
+```
+
+### Official AI SDK providers
+
+Update your AI SDK provider packages to v3.x:
+```bash
+# For OpenAI
+npm install @ai-sdk/openai@^3.0.10
+
+# For Anthropic
+npm install @ai-sdk/anthropic@^3.0.13
+
+# For Groq
+npm install @ai-sdk/groq@^3.0.8
+
+# For Google (Gemini)
+npm install @ai-sdk/google@^3.0.8
+```
+
+### Third-party providers
+
+Third-party providers also need updates to be compatible with AI SDK v6:
+
+```bash
+# For OpenRouter
+npm install @openrouter/ai-sdk-provider@^2.0.0
+
+# For other providers, check their documentation for AI SDK v6 compatibility
+```
+
+### Handling dependency conflicts
+
+If you see peer dependency warnings or errors, try updating all packages at once:
+
+```bash
+npm install @convex-dev/agent@^0.6.0 ai@^6.0.35 @ai-sdk/openai@^3.0.10 @openrouter/ai-sdk-provider@^2.0.0
+```
+
+If you still have conflicts, you can use `--force` as a last resort:
+
+```bash
+npm install @convex-dev/agent@^0.6.0 --force
+```
+
+> **Note**: Using `--force` can lead to inconsistent dependency trees. After using it, verify your app works correctly and consider running `npm dedupe` to clean up.
+
+## Step 2: Update tool definitions
+
+Replace `parameters` with `inputSchema`:
+
+```typescript
+// Before (v5)
+const myTool = createTool({
+  description: "My tool",
+  parameters: z.object({ query: z.string() }),
+  execute: async (ctx, args) => { ... }
+})
+
+// After (v6)
+const myTool = createTool({
+  description: "My tool",
+  inputSchema: z.object({ query: z.string() }),
+  execute: async (ctx, input, options) => { ... }
+})
+```
+
+## Step 3: Update Agent config (if using embeddings)
+
+```typescript
+// Before
+new Agent(components.agent, {
+  textEmbeddingModel: openai.embedding("text-embedding-3-small")
+})
+
+// After
+new Agent(components.agent, {
+  embeddingModel: openai.embedding("text-embedding-3-small")
+})
+```
+
+## Step 4: Update maxSteps (optional)
+
+```typescript
+// Before
+await agent.generateText(ctx, { threadId }, {
+  prompt: "...",
+  maxSteps: 5
+})
+
+// After (maxSteps still works, but stopWhen is preferred)
+import { stepCountIs } from "ai"
+await agent.generateText(ctx, { threadId }, {
+  prompt: "...",
+  stopWhen: stepCountIs(5)
+})
+```
+
+## Step 5: Verify
+
+```bash
+npm run typecheck
+npm test
+```
+
+## Common Issues
+
+### EmbeddingModelV2 vs EmbeddingModelV3 type errors
+Ensure all `@ai-sdk/*` packages are updated to v3.x. Older versions use AI SDK v5 types.
+
+### Tool `args` vs `input`
+AI SDK v6 renamed `args` to `input` in tool calls. The library maintains backwards compatibility, but you may see this in types.
+
+### `mimeType` vs `mediaType`
+AI SDK v6 renamed `mimeType` to `mediaType`. Backwards compatibility is maintained.
+
+### Peer dependency conflicts
+
+If you see errors like:
+```
+npm error ERESOLVE unable to resolve dependency tree
+npm error peer ai@"^5.0.0" from @openrouter/ai-sdk-provider@1.0.3
+```
+
+This means a third-party provider needs updating. Common solutions:
+
+1. **Update the provider** to a version compatible with AI SDK v6
+2. **Check npm** for the latest version: `npm view @openrouter/ai-sdk-provider versions`
+3. **Use `--force`** if a compatible version isn't available yet (temporary workaround)
+
+### Third-party provider compatibility
+
+| Provider | AI SDK v5 (ai@5.x) | AI SDK v6 (ai@6.x) |
+|----------|-------------------|-------------------|
+| @openrouter/ai-sdk-provider | v1.x | v2.x |
+| @ai-sdk/openai | v1.x-v2.x | v3.x |
+| @ai-sdk/anthropic | v1.x-v2.x | v3.x |
+| @ai-sdk/groq | v1.x-v2.x | v3.x |
+| @ai-sdk/google | v1.x-v2.x | v3.x |
+
+## More Information
+
+- [AI SDK v6 Migration Guide](https://ai-sdk.dev/docs/migration-guides/migration-guide-6-0)
+- [Convex Agent Documentation](https://docs.convex.dev/agents)

package/dist/client/createTool.d.ts

@@ -31,27 +31,31 @@ export type ToolNeedsApprovalFunctionCtx<INPUT, Ctx extends ToolCtx = ToolCtx> =
 }) => boolean | PromiseLike<boolean>;
 export type ToolExecuteFunctionCtx<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx> = (ctx: Ctx, input: INPUT, options: ToolExecutionOptions) => AsyncIterable<OUTPUT> | PromiseLike<OUTPUT>;
 type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
+/**
+ * Error message type for deprecated 'handler' property.
+ * Using a string literal type causes TypeScript to show this message in errors.
+ */
+type HANDLER_REMOVED_ERROR = "⚠️ 'handler' was removed in @convex-dev/agent v0.6.0. Rename to 'execute'. See: node_modules/@convex-dev/agent/MIGRATION.md";
 export type ToolOutputPropertiesCtx<INPUT, OUTPUT, Ctx extends ToolCtx = ToolCtx> = NeverOptional<OUTPUT, {
     /**
      * An async function that is called with the arguments from the tool call and produces a result.
-     * If `execute` (or `handler`) is not provided, the tool will not be executed automatically.
+     * If `execute` is not provided, the tool will not be executed automatically.
      *
      * @param input - The input of the tool call.
      * @param options.abortSignal - A signal that can be used to abort the tool call.
      */
-    execute: ToolExecuteFunctionCtx<INPUT, OUTPUT, Ctx>;
-    outputSchema?: FlexibleSchema<OUTPUT>;
-    handler?: never;
-} | {
-    /** @deprecated Use execute instead. */
-    handler: ToolExecuteFunctionCtx<INPUT, OUTPUT, Ctx>;
+    execute?: ToolExecuteFunctionCtx<INPUT, OUTPUT, Ctx>;
     outputSchema?: FlexibleSchema<OUTPUT>;
-    execute?: never;
-} | {
-    outputSchema: FlexibleSchema<OUTPUT>;
-    execute?: never;
-    handler?: never;
+    /**
+     * @deprecated Removed in v0.6.0. Use `execute` instead.
+     */
+    handler?: HANDLER_REMOVED_ERROR;
 }>;
+/**
+ * Error message type for deprecated 'args' property.
+ * Using a string literal type causes TypeScript to show this message in errors.
+ */
+type ARGS_REMOVED_ERROR = "⚠️ 'args' was removed in @convex-dev/agent v0.6.0. Rename to 'inputSchema'. See: node_modules/@convex-dev/agent/MIGRATION.md";
 export type ToolInputProperties<INPUT> = {
     /**
      * The schema of the input that the tool expects.
@@ -61,17 +65,10 @@ export type ToolInputProperties<INPUT> = {
      * You can use descriptions on the schema properties to make the input understandable for the language model.
      */
     inputSchema: FlexibleSchema<INPUT>;
-    args?: never;
-} | {
     /**
-     * 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.
-     *
-     * @deprecated Use inputSchema instead.
+     * @deprecated Removed in v0.6.0. Use `inputSchema` instead.
      */
-    args: FlexibleSchema<INPUT>;
-    inputSchema?: never;
+    args?: ARGS_REMOVED_ERROR;
 };
 /**
  * This is a wrapper around the ai.tool function that adds extra context to the

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,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,IAAI,EACJ,oBAAoB,EACpB,OAAO,EACR,MAAM,IAAI,CAAC;AAEZ,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAWxC,MAAM,MAAM,OAAO,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,IACvE,gBAAgB,CAAC,SAAS,CAAC,GAAG;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,4BAA4B,CACtC,KAAK,EACL,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,CACF,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE;IACP;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,KACE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAEpC,MAAM,MAAM,sBAAsB,CAChC,KAAK,EACL,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,CACF,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,oBAAoB,KAC1B,aAAa,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;AAEjD,KAAK,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GACtC,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,GACnC,CAAC,CAAC;AAER,MAAM,MAAM,uBAAuB,CACjC,KAAK,EACL,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,aAAa,CACf,MAAM,EACJ;IACE;;;;;;OAMG;IACH,OAAO,EAAE,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACpD,YAAY,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,uCAAuC;IACvC,OAAO,EAAE,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACpD,YAAY,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,GACD;IACE,YAAY,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACrC,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,OAAO,CAAC,EAAE,KAAK,CAAC;CACjB,CACJ,CAAC;AAEF,MAAM,MAAM,mBAAmB,CAAC,KAAK,IACjC;IACE;;;;;;OAMG;IACH,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IACnC,IAAI,CAAC,EAAE,KAAK,CAAC;CACd,GACD;IACE;;;;;;OAMG;IACH,IAAI,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IAC5B,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,CAAC;AAEN;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,OAAO,GAAG,OAAO,EACrE,GAAG,EAAE;IACH;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;KACvB,CAAC,CAAC;IACH;;OAEG;IACH,aAAa,CAAC,EACV,OAAO,GACP,4BAA4B,CAC1B;QAAC,KAAK;KAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,EACzC,GAAG,CACJ,CAAC;IACN;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,oBAAoB,KAC1B,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB,KACvD,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,OAAO,GAAG,KAAK,CAAC;KAClD,GAAG,oBAAoB,KACrB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;CAC/B,GAAG,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG;IAChD;;;;OAIG;IACH,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;QACjD;;WAEG;QACH,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,MAAM,GACxB,GAAG,GACH,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GACtB,GAAG,GACH,OAAO,CAAC,MAAM,CAAC,CAAC;KACvB,KACE,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;CACvD,GACF,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CA8FrB;AAMD,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,QAAQ,EAAE,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GACnC,OAAO,CAgBT"}
+{"version":3,"file":"createTool.d.ts","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,KAAK,EACV,cAAc,EACd,YAAY,EACZ,IAAI,EACJ,oBAAoB,EACpB,OAAO,EACR,MAAM,IAAI,CAAC;AAEZ,OAAO,KAAK,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAWxC,MAAM,MAAM,OAAO,CAAC,SAAS,SAAS,gBAAgB,GAAG,gBAAgB,IACvE,gBAAgB,CAAC,SAAS,CAAC,GAAG;IAC5B,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB,CAAC;AAEJ;;GAEG;AACH,MAAM,MAAM,4BAA4B,CACtC,KAAK,EACL,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,CACF,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE;IACP;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,QAAQ,EAAE,YAAY,EAAE,CAAC;IACzB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC,KACE,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;AAEpC,MAAM,MAAM,sBAAsB,CAChC,KAAK,EACL,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,CACF,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,oBAAoB,KAC1B,aAAa,CAAC,MAAM,CAAC,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;AAEjD,KAAK,aAAa,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GACtC,OAAO,CAAC,CAAC,CAAC,GACV,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GACjB,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC,GACnC,CAAC,CAAC;AAER;;;GAGG;AACH,KAAK,qBAAqB,GACxB,6HAA6H,CAAC;AAEhI,MAAM,MAAM,uBAAuB,CACjC,KAAK,EACL,MAAM,EACN,GAAG,SAAS,OAAO,GAAG,OAAO,IAC3B,aAAa,CACf,MAAM,EACN;IACE;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,CAAC;IACrD,YAAY,CAAC,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC;IACtC;;OAEG;IACH,OAAO,CAAC,EAAE,qBAAqB,CAAC;CACjC,CACF,CAAC;AAEF;;;GAGG;AACH,KAAK,kBAAkB,GACrB,8HAA8H,CAAC;AAEjI,MAAM,MAAM,mBAAmB,CAAC,KAAK,IAAI;IACvC;;;;;;OAMG;IACH,WAAW,EAAE,cAAc,CAAC,KAAK,CAAC,CAAC;IACnC;;OAEG;IACH,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B,CAAC;AAEF;;;;;;;;GAQG;AACH,wBAAgB,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,SAAS,OAAO,GAAG,OAAO,EACrE,GAAG,EAAE;IACH;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG;IAC7B;;;OAGG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC;QACpB,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;KACvB,CAAC,CAAC;IACH;;OAEG;IACH,aAAa,CAAC,EACV,OAAO,GACP,4BAA4B,CAC1B;QAAC,KAAK;KAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,EACzC,GAAG,CACJ,CAAC;IACN;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,GAAG,CAAC,EAAE,GAAG,CAAC;IACV;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE,oBAAoB,KAC1B,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IAC9B;;;OAGG;IACH,YAAY,CAAC,EAAE,CACb,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QAAE,cAAc,EAAE,MAAM,CAAA;KAAE,GAAG,oBAAoB,KACvD,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,OAAO,GAAG,KAAK,CAAC;KAClD,GAAG,oBAAoB,KACrB,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;CAC/B,GAAG,uBAAuB,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,CAAC,GAAG;IAChD;;;;OAIG;IACH,aAAa,CAAC,EAAE,CACd,GAAG,EAAE,GAAG,EACR,OAAO,EAAE;QACP;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,KAAK,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,OAAO,GAAG,KAAK,CAAC;QACjD;;WAEG;QACH,MAAM,EAAE,CAAC,SAAS,CAAC,GAAG,MAAM,GACxB,GAAG,GACH,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,GACtB,GAAG,GACH,OAAO,CAAC,MAAM,CAAC,CAAC;KACvB,KACE,gBAAgB,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;CACvD,GACF,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CA+FrB;AAMD,wBAAgB,SAAS,CACvB,GAAG,EAAE,OAAO,EACZ,GAAG,QAAQ,EAAE,CAAC,OAAO,GAAG,SAAS,CAAC,EAAE,GACnC,OAAO,CAgBT"}

package/dist/client/createTool.js

@@ -1,5 +1,5 @@
 import { tool } from "ai";
-const MIGRATION_URL = "https://github.com/get-convex/agent/blob/main/MIGRATION.md";
+const MIGRATION_URL = "node_modules/@convex-dev/agent/MIGRATION.md";
 const warnedDeprecations = new Set();
 function warnDeprecation(key, message) {
     if (!warnedDeprecations.has(key)) {
@@ -17,9 +17,10 @@ function warnDeprecation(key, message) {
  * @returns A tool to be used with the AI SDK.
  */
 export function createTool(def) {
+    // Runtime backwards compat - types will show errors but runtime still works
     const inputSchema = def.inputSchema ?? def.args;
     if (!inputSchema)
-        throw new Error("To use a Convex tool, you must provide an `inputSchema` (or `args`)");
+        throw new Error("To use a Convex tool, you must provide an `inputSchema`");
     if (def.args && !def.inputSchema) {
         warnDeprecation("createTool.args", "createTool: 'args' is deprecated. Use 'inputSchema' instead.");
     }

package/dist/client/createTool.js.map

@@ -1 +1 @@
-{"version":3,"file":"createTool.js","sourceRoot":"","sources":["../../src/client/createTool.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAK1B,MAAM,aAAa,GAAG,4DAA4D,CAAC;AACnF,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;AAC7C,SAAS,eAAe,CAAC,GAAW,EAAE,OAAe;IACnD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,CAAC,IAAI,CAAC,uBAAuB,OAAO,YAAY,aAAa,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AA6GD;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACxB,GAmGG;IAEH,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,IAAI,CAAC;IAChD,IAAI,CAAC,WAAW;QACd,MAAM,IAAI,KAAK,CAAC,qEAAqE,CAAC,CAAC;IAEzF,IAAI,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QACjC,eAAe,CACb,iBAAiB,EACjB,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QAChC,eAAe,CACb,oBAAoB,EACpB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC;IAClD,IAAI,CAAC,cAAc,IAAI,CAAC,GAAG,CAAC,YAAY;QACtC,MAAM,IAAI,KAAK,CACb,0DAA0D;YACxD,oDAAoD,CACvD,CAAC;IAEJ,MAAM,CAAC,GAAG,IAAI,CAAgB;QAC5B,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,eAAe,EAAE,GAAG,CAAC,eAAe;QACpC,WAAW;QACX,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,aAAa,CAA4B,KAAK,EAAE,OAAO;YACrD,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;YACxC,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,SAAS;gBACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC;YAEhC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;oBACrD,qEAAqE;oBACrE,uDAAuD,CAC1D,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,CAAC,cAAc;YAChB,CAAC,CAAC;gBACE,OAAO,CAEL,KAAY,EACZ,OAA6B;oBAE7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;4BACrD,qEAAqE;4BACrE,uDAAuD,CAC1D,CAAC;oBACJ,CAAC;oBACD,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;gBACtD,CAAC;aACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP,YAAY,EAAE,GAAG,CAAC,YAAY;KAC/B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC;QAC1C,CAAC,CAAC,YAAY,GAAG,UAAqC,OAAO;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC;QAC1C,CAAC,CAAC,YAAY,GAAG,UAAqC,OAAO;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzB,MAAM,oBAAoB,GAAG,GAAG,CAAC,gBAAgB,CAAC;QAClD,CAAC,CAAC,gBAAgB,GAAG,UAAqC,OAAO;YAC/D,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;QACtB,MAAM,iBAAiB,GAAG,GAAG,CAAC,aAAa,CAAC;QAC5C,CAAC,CAAC,aAAa,GAAG,UAAqC,OAAO;YAC5D,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,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,IAAI,IAAI,IAAI,CAAE,IAAY,CAAC,YAAY,EAAE,CAAC;gBACxC,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":"AAQA,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAK1B,MAAM,aAAa,GAAG,6CAA6C,CAAC;AACpE,MAAM,kBAAkB,GAAG,IAAI,GAAG,EAAU,CAAC;AAC7C,SAAS,eAAe,CAAC,GAAW,EAAE,OAAe;IACnD,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC5B,OAAO,CAAC,IAAI,CAAC,uBAAuB,OAAO,YAAY,aAAa,EAAE,CAAC,CAAC;IAC1E,CAAC;AACH,CAAC;AA0GD;;;;;;;;GAQG;AACH,MAAM,UAAU,UAAU,CACxB,GAmGG;IAEH,4EAA4E;IAC5E,MAAM,WAAW,GAAG,GAAG,CAAC,WAAW,IAAK,GAAW,CAAC,IAAI,CAAC;IACzD,IAAI,CAAC,WAAW;QACd,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;IAE7E,IAAK,GAAW,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC;QAC1C,eAAe,CACb,iBAAiB,EACjB,8DAA8D,CAC/D,CAAC;IACJ,CAAC;IACD,IAAK,GAAW,CAAC,OAAO,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;QACzC,eAAe,CACb,oBAAoB,EACpB,6DAA6D,CAC9D,CAAC;IACJ,CAAC;IAED,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,IAAK,GAAW,CAAC,OAAO,CAAC;IAC3D,IAAI,CAAC,cAAc,IAAI,CAAC,GAAG,CAAC,YAAY;QACtC,MAAM,IAAI,KAAK,CACb,0DAA0D;YACxD,oDAAoD,CACvD,CAAC;IAEJ,MAAM,CAAC,GAAG,IAAI,CAAgB;QAC5B,IAAI,EAAE,UAAU;QAChB,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,GAAG,CAAC,GAAG;QACZ,WAAW,EAAE,GAAG,CAAC,WAAW;QAC5B,KAAK,EAAE,GAAG,CAAC,KAAK;QAChB,eAAe,EAAE,GAAG,CAAC,eAAe;QACpC,WAAW;QACX,aAAa,EAAE,GAAG,CAAC,aAAa;QAChC,aAAa,CAA4B,KAAK,EAAE,OAAO;YACrD,MAAM,aAAa,GAAG,GAAG,CAAC,aAAa,CAAC;YACxC,IAAI,CAAC,aAAa,IAAI,OAAO,aAAa,KAAK,SAAS;gBACtD,OAAO,OAAO,CAAC,aAAa,CAAC,CAAC;YAEhC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;oBACrD,qEAAqE;oBACrE,uDAAuD,CAC1D,CAAC;YACJ,CAAC;YACD,OAAO,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QACD,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,GAAG,CAAC,cAAc;YAChB,CAAC,CAAC;gBACE,OAAO,CAEL,KAAY,EACZ,OAA6B;oBAE7B,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;wBAClB,MAAM,IAAI,KAAK,CACb,uDAAuD;4BACrD,qEAAqE;4BACrE,uDAAuD,CAC1D,CAAC;oBACJ,CAAC;oBACD,OAAO,cAAc,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;gBACtD,CAAC;aACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP,YAAY,EAAE,GAAG,CAAC,YAAY;KAC/B,CAAC,CAAC;IACH,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC;QAC1C,CAAC,CAAC,YAAY,GAAG,UAAqC,OAAO;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,YAAY,EAAE,CAAC;QACrB,MAAM,gBAAgB,GAAG,GAAG,CAAC,YAAY,CAAC;QAC1C,CAAC,CAAC,YAAY,GAAG,UAAqC,OAAO;YAC3D,OAAO,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC5D,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,gBAAgB,EAAE,CAAC;QACzB,MAAM,oBAAoB,GAAG,GAAG,CAAC,gBAAgB,CAAC;QAClD,CAAC,CAAC,gBAAgB,GAAG,UAAqC,OAAO;YAC/D,OAAO,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAChE,CAAC,CAAC;IACJ,CAAC;IACD,IAAI,GAAG,CAAC,aAAa,EAAE,CAAC;QACtB,MAAM,iBAAiB,GAAG,GAAG,CAAC,aAAa,CAAC;QAC5C,CAAC,CAAC,aAAa,GAAG,UAAqC,OAAO;YAC5D,OAAO,iBAAiB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;QAC7D,CAAC,CAAC;IACJ,CAAC;IACD,OAAO,CAAC,CAAC;AACX,CAAC;AAED,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,IAAI,IAAI,IAAI,CAAE,IAAY,CAAC,YAAY,EAAE,CAAC;gBACxC,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

@@ -15,7 +15,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
         apiKey: string;
     }, Promise<boolean>>;
     listUsers: import("convex/server").RegisteredQuery<"public", {
-        apiKey: string;
         paginationOpts: {
             id?: number;
             endCursor?: string | null;
@@ -24,6 +23,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             numItems: number;
             cursor: string | null;
         };
+        apiKey: string;
     }, Promise<{
         page: {
             _id: string;
@@ -36,7 +36,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
     }>>;
     listThreads: import("convex/server").RegisteredQuery<"public", {
         userId?: string | undefined;
-        apiKey: string;
         paginationOpts: {
             id?: number;
             endCursor?: string | null;
@@ -45,6 +44,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             numItems: number;
             cursor: string | null;
         };
+        apiKey: string;
     }, Promise<{
         page: {
             lastAgentName: string | undefined;
@@ -74,7 +74,6 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             }[];
         } | undefined;
         threadId: string;
-        apiKey: string;
         paginationOpts: {
             id?: number;
             endCursor?: string | null;
@@ -83,11 +82,12 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             numItems: number;
             cursor: string | null;
         };
+        apiKey: string;
     }, Promise<{
         streams: import("./types.js").SyncStreamsReturnValue;
         page: {
-            id?: string | undefined;
             userId?: string | undefined;
+            id?: string | undefined;
             embeddingId?: string | undefined;
             fileIds?: string[] | undefined;
             error?: string | undefined;
@@ -244,22 +244,22 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                     toolCallId: string;
                     toolName: string;
                 } | {
-                    title?: string | undefined;
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     providerMetadata?: Record<string, Record<string, any>> | undefined;
-                    id: string;
+                    title?: string | undefined;
                     type: "source";
+                    id: string;
                     url: string;
                     sourceType: "url";
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     providerMetadata?: Record<string, Record<string, any>> | undefined;
                     filename?: string | undefined;
-                    id: string;
-                    title: string;
                     type: "source";
+                    id: string;
                     mediaType: string;
                     sourceType: "document";
+                    title: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -375,10 +375,10 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 totalTokens: number;
             } | undefined;
             sources?: ({
-                title?: string | undefined;
                 type?: "source" | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
+                title?: string | undefined;
                 id: string;
                 url: string;
                 sourceType: "url";
@@ -386,11 +386,11 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
                 filename?: string | undefined;
-                id: string;
-                title: string;
                 type: "source";
+                id: string;
                 mediaType: string;
                 sourceType: "document";
+                title: string;
             })[] | undefined;
             warnings?: ({
                 details?: string | undefined;
@@ -404,7 +404,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 type: "other";
                 message: string;
             })[] | undefined;
-            finishReason?: "error" | "length" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
+            finishReason?: "length" | "error" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
             reasoningDetails?: ({
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -419,13 +419,13 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 type: "redacted";
                 data: string;
             })[] | undefined;
-            status: "pending" | "success" | "failed";
-            order: number;
+            _id: string;
             _creationTime: number;
             threadId: string;
+            order: number;
             stepOrder: number;
+            status: "pending" | "success" | "failed";
             tool: boolean;
-            _id: string;
         }[];
         isDone: boolean;
         continueCursor: import("convex/server").Cursor;
@@ -445,9 +445,9 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
         tools: string[];
     }[]>>;
     createThread: import("convex/server").RegisteredMutation<"public", {
+        agentName?: string | undefined;
         title?: string | undefined;
         summary?: string | undefined;
-        agentName?: string | undefined;
         userId: string;
         apiKey: string;
     }, Promise<{
@@ -455,6 +455,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
     }>>;
     generateText: import("convex/server").RegisteredAction<"public", {
         system?: string | undefined;
+        prompt?: string | undefined;
         messages?: ({
             providerOptions?: Record<string, Record<string, any>> | undefined;
             role: "user";
@@ -604,22 +605,22 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 toolCallId: string;
                 toolName: string;
             } | {
-                title?: string | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
-                id: string;
+                title?: string | undefined;
                 type: "source";
+                id: string;
                 url: string;
                 sourceType: "url";
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
                 filename?: string | undefined;
-                id: string;
-                title: string;
                 type: "source";
+                id: string;
                 mediaType: string;
                 sourceType: "document";
+                title: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -724,13 +725,12 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             role: "system";
             content: string;
         })[] | undefined;
-        prompt?: string | undefined;
         contextOptions?: {
             excludeToolMessages?: boolean | undefined;
             recentMessages?: number | undefined;
             searchOptions?: {
-                textSearch?: boolean | undefined;
                 vectorSearch?: boolean | undefined;
+                textSearch?: boolean | undefined;
                 vectorScoreThreshold?: number | undefined;
                 messageRange?: {
                     before: number;
@@ -772,10 +772,10 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 totalTokens: number;
             } | undefined;
             sources?: ({
-                title?: string | undefined;
                 type?: "source" | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
+                title?: string | undefined;
                 id: string;
                 url: string;
                 sourceType: "url";
@@ -783,11 +783,11 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
                 filename?: string | undefined;
-                id: string;
-                title: string;
                 type: "source";
+                id: string;
                 mediaType: string;
                 sourceType: "document";
+                title: string;
             })[] | undefined;
             warnings?: ({
                 details?: string | undefined;
@@ -801,7 +801,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 type: "other";
                 message: string;
             })[] | undefined;
-            finishReason?: "error" | "length" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
+            finishReason?: "length" | "error" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
             reasoningDetails?: ({
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -965,22 +965,22 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                     toolCallId: string;
                     toolName: string;
                 } | {
-                    title?: string | undefined;
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     providerMetadata?: Record<string, Record<string, any>> | undefined;
-                    id: string;
+                    title?: string | undefined;
                     type: "source";
+                    id: string;
                     url: string;
                     sourceType: "url";
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     providerMetadata?: Record<string, Record<string, any>> | undefined;
                     filename?: string | undefined;
-                    id: string;
-                    title: string;
                     type: "source";
+                    id: string;
                     mediaType: string;
                     sourceType: "document";
+                    title: string;
                 } | {
                     providerOptions?: Record<string, Record<string, any>> | undefined;
                     providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -1239,22 +1239,22 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 toolCallId: string;
                 toolName: string;
             } | {
-                title?: string | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
-                id: string;
+                title?: string | undefined;
                 type: "source";
+                id: string;
                 url: string;
                 sourceType: "url";
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
                 filename?: string | undefined;
-                id: string;
-                title: string;
                 type: "source";
+                id: string;
                 mediaType: string;
                 sourceType: "document";
+                title: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -1363,12 +1363,13 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
         beforeMessageId?: string | undefined;
         searchText?: string | undefined;
         agentName: string;
+        apiKey: string;
         contextOptions: {
             excludeToolMessages?: boolean | undefined;
             recentMessages?: number | undefined;
             searchOptions?: {
-                textSearch?: boolean | undefined;
                 vectorSearch?: boolean | undefined;
+                textSearch?: boolean | undefined;
                 vectorScoreThreshold?: number | undefined;
                 messageRange?: {
                     before: number;
@@ -1378,10 +1379,9 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             } | undefined;
             searchOtherThreads?: boolean | undefined;
         };
-        apiKey: string;
     }, Promise<{
-        id?: string | undefined;
         userId?: string | undefined;
+        id?: string | undefined;
         embeddingId?: string | undefined;
         fileIds?: string[] | undefined;
         error?: string | undefined;
@@ -1538,22 +1538,22 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
                 toolCallId: string;
                 toolName: string;
             } | {
-                title?: string | undefined;
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
-                id: string;
+                title?: string | undefined;
                 type: "source";
+                id: string;
                 url: string;
                 sourceType: "url";
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
                 filename?: string | undefined;
-                id: string;
-                title: string;
                 type: "source";
+                id: string;
                 mediaType: string;
                 sourceType: "document";
+                title: string;
             } | {
                 providerOptions?: Record<string, Record<string, any>> | undefined;
                 providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -1669,10 +1669,10 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             totalTokens: number;
         } | undefined;
         sources?: ({
-            title?: string | undefined;
             type?: "source" | undefined;
             providerOptions?: Record<string, Record<string, any>> | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
+            title?: string | undefined;
             id: string;
             url: string;
             sourceType: "url";
@@ -1680,11 +1680,11 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             providerOptions?: Record<string, Record<string, any>> | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
             filename?: string | undefined;
-            id: string;
-            title: string;
             type: "source";
+            id: string;
             mediaType: string;
             sourceType: "document";
+            title: string;
         })[] | undefined;
         warnings?: ({
             details?: string | undefined;
@@ -1698,7 +1698,7 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             type: "other";
             message: string;
         })[] | undefined;
-        finishReason?: "error" | "length" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
+        finishReason?: "length" | "error" | "other" | "stop" | "content-filter" | "tool-calls" | "unknown" | undefined;
         reasoningDetails?: ({
             providerOptions?: Record<string, Record<string, any>> | undefined;
             providerMetadata?: Record<string, Record<string, any>> | undefined;
@@ -1713,13 +1713,13 @@ export declare function definePlaygroundAPI<DataModel extends GenericDataModel>(
             type: "redacted";
             data: string;
         })[] | undefined;
-        status: "pending" | "success" | "failed";
-        order: number;
+        _id: string;
         _creationTime: number;
         threadId: string;
+        order: number;
         stepOrder: number;
+        status: "pending" | "success" | "failed";
         tool: boolean;
-        _id: string;
     }[]>>;
 };
 //# sourceMappingURL=definePlaygroundAPI.d.ts.map