Overview

Complete API documentation for Giskard Checks - a comprehensive testing framework for AI applications.

API Modules

Explore the Giskard Checks API organized by functionality:

⚙️ Core Base classes and fundamental types: Check, Trace, Interaction, Scenario, TestCase

✅ Checks Ready-to-use validation checks: string matching, comparisons, LLM-based checks

🎬 Scenarios Multi-step workflow testing with scenario builders and runners

🧪 Testing Utilities Testing utilities: test runners, spies, and debugging helpers

🔧 Generators Input generators for creating dynamic test data and scenarios

🛠️ Utilities Helper functions for normalization, value providers, and parameter injection

Quick Reference

Most Common Imports

from giskard.checks import (
    # Core types
    Check,
    CheckResult,
    CheckStatus,
    Interaction,
    Trace,

    # Interaction specs
    InteractionSpec,
    BaseInteractionSpec,

    # Scenarios
    Scenario,
    TestCase,

    # Built-in checks
    from_fn,
    StringMatching,
    Equals,
    NotEquals,
    LesserThan,
    GreaterThan,
    LesserThanEquals,
    GreaterEquals,

    # Configuration
    set_default_generator,
    get_default_generator,
)

# LLM-based checks
from giskard.checks import (
    BaseLLMCheck,
    LLMCheckResult,
    Groundedness,
    Conformity,
    LLMJudge,
    SemanticSimilarity,
)

Package Structure

giskard.checks/
├── core/                 # Base classes and fundamental types
│   ├── check.py          # Check base class
│   ├── trace.py          # Trace and Interaction
│   ├── interaction.py    # InteractionSpec, BaseInteractionSpec
│   ├── result.py         # CheckResult, CheckStatus
│   ├── scenario.py       # Scenario
│   ├── testcase.py       # TestCase
│   └── extraction.py     # Extractors
│
├── builtin/              # Ready-to-use checks
│   ├── fn.py             # from_fn, FnCheck
│   ├── string_matching.py # StringMatching
│   ├── comparison.py     # Equals, NotEquals, etc.
│   └── semantic_similarity.py # SemanticSimilarity
│
├── judges/               # LLM-based checks
│   ├── base.py           # BaseLLMCheck, LLMCheckResult
│   ├── groundedness.py   # Groundedness check
│   ├── conformity.py     # Conformity check
│   └── judge.py          # LLMJudge
│
├── scenarios/            # Multi-step workflows
│   ├── builder.py        # Scenario builder
│   └── runner.py         # ScenarioRunner
│
├── testing/              # Testing utilities
│   ├── runner.py         # TestCaseRunner
│   └── spy.py            # WithSpy
│
├── generators/           # Input generators
│   └── user.py           # User input generators
│
├── interaction/          # Interaction specifications
│   └── __init__.py       # InteractionSpec
│
└── utils/                # Helper utilities
    ├── generator.py      # Generator utilities
    ├── normalization.py  # Value normalization
    ├── parameter_injection.py # Parameter injection
    └── value_provider.py # Value providers