Skip to main content

Calibrate Python Library

fern shield pypi

The Calibrate Python SDK provides convenient, typed access to the Calibrate agent evaluation platform API. Authenticate with an API key (sk_…) scoped to your organization to run agent tests and poll their results.

Table of Contents

Documentation

API reference documentation is available here.

Installation

pip install calibrate-sdk

Pre-requisites

You need to have a Calibrate API key. You can get the API key from the UI.

Reference

A full reference for this library is available here.

Quick Start

from calibrate import Calibrate

client = Calibrate(api_key="sk_...")

# List the agents in your organization
agents = client.agents.list()

# Kick off a test run for an agent and poll for the result
run = client.agent_tests.run(agent_uuid="<agent-uuid>")
result = client.agent_tests.get_run(task_id=run.task_id)

Usage

Instantiate and use the client with the following:

from calibrate import Calibrate

client = Calibrate(
    api_key="<value>",
)

client.agents.verify_connection(
    agent_uuid="f47ac10b-58cc-4372-a567-0e02b2c3d479",
)

Environments

This SDK allows you to configure different environments for API requests.

from calibrate import Calibrate
from calibrate.environment import CalibrateEnvironment

client = Calibrate(
    environment=CalibrateEnvironment.DEFAULT,
)

Async Client

The SDK also exports an async client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use httpx.AsyncClient() instead of httpx.Client() (e.g. for the httpx_client parameter of this client).

import asyncio

from calibrate import AsyncCalibrate

client = AsyncCalibrate(
    api_key="<value>",
)


async def main() -> None:
    await client.agents.verify_connection(
        agent_uuid="f47ac10b-58cc-4372-a567-0e02b2c3d479",
    )


asyncio.run(main())

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

from calibrate.core.api_error import ApiError

try:
    client.agents.verify_connection(...)
except ApiError as e:
    print(e.status_code)
    print(e.body)

Advanced

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .with_raw_response property. The .with_raw_response property returns a "raw" client that can be used to access the .headers and .data attributes.

from calibrate import Calibrate

client = Calibrate(...)
response = client.agents.with_raw_response.verify_connection(...)
print(response.headers)  # access the response headers
print(response.status_code)  # access the response status code
print(response.data)  # access the underlying object

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 5XX (All server errors, including 500)

recommended: retries on

  • 408 (Timeout)
  • 409 (Conflict)
  • 429 (Too Many Requests)
  • 502 (Bad Gateway)
  • 503 (Service Unavailable)
  • 504 (Gateway Timeout)

Use the max_retries request option to configure this behavior.

client.agents.verify_connection(..., request_options={
    "max_retries": 1
})

Timeouts

The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.

from calibrate import Calibrate

client = Calibrate(..., timeout=20.0)

# Override timeout for a specific method
client.agents.verify_connection(..., request_options={
    "timeout_in_seconds": 1
})

Custom Client

You can override the httpx client to customize it for your use-case. Some common use-cases include support for proxies and transports.

import httpx
from calibrate import Calibrate

client = Calibrate(
    ...,
    httpx_client=httpx.Client(
        proxy="http://my.test.proxy.example.com",
        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
    ),
)

Metadata

Release files for calibrate-sdk 0.0.58

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

Source distribution (sdist)

Source distribution for calibrate-sdk 0.0.58
File Size Uploaded
calibrate_sdk-0.0.58.tar.gz 89.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for calibrate-sdk 0.0.58
File Interpreter ABI Platform
calibrate_sdk-0.0.58-py3-none-any.whl Python 3 none any Details

Total release size: 260.7 kB

Release files / calibrate_sdk-0.0.58.tar.gz

Download URL calibrate_sdk-0.0.58.tar.gz
Size 89.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e05dd794d54ca730b38160cb4bd7b2f883a87a5dbc77c151687d9dd937530369
BLAKE2b-256 checksum
How to use checksums
19419ac1b7a1120a04338ca47e3c6428e99a5af83c54df6bbf9e8bec2e0be153
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure

Release files / calibrate_sdk-0.0.58-py3-none-any.whl

Download URL calibrate_sdk-0.0.58-py3-none-any.whl
Size 171.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0b859c1e9378f036cbdf2958fbb43b64c05afd1b00afa403d9ea3eaf14d9876a
BLAKE2b-256 checksum
How to use checksums
e40ba02e440ed1b46d33837ffb433dc6609f793743ea149833838928aab1582b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.5.1 CPython/3.10.21 Linux/6.17.0-1022-azure

Release history Release notifications | RSS feed

0.0.67

2 release files

0.0.66

2 release files

0.0.65

2 release files

0.0.64

2 release files

0.0.63

2 release files

0.0.62

2 release files

0.0.61

2 release files

0.0.60

2 release files

0.0.59

2 release files

This release

0.0.58 This release

2 release files

0.0.57

2 release files

0.0.56

2 release files

0.0.53

2 release files

0.0.52

2 release files

0.0.51

2 release files

0.0.50

2 release files

0.0.49

2 release files

0.0.48

2 release files

0.0.47

2 release files

0.0.46

2 release files

0.0.45

2 release files

0.0.44

2 release files

0.0.43

2 release files

0.0.42

2 release files

0.0.41

2 release files

0.0.40

2 release files

0.0.39

2 release files

0.0.38

2 release files

0.0.37

2 release files

0.0.36

2 release files

0.0.35

2 release files

0.0.34

2 release files

0.0.33

2 release files

0.0.32

2 release files

0.0.31

2 release files

0.0.30

2 release files

0.0.29

2 release files

0.0.28

2 release files

0.0.27

2 release files

0.0.26

2 release files

0.0.25

2 release files

0.0.24

2 release files

0.0.23

2 release files

0.0.9

2 release files

0.0.8

2 release files

0.0.7

2 release files

0.0.6

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.3

2 release files

0.0.2

2 release files

0.0.1

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