A programming framework for agentic AI
Ollama client docs (#5605)
peterychang2842c76aeb2c
diff --git a/python/packages/autogen-core/docs/src/reference/index.md b/python/packages/autogen-core/docs/src/reference/index.mdindex f9dc5c1a1..ffa2581ba 100644--- a/python/packages/autogen-core/docs/src/reference/index.md+++ b/python/packages/autogen-core/docs/src/reference/index.md@@ -52,6 +52,7 @@ python/autogen_ext.models.openaipython/autogen_ext.models.replaypython/autogen_ext.models.azurepython/autogen_ext.models.semantic_kernel+python/autogen_ext.models.ollamapython/autogen_ext.tools.code_executionpython/autogen_ext.tools.graphragpython/autogen_ext.tools.httpdiff --git a/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.ollama.rst b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.ollama.rstnew file mode 100644index 000000000..67076e797--- /dev/null+++ b/python/packages/autogen-core/docs/src/reference/python/autogen_ext.models.ollama.rst@@ -0,0 +1,8 @@+autogen\_ext.models.ollama+==========================+++.. automodule:: autogen_ext.models.ollama+ :members:+ :undoc-members:+ :show-inheritance: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.pyindex a3df82b3b..4ab1af045 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@@ -402,6 +402,7 @@ class BaseOllamaChatCompletionClient(ChatCompletionClient):response_format_value = value.model_json_schema()else:# response_format_value is not a Pydantic model class+ # TODO: Should this be an warning/error?response_format_value = None# Remove 'response_format' from create_args to prevent passing it twice@@ -842,15 +843,16 @@ class BaseOllamaChatCompletionClient(ChatCompletionClient):class OllamaChatCompletionClient(BaseOllamaChatCompletionClient, Component[BaseOllamaClientConfigurationConfigModel]):"""Chat completion client for Ollama hosted models.- You can also use this client for Ollama-compatible ChatCompletion endpoints.-Ollama must be installed and the appropriate model pulled.Args:model (str): Which Ollama model to use.- host (str): Model host url.- response_format (optional, pydantic.BaseModel)+ host (optional, str): Model host url.+ response_format (optional, pydantic.BaseModel): The format of the response. If provided, the response will be parsed into this format as json.+ model_info (optional, ModelInfo): The capabilities of the model. **Required if the model is not listed in the ollama model info.**+ Note:+ Only models with 200k+ downloads (as of Jan 21, 2025), + phi4, deepseek-r1 have pre-defined model infos. See `this file <https://github.com/microsoft/autogen/blob/main/python/packages/autogen-ext/src/autogen_ext/models/ollama/_model_info.py>`__ for the full list. An entry for one model encompases all parameter variants of that model.To use this client, you must install the `ollama` extension:@@ -886,7 +888,11 @@ class OllamaChatCompletionClient(BaseOllamaChatCompletionClient, Component[BaseOclient = ChatCompletionClient.load_component(config)To output structured data, you can use the `response_format` argument:+.. code-block:: python++ from autogen_ext.models.ollama import OllamaChatCompletionClient+ from autogen_core.models import UserMessagefrom pydantic import BaseModel@@ -902,7 +908,8 @@ class OllamaChatCompletionClient(BaseOllamaChatCompletionClient, Component[BaseOresult = await ollama_client.create([UserMessage(content="Who was the first man on the moon?", source="user")]) # type: ignoreprint(result)- Note: Tool usage in ollama is stricter than in its OpenAI counterparts. While OpenAI accepts a map of [str, Any], Ollama requires a map of [str, Property] where Property is a typed object containing ``type`` and ``description`` fields. Therefore, only the keys ``type`` and ``description`` will be converted from the properties blob in the tool schema.+ Note:+ Tool usage in ollama is stricter than in its OpenAI counterparts. While OpenAI accepts a map of [str, Any], Ollama requires a map of [str, Property] where Property is a typed object containing ``type`` and ``description`` fields. Therefore, only the keys ``type`` and ``description`` will be converted from the properties blob in the tool schema.To view the full list of available configuration options, see the :py:class:`OllamaClientConfigurationConfigModel` class.diff --git a/python/packages/autogen-ext/src/autogen_ext/models/ollama/config/__init__.py b/python/packages/autogen-ext/src/autogen_ext/models/ollama/config/__init__.pyindex 7bc43b395..d35dc601c 100644--- a/python/packages/autogen-ext/src/autogen_ext/models/ollama/config/__init__.py+++ b/python/packages/autogen-ext/src/autogen_ext/models/ollama/config/__init__.py@@ -5,9 +5,12 @@ from pydantic import BaseModelfrom typing_extensions import TypedDict+# response_format MUST be a pydantic.BaseModel type or None+# TODO: check if we can extend response_format to support json and/or dictclass CreateArguments(TypedDict, total=False):model: strhost: Optional[str]+ response_format: Anyclass BaseOllamaClientConfiguration(CreateArguments, total=False):@@ -20,9 +23,11 @@ class BaseOllamaClientConfiguration(CreateArguments, total=False):# Pydantic equivalents of the above TypedDicts+# response_format MUST be a pydantic.BaseModel type or Noneclass CreateArgumentsConfigModel(BaseModel):model: strhost: str | None = None+ response_format: Any = Noneclass BaseOllamaClientConfigurationConfigModel(CreateArgumentsConfigModel):