chore(providers/openai-compatible): convert to providerOptions (#5673)

Author: samdenty

.changeset/fair-cobras-tan.md

@@ -0,0 +1,12 @@
+---
+'@ai-sdk/openai-compatible': patch
+'@ai-sdk/amazon-bedrock': patch
+'@ai-sdk/togetherai': patch
+'@ai-sdk/deepinfra': patch
+'@ai-sdk/fireworks': patch
+'@ai-sdk/cerebras': patch
+'@ai-sdk/deepseek': patch
+'@ai-sdk/xai': patch
+---
+
+feat(providers/openai-compatible): convert to providerOptions

content/providers/01-ai-sdk-providers/01-xai.mdx

@@ -94,17 +94,23 @@ xAI language models can also be used in the `streamText`, `generateObject`, and
 
 ### Chat Models
 
-xAI chat models also support some model specific settings that are not part of
-the [standard call settings](/docs/ai-sdk-core/settings). You can pass them as
-an options argument:
+xAI chat models also support some model specific provider options that are not part of
+the [standard call settings](/docs/ai-sdk-core/settings). You can pass them in `providerOptions` argument:
 
 ```ts
-const model = xai('grok-3', {
-  user: 'test-user', // optional unique user identifier
+const model = xai('grok-3');
+
+await generateText({
+  model,
+  providerOptions: {
+    xai: {
+      user: 'test-user', // optional unique user identifier
+    },
+  },
 });
 ```
 
-The following optional settings are available for xAI chat models:
+The following optional provider options are available for xAI chat models:
 
 - **user** _string_
 

content/providers/02-openai-compatible-providers/01-custom-providers.mdx

@@ -30,16 +30,10 @@ packages/example/
 1. **example-chat-settings.ts** - Define chat model IDs and settings:
 
 ```ts
-import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
-
 export type ExampleChatModelId =
   | 'example/chat-model-1'
   | 'example/chat-model-2'
   | (string & {});
-
-export interface ExampleChatSettings extends OpenAICompatibleChatSettings {
-  // Add any custom settings here
-}
 ```
 
 The completion, embedding, and image settings are implemented similarly to the chat settings.

packages/cerebras/src/cerebras-chat-settings.ts

@@ -1,10 +1,6 @@
-import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
-
 // https://inference-docs.cerebras.ai/introduction
 export type CerebrasChatModelId =
   | 'llama3.1-8b'
   | 'llama3.1-70b'
   | 'llama-3.3-70b'
   | (string & {});
-
-export interface CerebrasChatSettings extends OpenAICompatibleChatSettings {}

packages/cerebras/src/cerebras-provider.test.ts

@@ -28,7 +28,7 @@ describe('CerebrasProvider', () => {
 
       const constructorCall =
         OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[2];
+      const config = constructorCall[1];
       config.headers();
 
       expect(loadApiKey).toHaveBeenCalledWith({
@@ -49,7 +49,7 @@ describe('CerebrasProvider', () => {
 
       const constructorCall =
         OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[2];
+      const config = constructorCall[1];
       config.headers();
 
       expect(loadApiKey).toHaveBeenCalledWith({
@@ -62,9 +62,8 @@ describe('CerebrasProvider', () => {
     it('should return a chat model when called as a function', () => {
       const provider = createCerebras();
       const modelId = 'foo-model-id';
-      const settings = { user: 'foo-user' };
 
-      const model = provider(modelId, settings);
+      const model = provider(modelId);
       expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
     });
   });
@@ -73,9 +72,8 @@ describe('CerebrasProvider', () => {
     it('should construct a language model with correct configuration', () => {
       const provider = createCerebras();
       const modelId = 'foo-model-id';
-      const settings = { user: 'foo-user' };
 
-      const model = provider.languageModel(modelId, settings);
+      const model = provider.languageModel(modelId);
 
       expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
     });
@@ -95,9 +93,8 @@ describe('CerebrasProvider', () => {
     it('should construct a chat model with correct configuration', () => {
       const provider = createCerebras();
       const modelId = 'foo-model-id';
-      const settings = { user: 'foo-user' };
 
-      const model = provider.chat(modelId, settings);
+      const model = provider.chat(modelId);
 
       expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
     });

packages/cerebras/src/cerebras-provider.ts

@@ -9,10 +9,7 @@ import {
   loadApiKey,
   withoutTrailingSlash,
 } from '@ai-sdk/provider-utils';
-import {
-  CerebrasChatModelId,
-  CerebrasChatSettings,
-} from './cerebras-chat-settings';
+import { CerebrasChatModelId } from './cerebras-chat-settings';
 import { z } from 'zod';
 import { ProviderErrorStructure } from '@ai-sdk/openai-compatible';
 
@@ -55,26 +52,17 @@ export interface CerebrasProvider extends ProviderV2 {
   /**
 Creates a Cerebras model for text generation.
 */
-  (
-    modelId: CerebrasChatModelId,
-    settings?: CerebrasChatSettings,
-  ): LanguageModelV2;
+  (modelId: CerebrasChatModelId): LanguageModelV2;
 
   /**
 Creates a Cerebras model for text generation.
 */
-  languageModel(
-    modelId: CerebrasChatModelId,
-    settings?: CerebrasChatSettings,
-  ): LanguageModelV2;
+  languageModel(modelId: CerebrasChatModelId): LanguageModelV2;
 
   /**
 Creates a Cerebras chat model for text generation.
 */
-  chat(
-    modelId: CerebrasChatModelId,
-    settings?: CerebrasChatSettings,
-  ): LanguageModelV2;
+  chat(modelId: CerebrasChatModelId): LanguageModelV2;
 }
 
 export function createCerebras(
@@ -92,11 +80,8 @@ export function createCerebras(
     ...options.headers,
   });
 
-  const createLanguageModel = (
-    modelId: CerebrasChatModelId,
-    settings: CerebrasChatSettings = {},
-  ) => {
-    return new OpenAICompatibleChatLanguageModel(modelId, settings, {
+  const createLanguageModel = (modelId: CerebrasChatModelId) => {
+    return new OpenAICompatibleChatLanguageModel(modelId, {
       provider: `cerebras.chat`,
       url: ({ path }) => `${baseURL}${path}`,
       headers: getHeaders,
@@ -106,10 +91,8 @@ export function createCerebras(
     });
   };
 
-  const provider = (
-    modelId: CerebrasChatModelId,
-    settings?: CerebrasChatSettings,
-  ) => createLanguageModel(modelId, settings);
+  const provider = (modelId: CerebrasChatModelId) =>
+    createLanguageModel(modelId);
 
   provider.languageModel = createLanguageModel;
   provider.chat = createLanguageModel;

packages/deepinfra/src/deepinfra-chat-settings.ts

@@ -1,5 +1,3 @@
-import { OpenAICompatibleChatSettings } from '@ai-sdk/openai-compatible';
-
 // https://deepinfra.com/models/text-generation
 export type DeepInfraChatModelId =
   | 'meta-llama/Llama-4-Maverick-17B-128E-Instruct-FP8'
@@ -69,5 +67,3 @@ export type DeepInfraChatModelId =
   | 'openchat/openchat-3.6-8b'
   | 'openchat/openchat_3.5'
   | (string & {});
-
-export interface DeepInfraChatSettings extends OpenAICompatibleChatSettings {}

packages/deepinfra/src/deepinfra-completion-settings.ts

@@ -1,8 +1,4 @@
-import { OpenAICompatibleCompletionSettings } from '@ai-sdk/openai-compatible';
 import { DeepInfraChatModelId } from './deepinfra-chat-settings';
 
 // Use the same model IDs as chat
 export type DeepInfraCompletionModelId = DeepInfraChatModelId;
-
-export interface DeepInfraCompletionSettings
-  extends OpenAICompatibleCompletionSettings {}

packages/deepinfra/src/deepinfra-embedding-settings.ts

@@ -1,5 +1,3 @@
-import { OpenAICompatibleEmbeddingSettings } from '@ai-sdk/openai-compatible';
-
 // https://deepinfra.com/models/embeddings
 export type DeepInfraEmbeddingModelId =
   | 'BAAI/bge-base-en-v1.5'
@@ -19,6 +17,3 @@ export type DeepInfraEmbeddingModelId =
   | 'thenlper/gte-base'
   | 'thenlper/gte-large'
   | (string & {});
-
-export interface DeepInfraEmbeddingSettings
-  extends OpenAICompatibleEmbeddingSettings {}

packages/deepinfra/src/deepinfra-provider.test.ts

@@ -53,7 +53,7 @@ describe('DeepInfraProvider', () => {
       // Use the mocked version
       const constructorCall =
         OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[2];
+      const config = constructorCall[1];
       config.headers();
 
       expect(loadApiKey).toHaveBeenCalledWith({
@@ -74,7 +74,7 @@ describe('DeepInfraProvider', () => {
 
       const constructorCall =
         OpenAICompatibleChatLanguageModelMock.mock.calls[0];
-      const config = constructorCall[2];
+      const config = constructorCall[1];
       config.headers();
 
       expect(loadApiKey).toHaveBeenCalledWith({
@@ -87,9 +87,8 @@ describe('DeepInfraProvider', () => {
     it('should return a chat model when called as a function', () => {
       const provider = createDeepInfra();
       const modelId = 'foo-model-id';
-      const settings = { user: 'foo-user' };
 
-      const model = provider(modelId, settings);
+      const model = provider(modelId);
       expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
     });
   });
@@ -98,14 +97,12 @@ describe('DeepInfraProvider', () => {
     it('should construct a chat model with correct configuration', () => {
       const provider = createDeepInfra();
       const modelId = 'deepinfra-chat-model';
-      const settings = { user: 'foo-user' };
 
-      const model = provider.chatModel(modelId, settings);
+      const model = provider.chatModel(modelId);
 
       expect(model).toBeInstanceOf(OpenAICompatibleChatLanguageModel);
       expect(OpenAICompatibleChatLanguageModelMock).toHaveBeenCalledWith(
         modelId,
-        settings,
         expect.objectContaining({
           provider: 'deepinfra.chat',
           defaultObjectGenerationMode: 'json',
@@ -118,9 +115,8 @@ describe('DeepInfraProvider', () => {
     it('should construct a completion model with correct configuration', () => {
       const provider = createDeepInfra();
       const modelId = 'deepinfra-completion-model';
-      const settings = { user: 'foo-user' };
 
-      const model = provider.completionModel(modelId, settings);
+      const model = provider.completionModel(modelId);
 
       expect(model).toBeInstanceOf(OpenAICompatibleCompletionLanguageModel);
     });
@@ -130,9 +126,8 @@ describe('DeepInfraProvider', () => {
     it('should construct a text embedding model with correct configuration', () => {
       const provider = createDeepInfra();
       const modelId = 'deepinfra-embedding-model';
-      const settings = { user: 'foo-user' };
 
-      const model = provider.textEmbeddingModel(modelId, settings);
+      const model = provider.textEmbeddingModel(modelId);
 
       expect(model).toBeInstanceOf(OpenAICompatibleEmbeddingModel);
     });