@ai-sdk/provider - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

CHANGELOG.md

 # @ai-sdk/provider
 
+## 1.0.2
+
+### Patch Changes
+
+- 09a9cab: feat (ai/core): add experimental generateImage function
+
 ## 1.0.1
@@ -4,0 +10,0 @@

dist/index.d.ts

@@ -11,3 +11,3 @@ import { JSONSchema7 } from 'json-schema';
 /**
-Experimental: Specification for an embedding model that implements the embedding model
+Specification for an embedding model that implements the embedding model
 interface version 1.
@@ -314,2 +314,70 @@
 
+/**
+Image generation model specification version 1.
+ */
+type ImageModelV1 = {
+    /**
+  The image model must specify which image model interface
+  version it implements. This will allow us to evolve the image
+  model interface and retain backwards compatibility. The different
+  implementation versions can be handled as a discriminated union
+  on our side.
+     */
+    readonly specificationVersion: 'v1';
+    /**
+  Name of the provider for logging purposes.
+     */
+    readonly provider: string;
+    /**
+  Provider-specific model ID for logging purposes.
+     */
+    readonly modelId: string;
+    /**
+  Generates an array of images.
+     */
+    doGenerate(options: {
+        /**
+    Prompt for the image generation.
+         */
+        prompt: string;
+        /**
+    Number of images to generate.
+         */
+        n: number;
+        /**
+    Size of the images to generate. Must have the format `{width}x{height}`.
+         */
+        size: `${number}x${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"
+      }
+    }
+    ```
+         */
+        providerOptions: Record<string, Record<string, JSONValue>>;
+        /**
+    Abort signal for cancelling the operation.
+         */
+        abortSignal?: AbortSignal;
+        /**
+      Additional HTTP headers to be sent with the request.
+      Only applicable for HTTP-based providers.
+         */
+        headers?: Record<string, string | undefined>;
+    }): PromiseLike<{
+        /**
+    Generated images as base64 encoded strings.
+         */
+        images: Array<string>;
+    }>;
+};
+
 declare function isJSONValue(value: unknown): value is JSONValue;
@@ -1022,2 +1090,2 @@ declare function isJSONArray(value: unknown): value is JSONArray;
 
-export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FilePart, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1ObjectGenerationMode, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };
+export { AISDKError, APICallError, type EmbeddingModelV1, type EmbeddingModelV1Embedding, EmptyResponseBodyError, type ImageModelV1, InvalidArgumentError, InvalidPromptError, InvalidResponseDataError, type JSONArray, type JSONObject, JSONParseError, type JSONValue, type LanguageModelV1, type LanguageModelV1CallOptions, type LanguageModelV1CallWarning, type LanguageModelV1FilePart, type LanguageModelV1FinishReason, type LanguageModelV1FunctionTool, type LanguageModelV1FunctionToolCall, type LanguageModelV1ImagePart, type LanguageModelV1LogProbs, type LanguageModelV1Message, type LanguageModelV1ObjectGenerationMode, type LanguageModelV1Prompt, type LanguageModelV1ProviderDefinedTool, type LanguageModelV1ProviderMetadata, type LanguageModelV1StreamPart, type LanguageModelV1TextPart, type LanguageModelV1ToolCallPart, type LanguageModelV1ToolChoice, type LanguageModelV1ToolResultPart, LoadAPIKeyError, LoadSettingError, NoContentGeneratedError, NoSuchModelError, type ProviderV1, TooManyEmbeddingValuesForCallError, TypeValidationError, UnsupportedFunctionalityError, getErrorMessage, isJSONArray, isJSONObject, isJSONValue };

package.json

 {
   "name": "@ai-sdk/provider",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "license": "Apache-2.0",
@@ -5,0 +5,0 @@ "sideEffects": false,

No alert changes

Improved metrics

Total package byte prevSize

142108

increased by2.73%

Lines of code

1826

increased by3.75%

No dependency changes