@ai-sdk/openai 0.0.36 → 0.0.38

package/dist/index.d.mts

@@ -1,6 +1,6 @@
 import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
 
-type OpenAIChatModelId = 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k-0613' | (string & {});
+type OpenAIChatModelId = 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | (string & {});
 interface OpenAIChatSettings {
     /**
   Modify the likelihood of specified tokens appearing in the completion.
@@ -34,6 +34,18 @@ interface OpenAIChatSettings {
      */
     parallelToolCalls?: boolean;
     /**
+  Whether to use legacy function calling. Defaults to false.
+  
+  Required by some open source inference engines which do not support the `tools` API. May also
+  provide a workaround for `parallelToolCalls` resulting in the provider buffering tool calls,
+  which causes `streamObject` to be non-streaming.
+  
+  Prefer setting `parallelToolCalls: false` over this option.
+  
+  @deprecated this API is supported but deprecated by OpenAI.
+     */
+    useLegacyFunctionCalling?: boolean;
+    /**
   A unique identifier representing your end-user, which can help OpenAI to
   monitor and detect abuse. Learn more.
   */

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { LanguageModelV1, EmbeddingModelV1 } from '@ai-sdk/provider';
 
-type OpenAIChatModelId = 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4-vision-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-4-32k' | 'gpt-4-32k-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | 'gpt-3.5-turbo-16k' | 'gpt-3.5-turbo-0613' | 'gpt-3.5-turbo-16k-0613' | (string & {});
+type OpenAIChatModelId = 'gpt-4o' | 'gpt-4o-2024-05-13' | 'gpt-4o-mini' | 'gpt-4o-mini-2024-07-18' | 'gpt-4-turbo' | 'gpt-4-turbo-2024-04-09' | 'gpt-4-turbo-preview' | 'gpt-4-0125-preview' | 'gpt-4-1106-preview' | 'gpt-4' | 'gpt-4-0613' | 'gpt-3.5-turbo-0125' | 'gpt-3.5-turbo' | 'gpt-3.5-turbo-1106' | (string & {});
 interface OpenAIChatSettings {
     /**
   Modify the likelihood of specified tokens appearing in the completion.
@@ -34,6 +34,18 @@ interface OpenAIChatSettings {
      */
     parallelToolCalls?: boolean;
     /**
+  Whether to use legacy function calling. Defaults to false.
+  
+  Required by some open source inference engines which do not support the `tools` API. May also
+  provide a workaround for `parallelToolCalls` resulting in the provider buffering tool calls,
+  which causes `streamObject` to be non-streaming.
+  
+  Prefer setting `parallelToolCalls: false` over this option.
+  
+  @deprecated this API is supported but deprecated by OpenAI.
+     */
+    useLegacyFunctionCalling?: boolean;
+    /**
   A unique identifier representing your end-user, which can help OpenAI to
   monitor and detect abuse. Learn more.
   */

package/dist/index.js

@@ -30,13 +30,17 @@ module.exports = __toCommonJS(src_exports);
 var import_provider_utils5 = require("@ai-sdk/provider-utils");
 
 // src/openai-chat-language-model.ts
-var import_provider = require("@ai-sdk/provider");
+var import_provider2 = require("@ai-sdk/provider");
 var import_provider_utils3 = require("@ai-sdk/provider-utils");
 var import_zod2 = require("zod");
 
 // src/convert-to-openai-chat-messages.ts
+var import_provider = require("@ai-sdk/provider");
 var import_provider_utils = require("@ai-sdk/provider-utils");
-function convertToOpenAIChatMessages(prompt) {
+function convertToOpenAIChatMessages({
+  prompt,
+  useLegacyFunctionCalling = false
+}) {
   const messages = [];
   for (const { role, content } of prompt) {
     switch (role) {
@@ -96,20 +100,41 @@ function convertToOpenAIChatMessages(prompt) {
             }
           }
         }
-        messages.push({
-          role: "assistant",
-          content: text,
-          tool_calls: toolCalls.length > 0 ? toolCalls : void 0
-        });
+        if (useLegacyFunctionCalling) {
+          if (toolCalls.length > 1) {
+            throw new import_provider.UnsupportedFunctionalityError({
+              functionality: "useLegacyFunctionCalling with multiple tool calls in one message"
+            });
+          }
+          messages.push({
+            role: "assistant",
+            content: text,
+            function_call: toolCalls.length > 0 ? toolCalls[0].function : void 0
+          });
+        } else {
+          messages.push({
+            role: "assistant",
+            content: text,
+            tool_calls: toolCalls.length > 0 ? toolCalls : void 0
+          });
+        }
         break;
       }
       case "tool": {
         for (const toolResponse of content) {
-          messages.push({
-            role: "tool",
-            tool_call_id: toolResponse.toolCallId,
-            content: JSON.stringify(toolResponse.result)
-          });
+          if (useLegacyFunctionCalling) {
+            messages.push({
+              role: "function",
+              name: toolResponse.toolName,
+              content: JSON.stringify(toolResponse.result)
+            });
+          } else {
+            messages.push({
+              role: "tool",
+              tool_call_id: toolResponse.toolCallId,
+              content: JSON.stringify(toolResponse.result)
+            });
+          }
         }
         break;
       }
@@ -186,11 +211,34 @@ var OpenAIChatLanguageModel = class {
     maxTokens,
     temperature,
     topP,
+    topK,
     frequencyPenalty,
     presencePenalty,
+    stopSequences,
+    responseFormat,
     seed
   }) {
     const type = mode.type;
+    const warnings = [];
+    if (topK != null) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "topK"
+      });
+    }
+    if (responseFormat != null && responseFormat.type === "json" && responseFormat.schema != null) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "responseFormat",
+        details: "JSON response format schema is not supported"
+      });
+    }
+    const useLegacyFunctionCalling = this.settings.useLegacyFunctionCalling;
+    if (useLegacyFunctionCalling && this.settings.parallelToolCalls === true) {
+      throw new import_provider2.UnsupportedFunctionalityError({
+        functionality: "useLegacyFunctionCalling with parallelToolCalls"
+      });
+    }
     const baseArgs = {
       // model id:
       model: this.modelId,
@@ -206,41 +254,69 @@ var OpenAIChatLanguageModel = class {
       top_p: topP,
       frequency_penalty: frequencyPenalty,
       presence_penalty: presencePenalty,
+      stop: stopSequences,
       seed,
+      // response format:
+      response_format: (responseFormat == null ? void 0 : responseFormat.type) === "json" ? { type: "json_object" } : void 0,
       // messages:
-      messages: convertToOpenAIChatMessages(prompt)
+      messages: convertToOpenAIChatMessages({
+        prompt,
+        useLegacyFunctionCalling
+      })
     };
     switch (type) {
       case "regular": {
-        return { ...baseArgs, ...prepareToolsAndToolChoice(mode) };
+        return {
+          args: {
+            ...baseArgs,
+            ...prepareToolsAndToolChoice({ mode, useLegacyFunctionCalling })
+          },
+          warnings
+        };
       }
       case "object-json": {
         return {
-          ...baseArgs,
-          response_format: { type: "json_object" }
+          args: {
+            ...baseArgs,
+            response_format: { type: "json_object" }
+          },
+          warnings
         };
       }
       case "object-tool": {
         return {
-          ...baseArgs,
-          tool_choice: { type: "function", function: { name: mode.tool.name } },
-          tools: [
-            {
-              type: "function",
-              function: {
+          args: useLegacyFunctionCalling ? {
+            ...baseArgs,
+            function_call: {
+              name: mode.tool.name
+            },
+            functions: [
+              {
                 name: mode.tool.name,
                 description: mode.tool.description,
                 parameters: mode.tool.parameters
               }
-            }
-          ]
+            ]
+          } : {
+            ...baseArgs,
+            tool_choice: {
+              type: "function",
+              function: { name: mode.tool.name }
+            },
+            tools: [
+              {
+                type: "function",
+                function: {
+                  name: mode.tool.name,
+                  description: mode.tool.description,
+                  parameters: mode.tool.parameters
+                }
+              }
+            ]
+          },
+          warnings
         };
       }
-      case "object-grammar": {
-        throw new import_provider.UnsupportedFunctionalityError({
-          functionality: "object-grammar mode"
-        });
-      }
       default: {
         const _exhaustiveCheck = type;
         throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
@@ -249,7 +325,7 @@ var OpenAIChatLanguageModel = class {
   }
   async doGenerate(options) {
     var _a, _b;
-    const args = this.getArgs(options);
+    const { args, warnings } = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
         path: "/chat/completions",
@@ -268,7 +344,14 @@ var OpenAIChatLanguageModel = class {
     const choice = response.choices[0];
     return {
       text: (_a = choice.message.content) != null ? _a : void 0,
-      toolCalls: (_b = choice.message.tool_calls) == null ? void 0 : _b.map((toolCall) => {
+      toolCalls: this.settings.useLegacyFunctionCalling && choice.message.function_call ? [
+        {
+          toolCallType: "function",
+          toolCallId: (0, import_provider_utils3.generateId)(),
+          toolName: choice.message.function_call.name,
+          args: choice.message.function_call.arguments
+        }
+      ] : (_b = choice.message.tool_calls) == null ? void 0 : _b.map((toolCall) => {
         var _a2;
         return {
           toolCallType: "function",
@@ -284,12 +367,12 @@ var OpenAIChatLanguageModel = class {
       },
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
-      warnings: [],
+      warnings,
       logprobs: mapOpenAIChatLogProbsOutput(choice.logprobs)
     };
   }
   async doStream(options) {
-    const args = this.getArgs(options);
+    const { args, warnings } = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils3.postJsonToApi)({
       url: this.config.url({
         path: "/chat/completions",
@@ -317,6 +400,7 @@ var OpenAIChatLanguageModel = class {
       completionTokens: Number.NaN
     };
     let logprobs;
+    const { useLegacyFunctionCalling } = this.settings;
     return {
       stream: response.pipeThrough(
         new TransformStream({
@@ -361,24 +445,32 @@ var OpenAIChatLanguageModel = class {
                 logprobs = [];
               logprobs.push(...mappedLogprobs);
             }
-            if (delta.tool_calls != null) {
-              for (const toolCallDelta of delta.tool_calls) {
+            const mappedToolCalls = useLegacyFunctionCalling && delta.function_call != null ? [
+              {
+                type: "function",
+                id: (0, import_provider_utils3.generateId)(),
+                function: delta.function_call,
+                index: 0
+              }
+            ] : delta.tool_calls;
+            if (mappedToolCalls != null) {
+              for (const toolCallDelta of mappedToolCalls) {
                 const index = toolCallDelta.index;
                 if (toolCalls[index] == null) {
                   if (toolCallDelta.type !== "function") {
-                    throw new import_provider.InvalidResponseDataError({
+                    throw new import_provider2.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function' type.`
                     });
                   }
                   if (toolCallDelta.id == null) {
-                    throw new import_provider.InvalidResponseDataError({
+                    throw new import_provider2.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'id' to be a string.`
                     });
                   }
                   if (((_a = toolCallDelta.function) == null ? void 0 : _a.name) == null) {
-                    throw new import_provider.InvalidResponseDataError({
+                    throw new import_provider2.InvalidResponseDataError({
                       data: toolCallDelta,
                       message: `Expected 'function.name' to be a string.`
                     });
@@ -445,7 +537,7 @@ var OpenAIChatLanguageModel = class {
       ),
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
-      warnings: []
+      warnings
     };
   }
 };
@@ -454,17 +546,21 @@ var openAIChatResponseSchema = import_zod2.z.object({
     import_zod2.z.object({
       message: import_zod2.z.object({
         role: import_zod2.z.literal("assistant"),
-        content: import_zod2.z.string().nullable().optional(),
+        content: import_zod2.z.string().nullish(),
+        function_call: import_zod2.z.object({
+          arguments: import_zod2.z.string(),
+          name: import_zod2.z.string()
+        }).nullish(),
         tool_calls: import_zod2.z.array(
           import_zod2.z.object({
-            id: import_zod2.z.string().optional().nullable(),
+            id: import_zod2.z.string().nullish(),
             type: import_zod2.z.literal("function"),
             function: import_zod2.z.object({
               name: import_zod2.z.string(),
               arguments: import_zod2.z.string()
             })
           })
-        ).optional()
+        ).nullish()
       }),
       index: import_zod2.z.number(),
       logprobs: import_zod2.z.object({
@@ -480,8 +576,8 @@ var openAIChatResponseSchema = import_zod2.z.object({
             )
           })
         ).nullable()
-      }).nullable().optional(),
-      finish_reason: import_zod2.z.string().optional().nullable()
+      }).nullish(),
+      finish_reason: import_zod2.z.string().nullish()
     })
   ),
   usage: import_zod2.z.object({
@@ -496,6 +592,10 @@ var openaiChatChunkSchema = import_zod2.z.union([
         delta: import_zod2.z.object({
           role: import_zod2.z.enum(["assistant"]).optional(),
           content: import_zod2.z.string().nullish(),
+          function_call: import_zod2.z.object({
+            name: import_zod2.z.string().optional(),
+            arguments: import_zod2.z.string().optional()
+          }).nullish(),
           tool_calls: import_zod2.z.array(
             import_zod2.z.object({
               index: import_zod2.z.number(),
@@ -533,12 +633,45 @@ var openaiChatChunkSchema = import_zod2.z.union([
   }),
   openAIErrorDataSchema
 ]);
-function prepareToolsAndToolChoice(mode) {
+function prepareToolsAndToolChoice({
+  mode,
+  useLegacyFunctionCalling = false
+}) {
   var _a;
   const tools = ((_a = mode.tools) == null ? void 0 : _a.length) ? mode.tools : void 0;
   if (tools == null) {
     return { tools: void 0, tool_choice: void 0 };
   }
+  const toolChoice = mode.toolChoice;
+  if (useLegacyFunctionCalling) {
+    const mappedFunctions = tools.map((tool) => ({
+      name: tool.name,
+      description: tool.description,
+      parameters: tool.parameters
+    }));
+    if (toolChoice == null) {
+      return { functions: mappedFunctions, function_call: void 0 };
+    }
+    const type2 = toolChoice.type;
+    switch (type2) {
+      case "auto":
+      case "none":
+      case void 0:
+        return {
+          functions: mappedFunctions,
+          function_call: void 0
+        };
+      case "required":
+        throw new import_provider2.UnsupportedFunctionalityError({
+          functionality: "useLegacyFunctionCalling and toolChoice: required"
+        });
+      default:
+        return {
+          functions: mappedFunctions,
+          function_call: { name: toolChoice.toolName }
+        };
+    }
+  }
   const mappedTools = tools.map((tool) => ({
     type: "function",
     function: {
@@ -547,7 +680,6 @@ function prepareToolsAndToolChoice(mode) {
       parameters: tool.parameters
     }
   }));
-  const toolChoice = mode.toolChoice;
   if (toolChoice == null) {
     return { tools: mappedTools, tool_choice: void 0 };
   }
@@ -575,12 +707,12 @@ function prepareToolsAndToolChoice(mode) {
 }
 
 // src/openai-completion-language-model.ts
-var import_provider3 = require("@ai-sdk/provider");
+var import_provider4 = require("@ai-sdk/provider");
 var import_provider_utils4 = require("@ai-sdk/provider-utils");
 var import_zod3 = require("zod");
 
 // src/convert-to-openai-completion-prompt.ts
-var import_provider2 = require("@ai-sdk/provider");
+var import_provider3 = require("@ai-sdk/provider");
 function convertToOpenAICompletionPrompt({
   prompt,
   inputFormat,
@@ -600,7 +732,7 @@ function convertToOpenAICompletionPrompt({
   for (const { role, content } of prompt) {
     switch (role) {
       case "system": {
-        throw new import_provider2.InvalidPromptError({
+        throw new import_provider3.InvalidPromptError({
           message: "Unexpected system message in prompt: ${content}",
           prompt
         });
@@ -612,7 +744,7 @@ function convertToOpenAICompletionPrompt({
               return part.text;
             }
             case "image": {
-              throw new import_provider2.UnsupportedFunctionalityError({
+              throw new import_provider3.UnsupportedFunctionalityError({
                 functionality: "images"
               });
             }
@@ -631,7 +763,7 @@ ${userMessage}
               return part.text;
             }
             case "tool-call": {
-              throw new import_provider2.UnsupportedFunctionalityError({
+              throw new import_provider3.UnsupportedFunctionalityError({
                 functionality: "tool-call messages"
               });
             }
@@ -644,7 +776,7 @@ ${assistantMessage}
         break;
       }
       case "tool": {
-        throw new import_provider2.UnsupportedFunctionalityError({
+        throw new import_provider3.UnsupportedFunctionalityError({
           functionality: "tool messages"
         });
       }
@@ -696,13 +828,31 @@ var OpenAICompletionLanguageModel = class {
     maxTokens,
     temperature,
     topP,
+    topK,
     frequencyPenalty,
     presencePenalty,
+    stopSequences: userStopSequences,
+    responseFormat,
     seed
   }) {
     var _a;
     const type = mode.type;
+    const warnings = [];
+    if (topK != null) {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "topK"
+      });
+    }
+    if (responseFormat != null && responseFormat.type !== "text") {
+      warnings.push({
+        type: "unsupported-setting",
+        setting: "responseFormat",
+        details: "JSON response format is not supported."
+      });
+    }
     const { prompt: completionPrompt, stopSequences } = convertToOpenAICompletionPrompt({ prompt, inputFormat });
+    const stop = [...stopSequences != null ? stopSequences : [], ...userStopSequences != null ? userStopSequences : []];
     const baseArgs = {
       // model id:
       model: this.modelId,
@@ -722,37 +872,32 @@ var OpenAICompletionLanguageModel = class {
       // prompt:
       prompt: completionPrompt,
       // stop sequences:
-      stop: stopSequences
+      stop: stop.length > 0 ? stop : void 0
     };
     switch (type) {
       case "regular": {
         if ((_a = mode.tools) == null ? void 0 : _a.length) {
-          throw new import_provider3.UnsupportedFunctionalityError({
+          throw new import_provider4.UnsupportedFunctionalityError({
             functionality: "tools"
           });
         }
         if (mode.toolChoice) {
-          throw new import_provider3.UnsupportedFunctionalityError({
+          throw new import_provider4.UnsupportedFunctionalityError({
             functionality: "toolChoice"
           });
         }
-        return baseArgs;
+        return { args: baseArgs, warnings };
       }
       case "object-json": {
-        throw new import_provider3.UnsupportedFunctionalityError({
+        throw new import_provider4.UnsupportedFunctionalityError({
           functionality: "object-json mode"
         });
       }
       case "object-tool": {
-        throw new import_provider3.UnsupportedFunctionalityError({
+        throw new import_provider4.UnsupportedFunctionalityError({
           functionality: "object-tool mode"
         });
       }
-      case "object-grammar": {
-        throw new import_provider3.UnsupportedFunctionalityError({
-          functionality: "object-grammar mode"
-        });
-      }
       default: {
         const _exhaustiveCheck = type;
         throw new Error(`Unsupported type: ${_exhaustiveCheck}`);
@@ -760,7 +905,7 @@ var OpenAICompletionLanguageModel = class {
     }
   }
   async doGenerate(options) {
-    const args = this.getArgs(options);
+    const { args, warnings } = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils4.postJsonToApi)({
       url: this.config.url({
         path: "/completions",
@@ -787,11 +932,11 @@ var OpenAICompletionLanguageModel = class {
       logprobs: mapOpenAICompletionLogProbs(choice.logprobs),
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
-      warnings: []
+      warnings
     };
   }
   async doStream(options) {
-    const args = this.getArgs(options);
+    const { args, warnings } = this.getArgs(options);
     const { responseHeaders, value: response } = await (0, import_provider_utils4.postJsonToApi)({
       url: this.config.url({
         path: "/completions",
@@ -799,7 +944,7 @@ var OpenAICompletionLanguageModel = class {
       }),
       headers: (0, import_provider_utils4.combineHeaders)(this.config.headers(), options.headers),
       body: {
-        ...this.getArgs(options),
+        ...args,
         stream: true,
         // only include stream_options when in strict compatibility mode:
         stream_options: this.config.compatibility === "strict" ? { include_usage: true } : void 0
@@ -870,7 +1015,7 @@ var OpenAICompletionLanguageModel = class {
       ),
       rawCall: { rawPrompt, rawSettings },
       rawResponse: { headers: responseHeaders },
-      warnings: []
+      warnings
     };
   }
 };
@@ -964,7 +1109,7 @@ var OpenAI = class {
 var import_provider_utils7 = require("@ai-sdk/provider-utils");
 
 // src/openai-embedding-model.ts
-var import_provider4 = require("@ai-sdk/provider");
+var import_provider5 = require("@ai-sdk/provider");
 var import_provider_utils6 = require("@ai-sdk/provider-utils");
 var import_zod4 = require("zod");
 var OpenAIEmbeddingModel = class {
@@ -991,7 +1136,7 @@ var OpenAIEmbeddingModel = class {
     abortSignal
   }) {
     if (values.length > this.maxEmbeddingsPerCall) {
-      throw new import_provider4.TooManyEmbeddingValuesForCallError({
+      throw new import_provider5.TooManyEmbeddingValuesForCallError({
         provider: this.provider,
         modelId: this.modelId,
         maxEmbeddingsPerCall: this.maxEmbeddingsPerCall,