Welcome to Trustwise SDK’s documentation!

Trustwise SDK is a powerful tool for evaluating AI-generated content, managing agents, guardrails, and policies through the Trustwise Platform API.

Quickstart

  1. Install the SDK:

    pip install trustwise

  2. Set up and run your first evaluation:

    import os
from trustwise.sdk.config import TrustwiseConfig
from trustwise.sdk.platform import TrustwiseClient

config = TrustwiseConfig(api_key=os.environ["TW_API_KEY"])
client = TrustwiseClient(config)

# Evaluate faithfulness
result = client.metrics.faithfulness(
    query="What is the capital of France?",
    response="The capital of France is Paris.",
    context=[{"chunk_text": "Paris is the capital of France.", "chunk_id": "doc:idx:1"}],
)
print(result.score)

# List agents
agents = client.agents.list(limit=5)

    Note

    Migrating from TrustwiseSDK? See Migrating from TrustwiseSDK to TrustwiseClient for a step-by-step guide.

Documentation Overview

This documentation is organized to help you quickly find what you need:

  • Platform Client: The recommended client for all platform APIs — agents, guardrails, policies, metrics (Platform API Client)

  • Usage: Setup, configuration, and comprehensive examples (Usage)

  • V4 Metrics: Metrics with enhanced type safety and improved response structures (V4 Metrics)

  • API Reference: Full technical documentation for all SDK classes (API Reference)

  • API Versioning: Explicit or default API versions (API Versioning)

  • SDK Migration: Migrate from TrustwiseSDK to TrustwiseClient (Migrating from TrustwiseSDK to TrustwiseClient)

  • Changelog: Track changes and feature additions (Changelog)

Contents

Indices and tables