Skip to content

A programming framework for agentic AI

Rename ModelClient to ChatCompletionClient (#54)

Jack Gerrits06ba5d3ca88a
diff --git a/src/agnext/chat/agents/chat_completion_agent.py b/src/agnext/chat/agents/chat_completion_agent.py
index 6fac52817..22ae7c754 100644
--- a/src/agnext/chat/agents/chat_completion_agent.py
+++ b/src/agnext/chat/agents/chat_completion_agent.py
@@ -17,7 +17,12 @@ from agnext.components import (
TypeRoutedAgent,
message_handler,
)
-from agnext.components.models import FunctionExecutionResult, FunctionExecutionResultMessage, ModelClient, SystemMessage
+from agnext.components.models import (
+ ChatCompletionClient,
+ FunctionExecutionResult,
+ FunctionExecutionResultMessage,
+ SystemMessage,
+)
from agnext.components.tools import Tool
from agnext.core import AgentRuntime, CancellationToken
@@ -29,7 +34,7 @@ class ChatCompletionAgent(BaseChatAgent, TypeRoutedAgent):
description: str,
runtime: AgentRuntime,
system_messages: List[SystemMessage],
- model_client: ModelClient,
+ model_client: ChatCompletionClient,
tools: Sequence[Tool] = [],
) -> None:
super().__init__(name, description, runtime)
diff --git a/src/agnext/components/models/__init__.py b/src/agnext/components/models/__init__.py
index f5a77ab04..05e149408 100644
--- a/src/agnext/components/models/__init__.py
+++ b/src/agnext/components/models/__init__.py
@@ -1,4 +1,4 @@
-from ._model_client import ModelCapabilities, ModelClient
+from ._model_client import ChatCompletionClient, ModelCapabilities
from ._openai_client import (
AzureOpenAI,
OpenAI,
@@ -19,7 +19,7 @@ __all__ = [
"AzureOpenAI",
"OpenAI",
"ModelCapabilities",
- "ModelClient",
+ "ChatCompletionClient",
"SystemMessage",
"UserMessage",
"AssistantMessage",
diff --git a/src/agnext/components/models/_model_client.py b/src/agnext/components/models/_model_client.py
index 2f3705073..1dcfe351a 100644
--- a/src/agnext/components/models/_model_client.py
+++ b/src/agnext/components/models/_model_client.py
@@ -22,7 +22,7 @@ class ModelCapabilities(TypedDict, total=False):
@runtime_checkable
-class ModelClient(Protocol):
+class ChatCompletionClient(Protocol):
# Caching has to be handled internally as they can depend on the create args that were stored in the constructor
async def create(
self,
diff --git a/src/agnext/components/models/_openai_client.py b/src/agnext/components/models/_openai_client.py
index 0676fb341..101aa8bdf 100644
--- a/src/agnext/components/models/_openai_client.py
+++ b/src/agnext/components/models/_openai_client.py
@@ -36,7 +36,7 @@ from .. import (
)
from ..tools import Tool
from . import _model_info
-from ._model_client import ModelCapabilities, ModelClient
+from ._model_client import ChatCompletionClient, ModelCapabilities
from ._types import (
AssistantMessage,
CreateResult,
@@ -214,7 +214,7 @@ def convert_tools(
return result
-class BaseOpenAI(ModelClient):
+class BaseOpenAI(ChatCompletionClient):
def __init__(
self,
client: Union[AsyncOpenAI, AsyncAzureOpenAI],
@@ -245,7 +245,7 @@ class BaseOpenAI(ModelClient):
self._actual_usage = RequestUsage(prompt_tokens=0, completion_tokens=0)
@classmethod
- def create_from_config(cls, config: Dict[str, Any]) -> ModelClient:
+ def create_from_config(cls, config: Dict[str, Any]) -> ChatCompletionClient:
return OpenAI(**config)
async def create(