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

package/dist/internal/index.d.mts

@@ -11,6 +11,16 @@ declare const openaiProviderOptions: z.ZodObject<{
      * the GPT tokenizer) to an associated bias value from -100 to 100.
      */
     logitBias: z.ZodOptional<z.ZodRecord<z.ZodNumber, z.ZodNumber>>;
+    /**
+     * Return the log probabilities of the tokens.
+     *
+     * Setting to true will return the log probabilities of the tokens that
+     * were generated.
+     *
+     * Setting to a number will return the log probabilities of the top n
+     * tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
     /**
      * Whether to enable parallel function calling during tool use. Default to true.
      */
@@ -49,6 +59,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -59,6 +70,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -123,14 +135,26 @@ declare const openaiCompletionProviderOptions: z.ZodObject<{
   monitor and detect abuse. Learn more.
    */
     user: z.ZodOptional<z.ZodString>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }>;

package/dist/internal/index.d.ts

@@ -11,6 +11,16 @@ declare const openaiProviderOptions: z.ZodObject<{
      * the GPT tokenizer) to an associated bias value from -100 to 100.
      */
     logitBias: z.ZodOptional<z.ZodRecord<z.ZodNumber, z.ZodNumber>>;
+    /**
+     * Return the log probabilities of the tokens.
+     *
+     * Setting to true will return the log probabilities of the tokens that
+     * were generated.
+     *
+     * Setting to a number will return the log probabilities of the top n
+     * tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
     /**
      * Whether to enable parallel function calling during tool use. Default to true.
      */
@@ -49,6 +59,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -59,6 +70,7 @@ declare const openaiProviderOptions: z.ZodObject<{
 }, {
     user?: string | undefined;
     logitBias?: Record<number, number> | undefined;
+    logprobs?: number | boolean | undefined;
     parallelToolCalls?: boolean | undefined;
     reasoningEffort?: "low" | "medium" | "high" | undefined;
     maxCompletionTokens?: number | undefined;
@@ -123,14 +135,26 @@ declare const openaiCompletionProviderOptions: z.ZodObject<{
   monitor and detect abuse. Learn more.
    */
     user: z.ZodOptional<z.ZodString>;
+    /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+    logprobs: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodNumber]>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }, {
     user?: string | undefined;
     logitBias?: Record<string, number> | undefined;
+    logprobs?: number | boolean | undefined;
     echo?: boolean | undefined;
     suffix?: string | undefined;
 }>;

package/dist/internal/index.js

@@ -246,6 +246,16 @@ var openaiProviderOptions = import_zod.z.object({
    * the GPT tokenizer) to an associated bias value from -100 to 100.
    */
   logitBias: import_zod.z.record(import_zod.z.coerce.number(), import_zod.z.number()).optional(),
+  /**
+   * Return the log probabilities of the tokens.
+   *
+   * Setting to true will return the log probabilities of the tokens that
+   * were generated.
+   *
+   * Setting to a number will return the log probabilities of the top n
+   * tokens that were generated.
+   */
+  logprobs: import_zod.z.union([import_zod.z.boolean(), import_zod.z.number()]).optional(),
   /**
    * Whether to enable parallel function calling during tool use. Default to true.
    */
@@ -420,6 +430,8 @@ var OpenAIChatLanguageModel = class {
       model: this.modelId,
       // model specific settings:
       logit_bias: openaiOptions.logitBias,
+      logprobs: openaiOptions.logprobs === true || typeof openaiOptions.logprobs === "number" ? true : void 0,
+      top_logprobs: typeof openaiOptions.logprobs === "number" ? openaiOptions.logprobs : typeof openaiOptions.logprobs === "boolean" ? openaiOptions.logprobs ? 0 : void 0 : void 0,
       user: openaiOptions.user,
       parallel_tool_calls: openaiOptions.parallelToolCalls,
       // standardized settings:
@@ -492,6 +504,20 @@ var OpenAIChatLanguageModel = class {
           message: "logitBias is not supported for reasoning models"
         });
       }
