@ai-sdk/openai 4.0.65 → 4.0.67

package/dist/internal/index.d.ts

@@ -123,6 +123,13 @@ type OpenAIConfig = {
      * @see https://github.com/vercel/ai/issues/20180
      */
     explicitMessageItemType?: boolean;
+    /**
+     * Whether the provider supports the
+     * `web_search_call.action.sources` Responses API include value.
+     *
+     * Defaults to `true`.
+     */
+    supportsWebSearchSourcesInclude?: boolean;
     /**
      * This is soft-deprecated. Use provider references (e.g. `{ openai: 'file-abc123' }`)
      * in file part data instead. File ID prefixes used to identify file IDs

package/dist/internal/index.js

@@ -909,9 +909,119 @@ var openaiLanguageModelChatOptions = lazySchema2(
 );
 
 // src/chat/openai-chat-prepare-tools.ts
+import {
+  UnsupportedFunctionalityError as UnsupportedFunctionalityError3
+} from "@ai-sdk/provider";
+
+// src/normalize-openai-json-schema.ts
 import {
   UnsupportedFunctionalityError as UnsupportedFunctionalityError2
 } from "@ai-sdk/provider";
+function normalizeOpenAIJsonSchema(schema) {
+  let removedPropertyNames = false;
+  const normalizedSchema = normalizeSchema(schema);
+  return {
+    schema: normalizedSchema,
+    warnings: removedPropertyNames ? [
+      {
+        type: "compatibility",
+        feature: "JSON Schema propertyNames",
+        details: "OpenAI does not support JSON Schema propertyNames. It was removed before sending the schema, so OpenAI will not enforce property-name constraints."
+      }
+    ] : []
+  };
+  function normalizeSchema(schema2) {
+    const propertyNames = schema2.propertyNames;
+    if (propertyNames != null) {
+      if (typeof propertyNames === "boolean" || propertyNames.type !== "string") {
+        throw new UnsupportedFunctionalityError2({
+          functionality: "JSON Schema propertyNames that does not use a string schema"
+        });
+      }
+      removedPropertyNames = true;
+    }
+    const normalizedSchema2 = { ...schema2 };
+    delete normalizedSchema2.propertyNames;
+    if (normalizedSchema2.properties != null) {
+      normalizedSchema2.properties = normalizeSchemaRecord(
+        normalizedSchema2.properties
+      );
+    }
+    if (normalizedSchema2.patternProperties != null) {
+      normalizedSchema2.patternProperties = normalizeSchemaRecord(
+        normalizedSchema2.patternProperties
+      );
+    }
+    if (normalizedSchema2.additionalProperties != null) {
+      normalizedSchema2.additionalProperties = normalizeDefinition(
+        normalizedSchema2.additionalProperties
+      );
+    }
+    if (normalizedSchema2.additionalItems != null) {
+      normalizedSchema2.additionalItems = normalizeDefinition(
+        normalizedSchema2.additionalItems
+      );
+    }
+    if (normalizedSchema2.items != null) {
+      normalizedSchema2.items = Array.isArray(normalizedSchema2.items) ? normalizedSchema2.items.map(normalizeDefinition) : normalizeDefinition(normalizedSchema2.items);
+    }
+    if (normalizedSchema2.contains != null) {
+      normalizedSchema2.contains = normalizeDefinition(
+        normalizedSchema2.contains
+      );
+    }
+    if (normalizedSchema2.not != null) {
+      normalizedSchema2.not = normalizeDefinition(normalizedSchema2.not);
+    }
+    if (normalizedSchema2.allOf != null) {
+      normalizedSchema2.allOf = normalizedSchema2.allOf.map(normalizeDefinition);
+    }
+    if (normalizedSchema2.anyOf != null) {
+      normalizedSchema2.anyOf = normalizedSchema2.anyOf.map(normalizeDefinition);
+    }
+    if (normalizedSchema2.oneOf != null) {
+      normalizedSchema2.oneOf = normalizedSchema2.oneOf.map(normalizeDefinition);
+    }
+    if (normalizedSchema2.definitions != null) {
+      normalizedSchema2.definitions = normalizeSchemaRecord(
+        normalizedSchema2.definitions
+      );
+    }
+    if (normalizedSchema2.$defs != null) {
+      normalizedSchema2.$defs = normalizeSchemaRecord(normalizedSchema2.$defs);
+    }
+    if (normalizedSchema2.dependencies != null) {
+      normalizedSchema2.dependencies = Object.fromEntries(
+        Object.entries(normalizedSchema2.dependencies).map(
+          ([key, dependency]) => [
+            key,
+            Array.isArray(dependency) ? dependency : normalizeDefinition(dependency)
+          ]
+        )
+      );
+    }
+    for (const keyword of ["if", "then", "else"]) {
+      const conditionalSchema = normalizedSchema2[keyword];
+      if (conditionalSchema != null) {
+        normalizedSchema2[keyword] = normalizeDefinition(conditionalSchema);
+      }
+    }
+    return normalizedSchema2;
+  }
+  function normalizeSchemaRecord(schemas) {
+    return Object.fromEntries(
+      Object.entries(schemas).map(([key, schema2]) => [
+        key,
+        normalizeDefinition(schema2)
+      ])
+    );
+  }
+  function normalizeDefinition(definition) {
+    return typeof definition === "boolean" ? definition : normalizeSchema(definition);
+  }
+}
+
+// src/chat/openai-chat-prepare-tools.ts
 function prepareChatTools({
   tools,
   toolChoice
@@ -924,17 +1034,22 @@ function prepareChatTools({
   const openaiTools = [];
   for (const tool of tools) {
     switch (tool.type) {
-      case "function":
+      case "function": {
+        const normalizedInputSchema = normalizeOpenAIJsonSchema(
+          tool.inputSchema
+        );
+        toolWarnings.push(...normalizedInputSchema.warnings);
         openaiTools.push({
           type: "function",
           function: {
             name: tool.name,
             description: tool.description,
-            parameters: tool.inputSchema,
+            parameters: normalizedInputSchema.schema,
             ...tool.strict != null ? { strict: tool.strict } : {}
           }
         });
         break;
+      }
       default:
         toolWarnings.push({
           type: "unsupported",
@@ -965,7 +1080,7 @@ function prepareChatTools({
       };
     default: {
       const _exhaustiveCheck = type;
-      throw new UnsupportedFunctionalityError2({
+      throw new UnsupportedFunctionalityError3({
         functionality: `tool choice type: ${_exhaustiveCheck}`
       });
     }
@@ -1041,6 +1156,10 @@ var OpenAIChatLanguageModel = class _OpenAIChatLanguageModel {
     );
     warnings.push(...messageWarnings);
     const strictJsonSchema = (_e = openaiOptions.strictJsonSchema) != null ? _e : true;
+    const normalizedResponseFormatSchema = (responseFormat == null ? void 0 : responseFormat.type) === "json" && responseFormat.schema != null ? normalizeOpenAIJsonSchema(responseFormat.schema) : void 0;
+    if (normalizedResponseFormatSchema != null) {
+      warnings.push(...normalizedResponseFormatSchema.warnings);
+    }
     const baseArgs = {
       // model id:
       model: this.modelId,
@@ -1056,10 +1175,10 @@ var OpenAIChatLanguageModel = class _OpenAIChatLanguageModel {
       top_p: topP,
       frequency_penalty: frequencyPenalty,
       presence_penalty: presencePenalty,
-      response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? responseFormat.schema != null ? {
+      response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? normalizedResponseFormatSchema != null ? {
         type: "json_schema",
         json_schema: {
-          schema: responseFormat.schema,
+          schema: normalizedResponseFormatSchema.schema,
           strict: strictJsonSchema,
           name: (_f = responseFormat.name) != null ? _f : "response",
           description: responseFormat.description
@@ -1476,7 +1595,7 @@ function convertOpenAICompletionUsage(usage) {
 // src/completion/convert-to-openai-completion-prompt.ts
 import {
   InvalidPromptError,
-  UnsupportedFunctionalityError as UnsupportedFunctionalityError3
+  UnsupportedFunctionalityError as UnsupportedFunctionalityError4
 } from "@ai-sdk/provider";
 function convertToOpenAICompletionPrompt({
   prompt,
@@ -1519,7 +1638,7 @@ ${userMessage}
               return part.text;
             }
             case "tool-call": {
-              throw new UnsupportedFunctionalityError3({
+              throw new UnsupportedFunctionalityError4({
                 functionality: "tool-call messages"
               });
             }
@@ -1532,7 +1651,7 @@ ${assistantMessage}
         break;
       }
       case "tool": {
-        throw new UnsupportedFunctionalityError3({
+        throw new UnsupportedFunctionalityError4({
           functionality: "tool messages"
         });
       }
@@ -2424,7 +2543,7 @@ async function fileToBlob(file) {
 
 // src/transcription/openai-transcription-model.ts
 import {
-  UnsupportedFunctionalityError as UnsupportedFunctionalityError4
+  UnsupportedFunctionalityError as UnsupportedFunctionalityError5
 } from "@ai-sdk/provider";
 import {
   combineHeaders as combineHeaders5,
@@ -2714,7 +2833,7 @@ var OpenAITranscriptionModel = class _OpenAITranscriptionModel {
   async doGenerate(options) {
     var _a2, _b, _c, _d, _e, _f, _g, _h, _i, _j, _k;
     if (isRealtimeTranscriptionModelId(this.modelId)) {
-      throw new UnsupportedFunctionalityError4({
+      throw new UnsupportedFunctionalityError5({
         functionality: `non-streaming transcription with ${this.modelId}`
       });
     }
@@ -2781,7 +2900,7 @@ var OpenAITranscriptionModel = class _OpenAITranscriptionModel {
   async doStream(options) {
     var _a2, _b, _c, _d, _e, _f, _g;
     if (!isRealtimeTranscriptionModelId(this.modelId)) {
-      throw new UnsupportedFunctionalityError4({
+      throw new UnsupportedFunctionalityError5({
         functionality: `streaming transcription with ${this.modelId}`
       });
     }
@@ -3226,7 +3345,7 @@ function convertOpenAIResponsesUsage(usage) {
 
 // src/responses/convert-to-openai-responses-input.ts
 import {
-  UnsupportedFunctionalityError as UnsupportedFunctionalityError5
+  UnsupportedFunctionalityError as UnsupportedFunctionalityError6
 } from "@ai-sdk/provider";
 import {
   convertToBase64 as convertToBase643,
@@ -4006,7 +4125,7 @@ async function convertToOpenAIResponsesInput({
                     };
                   }
                   case "text": {
-                    throw new UnsupportedFunctionalityError5({
+                    throw new UnsupportedFunctionalityError6({
                       functionality: "text file parts"
                     });
                   }
@@ -4036,7 +4155,7 @@ async function convertToOpenAIResponsesInput({
                       }
                       const fullMediaType = resolveFullMediaType2({ part });
                       if (fullMediaType !== "application/pdf" && !passThroughUnsupportedFiles) {
-                        throw new UnsupportedFunctionalityError5({
+                        throw new UnsupportedFunctionalityError6({
                           functionality: `file part media type ${fullMediaType}`
                         });
                       }
@@ -4772,7 +4891,7 @@ ${text}`,
           }
           const resultCaller = (_P = (_O = part.providerOptions) == null ? void 0 : _O[providerOptionsName]) == null ? void 0 : _P.caller;
           if (output.type === "execution-denied" && ((resultCaller == null ? void 0 : resultCaller.type) === "program" || programmaticToolCallIds.has(part.toolCallId))) {
-            throw new UnsupportedFunctionalityError5({
+            throw new UnsupportedFunctionalityError6({
               functionality: "execution-denied results for programmatic tool calls"
             });
           }
@@ -5996,6 +6115,14 @@ var openaiLanguageModelResponsesOptionsSchema = lazySchema19(
           "message.output_text.logprobs"
         ])
       ).nullish(),
+      /**
+       * Whether to automatically include web search action sources in the
+       * response. Disable this for OpenAI-compatible providers that do not
+       * support the `web_search_call.action.sources` include value.
+       *
+       * Defaults to `true`.
+       */
+      includeWebSearchSources: z21.boolean().optional(),
       /**
        * Instructions for the model.
        * They can be used to change the system or developer message when continuing a conversation using the `previousResponseId` option.
@@ -6195,7 +6322,7 @@ var openaiLanguageModelResponsesOptionsSchema = lazySchema19(
 
 // src/responses/openai-responses-prepare-tools.ts
 import {
-  UnsupportedFunctionalityError as UnsupportedFunctionalityError6
+  UnsupportedFunctionalityError as UnsupportedFunctionalityError7
 } from "@ai-sdk/provider";
 import {
   resolveProviderReference as resolveProviderReference3,
@@ -6599,6 +6726,7 @@ async function prepareResponsesTools({
         const openaiFunctionTool = prepareFunctionTool({
           tool,
           options: openaiOptions,
+          toolWarnings,
           async: resolveAsyncToolOption({
             value: openaiOptions == null ? void 0 : openaiOptions.async,
             supportsAsyncToolCalling,
@@ -6621,7 +6749,7 @@ async function prepareResponsesTools({
             namespaceTools.set(namespace.name, namespaceTool);
             openaiTools.push(namespaceTool);
           } else if (namespaceTool.description !== namespace.description) {
-            throw new UnsupportedFunctionalityError6({
+            throw new UnsupportedFunctionalityError7({
               functionality: `conflicting descriptions for OpenAI tool namespace "${namespace.name}"`
             });
           }
@@ -6888,7 +7016,7 @@ async function prepareResponsesTools({
       allowedToolEntries.push(resolution.entry);
     }
     if (allowedToolEntries.length === 0) {
-      throw new UnsupportedFunctionalityError6({
+      throw new UnsupportedFunctionalityError7({
         functionality: `allowedTools with only tools that cannot be allow-listed (${droppedToolNames.join(
           ", "
         )})`
@@ -6923,7 +7051,7 @@ async function prepareResponsesTools({
     }
     default: {
       const _exhaustiveCheck = type;
-      throw new UnsupportedFunctionalityError6({
+      throw new UnsupportedFunctionalityError7({
         functionality: `tool choice type: ${_exhaustiveCheck}`
       });
     }
@@ -6979,19 +7107,27 @@ function toAllowedToolResolution(tool) {
 function prepareFunctionTool({
   tool,
   options,
+  toolWarnings,
   async
 }) {
+  var _a2;
   const deferLoading = options == null ? void 0 : options.deferLoading;
+  const normalizedInputSchema = normalizeOpenAIJsonSchema(tool.inputSchema);
+  const normalizedOutputSchema = (options == null ? void 0 : options.outputSchema) != null ? normalizeOpenAIJsonSchema(options.outputSchema) : void 0;
+  toolWarnings.push(
+    ...normalizedInputSchema.warnings,
+    ...(_a2 = normalizedOutputSchema == null ? void 0 : normalizedOutputSchema.warnings) != null ? _a2 : []
+  );
   return {
     type: "function",
     name: tool.name,
     description: tool.description,
-    parameters: tool.inputSchema,
+    parameters: normalizedInputSchema.schema,
     ...async != null ? { async } : {},
     ...tool.strict != null ? { strict: tool.strict } : {},
     ...deferLoading != null ? { defer_loading: deferLoading } : {},
     ...(options == null ? void 0 : options.allowedCallers) != null ? { allowed_callers: options.allowedCallers } : {},
-    ...(options == null ? void 0 : options.outputSchema) != null ? { output_schema: options.outputSchema } : {}
+    ...(options == null ? void 0 : options.outputSchema) != null ? { output_schema: normalizedOutputSchema == null ? void 0 : normalizedOutputSchema.schema } : {}
   };
 }
 function resolveAsyncToolOption({
@@ -7314,6 +7450,10 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
       input.push({ type: "compaction_trigger" });
     }
     const strictJsonSchema = (_g = openaiOptions == null ? void 0 : openaiOptions.strictJsonSchema) != null ? _g : true;
+    const normalizedResponseFormatSchema = (responseFormat == null ? void 0 : responseFormat.type) === "json" && responseFormat.schema != null ? normalizeOpenAIJsonSchema(responseFormat.schema) : void 0;
+    if (normalizedResponseFormatSchema != null) {
+      warnings.push(...normalizedResponseFormatSchema.warnings);
+    }
     let include = openaiOptions == null ? void 0 : openaiOptions.include;
     function addInclude(key) {
       if (include == null) {
@@ -7336,7 +7476,7 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
     const webSearchToolName = (_h = tools == null ? void 0 : tools.find(
       (tool) => tool.type === "provider" && (tool.id === "openai.web_search" || tool.id === "openai.web_search_preview")
     )) == null ? void 0 : _h.name;
-    if (webSearchToolName) {
+    if (webSearchToolName && config.supportsWebSearchSourcesInclude !== false && (openaiOptions == null ? void 0 : openaiOptions.includeWebSearchSources) !== false) {
       addInclude("web_search_call.action.sources");
     }
     if (hasOpenAITool("openai.code_interpreter")) {
@@ -7355,12 +7495,12 @@ var OpenAIResponsesLanguageModel = class _OpenAIResponsesLanguageModel {
       ...((responseFormat == null ? void 0 : responseFormat.type) === "json" || (openaiOptions == null ? void 0 : openaiOptions.textVerbosity)) && {
         text: {
           ...(responseFormat == null ? void 0 : responseFormat.type) === "json" && {
-            format: responseFormat.schema != null ? {
+            format: normalizedResponseFormatSchema != null ? {
               type: "json_schema",
               strict: strictJsonSchema,
               name: (_i = responseFormat.name) != null ? _i : "response",
               description: responseFormat.description,
-              schema: responseFormat.schema
+              schema: normalizedResponseFormatSchema.schema
             } : { type: "json_object" }
           },
           ...(openaiOptions == null ? void 0 : openaiOptions.textVerbosity) && {