Class RegressionError<Input, ExpectedOutput, Metadata>

Raised by experiment runners to signal a CI gate failure.

Intended for use with the langfuse/experiment-action GitHub Action.

Type Parameters

Input = any
ExpectedOutput = any
Metadata extends Record<string, any> = Record<string, any>

Hierarchy

Error
- RegressionError

Index

Constructors

Properties

cause? message metric? name result stack? threshold? value?

Constructors

constructor

new RegressionError<
    Input = any,
    ExpectedOutput = any,
    Metadata extends Record<string, any> = Record<string, any>,
>(
    params: RegressionErrorMessageOptions<Input, ExpectedOutput, Metadata>,
): RegressionError<Input, ExpectedOutput, Metadata>
Type Parameters
- Input = any
- ExpectedOutput = any
- Metadata extends Record<string, any> = Record<string, any>
Parameters
- params: RegressionErrorMessageOptions<Input, ExpectedOutput, Metadata>
Returns RegressionError<Input, ExpectedOutput, Metadata>
Overrides Error.constructor
- Defined in packages/client/src/experiment/RunnerContext.ts:137
new RegressionError<
    Input = any,
    ExpectedOutput = any,
    Metadata extends Record<string, any> = Record<string, any>,
>(
    params: RegressionErrorMetricOptions<Input, ExpectedOutput, Metadata>,
): RegressionError<Input, ExpectedOutput, Metadata>
Type Parameters
- Input = any
- ExpectedOutput = any
- Metadata extends Record<string, any> = Record<string, any>
Parameters
- params: RegressionErrorMetricOptions<Input, ExpectedOutput, Metadata>
Returns RegressionError<Input, ExpectedOutput, Metadata>
Overrides Error.constructor
- Defined in packages/client/src/experiment/RunnerContext.ts:140

Properties

`Optional`cause

cause?: unknown

message

message: string

`Optional` `Readonly`metric

metric?: string

name

name: string

`Readonly`result

result: ExperimentResult<Input, ExpectedOutput, Metadata>

`Optional`stack

stack?: string

`Optional` `Readonly`threshold

threshold?: number

`Optional` `Readonly`value

value?: number