@ai-sdk/openai-compatible 3.0.0-beta.2 → 3.0.0-beta.3

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/openai-compatible
 
+## 3.0.0-beta.3
+
+### Patch Changes
+
+- 8f3e1da: chore(openai-compat): update v3 specs to v4
+
 ## 3.0.0-beta.2
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { SharedV3ProviderMetadata, LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, ImageModelV3, ProviderV3 } from '@ai-sdk/provider';
+import { SharedV4ProviderMetadata, LanguageModelV4, LanguageModelV4CallOptions, LanguageModelV4GenerateResult, LanguageModelV4StreamResult, EmbeddingModelV4, ImageModelV4, ProviderV4 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { ZodType, z } from 'zod/v4';
 
@@ -42,7 +42,7 @@ type MetadataExtractor = {
      */
     extractMetadata: ({ parsedBody, }: {
         parsedBody: unknown;
-    }) => Promise<SharedV3ProviderMetadata | undefined>;
+    }) => Promise<SharedV4ProviderMetadata | undefined>;
     /**
      * Creates an extractor for handling streaming responses. The returned object provides
      * methods to process individual chunks and build the final metadata from the accumulated
@@ -65,7 +65,7 @@ type MetadataExtractor = {
          * @returns Provider-specific metadata or undefined if no metadata is available.
          *          The metadata should be under a key indicating the provider id.
          */
-        buildMetadata(): SharedV3ProviderMetadata | undefined;
+        buildMetadata(): SharedV4ProviderMetadata | undefined;
     };
 };
 
@@ -87,7 +87,7 @@ type OpenAICompatibleChatConfig = {
     /**
      * The supported URLs for the model.
      */
-    supportedUrls?: () => LanguageModelV3['supportedUrls'];
+    supportedUrls?: () => LanguageModelV4['supportedUrls'];
     /**
      * Optional function to transform the request body before sending it to the API.
      * This is useful for proxy providers that may require a different request format
@@ -95,8 +95,8 @@ type OpenAICompatibleChatConfig = {
      */
     transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
 };
-declare class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
-    readonly specificationVersion = "v3";
+declare class OpenAICompatibleChatLanguageModel implements LanguageModelV4 {
+    readonly specificationVersion = "v4";
     readonly supportsStructuredOutputs: boolean;
     readonly modelId: OpenAICompatibleChatModelId;
     private readonly config;
@@ -108,8 +108,8 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
     private transformRequestBody;
     private getArgs;
-    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
-    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
+    doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
 }
 
 type OpenAICompatibleCompletionModelId = string;
@@ -134,10 +134,10 @@ type OpenAICompatibleCompletionConfig = {
     /**
      * The supported URLs for the model.
      */
-    supportedUrls?: () => LanguageModelV3['supportedUrls'];
+    supportedUrls?: () => LanguageModelV4['supportedUrls'];
 };
-declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV3 {
-    readonly specificationVersion = "v3";
+declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV4 {
+    readonly specificationVersion = "v4";
     readonly modelId: OpenAICompatibleCompletionModelId;
     private readonly config;
     private readonly failedResponseHandler;
@@ -147,8 +147,8 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV3
     private get providerOptionsName();
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
     private getArgs;
-    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
-    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
+    doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
 }
 
 type OpenAICompatibleEmbeddingModelId = string;
@@ -176,8 +176,8 @@ type OpenAICompatibleEmbeddingConfig = {
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
 };
-declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV3 {
-    readonly specificationVersion = "v3";
+declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV4 {
+    readonly specificationVersion = "v4";
     readonly modelId: OpenAICompatibleEmbeddingModelId;
     private readonly config;
     get provider(): string;
@@ -185,7 +185,7 @@ declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV3 {
     get supportsParallelCalls(): boolean;
     constructor(modelId: OpenAICompatibleEmbeddingModelId, config: OpenAICompatibleEmbeddingConfig);
     private get providerOptionsName();
-    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV3['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>>;
+    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>>;
 }
 
 type OpenAICompatibleImageModelId = string;
@@ -203,10 +203,10 @@ type OpenAICompatibleImageModelConfig = {
         currentDate?: () => Date;
     };
 };
-declare class OpenAICompatibleImageModel implements ImageModelV3 {
+declare class OpenAICompatibleImageModel implements ImageModelV4 {
     readonly modelId: OpenAICompatibleImageModelId;
     private readonly config;
-    readonly specificationVersion = "v3";
+    readonly specificationVersion = "v4";
     readonly maxImagesPerCall = 10;
     get provider(): string;
     /**
@@ -215,20 +215,20 @@ declare class OpenAICompatibleImageModel implements ImageModelV3 {
     private get providerOptionsKey();
     constructor(modelId: OpenAICompatibleImageModelId, config: OpenAICompatibleImageModelConfig);
     private getArgs;
-    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, files, mask, }: Parameters<ImageModelV3['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV3['doGenerate']>>>;
+    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, files, mask, }: Parameters<ImageModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV4['doGenerate']>>>;
 }
 
-interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string, IMAGE_MODEL_IDS extends string = string> extends Omit<ProviderV3, 'imageModel'> {
-    (modelId: CHAT_MODEL_IDS): LanguageModelV3;
-    languageModel(modelId: CHAT_MODEL_IDS, config?: Partial<OpenAICompatibleChatConfig>): LanguageModelV3;
-    chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV3;
-    completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV3;
-    embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV3;
+interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string, IMAGE_MODEL_IDS extends string = string> extends Omit<ProviderV4, 'imageModel'> {
+    (modelId: CHAT_MODEL_IDS): LanguageModelV4;
+    languageModel(modelId: CHAT_MODEL_IDS, config?: Partial<OpenAICompatibleChatConfig>): LanguageModelV4;
+    chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV4;
+    completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV4;
+    embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
     /**
      * @deprecated Use `embeddingModel` instead.
      */
-    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV3;
-    imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV3;
+    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
+    imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV4;
 }
 interface OpenAICompatibleProviderSettings {
     /**

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { SharedV3ProviderMetadata, LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, EmbeddingModelV3, ImageModelV3, ProviderV3 } from '@ai-sdk/provider';
+import { SharedV4ProviderMetadata, LanguageModelV4, LanguageModelV4CallOptions, LanguageModelV4GenerateResult, LanguageModelV4StreamResult, EmbeddingModelV4, ImageModelV4, ProviderV4 } from '@ai-sdk/provider';
 import { FetchFunction } from '@ai-sdk/provider-utils';
 import { ZodType, z } from 'zod/v4';
 
@@ -42,7 +42,7 @@ type MetadataExtractor = {
      */
     extractMetadata: ({ parsedBody, }: {
         parsedBody: unknown;
-    }) => Promise<SharedV3ProviderMetadata | undefined>;
+    }) => Promise<SharedV4ProviderMetadata | undefined>;
     /**
      * Creates an extractor for handling streaming responses. The returned object provides
      * methods to process individual chunks and build the final metadata from the accumulated
@@ -65,7 +65,7 @@ type MetadataExtractor = {
          * @returns Provider-specific metadata or undefined if no metadata is available.
          *          The metadata should be under a key indicating the provider id.
          */
-        buildMetadata(): SharedV3ProviderMetadata | undefined;
+        buildMetadata(): SharedV4ProviderMetadata | undefined;
     };
 };
 
@@ -87,7 +87,7 @@ type OpenAICompatibleChatConfig = {
     /**
      * The supported URLs for the model.
      */
-    supportedUrls?: () => LanguageModelV3['supportedUrls'];
+    supportedUrls?: () => LanguageModelV4['supportedUrls'];
     /**
      * Optional function to transform the request body before sending it to the API.
      * This is useful for proxy providers that may require a different request format
@@ -95,8 +95,8 @@ type OpenAICompatibleChatConfig = {
      */
     transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
 };
-declare class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
-    readonly specificationVersion = "v3";
+declare class OpenAICompatibleChatLanguageModel implements LanguageModelV4 {
+    readonly specificationVersion = "v4";
     readonly supportsStructuredOutputs: boolean;
     readonly modelId: OpenAICompatibleChatModelId;
     private readonly config;
@@ -108,8 +108,8 @@ declare class OpenAICompatibleChatLanguageModel implements LanguageModelV3 {
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
     private transformRequestBody;
     private getArgs;
-    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
-    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
+    doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
 }
 
 type OpenAICompatibleCompletionModelId = string;
@@ -134,10 +134,10 @@ type OpenAICompatibleCompletionConfig = {
     /**
      * The supported URLs for the model.
      */
-    supportedUrls?: () => LanguageModelV3['supportedUrls'];
+    supportedUrls?: () => LanguageModelV4['supportedUrls'];
 };
-declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV3 {
-    readonly specificationVersion = "v3";
+declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV4 {
+    readonly specificationVersion = "v4";
     readonly modelId: OpenAICompatibleCompletionModelId;
     private readonly config;
     private readonly failedResponseHandler;
@@ -147,8 +147,8 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV3
     private get providerOptionsName();
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
     private getArgs;
-    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
-    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
+    doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
 }
 
 type OpenAICompatibleEmbeddingModelId = string;
@@ -176,8 +176,8 @@ type OpenAICompatibleEmbeddingConfig = {
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
 };
-declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV3 {
-    readonly specificationVersion = "v3";
+declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV4 {
+    readonly specificationVersion = "v4";
     readonly modelId: OpenAICompatibleEmbeddingModelId;
     private readonly config;
     get provider(): string;
@@ -185,7 +185,7 @@ declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV3 {
     get supportsParallelCalls(): boolean;
     constructor(modelId: OpenAICompatibleEmbeddingModelId, config: OpenAICompatibleEmbeddingConfig);
     private get providerOptionsName();
-    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV3['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV3['doEmbed']>>>;
+    doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>>;
 }
 
 type OpenAICompatibleImageModelId = string;
@@ -203,10 +203,10 @@ type OpenAICompatibleImageModelConfig = {
         currentDate?: () => Date;
     };
 };
-declare class OpenAICompatibleImageModel implements ImageModelV3 {
+declare class OpenAICompatibleImageModel implements ImageModelV4 {
     readonly modelId: OpenAICompatibleImageModelId;
     private readonly config;
-    readonly specificationVersion = "v3";
+    readonly specificationVersion = "v4";
     readonly maxImagesPerCall = 10;
     get provider(): string;
     /**
@@ -215,20 +215,20 @@ declare class OpenAICompatibleImageModel implements ImageModelV3 {
     private get providerOptionsKey();
     constructor(modelId: OpenAICompatibleImageModelId, config: OpenAICompatibleImageModelConfig);
     private getArgs;
-    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, files, mask, }: Parameters<ImageModelV3['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV3['doGenerate']>>>;
+    doGenerate({ prompt, n, size, aspectRatio, seed, providerOptions, headers, abortSignal, files, mask, }: Parameters<ImageModelV4['doGenerate']>[0]): Promise<Awaited<ReturnType<ImageModelV4['doGenerate']>>>;
 }
 
-interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string, IMAGE_MODEL_IDS extends string = string> extends Omit<ProviderV3, 'imageModel'> {
-    (modelId: CHAT_MODEL_IDS): LanguageModelV3;
-    languageModel(modelId: CHAT_MODEL_IDS, config?: Partial<OpenAICompatibleChatConfig>): LanguageModelV3;
-    chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV3;
-    completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV3;
-    embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV3;
+interface OpenAICompatibleProvider<CHAT_MODEL_IDS extends string = string, COMPLETION_MODEL_IDS extends string = string, EMBEDDING_MODEL_IDS extends string = string, IMAGE_MODEL_IDS extends string = string> extends Omit<ProviderV4, 'imageModel'> {
+    (modelId: CHAT_MODEL_IDS): LanguageModelV4;
+    languageModel(modelId: CHAT_MODEL_IDS, config?: Partial<OpenAICompatibleChatConfig>): LanguageModelV4;
+    chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV4;
+    completionModel(modelId: COMPLETION_MODEL_IDS): LanguageModelV4;
+    embeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
     /**
      * @deprecated Use `embeddingModel` instead.
      */
-    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV3;
-    imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV3;
+    textEmbeddingModel(modelId: EMBEDDING_MODEL_IDS): EmbeddingModelV4;
+    imageModel(modelId: IMAGE_MODEL_IDS): ImageModelV4;
 }
 interface OpenAICompatibleProviderSettings {
     /**

package/dist/index.js

@@ -18,8 +18,8 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // src/index.ts
-var src_exports = {};
-__export(src_exports, {
+var index_exports = {};
+__export(index_exports, {
   OpenAICompatibleChatLanguageModel: () => OpenAICompatibleChatLanguageModel,
   OpenAICompatibleCompletionLanguageModel: () => OpenAICompatibleCompletionLanguageModel,
   OpenAICompatibleEmbeddingModel: () => OpenAICompatibleEmbeddingModel,
@@ -27,7 +27,7 @@ __export(src_exports, {
   VERSION: () => VERSION,
   createOpenAICompatible: () => createOpenAICompatible
 });
-module.exports = __toCommonJS(src_exports);
+module.exports = __toCommonJS(index_exports);
 
 // src/chat/openai-compatible-chat-language-model.ts
 var import_provider3 = require("@ai-sdk/provider");
@@ -408,7 +408,7 @@ function prepareTools({
 var OpenAICompatibleChatLanguageModel = class {
   // type inferred via constructor
   constructor(modelId, config) {
-    this.specificationVersion = "v3";
+    this.specificationVersion = "v4";
     var _a, _b;
     this.modelId = modelId;
     this.config = config;
@@ -1148,7 +1148,7 @@ var openaiCompatibleLanguageModelCompletionOptions = import_v44.z.object({
 var OpenAICompatibleCompletionLanguageModel = class {
   // type inferred via constructor
   constructor(modelId, config) {
-    this.specificationVersion = "v3";
+    this.specificationVersion = "v4";
     var _a;
     this.modelId = modelId;
     this.config = config;
@@ -1427,7 +1427,7 @@ var openaiCompatibleEmbeddingModelOptions = import_v46.z.object({
 // src/embedding/openai-compatible-embedding-model.ts
 var OpenAICompatibleEmbeddingModel = class {
   constructor(modelId, config) {
-    this.specificationVersion = "v3";
+    this.specificationVersion = "v4";
     this.modelId = modelId;
     this.config = config;
   }
@@ -1533,7 +1533,7 @@ var OpenAICompatibleImageModel = class {
   constructor(modelId, config) {
     this.modelId = modelId;
     this.config = config;
-    this.specificationVersion = "v3";
+    this.specificationVersion = "v4";
     this.maxImagesPerCall = 10;
   }
   get provider() {
@@ -1665,7 +1665,7 @@ function toCamelCase(str) {
 var import_provider_utils6 = require("@ai-sdk/provider-utils");
 
 // src/version.ts
-var VERSION = true ? "3.0.0-beta.2" : "0.0.0-test";
+var VERSION = true ? "3.0.0-beta.3" : "0.0.0-test";
 
 // src/openai-compatible-provider.ts
 function createOpenAICompatible(options) {
@@ -1705,7 +1705,7 @@ function createOpenAICompatible(options) {
   });
   const createImageModel = (modelId) => new OpenAICompatibleImageModel(modelId, getCommonModelConfig("image"));
   const provider = (modelId) => createLanguageModel(modelId);
-  provider.specificationVersion = "v3";
+  provider.specificationVersion = "v4";
   provider.languageModel = createLanguageModel;
   provider.chatModel = createChatModel;
   provider.completionModel = createCompletionModel;