@ai-sdk/openai 4.0.96 → 4.0.98

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai",
-  "version": "4.0.96",
+  "version": "4.0.98",
   "type": "module",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -35,13 +35,14 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "4.0.29",
-    "@ai-sdk/provider-utils": "5.0.62"
+    "@ai-sdk/provider": "4.0.31",
+    "@ai-sdk/provider-utils": "5.0.64"
   },
   "devDependencies": {
     "@ai-sdk/test-server": "2.0.4",
     "@types/node": "22.19.19",
     "@vercel/ai-tsconfig": "0.0.0",
+    "@vercel/ai-tsdown-config": "0.0.0",
     "tsdown": "^0.23.0",
     "typescript": "6.0.3",
     "zod": "3.25.76"

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

@@ -52,6 +52,8 @@ import { normalizeOpenAIJsonSchema } from '../normalize-openai-json-schema';
 
 type OpenAIChatConfig = {
   provider: string;
+  /** Model ID sent to the API. Defaults to the model's reported ID. */
+  requestModelId?: string;
   headers?: () => Record<string, string | undefined>;
   url: (options: { modelId: string; path: string }) => string;
   fetch?: FetchFunction;
@@ -182,7 +184,7 @@ export class OpenAIChatLanguageModel implements LanguageModelV4 {
 
     const baseArgs = {
       // model id:
-      model: this.modelId,
+      model: this.config.requestModelId ?? this.modelId,
 
       // model specific settings:
       logit_bias: openaiOptions.logitBias,
@@ -404,7 +406,7 @@ export class OpenAIChatLanguageModel implements LanguageModelV4 {
     } = await postJsonToApi({
       url: this.config.url({
         path: '/chat/completions',
-        modelId: this.modelId,
+        modelId: this.config.requestModelId ?? this.modelId,
       }),
       headers: combineHeaders(this.config.headers?.(), options.headers),
       body,
@@ -504,7 +506,7 @@ export class OpenAIChatLanguageModel implements LanguageModelV4 {
 
     const url = this.config.url({
       path: '/chat/completions',
-      modelId: this.modelId,
+      modelId: this.config.requestModelId ?? this.modelId,
     });
 
     const { responseHeaders, value: response } = await postJsonToApi({

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

@@ -43,6 +43,8 @@ import {
 } from './openai-completion-language-model-options';
 type OpenAICompletionConfig = {
   provider: string;
+  /** Model ID sent to the API. Defaults to the model's reported ID. */
+  requestModelId?: string;
   headers?: () => Record<string, string | undefined>;
   url: (options: { modelId: string; path: string }) => string;
   fetch?: FetchFunction;
@@ -148,7 +150,7 @@ export class OpenAICompletionLanguageModel implements LanguageModelV4 {
     return {
       args: {
         // model id:
-        model: this.modelId,
+        model: this.config.requestModelId ?? this.modelId,
 
         // model specific settings:
         echo: openaiOptions.echo,
@@ -192,7 +194,7 @@ export class OpenAICompletionLanguageModel implements LanguageModelV4 {
     } = await postJsonToApi({
       url: this.config.url({
         path: '/completions',
-        modelId: this.modelId,
+        modelId: this.config.requestModelId ?? this.modelId,
       }),
       headers: combineHeaders(this.config.headers?.(), options.headers),
       body: args,
@@ -246,7 +248,7 @@ export class OpenAICompletionLanguageModel implements LanguageModelV4 {
 
     const url = this.config.url({
       path: '/completions',
-      modelId: this.modelId,
+      modelId: this.config.requestModelId ?? this.modelId,
     });
 
     const { responseHeaders, value: response } = await postJsonToApi({

package/src/openai-config.ts

@@ -11,6 +11,8 @@ type SerializedOpenAIConfig = Omit<Partial<OpenAIConfig>, 'headers'> & {
 
 export type OpenAIConfig = {
   provider: string;
+  /** Model ID sent to the API. Defaults to the model's reported ID. */
+  requestModelId?: string;
   baseURL?: string;
   url: (options: { modelId: string; path: string }) => string;
   headers?: () => OpenAIHeaders;

package/src/openai-decision-model.ts

@@ -114,6 +114,8 @@ export class DecisionOpenAIModel implements DecisionModelV4 {
   async doDecide({
     state,
     questions,
+    maxOutputTokens,
+    reasoning,
     headers,
     abortSignal,
     providerOptions,
@@ -180,7 +182,10 @@ export class DecisionOpenAIModel implements DecisionModelV4 {
           },
         ],
         questions: Object.entries(questions).map(([name, question]) => {
-          const instructions = toText(question.instructions);
+          const instructions =
+            question.instructions == null
+              ? question.instructions
+              : toText(question.instructions);
           switch (question.type) {
             case 'boolean':
               return {
@@ -195,7 +200,7 @@ export class DecisionOpenAIModel implements DecisionModelV4 {
                     ? undefined
                     : `Criteria for false:\n${toText(question.criteria.false)}`,
                 ]
-                  .filter(part => part !== undefined)
+                  .filter(part => part != null)
                   .join('\n\n'),
               };
             case 'choice':
@@ -299,12 +304,20 @@ export class DecisionOpenAIModel implements DecisionModelV4 {
             },
       // The Decisions API reports probabilities and scores to two decimal places.
       rounding: { probabilityDecimals: 2, scoreDecimals: 2 },
-      warnings: Object.keys(providerOptions?.openai ?? {})
-        .filter(option => option !== 'safetyIdentifier')
-        .map(option => ({
-          type: 'unsupported',
-          feature: `providerOptions.openai.${option}`,
-        })),
+      warnings: [
+        ...(maxOutputTokens != null
+          ? [{ type: 'unsupported' as const, feature: 'maxOutputTokens' }]
+          : []),
+        ...(reasoning != null
+          ? [{ type: 'unsupported' as const, feature: 'reasoning' }]
+          : []),
+        ...Object.keys(providerOptions?.openai ?? {})
+          .filter(option => option !== 'safetyIdentifier')
+          .map(option => ({
+            type: 'unsupported' as const,
+            feature: `providerOptions.openai.${option}`,
+          })),
+      ],
       providerMetadata: {
         openai: {
           ...(response.usage == null ? {} : { usage: response.usage }),

package/src/responses/convert-to-openai-responses-input.ts

@@ -1224,6 +1224,9 @@ export async function convertToOpenAIResponsesInput({
                   input.push({
                     type: 'shell_call_output',
                     call_id: part.toolCallId,
+                    ...(parsedOutput.maxOutputLength != null && {
+                      max_output_length: parsedOutput.maxOutputLength,
+                    }),
                     output: parsedOutput.output.map(item => ({
                       stdout: item.stdout,
                       stderr: item.stderr,
@@ -1565,6 +1568,9 @@ export async function convertToOpenAIResponsesInput({
             input.push({
               type: 'shell_call_output',
               call_id: part.toolCallId,
+              ...(parsedOutput.maxOutputLength != null && {
+                max_output_length: parsedOutput.maxOutputLength,
+              }),
               output: parsedOutput.output.map(item => ({
                 stdout: item.stdout,
                 stderr: item.stderr,

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

@@ -1061,6 +1061,8 @@ export const openaiResponsesChunkSchema = lazySchema(() =>
             status: z.enum(['in_progress', 'completed', 'incomplete']),
             action: z.object({
               commands: z.array(z.string()),
+              timeout_ms: z.number().nullish(),
+              max_output_length: z.number().nullish(),
             }),
           }),
           z.object({
@@ -1073,6 +1075,7 @@ export const openaiResponsesChunkSchema = lazySchema(() =>
             id: z.string(),
             call_id: z.string(),
             status: z.enum(['in_progress', 'completed', 'incomplete']),
+            max_output_length: z.number().nullish(),
             output: z.array(
               z.object({
                 stdout: z.string(),
@@ -1296,6 +1299,8 @@ export const openaiResponsesChunkSchema = lazySchema(() =>
             status: z.enum(['in_progress', 'completed', 'incomplete']),
             action: z.object({
               commands: z.array(z.string()),
+              timeout_ms: z.number().nullish(),
+              max_output_length: z.number().nullish(),
             }),
           }),
           z.object({
@@ -1308,6 +1313,7 @@ export const openaiResponsesChunkSchema = lazySchema(() =>
             id: z.string(),
             call_id: z.string(),
             status: z.enum(['in_progress', 'completed', 'incomplete']),
+            max_output_length: z.number().nullish(),
             output: z.array(
               z.object({
                 stdout: z.string(),
@@ -1737,6 +1743,8 @@ export const openaiResponsesResponseSchema = lazySchema(() =>
               status: z.enum(['in_progress', 'completed', 'incomplete']),
               action: z.object({
                 commands: z.array(z.string()),
+                timeout_ms: z.number().nullish(),
+                max_output_length: z.number().nullish(),
               }),
             }),
             z.object({
@@ -1749,6 +1757,7 @@ export const openaiResponsesResponseSchema = lazySchema(() =>
               id: z.string(),
               call_id: z.string(),
               status: z.enum(['in_progress', 'completed', 'incomplete']),
+              max_output_length: z.number().nullish(),
               output: z.array(
                 z.object({
                   stdout: z.string(),

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

@@ -598,7 +598,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
     }
 
     const baseArgs = {
-      model: modelId,
+      model: config.requestModelId ?? modelId,
       input,
       temperature,
       top_p: topP,
@@ -854,7 +854,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
     } = await this.getArgs(options);
     const url = this.config.url({
       path: '/responses',
-      modelId: this.modelId,
+      modelId: this.config.requestModelId ?? this.modelId,
     });
 
     const approvalRequestIdToDummyToolCallIdFromPrompt =
@@ -1045,6 +1045,8 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
             input: JSON.stringify({
               action: {
                 commands: part.action.commands,
+                timeoutMs: part.action.timeout_ms ?? undefined,
+                maxOutputLength: part.action.max_output_length ?? undefined,
               },
             } satisfies InferSchema<typeof shellInputSchema>),
             ...(isShellProviderExecuted && { providerExecuted: true }),
@@ -1064,6 +1066,9 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
             toolCallId: part.call_id,
             toolName: toolNameMapping.toCustomToolName('shell'),
             result: {
+              ...(part.max_output_length != null && {
+                maxOutputLength: part.max_output_length,
+              }),
               output: part.output.map(item => ({
                 stdout: item.stdout,
                 stderr: item.stderr,
@@ -1547,7 +1552,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
 
     const url = this.config.url({
       path: '/responses',
-      modelId: this.modelId,
+      modelId: this.config.requestModelId ?? this.modelId,
     });
 
     const { responseHeaders, value: response } = await postJsonToApi({
@@ -2530,6 +2535,9 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
                   input: JSON.stringify({
                     action: {
                       commands: value.item.action.commands,
+                      timeoutMs: value.item.action.timeout_ms ?? undefined,
+                      maxOutputLength:
+                        value.item.action.max_output_length ?? undefined,
                     },
                   } satisfies InferSchema<typeof shellInputSchema>),
                   ...(isShellProviderExecuted && {
@@ -2545,6 +2553,9 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV4 {
                   toolCallId: value.item.call_id,
                   toolName: toolNameMapping.toCustomToolName('shell'),
                   result: {
+                    ...(value.item.max_output_length != null && {
+                      maxOutputLength: value.item.max_output_length,
+                    }),
                     output: value.item.output.map(
                       (item: {
                         stdout: string;

package/src/tool/shell.ts

@@ -21,6 +21,7 @@ export const shellInputSchema = lazySchema(() =>
 export const shellOutputSchema = lazySchema(() =>
   zodSchema(
     z.object({
+      maxOutputLength: z.number().optional(),
       output: z.array(
         z.object({
           stdout: z.string(),
@@ -180,6 +181,11 @@ export const shell = createProviderDefinedToolFactoryWithOutputSchema<
     };
   },
   {
+    /**
+     * Optional maximum number of characters that was applied to each command's output.
+     */
+    maxOutputLength?: number;
+
     /**
      * An array of shell call output contents.
      */

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

@@ -6,6 +6,7 @@ export const openaiTranscriptionResponseSchema = lazySchema(() =>
     z.object({
       text: z.string(),
       language: z.string().nullish(),
+      languages: z.array(z.object({ code: z.string() })).nullish(),
       duration: z.number().nullish(),
       words: z
         .array(

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

@@ -136,6 +136,12 @@ const languageMap = {
   welsh: 'cy',
 };
 
+function isLanguageCode(
+  language: string | null | undefined,
+): language is string {
+  return language != null && /^[a-z]{2}$/.test(language);
+}
+
 export class OpenAITranscriptionModel implements TranscriptionModelV4 {
   readonly specificationVersion = 'v4';
 
@@ -299,9 +305,16 @@ export class OpenAITranscriptionModel implements TranscriptionModelV4 {
     });
 
     const language =
-      response.language != null && response.language in languageMap
-        ? languageMap[response.language as keyof typeof languageMap]
-        : undefined;
+      (isLanguageCode(response.language)
+        ? response.language
+        : response.language != null &&
+            Object.prototype.hasOwnProperty.call(languageMap, response.language)
+          ? languageMap[response.language as keyof typeof languageMap]
+          : undefined) ??
+      (response.languages?.length === 1 &&
+      isLanguageCode(response.languages[0].code)
+        ? response.languages[0].code
+        : undefined);
 
     const diarizedSegments = response.segments?.flatMap(segment =>
       'speaker' in segment
@@ -340,14 +353,20 @@ export class OpenAITranscriptionModel implements TranscriptionModelV4 {
         headers: responseHeaders,
         body: rawResponse,
       },
-      ...(diarizedSegments != null &&
-        diarizedSegments.length > 0 && {
-          providerMetadata: {
-            openai: {
-              segments: diarizedSegments,
-            },
+      ...(((diarizedSegments != null && diarizedSegments.length > 0) ||
+        response.languages != null) && {
+        providerMetadata: {
+          openai: {
+            ...(diarizedSegments != null &&
+              diarizedSegments.length > 0 && {
+                segments: diarizedSegments,
+              }),
+            ...(response.languages != null && {
+              languages: response.languages,
+            }),
           },
-        }),
+        },
+      }),
     };
   }