@ai-sdk/provider-utils 5.0.0-canary.31 → 5.0.0-canary.32

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-canary.32
+
+### Major Changes
+
+- 5463d0d: feat(provider): align tool result output content file part types with top-level message file part types
+
+### Patch Changes
+
+- Updated dependencies [5463d0d]
+  - @ai-sdk/provider@4.0.0-canary.16
+
 ## 5.0.0-canary.31
 
 ### Patch Changes

package/dist/index.d.ts

@@ -348,6 +348,45 @@ type ToolResultOutput = {
          */
         providerOptions?: ProviderOptions;
     } | {
+        type: 'file';
+        /**
+         * File data as a tagged discriminated union:
+         *
+         * - `{ type: 'data', data }`: raw bytes
+         *   (base64 string, Uint8Array, ArrayBuffer, Buffer)
+         * - `{ type: 'url', url }`: a URL that points to the file
+         * - `{ type: 'reference', reference }`: a provider reference
+         *   from `uploadFile`
+         * - `{ type: 'text', text }`: inline text content (e.g. an inline
+         *   text document)
+         */
+        data: FileData;
+        /**
+         * Either a full IANA media type (`type/subtype`, e.g. `image/png`) or just
+         * the top-level IANA segment (e.g. `image`, `audio`, `video`, `text`).
+         *
+         * `*`-subtype wildcards (e.g. `image/*`) are normalized as equivalent to the
+         * top-level segment alone (e.g. `image`). Providers can use the helpers in
+         * `@ai-sdk/provider-utils` (`isFullMediaType`, `getTopLevelMediaType`,
+         * `detectMediaType`) to resolve the field according to their API
+         * requirements.
+         *
+         * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+         */
+        mediaType: string;
+        /**
+         * Optional filename of the file.
+         */
+        filename?: string;
+        /**
+         * Provider-specific options.
+         */
+        providerOptions?: ProviderOptions;
+    } | {
+        /**
+         * @deprecated Use 'file' with mediaType + tagged data instead:
+         * `{ type: 'file', mediaType, data: { type: 'data', data } }`.
+         */
         type: 'file-data';
         /**
          * Base-64 encoded media data.
@@ -367,6 +406,10 @@ type ToolResultOutput = {
          */
         providerOptions?: ProviderOptions;
     } | {
+        /**
+         * @deprecated Use 'file' with mediaType and tagged data instead:
+         * `{ type: 'file', mediaType, data: { type: 'url', url: new URL(url) } }`.
+         */
         type: 'file-url';
         /**
          * URL of the file.
@@ -383,7 +426,8 @@ type ToolResultOutput = {
         providerOptions?: ProviderOptions;
     } | {
         /**
-         * @deprecated Use file-reference instead.
+         * @deprecated Use 'file' with tagged data instead:
+         * `{ type: 'file', mediaType, data: { type: 'reference', reference } }`.
          */
         type: 'file-id';
         /**
@@ -400,6 +444,10 @@ type ToolResultOutput = {
          */
         providerOptions?: ProviderOptions;
     } | {
+        /**
+         * @deprecated Use 'file' with tagged data instead:
+         * `{ type: 'file', mediaType, data: { type: 'reference', reference } }`.
+         */
         type: 'file-reference';
         /**
          * Provider-specific references for the file.
@@ -412,7 +460,9 @@ type ToolResultOutput = {
         providerOptions?: ProviderOptions;
     } | {
         /**
-         * @deprecated Use file-data instead.
+         * @deprecated Use 'file' with mediaType (e.g. 'image' or a specific
+         * `image/*` subtype) and tagged data instead:
+         * `{ type: 'file', mediaType: 'image', data: { type: 'data', data } }`.
          */
         type: 'image-data';
         /**
@@ -430,7 +480,9 @@ type ToolResultOutput = {
         providerOptions?: ProviderOptions;
     } | {
         /**
-         * @deprecated Use file-url instead.
+         * @deprecated Use 'file' with `mediaType: 'image'` (or a specific
+         * `image/*` subtype) and tagged data instead:
+         * `{ type: 'file', mediaType: 'image', data: { type: 'url', url: new URL(url) } }`.
          */
         type: 'image-url';
         /**
@@ -443,7 +495,9 @@ type ToolResultOutput = {
         providerOptions?: ProviderOptions;
     } | {
         /**
-         * @deprecated Use file-reference instead.
+         * @deprecated Use 'file' with `mediaType: 'image'` (or a specific
+         * `image/*` subtype) and tagged data instead:
+         * `{ type: 'file', mediaType: 'image', data: { type: 'reference', reference } }`.
          */
         type: 'image-file-id';
         /**
@@ -461,7 +515,9 @@ type ToolResultOutput = {
         providerOptions?: ProviderOptions;
     } | {
         /**
-         * @deprecated Use file-reference instead.
+         * @deprecated Use 'file' with `mediaType: 'image'` (or a specific
+         * `image/*` subtype) and tagged data instead:
+         * `{ type: 'file', mediaType: 'image', data: { type: 'reference', reference } }`.
          */
         type: 'image-file-reference';
         /**
@@ -1447,14 +1503,16 @@ type BaseFunctionTool<INPUT extends JSONValue | unknown | never = any, OUTPUT ex
     supportsDeferredResults?: never;
 };
 /**
- * Tool with user-defined input and output schemas.
+ * Tool with user-defined input and output schemas that is executed by the AI SDK.
  */
 type FunctionTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONValue | unknown | never = any, CONTEXT extends Context | unknown | never = any> = BaseFunctionTool<INPUT, OUTPUT, CONTEXT> & {
     type?: undefined | 'function';
 };
 /**
- * Tool that is defined at runtime (e.g. an MCP tool).
+ * Tool that is defined at runtime.
  * The types of input and output are not known at development time.
+ *
+ * For example, MCP tools that are not known at development time.
  */
 type DynamicTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONValue | unknown | never = any, CONTEXT extends Context | unknown | never = any> = BaseFunctionTool<INPUT, OUTPUT, CONTEXT> & {
     type: 'dynamic';
@@ -1479,6 +1537,8 @@ type BaseProviderTool<INPUT extends JSONValue | unknown | never = any, OUTPUT ex
 /**
  * Tool with provider-defined input and output schemas that is executed by the
  * user.
+ *
+ * For example, shell tools that are executed in a local shell, but have provider-defined input and output schemas.
  */
 type ProviderDefinedTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONValue | unknown | never = any, CONTEXT extends Context | unknown | never = any> = BaseProviderTool<INPUT, OUTPUT, CONTEXT> & {
     /**
@@ -1490,6 +1550,8 @@ type ProviderDefinedTool<INPUT extends JSONValue | unknown | never = any, OUTPUT
 /**
  * Tool with provider-defined input and output schemas that is executed by the
  * provider.
+ *
+ * For example, web search tools and code execution tools that are executed by the provider itself.
  */
 type ProviderExecutedTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONValue | unknown | never = any, CONTEXT extends Context | unknown | never = any> = BaseProviderTool<INPUT, OUTPUT, CONTEXT> & {
     /**

package/dist/index.js

@@ -862,7 +862,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "5.0.0-canary.31" : "0.0.0-test";
+var VERSION = true ? "5.0.0-canary.32" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;