@ai-sdk/openai-compatible 3.0.0-beta.8 → 3.0.0-canary.37

package/CHANGELOG.md

@@ -1,5 +1,256 @@
 # @ai-sdk/openai-compatible
 
+## 3.0.0-canary.37
+
+### Patch Changes
+
+- 0c4c275: trigger initial canary release
+- Updated dependencies [0c4c275]
+  - @ai-sdk/provider-utils@5.0.0-canary.31
+  - @ai-sdk/provider@4.0.0-canary.15
+
+## 3.0.0-beta.36
+
+### Patch Changes
+
+- e59c955: feat(vertex): add grok models to vertex provider
+
+## 3.0.0-beta.35
+
+### Major Changes
+
+- 04e9009: chore: make provider implementations code patterns more consistent, including renaming certain exported symbols
+
+  For all externally exported symbols that were renamed, the old names continue to work via deprecated aliases.
+
+### Patch Changes
+
+- Updated dependencies [08d2129]
+  - @ai-sdk/provider-utils@5.0.0-beta.30
+
+## 3.0.0-beta.34
+
+### Patch Changes
+
+- 9bd6512: feat(provider): change file part data property to be tagged with a type and remove the image part type
+- 258c093: chore: ensure consistent import handling and avoid import duplicates or cycles
+- Updated dependencies [9bd6512]
+- Updated dependencies [258c093]
+- Updated dependencies [b6783da]
+  - @ai-sdk/provider-utils@5.0.0-beta.29
+  - @ai-sdk/provider@4.0.0-beta.14
+
+## 3.0.0-beta.33
+
+### Patch Changes
+
+- 9f0e36c: trigger release for all packages after provenance setup
+- Updated dependencies [9f0e36c]
+  - @ai-sdk/provider@4.0.0-beta.13
+  - @ai-sdk/provider-utils@5.0.0-beta.28
+
+## 3.0.0-beta.32
+
+### Patch Changes
+
+- ab81968: fix(openai-compatible): buffer tool call deltas until function.name arrives
+- 58a2ad7: fix: more precise default message for tool execution denial
+- Updated dependencies [785fe16]
+- Updated dependencies [67df0a0]
+- Updated dependencies [befb78c]
+- Updated dependencies [0458559]
+- Updated dependencies [5852c0a]
+- Updated dependencies [fc92055]
+  - @ai-sdk/provider-utils@5.0.0-beta.27
+
+## 3.0.0-beta.31
+
+### Patch Changes
+
+- bfb756d: patch - send content: null instead of empty string for tool-only assistant messages
+- Updated dependencies [2e98477]
+  - @ai-sdk/provider-utils@5.0.0-beta.26
+
+## 3.0.0-beta.30
+
+### Patch Changes
+
+- Updated dependencies [eea8d98]
+  - @ai-sdk/provider-utils@5.0.0-beta.25
+
+## 3.0.0-beta.29
+
+### Patch Changes
+
+- f807e45: Extract shared `StreamingToolCallTracker` class into `@ai-sdk/provider-utils` to deduplicate streaming tool call handling across OpenAI-compatible providers. Also adds missing `generateId()` fallback for `toolCallId` in Alibaba's `doGenerate` path and ensures all providers finalize unfinished tool calls during stream flush.
+- Updated dependencies [f807e45]
+  - @ai-sdk/provider-utils@5.0.0-beta.24
+
+## 3.0.0-beta.28
+
+### Patch Changes
+
+- Updated dependencies [350ea38]
+  - @ai-sdk/provider-utils@5.0.0-beta.23
+
+## 3.0.0-beta.27
+
+### Patch Changes
+
+- Updated dependencies [083947b]
+  - @ai-sdk/provider-utils@5.0.0-beta.22
+
+## 3.0.0-beta.26
+
+### Patch Changes
+
+- Updated dependencies [add1126]
+  - @ai-sdk/provider-utils@5.0.0-beta.21
+
+## 3.0.0-beta.25
+
+### Patch Changes
+
+- b3976a2: Add workflow serialization support to all provider models.
+
+  **`@ai-sdk/provider-utils`:** New `serializeModel()` helper that extracts only serializable properties from a model instance, filtering out functions and objects containing functions. Third-party provider authors can use this to add workflow support to their own models.
+
+  **All providers:** `headers` is now optional in provider config types. This is non-breaking — existing code that passes `headers` continues to work. Custom provider implementations that construct model configs manually can now omit `headers`, which is useful when models are deserialized from a workflow step boundary where auth is provided separately.
+
+  All provider model classes now include `WORKFLOW_SERIALIZE` and `WORKFLOW_DESERIALIZE` static methods, enabling them to cross workflow step boundaries without serialization errors.
+
+- Updated dependencies [b3976a2]
+- Updated dependencies [ff5eba1]
+  - @ai-sdk/provider-utils@5.0.0-beta.20
+  - @ai-sdk/provider@4.0.0-beta.12
+
+## 3.0.0-beta.24
+
+### Major Changes
+
+- ef992f8: Remove CommonJS exports from all packages. All packages are now ESM-only (`"type": "module"`). Consumers using `require()` must switch to ESM `import` syntax.
+
+### Patch Changes
+
+- Updated dependencies [ef992f8]
+  - @ai-sdk/provider@4.0.0-beta.11
+  - @ai-sdk/provider-utils@5.0.0-beta.19
+
+## 3.0.0-beta.23
+
+### Patch Changes
+
+- 90e2d8a: chore: fix unused vars not being flagged by our lint tooling
+- Updated dependencies [90e2d8a]
+  - @ai-sdk/provider-utils@5.0.0-beta.18
+
+## 3.0.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [3ae1786]
+  - @ai-sdk/provider-utils@5.0.0-beta.17
+
+## 3.0.0-beta.21
+
+### Patch Changes
+
+- Updated dependencies [176466a]
+  - @ai-sdk/provider@4.0.0-beta.10
+  - @ai-sdk/provider-utils@5.0.0-beta.16
+
+## 3.0.0-beta.20
+
+### Patch Changes
+
+- Updated dependencies [e311194]
+  - @ai-sdk/provider@4.0.0-beta.9
+  - @ai-sdk/provider-utils@5.0.0-beta.15
+
+## 3.0.0-beta.19
+
+### Patch Changes
+
+- 008271d: feat(openai-compatible): emit warning when using kebab-case instead of camelCase
+- Updated dependencies [34bd95d]
+- Updated dependencies [008271d]
+  - @ai-sdk/provider@4.0.0-beta.8
+  - @ai-sdk/provider-utils@5.0.0-beta.14
+
+## 3.0.0-beta.18
+
+### Patch Changes
+
+- Updated dependencies [b0c2869]
+- Updated dependencies [7e26e81]
+  - @ai-sdk/provider-utils@5.0.0-beta.13
+
+## 3.0.0-beta.17
+
+### Patch Changes
+
+- 816ff67: fix(openai-compatible): honor camelCase providerOptions key in chat and completion models
+
+## 3.0.0-beta.16
+
+### Patch Changes
+
+- Updated dependencies [46d1149]
+  - @ai-sdk/provider-utils@5.0.0-beta.12
+
+## 3.0.0-beta.15
+
+### Patch Changes
+
+- 6fd51c0: fix(provider): preserve error type prefix in getErrorMessage
+- Updated dependencies [6fd51c0]
+  - @ai-sdk/provider-utils@5.0.0-beta.11
+  - @ai-sdk/provider@4.0.0-beta.7
+
+## 3.0.0-beta.14
+
+### Patch Changes
+
+- c29a26f: feat(provider): add support for provider references and uploading files as supported per provider
+- Updated dependencies [c29a26f]
+  - @ai-sdk/provider-utils@5.0.0-beta.10
+  - @ai-sdk/provider@4.0.0-beta.6
+
+## 3.0.0-beta.13
+
+### Patch Changes
+
+- 38fc777: Add AI Gateway hint to provider READMEs
+
+## 3.0.0-beta.12
+
+### Patch Changes
+
+- Updated dependencies [2e17091]
+  - @ai-sdk/provider-utils@5.0.0-beta.9
+
+## 3.0.0-beta.11
+
+### Patch Changes
+
+- Updated dependencies [986c6fd]
+- Updated dependencies [493295c]
+  - @ai-sdk/provider-utils@5.0.0-beta.8
+
+## 3.0.0-beta.10
+
+### Patch Changes
+
+- Updated dependencies [1f509d4]
+  - @ai-sdk/provider-utils@5.0.0-beta.7
+  - @ai-sdk/provider@4.0.0-beta.5
+
+## 3.0.0-beta.9
+
+### Patch Changes
+
+- 74d520f: feat: migrate providers to support new top-level `reasoning` parameter
+
 ## 3.0.0-beta.8
 
 ### Patch Changes

package/README.md

@@ -4,6 +4,8 @@ This package provides a foundation for implementing providers that expose an Ope
 
 The primary [OpenAI provider](../openai/README.md) is more feature-rich, including OpenAI-specific experimental and legacy features. This package offers a lighter-weight alternative focused on core OpenAI-compatible functionality.
 
+> **Deploying to Vercel?** With Vercel's AI Gateway you can access hundreds of models from any provider — no additional packages, API keys, or extra cost. [Get started with AI Gateway](https://vercel.com/ai-gateway).
+
 ## Setup
 
 The provider is available in the `@ai-sdk/openai-compatible` module. You can install it with

package/dist/index.d.ts

@@ -1,5 +1,6 @@
-import { SharedV4ProviderMetadata, LanguageModelV4, LanguageModelV4CallOptions, LanguageModelV4GenerateResult, LanguageModelV4StreamResult, EmbeddingModelV4, ImageModelV4, ProviderV4 } from '@ai-sdk/provider';
-import { FetchFunction } from '@ai-sdk/provider-utils';
+import * as _ai_sdk_provider from '@ai-sdk/provider';
+import { SharedV4ProviderMetadata, LanguageModelV4, LanguageModelV4Usage, LanguageModelV4CallOptions, LanguageModelV4GenerateResult, LanguageModelV4StreamResult, EmbeddingModelV4, ImageModelV4, ProviderV4 } from '@ai-sdk/provider';
+import { FetchFunction, WORKFLOW_SERIALIZE, WORKFLOW_DESERIALIZE } from '@ai-sdk/provider-utils';
 import { ZodType, z } from 'zod/v4';
 
 declare const openaiCompatibleErrorDataSchema: z.ZodObject<{
@@ -71,7 +72,7 @@ type MetadataExtractor = {
 
 type OpenAICompatibleChatConfig = {
     provider: string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
         path: string;
@@ -94,23 +95,50 @@ type OpenAICompatibleChatConfig = {
      * than the official OpenAI API.
      */
     transformRequestBody?: (args: Record<string, any>) => Record<string, any>;
+    /**
+     * Optional usage converter for OpenAI-compatible providers with different
+     * token accounting semantics.
+     */
+    convertUsage?: (usage: z.infer<typeof openaiCompatibleTokenUsageSchema>) => LanguageModelV4Usage;
 };
 declare class OpenAICompatibleChatLanguageModel implements LanguageModelV4 {
     readonly specificationVersion = "v4";
     readonly supportsStructuredOutputs: boolean;
     readonly modelId: OpenAICompatibleChatModelId;
-    private readonly config;
+    protected readonly config: OpenAICompatibleChatConfig;
     private readonly failedResponseHandler;
     private readonly chunkSchema;
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleChatLanguageModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleChatConfig;
+    }): OpenAICompatibleChatLanguageModel;
     constructor(modelId: OpenAICompatibleChatModelId, config: OpenAICompatibleChatConfig);
     get provider(): string;
     private get providerOptionsName();
     get supportedUrls(): Record<string, RegExp[]> | PromiseLike<Record<string, RegExp[]>>;
     private transformRequestBody;
+    private convertUsage;
     private getArgs;
     doGenerate(options: LanguageModelV4CallOptions): Promise<LanguageModelV4GenerateResult>;
     doStream(options: LanguageModelV4CallOptions): Promise<LanguageModelV4StreamResult>;
 }
+declare const openaiCompatibleTokenUsageSchema: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+    prompt_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    completion_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    total_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    prompt_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        cached_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+    completion_tokens_details: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        reasoning_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        accepted_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+        rejected_prediction_tokens: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    }, z.core.$strip>>>;
+}, z.core.$loose>>>;
 
 type OpenAICompatibleCompletionModelId = string;
 declare const openaiCompatibleLanguageModelCompletionOptions: z.ZodObject<{
@@ -124,7 +152,7 @@ type OpenAICompatibleLanguageModelCompletionOptions = z.infer<typeof openaiCompa
 type OpenAICompatibleCompletionConfig = {
     provider: string;
     includeUsage?: boolean;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
         path: string;
@@ -142,6 +170,14 @@ declare class OpenAICompatibleCompletionLanguageModel implements LanguageModelV4
     private readonly config;
     private readonly failedResponseHandler;
     private readonly chunkSchema;
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleCompletionLanguageModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleCompletionConfig;
+    }): OpenAICompatibleCompletionLanguageModel;
     constructor(modelId: OpenAICompatibleCompletionModelId, config: OpenAICompatibleCompletionConfig);
     get provider(): string;
     private get providerOptionsName();
