@ai-sdk/openai 4.0.55 → 4.0.57

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @ai-sdk/openai
 
+## 4.0.57
+
+### Patch Changes
+
+- 048ce06: feat(batch): surface the uploaded input file on the batch start result (`providerMetadata.<provider>.inputFileId` / `inputFileExpiresAt`) and accept an `inputFileExpiresAfter` provider option on the OpenAI and xAI batch input file upload
+- 7243530: fix(openai): preserve complete Responses API raw usage objects
+
+## 4.0.56
+
+### Patch Changes
+
+- Updated dependencies [6bcc0f8]
+  - @ai-sdk/provider-utils@5.0.36
+
 ## 4.0.55
 
 ### Patch Changes

package/dist/index.d.ts

@@ -255,20 +255,21 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         incomplete_details?: {
             reason: string;
         } | null | undefined;
-        usage?: {
+        usage?: (Record<string, JSONValue | undefined> & {
             input_tokens: number;
             output_tokens: number;
-            input_tokens_details?: {
+            input_tokens_details?: (Record<string, JSONValue | undefined> & {
                 cached_tokens?: number | null | undefined;
                 cache_write_tokens?: number | null | undefined;
                 orchestration_input_tokens?: number | null | undefined;
                 orchestration_input_cached_tokens?: number | null | undefined;
-            } | null | undefined;
-            output_tokens_details?: {
+            }) | null | undefined;
+            output_tokens_details?: (Record<string, JSONValue | undefined> & {
                 reasoning_tokens?: number | null | undefined;
                 orchestration_output_tokens?: number | null | undefined;
-            } | null | undefined;
-        } | null | undefined;
+            }) | null | undefined;
+            total_tokens?: number | undefined;
+        }) | null | undefined;
         reasoning?: {
             context?: string | null | undefined;
         } | null | undefined;
@@ -285,20 +286,21 @@ declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
         incomplete_details?: {
             reason: string;
         } | null | undefined;
-        usage?: {
+        usage?: (Record<string, JSONValue | undefined> & {
             input_tokens: number;
             output_tokens: number;
-            input_tokens_details?: {
+            input_tokens_details?: (Record<string, JSONValue | undefined> & {
                 cached_tokens?: number | null | undefined;
                 cache_write_tokens?: number | null | undefined;
                 orchestration_input_tokens?: number | null | undefined;
                 orchestration_input_cached_tokens?: number | null | undefined;
-            } | null | undefined;
-            output_tokens_details?: {
+            }) | null | undefined;
+            output_tokens_details?: (Record<string, JSONValue | undefined> & {
                 reasoning_tokens?: number | null | undefined;
                 orchestration_output_tokens?: number | null | undefined;
-            } | null | undefined;
-        } | null | undefined;
+            }) | null | undefined;
+            total_tokens?: number | undefined;
+        }) | null | undefined;
         reasoning?: {
             context?: string | null | undefined;
         } | null | undefined;

package/dist/index.js

@@ -3529,6 +3529,7 @@ import {
   getFromApi as getFromApi2,
   lazySchema as lazySchema26,
   normalizeBatchRequestCounts,
+  parseProviderOptions as parseProviderOptions8,
   postJsonToApi as postJsonToApi6,
   postToApi,
   safeValidateTypes,
@@ -3623,6 +3624,31 @@ var jsonValueSchema2 = z25.lazy(
     z25.record(z25.string(), jsonValueSchema2.optional())
   ])
 );
