@ai-sdk/provider-utils 4.0.0-beta.38 → 4.0.0-beta.39

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @ai-sdk/provider-utils
 
+## 4.0.0-beta.39
+
+### Patch Changes
+
+- 954c356: feat(openai): allow custom names for provider-defined tools
+- Updated dependencies [954c356]
+  - @ai-sdk/provider@3.0.0-beta.21
+
 ## 4.0.0-beta.38
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions } from '@ai-sdk/provider';
+import { LanguageModelV3FunctionTool, LanguageModelV3ProviderDefinedTool, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions } from '@ai-sdk/provider';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -16,6 +16,42 @@ declare function combineHeaders(...headers: Array<Record<string, string | undefi
  */
 declare function convertAsyncIteratorToReadableStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
 
+/**
+ * Interface for mapping between custom tool names and provider tool names.
+ */
+interface ToolNameMapping {
+    /**
+     * Maps a custom tool name (used by the client) to the provider's tool name.
+     * If the custom tool name does not have a mapping, returns the input name.
+     *
+     * @param customToolName - The custom name of the tool defined by the client.
+     * @returns The corresponding provider tool name, or the input name if not mapped.
+     */
+    toProviderToolName: (customToolName: string) => string;
+    /**
+     * Maps a provider tool name to the custom tool name used by the client.
+     * If the provider tool name does not have a mapping, returns the input name.
+     *
+     * @param providerToolName - The name of the tool as understood by the provider.
+     * @returns The corresponding custom tool name, or the input name if not mapped.
+     */
+    toCustomToolName: (providerToolName: string) => string;
+}
+/**
+ * @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, }: {
+    /**
+     * Tools that were passed to the language model.
+     */
+    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool> | undefined;
+    /**
+     * Maps the provider tool ids to the provider tool names.
+     */
+    providerToolNames: Record<`${string}.${string}`, string>;
+}): ToolNameMapping;
+
 /**
  * Creates a Promise that resolves after a specified delay
  * @param delayInMs - The delay duration in milliseconds. If null or undefined, resolves immediately.
@@ -960,14 +996,10 @@ Tool with provider-defined input and output schemas.
  */
     type: 'provider-defined';
     /**
-The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
+The ID of the tool. Must follow the format `<provider-name>.<unique-tool-name>`.
 */
     id: `${string}.${string}`;
     /**
-The name of the tool that the user must use in the tool set.
-*/
-    name: string;
-    /**
 The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
  */
     args: Record<string, unknown>;
@@ -1013,9 +1045,8 @@ type ProviderDefinedToolFactory<INPUT, ARGS extends object> = <OUTPUT>(options:
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];
     onInputAvailable?: Tool<INPUT, OUTPUT>['onInputAvailable'];
 }) => Tool<INPUT, OUTPUT>;
-declare function createProviderDefinedToolFactory<INPUT, ARGS extends object>({ id, name, inputSchema, }: {
+declare function createProviderDefinedToolFactory<INPUT, ARGS extends object>({ id, inputSchema, }: {
     id: `${string}.${string}`;
-    name: string;
     inputSchema: FlexibleSchema<INPUT>;
 }): ProviderDefinedToolFactory<INPUT, ARGS>;
 type ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object> = (options: ARGS & {
@@ -1026,9 +1057,8 @@ type ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends obje
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];
     onInputAvailable?: Tool<INPUT, OUTPUT>['onInputAvailable'];
 }) => Tool<INPUT, OUTPUT>;
-declare function createProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object>({ id, name, inputSchema, outputSchema, }: {
+declare function createProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object>({ id, inputSchema, outputSchema, }: {
     id: `${string}.${string}`;
-    name: string;
     inputSchema: FlexibleSchema<INPUT>;
     outputSchema: FlexibleSchema<OUTPUT>;
 }): ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS>;
@@ -1173,4 +1203,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, DelayedPromise, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, type DataContent, DelayedPromise, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions } from '@ai-sdk/provider';
+import { LanguageModelV3FunctionTool, LanguageModelV3ProviderDefinedTool, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions } from '@ai-sdk/provider';
 import { StandardSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -16,6 +16,42 @@ declare function combineHeaders(...headers: Array<Record<string, string | undefi
  */
 declare function convertAsyncIteratorToReadableStream<T>(iterator: AsyncIterator<T>): ReadableStream<T>;
 
+/**
+ * Interface for mapping between custom tool names and provider tool names.
+ */
+interface ToolNameMapping {
+    /**
+     * Maps a custom tool name (used by the client) to the provider's tool name.
+     * If the custom tool name does not have a mapping, returns the input name.
+     *
+     * @param customToolName - The custom name of the tool defined by the client.
+     * @returns The corresponding provider tool name, or the input name if not mapped.
+     */
+    toProviderToolName: (customToolName: string) => string;
+    /**
+     * Maps a provider tool name to the custom tool name used by the client.
+     * If the provider tool name does not have a mapping, returns the input name.
+     *
+     * @param providerToolName - The name of the tool as understood by the provider.
+     * @returns The corresponding custom tool name, or the input name if not mapped.
+     */
+    toCustomToolName: (providerToolName: string) => string;
+}
+/**
+ * @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, }: {
+    /**
+     * Tools that were passed to the language model.
+     */
+    tools: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool> | undefined;
+    /**
+     * Maps the provider tool ids to the provider tool names.
+     */
+    providerToolNames: Record<`${string}.${string}`, string>;
+}): ToolNameMapping;
+
 /**
  * Creates a Promise that resolves after a specified delay
  * @param delayInMs - The delay duration in milliseconds. If null or undefined, resolves immediately.
@@ -960,14 +996,10 @@ Tool with provider-defined input and output schemas.
  */
     type: 'provider-defined';
     /**
-The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
+The ID of the tool. Must follow the format `<provider-name>.<unique-tool-name>`.
 */
     id: `${string}.${string}`;
     /**
-The name of the tool that the user must use in the tool set.
-*/
-    name: string;
-    /**
 The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
  */
     args: Record<string, unknown>;
@@ -1013,9 +1045,8 @@ type ProviderDefinedToolFactory<INPUT, ARGS extends object> = <OUTPUT>(options:
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];
     onInputAvailable?: Tool<INPUT, OUTPUT>['onInputAvailable'];
 }) => Tool<INPUT, OUTPUT>;
