@ai-sdk/provider 3.0.0-beta.26 → 3.0.0-beta.28

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/provider
 
+## 3.0.0-beta.28
+
+### Patch Changes
+
+- 9061dc0: feat: image editing
+
+## 3.0.0-beta.27
+
+### Patch Changes
+
+- 366f50b: chore(provider): add deprecated textEmbeddingModel and textEmbedding aliases
+
 ## 3.0.0-beta.26
 
 ### Patch Changes

package/dist/index.d.mts

@@ -598,55 +598,102 @@ type ImageModelV3Usage = {
     totalTokens: number | undefined;
 };
 
+/**
+ * An image file that can be used for image editing or variation generation.
+ */
+type ImageModelV3File = {
+    type: 'file';
+    /**
+     * The IANA media type of the file, e.g. `image/png`. Any string is supported.
+     *
+     * @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 file part.
+     */
+    providerOptions?: SharedV3ProviderMetadata;
+} | {
+    type: 'url';
+    /**
+     * The URL of the image file.
+     */
+    url: string;
+    /**
+     * Optional provider-specific metadata for the file part.
+     */
+    providerOptions?: SharedV3ProviderMetadata;
+};
+
 type ImageModelV3CallOptions = {
     /**
-  Prompt for the image generation.
-       */
-    prompt: string;
+     * Prompt for the image generation. Some operations, like upscaling, may not require a prompt.
+     */
+    prompt: string | undefined;
     /**
-  Number of images to generate.
-   */
+     * Number of images to generate.
+     */
     n: number;
     /**
-  Size of the images to generate.
-  Must have the format `{width}x{height}`.
-  `undefined` will use the provider's default size.
-   */
+     * Size of the images to generate.
+     * Must have the format `{width}x{height}`.
+     * `undefined` will use the provider's default size.
+     */
     size: `${number}x${number}` | undefined;
     /**
-  Aspect ratio of the images to generate.
-  Must have the format `{width}:{height}`.
-  `undefined` will use the provider's default aspect ratio.
-   */
+     * Aspect ratio of the images to generate.
+     * Must have the format `{width}:{height}`.
+     * `undefined` will use the provider's default aspect ratio.
+     */
     aspectRatio: `${number}:${number}` | undefined;
     /**
-  Seed for the image generation.
-  `undefined` will use the provider's default seed.
-   */
+     * Seed for the image generation.
+     * `undefined` will use the provider's default seed.
+     */
     seed: number | undefined;
     /**
-  Additional provider-specific options that are passed through to the provider
-  as body parameters.
-  
-  The outer record is keyed by the provider name, and the inner
-  record is keyed by the provider-specific metadata key.
-  ```ts
-  {
-    "openai": {
-      "style": "vivid"
-    }
-  }
-  ```
-   */
+     * Array of images for image editing or variation generation.
+     * The images should be provided as base64 encoded strings or binary data.
+     */
+    files: ImageModelV3File[] | undefined;
+    /**
+     * Mask image for inpainting operations.
+     * The mask should be provided as base64 encoded strings or binary data.
+     */
+    mask: ImageModelV3File | undefined;
+    /**
+     * Additional provider-specific options that are passed through to the provider
+     * as body parameters.
+     *
+     * The outer record is keyed by the provider name, and the inner
+     * record is keyed by the provider-specific metadata key.
+     *
+     * ```ts
+     * {
+     *   "openai": {
+     *     "style": "vivid"
+     *   }
+     * }
+     * ```
+     */
     providerOptions: SharedV3ProviderOptions;
     /**
-  Abort signal for cancelling the operation.
-   */
+     * Abort signal for cancelling the operation.
+     */
     abortSignal?: AbortSignal;
     /**
-  Additional HTTP headers to be sent with the request.
-  Only applicable for HTTP-based providers.
-   */
+     * Additional HTTP headers to be sent with the request.
+     * Only applicable for HTTP-based providers.
+     */
     headers?: Record<string, string | undefined>;
 };
 
