@ai-sdk/openai 3.0.6 → 3.0.8

package/dist/index.d.ts

@@ -160,6 +160,352 @@ type OpenAIResponsesFileSearchToolCompoundFilter = {
      */
     filters: Array<OpenAIResponsesFileSearchToolComparisonFilter | OpenAIResponsesFileSearchToolCompoundFilter>;
 };
+declare const openaiResponsesChunkSchema: _ai_sdk_provider_utils.LazySchema<{
+    type: "unknown_chunk";
+    message: string;
+} | {
+    type: "response.output_text.delta";
+    item_id: string;
+    delta: string;
+    logprobs?: {
+        token: string;
+        logprob: number;
+        top_logprobs: {
+            token: string;
+            logprob: number;
+        }[];
+    }[] | null | undefined;
+} | {
+    type: "response.completed" | "response.incomplete";
+    response: {
+        usage: {
+            input_tokens: number;
+            output_tokens: number;
+            input_tokens_details?: {
+                cached_tokens?: number | null | undefined;
+            } | null | undefined;
+            output_tokens_details?: {
+                reasoning_tokens?: number | null | undefined;
+            } | null | undefined;
+        };
+        incomplete_details?: {
+            reason: string;
+        } | null | undefined;
+        service_tier?: string | null | undefined;
+    };
+} | {
+    type: "response.created";
+    response: {
+        id: string;
+        created_at: number;
+        model: string;
+        service_tier?: string | null | undefined;
+    };
+} | {
+    type: "response.output_item.added";
+    output_index: number;
+    item: {
+        type: "message";
+        id: string;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+    } | {
+        type: "web_search_call";
+        id: string;
+        status: string;
+    } | {
+        type: "computer_call";
+        id: string;
+        status: string;
+    } | {
+        type: "file_search_call";
+        id: string;
+    } | {
+        type: "image_generation_call";
+        id: string;
+    } | {
+        type: "code_interpreter_call";
+        id: string;
+        container_id: string;
+        code: string | null;
+        outputs: ({
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        })[] | null;
+        status: string;
+    } | {
+        type: "mcp_call";
+        id: string;
+        status: string;
+        approval_request_id?: string | null | undefined;
+    } | {
+        type: "mcp_list_tools";
+        id: string;
+    } | {
+        type: "mcp_approval_request";
+        id: string;
+    } | {
+        type: "apply_patch_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress";
+        operation: {
+            type: "create_file";
+            path: string;
+            diff: string;
+        } | {
+            type: "delete_file";
+            path: string;
+        } | {
+            type: "update_file";
+            path: string;
+            diff: string;
+        };
+    } | {
+        type: "shell_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress" | "incomplete";
+        action: {
+            commands: string[];
+        };
+    };
+} | {
+    type: "response.output_item.done";
+    output_index: number;
+    item: {
+        type: "message";
+        id: string;
+    } | {
+        type: "reasoning";
+        id: string;
+        encrypted_content?: string | null | undefined;
+    } | {
+        type: "function_call";
+        id: string;
+        call_id: string;
+        name: string;
+        arguments: string;
+        status: "completed";
+    } | {
+        type: "code_interpreter_call";
+        id: string;
+        code: string | null;
+        container_id: string;
+        outputs: ({
+            type: "logs";
+            logs: string;
+        } | {
+            type: "image";
+            url: string;
+        })[] | null;
+    } | {
+        type: "image_generation_call";
+        id: string;
+        result: string;
+    } | {
+        type: "web_search_call";
+        id: string;
+        status: string;
+        action: {
+            type: "search";
+            query?: string | null | undefined;
+            sources?: ({
+                type: "url";
+                url: string;
+            } | {
+                type: "api";
+                name: string;
+            })[] | null | undefined;
+        } | {
+            type: "open_page";
+            url?: string | null | undefined;
+        } | {
+            type: "find_in_page";
+            url?: string | null | undefined;
+            pattern?: string | null | undefined;
+        };
+    } | {
+        type: "file_search_call";
+        id: string;
+        queries: string[];
+        results?: {
+            attributes: Record<string, string | number | boolean>;
+            file_id: string;
+            filename: string;
+            score: number;
+            text: string;
+        }[] | null | undefined;
+    } | {
+        type: "local_shell_call";
+        id: string;
+        call_id: string;
+        action: {
+            type: "exec";
+            command: string[];
+            timeout_ms?: number | undefined;
+            user?: string | undefined;
+            working_directory?: string | undefined;
+            env?: Record<string, string> | undefined;
+        };
+    } | {
+        type: "computer_call";
+        id: string;
+        status: "completed";
+    } | {
+        type: "mcp_call";
+        id: string;
+        status: string;
+        arguments: string;
+        name: string;
+        server_label: string;
+        output?: string | null | undefined;
+        error?: string | {
+            [x: string]: unknown;
+            type?: string | undefined;
+            code?: string | number | undefined;
+            message?: string | undefined;
+        } | null | undefined;
+        approval_request_id?: string | null | undefined;
+    } | {
+        type: "mcp_list_tools";
+        id: string;
+        server_label: string;
+        tools: {
+            name: string;
+            input_schema: any;
+            description?: string | undefined;
+            annotations?: Record<string, unknown> | undefined;
+        }[];
+        error?: string | {
+            [x: string]: unknown;
+            type?: string | undefined;
+            code?: string | number | undefined;
+            message?: string | undefined;
+        } | undefined;
+    } | {
+        type: "mcp_approval_request";
+        id: string;
+        server_label: string;
+        name: string;
+        arguments: string;
+        approval_request_id?: string | undefined;
+    } | {
+        type: "apply_patch_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress";
+        operation: {
+            type: "create_file";
+            path: string;
+            diff: string;
+        } | {
+            type: "delete_file";
+            path: string;
+        } | {
+            type: "update_file";
+            path: string;
+            diff: string;
+        };
+    } | {
+        type: "shell_call";
+        id: string;
+        call_id: string;
+        status: "completed" | "in_progress" | "incomplete";
+        action: {
+            commands: string[];
+        };
+    };
+} | {
+    type: "response.function_call_arguments.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
+} | {
+    type: "response.image_generation_call.partial_image";
+    item_id: string;
+    output_index: number;
+    partial_image_b64: string;
+} | {
+    type: "response.code_interpreter_call_code.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
+} | {
+    type: "response.code_interpreter_call_code.done";
+    item_id: string;
+    output_index: number;
+    code: string;
+} | {
+    type: "response.output_text.annotation.added";
+    annotation: {
+        type: "url_citation";
+        start_index: number;
+        end_index: number;
+        url: string;
+        title: string;
+    } | {
+        type: "file_citation";
+        file_id: string;
+        filename: string;
+        index: number;
+    } | {
+        type: "container_file_citation";
+        container_id: string;
+        file_id: string;
+        filename: string;
+        start_index: number;
+        end_index: number;
+    } | {
+        type: "file_path";
+        file_id: string;
+        index: number;
+    };
+} | {
+    type: "response.reasoning_summary_part.added";
+    item_id: string;
+    summary_index: number;
+} | {
+    type: "response.reasoning_summary_text.delta";
+    item_id: string;
+    summary_index: number;
+    delta: string;
+} | {
+    type: "response.reasoning_summary_part.done";
+    item_id: string;
+    summary_index: number;
+} | {
+    type: "response.apply_patch_call_operation_diff.delta";
+    item_id: string;
+    output_index: number;
+    delta: string;
+    obfuscation?: string | null | undefined;
+} | {
+    type: "response.apply_patch_call_operation_diff.done";
+    item_id: string;
+    output_index: number;
+    diff: string;
+} | {
+    type: "error";
+    sequence_number: number;
+    error: {
+        type: string;
+        code: string;
+        message: string;
+        param?: string | null | undefined;
+    };
+}>;
 
 /**
  * Type definitions for the apply_patch operations.
@@ -559,6 +905,34 @@ Default OpenAI provider instance.
  */
 declare const openai: OpenAIProvider;
 
