@ai-sdk/openai 2.0.0-canary.10 → 2.0.0-canary.11

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @ai-sdk/openai
 
+## 2.0.0-canary.11
+
+### Patch Changes
+
+- 8493141: feat (providers/openai): add support for reasoning summaries
+- Updated dependencies [e86be6f]
+  - @ai-sdk/provider@2.0.0-canary.9
+  - @ai-sdk/provider-utils@3.0.0-canary.10
+
 ## 2.0.0-canary.10
 
 ### Patch Changes

package/dist/index.d.mts

@@ -34,18 +34,6 @@ interface OpenAICompletionSettings {
      */
     logitBias?: Record<number, number>;
     /**
-  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?: boolean | number;
-    /**
   The suffix that comes after a completion of inserted text.
      */
     suffix?: string;
@@ -236,6 +224,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -245,6 +234,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;
+    reasoningSummary?: string | null | undefined;
 }, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -254,6 +244,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;
+    reasoningSummary?: string | null | undefined;
 }>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 

package/dist/index.d.ts

@@ -34,18 +34,6 @@ interface OpenAICompletionSettings {
      */
     logitBias?: Record<number, number>;
     /**
-  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?: boolean | number;
-    /**
   The suffix that comes after a completion of inserted text.
      */
     suffix?: string;
@@ -236,6 +224,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     reasoningEffort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     strictSchemas: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     instructions: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    reasoningSummary: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, "strip", z.ZodTypeAny, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -245,6 +234,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;
+    reasoningSummary?: string | null | undefined;
 }, {
     user?: string | null | undefined;
     parallelToolCalls?: boolean | null | undefined;
@@ -254,6 +244,7 @@ declare const openaiResponsesProviderOptionsSchema: z.ZodObject<{
     previousResponseId?: string | null | undefined;
     strictSchemas?: boolean | null | undefined;
     instructions?: string | null | undefined;
+    reasoningSummary?: string | null | undefined;
 }>;
 type OpenAIResponsesProviderOptions = z.infer<typeof openaiResponsesProviderOptionsSchema>;
 

package/dist/index.js

@@ -211,19 +211,6 @@ function getResponseMetadata({
   };
 }
 
-// src/map-openai-chat-logprobs.ts
-function mapOpenAIChatLogProbsOutput(logprobs) {
-  var _a, _b;
-  return (_b = (_a = logprobs == null ? void 0 : logprobs.content) == null ? void 0 : _a.map(({ token, logprob, top_logprobs }) => ({
-    token,
-    logprob,
-    topLogprobs: top_logprobs ? top_logprobs.map(({ token: token2, logprob: logprob2 }) => ({
-      token: token2,
-      logprob: logprob2
-    })) : []
-  }))) != null ? _b : void 0;
-}
-
 // src/map-openai-finish-reason.ts
 function mapOpenAIFinishReason(finishReason) {
   switch (finishReason) {
@@ -251,16 +238,6 @@ 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.
    */
@@ -431,8 +408,6 @@ 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:
@@ -505,20 +480,6 @@ 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;
@@ -618,7 +579,6 @@ var OpenAIChatLanguageModel = class {
         body: rawResponse
       },
       warnings,
-      logprobs: mapOpenAIChatLogProbsOutput(choice.logprobs),
       providerMetadata
     };
   }
@@ -651,7 +611,6 @@ var OpenAIChatLanguageModel = class {
       inputTokens: void 0,
       outputTokens: void 0
     };
-    let logprobs;
     let isFirstChunk = true;
     const providerMetadata = { openai: {} };
     return {
@@ -716,13 +675,6 @@ var OpenAIChatLanguageModel = class {
                 text: delta.content
               });
             }
-            const mappedLogprobs = mapOpenAIChatLogProbsOutput(
-              choice == null ? void 0 : choice.logprobs
-            );
-            if (mappedLogprobs == null ? void 0 : mappedLogprobs.length) {
-              if (logprobs === void 0) logprobs = [];
-              logprobs.push(...mappedLogprobs);
-            }
             if (delta.tool_calls != null) {
               for (const toolCallDelta of delta.tool_calls) {
                 const index = toolCallDelta.index;
@@ -809,7 +761,6 @@ var OpenAIChatLanguageModel = class {
             controller.enqueue({
               type: "finish",
               finishReason,
-              logprobs,
               usage,
               ...providerMetadata != null ? { providerMetadata } : {}
             });
@@ -854,20 +805,6 @@ 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()
-              })
-            )
-          })
-        ).nullable()
-      }).nullish(),
       finish_reason: import_zod3.z.string().nullish()
     })
   ),
