Overview

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

API Modules

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

from giskard.checks import (
    # Core types
    Check,
    CheckResult,
    CheckStatus,
    Interaction,
    Trace,
    InteractionSpec,
    Scenario,
    TestCase,
    # Built-in checks
    FnCheck,
    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
│   ├── result.py         # CheckResult, CheckStatus
│   ├── scenario.py       # Scenario
│   ├── testcase.py       # TestCase
│   ├── extraction.py     # Extractors
│   └── interaction/      # Interaction types
├── builtin/              # Ready-to-use checks
│   ├── fn.py             # FnCheck
│   ├── text_matching.py  # StringMatching, RegexMatching
│   ├── comparison.py     # Equals, NotEquals, etc.
│   └── semantic_similarity.py
├── judges/               # LLM-based checks
│   ├── base.py           # BaseLLMCheck, LLMCheckResult
│   ├── groundedness.py   # Groundedness
│   ├── conformity.py     # Conformity
│   └── judge.py          # LLMJudge
├── scenarios/            # Multi-step workflows
│   ├── builder.py        # Scenario builder
│   ├── runner.py         # ScenarioRunner
│   └── suite.py          # Suite
├── testing/              # Testing utilities
│   ├── runner.py         # TestCaseRunner
│   └── spy.py            # WithSpy
├── generators/           # Input generators
│   └── user.py           # UserSimulator
└── utils/                # Helper utilities
    ├── normalization.py
    ├── value_provider.py
    ├── parameter_injection.py
    └── generator.py