@ai-sdk/openai 3.0.13 → 3.0.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai",
-  "version": "3.0.13",
+  "version": "3.0.15",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -8,6 +8,7 @@
   "types": "./dist/index.d.ts",
   "files": [
     "dist/**/*",
+    "src",
     "CHANGELOG.md",
     "README.md",
     "internal.d.ts"
@@ -27,8 +28,8 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/provider-utils": "4.0.8",
+    "@ai-sdk/provider": "3.0.4"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
@@ -36,7 +37,7 @@
     "typescript": "5.8.3",
     "zod": "3.25.76",
     "@vercel/ai-tsconfig": "0.0.0",
-    "@ai-sdk/test-server": "1.0.1"
+    "@ai-sdk/test-server": "1.0.2"
   },
   "peerDependencies": {
     "zod": "^3.25.76 || ^4.1.8"

package/src/chat/__fixtures__/azure-model-router.1.chunks.txt

@@ -0,0 +1,8 @@
+{"choices":[],"created":0,"id":"","model":"","object":"","prompt_filter_results":[{"prompt_index":0,"content_filter_results":{"hate":{"filtered":false,"severity":"safe"},"jailbreak":{"filtered":false,"detected":false},"self_harm":{"filtered":false,"severity":"safe"},"sexual":{"filtered":false,"severity":"safe"},"violence":{"filtered":false,"severity":"safe"}}}]}
+{"choices":[{"content_filter_results":{},"delta":{"content":"","refusal":null,"role":"assistant"},"finish_reason":null,"index":0,"logprobs":null}],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"D3WbtIxo1Q2j1Q","object":"chat.completion.chunk","system_fingerprint":null,"usage":null}
+{"choices":[{"content_filter_results":{"hate":{"filtered":false,"severity":"safe"},"self_harm":{"filtered":false,"severity":"safe"},"sexual":{"filtered":false,"severity":"safe"},"violence":{"filtered":false,"severity":"safe"}},"delta":{"content":"Capital"},"finish_reason":null,"index":0,"logprobs":null}],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"NNpA6Dj2U","object":"chat.completion.chunk","system_fingerprint":null,"usage":null}
+{"choices":[{"content_filter_results":{"hate":{"filtered":false,"severity":"safe"},"self_harm":{"filtered":false,"severity":"safe"},"sexual":{"filtered":false,"severity":"safe"},"violence":{"filtered":false,"severity":"safe"}},"delta":{"content":" of"},"finish_reason":null,"index":0,"logprobs":null}],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"etvV32yk5dbxb","object":"chat.completion.chunk","system_fingerprint":null,"usage":null}
+{"choices":[{"content_filter_results":{"hate":{"filtered":false,"severity":"safe"},"self_harm":{"filtered":false,"severity":"safe"},"sexual":{"filtered":false,"severity":"safe"},"violence":{"filtered":false,"severity":"safe"}},"delta":{"content":" Denmark"},"finish_reason":null,"index":0,"logprobs":null}],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"iDOuV7Jz","object":"chat.completion.chunk","system_fingerprint":null,"usage":null}
+{"choices":[{"content_filter_results":{"hate":{"filtered":false,"severity":"safe"},"self_harm":{"filtered":false,"severity":"safe"},"sexual":{"filtered":false,"severity":"safe"},"violence":{"filtered":false,"severity":"safe"}},"delta":{"content":"."},"finish_reason":null,"index":0,"logprobs":null}],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"ywLH2r1kcaeOOkq","object":"chat.completion.chunk","system_fingerprint":null,"usage":null}
+{"choices":[{"content_filter_results":{},"delta":{},"finish_reason":"stop","index":0,"logprobs":null}],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"Zarov0xJhP","object":"chat.completion.chunk","system_fingerprint":null,"usage":null}
+{"choices":[],"created":1762317021,"id":"chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt","model":"gpt-5-nano-2025-08-07","obfuscation":"DjqQ9RbEQMJ3PX","object":"chat.completion.chunk","system_fingerprint":null,"usage":{"completion_tokens":78,"completion_tokens_details":{"accepted_prediction_tokens":0,"audio_tokens":0,"reasoning_tokens":64,"rejected_prediction_tokens":0},"prompt_tokens":15,"prompt_tokens_details":{"audio_tokens":0,"cached_tokens":0},"total_tokens":93}}

package/src/chat/__snapshots__/openai-chat-language-model.test.ts.snap

@@ -0,0 +1,88 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`doStream > should set .modelId for model-router request 1`] = `
+[
+  {
+    "type": "stream-start",
+    "warnings": [],
+  },
+  {
+    "id": "chatcmpl-CYPS1lijGoK8gd9lYzY3r9Sx50nbt",
+    "modelId": "gpt-5-nano-2025-08-07",
+    "timestamp": 2025-11-05T04:30:21.000Z,
+    "type": "response-metadata",
+  },
+  {
+    "id": "0",
+    "type": "text-start",
+  },
+  {
+    "delta": "",
+    "id": "0",
+    "type": "text-delta",
+  },
+  {
+    "delta": "Capital",
+    "id": "0",
+    "type": "text-delta",
+  },
+  {
+    "delta": " of",
+    "id": "0",
+    "type": "text-delta",
+  },
+  {
+    "delta": " Denmark",
+    "id": "0",
+    "type": "text-delta",
+  },
+  {
+    "delta": ".",
+    "id": "0",
+    "type": "text-delta",
+  },
+  {
+    "id": "0",
+    "type": "text-end",
+  },
+  {
+    "finishReason": {
+      "raw": "stop",
+      "unified": "stop",
+    },
+    "providerMetadata": {
+      "openai": {
+        "acceptedPredictionTokens": 0,
+        "rejectedPredictionTokens": 0,
+      },
+    },
+    "type": "finish",
+    "usage": {
+      "inputTokens": {
+        "cacheRead": 0,
+        "cacheWrite": undefined,
+        "noCache": 15,
+        "total": 15,
+      },
+      "outputTokens": {
+        "reasoning": 64,
+        "text": 14,
+        "total": 78,
+      },
+      "raw": {
+        "completion_tokens": 78,
+        "completion_tokens_details": {
+          "accepted_prediction_tokens": 0,
+          "reasoning_tokens": 64,
+          "rejected_prediction_tokens": 0,
+        },
+        "prompt_tokens": 15,
+        "prompt_tokens_details": {
+          "cached_tokens": 0,
+        },
+        "total_tokens": 93,
+      },
+    },
+  },
+]
+`;