@@ -3210,6 +3257,19 @@ interface ProviderV3 {
      */
     embeddingModel(modelId: string): EmbeddingModelV3;
     /**
+  Returns the text embedding model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {EmbeddingModel} The embedding model associated with the id
+  
+  @throws {NoSuchModelError} If no such model exists.
+  
+  @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel?(modelId: string): EmbeddingModelV3;
+    /**
   Returns the image model with the given id.
   The model id is then passed to the provider function to get the model.
   
@@ -3596,4 +3656,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 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 };
+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 ImageModelV3File, 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

@@ -598,55 +598,102 @@ type ImageModelV3Usage = {
     totalTokens: number | undefined;
 };
 
+/**
+ * An image file that can be used for image editing or variation generation.
+ */
+type ImageModelV3File = {
+    type: 'file';
+    /**
+     * The IANA media type of the file, e.g. `image/png`. Any string is supported.
+     *
+     * @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 file part.
+     */
+    providerOptions?: SharedV3ProviderMetadata;
+} | {
+    type: 'url';
+    /**
+     * The URL of the image file.
+     */
+    url: string;
+    /**
+     * Optional provider-specific metadata for the file part.
+     */
+    providerOptions?: SharedV3ProviderMetadata;
+};
+
 type ImageModelV3CallOptions = {
     /**
-  Prompt for the image generation.
-       */
-    prompt: string;
+     * Prompt for the image generation. Some operations, like upscaling, may not require a prompt.
+     */
+    prompt: string | undefined;
     /**
-  Number of images to generate.
-   */
+     * Number of images to generate.
+     */
     n: number;
     /**
-  Size of the images to generate.
-  Must have the format `{width}x{height}`.
-  `undefined` will use the provider's default size.
-   */
+     * Size of the images to generate.
+     * Must have the format `{width}x{height}`.
+     * `undefined` will use the provider's default size.
+     */
     size: `${number}x${number}` | undefined;
     /**
-  Aspect ratio of the images to generate.
-  Must have the format `{width}:{height}`.
-  `undefined` will use the provider's default aspect ratio.
-   */
+     * Aspect ratio of the images to generate.
+     * Must have the format `{width}:{height}`.
+     * `undefined` will use the provider's default aspect ratio.
+     */
     aspectRatio: `${number}:${number}` | undefined;
     /**
-  Seed for the image generation.
-  `undefined` will use the provider's default seed.
-   */
+     * Seed for the image generation.
+     * `undefined` will use the provider's default seed.
+     */
     seed: number | undefined;
     /**
-  Additional provider-specific options that are passed through to the provider
-  as body parameters.
-  
-  The outer record is keyed by the provider name, and the inner
-  record is keyed by the provider-specific metadata key.
-  ```ts
-  {
-    "openai": {
-      "style": "vivid"
-    }
-  }
-  ```
-   */
+     * Array of images for image editing or variation generation.
+     * The images should be provided as base64 encoded strings or binary data.
+     */
+    files: ImageModelV3File[] | undefined;
+    /**
+     * Mask image for inpainting operations.
+     * The mask should be provided as base64 encoded strings or binary data.
+     */
+    mask: ImageModelV3File | undefined;
+    /**
+     * Additional provider-specific options that are passed through to the provider
+     * as body parameters.
+     *
+     * The outer record is keyed by the provider name, and the inner
+     * record is keyed by the provider-specific metadata key.
+     *
+     * ```ts
+     * {
+     *   "openai": {
+     *     "style": "vivid"
+     *   }
+     * }
+     * ```
+     */
     providerOptions: SharedV3ProviderOptions;
     /**
-  Abort signal for cancelling the operation.
-   */
+     * Abort signal for cancelling the operation.
+     */
     abortSignal?: AbortSignal;
     /**
-  Additional HTTP headers to be sent with the request.
-  Only applicable for HTTP-based providers.
-   */
+     * Additional HTTP headers to be sent with the request.
+     * Only applicable for HTTP-based providers.
+     */
     headers?: Record<string, string | undefined>;
 };
 
@@ -3210,6 +3257,19 @@ interface ProviderV3 {
      */
     embeddingModel(modelId: string): EmbeddingModelV3;
     /**
+  Returns the text embedding model with the given id.
+  The model id is then passed to the provider function to get the model.
+  
+  @param {string} modelId - The id of the model to return.
+  
+  @returns {EmbeddingModel} The embedding model associated with the id
+  
+  @throws {NoSuchModelError} If no such model exists.
+  
+  @deprecated Use `embeddingModel` instead.
+     */
+    textEmbeddingModel?(modelId: string): EmbeddingModelV3;
+    /**
   Returns the image model with the given id.
   The model id is then passed to the provider function to get the model.
   
@@ -3596,4 +3656,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 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 };
+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 ImageModelV3File, 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.26",
+  "version": "3.0.0-beta.28",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",