feat (@ai-sdk/openai): add parallelToolCalls setting

.changeset/pretty-jeans-sit.md

@@ -0,0 +1,5 @@
+---
+'@ai-sdk/openai': patch
+---
+
+feat (@ai-sdk/openai): add parallelToolCalls setting

content/providers/01-ai-sdk-providers/01-openai.mdx

@@ -171,6 +171,10 @@ The following optional settings are available for OpenAI chat models:
   Setting to a number will return the log probabilities of the top n
   tokens that were generated.
 
+- **parallelToolCalls** _boolean_
+
+  Whether to enable parallel function calling during tool use. Default to true.
+
 - **user** _string_
 
   A unique identifier representing your end-user, which can help OpenAI to

content/providers/01-ai-sdk-providers/02-azure.mdx

@@ -133,6 +133,10 @@ The following optional settings are available for OpenAI chat models:
   Setting to a number will return the log probabilities of the top n
   tokens that were generated.
 
+- **parallelToolCalls** _boolean_
+
+  Whether to enable parallel function calling during tool use. Default to true.
+
 - **user** _string_
 
   A unique identifier representing your end-user, which can help OpenAI to

packages/openai/src/openai-chat-language-model.test.ts

@@ -146,7 +146,7 @@ describe('doGenerate', () => {
         | null;
     } | null;
     finish_reason?: string;
-  }) {
+  } = {}) {
     server.responseBodyJson = {
       id: 'chatcmpl-95ZTZkhr0mHNKqerQfiwkuox3PHAd',
       object: 'chat.completion',
@@ -283,6 +283,33 @@ describe('doGenerate', () => {
     });
   });
 
+  it('should pass settings', async () => {
+    prepareJsonResponse();
+
+    await provider
+      .chat('gpt-3.5-turbo', {
+        logitBias: { 50256: -100 },
+        logprobs: 2,
+        parallelToolCalls: false,
+        user: 'test-user-id',
+      })
+      .doGenerate({
+        inputFormat: 'prompt',
+        mode: { type: 'regular' },
+        prompt: TEST_PROMPT,
+      });
+
+    expect(await server.getRequestBodyJson()).toStrictEqual({
+      model: 'gpt-3.5-turbo',
+      messages: [{ role: 'user', content: 'Hello' }],
+      logprobs: true,
+      top_logprobs: 2,
+      logit_bias: { 50256: -100 },
+      parallel_tool_calls: false,
+      user: 'test-user-id',
+    });
+  });
+
   it('should pass tools and toolChoice', async () => {
     prepareJsonResponse({ content: '' });
 

packages/openai/src/openai-chat-language-model.ts

@@ -84,6 +84,7 @@ export class OpenAIChatLanguageModel implements LanguageModelV1 {
             : undefined
           : undefined,
       user: this.settings.user,
+      parallel_tool_calls: this.settings.parallelToolCalls,
 
       // standardized settings:
       max_tokens: maxTokens,

packages/openai/src/openai-chat-settings.ts

@@ -50,6 +50,11 @@ tokens that were generated.
 */
   logprobs?: boolean | number;
 
+  /**
+Whether to enable parallel function calling during tool use. Default to true.
+   */
+  parallelToolCalls?: boolean;
+
   /**
 A unique identifier representing your end-user, which can help OpenAI to
 monitor and detect abuse. Learn more.