Skip to content

Reference

Reference is the lookup layer for Truthound Core. Use it when you already know which command, function, type, or option you need and want the canonical details without walking through a tutorial.

This section does not try to document the whole product line in one place. For host-native adapters, go to Truthound Orchestration. For review-layer APIs, go to Truthound AI. For control-plane APIs and operations, go to Truthound Dashboard.

What Lives Here

Python API

Use the Python API reference when you want to:

  • call the core truthound package from notebooks, scripts, services, or jobs
  • inspect ValidationRunResult and related result types directly
  • work with truthound.drift, truthound.checkpoint, truthound.reporters, or truthound.profiler
  • jump from guides into function-level or class-level documentation

Recommended entry points:

CLI

Use the CLI reference when you want to:

  • run core validations without writing Python
  • generate suites, docs, and benchmark artifacts from the terminal
  • operate checkpoints from shell scripts or CI
  • scaffold validators, reporters, and plugins

Recommended entry points:

Layer Boundaries

Need Best section
Install Truthound and run your first validation Getting Started
Learn with end-to-end runnable examples Tutorials
Solve a feature-specific core task Guides
Understand the layered system and kernel boundaries Concepts & Architecture
Use the optional prompt-to-proposal and run-analysis APIs Truthound AI
Run Truthound inside Airflow, Dagster, Prefect, dbt, Mage, or Kestra Truthound Orchestration
Operate a UI, RBAC, artifacts, incidents, and observability Truthound Dashboard

Common Lookup Paths