@ai-sdk/provider-utils 5.0.0-beta.3 → 5.0.0-beta.4

package/CHANGELOG.md

@@ -1,5 +1,80 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-beta.4
+
+### Major Changes
+
+- 61753c3: ### `@ai-sdk/openai`: remove redundant `name` argument from `openai.tools.customTool()`
+
+  `openai.tools.customTool()` no longer accepts a `name` field. the tool name is now derived from the sdk tool key (the object key in the `tools` object).
+
+  migration: remove the `name` property from `customTool()` calls. the object key is now used as the tool name sent to the openai api.
+
+  before:
+
+  ```ts
+  tools: {
+    write_sql: openai.tools.customTool({
+      name: 'write_sql',
+      description: '...',
+    }),
+  }
+  ```
+
+  after:
+
+  ```ts
+  tools: {
+    write_sql: openai.tools.customTool({
+      description: '...',
+    }),
+  }
+  ```
+
+  ### `@ai-sdk/provider-utils`: `createToolNameMapping()` no longer accepts the `resolveProviderToolName` parameter
+
+  before: tool name can be set dynamically
+
+  ```ts
+  const toolNameMapping = createToolNameMapping({
+    tools,
+    providerToolNames: {
+      'openai.code_interpreter': 'code_interpreter',
+      'openai.file_search': 'file_search',
+      'openai.image_generation': 'image_generation',
+      'openai.local_shell': 'local_shell',
+      'openai.shell': 'shell',
+      'openai.web_search': 'web_search',
+      'openai.web_search_preview': 'web_search_preview',
+      'openai.mcp': 'mcp',
+      'openai.apply_patch': 'apply_patch',
+    },
+    resolveProviderToolName: tool =>
+      tool.id === 'openai.custom'
+        ? (tool.args as { name?: string }).name
+        : undefined,
+  });
+  ```
+
+  after: tool name is static based on `tools` keys
+
+  ```
+  const toolNameMapping = createToolNameMapping({
+    tools,
+    providerToolNames: {
+      'openai.code_interpreter': 'code_interpreter',
+      'openai.file_search': 'file_search',
+      'openai.image_generation': 'image_generation',
+      'openai.local_shell': 'local_shell',
+      'openai.shell': 'shell',
+      'openai.web_search': 'web_search',
+      'openai.web_search_preview': 'web_search_preview',
+      'openai.mcp': 'mcp',
+      'openai.apply_patch': 'apply_patch',
+    }
+  });
+  ```
+
 ## 5.0.0-beta.3
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, ImageModelV3File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions, TypeValidationContext } from '@ai-sdk/provider';
+import { LanguageModelV4FunctionTool, LanguageModelV4ProviderTool, ImageModelV4File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV4Prompt, SharedV4ProviderOptions, TypeValidationContext } from '@ai-sdk/provider';
 import { StandardSchemaV1, StandardJSONSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -41,20 +41,15 @@ interface ToolNameMapping {
  * @param tools - Tools that were passed to the language model.
  * @param providerToolNames - Maps the provider tool ids to the provider tool names.
  */
-declare function createToolNameMapping({ tools, providerToolNames, resolveProviderToolName, }: {
+declare function createToolNameMapping({ tools, providerToolNames, }: {
     /**
      * Tools that were passed to the language model.
      */
-    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool> | undefined;
+    tools: Array<LanguageModelV4FunctionTool | LanguageModelV4ProviderTool> | undefined;
     /**
      * Maps the provider tool ids to the provider tool names.
      */
     providerToolNames: Record<`${string}.${string}`, string>;
-    /**
-     * Optional resolver for provider tool names that cannot be represented as
-     * static id -> name mappings (e.g. dynamic provider names).
-     */
-    resolveProviderToolName?: (tool: LanguageModelV3ProviderTool) => string | undefined;
 }): ToolNameMapping;
 
 /**
@@ -97,13 +92,13 @@ declare function extractResponseHeaders(response: Response): {
 };
 
 /**
- * Convert an ImageModelV3File to a URL or data URI string.
+ * Convert an ImageModelV4File to a URL or data URI string.
  *
  * If the file is a URL, it returns the URL as-is.
  * If the file is base64 data, it returns a data URI with the base64 data.
  * If the file is a Uint8Array, it converts it to base64 and returns a data URI.
  */
-declare function convertImageModelFileToDataUri(file: ImageModelV3File): string;
+declare function convertImageModelFileToDataUri(file: ImageModelV4File): string;
 
 /**
  * Converts an input object to FormData for multipart/form-data requests.
@@ -390,11 +385,11 @@ declare const getFromApi: <T>({ url, headers, successfulResponseHandler, failedR
 declare function getRuntimeEnvironmentUserAgent(globalThisAny?: any): string;
 
 declare function injectJsonInstructionIntoMessages({ messages, schema, schemaPrefix, schemaSuffix, }: {
-    messages: LanguageModelV3Prompt;
+    messages: LanguageModelV4Prompt;
     schema?: JSONSchema7;
     schemaPrefix?: string;
     schemaSuffix?: string;
-}): LanguageModelV3Prompt;
+}): LanguageModelV4Prompt;
 
 declare function isAbortError(error: unknown): error is Error;
 
@@ -549,7 +544,7 @@ type DataContent = string | Uint8Array | ArrayBuffer | Buffer;
  * They are passed through to the provider from the AI SDK and enable
  * provider-specific functionality that can be fully encapsulated in the provider.
  */
-type ProviderOptions = SharedV3ProviderOptions;
+type ProviderOptions = SharedV4ProviderOptions;
 
 /**
  * Text content part of a prompt. It contains a string of text.
@@ -1145,6 +1140,8 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      * Optional conversion function that maps the tool result to an output that can be used by the language model.
      *
      * If not provided, the tool result will be sent as a JSON object.
+     *
+     * This function is invoked on the server by `convertToModelMessages`, so ensure that you pass the same "tools" (ToolSet) to both "convertToModelMessages" and "streamText" (or other generation APIs).
      */
     toModelOutput?: (options: {
         /**

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, ImageModelV3File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions, TypeValidationContext } from '@ai-sdk/provider';
+import { LanguageModelV4FunctionTool, LanguageModelV4ProviderTool, ImageModelV4File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV4Prompt, SharedV4ProviderOptions, TypeValidationContext } from '@ai-sdk/provider';
 import { StandardSchemaV1, StandardJSONSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -41,20 +41,15 @@ interface ToolNameMapping {
  * @param tools - Tools that were passed to the language model.
  * @param providerToolNames - Maps the provider tool ids to the provider tool names.
  */
-declare function createToolNameMapping({ tools, providerToolNames, resolveProviderToolName, }: {
+declare function createToolNameMapping({ tools, providerToolNames, }: {
     /**
      * Tools that were passed to the language model.
      */
-    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool> | undefined;
+    tools: Array<LanguageModelV4FunctionTool | LanguageModelV4ProviderTool> | undefined;
     /**
      * Maps the provider tool ids to the provider tool names.
      */
     providerToolNames: Record<`${string}.${string}`, string>;
-    /**
-     * Optional resolver for provider tool names that cannot be represented as
-     * static id -> name mappings (e.g. dynamic provider names).
-     */
-    resolveProviderToolName?: (tool: LanguageModelV3ProviderTool) => string | undefined;
 }): ToolNameMapping;
 
 /**
@@ -97,13 +92,13 @@ declare function extractResponseHeaders(response: Response): {
 };
 
 /**
- * Convert an ImageModelV3File to a URL or data URI string.
+ * Convert an ImageModelV4File to a URL or data URI string.
  *
  * If the file is a URL, it returns the URL as-is.
  * If the file is base64 data, it returns a data URI with the base64 data.
  * If the file is a Uint8Array, it converts it to base64 and returns a data URI.
  */
-declare function convertImageModelFileToDataUri(file: ImageModelV3File): string;
+declare function convertImageModelFileToDataUri(file: ImageModelV4File): string;
 
 /**
  * Converts an input object to FormData for multipart/form-data requests.
@@ -390,11 +385,11 @@ declare const getFromApi: <T>({ url, headers, successfulResponseHandler, failedR
 declare function getRuntimeEnvironmentUserAgent(globalThisAny?: any): string;
 
 declare function injectJsonInstructionIntoMessages({ messages, schema, schemaPrefix, schemaSuffix, }: {
-    messages: LanguageModelV3Prompt;
+    messages: LanguageModelV4Prompt;
     schema?: JSONSchema7;
     schemaPrefix?: string;
     schemaSuffix?: string;
-}): LanguageModelV3Prompt;
+}): LanguageModelV4Prompt;
 
 declare function isAbortError(error: unknown): error is Error;
 
@@ -549,7 +544,7 @@ type DataContent = string | Uint8Array | ArrayBuffer | Buffer;
  * They are passed through to the provider from the AI SDK and enable
  * provider-specific functionality that can be fully encapsulated in the provider.
  */
-type ProviderOptions = SharedV3ProviderOptions;
+type ProviderOptions = SharedV4ProviderOptions;
 
 /**
  * Text content part of a prompt. It contains a string of text.
@@ -1145,6 +1140,8 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      * Optional conversion function that maps the tool result to an output that can be used by the language model.
      *
      * If not provided, the tool result will be sent as a JSON object.
+     *
+     * This function is invoked on the server by `convertToModelMessages`, so ensure that you pass the same "tools" (ToolSet) to both "convertToModelMessages" and "streamText" (or other generation APIs).
      */
     toModelOutput?: (options: {
         /**

package/dist/index.js

@@ -146,30 +146,25 @@ function convertAsyncIteratorToReadableStream(iterator) {
 // src/create-tool-name-mapping.ts
 function createToolNameMapping({
   tools = [],
-  providerToolNames,
-  resolveProviderToolName
+  providerToolNames
 }) {
-  var _a2;
   const customToolNameToProviderToolName = {};
   const providerToolNameToCustomToolName = {};
   for (const tool2 of tools) {
-    if (tool2.type === "provider") {
-      const providerToolName = (_a2 = resolveProviderToolName == null ? void 0 : resolveProviderToolName(tool2)) != null ? _a2 : tool2.id in providerToolNames ? providerToolNames[tool2.id] : void 0;
-      if (providerToolName == null) {
-        continue;
-      }
+    if (tool2.type === "provider" && tool2.id in providerToolNames) {
+      const providerToolName = providerToolNames[tool2.id];
       customToolNameToProviderToolName[tool2.name] = providerToolName;
       providerToolNameToCustomToolName[providerToolName] = tool2.name;
     }
   }
   return {
     toProviderToolName: (customToolName) => {
-      var _a3;
-      return (_a3 = customToolNameToProviderToolName[customToolName]) != null ? _a3 : customToolName;
+      var _a2;
+      return (_a2 = customToolNameToProviderToolName[customToolName]) != null ? _a2 : customToolName;
     },
     toCustomToolName: (providerToolName) => {
-      var _a3;
-      return (_a3 = providerToolNameToCustomToolName[providerToolName]) != null ? _a3 : providerToolName;
+      var _a2;
+      return (_a2 = providerToolNameToCustomToolName[providerToolName]) != null ? _a2 : providerToolName;
     }
   };
 }
@@ -675,7 +670,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-beta.3" : "0.0.0-test";
+var VERSION = true ? "5.0.0-beta.4" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;