Skip to content

A programming framework for agentic AI

Support custom models with OpenAI client (#4808)

Sachin Joglekar3b4dd6e05039
diff --git a/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py b/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py
index d37f696fa..a70ee087a 100644
--- a/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py
+++ b/python/packages/autogen-ext/src/autogen_ext/models/openai/_openai_client.py
@@ -360,7 +360,10 @@ class BaseOpenAIChatCompletionClient(ChatCompletionClient):
):
self._client = client
if model_capabilities is None:
- self._model_capabilities = _model_info.get_capabilities(create_args["model"])
+ try:
+ self._model_capabilities = _model_info.get_capabilities(create_args["model"])
+ except KeyError as err:
+ raise ValueError("model_capabilities is required when model name is not a valid OpenAI model") from err
else:
self._model_capabilities = model_capabilities
diff --git a/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py b/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py
index c2938cb7c..4f83466f5 100644
--- a/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py
+++ b/python/packages/autogen-ext/src/autogen_ext/models/openai/config/__init__.py
@@ -2,7 +2,7 @@ from typing import Awaitable, Callable, Dict, List, Literal, Optional, Union
from autogen_core import ComponentModel
from autogen_core.models import ModelCapabilities
-from pydantic import BaseModel
+from pydantic import BaseModel, ConfigDict
from typing_extensions import Required, TypedDict
from .._azure_token_provider import AzureTokenProvider
@@ -79,6 +79,9 @@ class CreateArgumentsConfigModel(BaseModel):
class BaseOpenAIClientConfigurationConfigModel(CreateArgumentsConfigModel):
+ # To allow `model_capabilities` field without triggering pydantic warnings.
+ model_config = ConfigDict(protected_namespaces=())
+
model: str
api_key: str | None = None
timeout: float | None = None
diff --git a/python/packages/autogen-ext/tests/models/test_openai_model_client.py b/python/packages/autogen-ext/tests/models/test_openai_model_client.py
index 9f2144c5d..54ae8a6ad 100644
--- a/python/packages/autogen-ext/tests/models/test_openai_model_client.py
+++ b/python/packages/autogen-ext/tests/models/test_openai_model_client.py
@@ -137,6 +137,24 @@ async def test_openai_chat_completion_client() -> None:
assert client
+async def test_custom_model_with_capabilities() -> None:
+ with pytest.raises(ValueError, match="model_capabilities is required"):
+ client = OpenAIChatCompletionClient(model="dummy_model", base_url="https://api.dummy.com/v0", api_key="api_key")
+
+ client = OpenAIChatCompletionClient(
+ model="dummy_model",
+ base_url="https://api.dummy.com/v0",
+ api_key="api_key",
+ model_capabilities={
+ "vision": False,
+ "function_calling": False,
+ "json_output": False,
+ },
+ )
+ assert client
+
+
@pytest.mark.asyncio
async def test_azure_openai_chat_completion_client() -> None:
client = AzureOpenAIChatCompletionClient(