@ai-sdk/openai 2.0.0-canary.15 → 2.0.0-canary.16

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @ai-sdk/openai
 
+## 2.0.0-canary.16
+
+### Patch Changes
+
+- 928fadf: fix(providers/openai): logprobs for stream alongside completion model
+- 6f231db: fix(providers): always use optional instead of mix of nullish for providerOptions
+- Updated dependencies [a571d6e]
+- Updated dependencies [a8c8bd5]
+- Updated dependencies [7979f7f]
+- Updated dependencies [41fa418]
+  - @ai-sdk/provider-utils@3.0.0-canary.15
+  - @ai-sdk/provider@2.0.0-canary.14
+
 ## 2.0.0-canary.15
 
 ### Patch Changes

package/README.md

@@ -1,6 +1,6 @@
 # AI SDK - OpenAI Provider
 
-The **[OpenAI provider](https://sdk.vercel.ai/providers/ai-sdk-providers/openai)** for the [AI SDK](https://sdk.vercel.ai/docs)
+The **[OpenAI provider](https://ai-sdk.dev/providers/ai-sdk-providers/openai)** for the [AI SDK](https://ai-sdk.dev/docs)
 contains language model support for the OpenAI chat and completion APIs and embedding model support for the OpenAI embeddings API.
 
 ## Setup
@@ -33,4 +33,4 @@ const { text } = await generateText({
 
 ## Documentation
 
-Please check out the **[OpenAI provider documentation](https://sdk.vercel.ai/providers/ai-sdk-providers/openai)** for more information.
+Please check out the **[OpenAI provider documentation](https://ai-sdk.dev/providers/ai-sdk-providers/openai)** for more information.

package/dist/index.js

@@ -545,7 +545,7 @@ var OpenAIChatLanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m;
     const { args: body, warnings } = await this.getArgs(options);
     const {
       responseHeaders,
@@ -583,18 +583,12 @@ var OpenAIChatLanguageModel = class {
     const completionTokenDetails = (_c = response.usage) == null ? void 0 : _c.completion_tokens_details;
     const promptTokenDetails = (_d = response.usage) == null ? void 0 : _d.prompt_tokens_details;
     const providerMetadata = { openai: {} };
-    if ((completionTokenDetails == null ? void 0 : completionTokenDetails.reasoning_tokens) != null) {
-      providerMetadata.openai.reasoningTokens = completionTokenDetails == null ? void 0 : completionTokenDetails.reasoning_tokens;
-    }
     if ((completionTokenDetails == null ? void 0 : completionTokenDetails.accepted_prediction_tokens) != null) {
       providerMetadata.openai.acceptedPredictionTokens = completionTokenDetails == null ? void 0 : completionTokenDetails.accepted_prediction_tokens;
     }
     if ((completionTokenDetails == null ? void 0 : completionTokenDetails.rejected_prediction_tokens) != null) {
       providerMetadata.openai.rejectedPredictionTokens = completionTokenDetails == null ? void 0 : completionTokenDetails.rejected_prediction_tokens;
     }
-    if ((promptTokenDetails == null ? void 0 : promptTokenDetails.cached_tokens) != null) {
-      providerMetadata.openai.cachedPromptTokens = promptTokenDetails == null ? void 0 : promptTokenDetails.cached_tokens;
-    }
     if (((_e = choice.logprobs) == null ? void 0 : _e.content) != null) {
       providerMetadata.openai.logprobs = choice.logprobs.content;
     }
@@ -603,7 +597,10 @@ var OpenAIChatLanguageModel = class {
       finishReason: mapOpenAIFinishReason(choice.finish_reason),
       usage: {
         inputTokens: (_g = (_f = response.usage) == null ? void 0 : _f.prompt_tokens) != null ? _g : void 0,
-        outputTokens: (_i = (_h = response.usage) == null ? void 0 : _h.completion_tokens) != null ? _i : void 0
+        outputTokens: (_i = (_h = response.usage) == null ? void 0 : _h.completion_tokens) != null ? _i : void 0,
+        totalTokens: (_k = (_j = response.usage) == null ? void 0 : _j.total_tokens) != null ? _k : void 0,
+        reasoningTokens: (_l = completionTokenDetails == null ? void 0 : completionTokenDetails.reasoning_tokens) != null ? _l : void 0,
+        cachedInputTokens: (_m = promptTokenDetails == null ? void 0 : promptTokenDetails.cached_tokens) != null ? _m : void 0
       },
       request: { body },
       response: {
@@ -637,12 +634,12 @@ var OpenAIChatLanguageModel = class {
       abortSignal: options.abortSignal,
       fetch: this.config.fetch
     });
-    const { messages: rawPrompt, ...rawSettings } = args;
     const toolCalls = [];
     let finishReason = "unknown";
     const usage = {
       inputTokens: void 0,
-      outputTokens: void 0
+      outputTokens: void 0,
+      totalTokens: void 0
     };
     let isFirstChunk = true;
     const providerMetadata = { openai: {} };
@@ -653,7 +650,7 @@ var OpenAIChatLanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
@@ -673,31 +670,25 @@ var OpenAIChatLanguageModel = class {
               });
             }
             if (value.usage != null) {
-              const {
-                prompt_tokens,
-                completion_tokens,
-                prompt_tokens_details,
-                completion_tokens_details
-              } = value.usage;
-              usage.inputTokens = prompt_tokens != null ? prompt_tokens : void 0;
-              usage.outputTokens = completion_tokens != null ? completion_tokens : void 0;
-              if ((completion_tokens_details == null ? void 0 : completion_tokens_details.reasoning_tokens) != null) {
-                providerMetadata.openai.reasoningTokens = completion_tokens_details == null ? void 0 : completion_tokens_details.reasoning_tokens;
-              }
-              if ((completion_tokens_details == null ? void 0 : completion_tokens_details.accepted_prediction_tokens) != null) {
-                providerMetadata.openai.acceptedPredictionTokens = completion_tokens_details == null ? void 0 : completion_tokens_details.accepted_prediction_tokens;
-              }
-              if ((completion_tokens_details == null ? void 0 : completion_tokens_details.rejected_prediction_tokens) != null) {
-                providerMetadata.openai.rejectedPredictionTokens = completion_tokens_details == null ? void 0 : completion_tokens_details.rejected_prediction_tokens;
+              usage.inputTokens = (_a = value.usage.prompt_tokens) != null ? _a : void 0;
+              usage.outputTokens = (_b = value.usage.completion_tokens) != null ? _b : void 0;
+              usage.totalTokens = (_c = value.usage.total_tokens) != null ? _c : void 0;
+              usage.reasoningTokens = (_e = (_d = value.usage.completion_tokens_details) == null ? void 0 : _d.reasoning_tokens) != null ? _e : void 0;
+              usage.cachedInputTokens = (_g = (_f = value.usage.prompt_tokens_details) == null ? void 0 : _f.cached_tokens) != null ? _g : void 0;
+              if (((_h = value.usage.completion_tokens_details) == null ? void 0 : _h.accepted_prediction_tokens) != null) {
+                providerMetadata.openai.acceptedPredictionTokens = (_i = value.usage.completion_tokens_details) == null ? void 0 : _i.accepted_prediction_tokens;
               }
-              if ((prompt_tokens_details == null ? void 0 : prompt_tokens_details.cached_tokens) != null) {
-                providerMetadata.openai.cachedPromptTokens = prompt_tokens_details == null ? void 0 : prompt_tokens_details.cached_tokens;
+              if (((_j = value.usage.completion_tokens_details) == null ? void 0 : _j.rejected_prediction_tokens) != null) {
+                providerMetadata.openai.rejectedPredictionTokens = (_k = value.usage.completion_tokens_details) == null ? void 0 : _k.rejected_prediction_tokens;
               }
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
               finishReason = mapOpenAIFinishReason(choice.finish_reason);
             }
+            if (((_l = choice == null ? void 0 : choice.logprobs) == null ? void 0 : _l.content) != null) {
+              providerMetadata.openai.logprobs = choice.logprobs.content;
+            }
             if ((choice == null ? void 0 : choice.delta) == null) {
               return;
             }
@@ -724,7 +715,7 @@ var OpenAIChatLanguageModel = class {
                       message: `Expected 'id' to be a string.`
                     });
                   }
-                  if (((_a = toolCallDelta.function) == null ? void 0 : _a.name) == null) {
+                  if (((_m = toolCallDelta.function) == null ? void 0 : _m.name) == null) {
                     throw new import_provider3.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function.name' to be a string.`
@@ -735,12 +726,12 @@ var OpenAIChatLanguageModel = class {
                     type: "function",
                     function: {
                       name: toolCallDelta.function.name,
-                      arguments: (_b = toolCallDelta.function.arguments) != null ? _b : ""
+                      arguments: (_n = toolCallDelta.function.arguments) != null ? _n : ""
                     },
                     hasFinished: false
                   };
                   const toolCall2 = toolCalls[index];
-                  if (((_c = toolCall2.function) == null ? void 0 : _c.name) != null && ((_d = toolCall2.function) == null ? void 0 : _d.arguments) != null) {
+                  if (((_o = toolCall2.function) == null ? void 0 : _o.name) != null && ((_p = toolCall2.function) == null ? void 0 : _p.arguments) != null) {
                     if (toolCall2.function.arguments.length > 0) {
                       controller.enqueue({
                         type: "tool-call-delta",
@@ -754,7 +745,7 @@ var OpenAIChatLanguageModel = class {
                       controller.enqueue({
                         type: "tool-call",
                         toolCallType: "function",
-                        toolCallId: (_e = toolCall2.id) != null ? _e : (0, import_provider_utils3.generateId)(),
+                        toolCallId: (_q = toolCall2.id) != null ? _q : (0, import_provider_utils3.generateId)(),
                         toolName: toolCall2.function.name,
                         args: toolCall2.function.arguments
                       });
@@ -767,21 +758,21 @@ var OpenAIChatLanguageModel = class {
                 if (toolCall.hasFinished) {
                   continue;
                 }
-                if (((_f = toolCallDelta.function) == null ? void 0 : _f.arguments) != null) {
-                  toolCall.function.arguments += (_h = (_g = toolCallDelta.function) == null ? void 0 : _g.arguments) != null ? _h : "";
+                if (((_r = toolCallDelta.function) == null ? void 0 : _r.arguments) != null) {
+                  toolCall.function.arguments += (_t = (_s = toolCallDelta.function) == null ? void 0 : _s.arguments) != null ? _t : "";
                 }
                 controller.enqueue({
                   type: "tool-call-delta",
                   toolCallType: "function",
                   toolCallId: toolCall.id,
                   toolName: toolCall.function.name,
-                  argsTextDelta: (_i = toolCallDelta.function.arguments) != null ? _i : ""
+                  argsTextDelta: (_u = toolCallDelta.function.arguments) != null ? _u : ""
                 });
-                if (((_j = toolCall.function) == null ? void 0 : _j.name) != null && ((_k = toolCall.function) == null ? void 0 : _k.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
+                if (((_v = toolCall.function) == null ? void 0 : _v.name) != null && ((_w = toolCall.function) == null ? void 0 : _w.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
                   controller.enqueue({
                     type: "tool-call",
                     toolCallType: "function",
-                    toolCallId: (_l = toolCall.id) != null ? _l : (0, import_provider_utils3.generateId)(),
+                    toolCallId: (_x = toolCall.id) != null ? _x : (0, import_provider_utils3.generateId)(),
                     toolName: toolCall.function.name,
                     args: toolCall.function.arguments
                   });
@@ -808,6 +799,7 @@ var OpenAIChatLanguageModel = class {
 var openaiTokenUsageSchema = import_zod3.z.object({
   prompt_tokens: import_zod3.z.number().nullish(),
   completion_tokens: import_zod3.z.number().nullish(),
+  total_tokens: import_zod3.z.number().nullish(),
   prompt_tokens_details: import_zod3.z.object({
     cached_tokens: import_zod3.z.number().nullish()
   }).nullish(),
@@ -879,6 +871,20 @@ var openaiChatChunkSchema = import_zod3.z.union([
             })
           ).nullish()
         }).nullish(),
+        logprobs: import_zod3.z.object({
+          content: import_zod3.z.array(
+            import_zod3.z.object({
+              token: import_zod3.z.string(),
+              logprob: import_zod3.z.number(),
+              top_logprobs: import_zod3.z.array(
+                import_zod3.z.object({
+                  token: import_zod3.z.string(),
+                  logprob: import_zod3.z.number()
+                })
+              )
+            })
+          ).nullish()
+        }).nullish(),
         finish_reason: import_zod3.z.string().nullish(),
         index: import_zod3.z.number()
       })
@@ -1140,6 +1146,7 @@ var OpenAICompletionLanguageModel = class {
     };
   }
   async doGenerate(options) {
+    var _a, _b, _c;
     const { args, warnings } = await this.getArgs(options);
     const {
       responseHeaders,
@@ -1167,8 +1174,9 @@ var OpenAICompletionLanguageModel = class {
     return {
       content: [{ type: "text", text: choice.text }],
       usage: {
-        inputTokens: response.usage.prompt_tokens,
-        outputTokens: response.usage.completion_tokens
+        inputTokens: (_a = response.usage) == null ? void 0 : _a.prompt_tokens,
+        outputTokens: (_b = response.usage) == null ? void 0 : _b.completion_tokens,
+        totalTokens: (_c = response.usage) == null ? void 0 : _c.total_tokens
       },
       finishReason: mapOpenAIFinishReason(choice.finish_reason),
       request: { body: args },
@@ -1207,7 +1215,8 @@ var OpenAICompletionLanguageModel = class {
     const providerMetadata = { openai: {} };
     const usage = {
       inputTokens: void 0,
-      outputTokens: void 0
+      outputTokens: void 0,
+      totalTokens: void 0
     };
     let isFirstChunk = true;
     return {
@@ -1238,6 +1247,7 @@ var OpenAICompletionLanguageModel = class {
             if (value.usage != null) {
               usage.inputTokens = value.usage.prompt_tokens;
               usage.outputTokens = value.usage.completion_tokens;
+              usage.totalTokens = value.usage.total_tokens;
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
@@ -1268,6 +1278,11 @@ var OpenAICompletionLanguageModel = class {
     };
   }
 };
+var usageSchema = import_zod5.z.object({
+  prompt_tokens: import_zod5.z.number(),
+  completion_tokens: import_zod5.z.number(),
+  total_tokens: import_zod5.z.number()
+});
 var openaiCompletionResponseSchema = import_zod5.z.object({
   id: import_zod5.z.string().nullish(),
   created: import_zod5.z.number().nullish(),
@@ -1283,10 +1298,7 @@ var openaiCompletionResponseSchema = import_zod5.z.object({
       }).nullish()
     })
   ),
-  usage: import_zod5.z.object({
-    prompt_tokens: import_zod5.z.number(),
-    completion_tokens: import_zod5.z.number()
-  })
+  usage: usageSchema.nullish()
 });
 var openaiCompletionChunkSchema = import_zod5.z.union([
   import_zod5.z.object({
@@ -1305,10 +1317,7 @@ var openaiCompletionChunkSchema = import_zod5.z.union([
         }).nullish()
       })
     ),
-    usage: import_zod5.z.object({
-      prompt_tokens: import_zod5.z.number(),
-      completion_tokens: import_zod5.z.number()
-    }).nullish()
+    usage: usageSchema.nullish()
   }),
   openaiErrorDataSchema
 ]);
@@ -1529,25 +1538,25 @@ var openAITranscriptionProviderOptions = import_zod10.z.object({
   /**
    * Additional information to include in the transcription response.
    */
-  include: import_zod10.z.array(import_zod10.z.string()).nullish(),
+  include: import_zod10.z.array(import_zod10.z.string()).optional(),
   /**
    * The language of the input audio in ISO-639-1 format.
    */
-  language: import_zod10.z.string().nullish(),
+  language: import_zod10.z.string().optional(),
   /**
    * An optional text to guide the model's style or continue a previous audio segment.
    */
-  prompt: import_zod10.z.string().nullish(),
+  prompt: import_zod10.z.string().optional(),
   /**
    * The sampling temperature, between 0 and 1.
    * @default 0
    */
-  temperature: import_zod10.z.number().min(0).max(1).default(0).nullish(),
+  temperature: import_zod10.z.number().min(0).max(1).default(0).optional(),
   /**
    * The timestamp granularities to populate for this transcription.
    * @default ['segment']
    */
-  timestampGranularities: import_zod10.z.array(import_zod10.z.enum(["word", "segment"])).default(["segment"]).nullish()
+  timestampGranularities: import_zod10.z.array(import_zod10.z.enum(["word", "segment"])).default(["segment"]).optional()
 });
 
 // src/openai-transcription-model.ts
@@ -2118,7 +2127,7 @@ var OpenAIResponsesLanguageModel = class {
             ])
           ),
           incomplete_details: import_zod12.z.object({ reason: import_zod12.z.string() }).nullable(),
-          usage: usageSchema
+          usage: usageSchema2
         })
       ),
       abortSignal: options.abortSignal,
@@ -2172,7 +2181,10 @@ var OpenAIResponsesLanguageModel = class {
       }),
       usage: {
         inputTokens: response.usage.input_tokens,
-        outputTokens: response.usage.output_tokens
+        outputTokens: response.usage.output_tokens,
+        totalTokens: response.usage.input_tokens + response.usage.output_tokens,
+        reasoningTokens: (_f = (_e = response.usage.output_tokens_details) == null ? void 0 : _e.reasoning_tokens) != null ? _f : void 0,
+        cachedInputTokens: (_h = (_g = response.usage.input_tokens_details) == null ? void 0 : _g.cached_tokens) != null ? _h : void 0
       },
       request: { body },
       response: {
@@ -2184,9 +2196,7 @@ var OpenAIResponsesLanguageModel = class {
       },
       providerMetadata: {
         openai: {
-          responseId: response.id,
-          cachedPromptTokens: (_f = (_e = response.usage.input_tokens_details) == null ? void 0 : _e.cached_tokens) != null ? _f : null,
-          reasoningTokens: (_h = (_g = response.usage.output_tokens_details) == null ? void 0 : _g.reasoning_tokens) != null ? _h : null
+          responseId: response.id
         }
       },
       warnings
@@ -2215,10 +2225,9 @@ var OpenAIResponsesLanguageModel = class {
     let finishReason = "unknown";
     const usage = {
       inputTokens: void 0,
-      outputTokens: void 0
+      outputTokens: void 0,
+      totalTokens: void 0
     };
-    let cachedPromptTokens = null;
-    let reasoningTokens = null;
     let responseId = null;
     const ongoingToolCalls = {};
     let hasToolCalls = false;
@@ -2296,8 +2305,9 @@ var OpenAIResponsesLanguageModel = class {
               });
               usage.inputTokens = value.response.usage.input_tokens;
               usage.outputTokens = value.response.usage.output_tokens;
-              cachedPromptTokens = (_c = (_b = value.response.usage.input_tokens_details) == null ? void 0 : _b.cached_tokens) != null ? _c : cachedPromptTokens;
-              reasoningTokens = (_e = (_d = value.response.usage.output_tokens_details) == null ? void 0 : _d.reasoning_tokens) != null ? _e : reasoningTokens;
+              usage.totalTokens = value.response.usage.input_tokens + value.response.usage.output_tokens;
+              usage.reasoningTokens = (_c = (_b = value.response.usage.output_tokens_details) == null ? void 0 : _b.reasoning_tokens) != null ? _c : void 0;
+              usage.cachedInputTokens = (_e = (_d = value.response.usage.input_tokens_details) == null ? void 0 : _d.cached_tokens) != null ? _e : void 0;
             } else if (isResponseAnnotationAddedChunk(value)) {
               controller.enqueue({
                 type: "source",
@@ -2313,13 +2323,9 @@ var OpenAIResponsesLanguageModel = class {
               type: "finish",
               finishReason,
               usage,
-              ...(cachedPromptTokens != null || reasoningTokens != null) && {
-                providerMetadata: {
-                  openai: {
-                    responseId,
-                    cachedPromptTokens,
-                    reasoningTokens
-                  }
+              providerMetadata: {
+                openai: {
+                  responseId
                 }
               }
             });
@@ -2331,7 +2337,7 @@ var OpenAIResponsesLanguageModel = class {
     };
   }
 };
-var usageSchema = import_zod12.z.object({
+var usageSchema2 = import_zod12.z.object({
   input_tokens: import_zod12.z.number(),
   input_tokens_details: import_zod12.z.object({ cached_tokens: import_zod12.z.number().nullish() }).nullish(),
   output_tokens: import_zod12.z.number(),
@@ -2345,7 +2351,7 @@ var responseFinishedChunkSchema = import_zod12.z.object({
   type: import_zod12.z.enum(["response.completed", "response.incomplete"]),
   response: import_zod12.z.object({
     incomplete_details: import_zod12.z.object({ reason: import_zod12.z.string() }).nullish(),
-    usage: usageSchema
+    usage: usageSchema2
   })
 });
 var responseCreatedChunkSchema = import_zod12.z.object({