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

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @ai-sdk/provider-utils
 
+## 5.0.0-canary.33
+
+### Patch Changes
+
+- 2427d88: feat(ai): change Tool.sensitiveContext to telemetry.includeToolsContext and make it opt-in
+
+## 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';
         /**
@@ -1102,14 +1158,6 @@ type Context = Record<string, unknown>;
 
 type NeverOptional<N, T> = 0 extends 1 & N ? Partial<T> : [N] extends [never] ? Partial<Record<keyof T, undefined>> : T;
 
-/**
- * Top-level context properties that contain sensitive data and should be
- * excluded from telemetry.
- */
-type SensitiveContext<CONTEXT extends Context | unknown | never> = {
-    [KEY in keyof CONTEXT]?: boolean;
-} | undefined;
-
 /**
  * Tool approval request prompt part.
  */
@@ -1363,11 +1411,6 @@ type BaseTool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JS
      * The context is passed to execute function as part of the execution options.
      */
     contextSchema?: FlexibleSchema<CONTEXT>;
-    /**
-     * Marks top-level context properties that contain sensitive data and should be excluded from telemetry.
-     * Properties marked as `true` are omitted from telemetry integrations.
-     */
-    sensitiveContext?: SensitiveContext<CONTEXT>;
     /**
      * Whether the tool needs approval before it can be executed.
      *
@@ -1447,14 +1490,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 +1524,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 +1537,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> & {
     /**
@@ -1981,4 +2030,4 @@ interface ToolResult<NAME extends string, INPUT, OUTPUT> {
     dynamic?: boolean;
 }
 
-export { type Arrayable, type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type DynamicTool, type ExecutableTool, type FetchFunction, type FileData, type FileDataData, type FileDataReference, type FileDataText, type FileDataUrl, type FilePart, type FlexibleSchema, type FunctionTool, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedTool, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderExecutedTool, type ProviderExecutedToolFactory, type ProviderOptions, type ProviderReference, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type SensitiveContext, type StreamingToolCallDelta, StreamingToolCallTracker, type StreamingToolCallTrackerOptions, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asArray, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertInlineFileDataToUint8Array, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createProviderExecutedToolFactory, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, detectMediaType, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, filterNullable, generateId, getFromApi, getRuntimeEnvironmentUserAgent, getTopLevelMediaType, injectJsonInstructionIntoMessages, isAbortError, isBuffer, isCustomReasoning, isExecutableTool, isFullMediaType, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveFullMediaType, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };
+export { type Arrayable, type AssistantContent, type AssistantModelMessage, type Context, type CustomPart, DEFAULT_MAX_DOWNLOAD_SIZE, type DataContent, DelayedPromise, DownloadError, type DynamicTool, type ExecutableTool, type FetchFunction, type FileData, type FileDataData, type FileDataReference, type FileDataText, type FileDataUrl, type FilePart, type FlexibleSchema, type FunctionTool, type HasRequiredKey, type IdGenerator, type ImagePart, type InferSchema, type InferToolContext, type InferToolInput, type InferToolOutput, type InferToolSetContext, type LazySchema, type MaybePromiseLike, type ModelMessage, type ParseResult, type ProviderDefinedTool, type ProviderDefinedToolFactory, type ProviderDefinedToolFactoryWithOutputSchema, type ProviderExecutedTool, type ProviderExecutedToolFactory, type ProviderOptions, type ProviderReference, type ReasoningFilePart, type ReasoningPart, type Resolvable, type ResponseHandler, type Schema, type StreamingToolCallDelta, StreamingToolCallTracker, type StreamingToolCallTrackerOptions, type SystemModelMessage, type TextPart, type Tool, type ToolApprovalRequest, type ToolApprovalResponse, type ToolCall, type ToolCallPart, type ToolContent, type ToolExecuteFunction, type ToolExecutionOptions, type ToolModelMessage, type ToolNameMapping, type ToolNeedsApprovalFunction, type ToolResult, type ToolResultOutput, type ToolResultPart, type ToolSet, type UserContent, type UserModelMessage, VERSION, type ValidationResult, asArray, asSchema, combineHeaders, convertAsyncIteratorToReadableStream, convertBase64ToUint8Array, convertImageModelFileToDataUri, convertInlineFileDataToUint8Array, convertToBase64, convertToFormData, convertUint8ArrayToBase64, createBinaryResponseHandler, createEventSourceResponseHandler, createIdGenerator, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderDefinedToolFactory, createProviderDefinedToolFactoryWithOutputSchema, createProviderExecutedToolFactory, createStatusCodeErrorResponseHandler, createToolNameMapping, delay, detectMediaType, downloadBlob, dynamicTool, executeTool, extractResponseHeaders, filterNullable, generateId, getFromApi, getRuntimeEnvironmentUserAgent, getTopLevelMediaType, injectJsonInstructionIntoMessages, isAbortError, isBuffer, isCustomReasoning, isExecutableTool, isFullMediaType, isNonNullable, isParsableJson, isProviderReference, isUrlSupported, jsonSchema, lazySchema, loadApiKey, loadOptionalSetting, loadSetting, mapReasoningToProviderBudget, mapReasoningToProviderEffort, mediaTypeToExtension, normalizeHeaders, parseJSON, parseJsonEventStream, parseProviderOptions, postFormDataToApi, postJsonToApi, postToApi, readResponseWithSizeLimit, removeUndefinedEntries, resolve, resolveFullMediaType, resolveProviderReference, safeParseJSON, safeValidateTypes, serializeModelOptions, stripFileExtension, tool, validateDownloadUrl, validateTypes, withUserAgentSuffix, withoutTrailingSlash, zodSchema };

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.33" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;