Skip to main content

Pydantic AI tool adapters for Copass — drop-in discover/interpret/search tools for Pydantic AI agents

Project description

copass-pydantic-ai

Copass retrieval as Pydantic AI tools. The LLM decides whether to discover, interpret, or search — you don't write the tool-calling loop.

Prerequisites

Install the Copass CLI and bootstrap your account:

npm install -g @copass/cli
copass login                             # email OTP
copass setup                             # creates a sandbox, writes .olane/refs.json
copass apikey create --name my-app       # prints an olk_... key — shown once, save it
Output Use as
olk_... key printed by copass apikey create api_key on CopassRetrievalClient (typically via COPASS_API_KEY env)
sandbox_id in ./.olane/refs.json sandbox_id on copass_tools (typically via COPASS_SANDBOX_ID env)

Ingest some content so retrieval has something to return:

copass ingest path/to/file.md

Install

pip install copass-pydantic-ai pydantic-ai

Requires Python 3.10+.

Quickstart

import os
from pydantic_ai import Agent
from copass_pydantic_ai import CopassRetrievalClient, copass_tools

# COPASS_API_KEY is the olk_... token from `copass apikey create`.
# COPASS_SANDBOX_ID is from .olane/refs.json (written by `copass setup`).
client = CopassRetrievalClient(
    api_url=os.environ.get("COPASS_API_URL", "https://ai.copass.id"),
    api_key=os.environ["COPASS_API_KEY"],
)
discover, interpret, search = copass_tools(
    client=client,
    sandbox_id=os.environ["COPASS_SANDBOX_ID"],
)

agent = Agent(
    "anthropic:claude-opus-4-7",
    tools=[discover, interpret, search],
)
result = await agent.run("what do we know about checkout retry behavior?")
print(result.output)

If it worked, the answer cites concepts from whatever you ingested. Run twice with a shared window (see below) — the second call won't re-surface items the agent already used.

Why this, not the raw API

  • LLM chooses the retrieval shape. Three tools; the model picks the right one per turn.
  • Pydantic AI-native. Type hints become the schema; docstrings become descriptions. No decorator dance.
  • Trimmed responses. Tools return only what the model needs — no sandbox/query echoes.

Tools

Tool When the LLM calls it
discover "What's relevant?" — ranked menu of pointers
interpret "Tell me about these specific items." — brief pinned to canonical_ids
search "Answer this directly." — full synthesized answer

Window-aware retrieval

Pass any object with a get_turns() method:

class MyWindow:
    def __init__(self):
        self.turns: list[dict[str, str]] = []
    def get_turns(self) -> list[dict[str, str]]:
        return self.turns

window = MyWindow()
discover, interpret, search = copass_tools(
    client=client,
    sandbox_id=project_refs["sandbox_id"],
    window=window,
)

Every retrieval call forwards window.get_turns() as history so the server excludes already-seen content.

Low-level client

If you don't want the Pydantic AI wrapping, CopassRetrievalClient is a minimal async httpx client you can use directly:

menu = await client.discover("sb_...", query="...")
brief = await client.interpret("sb_...", query="...", items=[["cid1", "cid2"]])
answer = await client.search("sb_...", query="...")

Related

License

MIT

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

copass_pydantic_ai-0.5.0.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

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

copass_pydantic_ai-0.5.0-py3-none-any.whl (8.1 kB view details)

Uploaded Python 3

File details

Details for the file copass_pydantic_ai-0.5.0.tar.gz.

File metadata

  • Download URL: copass_pydantic_ai-0.5.0.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.9

File hashes

Hashes for copass_pydantic_ai-0.5.0.tar.gz
Algorithm Hash digest
SHA256 59c7b52f8fd8957965dcc581752e6de25ee118bde09fc1356fa2e0f22eedf6f7
MD5 83ed446f99192e9363d51f143449fc81
BLAKE2b-256 ebf75d36ba870d9fcbfcfe4f8debe3239a354c092300123cb48f92cdde7efaea

See more details on using hashes here.

File details

Details for the file copass_pydantic_ai-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for copass_pydantic_ai-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bed275dd3a5a35ca014269953e6d5645481314f950e61aba0414c6dca14ba464
MD5 2cfa5141c6e18e8dfd615ab27192d11b
BLAKE2b-256 b7bd901176e6685037acf835e85ac1e5ec89962336e4a6fdccbe8a63282320cc

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