Skip to content

A programming framework for agentic AI

5663 ollama client host (#5674)

rylativity5615f40a3091
diff --git a/python/packages/autogen-ext/pyproject.toml b/python/packages/autogen-ext/pyproject.toml
index d4c839d35..1de0981c3 100644
--- a/python/packages/autogen-ext/pyproject.toml
+++ b/python/packages/autogen-ext/pyproject.toml
@@ -26,6 +26,7 @@ azure = [
"azure-identity",
]
docker = ["docker~=7.0", "asyncio_atexit>=1.0.1"]
+ollama = ["ollama>=0.4.7", "tiktoken>=0.8.0"]
openai = ["openai>=1.52.2", "tiktoken>=0.8.0", "aiofiles"]
file-surfer = [
"autogen-agentchat==0.4.8",
diff --git a/python/packages/autogen-ext/src/autogen_ext/models/ollama/_ollama_client.py b/python/packages/autogen-ext/src/autogen_ext/models/ollama/_ollama_client.py
index 4ab1af045..1093e185c 100644
--- a/python/packages/autogen-ext/src/autogen_ext/models/ollama/_ollama_client.py
+++ b/python/packages/autogen-ext/src/autogen_ext/models/ollama/_ollama_client.py
@@ -1,4 +1,5 @@
import asyncio
+import inspect
import json
import logging
import math
@@ -46,6 +47,7 @@ from autogen_core.tools import Tool, ToolSchema
from ollama import AsyncClient, ChatResponse, Message
from ollama import Image as OllamaImage
from ollama import Tool as OllamaTool
+from ollama._types import ChatRequest
from pydantic import BaseModel
from typing_extensions import Self, Unpack
@@ -75,8 +77,20 @@ def _ollama_client_from_config(config: Mapping[str, Any]) -> AsyncClient:
return AsyncClient(**ollama_config)
+ollama_chat_request_fields: dict[str, Any] = [m for m in inspect.getmembers(ChatRequest) if m[0] == "model_fields"][0][
+ 1
+]
+OLLAMA_VALID_CREATE_KWARGS_KEYS = set(ollama_chat_request_fields.keys()) | set(
+ ("model", "messages", "tools", "stream", "format", "options", "keep_alive")
+)
+
+
def _create_args_from_config(config: Mapping[str, Any]) -> Dict[str, Any]:
- return dict(config).copy()
+ create_args = {k.lower(): v for k, v in config.items() if k.lower() in OLLAMA_VALID_CREATE_KWARGS_KEYS}
+ dropped_keys = [k for k in config.keys() if k.lower() not in OLLAMA_VALID_CREATE_KWARGS_KEYS]
+ logger.info(f"Dropped the following unrecognized keys from create_args: {dropped_keys}")
+
+ return create_args
# create_args = {k: v for k, v in config.items() if k in create_kwargs}
# create_args_keys = set(create_args.keys())
# if not required_create_args.issubset(create_args_keys):
@@ -374,6 +388,9 @@ class BaseOllamaChatCompletionClient(ChatCompletionClient):
def create_from_config(cls, config: Dict[str, Any]) -> ChatCompletionClient:
return OllamaChatCompletionClient(**config)
+ def get_create_args(self) -> Mapping[str, Any]:
+ return self._create_args
+
async def create(
self,
messages: Sequence[LLMMessage],
diff --git a/python/packages/autogen-ext/tests/models/test_ollama_chat_completion_client.py b/python/packages/autogen-ext/tests/models/test_ollama_chat_completion_client.py
new file mode 100644
index 000000000..c57997431
--- /dev/null
+++ b/python/packages/autogen-ext/tests/models/test_ollama_chat_completion_client.py
@@ -0,0 +1,49 @@
+from typing import Any, Mapping
+
+import pytest
+from autogen_core.models._types import UserMessage
+from autogen_ext.models.ollama import OllamaChatCompletionClient
+from autogen_ext.models.ollama._ollama_client import OLLAMA_VALID_CREATE_KWARGS_KEYS
+from httpx import Response
+from ollama import AsyncClient
+
+
+def _mock_request(*args: Any, **kwargs: Any) -> Response:
+ return Response(status_code=200, content="{'response': 'Hello world!'}")
+
+
+async def test_ollama_chat_completion_client_doesnt_error_with_host_kwarg(monkeypatch: pytest.MonkeyPatch) -> None:
+ monkeypatch.setattr(AsyncClient, "_request", _mock_request)
+
+ client = OllamaChatCompletionClient(model="llama3.1", host="http://testyhostname:11434")
+
+ ## Call to client.create will throw a ConnectionError,
+ # but that will only occur if the call to the AsyncChat's .chat() method does not receive unexpected kwargs
+ # and does not throw a TypeError with unrecognized kwargs
+ # (i.e. the extra unrecognized kwargs have been successfully removed)
+ try:
+ await client.create([UserMessage(content="hi", source="user")])
+ except TypeError as e:
+ assert "AsyncClient.chat() got an unexpected keyword argument" not in e.args[0]
+
+
+def test_create_args_from_config_drops_unexpected_kwargs() -> None:
+ test_config: Mapping[str, Any] = {
+ "model": "llama3.1",
+ "messages": [],
+ "tools": [],
+ "stream": False,
+ "format": "json",
+ "options": {},
+ "keep_alive": 100,
+ "extra_unexpected_kwarg": "value",
+ "another_extra_unexpected_kwarg": "another_value",
+ }
+
+ client = OllamaChatCompletionClient(**test_config)
+
+ final_create_args = client.get_create_args()
+
+ for arg in final_create_args.keys():
+ assert arg in OLLAMA_VALID_CREATE_KWARGS_KEYS
diff --git a/python/uv.lock b/python/uv.lock
index ae885381a..1b3efe128 100644
--- a/python/uv.lock
+++ b/python/uv.lock
@@ -623,6 +623,10 @@ mcp = [
{ name = "json-schema-to-pydantic" },
{ name = "mcp" },
]
+ollama = [
+ { name = "ollama" },
+ { name = "tiktoken" },
+]
openai = [
{ name = "aiofiles" },
{ name = "openai" },
@@ -716,6 +720,7 @@ requires-dist = [
{ name = "markitdown", marker = "extra == 'web-surfer'", specifier = ">=0.0.1a2" },
{ name = "mcp", marker = "extra == 'mcp'", specifier = ">=1.1.3" },
{ name = "nbclient", marker = "extra == 'jupyter-executor'", specifier = ">=0.10.2" },
+ { name = "ollama", marker = "extra == 'ollama'", specifier = ">=0.4.7" },
{ name = "openai", marker = "extra == 'openai'", specifier = ">=1.52.2" },
{ name = "openai-whisper", marker = "extra == 'video-surfer'" },
{ name = "opencv-python", marker = "extra == 'video-surfer'", specifier = ">=4.5" },
@@ -736,6 +741,7 @@ requires-dist = [
{ name = "semantic-kernel", extras = ["ollama"], marker = "extra == 'semantic-kernel-ollama'", specifier = ">=1.17.1" },
{ name = "semantic-kernel", extras = ["onnx"], marker = "extra == 'semantic-kernel-onnx'", specifier = ">=1.17.1" },
{ name = "semantic-kernel", extras = ["pandas"], marker = "extra == 'semantic-kernel-pandas'", specifier = ">=1.17.1" },
+ { name = "tiktoken", marker = "extra == 'ollama'", specifier = ">=0.8.0" },
{ name = "tiktoken", marker = "extra == 'openai'", specifier = ">=0.8.0" },
]