+type OpenaiResponsesChunk = InferSchema<typeof openaiResponsesChunkSchema>;
+type ResponsesOutputTextAnnotationProviderMetadata = Extract<OpenaiResponsesChunk, {
+    type: 'response.output_text.annotation.added';
+}>['annotation'];
+type ResponsesTextProviderMetadata = {
+    itemId: string;
+    annotations?: Array<ResponsesOutputTextAnnotationProviderMetadata>;
+};
+type OpenaiResponsesTextProviderMetadata = {
+    openai: ResponsesTextProviderMetadata;
+};
+type ResponsesSourceDocumentProviderMetadata = {
+    type: 'file_citation';
+    fileId: string;
+    index: number;
+} | {
+    type: 'container_file_citation';
+    fileId: string;
+    containerId: string;
+} | {
+    type: 'file_path';
+    fileId: string;
+    index: number;
+};
+type OpenaiResponsesSourceDocumentProviderMetadata = {
+    openai: ResponsesSourceDocumentProviderMetadata;
+};
+
 declare const VERSION: string;
 
-export { type OpenAIChatLanguageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, VERSION, createOpenAI, openai };
+export { type OpenAIChatLanguageModelOptions, type OpenAIProvider, type OpenAIProviderSettings, type OpenAIResponsesProviderOptions, type OpenaiResponsesSourceDocumentProviderMetadata, type OpenaiResponsesTextProviderMetadata, VERSION, createOpenAI, openai };

