@ai-sdk/openai 0.0.64 → 0.0.66

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @ai-sdk/openai
 
+## 0.0.66
+
+### Patch Changes
+
+- 3f29c10: feat (provider/openai): support metadata field for distillation
+
+## 0.0.65
+
+### Patch Changes
+
+- e8aed44: Add OpenAI cached prompt tokens to experimental_providerMetadata for generateText and streamText
+
 ## 0.0.64
 
 ### Patch Changes

package/dist/index.js

@@ -250,7 +250,7 @@ var OpenAIChatLanguageModel = class {
     seed,
     providerMetadata
   }) {
-    var _a, _b, _c, _d, _e;
+    var _a, _b, _c, _d, _e, _f, _g;
     const type = mode.type;
     const warnings = [];
     if (topK != null) {
@@ -297,6 +297,7 @@ var OpenAIChatLanguageModel = class {
       // openai specific settings:
       max_completion_tokens: (_b = (_a = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _a.maxCompletionTokens) != null ? _b : void 0,
       store: (_d = (_c = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _c.store) != null ? _d : void 0,
+      metadata: (_f = (_e = providerMetadata == null ? void 0 : providerMetadata.openai) == null ? void 0 : _e.metadata) != null ? _f : void 0,
       // response format:
       response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? { type: "json_object" } : void 0,
       // messages:
@@ -334,7 +335,7 @@ var OpenAIChatLanguageModel = class {
               json_schema: {
                 schema: mode.schema,
                 strict: true,
-                name: (_e = mode.name) != null ? _e : "response",
+                name: (_g = mode.name) != null ? _g : "response",
                 description: mode.description
               }
             } : { type: "json_object" }
@@ -384,7 +385,7 @@ var OpenAIChatLanguageModel = class {
     }
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r;
     const { args, warnings } = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
@@ -402,13 +403,18 @@ var OpenAIChatLanguageModel = class {
     });
     const { messages: rawPrompt, ...rawSettings } = args;
     const choice = response.choices[0];
-    const providerMetadata = ((_b = (_a = response.usage) == null ? void 0 : _a.completion_tokens_details) == null ? void 0 : _b.reasoning_tokens) != null ? {
-      openai: {
-        reasoningTokens: (_d = (_c = response.usage) == null ? void 0 : _c.completion_tokens_details) == null ? void 0 : _d.reasoning_tokens
+    let providerMetadata;
+    if (((_b = (_a = response.usage) == null ? void 0 : _a.completion_tokens_details) == null ? void 0 : _b.reasoning_tokens) != null || ((_d = (_c = response.usage) == null ? void 0 : _c.prompt_tokens_details) == null ? void 0 : _d.cached_tokens) != null) {
+      providerMetadata = { openai: {} };
+      if (((_f = (_e = response.usage) == null ? void 0 : _e.completion_tokens_details) == null ? void 0 : _f.reasoning_tokens) != null) {
+        providerMetadata.openai.reasoningTokens = (_h = (_g = response.usage) == null ? void 0 : _g.completion_tokens_details) == null ? void 0 : _h.reasoning_tokens;
       }
-    } : void 0;
+      if (((_j = (_i = response.usage) == null ? void 0 : _i.prompt_tokens_details) == null ? void 0 : _j.cached_tokens) != null) {
+        providerMetadata.openai.cachedPromptTokens = (_l = (_k = response.usage) == null ? void 0 : _k.prompt_tokens_details) == null ? void 0 : _l.cached_tokens;
+      }
+    }
     return {
-      text: (_e = choice.message.content) != null ? _e : void 0,
+      text: (_m = choice.message.content) != null ? _m : void 0,
       toolCalls: this.settings.useLegacyFunctionCalling && choice.message.function_call ? [
         {
           toolCallType: "function",
@@ -416,7 +422,7 @@ var OpenAIChatLanguageModel = class {
           toolName: choice.message.function_call.name,
           args: choice.message.function_call.arguments
         }
-      ] : (_f = choice.message.tool_calls) == null ? void 0 : _f.map((toolCall) => {
+      ] : (_n = choice.message.tool_calls) == null ? void 0 : _n.map((toolCall) => {
         var _a2;
         return {
           toolCallType: "function",
@@ -427,8 +433,8 @@ var OpenAIChatLanguageModel = class {
       }),
       finishReason: mapOpenAIFinishReason(choice.finish_reason),
       usage: {
-        promptTokens: (_h = (_g = response.usage) == null ? void 0 : _g.prompt_tokens) != null ? _h : NaN,
-        completionTokens: (_j = (_i = response.usage) == null ? void 0 : _i.completion_tokens) != null ? _j : NaN
+        promptTokens: (_p = (_o = response.usage) == null ? void 0 : _o.prompt_tokens) != null ? _p : NaN,
+        completionTokens: (_r = (_q = response.usage) == null ? void 0 : _q.completion_tokens) != null ? _r : NaN
       },
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
@@ -505,11 +511,12 @@ var OpenAIChatLanguageModel = class {
     let logprobs;
     let isFirstChunk = true;
     const { useLegacyFunctionCalling } = this.settings;
+    let providerMetadata;
     return {
       stream: response.pipeThrough(
         new TransformStream({
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p;
             if (!chunk.success) {
               finishReason = "error";
               controller.enqueue({ type: "error", error: chunk.error });
@@ -533,6 +540,13 @@ var OpenAIChatLanguageModel = class {
                 promptTokens: (_a = value.usage.prompt_tokens) != null ? _a : void 0,
                 completionTokens: (_b = value.usage.completion_tokens) != null ? _b : void 0
               };
+              if (((_c = value.usage.prompt_tokens_details) == null ? void 0 : _c.cached_tokens) != null) {
+                providerMetadata = {
+                  openai: {
+                    cachedPromptTokens: (_d = value.usage.prompt_tokens_details) == null ? void 0 : _d.cached_tokens
+                  }
+                };
+              }
             }
             const choice = value.choices[0];
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
@@ -579,7 +593,7 @@ var OpenAIChatLanguageModel = class {
                       message: `Expected 'id' to be a string.`
                     });
                   }
-                  if (((_c = toolCallDelta.function) == null ? void 0 : _c.name) == null) {
+                  if (((_e = toolCallDelta.function) == null ? void 0 : _e.name) == null) {
                     throw new import_provider2.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function.name' to be a string.`
@@ -590,11 +604,11 @@ var OpenAIChatLanguageModel = class {
                     type: "function",
                     function: {
                       name: toolCallDelta.function.name,
-                      arguments: (_d = toolCallDelta.function.arguments) != null ? _d : ""
+                      arguments: (_f = toolCallDelta.function.arguments) != null ? _f : ""
                     }
                   };
                   const toolCall2 = toolCalls[index];
-                  if (((_e = toolCall2.function) == null ? void 0 : _e.name) != null && ((_f = toolCall2.function) == null ? void 0 : _f.arguments) != null) {
+                  if (((_g = toolCall2.function) == null ? void 0 : _g.name) != null && ((_h = toolCall2.function) == null ? void 0 : _h.arguments) != null) {
                     if (toolCall2.function.arguments.length > 0) {
                       controller.enqueue({
                         type: "tool-call-delta",
@@ -608,7 +622,7 @@ var OpenAIChatLanguageModel = class {
                       controller.enqueue({
                         type: "tool-call",
                         toolCallType: "function",
-                        toolCallId: (_g = toolCall2.id) != null ? _g : (0, import_provider_utils3.generateId)(),
+                        toolCallId: (_i = toolCall2.id) != null ? _i : (0, import_provider_utils3.generateId)(),
                         toolName: toolCall2.function.name,
                         args: toolCall2.function.arguments
                       });
@@ -617,21 +631,21 @@ var OpenAIChatLanguageModel = class {
                   continue;
                 }
                 const toolCall = toolCalls[index];
-                if (((_h = toolCallDelta.function) == null ? void 0 : _h.arguments) != null) {
-                  toolCall.function.arguments += (_j = (_i = toolCallDelta.function) == null ? void 0 : _i.arguments) != null ? _j : "";
+                if (((_j = toolCallDelta.function) == null ? void 0 : _j.arguments) != null) {
+                  toolCall.function.arguments += (_l = (_k = toolCallDelta.function) == null ? void 0 : _k.arguments) != null ? _l : "";
                 }
                 controller.enqueue({
                   type: "tool-call-delta",
                   toolCallType: "function",
                   toolCallId: toolCall.id,
                   toolName: toolCall.function.name,
-                  argsTextDelta: (_k = toolCallDelta.function.arguments) != null ? _k : ""
+                  argsTextDelta: (_m = toolCallDelta.function.arguments) != null ? _m : ""
                 });
-                if (((_l = toolCall.function) == null ? void 0 : _l.name) != null && ((_m = toolCall.function) == null ? void 0 : _m.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
+                if (((_n = toolCall.function) == null ? void 0 : _n.name) != null && ((_o = toolCall.function) == null ? void 0 : _o.arguments) != null && (0, import_provider_utils3.isParsableJson)(toolCall.function.arguments)) {
                   controller.enqueue({
                     type: "tool-call",
                     toolCallType: "function",
-                    toolCallId: (_n = toolCall.id) != null ? _n : (0, import_provider_utils3.generateId)(),
+                    toolCallId: (_p = toolCall.id) != null ? _p : (0, import_provider_utils3.generateId)(),
                     toolName: toolCall.function.name,
                     args: toolCall.function.arguments
                   });
@@ -648,7 +662,8 @@ var OpenAIChatLanguageModel = class {
               usage: {
                 promptTokens: (_a = usage.promptTokens) != null ? _a : NaN,
                 completionTokens: (_b = usage.completionTokens) != null ? _b : NaN
-              }
+              },
+              ...providerMetadata != null ? { providerMetadata } : {}
             });
           }
         })
@@ -662,6 +677,9 @@ var OpenAIChatLanguageModel = class {
 var openAITokenUsageSchema = import_zod2.z.object({
   prompt_tokens: import_zod2.z.number().nullish(),
   completion_tokens: import_zod2.z.number().nullish(),
+  prompt_tokens_details: import_zod2.z.object({
+    cached_tokens: import_zod2.z.number().nullish()
+  }).nullish(),
   completion_tokens_details: import_zod2.z.object({
     reasoning_tokens: import_zod2.z.number().nullish()
   }).nullish()