package/src/chat/convert-openai-chat-usage.ts

@@ -0,0 +1,57 @@
+import { LanguageModelV3Usage } from '@ai-sdk/provider';
+
+export type OpenAIChatUsage = {
+  prompt_tokens?: number | null;
+  completion_tokens?: number | null;
+  total_tokens?: number | null;
+  prompt_tokens_details?: {
+    cached_tokens?: number | null;
+  } | null;
+  completion_tokens_details?: {
+    reasoning_tokens?: number | null;
+    accepted_prediction_tokens?: number | null;
+    rejected_prediction_tokens?: number | null;
+  } | null;
+};
+
+export function convertOpenAIChatUsage(
+  usage: OpenAIChatUsage | undefined | null,
+): LanguageModelV3Usage {
+  if (usage == null) {
+    return {
+      inputTokens: {
+        total: undefined,
+        noCache: undefined,
+        cacheRead: undefined,
+        cacheWrite: undefined,
+      },
+      outputTokens: {
+        total: undefined,
+        text: undefined,
+        reasoning: undefined,
+      },
+      raw: undefined,
+    };
+  }
+
+  const promptTokens = usage.prompt_tokens ?? 0;
+  const completionTokens = usage.completion_tokens ?? 0;
+  const cachedTokens = usage.prompt_tokens_details?.cached_tokens ?? 0;
+  const reasoningTokens =
+    usage.completion_tokens_details?.reasoning_tokens ?? 0;
+
+  return {
+    inputTokens: {
+      total: promptTokens,
+      noCache: promptTokens - cachedTokens,
+      cacheRead: cachedTokens,
+      cacheWrite: undefined,
+    },
+    outputTokens: {
+      total: completionTokens,
+      text: completionTokens - reasoningTokens,
+      reasoning: reasoningTokens,
+    },
+    raw: usage,
+  };
+}

package/src/chat/convert-to-openai-chat-messages.test.ts