package/dist/index.js

@@ -1751,11 +1751,16 @@ var modelMaxImagesPerCall = {
   "gpt-image-1-mini": 10,
   "gpt-image-1.5": 10
 };
-var hasDefaultResponseFormat = /* @__PURE__ */ new Set([
-  "gpt-image-1",
+var defaultResponseFormatPrefixes = [
   "gpt-image-1-mini",
-  "gpt-image-1.5"
-]);
+  "gpt-image-1.5",
+  "gpt-image-1"
+];
+function hasDefaultResponseFormat(modelId) {
+  return defaultResponseFormatPrefixes.some(
+    (prefix) => modelId.startsWith(prefix)
+  );
+}
 
 // src/image/openai-image-model.ts
 var OpenAIImageModel = class {
@@ -1874,7 +1879,7 @@ var OpenAIImageModel = class {
         n,
         size,
         ...(_h = providerOptions.openai) != null ? _h : {},
-        ...!hasDefaultResponseFormat.has(this.modelId) ? { response_format: "b64_json" } : {}
+        ...!hasDefaultResponseFormat(this.modelId) ? { response_format: "b64_json" } : {}
       },
       failedResponseHandler: openaiFailedResponseHandler,
       successfulResponseHandler: (0, import_provider_utils13.createJsonResponseHandler)(
@@ -3231,25 +3236,21 @@ var openaiResponsesChunkSchema = (0, import_provider_utils24.lazySchema)(
           import_v419.z.object({
             type: import_v419.z.literal("file_citation"),
             file_id: import_v419.z.string(),
-            filename: import_v419.z.string().nullish(),
-            index: import_v419.z.number().nullish(),
-            start_index: import_v419.z.number().nullish(),
-            end_index: import_v419.z.number().nullish(),
-            quote: import_v419.z.string().nullish()
+            filename: import_v419.z.string(),
+            index: import_v419.z.number()
           }),
           import_v419.z.object({
             type: import_v419.z.literal("container_file_citation"),
             container_id: import_v419.z.string(),
             file_id: import_v419.z.string(),
-            filename: import_v419.z.string().nullish(),
-            start_index: import_v419.z.number().nullish(),
-            end_index: import_v419.z.number().nullish(),
-            index: import_v419.z.number().nullish()
+            filename: import_v419.z.string(),
+            start_index: import_v419.z.number(),
+            end_index: import_v419.z.number()
           }),
           import_v419.z.object({
             type: import_v419.z.literal("file_path"),
             file_id: import_v419.z.string(),
-            index: import_v419.z.number().nullish()
+            index: import_v419.z.number()
           })
         ])
       }),
@@ -3346,25 +3347,21 @@ var openaiResponsesResponseSchema = (0, import_provider_utils24.lazySchema)(
                     import_v419.z.object({
                       type: import_v419.z.literal("file_citation"),
                       file_id: import_v419.z.string(),
-                      filename: import_v419.z.string().nullish(),
-                      index: import_v419.z.number().nullish(),
-                      start_index: import_v419.z.number().nullish(),
-                      end_index: import_v419.z.number().nullish(),
-                      quote: import_v419.z.string().nullish()
+                      filename: import_v419.z.string(),
+                      index: import_v419.z.number()
                     }),
                     import_v419.z.object({
                       type: import_v419.z.literal("container_file_citation"),
                       container_id: import_v419.z.string(),
                       file_id: import_v419.z.string(),
-                      filename: import_v419.z.string().nullish(),
-                      start_index: import_v419.z.number().nullish(),
-                      end_index: import_v419.z.number().nullish(),
-                      index: import_v419.z.number().nullish()
+                      filename: import_v419.z.string(),
+                      start_index: import_v419.z.number(),
+                      end_index: import_v419.z.number()
                     }),
                     import_v419.z.object({
                       type: import_v419.z.literal("file_path"),
                       file_id: import_v419.z.string(),
-                      index: import_v419.z.number().nullish()
+                      index: import_v419.z.number()
                     })
                   ])
                 )
