Eduard van Valkenburg
0521f5bed8
* [BREAKING] Rename ChatAgent -> Agent, ChatMessage -> Message, ChatClientProtocol -> SupportsChatGetResponse Simplify the public API by removing redundant 'Chat' prefix from core types: - ChatAgent -> Agent - RawChatAgent -> RawAgent - ChatMessage -> Message - ChatClientProtocol -> SupportsChatGetResponse Also renamed internal WorkflowMessage (was Message in _runner_context) to avoid collision. No backward compatibility aliases - this is a clean breaking change. * [BREAKING] Rename Agent chat_client parameter to client * Fix rebase issues: WorkflowMessage references and broken markdown links * Fix formatting and lint issues from code quality checks * Fix import ordering in workflow sample files * fixed rebase * Fix test failures: use WorkflowMessage and A2AMessage after ChatMessage→Message rename - Replace Message(data=..., source_id=...) with WorkflowMessage(...) in workflow tests - Fix isinstance check in A2A agent to use A2AMessage instead of Message - Fix import in test_workflow_observability.py (Message→WorkflowMessage) * Fix lint, fmt, and sample errors after ChatMessage→Message rename - Auto-fix 70+ ruff lint issues across samples (ChatMessage→Message refs) - Fix HostedVectorStoreContent→Content.from_hosted_vector_store in file search sample - Fix _normalize_messages→normalize_messages in custom agent sample - Fix context.terminate→raise MiddlewareTermination in middleware samples - Fix with_update_hook→with_transform_hook in override middleware sample - Add TOptions_co import back to custom_chat_client sample - Add noqa for FastAPI File() default in chatkit sample - Fix B023 loop variable capture in weather agent sample * fix: update Agent constructor calls from chat_client to client in declaration-only tool tests * fix: add register_cleanup to devui lazy-loading proxy and type stub * fixed tests and updated new pieces * fix agui typevar * fix merge errors * fix merge conflicts * fiux merge * Remove unused links --------- Co-authored-by: Evan Mattson <evan.mattson@microsoft.com>
Ollama Examples
This folder contains examples demonstrating how to use Ollama models with the Agent Framework.
Prerequisites
- Install Ollama: Download and install Ollama from ollama.com
- Start Ollama: Ensure Ollama is running on your local machine
- Pull a model: Run
ollama pull mistral(or any other model you prefer)- For function calling examples, use models that support tool calling like
mistralorqwen2.5 - For reasoning examples, use models that support reasoning like
qwen3:8b - For multimodal examples, use models like
gemma3:4b
- For function calling examples, use models that support tool calling like
Note
: Not all models support all features. Function calling, reasoning, and multimodal capabilities depend on the specific model you're using.
Recommended Approach
The recommended way to use Ollama with Agent Framework is via the native OllamaChatClient from the agent-framework-ollama package. This provides full support for Ollama-specific features like reasoning mode.
Alternatively, you can use the OpenAIChatClient configured to point to your local Ollama server, which may be useful if you're already familiar with the OpenAI client interface.
Examples
| File | Description |
|---|---|
ollama_agent_basic.py |
Basic Ollama agent with tool calling using native Ollama Chat Client. Shows both streaming and non-streaming responses. |
ollama_agent_reasoning.py |
Ollama agent with reasoning capabilities using native Ollama Chat Client. Shows how to enable thinking/reasoning mode. |
ollama_chat_client.py |
Direct usage of the native Ollama Chat Client with tool calling. |
ollama_chat_multimodal.py |
Ollama Chat Client with multimodal (image) input capabilities. |
ollama_with_openai_chat_client.py |
Alternative approach using OpenAI Chat Client configured to use local Ollama models. |
Configuration
The examples use environment variables for configuration. Set the appropriate variables based on which example you're running:
For Native Ollama Examples
Set the following environment variables:
-
OLLAMA_HOST: The base URL for your Ollama server (optional, defaults tohttp://localhost:11434)- Example:
export OLLAMA_HOST="http://localhost:11434"
- Example:
-
OLLAMA_MODEL_ID: The model name to use- Example:
export OLLAMA_MODEL_ID="qwen2.5:8b" - Must be a model you have pulled with Ollama
- Example:
For OpenAI Client with Ollama (ollama_with_openai_chat_client.py)
Set the following environment variables:
-
OLLAMA_ENDPOINT: The base URL for your Ollama server with/v1/suffix- Example:
export OLLAMA_ENDPOINT="http://localhost:11434/v1/"
- Example:
-
OLLAMA_MODEL: The model name to use- Example:
export OLLAMA_MODEL="mistral" - Must be a model you have pulled with Ollama
- Example: