Giskard Checks API Reference

These pages document the symbols in giskard.checks you will use directly. They assume you have written a test already. If you have not, start with Your First Test; the terms used here (scenario, check, trace, judge) are introduced in Core Concepts.

API modules

Core Base classes and types: Check, Trace, mixins, InteractionGenerationError, Scenario, TestCase

Checks Ready-to-use validation checks: string matching, comparisons, RegoPolicy, composition, LLM judges

Scenarios Scenario builders, tags, SuiteResult grouping, and Hub export

Testing Utilities TestCase, TestCaseResult, TestCaseError, spies, and debugging helpers

Generators UserSimulator, LLMGenerator, DatasetInputGenerator, and custom InputGenerator subclasses

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

Settings Default LLM generator, embedding model, and environment-backed GiskardChecksSettings

Quick reference

from giskard.checks import (
    # Core types
    Check,
    CheckResult,
    CheckStatus,
    Interaction,
    InteractionSpec,
    InteractionGenerationError,
    Trace,
    Scenario,
    ScenarioStatus,
    TestCase,
    TestCaseError,
    TestCaseStatus,
    Suite,
    SuiteResult,
    GroupedSuiteResult,
    GroupStats,
    WithGeneratorMixin,
    WithEmbeddingMixin,
    # Built-in checks
    FnCheck,
    StringMatching,
    RegexMatching,
    JsonValid,
    Readability,
    SemanticSimilarity,
    Equals,
    NotEquals,
    LessThan,
    LessThanEquals,
    GreaterThan,
    GreaterThanEquals,
    AllOf,
    AnyOf,
    Not,
    RegoPolicy,
    # Configuration
    set_default_generator,
    get_default_generator,
)

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

# Generators
from giskard.checks import LLMGenerator, DatasetInputGenerator, UserSimulator

# Suite generation lives in the scan package, not in giskard.checks
from giskard.scan import generate_suite