Skip to content

Build and run agents you can see, understand and trust.

fix(model): add `extra_kwargs` for OpenAI chat model class (#1774)

Yufeng He6bb26309da5d
diff --git a/src/agentscope/model/_openai_chat/_model.py b/src/agentscope/model/_openai_chat/_model.py
index 8d7627cf4..bb3864f88 100644
--- a/src/agentscope/model/_openai_chat/_model.py
+++ b/src/agentscope/model/_openai_chat/_model.py
@@ -122,6 +122,7 @@ class OpenAIChatModel(ChatModelBase):
context_size: int = 128000,
formatter: FormatterBase | None = None,
client_kwargs: dict[str, Any] | None = None,
+ extra_body: dict[str, Any] | None = None,
) -> None:
"""Initialize the OpenAI chat model.
@@ -149,6 +150,9 @@ class OpenAIChatModel(ChatModelBase):
client_kwargs (`dict[str, Any] | None`, defaults to `None`):
Extra keyword arguments forwarded to ``openai.AsyncClient``
(e.g. ``timeout``, ``default_headers``, ``http_client``).
+ extra_body (`dict[str, Any] | None`, defaults to `None`):
+ Additional request body fields forwarded to
+ OpenAI-compatible APIs.
"""
super().__init__(
credential=credential,
@@ -161,6 +165,7 @@ class OpenAIChatModel(ChatModelBase):
)
self.formatter = formatter or OpenAIChatFormatter()
self.client_kwargs = client_kwargs or {}
+ self.extra_body = dict(extra_body) if extra_body is not None else None
@classmethod
def _get_retryable_exceptions(cls) -> tuple[Type[Exception], ...]:
@@ -247,6 +252,9 @@ class OpenAIChatModel(ChatModelBase):
}
kwargs["modalities"] = ["text", "audio"]
+ if self.extra_body is not None:
+ kwargs["extra_body"] = dict(self.extra_body)
+
kwargs.update(generate_kwargs)
fmt_tools, fmt_tool_choice = self._format_tools(tools, tool_choice)
diff --git a/tests/model_openai_chat_test.py b/tests/model_openai_chat_test.py
index 8921a7e33..106024037 100644
--- a/tests/model_openai_chat_test.py
+++ b/tests/model_openai_chat_test.py
@@ -185,6 +185,71 @@ class TestOpenAIChatNonStream(IsolatedAsyncioTestCase):
)
self.assertEqual(result.id, "resp-1")
+ @patch("openai.AsyncClient")
+ async def test_default_thinking_enable_not_forwarded(
+ self,
+ mock_client_cls: MagicMock,
+ ) -> None:
+ """Default parameters do not add provider-specific extra_body."""
+ mock_create = AsyncMock(
+ return_value=_mock_completion(text="Hello world!"),
+ )
+ mock_client_cls.return_value.chat.completions.create = mock_create
+
+ await self.model([])
+
+ self.assertNotIn("extra_body", mock_create.call_args.kwargs)
+
+ @patch("openai.AsyncClient")
+ async def test_constructor_extra_body_forwarded(
+ self,
+ mock_client_cls: MagicMock,
+ ) -> None:
+ """Custom request fields are forwarded to OpenAI-compatible APIs."""
+ model = OpenAIChatModel(
+ credential=OpenAICredential(api_key="test"),
+ model="custom-model",
+ stream=False,
+ context_size=128_000,
+ extra_body={"enable_thinking": False},
+ )
+ mock_create = AsyncMock(
+ return_value=_mock_completion(text="Hello world!"),
+ )
+ mock_client_cls.return_value.chat.completions.create = mock_create
+
+ await model([])
+
+ self.assertEqual(
+ mock_create.call_args.kwargs["extra_body"],
+ {"enable_thinking": False},
+ )
+
+ @patch("openai.AsyncClient")
+ async def test_generate_kwargs_extra_body_overrides_constructor(
+ self,
+ mock_client_cls: MagicMock,
+ ) -> None:
+ """Per-call extra_body overrides the constructor default."""
+ model = OpenAIChatModel(
+ credential=OpenAICredential(api_key="test"),
+ model="custom-model",
+ stream=False,
+ context_size=128_000,
+ extra_body={"enable_thinking": False},
+ )
+ mock_create = AsyncMock(
+ return_value=_mock_completion(text="Hello world!"),
+ )
+ mock_client_cls.return_value.chat.completions.create = mock_create
+
+ await model([], extra_body={"custom_option": "value"})
+
+ self.assertEqual(
+ mock_create.call_args.kwargs["extra_body"],
+ {"custom_option": "value"},
+ )
+
@patch("openai.AsyncClient")
async def test_tool_call_response(
self,