@@ -895,20 +832,6 @@ 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()
-                })
-              )
-            })
-          ).nullable()
-        }).nullish(),
         finish_reason: import_zod3.z.string().nullable().optional(),
         index: import_zod3.z.number()
       })
@@ -1031,20 +954,6 @@ ${user}:`]
   };
 }
 
-// src/map-openai-completion-logprobs.ts
-function mapOpenAICompletionLogProbs(logprobs) {
-  return logprobs == null ? void 0 : logprobs.tokens.map((token, index) => ({
-    token,
-    logprob: logprobs.token_logprobs[index],
-    topLogprobs: logprobs.top_logprobs ? Object.entries(logprobs.top_logprobs[index]).map(
-      ([token2, logprob]) => ({
-        token: token2,
-        logprob
-      })
-    ) : []
-  }));
-}
-
 // src/openai-completion-language-model.ts
 var OpenAICompletionLanguageModel = class {
   constructor(modelId, settings, config) {
@@ -1102,7 +1011,6 @@ var OpenAICompletionLanguageModel = class {
         // model specific settings:
         echo: this.settings.echo,
         logit_bias: this.settings.logitBias,
-        logprobs: typeof this.settings.logprobs === "number" ? this.settings.logprobs : typeof this.settings.logprobs === "boolean" ? this.settings.logprobs ? 0 : void 0 : void 0,
         suffix: this.settings.suffix,
         user: this.settings.user,
         // standardized settings:
@@ -1148,7 +1056,6 @@ var OpenAICompletionLanguageModel = class {
         outputTokens: response.usage.completion_tokens
       },
       finishReason: mapOpenAIFinishReason(choice.finish_reason),
-      logprobs: mapOpenAICompletionLogProbs(choice.logprobs),
       request: { body: args },
       response: {
         ...getResponseMetadata(response),
@@ -1185,7 +1092,6 @@ var OpenAICompletionLanguageModel = class {
       inputTokens: void 0,
       outputTokens: void 0
     };
-    let logprobs;
     let isFirstChunk = true;
     return {
       stream: response.pipeThrough(
@@ -1226,19 +1132,11 @@ var OpenAICompletionLanguageModel = class {
                 text: choice.text
               });
             }
-            const mappedLogprobs = mapOpenAICompletionLogProbs(
-              choice == null ? void 0 : choice.logprobs
-            );
-            if (mappedLogprobs == null ? void 0 : mappedLogprobs.length) {
-              if (logprobs === void 0) logprobs = [];
-              logprobs.push(...mappedLogprobs);
-            }
           },
           flush(controller) {
             controller.enqueue({
               type: "finish",
               finishReason,
-              logprobs,
               usage
             });
           }
@@ -1256,12 +1154,7 @@ var openaiCompletionResponseSchema = import_zod4.z.object({
   choices: import_zod4.z.array(
     import_zod4.z.object({
       text: import_zod4.z.string(),
-      finish_reason: import_zod4.z.string(),
-      logprobs: import_zod4.z.object({
-        tokens: import_zod4.z.array(import_zod4.z.string()),
-        token_logprobs: import_zod4.z.array(import_zod4.z.number()),
-        top_logprobs: import_zod4.z.array(import_zod4.z.record(import_zod4.z.string(), import_zod4.z.number())).nullable()
-      }).nullish()
+      finish_reason: import_zod4.z.string()
     })
   ),
   usage: import_zod4.z.object({
@@ -1278,12 +1171,7 @@ var openaiCompletionChunkSchema = import_zod4.z.union([
       import_zod4.z.object({
         text: import_zod4.z.string(),
         finish_reason: import_zod4.z.string().nullish(),
-        index: import_zod4.z.number(),
-        logprobs: import_zod4.z.object({
-          tokens: import_zod4.z.array(import_zod4.z.string()),
-          token_logprobs: import_zod4.z.array(import_zod4.z.number()),
-          top_logprobs: import_zod4.z.array(import_zod4.z.record(import_zod4.z.string(), import_zod4.z.number())).nullable()
-        }).nullish()
+        index: import_zod4.z.number()
       })
     ),
     usage: import_zod4.z.object({
@@ -1960,8 +1848,15 @@ var OpenAIResponsesLanguageModel = class {
       user: openaiOptions == null ? void 0 : openaiOptions.user,
       instructions: openaiOptions == null ? void 0 : openaiOptions.instructions,
       // model-specific settings:
-      ...modelConfig.isReasoningModel && (openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null && {
-        reasoning: { effort: openaiOptions == null ? void 0 : openaiOptions.reasoningEffort }
+      ...modelConfig.isReasoningModel && ((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null) && {
+        reasoning: {
+          ...(openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null && {
+            effort: openaiOptions.reasoningEffort
+          },
+          ...(openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null && {
+            summary: openaiOptions.reasoningSummary
+          }
+        }
       },
       ...modelConfig.requiredAutoTruncation && {
         truncation: "auto"
@@ -2057,7 +1952,13 @@ var OpenAIResponsesLanguageModel = class {
                 type: import_zod10.z.literal("computer_call")
               }),
               import_zod10.z.object({
-                type: import_zod10.z.literal("reasoning")
+                type: import_zod10.z.literal("reasoning"),
+                summary: import_zod10.z.array(
+                  import_zod10.z.object({
+                    type: import_zod10.z.literal("summary_text"),
+                    text: import_zod10.z.string()
+                  })
+                )
               })
             ])
           ),
@@ -2071,6 +1972,14 @@ var OpenAIResponsesLanguageModel = class {
     const content = [];
     for (const part of response.output) {
       switch (part.type) {
+        case "reasoning": {
+          content.push({
+            type: "reasoning",
+            reasoningType: "text",
+            text: part.summary.map((summary) => summary.text).join()
+          });
+          break;
+        }
         case "message": {
           for (const contentPart of part.content) {
             content.push({
@@ -2211,6 +2120,12 @@ var OpenAIResponsesLanguageModel = class {
                 type: "text",
                 text: value.delta
               });
+            } else if (isResponseReasoningSummaryTextDeltaChunk(value)) {
+              controller.enqueue({
+                type: "reasoning",
+                reasoningType: "text",
+                text: value.delta
+              });
             } else if (isResponseOutputItemDoneChunk(value) && value.item.type === "function_call") {
               ongoingToolCalls[value.output_index] = void 0;
               hasToolCalls = true;
@@ -2335,6 +2250,13 @@ var responseAnnotationAddedSchema = import_zod10.z.object({
     title: import_zod10.z.string()
   })
 });
+var responseReasoningSummaryTextDeltaSchema = import_zod10.z.object({
+  type: import_zod10.z.literal("response.reasoning_summary_text.delta"),
+  item_id: import_zod10.z.string(),
+  output_index: import_zod10.z.number(),
+  summary_index: import_zod10.z.number(),
+  delta: import_zod10.z.string()
+});
 var openaiResponsesChunkSchema = import_zod10.z.union([
   textDeltaChunkSchema,
   responseFinishedChunkSchema,
@@ -2343,6 +2265,7 @@ var openaiResponsesChunkSchema = import_zod10.z.union([
   responseFunctionCallArgumentsDeltaSchema,
   responseOutputItemAddedSchema,
   responseAnnotationAddedSchema,
+  responseReasoningSummaryTextDeltaSchema,
   import_zod10.z.object({ type: import_zod10.z.string() }).passthrough()
   // fallback for unknown chunks
 ]);
@@ -2367,6 +2290,9 @@ function isResponseOutputItemAddedChunk(chunk) {
 function isResponseAnnotationAddedChunk(chunk) {
   return chunk.type === "response.output_text.annotation.added";
 }
+function isResponseReasoningSummaryTextDeltaChunk(chunk) {
+  return chunk.type === "response.reasoning_summary_text.delta";
+}
 function getResponsesModelConfig(modelId) {
   if (modelId.startsWith("o")) {
     if (modelId.startsWith("o1-mini") || modelId.startsWith("o1-preview")) {
@@ -2396,7 +2322,8 @@ var openaiResponsesProviderOptionsSchema = import_zod10.z.object({
   user: import_zod10.z.string().nullish(),
   reasoningEffort: import_zod10.z.string().nullish(),
   strictSchemas: import_zod10.z.boolean().nullish(),
-  instructions: import_zod10.z.string().nullish()
+  instructions: import_zod10.z.string().nullish(),
+  reasoningSummary: import_zod10.z.string().nullish()
 });
 
 // src/openai-speech-model.ts