@ai-sdk/openai 3.0.17 → 3.0.19

package/docs/03-openai.mdx

@@ -255,24 +255,34 @@ The following provider options are available:
 
 The OpenAI responses provider also returns provider-specific metadata:
 
+For Responses models, you can type this metadata using `OpenaiResponsesProviderMetadata`:
+
 ```ts
-const { providerMetadata } = await generateText({
-  model: openai.responses('gpt-5'),
+import { openai, type OpenaiResponsesProviderMetadata } from '@ai-sdk/openai';
+import { generateText } from 'ai';
+
+const result = await generateText({
+  model: openai('gpt-5'),
 });
 
-const openaiMetadata = providerMetadata?.openai;
-```
+const providerMetadata = result.providerMetadata as
+  | OpenaiResponsesProviderMetadata
+  | undefined;
 
-The following OpenAI-specific metadata is returned:
+const { responseId, logprobs, serviceTier } = providerMetadata?.openai ?? {};
 
-- **responseId** _string_
-  The ID of the response. Can be used to continue a conversation.
+// responseId can be used to continue a conversation (previousResponseId).
+console.log(responseId);
+```
 
-- **cachedPromptTokens** _number_
-  The number of prompt tokens that were a cache hit.
+The following OpenAI-specific metadata may be returned:
 
-- **reasoningTokens** _number_
-  The number of reasoning tokens that the model generated.
+- **responseId** _string | null | undefined_
+  The ID of the response. Can be used to continue a conversation.
+- **logprobs** _(optional)_
+  Log probabilities of output tokens (when enabled).
+- **serviceTier** _(optional)_
+  Service tier information returned by the API.
 
 #### Reasoning Output
 
@@ -929,6 +939,52 @@ for (const part of result.content) {
   API.
 </Note>
 
+#### Typed providerMetadata in Reasoning Parts
+
+When using the OpenAI Responses API, reasoning output parts can include provider metadata.
+To handle this metadata in a type-safe way, use `OpenaiResponsesReasoningProviderMetadata`.
+
+For reasoning parts, when `part.type === 'reasoning'`, the `providerMetadata` is provided in the form of `OpenaiResponsesReasoningProviderMetadata`.
+
+This metadata includes the following fields:
+
+- `itemId`  
+  The ID of the reasoning item in the Responses API.
+- `reasoningEncryptedContent` (optional)  
+  Encrypted reasoning content (only returned when requested via `include: ['reasoning.encrypted_content']`).
+
+```ts
+import {
+  openai,
+  type OpenaiResponsesReasoningProviderMetadata,
+  type OpenAIResponsesProviderOptions,
+} from '@ai-sdk/openai';
+import { generateText } from 'ai';
+
+const result = await generateText({
+  model: openai('gpt-5'),
+  prompt: 'How many "r"s are in the word "strawberry"?',
+  providerOptions: {
+    openai: {
+      store: false,
+      include: ['reasoning.encrypted_content'],
+    } satisfies OpenAIResponsesProviderOptions,
+  },
+});
+
+for (const part of result.content) {
+  if (part.type === 'reasoning') {
+    const providerMetadata = part.providerMetadata as
+      | OpenaiResponsesReasoningProviderMetadata
+      | undefined;
+
+    const { itemId, reasoningEncryptedContent } =
+      providerMetadata?.openai ?? {};
+    console.log(itemId, reasoningEncryptedContent);
+  }
+}
+```
+
 #### Typed providerMetadata in Source Document Parts
 
 For source document parts, when `part.type === 'source'` and `sourceType === 'document'`, the `providerMetadata` is provided as `OpenaiResponsesSourceDocumentProviderMetadata`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ai-sdk/openai",
-  "version": "3.0.17",
+  "version": "3.0.19",
   "license": "Apache-2.0",
   "sideEffects": false,
   "main": "./dist/index.js",
@@ -10,6 +10,10 @@
     "dist/**/*",
     "docs/**/*",
     "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test-d.ts",
+    "!src/**/__snapshots__",
+    "!src/**/__fixtures__",
     "CHANGELOG.md",
     "README.md",
     "internal.d.ts"
@@ -32,15 +36,15 @@
     }
   },
   "dependencies": {
-    "@ai-sdk/provider": "3.0.4",
-    "@ai-sdk/provider-utils": "4.0.8"
+    "@ai-sdk/provider": "3.0.5",
+    "@ai-sdk/provider-utils": "4.0.9"
   },
   "devDependencies": {
     "@types/node": "20.17.24",
     "tsup": "^8",
     "typescript": "5.8.3",
     "zod": "3.25.76",
-    "@ai-sdk/test-server": "1.0.2",
+    "@ai-sdk/test-server": "1.0.3",
     "@vercel/ai-tsconfig": "0.0.0"
   },
   "peerDependencies": {

package/src/index.ts

@@ -3,6 +3,8 @@ 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 {
+  OpenaiResponsesProviderMetadata,
+  OpenaiResponsesReasoningProviderMetadata,
   OpenaiResponsesTextProviderMetadata,
   OpenaiResponsesSourceDocumentProviderMetadata,
 } from './responses/openai-responses-provider-metadata';

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

@@ -63,6 +63,8 @@ import {
 } from './openai-responses-options';
 import { prepareResponsesTools } from './openai-responses-prepare-tools';
 import {
+  ResponsesProviderMetadata,
+  ResponsesReasoningProviderMetadata,
   ResponsesSourceDocumentProviderMetadata,
   ResponsesTextProviderMetadata,
 } from './openai-responses-provider-metadata';
@@ -498,7 +500,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                 [providerOptionsName]: {
                   itemId: part.id,
                   reasoningEncryptedContent: part.encrypted_content ?? null,
-                },
+                } satisfies ResponsesReasoningProviderMetadata,
               },
             });
           }
@@ -864,17 +866,15 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
     }
 
     const providerMetadata: SharedV3ProviderMetadata = {
-      [providerOptionsName]: { responseId: response.id },
+      [providerOptionsName]: {
+        responseId: response.id,
+        ...(logprobs.length > 0 ? { logprobs } : {}),
+        ...(typeof response.service_tier === 'string'
+          ? { serviceTier: response.service_tier }
+          : {}),
+      } satisfies ResponsesProviderMetadata,
     };
 
-    if (logprobs.length > 0) {
-      providerMetadata[providerOptionsName].logprobs = logprobs;
-    }
-
-    if (typeof response.service_tier === 'string') {
-      providerMetadata[providerOptionsName].serviceTier = response.service_tier;
-    }
-
     const usage = response.usage!; // defined when there is no error
 
     return {
@@ -1188,7 +1188,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                       itemId: value.item.id,
                       reasoningEncryptedContent:
                         value.item.encrypted_content ?? null,
-                    },
+                    } satisfies ResponsesReasoningProviderMetadata,
                   },
                 });
               }
@@ -1496,7 +1496,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                         itemId: value.item.id,
                         reasoningEncryptedContent:
                           value.item.encrypted_content ?? null,
-                      },
+                      } satisfies ResponsesReasoningProviderMetadata,
                     },
                   });
                 }
@@ -1641,7 +1641,9 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                       type: 'reasoning-end',
                       id: `${value.item_id}:${summaryIndex}`,
                       providerMetadata: {
-                        [providerOptionsName]: { itemId: value.item_id },
+                        [providerOptionsName]: {
+                          itemId: value.item_id,
+                        } satisfies ResponsesReasoningProviderMetadata,
                       },
                     });
                     activeReasoningPart.summaryParts[summaryIndex] =
@@ -1658,7 +1660,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                       reasoningEncryptedContent:
                         activeReasoning[value.item_id]?.encryptedContent ??
                         null,
-                    },
+                    } satisfies ResponsesReasoningProviderMetadata,
                   },
                 });
               }
@@ -1670,7 +1672,7 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                 providerMetadata: {
                   [providerOptionsName]: {
                     itemId: value.item_id,
-                  },
+                  } satisfies ResponsesReasoningProviderMetadata,
                 },
               });
             } else if (value.type === 'response.reasoning_summary_part.done') {
@@ -1681,7 +1683,9 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
                   type: 'reasoning-end',
                   id: `${value.item_id}:${value.summary_index}`,
                   providerMetadata: {
-                    [providerOptionsName]: { itemId: value.item_id },
+                    [providerOptionsName]: {
+                      itemId: value.item_id,
+                    } satisfies ResponsesReasoningProviderMetadata,
                   },
                 });
 
@@ -1784,18 +1788,12 @@ export class OpenAIResponsesLanguageModel implements LanguageModelV3 {
           flush(controller) {
             const providerMetadata: SharedV3ProviderMetadata = {
               [providerOptionsName]: {
-                responseId,
-              },
+                responseId: responseId,
+                ...(logprobs.length > 0 ? { logprobs } : {}),
+                ...(serviceTier !== undefined ? { serviceTier } : {}),
+              } satisfies ResponsesProviderMetadata,
             };
 
-            if (logprobs.length > 0) {
-              providerMetadata[providerOptionsName].logprobs = logprobs;
-            }
-
-            if (serviceTier !== undefined) {
-              providerMetadata[providerOptionsName].serviceTier = serviceTier;
-            }
-
             controller.enqueue({
               type: 'finish',
               finishReason,

package/src/responses/openai-responses-provider-metadata.ts

@@ -1,4 +1,7 @@
-import { openaiResponsesChunkSchema } from './openai-responses-api';
+import {
+  openaiResponsesChunkSchema,
+  OpenAIResponsesLogprobs,
+} from './openai-responses-api';
 import { InferSchema } from '@ai-sdk/provider-utils';
 
 type OpenaiResponsesChunk = InferSchema<typeof openaiResponsesChunkSchema>;
@@ -8,6 +11,25 @@ type ResponsesOutputTextAnnotationProviderMetadata = Extract<
   { type: 'response.output_text.annotation.added' }
 >['annotation'];
 
+export type ResponsesProviderMetadata = {
+  responseId: string | null | undefined;
+  logprobs?: Array<OpenAIResponsesLogprobs>;
+  serviceTier?: string;
+};
+
+export type ResponsesReasoningProviderMetadata = {
+  itemId: string;
+  reasoningEncryptedContent?: string | null;
+};
+
+export type OpenaiResponsesReasoningProviderMetadata = {
+  openai: ResponsesReasoningProviderMetadata;
+};
+
+export type OpenaiResponsesProviderMetadata = {
+  openai: ResponsesProviderMetadata;
+};
+
 export type ResponsesTextProviderMetadata = {
   itemId: string;
   annotations?: Array<ResponsesOutputTextAnnotationProviderMetadata>;

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

@@ -1,8 +0,0 @@
-{"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

@@ -1,88 +0,0 @@
-// 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,
-      },
-    },
-  },
-]
-`;