Type Alias EvaluationResultArgs<TValue>

Base constructor arguments for EvaluationResult classes

type EvaluationResultArgs<TValue = any> = {
    confidence: number;
    dimensions?: (
        | EvaluationStringResult
        | EvaluationNumberResult
        | EvaluationBooleanResult
    )[];
    feedback?: EvaluationFeedback[];
    name?: string;
    reasoning?: string;
    value: TValue;
}

Type Parameters

TValue = any

Index

Properties

confidence dimensions? feedback? name? reasoning? value

Properties

confidence

confidence: number

The confidence in the evaluation

`Optional`dimensions

dimensions?: (
    | EvaluationStringResult
    | EvaluationNumberResult
    | EvaluationBooleanResult
)[]

Dimensions of this evaluation

`Optional`feedback

feedback?: EvaluationFeedback[]

Feedback for this evaluation

`Optional`name

name?: string

The name of the evaluation

`Optional`reasoning

reasoning?: string

The reasoning behind the result

value

value: TValue

The value of the evaluation