@@ -4230,7 +4227,7 @@ var OpenAIResponsesLanguageModel = class {
     };
   }
   async doGenerate(options) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D, _E;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
     const {
       args: body,
       warnings,
@@ -4377,29 +4374,29 @@ var OpenAIResponsesLanguageModel = class {
                   sourceType: "document",
                   id: (_i = (_h = (_g = this.config).generateId) == null ? void 0 : _h.call(_g)) != null ? _i : (0, import_provider_utils27.generateId)(),
                   mediaType: "text/plain",
-                  title: (_k = (_j = annotation.quote) != null ? _j : annotation.filename) != null ? _k : "Document",
-                  filename: (_l = annotation.filename) != null ? _l : annotation.file_id,
-                  ...annotation.file_id ? {
-                    providerMetadata: {
-                      [providerOptionsName]: {
-                        fileId: annotation.file_id
-                      }
+                  title: annotation.filename,
+                  filename: annotation.filename,
+                  providerMetadata: {
+                    [providerOptionsName]: {
+                      type: annotation.type,
+                      fileId: annotation.file_id,
+                      index: annotation.index
                     }
-                  } : {}
+                  }
                 });
               } else if (annotation.type === "container_file_citation") {
                 content.push({
                   type: "source",
                   sourceType: "document",
-                  id: (_o = (_n = (_m = this.config).generateId) == null ? void 0 : _n.call(_m)) != null ? _o : (0, import_provider_utils27.generateId)(),
+                  id: (_l = (_k = (_j = this.config).generateId) == null ? void 0 : _k.call(_j)) != null ? _l : (0, import_provider_utils27.generateId)(),
                   mediaType: "text/plain",
-                  title: (_q = (_p = annotation.filename) != null ? _p : annotation.file_id) != null ? _q : "Document",
-                  filename: (_r = annotation.filename) != null ? _r : annotation.file_id,
+                  title: annotation.filename,
+                  filename: annotation.filename,
                   providerMetadata: {
                     [providerOptionsName]: {
+                      type: annotation.type,
                       fileId: annotation.file_id,
-                      containerId: annotation.container_id,
-                      ...annotation.index != null ? { index: annotation.index } : {}
+                      containerId: annotation.container_id
                     }
                   }
                 });
@@ -4407,14 +4404,15 @@ var OpenAIResponsesLanguageModel = class {
                 content.push({
                   type: "source",
                   sourceType: "document",
-                  id: (_u = (_t = (_s = this.config).generateId) == null ? void 0 : _t.call(_s)) != null ? _u : (0, import_provider_utils27.generateId)(),
+                  id: (_o = (_n = (_m = this.config).generateId) == null ? void 0 : _n.call(_m)) != null ? _o : (0, import_provider_utils27.generateId)(),
                   mediaType: "application/octet-stream",
                   title: annotation.file_id,
                   filename: annotation.file_id,
                   providerMetadata: {
                     [providerOptionsName]: {
+                      type: annotation.type,
                       fileId: annotation.file_id,
-                      ...annotation.index != null ? { index: annotation.index } : {}
+                      index: annotation.index
                     }
                   }
                 });
@@ -4459,7 +4457,7 @@ var OpenAIResponsesLanguageModel = class {
           break;
         }
         case "mcp_call": {
-          const toolCallId = part.approval_request_id != null ? (_v = approvalRequestIdToDummyToolCallIdFromPrompt[part.approval_request_id]) != null ? _v : part.id : part.id;
+          const toolCallId = part.approval_request_id != null ? (_p = approvalRequestIdToDummyToolCallIdFromPrompt[part.approval_request_id]) != null ? _p : part.id : part.id;
           const toolName = `mcp.${part.name}`;
           content.push({
             type: "tool-call",
@@ -4493,8 +4491,8 @@ var OpenAIResponsesLanguageModel = class {
           break;
         }
         case "mcp_approval_request": {
-          const approvalRequestId = (_w = part.approval_request_id) != null ? _w : part.id;
-          const dummyToolCallId = (_z = (_y = (_x = this.config).generateId) == null ? void 0 : _y.call(_x)) != null ? _z : (0, import_provider_utils27.generateId)();
+          const approvalRequestId = (_q = part.approval_request_id) != null ? _q : part.id;
+          const dummyToolCallId = (_t = (_s = (_r = this.config).generateId) == null ? void 0 : _s.call(_r)) != null ? _t : (0, import_provider_utils27.generateId)();
           const toolName = `mcp.${part.name}`;
           content.push({
             type: "tool-call",
@@ -4544,13 +4542,13 @@ var OpenAIResponsesLanguageModel = class {
             toolName: toolNameMapping.toCustomToolName("file_search"),
             result: {
               queries: part.queries,
-              results: (_B = (_A = part.results) == null ? void 0 : _A.map((result) => ({
+              results: (_v = (_u = part.results) == null ? void 0 : _u.map((result) => ({
                 attributes: result.attributes,
                 fileId: result.file_id,
                 filename: result.filename,
                 score: result.score,
                 text: result.text
-              }))) != null ? _B : null
+              }))) != null ? _v : null
             }
           });
           break;
@@ -4609,10 +4607,10 @@ var OpenAIResponsesLanguageModel = class {
       content,
       finishReason: {
         unified: mapOpenAIResponseFinishReason({
-          finishReason: (_C = response.incomplete_details) == null ? void 0 : _C.reason,
+          finishReason: (_w = response.incomplete_details) == null ? void 0 : _w.reason,
           hasFunctionCall
         }),
-        raw: (_E = (_D = response.incomplete_details) == null ? void 0 : _D.reason) != null ? _E : void 0
+        raw: (_y = (_x = response.incomplete_details) == null ? void 0 : _x.reason) != null ? _y : void 0
       },
       usage: convertOpenAIResponsesUsage(usage),
       request: { body },
@@ -4675,7 +4673,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, _n, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _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, _s, _t, _u, _v, _w, _x, _y, _z, _A, _B, _C, _D;
             if (options.includeRawChunks) {
               controller.enqueue({ type: "raw", rawValue: chunk.rawValue });
             }
@@ -5272,29 +5270,29 @@ var OpenAIResponsesLanguageModel = class {
                   sourceType: "document",
                   id: (_x = (_w = (_v = self.config).generateId) == null ? void 0 : _w.call(_v)) != null ? _x : (0, import_provider_utils27.generateId)(),
                   mediaType: "text/plain",
-                  title: (_z = (_y = value.annotation.quote) != null ? _y : value.annotation.filename) != null ? _z : "Document",
-                  filename: (_A = value.annotation.filename) != null ? _A : value.annotation.file_id,
-                  ...value.annotation.file_id ? {
-                    providerMetadata: {
-                      [providerOptionsName]: {
-                        fileId: value.annotation.file_id
-                      }
+                  title: value.annotation.filename,
+                  filename: value.annotation.filename,
+                  providerMetadata: {
+                    [providerOptionsName]: {
+                      type: value.annotation.type,
+                      fileId: value.annotation.file_id,
+                      index: value.annotation.index
                     }
-                  } : {}
+                  }
                 });
               } else if (value.annotation.type === "container_file_citation") {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_D = (_C = (_B = self.config).generateId) == null ? void 0 : _C.call(_B)) != null ? _D : (0, import_provider_utils27.generateId)(),
+                  id: (_A = (_z = (_y = self.config).generateId) == null ? void 0 : _z.call(_y)) != null ? _A : (0, import_provider_utils27.generateId)(),
                   mediaType: "text/plain",
-                  title: (_F = (_E = value.annotation.filename) != null ? _E : value.annotation.file_id) != null ? _F : "Document",
-                  filename: (_G = value.annotation.filename) != null ? _G : value.annotation.file_id,
+                  title: value.annotation.filename,
+                  filename: value.annotation.filename,
                   providerMetadata: {
                     [providerOptionsName]: {
+                      type: value.annotation.type,
                       fileId: value.annotation.file_id,
-                      containerId: value.annotation.container_id,
-                      ...value.annotation.index != null ? { index: value.annotation.index } : {}
+                      containerId: value.annotation.container_id
                     }
                   }
                 });
@@ -5302,14 +5300,15 @@ var OpenAIResponsesLanguageModel = class {
                 controller.enqueue({
                   type: "source",
                   sourceType: "document",
-                  id: (_J = (_I = (_H = self.config).generateId) == null ? void 0 : _I.call(_H)) != null ? _J : (0, import_provider_utils27.generateId)(),
+                  id: (_D = (_C = (_B = self.config).generateId) == null ? void 0 : _C.call(_B)) != null ? _D : (0, import_provider_utils27.generateId)(),
                   mediaType: "application/octet-stream",
                   title: value.annotation.file_id,
                   filename: value.annotation.file_id,
                   providerMetadata: {
                     [providerOptionsName]: {
+                      type: value.annotation.type,
                       fileId: value.annotation.file_id,
-                      ...value.annotation.index != null ? { index: value.annotation.index } : {}
+                      index: value.annotation.index
                     }
                   }
                 });
@@ -5761,7 +5760,7 @@ var OpenAITranscriptionModel = class {
 };
 
 // src/version.ts
-var VERSION = true ? "3.0.6" : "0.0.0-test";
+var VERSION = true ? "3.0.8" : "0.0.0-test";
 
 // src/openai-provider.ts
 function createOpenAI(options = {}) {