+var jsonObjectSchema = z25.record(z25.string(), jsonValueSchema2.optional());
+var openaiResponsesUsageSchema = z25.intersection(
+  jsonObjectSchema,
+  z25.object({
+    input_tokens: z25.number(),
+    input_tokens_details: z25.intersection(
+      jsonObjectSchema,
+      z25.object({
+        cached_tokens: z25.number().nullish(),
+        cache_write_tokens: z25.number().nullish(),
+        orchestration_input_tokens: z25.number().nullish(),
+        orchestration_input_cached_tokens: z25.number().nullish()
+      })
+    ).nullish(),
+    output_tokens: z25.number(),
+    output_tokens_details: z25.intersection(
+      jsonObjectSchema,
+      z25.object({
+        reasoning_tokens: z25.number().nullish(),
+        orchestration_output_tokens: z25.number().nullish()
+      })
+    ).nullish(),
+    total_tokens: z25.number().optional()
+  })
+);
 var openaiResponsesComputerSafetyCheckSchema = z25.object({
   id: z25.string(),
   code: z25.string().nullish(),
@@ -3819,20 +3845,7 @@ var openaiResponsesChunkSchema = lazySchema24(
         type: z25.enum(["response.completed", "response.incomplete"]),
         response: z25.object({
           incomplete_details: z25.object({ reason: z25.string() }).nullish(),
-          usage: z25.object({
-            input_tokens: z25.number(),
-            input_tokens_details: z25.object({
-              cached_tokens: z25.number().nullish(),
-              cache_write_tokens: z25.number().nullish(),
-              orchestration_input_tokens: z25.number().nullish(),
-              orchestration_input_cached_tokens: z25.number().nullish()
-            }).nullish(),
-            output_tokens: z25.number(),
-            output_tokens_details: z25.object({
-              reasoning_tokens: z25.number().nullish(),
-              orchestration_output_tokens: z25.number().nullish()
-            }).nullish()
-          }).nullish(),
+          usage: openaiResponsesUsageSchema.nullish(),
           reasoning: z25.object({
             context: z25.string().nullish()
           }).nullish(),
@@ -3848,20 +3861,7 @@ var openaiResponsesChunkSchema = lazySchema24(
             message: z25.string()
           }).nullish(),
           incomplete_details: z25.object({ reason: z25.string() }).nullish(),
-          usage: z25.object({
-            input_tokens: z25.number(),
-            input_tokens_details: z25.object({
-              cached_tokens: z25.number().nullish(),
-              cache_write_tokens: z25.number().nullish(),
-              orchestration_input_tokens: z25.number().nullish(),
-              orchestration_input_cached_tokens: z25.number().nullish()
-            }).nullish(),
-            output_tokens: z25.number(),
-            output_tokens_details: z25.object({
-              reasoning_tokens: z25.number().nullish(),
-              orchestration_output_tokens: z25.number().nullish()
-            }).nullish()
-          }).nullish(),
+          usage: openaiResponsesUsageSchema.nullish(),
           reasoning: z25.object({
             context: z25.string().nullish()
           }).nullish(),
@@ -4651,20 +4651,7 @@ var openaiResponsesResponseSchema = lazySchema24(
         context: z25.string().nullish()
       }).nullish(),
       incomplete_details: z25.object({ reason: z25.string() }).nullish(),
-      usage: z25.object({
-        input_tokens: z25.number(),
-        input_tokens_details: z25.object({
-          cached_tokens: z25.number().nullish(),
-          cache_write_tokens: z25.number().nullish(),
-          orchestration_input_tokens: z25.number().nullish(),
-          orchestration_input_cached_tokens: z25.number().nullish()
-        }).nullish(),
-        output_tokens: z25.number(),
-        output_tokens_details: z25.object({
-          reasoning_tokens: z25.number().nullish(),
-          orchestration_output_tokens: z25.number().nullish()
-        }).nullish()
-      }).nullish()
+      usage: openaiResponsesUsageSchema.nullish()
     })
   )
 );
