@ai-sdk/openai 2.0.12 → 2.0.14

package/dist/index.mjs

@@ -2150,6 +2150,19 @@ function prepareResponsesTools({
 }
 
 // src/responses/openai-responses-language-model.ts
+var TOP_LOGPROBS_MAX = 20;
+var LOGPROBS_SCHEMA = z13.array(
+  z13.object({
+    token: z13.string(),
+    logprob: z13.number(),
+    top_logprobs: z13.array(
+      z13.object({
+        token: z13.string(),
+        logprob: z13.number()
+      })
+    )
+  })
+);
 var OpenAIResponsesLanguageModel = class {
   constructor(modelId, config) {
     this.specificationVersion = "v2";
@@ -2213,6 +2226,8 @@ var OpenAIResponsesLanguageModel = class {
       schema: openaiResponsesProviderOptionsSchema
     });
     const strictJsonSchema = (_a = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _a : false;
+    const topLogprobs = typeof (openaiOptions == null ? void 0 : openaiOptions.logprobs) === "number" ? openaiOptions == null ? void 0 : openaiOptions.logprobs : (openaiOptions == null ? void 0 : openaiOptions.logprobs) === true ? TOP_LOGPROBS_MAX : void 0;
+    const openaiOptionsInclude = topLogprobs ? Array.isArray(openaiOptions == null ? void 0 : openaiOptions.include) ? [...openaiOptions == null ? void 0 : openaiOptions.include, "message.output_text.logprobs"] : ["message.output_text.logprobs"] : openaiOptions == null ? void 0 : openaiOptions.include;
     const baseArgs = {
       model: this.modelId,
       input: messages,
@@ -2243,9 +2258,10 @@ var OpenAIResponsesLanguageModel = class {
       user: openaiOptions == null ? void 0 : openaiOptions.user,
       instructions: openaiOptions == null ? void 0 : openaiOptions.instructions,
       service_tier: openaiOptions == null ? void 0 : openaiOptions.serviceTier,
-      include: openaiOptions == null ? void 0 : openaiOptions.include,
+      include: openaiOptionsInclude,
       prompt_cache_key: openaiOptions == null ? void 0 : openaiOptions.promptCacheKey,
       safety_identifier: openaiOptions == null ? void 0 : openaiOptions.safetyIdentifier,
+      top_logprobs: topLogprobs,
       // model-specific settings:
       ...modelConfig.isReasoningModel && ((openaiOptions == null ? void 0 : openaiOptions.reasoningEffort) != null || (openaiOptions == null ? void 0 : openaiOptions.reasoningSummary) != null) && {
         reasoning: {
@@ -2329,7 +2345,7 @@ var OpenAIResponsesLanguageModel = 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, _n;
     const { args: body, warnings } = await this.getArgs(options);
     const url = this.config.url({
       path: "/responses",
@@ -2363,14 +2379,24 @@ var OpenAIResponsesLanguageModel = class {
                   z13.object({
                     type: z13.literal("output_text"),
                     text: z13.string(),
+                    logprobs: LOGPROBS_SCHEMA.nullish(),
                     annotations: z13.array(
-                      z13.object({
-                        type: z13.literal("url_citation"),
-                        start_index: z13.number(),
-                        end_index: z13.number(),
-                        url: z13.string(),
-                        title: z13.string()
-                      })
+                      z13.discriminatedUnion("type", [
+                        z13.object({
+                          type: z13.literal("url_citation"),
+                          start_index: z13.number(),
+                          end_index: z13.number(),
+                          url: z13.string(),
+                          title: z13.string()
+                        }),
+                        z13.object({
+                          type: z13.literal("file_citation"),
+                          start_index: z13.number(),
+                          end_index: z13.number(),
+                          file_id: z13.string(),
+                          quote: z13.string()
+                        })
+                      ])
                     )
                   })
                 )
@@ -2440,6 +2466,7 @@ var OpenAIResponsesLanguageModel = class {
       });
     }
     const content = [];
+    const logprobs = [];
     for (const part of response.output) {
       switch (part.type) {
         case "reasoning": {
@@ -2462,6 +2489,9 @@ var OpenAIResponsesLanguageModel = class {
         }
         case "message": {
           for (const contentPart of part.content) {
+            if (((_c = (_b = options.providerOptions) == null ? void 0 : _b.openai) == null ? void 0 : _c.logprobs) && contentPart.logprobs) {
+              logprobs.push(contentPart.logprobs);
+            }
             content.push({
               type: "text",
               text: contentPart.text,
@@ -2472,13 +2502,24 @@ var OpenAIResponsesLanguageModel = class {
               }
             });
             for (const annotation of contentPart.annotations) {
-              content.push({
-                type: "source",
-                sourceType: "url",
-                id: (_d = (_c = (_b = this.config).generateId) == null ? void 0 : _c.call(_b)) != null ? _d : generateId2(),
-                url: annotation.url,
-                title: annotation.title
-              });
+              if (annotation.type === "url_citation") {
+                content.push({
+                  type: "source",
+                  sourceType: "url",
+                  id: (_f = (_e = (_d = this.config).generateId) == null ? void 0 : _e.call(_d)) != null ? _f : generateId2(),
+                  url: annotation.url,
+                  title: annotation.title
+                });
+              } else if (annotation.type === "file_citation") {
+                content.push({
+                  type: "source",
+                  sourceType: "document",
+                  id: (_i = (_h = (_g = this.config).generateId) == null ? void 0 : _h.call(_g)) != null ? _i : generateId2(),
+                  mediaType: "text/plain",
+                  title: annotation.quote,
+                  filename: annotation.file_id
+                });
+              }
             }
           }
           break;
@@ -2558,18 +2599,24 @@ var OpenAIResponsesLanguageModel = class {
         }
       }
     }
+    const providerMetadata = {
+      openai: { responseId: response.id }
+    };
+    if (logprobs.length > 0) {
+      providerMetadata.openai.logprobs = logprobs;
+    }
     return {
       content,
       finishReason: mapOpenAIResponseFinishReason({
-        finishReason: (_e = response.incomplete_details) == null ? void 0 : _e.reason,
+        finishReason: (_j = response.incomplete_details) == null ? void 0 : _j.reason,
         hasToolCalls: content.some((part) => part.type === "tool-call")
       }),
       usage: {
         inputTokens: response.usage.input_tokens,
         outputTokens: response.usage.output_tokens,
         totalTokens: response.usage.input_tokens + response.usage.output_tokens,
-        reasoningTokens: (_g = (_f = response.usage.output_tokens_details) == null ? void 0 : _f.reasoning_tokens) != null ? _g : void 0,
-        cachedInputTokens: (_i = (_h = response.usage.input_tokens_details) == null ? void 0 : _h.cached_tokens) != null ? _i : void 0
+        reasoningTokens: (_l = (_k = response.usage.output_tokens_details) == null ? void 0 : _k.reasoning_tokens) != null ? _l : void 0,
+        cachedInputTokens: (_n = (_m = response.usage.input_tokens_details) == null ? void 0 : _m.cached_tokens) != null ? _n : void 0
       },
       request: { body },
       response: {
@@ -2579,11 +2626,7 @@ var OpenAIResponsesLanguageModel = class {
         headers: responseHeaders,
         body: rawResponse
       },
-      providerMetadata: {
-        openai: {
-          responseId: response.id
-        }
-      },
+      providerMetadata,
       warnings
     };
   }
@@ -2613,6 +2656,7 @@ var OpenAIResponsesLanguageModel = class {
       outputTokens: void 0,
       totalTokens: void 0
     };
+    const logprobs = [];
     let responseId = null;
     const ongoingToolCalls = {};
     let hasToolCalls = false;
@@ -2624,7 +2668,7 @@ var OpenAIResponsesLanguageModel = class {
             controller.enqueue({ type: "stream-start", warnings });
           },
           transform(chunk, controller) {
-            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -2838,6 +2882,9 @@ var OpenAIResponsesLanguageModel = class {
                 id: value.item_id,
                 delta: value.delta
               });
+              if (value.logprobs) {
+                logprobs.push(value.logprobs);
+              }
             } else if (isResponseReasoningSummaryPartAddedChunk(value)) {
               if (value.summary_index > 0) {
                 (_c = activeReasoning[value.item_id]) == null ? void 0 : _c.summaryParts.push(
@@ -2876,27 +2923,42 @@ var OpenAIResponsesLanguageModel = class {
               usage.reasoningTokens = (_h = (_g = value.response.usage.output_tokens_details) == null ? void 0 : _g.reasoning_tokens) != null ? _h : void 0;
               usage.cachedInputTokens = (_j = (_i = value.response.usage.input_tokens_details) == null ? void 0 : _i.cached_tokens) != null ? _j : void 0;
             } else if (isResponseAnnotationAddedChunk(value)) {
-              controller.enqueue({
-                type: "source",
-                sourceType: "url",
-                id: (_m = (_l = (_k = self.config).generateId) == null ? void 0 : _l.call(_k)) != null ? _m : generateId2(),
-                url: value.annotation.url,
-                title: value.annotation.title
-              });
+              if (value.annotation.type === "url_citation") {
+                controller.enqueue({
+                  type: "source",
+                  sourceType: "url",
+                  id: (_m = (_l = (_k = self.config).generateId) == null ? void 0 : _l.call(_k)) != null ? _m : generateId2(),
+                  url: value.annotation.url,
+                  title: value.annotation.title
+                });
+              } else if (value.annotation.type === "file_citation") {
+                controller.enqueue({
+                  type: "source",
+                  sourceType: "document",
+                  id: (_p = (_o = (_n = self.config).generateId) == null ? void 0 : _o.call(_n)) != null ? _p : generateId2(),
+                  mediaType: "text/plain",
+                  title: value.annotation.quote,
+                  filename: value.annotation.file_id
+                });
+              }
             } else if (isErrorChunk(value)) {
               controller.enqueue({ type: "error", error: value });
             }
           },
           flush(controller) {
+            const providerMetadata = {
+              openai: {
+                responseId
+              }
+            };
+            if (logprobs.length > 0) {
+              providerMetadata.openai.logprobs = logprobs;
+            }
             controller.enqueue({
               type: "finish",
               finishReason,
               usage,
-              providerMetadata: {
-                openai: {
-                  responseId
-                }
-              }
+              providerMetadata
             });
           }
         })
@@ -2915,7 +2977,8 @@ var usageSchema2 = z13.object({
 var textDeltaChunkSchema = z13.object({
   type: z13.literal("response.output_text.delta"),
   item_id: z13.string(),
-  delta: z13.string()
+  delta: z13.string(),
+  logprobs: LOGPROBS_SCHEMA.nullish()
 });
 var errorChunkSchema = z13.object({
   type: z13.literal("error"),
@@ -3044,11 +3107,18 @@ var responseFunctionCallArgumentsDeltaSchema = z13.object({
 });
 var responseAnnotationAddedSchema = z13.object({
   type: z13.literal("response.output_text.annotation.added"),
-  annotation: z13.object({
-    type: z13.literal("url_citation"),
-    url: z13.string(),
-    title: z13.string()
-  })
+  annotation: z13.discriminatedUnion("type", [
+    z13.object({
+      type: z13.literal("url_citation"),
+      url: z13.string(),
+      title: z13.string()
+    }),
+    z13.object({
+      type: z13.literal("file_citation"),
+      file_id: z13.string(),
+      quote: z13.string()
+    })
+  ])
 });
 var responseReasoningSummaryPartAddedSchema = z13.object({
   type: z13.literal("response.reasoning_summary_part.added"),
@@ -3156,10 +3226,29 @@ var openaiResponsesProviderOptionsSchema = z13.object({
   instructions: z13.string().nullish(),
   reasoningSummary: z13.string().nullish(),
   serviceTier: z13.enum(["auto", "flex", "priority"]).nullish(),
-  include: z13.array(z13.enum(["reasoning.encrypted_content", "file_search_call.results"])).nullish(),
+  include: z13.array(
+    z13.enum([
+      "reasoning.encrypted_content",
+      "file_search_call.results",
+      "message.output_text.logprobs"
+    ])
+  ).nullish(),
   textVerbosity: z13.enum(["low", "medium", "high"]).nullish(),
   promptCacheKey: z13.string().nullish(),
-  safetyIdentifier: z13.string().nullish()
+  safetyIdentifier: z13.string().nullish(),
+  /**
+   * 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.
+   *
+   * @see https://platform.openai.com/docs/api-reference/responses/create
+   * @see https://cookbook.openai.com/examples/using_logprobs
+   */
+  logprobs: z13.union([z13.boolean(), z13.number().min(1).max(TOP_LOGPROBS_MAX)]).optional()
 });
 
 // src/speech/openai-speech-model.ts