@ai-sdk/provider 3.0.0-beta.6 → 3.0.0-beta.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider
 
+## 3.0.0-beta.8
+
+### Patch Changes
+
+- 3794514: feat: flexible tool output content support
+
+## 3.0.0-beta.7
+
+### Patch Changes
+
+- 81d4308: feat: provider-executed dynamic tools
+
 ## 3.0.0-beta.6
 
 ### Major Changes

package/dist/index.d.mts

@@ -1020,11 +1020,22 @@ interface LanguageModelV3ToolResultPart {
  * Result of a tool call.
  */
 type LanguageModelV3ToolResultOutput = {
+    /**
+     * Text tool output that should be directly sent to the API.
+     */
     type: 'text';
     value: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'json';
     value: JSONValue;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     /**
      * Type when the user has denied the execution of the tool call.
@@ -1034,12 +1045,24 @@ type LanguageModelV3ToolResultOutput = {
      * Optional reason for the execution denial.
      */
     reason?: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'error-text';
     value: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'error-json';
     value: JSONValue;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'content';
     value: Array<{
@@ -1048,8 +1071,12 @@ type LanguageModelV3ToolResultOutput = {
 Text content.
 */
         text: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
     } | {
-        type: 'media';
+        type: 'file-data';
         /**
 Base-64 encoded media data.
 */
@@ -1059,28 +1086,120 @@ IANA media type.
 @see https://www.iana.org/assignments/media-types/media-types.xhtml
 */
         mediaType: string;
+        /**
+         * Optional filename of the file.
+         */
+        filename?: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        type: 'file-url';
+        /**
+         * URL of the file.
+         */
+        url: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        type: 'file-id';
+        /**
+         * ID of the file.
+         *
+         * If you use multiple providers, you need to
+         * specify the provider specific ids using
+         * the Record option. The key is the provider
+         * name, e.g. 'openai' or 'anthropic'.
+         */
+        fileId: string | Record<string, string>;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using base64 encoded data.
+         */
+        type: 'image-data';
+        /**
+Base-64 encoded image data.
+*/
+        data: string;
+        /**
+IANA media type.
+@see https://www.iana.org/assignments/media-types/media-types.xhtml
+*/
+        mediaType: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using a URL.
+         */
+        type: 'image-url';
+        /**
+         * URL of the image.
+         */
+        url: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using a provider file id.
+         */
+        type: 'image-file-id';
+        /**
+         * Image that is referenced using a provider file id.
+         *
+         * If you use multiple providers, you need to
+         * specify the provider specific ids using
+         * the Record option. The key is the provider
+         * name, e.g. 'openai' or 'anthropic'.
+         */
+        fileId: string | Record<string, string>;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Custom content part. This can be used to implement
+         * provider-specific content parts.
+         */
+        type: 'custom';
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
     }>;
 };
 
 /**
-The configuration of a tool that is defined by the provider.
+ * The configuration of a tool that is defined by the provider.
  */
 type LanguageModelV3ProviderDefinedTool = {
     /**
-  The type of the tool (always 'provider-defined').
+     * The type of the tool (always 'provider-defined').
      */
     type: 'provider-defined';
     /**
-  The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
+     * 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 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.
-    */
+     * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+     */
     args: Record<string, unknown>;
 };
 
@@ -1337,6 +1456,11 @@ type LanguageModelV3ToolCall = {
      * If this flag is not set or is false, the tool call will be executed by the client.
      */
     providerExecuted?: boolean;
+    /**
+     * Whether the tool is dynamic, i.e. defined at runtime.
+     * For example, MCP (Model Context Protocol) tools that are executed by the provider.
+     */
+    dynamic?: boolean;
     /**
      * Additional provider-specific metadata for the tool call.
      */
@@ -1381,6 +1505,11 @@ type LanguageModelV3ToolResult = {
      * If this flag is not set or is false, the tool result is not preliminary.
      */
     preliminary?: boolean;
+    /**
+     * Whether the tool is dynamic, i.e. defined at runtime.
+     * For example, MCP (Model Context Protocol) tools that are executed by the provider.
+     */
+    dynamic?: boolean;
     /**
      * Additional provider-specific metadata for the tool result.
      */
@@ -1481,6 +1610,7 @@ type LanguageModelV3StreamPart = {
     toolName: string;
     providerMetadata?: SharedV3ProviderMetadata;
     providerExecuted?: boolean;
+    dynamic?: boolean;
 } | {
     type: 'tool-input-delta';
     id: string;
@@ -1517,11 +1647,11 @@ type LanguageModelV3 = {
      */
     readonly specificationVersion: 'v3';
     /**
-  Name of the provider for logging purposes.
+  Provider ID.
      */
     readonly provider: string;
     /**
-  Provider-specific model ID for logging purposes.
+  Provider-specific model ID.
      */
     readonly modelId: string;
     /**

package/dist/index.d.ts

@@ -1020,11 +1020,22 @@ interface LanguageModelV3ToolResultPart {
  * Result of a tool call.
  */
 type LanguageModelV3ToolResultOutput = {
+    /**
+     * Text tool output that should be directly sent to the API.
+     */
     type: 'text';
     value: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'json';
     value: JSONValue;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     /**
      * Type when the user has denied the execution of the tool call.
@@ -1034,12 +1045,24 @@ type LanguageModelV3ToolResultOutput = {
      * Optional reason for the execution denial.
      */
     reason?: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'error-text';
     value: string;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'error-json';
     value: JSONValue;
+    /**
+     * Provider-specific options.
+     */
+    providerOptions?: SharedV3ProviderOptions;
 } | {
     type: 'content';
     value: Array<{
@@ -1048,8 +1071,12 @@ type LanguageModelV3ToolResultOutput = {
 Text content.
 */
         text: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
     } | {
-        type: 'media';
+        type: 'file-data';
         /**
 Base-64 encoded media data.
 */
@@ -1059,28 +1086,120 @@ IANA media type.
 @see https://www.iana.org/assignments/media-types/media-types.xhtml
 */
         mediaType: string;
+        /**
+         * Optional filename of the file.
+         */
+        filename?: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        type: 'file-url';
+        /**
+         * URL of the file.
+         */
+        url: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        type: 'file-id';
+        /**
+         * ID of the file.
+         *
+         * If you use multiple providers, you need to
+         * specify the provider specific ids using
+         * the Record option. The key is the provider
+         * name, e.g. 'openai' or 'anthropic'.
+         */
+        fileId: string | Record<string, string>;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using base64 encoded data.
+         */
+        type: 'image-data';
+        /**
+Base-64 encoded image data.
+*/
+        data: string;
+        /**
+IANA media type.
+@see https://www.iana.org/assignments/media-types/media-types.xhtml
+*/
+        mediaType: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using a URL.
+         */
+        type: 'image-url';
+        /**
+         * URL of the image.
+         */
+        url: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Images that are referenced using a provider file id.
+         */
+        type: 'image-file-id';
+        /**
+         * Image that is referenced using a provider file id.
+         *
+         * If you use multiple providers, you need to
+         * specify the provider specific ids using
+         * the Record option. The key is the provider
+         * name, e.g. 'openai' or 'anthropic'.
+         */
+        fileId: string | Record<string, string>;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
+    } | {
+        /**
+         * Custom content part. This can be used to implement
+         * provider-specific content parts.
+         */
+        type: 'custom';
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: SharedV3ProviderOptions;
     }>;
 };
 
 /**
-The configuration of a tool that is defined by the provider.
+ * The configuration of a tool that is defined by the provider.
  */
 type LanguageModelV3ProviderDefinedTool = {
     /**
-  The type of the tool (always 'provider-defined').
+     * The type of the tool (always 'provider-defined').
      */
     type: 'provider-defined';
     /**
-  The ID of the tool. Should follow the format `<provider-name>.<unique-tool-name>`.
+     * 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 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.
-    */
+     * The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool.
+     */
     args: Record<string, unknown>;
 };
 
@@ -1337,6 +1456,11 @@ type LanguageModelV3ToolCall = {
      * If this flag is not set or is false, the tool call will be executed by the client.
      */
     providerExecuted?: boolean;
+    /**
+     * Whether the tool is dynamic, i.e. defined at runtime.
+     * For example, MCP (Model Context Protocol) tools that are executed by the provider.
+     */
+    dynamic?: boolean;
     /**
      * Additional provider-specific metadata for the tool call.
      */
@@ -1381,6 +1505,11 @@ type LanguageModelV3ToolResult = {
      * If this flag is not set or is false, the tool result is not preliminary.
      */
     preliminary?: boolean;
+    /**
+     * Whether the tool is dynamic, i.e. defined at runtime.
+     * For example, MCP (Model Context Protocol) tools that are executed by the provider.
+     */
+    dynamic?: boolean;
     /**
      * Additional provider-specific metadata for the tool result.
      */
@@ -1481,6 +1610,7 @@ type LanguageModelV3StreamPart = {
     toolName: string;
     providerMetadata?: SharedV3ProviderMetadata;
     providerExecuted?: boolean;
+    dynamic?: boolean;
 } | {
     type: 'tool-input-delta';
     id: string;
@@ -1517,11 +1647,11 @@ type LanguageModelV3 = {
      */
     readonly specificationVersion: 'v3';
     /**
-  Name of the provider for logging purposes.
+  Provider ID.
      */
     readonly provider: string;
     /**
-  Provider-specific model ID for logging purposes.
+  Provider-specific model ID.
      */
     readonly modelId: string;
     /**

package/package.json

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