@@ -172,7 +208,7 @@ type OpenAICompatibleEmbeddingConfig = {
         modelId: string;
         path: string;
     }) => string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     fetch?: FetchFunction;
     errorStructure?: ProviderErrorStructure<any>;
 };
@@ -183,6 +219,14 @@ declare class OpenAICompatibleEmbeddingModel implements EmbeddingModelV4 {
     get provider(): string;
     get maxEmbeddingsPerCall(): number;
     get supportsParallelCalls(): boolean;
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleEmbeddingModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleEmbeddingConfig;
+    }): OpenAICompatibleEmbeddingModel;
     constructor(modelId: OpenAICompatibleEmbeddingModelId, config: OpenAICompatibleEmbeddingConfig);
     private get providerOptionsName();
     doEmbed({ values, headers, abortSignal, providerOptions, }: Parameters<EmbeddingModelV4['doEmbed']>[0]): Promise<Awaited<ReturnType<EmbeddingModelV4['doEmbed']>>>;
@@ -192,7 +236,7 @@ type OpenAICompatibleImageModelId = string;
 
 type OpenAICompatibleImageModelConfig = {
     provider: string;
-    headers: () => Record<string, string | undefined>;
+    headers?: () => Record<string, string | undefined>;
     url: (options: {
         modelId: string;
         path: string;
@@ -213,12 +257,20 @@ declare class OpenAICompatibleImageModel implements ImageModelV4 {
      * The provider options key used to extract provider-specific options.
      */
     private get providerOptionsKey();
+    static [WORKFLOW_SERIALIZE](model: OpenAICompatibleImageModel): {
+        modelId: string;
+        config: _ai_sdk_provider.JSONObject;
+    };
+    static [WORKFLOW_DESERIALIZE](options: {
+        modelId: string;
+        config: OpenAICompatibleImageModelConfig;
+    }): OpenAICompatibleImageModel;
     constructor(modelId: OpenAICompatibleImageModelId, config: OpenAICompatibleImageModelConfig);
     private getArgs;
     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<ProviderV4, 'imageModel'> {
+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 ProviderV4 {
     (modelId: CHAT_MODEL_IDS): LanguageModelV4;
     languageModel(modelId: CHAT_MODEL_IDS, config?: Partial<OpenAICompatibleChatConfig>): LanguageModelV4;
     chatModel(modelId: CHAT_MODEL_IDS): LanguageModelV4;
@@ -279,6 +331,15 @@ interface OpenAICompatibleProviderSettings {
      * or provider-specific metrics from both streaming and non-streaming responses.
      */
     metadataExtractor?: MetadataExtractor;
+    /**
+     * The supported URLs for chat models.
+     */
+    supportedUrls?: OpenAICompatibleChatConfig['supportedUrls'];
+    /**
+     * Optional usage converter for providers with token accounting semantics that
+     * differ from the default OpenAI-compatible shape.
+     */
+    convertUsage?: OpenAICompatibleChatConfig['convertUsage'];
 }
 /**
  * Create an OpenAICompatible provider instance.