@ai-sdk/provider 3.0.0-beta.20 → 3.0.0-beta.22

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider
 
+## 3.0.0-beta.22
+
+### Patch Changes
+
+- 544d4e8: chore(specification): rename v3 provider defined tool to provider tool
+
+## 3.0.0-beta.21
+
+### Patch Changes
+
+- 954c356: feat(openai): allow custom names for provider-defined tools
+
 ## 3.0.0-beta.20
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1234,19 +1234,23 @@ IANA media type.
 };
 
 /**
- * The configuration of a tool that is defined by the provider.
+ * The configuration of a provider tool.
+ *
+ * Provider tools are tools that are specific to a certain provider.
+ * The input and output schemas are defined be the provider, and
+ * some of the tools are also executed on the provider systems.
  */
-type LanguageModelV3ProviderDefinedTool = {
+type LanguageModelV3ProviderTool = {
     /**
-     * The type of the tool (always 'provider-defined').
+     * The type of the tool (always 'provider').
      */
-    type: 'provider-defined';
+    type: 'provider';
     /**
      * The ID of the tool. Should follow the format `<provider-id>.<unique-tool-name>`.
      */
     id: `${string}.${string}`;
     /**
-     * The name of the tool that the user must use in the tool set.
+     * The name of the tool. Unique within this model call.
      */
     name: string;
     /**
@@ -1341,7 +1345,7 @@ type LanguageModelV3CallOptions = {
     /**
   The tools that are available for the model.
     */
-    tools?: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool>;
+    tools?: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool>;
     /**
   Specifies how the tool should be selected. Defaults to 'auto'.
   */
@@ -2077,11 +2081,11 @@ IANA media type.
 /**
 The configuration of a tool that is defined by the provider.
  */
-type LanguageModelV2ProviderDefinedTool = {
+type LanguageModelV2ProviderTool = {
     /**
-  The type of the tool (always 'provider-defined').
+  The type of the tool (always 'provider').
      */
-    type: 'provider-defined';
+    type: 'provider';
     /**
   The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
      */
@@ -2182,7 +2186,7 @@ type LanguageModelV2CallOptions = {
     /**
   The tools that are available for the model.
     */
-    tools?: Array<LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool>;
+    tools?: Array<LanguageModelV2FunctionTool | LanguageModelV2ProviderTool>;
     /**
   Specifies how the tool should be selected. Defaults to 'auto'.
   */
@@ -2218,7 +2222,7 @@ type LanguageModelV2CallWarning = {
     details?: string;
 } | {
     type: 'unsupported-tool';
-    tool: LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool;
+    tool: LanguageModelV2FunctionTool | LanguageModelV2ProviderTool;
     details?: string;
 } | {
     type: 'other';
@@ -3553,4 +3557,4 @@ interface ProviderV2 {
     speechModel?(modelId: string): SpeechModelV2;
 }
 
-export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderDefinedTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type RerankingModelV3, type RerankingModelV3CallOptions, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type RerankingModelV3, type RerankingModelV3CallOptions, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };

package/dist/index.d.ts

@@ -1234,19 +1234,23 @@ IANA media type.
 };
 
 /**
- * The configuration of a tool that is defined by the provider.
+ * The configuration of a provider tool.
+ *
+ * Provider tools are tools that are specific to a certain provider.
+ * The input and output schemas are defined be the provider, and
+ * some of the tools are also executed on the provider systems.
  */
-type LanguageModelV3ProviderDefinedTool = {
+type LanguageModelV3ProviderTool = {
     /**
-     * The type of the tool (always 'provider-defined').
+     * The type of the tool (always 'provider').
      */
-    type: 'provider-defined';
+    type: 'provider';
     /**
      * The ID of the tool. Should follow the format `<provider-id>.<unique-tool-name>`.
      */
     id: `${string}.${string}`;
     /**
-     * The name of the tool that the user must use in the tool set.
+     * The name of the tool. Unique within this model call.
      */
     name: string;
     /**
@@ -1341,7 +1345,7 @@ type LanguageModelV3CallOptions = {
     /**
   The tools that are available for the model.
     */
-    tools?: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderDefinedTool>;
+    tools?: Array<LanguageModelV3FunctionTool | LanguageModelV3ProviderTool>;
     /**
   Specifies how the tool should be selected. Defaults to 'auto'.
   */
@@ -2077,11 +2081,11 @@ IANA media type.
 /**
 The configuration of a tool that is defined by the provider.
  */
-type LanguageModelV2ProviderDefinedTool = {
+type LanguageModelV2ProviderTool = {
     /**
-  The type of the tool (always 'provider-defined').
+  The type of the tool (always 'provider').
      */
-    type: 'provider-defined';
+    type: 'provider';
     /**
   The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
      */
@@ -2182,7 +2186,7 @@ type LanguageModelV2CallOptions = {
     /**
   The tools that are available for the model.
     */
-    tools?: Array<LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool>;
+    tools?: Array<LanguageModelV2FunctionTool | LanguageModelV2ProviderTool>;
     /**
   Specifies how the tool should be selected. Defaults to 'auto'.
   */
@@ -2218,7 +2222,7 @@ type LanguageModelV2CallWarning = {
     details?: string;
 } | {
     type: 'unsupported-tool';
-    tool: LanguageModelV2FunctionTool | LanguageModelV2ProviderDefinedTool;
+    tool: LanguageModelV2FunctionTool | LanguageModelV2ProviderTool;
     details?: string;
 } | {
     type: 'other';
@@ -3553,4 +3557,4 @@ interface ProviderV2 {
     speechModel?(modelId: string): SpeechModelV2;
 }
 
-export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderDefinedTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderDefinedTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type RerankingModelV3, type RerankingModelV3CallOptions, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelCallOptions, type EmbeddingModelV2, type EmbeddingModelV2Embedding, type EmbeddingModelV3, type EmbeddingModelV3Embedding, type EmbeddingModelV3Middleware, EmptyResponseBodyError, type ImageModelV2, type ImageModelV2CallOptions, type ImageModelV2CallWarning, type ImageModelV2ProviderMetadata, type ImageModelV3, type ImageModelV3CallOptions, type ImageModelV3ProviderMetadata, type ImageModelV3Usage, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV2, type LanguageModelV2CallOptions, type LanguageModelV2CallWarning, type LanguageModelV2Content, type LanguageModelV2DataContent, type LanguageModelV2File, type LanguageModelV2FilePart, type LanguageModelV2FinishReason, type LanguageModelV2FunctionTool, type LanguageModelV2Message, type LanguageModelV2Middleware, type LanguageModelV2Prompt, type LanguageModelV2ProviderTool, type LanguageModelV2Reasoning, type LanguageModelV2ReasoningPart, type LanguageModelV2ResponseMetadata, type LanguageModelV2Source, type LanguageModelV2StreamPart, type LanguageModelV2Text, type LanguageModelV2TextPart, type LanguageModelV2ToolCall, type LanguageModelV2ToolCallPart, type LanguageModelV2ToolChoice, type LanguageModelV2ToolResultOutput, type LanguageModelV2ToolResultPart, type LanguageModelV2Usage, type LanguageModelV3, type LanguageModelV3CallOptions, type LanguageModelV3Content, type LanguageModelV3DataContent, type LanguageModelV3File, type LanguageModelV3FilePart, type LanguageModelV3FinishReason, type LanguageModelV3FunctionTool, type LanguageModelV3Message, type LanguageModelV3Middleware, type LanguageModelV3Prompt, type LanguageModelV3ProviderTool, type LanguageModelV3Reasoning, type LanguageModelV3ReasoningPart, type LanguageModelV3ResponseMetadata, type LanguageModelV3Source, type LanguageModelV3StreamPart, type LanguageModelV3Text, type LanguageModelV3TextPart, type LanguageModelV3ToolCall, type LanguageModelV3ToolCallPart, type LanguageModelV3ToolChoice, type LanguageModelV3ToolResult, type LanguageModelV3ToolResultOutput, type LanguageModelV3ToolResultPart, type LanguageModelV3Usage, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV2, type ProviderV3, type RerankingModelV3, type RerankingModelV3CallOptions, type SharedV2Headers, type SharedV2ProviderMetadata, type SharedV2ProviderOptions, type SharedV3Headers, type SharedV3ProviderMetadata, type SharedV3ProviderOptions, type SharedV3Warning, type SpeechModelV2, type SpeechModelV2CallOptions, type SpeechModelV2CallWarning, type SpeechModelV3, type SpeechModelV3CallOptions, TooManyEmbeddingValuesForCallError, type TranscriptionModelV2, type TranscriptionModelV2CallOptions, type TranscriptionModelV2CallWarning, type TranscriptionModelV3, type TranscriptionModelV3CallOptions, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/provider",
-  "version": "3.0.0-beta.20",
+  "version": "3.0.0-beta.22",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",