@ai-sdk/openai 3.0.25 → 3.0.27

package/docs/03-openai.mdx

@@ -135,10 +135,10 @@ const model = openai('gpt-5');
 ```
 
 Further configuration can be done using OpenAI provider options.
-You can validate the provider options using the `OpenAIResponsesProviderOptions` type.
+You can validate the provider options using the `OpenAILanguageModelResponsesOptions` type.
 
 ```ts
-import { openai, OpenAIResponsesProviderOptions } from '@ai-sdk/openai';
+import { openai, OpenAILanguageModelResponsesOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const result = await generateText({
@@ -149,7 +149,7 @@ const result = await generateText({
       store: false,
       user: 'user_123',
       // ...
-    } satisfies OpenAIResponsesProviderOptions,
+    } satisfies OpenAILanguageModelResponsesOptions,
   },
   // ...
 });
@@ -292,7 +292,10 @@ The following OpenAI-specific metadata may be returned:
 For reasoning models like `gpt-5`, you can enable reasoning summaries to see the model's thought process. Different models support different summarizers—for example, `o4-mini` supports detailed summaries. Set `reasoningSummary: "auto"` to automatically receive the richest level available.
 
 ```ts highlight="8-9,16"
-import { openai } from '@ai-sdk/openai';
+import {
+  openai,
+  type OpenAILanguageModelResponsesOptions,
+} from '@ai-sdk/openai';
 import { streamText } from 'ai';
 
 const result = streamText({
@@ -301,7 +304,7 @@ const result = streamText({
   providerOptions: {
     openai: {
       reasoningSummary: 'detailed', // 'auto' for condensed or 'detailed' for comprehensive
-    },
+    } satisfies OpenAILanguageModelResponsesOptions,
   },
 });
 
@@ -317,7 +320,10 @@ for await (const part of result.fullStream) {
 For non-streaming calls with `generateText`, the reasoning summaries are available in the `reasoning` field of the response:
 
 ```ts highlight="8-9,13"
-import { openai } from '@ai-sdk/openai';
+import {
+  openai,
+  type OpenAILanguageModelResponsesOptions,
+} from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const result = await generateText({
@@ -326,7 +332,7 @@ const result = await generateText({
   providerOptions: {
     openai: {
       reasoningSummary: 'auto',
-    },
+    } satisfies OpenAILanguageModelResponsesOptions,
   },
 });
 console.log('Reasoning:', result.reasoning);
@@ -339,7 +345,10 @@ Learn more about reasoning summaries in the [OpenAI documentation](https://platf
 You can control the length and detail of model responses using the `textVerbosity` parameter:
 
 ```ts
-import { openai } from '@ai-sdk/openai';
+import {
+  openai,
+  type OpenAILanguageModelResponsesOptions,
+} from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const result = await generateText({
@@ -348,7 +357,7 @@ const result = await generateText({
   providerOptions: {
     openai: {
       textVerbosity: 'low', // 'low' for concise, 'medium' (default), or 'high' for verbose
-    },
+    } satisfies OpenAILanguageModelResponsesOptions,
   },
 });
 ```
@@ -439,7 +448,7 @@ const result = await generateText({
     openai: {
       // optional: include results
       include: ['file_search_call.results'],
-    } satisfies OpenAIResponsesProviderOptions,
+    } satisfies OpenAILanguageModelResponsesOptions,
   },
 });
 ```
@@ -1014,7 +1023,7 @@ This metadata includes the following fields:
 import {
   openai,
   type OpenaiResponsesReasoningProviderMetadata,
-  type OpenAIResponsesProviderOptions,
+  type OpenAILanguageModelResponsesOptions,
 } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
@@ -1025,7 +1034,7 @@ const result = await generateText({
     openai: {
       store: false,
       include: ['reasoning.encrypted_content'],
-    } satisfies OpenAIResponsesProviderOptions,
+    } satisfies OpenAILanguageModelResponsesOptions,
   },
 });
 
@@ -1130,7 +1139,7 @@ OpenAI chat models support also some model specific provider options that are no
 You can pass them in the `providerOptions` argument:
 
 ```ts
-import { openai, type OpenAIChatLanguageModelOptions } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 
 const model = openai.chat('gpt-5');
 