-declare function createProviderDefinedToolFactory<INPUT, ARGS extends object>({ id, name, inputSchema, }: {
+declare function createProviderDefinedToolFactory<INPUT, ARGS extends object>({ id, inputSchema, }: {
     id: `${string}.${string}`;
-    name: string;
     inputSchema: FlexibleSchema<INPUT>;
 }): ProviderDefinedToolFactory<INPUT, ARGS>;
 type ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object> = (options: ARGS & {
@@ -1026,9 +1057,8 @@ type ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends obje
     onInputDelta?: Tool<INPUT, OUTPUT>['onInputDelta'];
     onInputAvailable?: Tool<INPUT, OUTPUT>['onInputAvailable'];
 }) => Tool<INPUT, OUTPUT>;
-declare function createProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object>({ id, name, inputSchema, outputSchema, }: {
+declare function createProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS extends object>({ id, inputSchema, outputSchema, }: {
     id: `${string}.${string}`;
-    name: string;
     inputSchema: FlexibleSchema<INPUT>;
     outputSchema: FlexibleSchema<OUTPUT>;
 }): ProviderDefinedToolFactoryWithOutputSchema<INPUT, OUTPUT, ARGS>;
@@ -1173,4 +1203,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type AssistantContent, type AssistantModelMessage, type DataContent, DelayedPromise, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type AssistantContent, type AssistantModelMessage, type DataContent, DelayedPromise, type FetchFunction, type FilePart, type FlexibleSchema, type IdGenerator, type ImagePart, type InferSchema, type InferToolInput, type InferToolOutput, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderOptions, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallOptions, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertToBase64, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, dynamicTool, executeTool, extractResponseHeaders, generateId, getErrorMessage, getFromApi, getRuntimeEnvironmentUserAgent, injectJsonInstructionIntoMessages, isAbortError, isNonNullable, isParsableJson, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, removeUndefinedEntries, resolve, safeParseJSON, safeValidateTypes, tool, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

package/dist/index.js

@@ -48,6 +48,7 @@ __export(src_exports, {
   createProviderDefinedToolFactory: () => createProviderDefinedToolFactory,
   createProviderDefinedToolFactoryWithOutputSchema: () => createProviderDefinedToolFactoryWithOutputSchema,
   createStatusCodeErrorResponseHandler: () => createStatusCodeErrorResponseHandler,
+  createToolNameMapping: () => createToolNameMapping,
   delay: () => delay,
   dynamicTool: () => dynamicTool,
   executeTool: () => executeTool,
@@ -135,6 +136,32 @@ function convertAsyncIteratorToReadableStream(iterator) {
   });
 }
 
+// src/create-tool-name-mapping.ts
+function createToolNameMapping({
+  tools = [],
+  providerToolNames
+}) {
+  const customToolNameToProviderToolName = {};
+  const providerToolNameToCustomToolName = {};
+  for (const tool2 of tools) {
+    if (tool2.type === "provider-defined" && tool2.id in providerToolNames) {
+      const providerToolName = providerToolNames[tool2.id];
+      customToolNameToProviderToolName[tool2.name] = providerToolName;
+      providerToolNameToCustomToolName[providerToolName] = tool2.name;
+    }
+  }
+  return {
+    toProviderToolName: (customToolName) => {
+      var _a;
+      return (_a = customToolNameToProviderToolName[customToolName]) != null ? _a : customToolName;
+    },
+    toCustomToolName: (providerToolName) => {
+      var _a;
+      return (_a = providerToolNameToCustomToolName[providerToolName]) != null ? _a : providerToolName;
+    }
+  };
+}
+
 // src/delay.ts
 async function delay(delayInMs, options) {
   if (delayInMs == null) {
@@ -351,7 +378,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.0-beta.38" : "0.0.0-test";
+var VERSION = true ? "4.0.0-beta.39" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;
@@ -2226,7 +2253,6 @@ function dynamicTool(tool2) {
 // src/provider-defined-tool-factory.ts
 function createProviderDefinedToolFactory({
   id,
-  name,
   inputSchema
 }) {
   return ({
@@ -2241,7 +2267,6 @@ function createProviderDefinedToolFactory({
   }) => tool({
     type: "provider-defined",
     id,
-    name,
     args,
     inputSchema,
     outputSchema,
@@ -2255,7 +2280,6 @@ function createProviderDefinedToolFactory({
 }
 function createProviderDefinedToolFactoryWithOutputSchema({
   id,
-  name,
   inputSchema,
   outputSchema
 }) {
@@ -2270,7 +2294,6 @@ function createProviderDefinedToolFactoryWithOutputSchema({
   }) => tool({
     type: "provider-defined",
     id,
-    name,
     args,
     inputSchema,
     outputSchema,
@@ -2506,6 +2529,7 @@ var import_stream2 = require("eventsource-parser/stream");
   createProviderDefinedToolFactory,
   createProviderDefinedToolFactoryWithOutputSchema,
   createStatusCodeErrorResponseHandler,
+  createToolNameMapping,
   delay,
   dynamicTool,
   executeTool,