@ai-sdk/provider 4.0.0-beta.1 → 4.0.0-beta.11

package/src/image-model/v4/image-model-v4.ts

@@ -1,14 +1,5 @@
-import { JSONArray, JSONValue } from '../../json-value';
-import { ImageModelV4Usage } from './image-model-v4-usage';
 import { ImageModelV4CallOptions } from './image-model-v4-call-options';
-import { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
-
-export type ImageModelV4ProviderMetadata = Record<
-  string,
-  {
-    images: JSONArray;
-  } & JSONValue
->;
+import { ImageModelV4Result } from './image-model-v4-result';
 
 type GetMaxImagesPerCallFunction = (options: {
   modelId: string;
@@ -48,63 +39,5 @@ export type ImageModelV4 = {
   /**
    * Generates an array of images.
    */
-  doGenerate(options: ImageModelV4CallOptions): PromiseLike<{
-    /**
-     * Generated images as base64 encoded strings or binary data.
-     * The images should be returned without any unnecessary conversion.
-     * If the API returns base64 encoded strings, the images should be returned
-     * as base64 encoded strings. If the API returns binary data, the images should
-     * be returned as binary data.
-     */
-    images: Array<string> | Array<Uint8Array>;
-
-    /**
-     * Warnings for the call, e.g. unsupported features.
-     */
-    warnings: Array<SharedV4Warning>;
-
-    /**
-     * Additional provider-specific metadata. They are passed through
-     * from the provider to the AI SDK and enable provider-specific
-     * results that can be fully encapsulated in the provider.
-     *
-     * The outer record is keyed by the provider name, and the inner
-     * record is provider-specific metadata. It always includes an
-     * `images` key with image-specific metadata
-     *
-     * ```ts
-     * {
-     * "openai": {
-     * "images": ["revisedPrompt": "Revised prompt here."]
-     * }
-     * }
-     * ```
-     */
-    providerMetadata?: ImageModelV4ProviderMetadata;
-
-    /**
-     * Response information for telemetry and debugging purposes.
-     */
-    response: {
-      /**
-       * Timestamp for the start of the generated response.
-       */
-      timestamp: Date;
-
-      /**
-       * The ID of the response model that was used to generate the response.
-       */
-      modelId: string;
-
-      /**
-       * Response headers.
-       */
-      headers: Record<string, string> | undefined;
-    };
-
-    /**
-     * Optional token usage for the image generation call (if the provider reports it).
-     */
-    usage?: ImageModelV4Usage;
-  }>;
+  doGenerate(options: ImageModelV4CallOptions): PromiseLike<ImageModelV4Result>;
 };

package/src/image-model/v4/index.ts

@@ -1,7 +1,8 @@
+export type { ImageModelV4 } from './image-model-v4';
+export type { ImageModelV4CallOptions } from './image-model-v4-call-options';
 export type {
-  ImageModelV4,
   ImageModelV4ProviderMetadata,
-} from './image-model-v4';
-export type { ImageModelV4CallOptions } from './image-model-v4-call-options';
+  ImageModelV4Result,
+} from './image-model-v4-result';
 export type { ImageModelV4Usage } from './image-model-v4-usage';
 export type { ImageModelV4File } from './image-model-v4-file';

package/src/index.ts

@@ -1,5 +1,6 @@
 export * from './embedding-model/index';
 export * from './errors/index';
+export * from './files/index';
 export * from './image-model/index';
 export * from './image-model-middleware/index';
 export * from './json-value/index';
@@ -9,6 +10,7 @@ export * from './language-model/index';
 export * from './provider/index';
 export * from './reranking-model/index';
 export * from './shared/index';
+export * from './skills/index';
 export * from './speech-model/index';
 export * from './transcription-model/index';
 export * from './video-model/index';

package/src/language-model/v4/index.ts

@@ -1,6 +1,7 @@
 export * from './language-model-v4';
 export * from './language-model-v4-call-options';
 export * from './language-model-v4-content';
+export * from './language-model-v4-custom-content';
 export * from './language-model-v4-data-content';
 export * from './language-model-v4-file';
 export * from './language-model-v4-finish-reason';
@@ -9,6 +10,7 @@ export * from './language-model-v4-generate-result';
 export * from './language-model-v4-prompt';
 export * from './language-model-v4-provider-tool';
 export * from './language-model-v4-reasoning';
+export * from './language-model-v4-reasoning-file';
 export * from './language-model-v4-response-metadata';
 export * from './language-model-v4-source';
 export * from './language-model-v4-stream-part';

package/src/language-model/v4/language-model-v4-call-options.ts

@@ -116,6 +116,19 @@ export type LanguageModelV4CallOptions = {
    */
   headers?: Record<string, string | undefined>;
 
+  /**
+   * Reasoning effort level for the model. Controls how much reasoning
+   * the model performs before generating a response. Defaults to 'provider-default'.
+   */
+  reasoning?:
+    | 'provider-default'
+    | 'none'
+    | 'minimal'
+    | 'low'
+    | 'medium'
+    | 'high'
+    | 'xhigh';
+
   /**
    * Additional provider-specific options. They are passed through
    * to the provider from the AI SDK and enable provider-specific

package/src/language-model/v4/language-model-v4-content.ts

@@ -1,5 +1,7 @@
+import { LanguageModelV4CustomContent } from './language-model-v4-custom-content';
 import { LanguageModelV4File } from './language-model-v4-file';
 import { LanguageModelV4Reasoning } from './language-model-v4-reasoning';
+import { LanguageModelV4ReasoningFile } from './language-model-v4-reasoning-file';
 import { LanguageModelV4Source } from './language-model-v4-source';
 import { LanguageModelV4Text } from './language-model-v4-text';
 import { LanguageModelV4ToolApprovalRequest } from './language-model-v4-tool-approval-request';
@@ -9,6 +11,8 @@ import { LanguageModelV4ToolResult } from './language-model-v4-tool-result';
 export type LanguageModelV4Content =
   | LanguageModelV4Text
   | LanguageModelV4Reasoning
+  | LanguageModelV4CustomContent
+  | LanguageModelV4ReasoningFile
   | LanguageModelV4File
   | LanguageModelV4ToolApprovalRequest
   | LanguageModelV4Source

package/src/language-model/v4/language-model-v4-custom-content.ts

@@ -0,0 +1,21 @@
+import { SharedV4ProviderMetadata } from '../../shared/v4/shared-v4-provider-metadata';
+
+/**
+ * A provider-specific content block that does not map to another standardized
+ * content part type.
+ */
+export type LanguageModelV4CustomContent = {
+  type: 'custom';
+
+  /**
+   * The kind of custom content, in the format `{provider}.{provider-type}`.
+   */
+  kind: `${string}.${string}`;
+
+  /**
+   * Additional provider-specific options. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
+   */
+  providerMetadata?: SharedV4ProviderMetadata;
+};

package/src/language-model/v4/language-model-v4-prompt.ts

@@ -1,5 +1,6 @@
 import { JSONValue } from '../../json-value/json-value';
 import { SharedV4ProviderOptions } from '../../shared/v4/shared-v4-provider-options';
+import { SharedV4ProviderReference } from '../../shared/v4/shared-v4-provider-reference';
 import { LanguageModelV4DataContent } from './language-model-v4-data-content';
 
 /**
@@ -31,7 +32,9 @@ export type LanguageModelV4Message =
         content: Array<
           | LanguageModelV4TextPart
           | LanguageModelV4FilePart
+          | LanguageModelV4CustomPart
           | LanguageModelV4ReasoningPart
+          | LanguageModelV4ReasoningFilePart
           | LanguageModelV4ToolCallPart
           | LanguageModelV4ToolResultPart
         >;
@@ -90,6 +93,52 @@ export interface LanguageModelV4ReasoningPart {
   providerOptions?: SharedV4ProviderOptions;
 }
 
+/**
+ * Reasoning file content part of a prompt. It contains a file generated as part of reasoning.
+ */
+export interface LanguageModelV4ReasoningFilePart {
+  type: 'reasoning-file';
+
+  /**
+   * File data. Can be a Uint8Array or base64 encoded data as a string.
+   */
+  data: LanguageModelV4DataContent;
+
+  /**
+   * IANA media type of the file.
+   *
+   * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+   */
+  mediaType: string;
+
+  /**
+   * Additional provider-specific options. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
+   */
+  providerOptions?: SharedV4ProviderOptions;
+}
+
+/**
+ * Provider-specific content part of a prompt. It contains no standardized
+ * payload beyond provider-specific options.
+ */
+export interface LanguageModelV4CustomPart {
+  type: 'custom';
+
+  /**
+   * The kind of custom content, in the format `{provider}.{provider-type}`.
+   */
+  kind: `${string}.${string}`;
+
+  /**
+   * Additional provider-specific options. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
+   */
+  providerOptions?: SharedV4ProviderOptions;
+}
+
 /**
  * File content part of a prompt. It contains a file.
  */
@@ -102,9 +151,10 @@ export interface LanguageModelV4FilePart {
   filename?: string;
 
   /**
-   * File data. Can be a Uint8Array, base64 encoded data as a string or a URL.
+   * File data. Can be a Uint8Array, base64 encoded data as a string, a URL,
+   * or a provider reference mapping provider names to provider-specific file IDs.
    */
-  data: LanguageModelV4DataContent;
+  data: LanguageModelV4DataContent | SharedV4ProviderReference;
 
   /**
    * IANA media type of the file.
@@ -330,17 +380,13 @@ export type LanguageModelV4ToolResultOutput =
             providerOptions?: SharedV4ProviderOptions;
           }
         | {
-            type: 'file-id';
+            type: 'file-reference';
 
             /**
-             * 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'.
+             * Provider-specific references for the file.
+             * The key is the provider name, e.g. 'openai' or 'anthropic'.
              */
-            fileId: string | Record<string, string>;
+            providerReference: SharedV4ProviderReference;
 
             /**
              * Provider-specific options.
@@ -387,19 +433,15 @@ export type LanguageModelV4ToolResultOutput =
           }
         | {
             /**
-             * Images that are referenced using a provider file id.
+             * Images that are referenced using a provider reference.
              */
-            type: 'image-file-id';
+            type: 'image-file-reference';
 
             /**
-             * 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'.
+             * Provider-specific references for the image file.
+             * The key is the provider name, e.g. 'openai' or 'anthropic'.
              */
-            fileId: string | Record<string, string>;
+            providerReference: SharedV4ProviderReference;
 
             /**
              * Provider-specific options.

package/src/language-model/v4/language-model-v4-reasoning-file.ts

@@ -0,0 +1,32 @@
+import { SharedV4ProviderMetadata } from '../../shared';
+
+/**
+ * A file that has been generated by the model as part of reasoning.
+ * Generated files as base64 encoded strings or binary data.
+ * The files should be returned without any unnecessary conversion.
+ */
+export type LanguageModelV4ReasoningFile = {
+  type: 'reasoning-file';
+
+  /**
+   * The IANA media type of the file, e.g. `image/png` or `audio/mp3`.
+   *
+   * @see https://www.iana.org/assignments/media-types/media-types.xhtml
+   */
+  mediaType: string;
+
+  /**
+   * Generated file data as base64 encoded strings or binary data.
+   *
+   * The file data should be returned without any unnecessary conversion.
+   * If the API returns base64 encoded strings, the file data should be returned
+   * as base64 encoded strings. If the API returns binary data, the file data should
+   * be returned as binary data.
+   */
+  data: string | Uint8Array;
+
+  /**
+   * Optional provider-specific metadata for the reasoning file part.
+   */
+  providerMetadata?: SharedV4ProviderMetadata;
+};

package/src/language-model/v4/language-model-v4-stream-part.ts

@@ -1,7 +1,9 @@
 import { SharedV4ProviderMetadata } from '../../shared/v4/shared-v4-provider-metadata';
 import { SharedV4Warning } from '../../shared/v4/shared-v4-warning';
+import { LanguageModelV4CustomContent } from './language-model-v4-custom-content';
 import { LanguageModelV4File } from './language-model-v4-file';
 import { LanguageModelV4FinishReason } from './language-model-v4-finish-reason';
+import { LanguageModelV4ReasoningFile } from './language-model-v4-reasoning-file';
 import { LanguageModelV4ResponseMetadata } from './language-model-v4-response-metadata';
 import { LanguageModelV4Source } from './language-model-v4-source';
 import { LanguageModelV4ToolApprovalRequest } from './language-model-v4-tool-approval-request';
@@ -70,9 +72,11 @@ export type LanguageModelV4StreamPart =
   | LanguageModelV4ToolApprovalRequest
   | LanguageModelV4ToolCall
   | LanguageModelV4ToolResult
+  | LanguageModelV4CustomContent
 
   // Files and sources:
   | LanguageModelV4File
+  | LanguageModelV4ReasoningFile
   | LanguageModelV4Source
 
   // stream start event with warnings for the call, e.g. unsupported settings:

package/src/provider/v4/provider-v4.ts

@@ -1,9 +1,11 @@
 import { EmbeddingModelV4 } from '../../embedding-model/v4/embedding-model-v4';
+import { FilesV4 } from '../../files/v4/files-v4';
 import { ImageModelV4 } from '../../image-model/v4/image-model-v4';
 import { LanguageModelV4 } from '../../language-model/v4/language-model-v4';
 import { RerankingModelV4 } from '../../reranking-model/v4/reranking-model-v4';
 import { SpeechModelV4 } from '../../speech-model/v4/speech-model-v4';
 import { TranscriptionModelV4 } from '../../transcription-model/v4/transcription-model-v4';
+import { SkillsV4 } from '../../skills/v4/skills-v4';
 
 /**
  * Provider for language, text embedding, and image generation models.
@@ -76,4 +78,18 @@ export interface ProviderV4 {
    * @throws {NoSuchModelError} If no such model exists.
    */
   rerankingModel?(modelId: string): RerankingModelV4;
+
+  /**
+   * Returns the files interface for uploading files to the provider.
+   * The returned interface can be passed to the `uploadFile` function.
+   *
+   * @returns {FilesV4} The files interface for this provider.
+   */
+  files?(): FilesV4;
+
+  /**
+   * Returns the skills interface for uploading skills to the provider.
+   * The returned interface can be passed to the `uploadSkill` function.
+   */
+  skills?(): SkillsV4;
 }

package/src/reranking-model/v4/index.ts

@@ -1,2 +1,3 @@
 export type { RerankingModelV4 } from './reranking-model-v4';
 export type { RerankingModelV4CallOptions } from './reranking-model-v4-call-options';
+export type { RerankingModelV4Result } from './reranking-model-v4-result';

package/src/reranking-model/v4/reranking-model-v4-result.ts

@@ -0,0 +1,68 @@
+import {
+  SharedV4Headers,
+  SharedV4ProviderMetadata,
+  SharedV4Warning,
+} from '../../shared/v4/';
+
+/**
+ * The result of a reranking model doRerank call.
+ */
+export type RerankingModelV4Result = {
+  /**
+   * Ordered list of reranked documents (via index before reranking).
+   * The documents are sorted by the descending order of relevance scores.
+   */
+  ranking: Array<{
+    /**
+     * The index of the document in the original list of documents before reranking.
+     */
+    index: number;
+
+    /**
+     * The relevance score of the document after reranking.
+     */
+    relevanceScore: number;
+  }>;
+
+  /**
+   * Additional provider-specific metadata. They are passed through
+   * to the provider from the AI SDK and enable provider-specific
+   * functionality that can be fully encapsulated in the provider.
+   */
+  providerMetadata?: SharedV4ProviderMetadata;
+
+  /**
+   * Warnings for the call, e.g. unsupported settings.
+   */
+  warnings?: Array<SharedV4Warning>;
+
+  /**
+   * Optional response information for debugging purposes.
+   */
+  response?: {
+    /**
+     * ID for the generated response, if the provider sends one.
+     */
+    id?: string;
+
+    /**
+     * Timestamp for the start of the generated response, if the provider sends one.
+     */
+    timestamp?: Date;
+
+    /**
+     * The ID of the response model that was used to generate the response, if the provider sends one.
+     */
+    modelId?: string;
+
+    /**
+     * Response headers.
+     */
+    headers?: SharedV4Headers;
+
+    /**
+     * Response body.
+     */
+    body?: unknown;
+  };
+};

package/src/reranking-model/v4/reranking-model-v4.ts

@@ -1,9 +1,5 @@
-import {
-  SharedV4Headers,
-  SharedV4ProviderMetadata,
-  SharedV4Warning,
-} from '../../shared/v4/';
 import { RerankingModelV4CallOptions } from './reranking-model-v4-call-options';
+import { RerankingModelV4Result } from './reranking-model-v4-result';
 
 /**
  * Specification for a reranking model that implements the reranking model interface version 3.
@@ -28,63 +24,7 @@ export type RerankingModelV4 = {
    * Reranking a list of documents using the query.
    */
   // Naming: "do" prefix to prevent accidental direct usage of the method by the user.
-  doRerank(options: RerankingModelV4CallOptions): PromiseLike<{
-    /**
-     * Ordered list of reranked documents (via index before reranking).
-     * The documents are sorted by the descending order of relevance scores.
-     */
-    ranking: Array<{
-      /**
-       * The index of the document in the original list of documents before reranking.
-       */
-      index: number;
-
-      /**
-       * The relevance score of the document after reranking.
-       */
-      relevanceScore: number;
-    }>;
-
-    /**
-     * Additional provider-specific metadata. They are passed through
-     * to the provider from the AI SDK and enable provider-specific
-     * functionality that can be fully encapsulated in the provider.
-     */
-    providerMetadata?: SharedV4ProviderMetadata;
-
-    /**
-     * Warnings for the call, e.g. unsupported settings.
-     */
-    warnings?: Array<SharedV4Warning>;
-
-    /**
-     * Optional response information for debugging purposes.
-     */
-    response?: {
-      /**
-       * ID for the generated response, if the provider sends one.
-       */
-      id?: string;
-
-      /**
-       * Timestamp for the start of the generated response, if the provider sends one.
-       */
-      timestamp?: Date;
-
-      /**
-       * The ID of the response model that was used to generate the response, if the provider sends one.
-       */
-      modelId?: string;
-
-      /**
-       * Response headers.
-       */
-      headers?: SharedV4Headers;
-
-      /**
-       * Response body.
-       */
-      body?: unknown;
-    };
-  }>;
+  doRerank(
+    options: RerankingModelV4CallOptions,
+  ): PromiseLike<RerankingModelV4Result>;
 };

package/src/shared/v4/index.ts

@@ -1,4 +1,5 @@
 export * from './shared-v4-headers';
 export * from './shared-v4-provider-metadata';
 export * from './shared-v4-provider-options';
+export * from './shared-v4-provider-reference';
 export * from './shared-v4-warning';

package/src/shared/v4/shared-v4-provider-reference.ts

@@ -0,0 +1,15 @@
+/**
+ * A mapping of provider names to provider-specific file identifiers.
+ *
+ * Provider references allow files to be identified across different
+ * providers without re-uploading, by storing each provider's own
+ * identifier for the same logical file.
+ *
+ * ```ts
+ * {
+ *   "openai": "file-abc123",
+ *   "anthropic": "file-xyz789"
+ * }
+ * ```
+ */
+export type SharedV4ProviderReference = Record<string, string>;

package/src/shared/v4/shared-v4-warning.ts

@@ -37,6 +37,22 @@ export type SharedV4Warning =
        */
       details?: string;
     }
+  | {
+      /**
+       * A deprecated feature or option is being used.
+       */
+      type: 'deprecated';
+
+      /**
+       * The deprecated setting or feature name.
+       */
+      setting: string;
+
+      /**
+       * A human-readable message explaining what to use instead.
+       */
+      message: string;
+    }
   | {
       /**
        * Other warning.

package/src/skills/index.ts

@@ -0,0 +1 @@
+export * from './v4/index';

package/src/skills/v4/index.ts

@@ -0,0 +1,6 @@
+export type { SkillsV4 } from './skills-v4';
+export type {
+  SkillsV4File,
+  SkillsV4UploadSkillCallOptions,
+} from './skills-v4-upload-skill-call-options';
+export type { SkillsV4UploadSkillResult } from './skills-v4-upload-skill-result';

package/src/skills/v4/skills-v4-upload-skill-call-options.ts

@@ -0,0 +1,30 @@
+import { SharedV4ProviderOptions } from '../../shared/v4/shared-v4-provider-options';
+
+export interface SkillsV4File {
+  /**
+   * The path of the file relative to the skill root.
+   */
+  path: string;
+
+  /**
+   * The content of the file, either as a base64 string or binary data.
+   */
+  content: string | Uint8Array;
+}
+
+export interface SkillsV4UploadSkillCallOptions {
+  /**
+   * The files that make up the skill.
+   */
+  files: SkillsV4File[];
+
+  /**
+   * Optional human-readable title for the skill.
+   */
+  displayTitle?: string;
+
+  /**
+   * Additional provider-specific options.
+   */
+  providerOptions?: SharedV4ProviderOptions;
+}