@ai-sdk/openai 2.0.26 → 2.0.28

package/dist/index.mjs

@@ -359,23 +359,11 @@ var compoundFilterSchema = z3.object({
 });
 var filtersSchema = z3.union([comparisonFilterSchema, compoundFilterSchema]);
 var fileSearchArgsSchema = z3.object({
-  /**
-   * List of vector store IDs to search through. If not provided, searches all available vector stores.
-   */
   vectorStoreIds: z3.array(z3.string()).optional(),
-  /**
-   * Maximum number of search results to return. Defaults to 10.
-   */
   maxNumResults: z3.number().optional(),
-  /**
-   * Ranking options for the search.
-   */
   ranking: z3.object({
     ranker: z3.enum(["auto", "default-2024-08-21"]).optional()
   }).optional(),
-  /**
-   * A filter to apply based on file attributes.
-   */
   filters: filtersSchema.optional()
 });
 var fileSearch = createProviderDefinedToolFactory({
@@ -1829,11 +1817,14 @@ var codeInterpreterArgsSchema = z11.object({
     })
   ]).optional()
 });
-var codeInterpreter = createProviderDefinedToolFactory3({
+var codeInterpreterToolFactory = createProviderDefinedToolFactory3({
   id: "openai.code_interpreter",
   name: "code_interpreter",
   inputSchema: z11.object({})
 });
+var codeInterpreter = (args = {}) => {
+  return codeInterpreterToolFactory(args);
+};
 
 // src/tool/web-search.ts
 import { createProviderDefinedToolFactory as createProviderDefinedToolFactory4 } from "@ai-sdk/provider-utils";
@@ -1851,7 +1842,7 @@ var webSearchArgsSchema = z12.object({
     timezone: z12.string().optional()
   }).optional()
 });
