ollama-python/examples/README.md

Running Examples

Run the examples in this directory with:

# Run example
python3 examples/<example>.py

# or with uv
uv run examples/<example>.py

See ollama/docs/api.md for full API documentation

Chat - Chat with a model

• chat.py
• async-chat.py
• chat-stream.py - Streamed outputs
• chat-with-history.py - Chat with model and maintain history of the conversation

Generate - Generate text with a model

• generate.py
• async-generate.py
• generate-stream.py - Streamed outputs
• fill-in-middle.py - Given a prefix and suffix, fill in the middle

Tools/Function Calling - Call a function with a model

• tools.py - Simple example of Tools/Function Calling
• async-tools.py
• multi-tool.py - Using multiple tools, with thinking enabled

gpt-oss

• gpt-oss-tools.py
• gpt-oss-tools-stream.py
• gpt-oss-tools-browser.py - Using browser research tools with gpt-oss
• gpt-oss-tools-browser-stream.py - Using browser research tools with gpt-oss, with streaming enabled

Web search

An API key from Ollama's cloud service is required. You can create one here.

export OLLAMA_API_KEY="your_api_key_here"

• web-search.py

MCP server

The MCP server can be used with an MCP client like Cursor, Cline, Codex, Open WebUI, Goose, and more.

uv run examples/web-search-mcp.py

Configuration to use with an MCP client:

{
  "mcpServers": {
    "web_search": {
      "type": "stdio",
      "command": "uv",
      "args": ["run", "path/to/ollama-python/examples/web-search-mcp.py"],
      "env": { "OLLAMA_API_KEY": "api-key" }
    }
  }
}

• web-search-mcp.py

Multimodal with Images - Chat with a multimodal (image chat) model

• multimodal-chat.py
• multimodal-generate.py

Structured Outputs - Generate structured outputs with a model

• structured-outputs.py
• async-structured-outputs.py
• structured-outputs-image.py

Ollama List - List all downloaded models and their properties

• list.py

Ollama Show - Display model properties and capabilities

• show.py

Ollama ps - Show model status with CPU/GPU usage

• ps.py

Ollama Pull - Pull a model from Ollama

Requirement: pip install tqdm

• pull.py

Ollama Create - Create a model from a Modelfile

• create.py

Ollama Embed - Generate embeddings with a model

• embed.py

Thinking - Enable thinking mode for a model

• thinking.py

Thinking (generate) - Enable thinking mode for a model

• thinking-generate.py

Thinking (levels) - Choose the thinking level

• thinking-levels.py