API Reference
@kyro/judge
Full API reference for the Judge class and related types.
Judge
The main class for running evaluation pipelines.
Constructor
| Parameter | Type | Description |
|---|---|---|
configPath | string | Path to the YAML pipeline config file |
provider | AIProvider | AI provider instance from @kyro/shared |
options | JudgeOptions? | Optional configuration |
.run(input, variables?)
Execute the evaluation pipeline against an input.
| Parameter | Type | Description |
|---|---|---|
input | string | object | Transcript string, JSON object, or file path |
variables | Record<string, string>? | Template variables for prompt interpolation |
KyroResult
StepResult
Error types
| Class | Description |
|---|---|
KyroError | Base error class |
KyroConfigError | Invalid YAML config, schema validation failure, circular dependency |
KyroExecutionError | Runtime error during step execution |
KyroProviderError | AI provider API error |