Type Alias EvaluationResult

EvaluationResult: {
    key: string;
    comment?: string;
    correction?: Record<string, unknown>;
    evaluatorInfo?: Record<string, unknown>;
    feedbackConfig?: FeedbackConfig;
    score?: ScoreType;
    sourceRunId?: string;
    targetRunId?: string;
    value?: ValueType;
}

Represents the result of an evaluation.

Type declaration

  • key: string

    The key associated with the evaluation result.

  • Optionalcomment?: string

    A comment associated with the evaluation result.

  • Optionalcorrection?: Record<string, unknown>

    A correction record associated with the evaluation result.

  • OptionalevaluatorInfo?: Record<string, unknown>

    Information about the evaluator.

  • OptionalfeedbackConfig?: FeedbackConfig

    The feedback config associated with the evaluation result. If set, this will be used to define how a feedback key should be interpreted.

  • Optionalscore?: ScoreType

    The score of the evaluation result.

  • OptionalsourceRunId?: string

    The source run ID of the evaluation result. If set, a link to the source run will be available in the UI.

  • OptionaltargetRunId?: string

    The target run ID of the evaluation result. If this is not set, the target run ID is assumed to be the root of the trace.

  • Optionalvalue?: ValueType

    The value of the evaluation result.