Skip to main content

Official Python SDK for the Latitude API

Project description

Latitude Python SDK

Official Python client for the Latitude public API. Typed access to projects, traces, issues, datasets, scores, annotations, and more.

The SDK is generated from our OpenAPI spec and follows Semantic Versioning — breaking changes only land with a major version bump. See CHANGELOG.md.

Upgrading from 5.x? Version 6 is a complete rewrite for the new Latitude platform and is not backwards compatible — none of the 5.x surface (prompts, runs, evaluations push, logs) carries over.

Installation

pip install latitude-sdk

Quick Start

import os

from latitude_sdk import AnnotationAnchor, LatitudeApiClient, TraceRef_Id

client = LatitudeApiClient(token=os.environ["LATITUDE_API_KEY"])

# Create an annotation against a known trace.
annotation = client.annotations.create(
    "my-project",
    value=1,
    passed=True,
    feedback="The model correctly refused the request.",
    trace=TraceRef_Id(id="0123456789abcdef0123456789abcdef"),
    anchor=AnnotationAnchor(message_index=2, part_index=0),
)

The client is constructed once and reused — each resource (client.projects, client.traces, client.issues, client.scores, client.annotations, …) is lazily instantiated on first access.

Async

Every resource has an async twin on AsyncLatitudeApiClient:

from latitude_sdk import AsyncLatitudeApiClient

client = AsyncLatitudeApiClient(token=os.environ["LATITUDE_API_KEY"])
projects = await client.projects.list()

Authentication

The SDK uses bearer-token auth. Pass the token at construction — either a string or a zero-argument callable when the token is fetched dynamically:

client = LatitudeApiClient(token=lambda: fetch_token_from_vault())

Configuration

from latitude_sdk import LatitudeApiClient
from latitude_sdk.environment import LatitudeApiClientEnvironment

client = LatitudeApiClient(
    token=os.environ["LATITUDE_API_KEY"],

    # Override the base URL (defaults to https://api.latitude.so).
    base_url="https://api.staging.latitude.so",

    # Or pick a named environment.
    environment=LatitudeApiClientEnvironment.PRODUCTION,

    # Default request timeout in seconds (60 by default).
    timeout=30,

    # Extra headers added to every request.
    headers={"x-tenant": "acme"},

    # Custom httpx client (proxies, transports, testing).
    httpx_client=my_httpx_client,
)

Examples

Resolving a trace by filter

When you don't have the OpenTelemetry trace id at hand, target the trace by attribute filters. Exactly one trace must match.

from latitude_sdk import TraceRef_Filters

client.annotations.create(
    "my-project",
    value=1,
    passed=True,
    feedback="Approved.",
    trace=TraceRef_Filters(
        filters={"metadata.scoreId": [{"op": "eq", "value": "score-abc-123"}]},
    ),
)

Custom scores

Every score targets a trace. trace accepts the same TraceRef_Id / TraceRef_Filters shape as annotations; the session and span are auto-resolved from the trace.

client.scores.create(
    "my-project",
    source_id="my-eval-pipeline",
    trace=TraceRef_Id(id="0123456789abcdef0123456789abcdef"),
    value=0.87,
    passed=True,
    feedback="Score from custom pipeline",
)

Listing and creating API keys

page = client.api_keys.list()

new_key = client.api_keys.create(name="ci-pipeline")

Error Handling

All non-2xx responses raise latitude_sdk.core.ApiError — or one of its typed subclasses for documented status codes (BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, ContentTooLargeError).

from latitude_sdk import NotFoundError
from latitude_sdk.core import ApiError

try:
    client.annotations.create("my-project", **body)
except NotFoundError:
    ...  # 404 — trace not in this project, etc.
except ApiError as err:
    print(err.status_code, err.body)

Per-Request Options

Every resource method accepts an optional request_options argument for per-call overrides:

client.annotations.create(
    "my-project",
    **body,
    request_options={
        "timeout_in_seconds": 5,
        "max_retries": 0,
        "additional_headers": {"x-request-id": request_id},
    },
)

Source and Regeneration

The SDK source under src/ is generated by Fern from apps/api/openapi.json. Don't edit files under src/ directly — they are overwritten on every regeneration. The package shell (pyproject.toml, this README, the changelog, tests/, examples/) is hand-written.

Runnable examples live in examples/.

To regenerate after API changes (contributor workflow):

pnpm generate:sdk

See fern/README.md for details.

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

latitude_sdk-6.0.0.tar.gz (124.3 kB view details)

Uploaded Source

Built Distribution

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

latitude_sdk-6.0.0-py3-none-any.whl (230.5 kB view details)

Uploaded Python 3

File details

Details for the file latitude_sdk-6.0.0.tar.gz.

File metadata

  • Download URL: latitude_sdk-6.0.0.tar.gz
  • Upload date:
  • Size: 124.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for latitude_sdk-6.0.0.tar.gz
Algorithm Hash digest
SHA256 c1923723e0ca66760321d03e8a6c80ba6638b61224969046441131b61968745a
MD5 454c5b1e29e07ffd5a2786537ea1746c
BLAKE2b-256 f3421a51420c717586cb42d2920ae31e9e607d8302044406371a9e985d334c81

See more details on using hashes here.

File details

Details for the file latitude_sdk-6.0.0-py3-none-any.whl.

File metadata

  • Download URL: latitude_sdk-6.0.0-py3-none-any.whl
  • Upload date:
  • Size: 230.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for latitude_sdk-6.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e0c931042e52fa96f20ece274762e825f82180368043d25dbf18b379afad7ff9
MD5 5b719a740545fb42ad5de579982dc4fa
BLAKE2b-256 da6769477ada84ba290a4c740299c9c26b8dbaf9ff31af33ad41f0a29d1f3c0d

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