-var factory = createProviderDefinedToolFactory4({
+var webSearchToolFactory = createProviderDefinedToolFactory4({
   id: "openai.web_search",
   name: "web_search",
   inputSchema: z12.object({
@@ -1873,14 +1864,56 @@ var factory = createProviderDefinedToolFactory4({
   })
 });
 var webSearch = (args = {}) => {
-  return factory(args);
+  return webSearchToolFactory(args);
 };
 
 // src/openai-tools.ts
 var openaiTools = {
+  /**
+   * The Code Interpreter tool allows models to write and run Python code in a
+   * sandboxed environment to solve complex problems in domains like data analysis,
+   * coding, and math.
+   *
+   * @param container - The container to use for the code interpreter.
+   *
+   * Must have name `code_interpreter`.
+   */
   codeInterpreter,
+  /**
+   * File search is a tool available in the Responses API. It enables models to
+   * retrieve information in a knowledge base of previously uploaded files through
+   * semantic and keyword search.
+   *
+   * Must have name `file_search`.
+   *
+   * @param vectorStoreIds - The vector store IDs to use for the file search.
+   * @param maxNumResults - The maximum number of results to return.
+   * @param ranking - The ranking options to use for the file search.
+   * @param filters - The filters to use for the file search.
+   */
   fileSearch,
+  /**
+   * Web search allows models to access up-to-date information from the internet
+   * and provide answers with sourced citations.
+   *
+   * Must have name `web_search_preview`.
+   *
+   * @param searchContextSize - The search context size to use for the web search.
+   * @param userLocation - The user location to use for the web search.
+   *
+   * @deprecated Use `webSearch` instead.
+   */
   webSearchPreview,
+  /**
+   * Web search allows models to access up-to-date information from the internet
+   * and provide answers with sourced citations.
+   *
+   * Must have name `web_search`.
+   *
+   * @param filters - The filters to use for the web search.
+   * @param searchContextSize - The search context size to use for the web search.
+   * @param userLocation - The user location to use for the web search.
+   */
   webSearch
 };
 
@@ -2280,7 +2313,7 @@ var OpenAIResponsesLanguageModel = class {
     toolChoice,
     responseFormat
   }) {
-    var _a, _b;
+    var _a, _b, _c;
     const warnings = [];
     const modelConfig = getResponsesModelConfig(this.modelId);
     if (topK != null) {
@@ -2316,8 +2349,13 @@ var OpenAIResponsesLanguageModel = class {
       schema: openaiResponsesProviderOptionsSchema
     });
     const strictJsonSchema = (_a = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _a : false;
+    let include = openaiOptions == null ? void 0 : openaiOptions.include;
     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;
+    include = topLogprobs ? Array.isArray(include) ? [...include, "message.output_text.logprobs"] : ["message.output_text.logprobs"] : include;
+    const webSearchToolName = (_b = tools == null ? void 0 : tools.find(
+      (tool) => tool.type === "provider-defined" && (tool.id === "openai.web_search" || tool.id === "openai.web_search_preview")
+    )) == null ? void 0 : _b.name;
+    include = webSearchToolName ? Array.isArray(include) ? [...include, "web_search_call.action.sources"] : ["web_search_call.action.sources"] : include;
     const baseArgs = {
       model: this.modelId,
       input: messages,
@@ -2330,7 +2368,7 @@ var OpenAIResponsesLanguageModel = class {
             format: responseFormat.schema != null ? {
               type: "json_schema",
               strict: strictJsonSchema,
-              name: (_b = responseFormat.name) != null ? _b : "response",
+              name: (_c = responseFormat.name) != null ? _c : "response",
               description: responseFormat.description,
               schema: responseFormat.schema
             } : { type: "json_object" }
@@ -2348,7 +2386,7 @@ 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: openaiOptionsInclude,
+      include,
       prompt_cache_key: openaiOptions == null ? void 0 : openaiOptions.promptCacheKey,
       safety_identifier: openaiOptions == null ? void 0 : openaiOptions.safetyIdentifier,
       top_logprobs: topLogprobs,
@@ -2426,6 +2464,7 @@ var OpenAIResponsesLanguageModel = class {
       strictJsonSchema
     });
     return {
+      webSearchToolName,
       args: {
         ...baseArgs,
         tools: openaiTools2,
@@ -2436,7 +2475,11 @@ var OpenAIResponsesLanguageModel = class {
   }
   async doGenerate(options) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k, _l, _m, _n, _o, _p, _q;
-    const { args: body, warnings } = await this.getArgs(options);
+    const {
+      args: body,
+      warnings,
+      webSearchToolName
+    } = await this.getArgs(options);
     const url = this.config.url({
       path: "/responses",
       modelId: this.modelId
@@ -2487,12 +2530,18 @@ var OpenAIResponsesLanguageModel = class {
                           start_index: z14.number().nullish(),
                           end_index: z14.number().nullish(),
                           quote: z14.string().nullish()
+                        }),
+                        z14.object({
+                          type: z14.literal("container_file_citation")
                         })
                       ])
                     )
                   })
                 )
               }),
+              z14.object({
+                type: z14.literal("code_interpreter_call")
+              }),
               z14.object({
                 type: z14.literal("function_call"),
                 call_id: z14.string(),
@@ -2633,14 +2682,14 @@ var OpenAIResponsesLanguageModel = class {
           content.push({
             type: "tool-call",
             toolCallId: part.id,
-            toolName: "web_search_preview",
+            toolName: webSearchToolName != null ? webSearchToolName : "web_search",
             input: JSON.stringify({ action: part.action }),
             providerExecuted: true
           });
           content.push({
             type: "tool-result",
             toolCallId: part.id,
-            toolName: "web_search_preview",
+            toolName: webSearchToolName != null ? webSearchToolName : "web_search",
             result: { status: part.status },
             providerExecuted: true
           });
@@ -2725,7 +2774,11 @@ var OpenAIResponsesLanguageModel = class {
     };
   }
   async doStream(options) {
-    const { args: body, warnings } = await this.getArgs(options);
+    const {
+      args: body,
+      warnings,
+      webSearchToolName
+    } = await this.getArgs(options);
     const { responseHeaders, value: response } = await postJsonToApi5({
       url: this.config.url({
         path: "/responses",
@@ -2786,13 +2839,13 @@ var OpenAIResponsesLanguageModel = class {
                 });
               } else if (value.item.type === "web_search_call") {
                 ongoingToolCalls[value.output_index] = {
-                  toolName: "web_search_preview",
+                  toolName: webSearchToolName != null ? webSearchToolName : "web_search",
                   toolCallId: value.item.id
                 };
                 controller.enqueue({
                   type: "tool-input-start",
                   id: value.item.id,
-                  toolName: "web_search_preview"
+                  toolName: webSearchToolName != null ? webSearchToolName : "web_search"
                 });
               } else if (value.item.type === "computer_call") {
                 ongoingToolCalls[value.output_index] = {