@@ -0,0 +1,516 @@
+import { convertToOpenAIChatMessages } from './convert-to-openai-chat-messages';
+import { describe, it, expect } from 'vitest';
+
+describe('system messages', () => {
+  it('should forward system messages', async () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [{ role: 'system', content: 'You are a helpful assistant.' }],
+    });
+
+    expect(result.messages).toEqual([
+      { role: 'system', content: 'You are a helpful assistant.' },
+    ]);
+  });
+
+  it('should convert system messages to developer messages when requested', async () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [{ role: 'system', content: 'You are a helpful assistant.' }],
+      systemMessageMode: 'developer',
+    });
+
+    expect(result.messages).toEqual([
+      { role: 'developer', content: 'You are a helpful assistant.' },
+    ]);
+  });
+
+  it('should remove system messages when requested', async () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [{ role: 'system', content: 'You are a helpful assistant.' }],
+      systemMessageMode: 'remove',
+    });
+
+    expect(result.messages).toEqual([]);
+  });
+});
+
+describe('user messages', () => {
+  it('should convert messages with only a text part to a string content', async () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [
+        {
+          role: 'user',
+          content: [{ type: 'text', text: 'Hello' }],
+        },
+      ],
+    });
+
+    expect(result.messages).toEqual([{ role: 'user', content: 'Hello' }]);
+  });
+
+  it('should convert messages with image parts', async () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [
+        {
+          role: 'user',
+          content: [
+            { type: 'text', text: 'Hello' },
+            {
+              type: 'file',
+              mediaType: 'image/png',
+              data: Buffer.from([0, 1, 2, 3]).toString('base64'),
+            },
+          ],
+        },
+      ],
+    });
+
+    expect(result.messages).toEqual([
+      {
+        role: 'user',
+        content: [
+          { type: 'text', text: 'Hello' },
+          {
+            type: 'image_url',
+            image_url: { url: 'data:image/png;base64,AAECAw==' },
+          },
+        ],
+      },
+    ]);
+  });
+
+  it('should add image detail when specified through extension', async () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'file',
+              mediaType: 'image/png',
+              data: Buffer.from([0, 1, 2, 3]).toString('base64'),
+              providerOptions: {
+                openai: {
+                  imageDetail: 'low',
+                },
+              },
+            },
+          ],
+        },
+      ],
+    });
+
+    expect(result.messages).toEqual([
+      {
+        role: 'user',
+        content: [
+          {
+            type: 'image_url',
+            image_url: {
+              url: 'data:image/png;base64,AAECAw==',
+              detail: 'low',
+            },
+          },
+        ],
+      },
+    ]);
+  });
+
+  describe('file parts', () => {
+    it('should throw for unsupported mime types', () => {
+      expect(() =>
+        convertToOpenAIChatMessages({
+          prompt: [
+            {
+              role: 'user',
+              content: [
+                {
+                  type: 'file',
+                  data: 'AAECAw==',
+                  mediaType: 'application/something',
+                },
+              ],
+            },
+          ],
+        }),
+      ).toThrow('file part media type application/something');
+    });
+
+    it('should throw for URL data', () => {
+      expect(() =>
+        convertToOpenAIChatMessages({
+          prompt: [
+            {
+              role: 'user',
+              content: [
+                {
+                  type: 'file',
+                  data: new URL('https://example.com/foo.wav'),
+                  mediaType: 'audio/wav',
+                },
+              ],
+            },
+          ],
+        }),
+      ).toThrow('audio file parts with URLs');
+    });
+
+    it('should add audio content for audio/wav file parts', () => {
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                data: 'AAECAw==',
+                mediaType: 'audio/wav',
+              },
+            ],
+          },
+        ],
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'input_audio',
+              input_audio: { data: 'AAECAw==', format: 'wav' },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should add audio content for audio/mpeg file parts', () => {
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                data: 'AAECAw==',
+                mediaType: 'audio/mpeg',
+              },
+            ],
+          },
+        ],
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'input_audio',
+              input_audio: { data: 'AAECAw==', format: 'mp3' },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should add audio content for audio/mp3 file parts', () => {
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                data: 'AAECAw==',
+                mediaType: 'audio/mp3', // not official but sometimes used
+              },
+            ],
+          },
+        ],
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'input_audio',
+              input_audio: { data: 'AAECAw==', format: 'mp3' },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should convert messages with PDF file parts', async () => {
+      const base64Data = 'AQIDBAU='; // Base64 encoding of pdfData
+
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                mediaType: 'application/pdf',
+                data: base64Data,
+                filename: 'document.pdf',
+              },
+            ],
+          },
+        ],
+        systemMessageMode: 'system',
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'file',
+              file: {
+                filename: 'document.pdf',
+                file_data: 'data:application/pdf;base64,AQIDBAU=',
+              },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should convert messages with binary PDF file parts', async () => {
+      const data = Uint8Array.from([1, 2, 3, 4, 5]);
+
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                mediaType: 'application/pdf',
+                data,
+                filename: 'document.pdf',
+              },
+            ],
+          },
+        ],
+        systemMessageMode: 'system',
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'file',
+              file: {
+                filename: 'document.pdf',
+                file_data: 'data:application/pdf;base64,AQIDBAU=',
+              },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should convert messages with PDF file parts using file_id', async () => {
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                mediaType: 'application/pdf',
+                data: 'file-pdf-12345',
+              },
+            ],
+          },
+        ],
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'file',
+              file: {
+                file_id: 'file-pdf-12345',
+              },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should use default filename for PDF file parts when not provided', async () => {
+      const base64Data = 'AQIDBAU=';
+
+      const result = convertToOpenAIChatMessages({
+        prompt: [
+          {
+            role: 'user',
+            content: [
+              {
+                type: 'file',
+                mediaType: 'application/pdf',
+                data: base64Data,
+              },
+            ],
+          },
+        ],
+        systemMessageMode: 'system',
+      });
+
+      expect(result.messages).toEqual([
+        {
+          role: 'user',
+          content: [
+            {
+              type: 'file',
+              file: {
+                filename: 'part-0.pdf',
+                file_data: 'data:application/pdf;base64,AQIDBAU=',
+              },
+            },
+          ],
+        },
+      ]);
+    });
+
+    it('should throw error for unsupported file types', async () => {
+      const base64Data = 'AQIDBAU=';
+
+      expect(() => {
+        convertToOpenAIChatMessages({
+          prompt: [
+            {
+              role: 'user',
+              content: [
+                {
+                  type: 'file',
+                  mediaType: 'text/plain',
+                  data: base64Data,
+                },
+              ],
+            },
+          ],
+          systemMessageMode: 'system',
+        });
+      }).toThrow('file part media type text/plain');
+    });
+
+    it('should throw error for file URLs', async () => {
+      expect(() => {
+        convertToOpenAIChatMessages({
+          prompt: [
+            {
+              role: 'user',
+              content: [
+                {
+                  type: 'file',
+                  mediaType: 'application/pdf',
+                  data: new URL('https://example.com/document.pdf'),
+                },
+              ],
+            },
+          ],
+          systemMessageMode: 'system',
+        });
+      }).toThrow('PDF file parts with URLs');
+    });
+  });
+});
+
+describe('tool calls', () => {
+  it('should stringify arguments to tool calls', () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [
+        {
+          role: 'assistant',
+          content: [
+            {
+              type: 'tool-call',
+              input: { foo: 'bar123' },
+              toolCallId: 'quux',
+              toolName: 'thwomp',
+            },
+          ],
+        },
+        {
+          role: 'tool',
+          content: [
+            {
+              type: 'tool-result',
+              toolCallId: 'quux',
+              toolName: 'thwomp',
+              output: { type: 'json', value: { oof: '321rab' } },
+            },
+          ],
+        },
+      ],
+    });
+
+    expect(result.messages).toEqual([
+      {
+        role: 'assistant',
+        content: '',
+        tool_calls: [
+          {
+            type: 'function',
+            id: 'quux',
+            function: {
+              name: 'thwomp',
+              arguments: JSON.stringify({ foo: 'bar123' }),
+            },
+          },
+        ],
+      },
+      {
+        role: 'tool',
+        content: JSON.stringify({ oof: '321rab' }),
+        tool_call_id: 'quux',
+      },
+    ]);
+  });
+
+  it('should handle different tool output types', () => {
+    const result = convertToOpenAIChatMessages({
+      prompt: [
+        {
+          role: 'tool',
+          content: [
+            {
+              type: 'tool-result',
+              toolCallId: 'text-tool',
+              toolName: 'text-tool',
+              output: { type: 'text', value: 'Hello world' },
+            },
+            {
+              type: 'tool-result',
+              toolCallId: 'error-tool',
+              toolName: 'error-tool',
+              output: { type: 'error-text', value: 'Something went wrong' },
+            },
+          ],
+        },
+      ],
+    });
+
+    expect(result.messages).toMatchInlineSnapshot(`
+      [
+        {
+          "content": "Hello world",
+          "role": "tool",
+          "tool_call_id": "text-tool",
+        },
+        {
+          "content": "Something went wrong",
+          "role": "tool",
+          "tool_call_id": "error-tool",
+        },
+      ]
+    `);
+  });
+});