@@ -8924,7 +8911,19 @@ function escapeJSONDelta(delta) {
 
 // src/openai-responses-batch.ts
 var openaiBatchEndpoint = "/v1/responses";
-var openaiBatchInputFileExpiresAfterSeconds = 48 * 60 * 60;
+var openaiBatchInputFileDefaultExpiresAfterSeconds = 48 * 60 * 60;
+var openaiBatchProviderOptionsSchema = lazySchema26(
+  () => zodSchema26(
+    z28.object({
+      /**
+       * TTL in seconds for the uploaded batch input file, measured from
+       * upload time. OpenAI accepts integers between 3600 (1 hour) and
+       * 2592000 (30 days) inclusive. Defaults to 48 hours.
+       */
+      inputFileExpiresAfter: z28.number().int().min(3600).max(2592e3).optional()
+    })
+  )
+);
 var openaiBatchResponseSchema = lazySchema26(
   () => zodSchema26(
     z28.object({
@@ -8971,7 +8970,7 @@ var OpenAIResponsesBatch = class {
     this.options = options;
   }
   async startBatch(options) {
-    var _a2, _b, _c, _d, _e;
+    var _a2, _b, _c, _d, _e, _f;
     const fileParts = [];
     const warnings = options.webhookUrl == null ? [] : [
       {
@@ -8982,6 +8981,10 @@ var OpenAIResponsesBatch = class {
         }
       }
     ];
+    const batchOptions = await this.parseBatchProviderOptions(
+      options.providerOptions
+    );
+    const inputFileExpiresAfterSeconds = (_a2 = batchOptions == null ? void 0 : batchOptions.inputFileExpiresAfter) != null ? _a2 : openaiBatchInputFileDefaultExpiresAfterSeconds;
     for (const request of options.requests) {
       const preparedRequest = await this.options.prepareRequest(request);
       fileParts.push(
@@ -8996,7 +8999,7 @@ var OpenAIResponsesBatch = class {
       for (const warning of preparedRequest.warnings) {
         warnings.push({ requestId: request.id, warning });
       }
-      for (const tool of (_a2 = request.options.tools) != null ? _a2 : []) {
+      for (const tool of (_b = request.options.tools) != null ? _b : []) {
         if (tool.type === "provider" && !openAIBatchConvertibleProviderToolIds.has(tool.id)) {
           warnings.push({
             requestId: request.id,
@@ -9020,19 +9023,17 @@ var OpenAIResponsesBatch = class {
     formData.append("expires_after[anchor]", "created_at");
     formData.append(
       "expires_after[seconds]",
-      String(openaiBatchInputFileExpiresAfterSeconds)
+      String(inputFileExpiresAfterSeconds)
     );
     const { value: uploadedFile } = await postToApi({
       url: this.getUrl("/files"),
-      headers: combineHeaders7((_c = (_b = this.options.config).headers) == null ? void 0 : _c.call(_b), options.headers),
+      headers: combineHeaders7((_d = (_c = this.options.config).headers) == null ? void 0 : _d.call(_c), options.headers),
       body: {
         content: formData,
         values: {
           purpose: "batch",
           "expires_after[anchor]": "created_at",
-          "expires_after[seconds]": String(
-            openaiBatchInputFileExpiresAfterSeconds
-          ),
+          "expires_after[seconds]": String(inputFileExpiresAfterSeconds),
           file: {
             name: filename,
             type: file.type,
@@ -9049,7 +9050,7 @@ var OpenAIResponsesBatch = class {
     });
     const { value: batch } = await postJsonToApi6({
       url: this.getUrl("/batches"),
-      headers: combineHeaders7((_e = (_d = this.options.config).headers) == null ? void 0 : _e.call(_d), options.headers),
+      headers: combineHeaders7((_f = (_e = this.options.config).headers) == null ? void 0 : _f.call(_e), options.headers),
       body: {
         input_file_id: uploadedFile.id,
         endpoint: openaiBatchEndpoint,
@@ -9062,12 +9063,35 @@ var OpenAIResponsesBatch = class {
       abortSignal: options.abortSignal,
       fetch: this.options.config.fetch
     });
+    const inputFileExpiresAt = convertUnixTimestamp(uploadedFile.expires_at);
     return {
       batchId: batch.id,
       ...convertOpenAIBatchStatus(batch),
+      providerMetadata: {
+        openai: {
+          inputFileId: uploadedFile.id,
+          ...inputFileExpiresAt != null ? { inputFileExpiresAt } : {}
+        }
+      },
       warnings
     };
   }
+  async parseBatchProviderOptions(providerOptions) {
+    const providerOptionsName = this.options.config.provider.includes("azure") ? "azure" : "openai";
+    let batchOptions = await parseProviderOptions8({
+      provider: providerOptionsName,
+      providerOptions,
+      schema: openaiBatchProviderOptionsSchema
+    });
+    if (batchOptions == null && providerOptionsName !== "openai") {
+      batchOptions = await parseProviderOptions8({
+        provider: "openai",
+        providerOptions,
+        schema: openaiBatchProviderOptionsSchema
+      });
+    }
+    return batchOptions;
+  }
   async getBatchStatus(options) {
     const batch = await this.retrieveBatch(options);
     return convertOpenAIBatchStatus(batch);
@@ -9896,7 +9920,7 @@ var OpenAIRealtimeModel = class {
 import {
   combineHeaders as combineHeaders8,
   createBinaryResponseHandler,
-  parseProviderOptions as parseProviderOptions8,
+  parseProviderOptions as parseProviderOptions9,
   postJsonToApi as postJsonToApi7,
   serializeModelOptions as serializeModelOptions6,
   WORKFLOW_DESERIALIZE as WORKFLOW_DESERIALIZE7,
@@ -9947,7 +9971,7 @@ var OpenAISpeechModel = class _OpenAISpeechModel {
     providerOptions
   }) {
     const warnings = [];
-    const openAIOptions = await parseProviderOptions8({
+    const openAIOptions = await parseProviderOptions9({
       provider: "openai",
       providerOptions,
       schema: openaiSpeechModelOptionsSchema
@@ -10039,7 +10063,7 @@ import {
   createJsonResponseHandler as createJsonResponseHandler8,
   connectToWebSocket,
   mediaTypeToExtension,
-  parseProviderOptions as parseProviderOptions9,
+  parseProviderOptions as parseProviderOptions10,
   postFormDataToApi as postFormDataToApi3,
   safeParseJSON as safeParseJSON2,
   serializeModelOptions as serializeModelOptions7,
@@ -10218,7 +10242,7 @@ var OpenAITranscriptionModel = class _OpenAITranscriptionModel {
     providerOptions
   }) {
     const warnings = [];
-    const openAIOptions = await parseProviderOptions9({
+    const openAIOptions = await parseProviderOptions10({
       provider: "openai",
       providerOptions,
       schema: openAITranscriptionModelOptions
@@ -10327,7 +10351,7 @@ var OpenAITranscriptionModel = class _OpenAITranscriptionModel {
       });
     }
     const currentDate = (_c = (_b = (_a2 = this.config._internal) == null ? void 0 : _a2.currentDate) == null ? void 0 : _b.call(_a2)) != null ? _c : /* @__PURE__ */ new Date();
-    const openAIOptions = await parseProviderOptions9({
+    const openAIOptions = await parseProviderOptions10({
       provider: "openai",
       providerOptions: options.providerOptions,
       schema: openAITranscriptionModelOptions
@@ -10569,7 +10593,7 @@ import {
   combineHeaders as combineHeaders10,
   connectToWebSocket as connectToWebSocket2,
   convertToBase64 as convertToBase644,
-  parseProviderOptions as parseProviderOptions10,
+  parseProviderOptions as parseProviderOptions11,
   safeParseJSON as safeParseJSON3,
   serializeModelOptions as serializeModelOptions8,
   toWebSocketUrl as toWebSocketUrl2,
@@ -10616,7 +10640,7 @@ var OpenAISpeechTranslationModel = class _OpenAISpeechTranslationModel {
       });
     }
     const currentDate = (_c = (_b = (_a2 = this.config._internal) == null ? void 0 : _a2.currentDate) == null ? void 0 : _b.call(_a2)) != null ? _c : /* @__PURE__ */ new Date();
-    await parseProviderOptions10({
+    await parseProviderOptions11({
       provider: "openai",
       providerOptions: options.providerOptions,
       schema: openAISpeechTranslationModelOptions
@@ -10963,7 +10987,7 @@ var OpenAISkills = class {
 };
 
 // src/version.ts
-var VERSION = true ? "4.0.55" : "0.0.0-test";
+var VERSION = true ? "4.0.57" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {