Skip to main content

copass-pydantic-ai

Copass retrieval as Pydantic AI tools. The LLM picks discover (menu of relevant items) or search (synthesized answer) — you don't write the tool-calling loop. interpret is exposed for back-compat but legacy; prefer search for drill-in.

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
search "Tell me about X" / "Answer this." — synthesized answer (canonical drill-in)
interpret Legacy — brief pinned to canonical_ids. Prefer search for drill-in.

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

Release files for copass-pydantic-ai 1.4.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for copass-pydantic-ai 1.4.8
File Size Uploaded
copass_pydantic_ai-1.4.8.tar.gz 8.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for copass-pydantic-ai 1.4.8
File Interpreter ABI Platform
copass_pydantic_ai-1.4.8-py3-none-any.whl Python 3 none any Details

Total release size: 16.0 kB

Release files / copass_pydantic_ai-1.4.8.tar.gz

Download URL copass_pydantic_ai-1.4.8.tar.gz
Size 8.0 kB
Tags Source
SHA-256 checksum
How to use checksums
89957cf47f4c46b024f9eeb05892dd721a03796213b9911ef6507bcb39d4a50b
BLAKE2b-256 checksum
How to use checksums
922194950c181c4d7e9b97af15a84791f1ee64856d0b5f282d430a0d9d0ff029
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 30, 2026.

Transparency log

Release files / copass_pydantic_ai-1.4.8-py3-none-any.whl

Download URL copass_pydantic_ai-1.4.8-py3-none-any.whl
Size 8.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7dae1e79cd1d03260469a4ef4b8f6028e12361a7d953f2d483fa9ef242e2c789
BLAKE2b-256 checksum
How to use checksums
e60a7d6e50a7aae9404439a069ed03460fc4778ebeda6df420f1a98dc6096eaf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on May 30, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.4.8 This release

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

0.6.0

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page