@@ -1143,7 +1152,7 @@ await generateText({
         '50256': -100,
       },
       user: 'test-user', // optional unique user identifier
-    } satisfies OpenAIChatLanguageModelOptions,
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 ```
@@ -1261,7 +1270,7 @@ They support additional settings and response metadata:
 - You can use response `providerMetadata` to access the number of reasoning tokens that the model generated.
 
 ```ts highlight="4,7-11,17"
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const { text, usage, providerMetadata } = await generateText({
@@ -1270,7 +1279,7 @@ const { text, usage, providerMetadata } = await generateText({
   providerOptions: {
     openai: {
       reasoningEffort: 'low',
-    },
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 
@@ -1293,7 +1302,7 @@ console.log('Usage:', {
   - `remove`: remove the system message from the messages.
 
 ```ts highlight="12"
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const result = await generateText({
@@ -1305,7 +1314,7 @@ const result = await generateText({
   providerOptions: {
     openai: {
       systemMessageMode: 'system',
-    },
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 ```
@@ -1327,7 +1336,7 @@ Strict structured outputs are enabled by default.
 You can disable them by setting the `strictJsonSchema` option to `false`.
 
 ```ts highlight="7"
-import { openai, OpenAIChatLanguageModelOptions } from '@ai-sdk/openai';
+import { openai, OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateObject } from 'ai';
 import { z } from 'zod';
 
@@ -1336,7 +1345,7 @@ const result = await generateObject({
   providerOptions: {
     openai: {
       strictJsonSchema: false,
-    } satisfies OpenAIChatLanguageModelOptions,
+    } satisfies OpenAILanguageModelChatOptions,
   },
   schemaName: 'recipe',
   schemaDescription: 'A recipe for lasagna.',
@@ -1373,7 +1382,7 @@ OpenAI provides logprobs information for completion/chat models.
 You can access it in the `providerMetadata` object.
 
 ```ts highlight="11"
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const result = await generateText({
@@ -1384,7 +1393,7 @@ const result = await generateText({
       // this can also be a number,
       // refer to logprobs provider options section for more
       logprobs: true,
-    },
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 
@@ -1510,7 +1519,7 @@ const result = streamText({
         type: 'content',
         content: existingCode,
       },
-    },
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 ```
@@ -1574,7 +1583,7 @@ If you want to store a generation for use in the distillation process, you can a
 This will save the generation to the OpenAI platform for later use in distillation.
 
 ```typescript highlight="9-16"
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 import 'dotenv/config';
 
@@ -1588,7 +1597,7 @@ async function main() {
         metadata: {
           custom: 'value',
         },
-      },
+      } satisfies OpenAILanguageModelChatOptions,
     },
   });
 
@@ -1630,7 +1639,7 @@ console.log(`usage:`, {
 To improve cache hit rates, you can manually control caching using the `promptCacheKey` option:
 
 ```ts highlight="7-11"
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const { text, usage, providerMetadata } = await generateText({
@@ -1639,7 +1648,7 @@ const { text, usage, providerMetadata } = await generateText({
   providerOptions: {
     openai: {
       promptCacheKey: 'my-custom-cache-key-123',
-    },
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 
@@ -1652,7 +1661,7 @@ console.log(`usage:`, {
 For GPT-5.1 models, you can enable extended prompt caching that keeps cached prefixes active for up to 24 hours:
 
 ```ts highlight="7-12"
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAILanguageModelChatOptions } from '@ai-sdk/openai';
 import { generateText } from 'ai';
 
 const { text, usage, providerMetadata } = await generateText({
@@ -1662,7 +1671,7 @@ const { text, usage, providerMetadata } = await generateText({
     openai: {
       promptCacheKey: 'my-custom-cache-key-123',
       promptCacheRetention: '24h', // Extended caching for GPT-5.1
-    },
+    } satisfies OpenAILanguageModelChatOptions,
   },
 });
 
@@ -1729,7 +1738,7 @@ await model.doGenerate({
       },
       suffix: 'some text', // optional suffix that comes after a completion of inserted text
       user: 'test-user', // optional unique user identifier
-    },
+    } satisfies OpenAILanguageModelCompletionOptions,
   },
 });
 ```
@@ -1819,7 +1828,7 @@ OpenAI embedding models support several additional provider options.
 You can pass them as an options argument:
 
 ```ts
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAIEmbeddingModelOptions } from '@ai-sdk/openai';
 import { embed } from 'ai';
 
 const { embedding } = await embed({
@@ -1829,7 +1838,7 @@ const { embedding } = await embed({
     openai: {
       dimensions: 512, // optional, number of dimensions for the embedding
       user: 'test-user', // optional unique user identifier
-    },
+    } satisfies OpenAIEmbeddingModelOptions,
   },
 });
 ```
@@ -2009,12 +2018,14 @@ You can also pass additional provider-specific options using the `providerOption
 
 ```ts highlight="6"
 import { experimental_transcribe as transcribe } from 'ai';
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAITranscriptionModelOptions } from '@ai-sdk/openai';
 
 const result = await transcribe({
   model: openai.transcription('whisper-1'),
   audio: new Uint8Array([1, 2, 3, 4]),
-  providerOptions: { openai: { language: 'en' } },
+  providerOptions: {
+    openai: { language: 'en' } satisfies OpenAITranscriptionModelOptions,
+  },
 });
 ```
 
@@ -2022,7 +2033,7 @@ To get word-level timestamps, specify the granularity:
 
 ```ts highlight="8-9"
 import { experimental_transcribe as transcribe } from 'ai';
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAITranscriptionModelOptions } from '@ai-sdk/openai';
 
 const result = await transcribe({
   model: openai.transcription('whisper-1'),
@@ -2031,7 +2042,7 @@ const result = await transcribe({
     openai: {
       //timestampGranularities: ['word'],
       timestampGranularities: ['segment'],
-    },
+    } satisfies OpenAITranscriptionModelOptions,
   },
 });
 
@@ -2099,7 +2110,7 @@ You can also pass additional provider-specific options using the `providerOption
 
 ```ts highlight="7-9"
 import { experimental_generateSpeech as generateSpeech } from 'ai';
-import { openai } from '@ai-sdk/openai';
+import { openai, type OpenAISpeechModelOptions } from '@ai-sdk/openai';
 
 const result = await generateSpeech({
   model: openai.speech('tts-1'),
@@ -2108,7 +2119,7 @@ const result = await generateSpeech({
   providerOptions: {
     openai: {
       speed: 1.2,
-    },
+    } satisfies OpenAISpeechModelOptions,
   },
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai",
-  "version": "3.0.25",
+  "version": "3.0.27",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -36,8 +36,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "3.0.7",
-    "@ai-sdk/provider-utils": "4.0.13"
+    "@ai-sdk/provider": "3.0.8",
+    "@ai-sdk/provider-utils": "4.0.14"
   },
   "devDependencies": {
     "@types/node": "20.17.24",

package/src/chat/openai-chat-language-model.ts

@@ -37,7 +37,7 @@ import {
 } from './openai-chat-api';
 import {
   OpenAIChatModelId,
-  openaiChatLanguageModelOptions,
+  openaiLanguageModelChatOptions,
 } from './openai-chat-options';
 import { prepareChatTools } from './openai-chat-prepare-tools';
 
@@ -90,7 +90,7 @@ export class OpenAIChatLanguageModel implements LanguageModelV3 {
       (await parseProviderOptions({
         provider: 'openai',
         providerOptions,
-        schema: openaiChatLanguageModelOptions,
+        schema: openaiLanguageModelChatOptions,
       })) ?? {};
 
     const modelCapabilities = getOpenAILanguageModelCapabilities(this.modelId);

package/src/chat/openai-chat-options.ts

@@ -47,7 +47,7 @@ export type OpenAIChatModelId =
   | 'gpt-5.2-pro'
   | (string & {});
 
-export const openaiChatLanguageModelOptions = lazySchema(() =>
+export const openaiLanguageModelChatOptions = lazySchema(() =>
   zodSchema(
     z.object({
       /**
@@ -181,6 +181,6 @@ export const openaiChatLanguageModelOptions = lazySchema(() =>
   ),
 );
 
-export type OpenAIChatLanguageModelOptions = InferSchema<
-  typeof openaiChatLanguageModelOptions
+export type OpenAILanguageModelChatOptions = InferSchema<
+  typeof openaiLanguageModelChatOptions
 >;

package/src/completion/openai-completion-language-model.ts

@@ -32,7 +32,7 @@ import {
 } from './openai-completion-api';
 import {
   OpenAICompletionModelId,
-  openaiCompletionProviderOptions,
+  openaiLanguageModelCompletionOptions,
 } from './openai-completion-options';
 
 type OpenAICompletionConfig = {
@@ -91,12 +91,12 @@ export class OpenAICompletionLanguageModel implements LanguageModelV3 {
       ...(await parseProviderOptions({
         provider: 'openai',
         providerOptions,
-        schema: openaiCompletionProviderOptions,
+        schema: openaiLanguageModelCompletionOptions,
       })),
       ...(await parseProviderOptions({
         provider: this.providerOptionsName,
         providerOptions,
-        schema: openaiCompletionProviderOptions,
+        schema: openaiLanguageModelCompletionOptions,
       })),
     };
 

package/src/completion/openai-completion-options.ts

@@ -4,7 +4,7 @@ import { z } from 'zod/v4';
 // https://platform.openai.com/docs/models
 export type OpenAICompletionModelId = 'gpt-3.5-turbo-instruct' | (string & {});
 
-export const openaiCompletionProviderOptions = lazySchema(() =>
+export const openaiLanguageModelCompletionOptions = lazySchema(() =>
   zodSchema(
     z.object({
       /**
@@ -53,6 +53,6 @@ export const openaiCompletionProviderOptions = lazySchema(() =>
   ),
 );
 
-export type OpenAICompletionProviderOptions = InferSchema<
-  typeof openaiCompletionProviderOptions
+export type OpenAILanguageModelCompletionOptions = InferSchema<
+  typeof openaiLanguageModelCompletionOptions
 >;

package/src/embedding/openai-embedding-model.ts

@@ -12,7 +12,7 @@ import { OpenAIConfig } from '../openai-config';
 import { openaiFailedResponseHandler } from '../openai-error';
 import {
   OpenAIEmbeddingModelId,
-  openaiEmbeddingProviderOptions,
+  openaiEmbeddingModelOptions,
 } from './openai-embedding-options';
 import { openaiTextEmbeddingResponseSchema } from './openai-embedding-api';
 
@@ -55,7 +55,7 @@ export class OpenAIEmbeddingModel implements EmbeddingModelV3 {
       (await parseProviderOptions({
         provider: 'openai',
         providerOptions,
-        schema: openaiEmbeddingProviderOptions,
+        schema: openaiEmbeddingModelOptions,
       })) ?? {};
 
     const {

package/src/embedding/openai-embedding-options.ts

@@ -7,7 +7,7 @@ export type OpenAIEmbeddingModelId =
   | 'text-embedding-ada-002'
   | (string & {});
 
-export const openaiEmbeddingProviderOptions = lazySchema(() =>
+export const openaiEmbeddingModelOptions = lazySchema(() =>
   zodSchema(
     z.object({
       /**
@@ -25,6 +25,6 @@ export const openaiEmbeddingProviderOptions = lazySchema(() =>
   ),
 );
 
-export type OpenAIEmbeddingProviderOptions = InferSchema<
-  typeof openaiEmbeddingProviderOptions
+export type OpenAIEmbeddingModelOptions = InferSchema<
+  typeof openaiEmbeddingModelOptions
 >;

package/src/index.ts

@@ -1,7 +1,19 @@
 export { createOpenAI, openai } from './openai-provider';
 export type { OpenAIProvider, OpenAIProviderSettings } from './openai-provider';
-export type { OpenAIResponsesProviderOptions } from './responses/openai-responses-options';
-export type { OpenAIChatLanguageModelOptions } from './chat/openai-chat-options';
+export type {
+  OpenAILanguageModelResponsesOptions,
+  /** @deprecated Use `OpenAILanguageModelResponsesOptions` instead. */
+  OpenAILanguageModelResponsesOptions as OpenAIResponsesProviderOptions,
+} from './responses/openai-responses-options';
+export type {
+  OpenAILanguageModelChatOptions,
+  /** @deprecated Use `OpenAILanguageModelChatOptions` instead. */
+  OpenAILanguageModelChatOptions as OpenAIChatLanguageModelOptions,
+} from './chat/openai-chat-options';
+export type { OpenAILanguageModelCompletionOptions } from './completion/openai-completion-options';
+export type { OpenAIEmbeddingModelOptions } from './embedding/openai-embedding-options';
+export type { OpenAISpeechModelOptions } from './speech/openai-speech-options';
+export type { OpenAITranscriptionModelOptions } from './transcription/openai-transcription-options';
 export type {
   OpenaiResponsesProviderMetadata,
   OpenaiResponsesReasoningProviderMetadata,

package/src/responses/openai-responses-language-model.ts

@@ -58,7 +58,7 @@ import {
 } from './openai-responses-api';
 import {
   OpenAIResponsesModelId,
-  openaiResponsesProviderOptionsSchema,
+  openaiLanguageModelResponsesOptionsSchema,
   TOP_LOGPROBS_MAX,
 } from './openai-responses-options';
 import { prepareResponsesTools } from './openai-responses-prepare-tools';
@@ -159,14 +159,14 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
     let openaiOptions = await parseProviderOptions({
       provider: providerOptionsName,
       providerOptions,
-      schema: openaiResponsesProviderOptionsSchema,
+      schema: openaiLanguageModelResponsesOptionsSchema,
     });
 
     if (openaiOptions == null && providerOptionsName !== 'openai') {
       openaiOptions = await parseProviderOptions({
         provider: 'openai',
         providerOptions,
-        schema: openaiResponsesProviderOptionsSchema,
+        schema: openaiLanguageModelResponsesOptionsSchema,
       });
     }
 

package/src/responses/openai-responses-options.ts

@@ -129,7 +129,7 @@ export type OpenAIResponsesModelId =
   | (string & {});
 
 // TODO AI SDK 6: use optional here instead of nullish
-export const openaiResponsesProviderOptionsSchema = lazySchema(() =>
+export const openaiLanguageModelResponsesOptionsSchema = lazySchema(() =>
   zodSchema(
     z.object({
       /**
@@ -307,6 +307,6 @@ export const openaiResponsesProviderOptionsSchema = lazySchema(() =>
   ),
 );
 
-export type OpenAIResponsesProviderOptions = InferSchema<
-  typeof openaiResponsesProviderOptionsSchema
+export type OpenAILanguageModelResponsesOptions = InferSchema<
+  typeof openaiLanguageModelResponsesOptionsSchema
 >;

package/src/speech/openai-speech-model.ts

@@ -9,7 +9,7 @@ import { OpenAIConfig } from '../openai-config';
 import { openaiFailedResponseHandler } from '../openai-error';
 import { OpenAISpeechAPITypes } from './openai-speech-api';
 import {
-  openaiSpeechProviderOptionsSchema,
+  openaiSpeechModelOptionsSchema,
   OpenAISpeechModelId,
 } from './openai-speech-options';
 
@@ -46,7 +46,7 @@ export class OpenAISpeechModel implements SpeechModelV3 {
     const openAIOptions = await parseProviderOptions({
       provider: 'openai',
       providerOptions,
-      schema: openaiSpeechProviderOptionsSchema,
+      schema: openaiSpeechModelOptionsSchema,
     });
 
     // Create request body

package/src/speech/openai-speech-options.ts

@@ -8,7 +8,7 @@ export type OpenAISpeechModelId =
   | (string & {});
 
 // https://platform.openai.com/docs/api-reference/audio/createSpeech
-export const openaiSpeechProviderOptionsSchema = lazySchema(() =>
+export const openaiSpeechModelOptionsSchema = lazySchema(() =>
   zodSchema(
     z.object({
       instructions: z.string().nullish(),
@@ -17,6 +17,6 @@ export const openaiSpeechProviderOptionsSchema = lazySchema(() =>
   ),
 );
 
-export type OpenAISpeechCallOptions = InferSchema<
-  typeof openaiSpeechProviderOptionsSchema
+export type OpenAISpeechModelOptions = InferSchema<
+  typeof openaiSpeechModelOptionsSchema
 >;

package/src/transcription/openai-transcription-model.ts

@@ -16,8 +16,8 @@ import { openaiFailedResponseHandler } from '../openai-error';
 import { openaiTranscriptionResponseSchema } from './openai-transcription-api';
 import {
   OpenAITranscriptionModelId,
-  openAITranscriptionProviderOptions,
-  OpenAITranscriptionProviderOptions,
+  openAITranscriptionModelOptions,
+  OpenAITranscriptionModelOptions,
 } from './openai-transcription-options';
 
 export type OpenAITranscriptionCallOptions = Omit<
@@ -25,7 +25,7 @@ export type OpenAITranscriptionCallOptions = Omit<
   'providerOptions'
 > & {
   providerOptions?: {
-    openai?: OpenAITranscriptionProviderOptions;
+    openai?: OpenAITranscriptionModelOptions;
   };
 };
 
@@ -119,7 +119,7 @@ export class OpenAITranscriptionModel implements TranscriptionModelV3 {
     const openAIOptions = await parseProviderOptions({
       provider: 'openai',
       providerOptions,
-      schema: openAITranscriptionProviderOptions,
+      schema: openAITranscriptionModelOptions,
     });
 
     // Create form data with base fields

package/src/transcription/openai-transcription-options.ts

@@ -8,7 +8,7 @@ export type OpenAITranscriptionModelId =
   | (string & {});
 
 // https://platform.openai.com/docs/api-reference/audio/createTranscription
-export const openAITranscriptionProviderOptions = lazySchema(() =>
+export const openAITranscriptionModelOptions = lazySchema(() =>
   zodSchema(
     z.object({
       /**
@@ -45,6 +45,6 @@ export const openAITranscriptionProviderOptions = lazySchema(() =>
   ),
 );
 
-export type OpenAITranscriptionProviderOptions = InferSchema<
-  typeof openAITranscriptionProviderOptions
+export type OpenAITranscriptionModelOptions = InferSchema<
+  typeof openAITranscriptionModelOptions
 >;