ai 6.0.0-beta.72 → 6.0.0-beta.74

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # ai
 
+## 6.0.0-beta.74
+
+### Patch Changes
+
+- 293a6b7: Added a title to the tools
+- Updated dependencies [293a6b7]
+  - @ai-sdk/provider-utils@4.0.0-beta.21
+  - @ai-sdk/gateway@2.0.0-beta.38
+
+## 6.0.0-beta.73
+
+### Patch Changes
+
+- 754df61: fix(ai): correct type field in arrayOutputStrategy from 'enum' to 'array'
+
 ## 6.0.0-beta.72
 
 ### Patch Changes

package/dist/index.d.mts

@@ -306,12 +306,14 @@ type StaticToolCall<TOOLS extends ToolSet> = ValueOf<{
         dynamic?: false | undefined;
         invalid?: false | undefined;
         error?: never;
+        title?: string;
     };
 }>;
 type DynamicToolCall = BaseToolCall & {
     toolName: string;
     input: unknown;
     dynamic: true;
+    title?: string;
     /**
      * True if this is caused by an unparsable tool call or
      * a tool that does not exist.
@@ -367,6 +369,7 @@ type StaticToolError<TOOLS extends ToolSet> = ValueOf<{
         error: unknown;
         providerExecuted?: boolean;
         dynamic?: false | undefined;
+        title?: string;
     };
 }>;
 type DynamicToolError = {
@@ -377,6 +380,7 @@ type DynamicToolError = {
     error: unknown;
     providerExecuted?: boolean;
     dynamic: true;
+    title?: string;
 };
 type TypedToolError<TOOLS extends ToolSet> = StaticToolError<TOOLS> | DynamicToolError;
 
@@ -390,6 +394,7 @@ type StaticToolResult<TOOLS extends ToolSet> = ValueOf<{
         providerExecuted?: boolean;
         dynamic?: false | undefined;
         preliminary?: boolean;
+        title?: string;
     };
 }>;
 type DynamicToolResult = {
@@ -401,6 +406,7 @@ type DynamicToolResult = {
     providerExecuted?: boolean;
     dynamic: true;
     preliminary?: boolean;
+    title?: string;
 };
 type TypedToolResult<TOOLS extends ToolSet> = StaticToolResult<TOOLS> | DynamicToolResult;
 
@@ -1648,6 +1654,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
      * ID of the tool call.
      */
     toolCallId: string;
+    title?: string;
     /**
      * Whether the tool call was executed by the provider.
      */
@@ -1738,6 +1745,7 @@ type DynamicToolUIPart = {
      * ID of the tool call.
      */
     toolCallId: string;
+    title?: string;
     /**
      * Whether the tool call was executed by the provider.
      */
@@ -1863,6 +1871,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     toolName: string;
     providerExecuted?: boolean | undefined;
     dynamic?: boolean | undefined;
+    title?: string | undefined;
 } | {
     type: "tool-input-delta";
     toolCallId: string;
@@ -1875,6 +1884,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     providerExecuted?: boolean | undefined;
     providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
     dynamic?: boolean | undefined;
+    title?: string | undefined;
 } | {
     type: "tool-input-error";
     toolCallId: string;
@@ -1884,6 +1894,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     providerExecuted?: boolean | undefined;
     providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
     dynamic?: boolean | undefined;
+    title?: string | undefined;
 } | {
     type: "tool-approval-request";
     approvalId: string;
@@ -2002,6 +2013,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     providerExecuted?: boolean;
     providerMetadata?: ProviderMetadata;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-error';
     toolCallId: string;
@@ -2011,6 +2023,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     providerMetadata?: ProviderMetadata;
     dynamic?: boolean;
     errorText: string;
+    title?: string;
 } | {
     type: 'tool-approval-request';
     approvalId: string;
@@ -2037,6 +2050,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     toolName: string;
     providerExecuted?: boolean;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-delta';
     toolCallId: string;
@@ -2404,6 +2418,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     providerMetadata?: ProviderMetadata;
     providerExecuted?: boolean;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-end';
     id: string;
@@ -3573,6 +3588,7 @@ type SingleRequestTextStreamPart<TOOLS extends ToolSet> = {
     toolName: string;
     providerMetadata?: ProviderMetadata;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-delta';
     id: string;

package/dist/index.d.ts

@@ -306,12 +306,14 @@ type StaticToolCall<TOOLS extends ToolSet> = ValueOf<{
         dynamic?: false | undefined;
         invalid?: false | undefined;
         error?: never;
+        title?: string;
     };
 }>;
 type DynamicToolCall = BaseToolCall & {
     toolName: string;
     input: unknown;
     dynamic: true;
+    title?: string;
     /**
      * True if this is caused by an unparsable tool call or
      * a tool that does not exist.
@@ -367,6 +369,7 @@ type StaticToolError<TOOLS extends ToolSet> = ValueOf<{
         error: unknown;
         providerExecuted?: boolean;
         dynamic?: false | undefined;
+        title?: string;
     };
 }>;
 type DynamicToolError = {
@@ -377,6 +380,7 @@ type DynamicToolError = {
     error: unknown;
     providerExecuted?: boolean;
     dynamic: true;
+    title?: string;
 };
 type TypedToolError<TOOLS extends ToolSet> = StaticToolError<TOOLS> | DynamicToolError;
 
@@ -390,6 +394,7 @@ type StaticToolResult<TOOLS extends ToolSet> = ValueOf<{
         providerExecuted?: boolean;
         dynamic?: false | undefined;
         preliminary?: boolean;
+        title?: string;
     };
 }>;
 type DynamicToolResult = {
@@ -401,6 +406,7 @@ type DynamicToolResult = {
     providerExecuted?: boolean;
     dynamic: true;
     preliminary?: boolean;
+    title?: string;
 };
 type TypedToolResult<TOOLS extends ToolSet> = StaticToolResult<TOOLS> | DynamicToolResult;
 
@@ -1648,6 +1654,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
      * ID of the tool call.
      */
     toolCallId: string;
+    title?: string;
     /**
      * Whether the tool call was executed by the provider.
      */
@@ -1738,6 +1745,7 @@ type DynamicToolUIPart = {
      * ID of the tool call.
      */
     toolCallId: string;
+    title?: string;
     /**
      * Whether the tool call was executed by the provider.
      */
@@ -1863,6 +1871,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     toolName: string;
     providerExecuted?: boolean | undefined;
     dynamic?: boolean | undefined;
+    title?: string | undefined;
 } | {
     type: "tool-input-delta";
     toolCallId: string;
@@ -1875,6 +1884,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     providerExecuted?: boolean | undefined;
     providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
     dynamic?: boolean | undefined;
+    title?: string | undefined;
 } | {
     type: "tool-input-error";
     toolCallId: string;
@@ -1884,6 +1894,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
     providerExecuted?: boolean | undefined;
     providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
     dynamic?: boolean | undefined;
+    title?: string | undefined;
 } | {
     type: "tool-approval-request";
     approvalId: string;
@@ -2002,6 +2013,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     providerExecuted?: boolean;
     providerMetadata?: ProviderMetadata;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-error';
     toolCallId: string;
@@ -2011,6 +2023,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     providerMetadata?: ProviderMetadata;
     dynamic?: boolean;
     errorText: string;
+    title?: string;
 } | {
     type: 'tool-approval-request';
     approvalId: string;
@@ -2037,6 +2050,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
     toolName: string;
     providerExecuted?: boolean;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-delta';
     toolCallId: string;
@@ -2404,6 +2418,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
     providerMetadata?: ProviderMetadata;
     providerExecuted?: boolean;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-end';
     id: string;
@@ -3573,6 +3588,7 @@ type SingleRequestTextStreamPart<TOOLS extends ToolSet> = {
     toolName: string;
     providerMetadata?: ProviderMetadata;
     dynamic?: boolean;
+    title?: string;
 } | {
     type: 'tool-input-delta';
     id: string;

package/dist/index.js

@@ -849,7 +849,7 @@ function detectMediaType({
 var import_provider_utils2 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "6.0.0-beta.72" : "0.0.0-test";
+var VERSION = true ? "6.0.0-beta.74" : "0.0.0-test";
 
 // src/util/download/download.ts
 var download = async ({ url }) => {
@@ -2315,6 +2315,7 @@ async function parseToolCall({
   system,
   messages
 }) {
+  var _a16;
   try {
     if (tools == null) {
       if (toolCall.providerExecuted && toolCall.dynamic) {
@@ -2362,7 +2363,8 @@ async function parseToolCall({
       input,
       dynamic: true,
       invalid: true,
-      error
+      error,
+      title: (_a16 = tools == null ? void 0 : tools[toolCall.toolName]) == null ? void 0 : _a16.title
     };
   }
 }
@@ -2416,14 +2418,16 @@ async function doParseToolCall({
     input: parseResult.value,
     providerExecuted: toolCall.providerExecuted,
     providerMetadata: toolCall.providerMetadata,
-    dynamic: true
+    dynamic: true,
+    title: tool2.title
   } : {
     type: "tool-call",
     toolCallId: toolCall.toolCallId,
     toolName,
     input: parseResult.value,
     providerExecuted: toolCall.providerExecuted,
-    providerMetadata: toolCall.providerMetadata
+    providerMetadata: toolCall.providerMetadata,
+    title: tool2.title
   };
 }
 
@@ -3390,7 +3394,8 @@ var uiMessageChunkSchema = (0, import_provider_utils12.lazySchema)(
         toolCallId: import_v47.z.string(),
         toolName: import_v47.z.string(),
         providerExecuted: import_v47.z.boolean().optional(),
-        dynamic: import_v47.z.boolean().optional()
+        dynamic: import_v47.z.boolean().optional(),
+        title: import_v47.z.string().optional()
       }),
       import_v47.z.strictObject({
         type: import_v47.z.literal("tool-input-delta"),
@@ -3404,7 +3409,8 @@ var uiMessageChunkSchema = (0, import_provider_utils12.lazySchema)(
         input: import_v47.z.unknown(),
         providerExecuted: import_v47.z.boolean().optional(),
         providerMetadata: providerMetadataSchema.optional(),
-        dynamic: import_v47.z.boolean().optional()
+        dynamic: import_v47.z.boolean().optional(),
+        title: import_v47.z.string().optional()
       }),
       import_v47.z.strictObject({
         type: import_v47.z.literal("tool-input-error"),
@@ -3414,7 +3420,8 @@ var uiMessageChunkSchema = (0, import_provider_utils12.lazySchema)(
         providerExecuted: import_v47.z.boolean().optional(),
         providerMetadata: providerMetadataSchema.optional(),
         dynamic: import_v47.z.boolean().optional(),
-        errorText: import_v47.z.string()
+        errorText: import_v47.z.string(),
+        title: import_v47.z.string().optional()
       }),
       import_v47.z.strictObject({
         type: import_v47.z.literal("tool-approval-request"),
@@ -3973,6 +3980,9 @@ function processUIMessageStream({
               anyPart.errorText = anyOptions.errorText;
               anyPart.rawInput = anyOptions.rawInput;
               anyPart.preliminary = anyOptions.preliminary;
+              if (options.title !== void 0) {
+                anyPart.title = options.title;
+              }
               anyPart.providerExecuted = (_a17 = anyOptions.providerExecuted) != null ? _a17 : part.providerExecuted;
               if (anyOptions.providerMetadata != null && part.state === "input-available") {
                 part.callProviderMetadata = anyOptions.providerMetadata;
@@ -3982,6 +3992,7 @@ function processUIMessageStream({
                 type: `tool-${options.toolName}`,
                 toolCallId: options.toolCallId,
                 state: options.state,
+                title: options.title,
                 input: anyOptions.input,
                 output: anyOptions.output,
                 rawInput: anyOptions.rawInput,
@@ -4007,6 +4018,9 @@ function processUIMessageStream({
               anyPart.errorText = anyOptions.errorText;
               anyPart.rawInput = (_a17 = anyOptions.rawInput) != null ? _a17 : anyPart.rawInput;
               anyPart.preliminary = anyOptions.preliminary;
+              if (options.title !== void 0) {
+                anyPart.title = options.title;
+              }
               anyPart.providerExecuted = (_b2 = anyOptions.providerExecuted) != null ? _b2 : part.providerExecuted;
               if (anyOptions.providerMetadata != null && part.state === "input-available") {
                 part.callProviderMetadata = anyOptions.providerMetadata;
@@ -4022,6 +4036,7 @@ function processUIMessageStream({
                 errorText: anyOptions.errorText,
                 preliminary: anyOptions.preliminary,
                 providerExecuted: anyOptions.providerExecuted,
+                title: options.title,
                 ...anyOptions.providerMetadata != null ? { callProviderMetadata: anyOptions.providerMetadata } : {}
               });
             }
@@ -4131,7 +4146,8 @@ function processUIMessageStream({
                 text: "",
                 toolName: chunk.toolName,
                 index: toolInvocations.length,
-                dynamic: chunk.dynamic
+                dynamic: chunk.dynamic,
+                title: chunk.title
               };
               if (chunk.dynamic) {
                 updateDynamicToolPart({
@@ -4139,7 +4155,8 @@ function processUIMessageStream({
                   toolName: chunk.toolName,
                   state: "input-streaming",
                   input: void 0,
-                  providerExecuted: chunk.providerExecuted
+                  providerExecuted: chunk.providerExecuted,
+                  title: chunk.title
                 });
               } else {
                 updateToolPart({
@@ -4147,7 +4164,8 @@ function processUIMessageStream({
                   toolName: chunk.toolName,
                   state: "input-streaming",
                   input: void 0,
-                  providerExecuted: chunk.providerExecuted
+                  providerExecuted: chunk.providerExecuted,
+                  title: chunk.title
                 });
               }
               write();
@@ -4164,14 +4182,16 @@ function processUIMessageStream({
                   toolCallId: chunk.toolCallId,
                   toolName: partialToolCall.toolName,
                   state: "input-streaming",
-                  input: partialArgs
+                  input: partialArgs,
+                  title: partialToolCall.title
                 });
               } else {
                 updateToolPart({
                   toolCallId: chunk.toolCallId,
                   toolName: partialToolCall.toolName,
                   state: "input-streaming",
-                  input: partialArgs
+                  input: partialArgs,
+                  title: partialToolCall.title
                 });
               }
               write();
@@ -4185,7 +4205,8 @@ function processUIMessageStream({
                   state: "input-available",
                   input: chunk.input,
                   providerExecuted: chunk.providerExecuted,
-                  providerMetadata: chunk.providerMetadata
+                  providerMetadata: chunk.providerMetadata,
+                  title: chunk.title
                 });
               } else {
                 updateToolPart({
@@ -4194,7 +4215,8 @@ function processUIMessageStream({
                   state: "input-available",
                   input: chunk.input,
                   providerExecuted: chunk.providerExecuted,
-                  providerMetadata: chunk.providerMetadata
+                  providerMetadata: chunk.providerMetadata,
+                  title: chunk.title
                 });
               }
               write();
@@ -4254,7 +4276,8 @@ function processUIMessageStream({
                   input: toolInvocation.input,
                   output: chunk.output,
                   preliminary: chunk.preliminary,
-                  providerExecuted: chunk.providerExecuted
+                  providerExecuted: chunk.providerExecuted,
+                  title: toolInvocation.title
                 });
               } else {
                 updateToolPart({
@@ -4264,7 +4287,8 @@ function processUIMessageStream({
                   input: toolInvocation.input,
                   output: chunk.output,
                   providerExecuted: chunk.providerExecuted,
-                  preliminary: chunk.preliminary
+                  preliminary: chunk.preliminary,
+                  title: toolInvocation.title
                 });
               }
               write();
@@ -4279,7 +4303,8 @@ function processUIMessageStream({
                   state: "output-error",
                   input: toolInvocation.input,
                   errorText: chunk.errorText,
-                  providerExecuted: chunk.providerExecuted
+                  providerExecuted: chunk.providerExecuted,
+                  title: toolInvocation.title
                 });
               } else {
                 updateToolPart({
@@ -4289,7 +4314,8 @@ function processUIMessageStream({
                   input: toolInvocation.input,
                   rawInput: toolInvocation.rawInput,
                   errorText: chunk.errorText,
-                  providerExecuted: chunk.providerExecuted
+                  providerExecuted: chunk.providerExecuted,
+                  title: toolInvocation.title
                 });
               }
               write();
@@ -4779,7 +4805,8 @@ function runToolsTransformation({
                 toolName: toolCall.toolName,
                 input: toolCall.input,
                 error: (0, import_provider_utils15.getErrorMessage)(toolCall.error),
-                dynamic: true
+                dynamic: true,
+                title: toolCall.title
               });
               break;
             }
@@ -5692,7 +5719,8 @@ var DefaultStreamTextResult = class {
                       }
                       controller.enqueue({
                         ...chunk,
-                        dynamic: (_e2 = chunk.dynamic) != null ? _e2 : (tool2 == null ? void 0 : tool2.type) === "dynamic"
+                        dynamic: (_e2 = chunk.dynamic) != null ? _e2 : (tool2 == null ? void 0 : tool2.type) === "dynamic",
+                        title: tool2 == null ? void 0 : tool2.title
                       });
                       break;
                     }
@@ -6102,7 +6130,8 @@ var DefaultStreamTextResult = class {
                 toolCallId: part.id,
                 toolName: part.toolName,
                 ...part.providerExecuted != null ? { providerExecuted: part.providerExecuted } : {},
-                ...dynamic != null ? { dynamic } : {}
+                ...dynamic != null ? { dynamic } : {},
+                ...part.title != null ? { title: part.title } : {}
               });
               break;
             }
@@ -6125,7 +6154,8 @@ var DefaultStreamTextResult = class {
                   ...part.providerExecuted != null ? { providerExecuted: part.providerExecuted } : {},
                   ...part.providerMetadata != null ? { providerMetadata: part.providerMetadata } : {},
                   ...dynamic != null ? { dynamic } : {},
-                  errorText: onError(part.error)
+                  errorText: onError(part.error),
+                  ...part.title != null ? { title: part.title } : {}
                 });
               } else {
                 controller.enqueue({
@@ -6135,7 +6165,8 @@ var DefaultStreamTextResult = class {
                   input: part.input,
                   ...part.providerExecuted != null ? { providerExecuted: part.providerExecuted } : {},
                   ...part.providerMetadata != null ? { providerMetadata: part.providerMetadata } : {},
-                  ...dynamic != null ? { dynamic } : {}
+                  ...dynamic != null ? { dynamic } : {},
+                  ...part.title != null ? { title: part.title } : {}
                 });
               }
               break;
@@ -7697,7 +7728,7 @@ var objectOutputStrategy = (schema) => ({
 });
 var arrayOutputStrategy = (schema) => {
   return {
-    type: "enum",
+    type: "array",
     // wrap in object that contains array of elements, since most LLMs will not
     // be able to generate an array directly:
     // possible future optimization: use arrays directly when model supports grammar-guided generation