Skip to main content

A simple SDK for interacting with the Ollama API by automatically creating a conversation (chat history)

Project description

QV Ollama SDK

A simple SDK for interacting with the Ollama API with thinking mode and tool calling support.

Features

  • 🧠 Thinking Mode - See AI reasoning process before answers
  • 🛠️ Tool Calling - Execute Python functions automatically
  • 💬 Simple Conversation - Easy chat interface
  • Streaming Support - Real-time responses
  • 🔧 Explicit Parameters - No unnecessary defaults
  • 🛡️ Model Compatibility - Auto-fallback for unsupported features

Installation

pip install qv-ollama-sdk

Quick Start

from qv_ollama_sdk import OllamaChatClient

# Create a client with a system message
client = OllamaChatClient(
    model_name="qwen3:8b",
    system_message="You are a helpful assistant."
)

# Simple chat - uses Ollama's default parameters
response = client.chat("What is the capital of France?")
print(response.content)

# Continue the conversation
response = client.chat("And what is its population?")
print(response.content)

# Set specific parameters only when you need them
client.temperature = 1.0  # Using property setter
client.max_tokens = 500   # Using property setter
client.set_parameters(num_ctx=2048)  # For multiple parameters

# Get conversation history
history = client.get_history()

🧠 Thinking Mode

# Enable thinking globally
client.enable_thinking()
response = client.chat("Solve this complex problem...")
print(f"🧠 Thinking: {response.thinking}")
print(f"💬 Answer: {response.content}")

# Disable when you want fast responses
client.disable_thinking()

🛠️ Tool Calling

def add_numbers(a: str, b: str) -> str:
    """Add two numbers."""
    return str(int(a) + int(b))

def get_weather(city: str) -> str:
    """Get weather for a city."""
    return f"Sunny in {city}, 23°C"

tools = [add_numbers, get_weather]

# AI automatically calls functions when needed
response = client.chat("What's 15+27? And weather in Berlin?", tools=tools)
print(response.content)

🎯 Thinking + Tools

client.enable_thinking()
response = client.chat("Calculate 25 + 18", tools=tools)

print(f"🧠 Thinking: {response.thinking}")
print(f"💬 Answer: {response.content}")
print(f"🛠️ Tools used: {len(response.tool_calls)}")

⚡ Streaming

# Stream with thinking and tools
for chunk in client.stream_chat("Add 12 + 8", tools=tools):
    if chunk.thinking:
        print(chunk.thinking, end="")
    if chunk.tool_calls:
        print(f"🛠️ Using: {chunk.tool_calls[0].function.name}")
    if chunk.content:
        print(chunk.content, end="")

API Reference

Main Methods

  • chat(message, tools=None, auto_execute=True) - Get response
  • stream_chat(message, tools=None, auto_execute=True) - Stream response

Thinking Control

  • enable_thinking() - Enable thinking globally
  • disable_thinking() - Disable thinking globally

Response Object

  • response.content - The answer
  • response.thinking - AI's thought process
  • response.tool_calls - Tools that were called
  • response.tool_results - Tool execution results

Parameters

  • tools=None - List of Python functions
  • auto_execute=True - Auto-run tools (default)
  • auto_execute=False - Raw tool calls only

🛡️ Model Compatibility

The SDK automatically handles different model capabilities:

# Works with any model - features auto-disabled if unsupported
client = OllamaChatClient(model_name="gemma2:2b")  # No tool/thinking support
client.enable_thinking()  # Will be ignored if not supported
tools = [add_numbers]

# This still works! Falls back to normal chat
response = client.chat("What is 15 + 27?", tools=tools)
# → "15 + 27 equals 42" (calculated by model, no tools used)

Supported Models:

  • Modern models (e.g., qwen3:8b) - Full features
  • Tool-only models (e.g., llama3:8b) - Tools but no thinking
  • Thinking-only models - Thinking but no tools
  • Basic models (e.g., gemma2:2b) - Normal chat only

Graceful Degradation:

  • Unsupported features are automatically disabled
  • No errors or exceptions thrown
  • Always provides a response

Advanced Usage

For more control, you can use the lower-level API:

from qv_ollama_sdk import Conversation, OllamaConversationService, ModelParameters

# Create a conversation
conversation = Conversation(model_name="qwen3:8b")
conversation.add_system_message("You are a helpful assistant.")
conversation.add_user_message("What is the capital of France?")

# Generate a response with specific parameters including thinking
service = OllamaConversationService()
parameters = ModelParameters(temperature=0.7, num_ctx=2048, think=True)
response = service.generate_response(conversation, parameters)

print(f"Thinking: {response.thinking}")
print(f"Answer: {response.content}")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

qv_ollama_sdk-0.4.0.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

qv_ollama_sdk-0.4.0-py3-none-any.whl (14.3 kB view details)

Uploaded Python 3

File details

Details for the file qv_ollama_sdk-0.4.0.tar.gz.

File metadata

  • Download URL: qv_ollama_sdk-0.4.0.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.5.5

File hashes

Hashes for qv_ollama_sdk-0.4.0.tar.gz
Algorithm Hash digest
SHA256 ce97a0747572fb667a9da19f504fc298d4c80c287f3f8354c3da5e974c0e7ab2
MD5 62e346679b57ff810e00c7a72f46b2f4
BLAKE2b-256 56929fcf30664afed5ffbc366aba7aaba5480b96b0a7e2424c99c27cd0a63fd0

See more details on using hashes here.

File details

Details for the file qv_ollama_sdk-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for qv_ollama_sdk-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7af1a8793c10d6175f41d1c488a520687a1bb72a85f772b47784508154b5dbc5
MD5 2db1786e2c6250f196788a7ea6a92abe
BLAKE2b-256 3b546f77d66465cd227e0c71a468bde5f3eed6a8da8d7625ac4139b62bf8cb19

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page