+      if (baseArgs.logprobs != null) {
+        baseArgs.logprobs = void 0;
+        warnings.push({
+          type: "other",
+          message: "logprobs is not supported for reasoning models"
+        });
+      }
+      if (baseArgs.top_logprobs != null) {
+        baseArgs.top_logprobs = void 0;
+        warnings.push({
+          type: "other",
+          message: "topLogprobs is not supported for reasoning models"
+        });
+      }
       if (baseArgs.max_tokens != null) {
         if (baseArgs.max_completion_tokens == null) {
           baseArgs.max_completion_tokens = baseArgs.max_tokens;
@@ -527,7 +553,7 @@ var OpenAIChatLanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i;
     const { args: body, warnings } = await this.getArgs(options);
     const {
       responseHeaders,
@@ -577,12 +603,15 @@ var OpenAIChatLanguageModel = class {
     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;
+    }
     return {
       content,
       finishReason: mapOpenAIFinishReason(choice.finish_reason),
       usage: {
-        inputTokens: (_f = (_e = response.usage) == null ? void 0 : _e.prompt_tokens) != null ? _f : void 0,
-        outputTokens: (_h = (_g = response.usage) == null ? void 0 : _g.completion_tokens) != null ? _h : void 0
+        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
       },
       request: { body },
       response: {
@@ -817,6 +846,20 @@ var openaiChatResponseSchema = import_zod3.z.object({
         ).nullish()
       }),
       index: import_zod3.z.number(),
+      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()
     })
   ),
@@ -836,7 +879,7 @@ var openaiChatChunkSchema = import_zod3.z.union([
             import_zod3.z.object({
               index: import_zod3.z.number(),
               id: import_zod3.z.string().nullish(),
-              type: import_zod3.z.literal("function").optional(),
+              type: import_zod3.z.literal("function").nullish(),
               function: import_zod3.z.object({
                 name: import_zod3.z.string().nullish(),
                 arguments: import_zod3.z.string().nullish()
@@ -844,7 +887,7 @@ var openaiChatChunkSchema = import_zod3.z.union([
             })
           ).nullish()
         }).nullish(),
-        finish_reason: import_zod3.z.string().nullable().optional(),
+        finish_reason: import_zod3.z.string().nullish(),
         index: import_zod3.z.number()
       })
     ),
@@ -1004,7 +1047,17 @@ var openaiCompletionProviderOptions = import_zod4.z.object({
   A unique identifier representing your end-user, which can help OpenAI to
   monitor and detect abuse. Learn more.
    */
-  user: import_zod4.z.string().optional()
+  user: import_zod4.z.string().optional(),
+  /**
+  Return the log probabilities of the tokens. Including logprobs will increase
+  the response size and can slow down response times. However, it can
+  be useful to better understand how the model is behaving.
+  Setting to true will return the log probabilities of the tokens that
+  were generated.
+  Setting to a number will return the log probabilities of the top n
+  tokens that were generated.
+     */
+  logprobs: import_zod4.z.union([import_zod4.z.boolean(), import_zod4.z.number()]).optional()
 });
 
 // src/openai-completion-language-model.ts
@@ -1076,6 +1129,7 @@ var OpenAICompletionLanguageModel = class {
         // model specific settings:
         echo: openaiOptions.echo,
         logit_bias: openaiOptions.logitBias,
+        logprobs: (openaiOptions == null ? void 0 : openaiOptions.logprobs) === true ? 0 : (openaiOptions == null ? void 0 : openaiOptions.logprobs) === false ? void 0 : openaiOptions == null ? void 0 : openaiOptions.logprobs,
         suffix: openaiOptions.suffix,
         user: openaiOptions.user,
         // standardized settings:
@@ -1114,6 +1168,10 @@ var OpenAICompletionLanguageModel = class {
       fetch: this.config.fetch
     });
     const choice = response.choices[0];
+    const providerMetadata = { openai: {} };
+    if (choice.logprobs != null) {
+      providerMetadata.openai.logprobs = choice.logprobs;
+    }
     return {
       content: [{ type: "text", text: choice.text }],
       usage: {
@@ -1127,6 +1185,7 @@ var OpenAICompletionLanguageModel = class {
         headers: responseHeaders,
         body: rawResponse
       },
+      providerMetadata,
       warnings
     };
   }
@@ -1153,6 +1212,7 @@ var OpenAICompletionLanguageModel = class {
       fetch: this.config.fetch
     });
     let finishReason = "unknown";
+    const providerMetadata = { openai: {} };
     const usage = {
       inputTokens: void 0,
       outputTokens: void 0
@@ -1191,6 +1251,9 @@ var OpenAICompletionLanguageModel = class {
             if ((choice == null ? void 0 : choice.finish_reason) != null) {
               finishReason = mapOpenAIFinishReason(choice.finish_reason);
             }
+            if ((choice == null ? void 0 : choice.logprobs) != null) {
+              providerMetadata.openai.logprobs = choice.logprobs;
+            }
             if ((choice == null ? void 0 : choice.text) != null) {
               controller.enqueue({
                 type: "text",
@@ -1202,6 +1265,7 @@ var OpenAICompletionLanguageModel = class {
             controller.enqueue({
               type: "finish",
               finishReason,
+              providerMetadata,
               usage
             });
           }
@@ -1219,7 +1283,12 @@ var openaiCompletionResponseSchema = import_zod5.z.object({
   choices: import_zod5.z.array(
     import_zod5.z.object({
       text: import_zod5.z.string(),
-      finish_reason: import_zod5.z.string()
+      finish_reason: import_zod5.z.string(),
+      logprobs: import_zod5.z.object({
+        tokens: import_zod5.z.array(import_zod5.z.string()),
+        token_logprobs: import_zod5.z.array(import_zod5.z.number()),
+        top_logprobs: import_zod5.z.array(import_zod5.z.record(import_zod5.z.string(), import_zod5.z.number())).nullish()
+      }).nullish()
     })
   ),
   usage: import_zod5.z.object({
@@ -1236,7 +1305,12 @@ var openaiCompletionChunkSchema = import_zod5.z.union([
       import_zod5.z.object({
         text: import_zod5.z.string(),
         finish_reason: import_zod5.z.string().nullish(),
-        index: import_zod5.z.number()
+        index: import_zod5.z.number(),
+        logprobs: import_zod5.z.object({
+          tokens: import_zod5.z.array(import_zod5.z.string()),
+          token_logprobs: import_zod5.z.array(import_zod5.z.number()),
+          top_logprobs: import_zod5.z.array(import_zod5.z.record(import_zod5.z.string(), import_zod5.z.number())).nullish()
+        }).nullish()
       })
     ),
     usage: import_zod5.z.object({
@@ -1413,12 +1487,23 @@ var OpenAIImageModel = class {
         timestamp: currentDate,
         modelId: this.modelId,
         headers: responseHeaders
+      },
+      providerMetadata: {
+        openai: {
+          images: response.data.map(
+            (item) => item.revised_prompt ? {
+              revisedPrompt: item.revised_prompt
+            } : null
+          )
+        }
       }
     };
   }
 };
 var openaiImageResponseSchema = import_zod8.z.object({
-  data: import_zod8.z.array(import_zod8.z.object({ b64_json: import_zod8.z.string() }))
+  data: import_zod8.z.array(
+    import_zod8.z.object({ b64_json: import_zod8.z.string(), revised_prompt: import_zod8.z.string().optional() })
+  )
 });
 
 // src/openai-transcription-model.ts