Interface DocumentRelevanceEvaluatorArgs<RecordType>

Arguments for the document relevance evaluator.

Deprecated

Use RetrievalRelevanceEvaluatorArgs instead. This type will be removed in the next major release.

interface DocumentRelevanceEvaluatorArgs<
    RecordType extends
        Record<string, unknown> = DocumentRelevanceEvaluationRecord,
> {
    choices?: ClassificationChoicesMap;
    inputMapping?: ObjectMapping<RecordType>;
    model: EvaluationModelV4 | LanguageModel;
    name?: string;
    optimizationDirection?: OptimizationDirection;
    promptTemplate?: PromptTemplate;
    telemetry?: TelemetryConfig;
}

Type Parameters

RecordType extends Record<string, unknown> = DocumentRelevanceEvaluationRecord

Hierarchy

Omit<
CreateClassificationEvaluatorArgs<RecordType>,
"promptTemplate" | "choices" | "optimizationDirection" | "name",
>
- DocumentRelevanceEvaluatorArgs

Index

Properties

choices? inputMapping? model name? optimizationDirection? promptTemplate? telemetry?

Properties

`Optional`choices

choices?: ClassificationChoicesMap

`Optional`inputMapping

inputMapping?: ObjectMapping<RecordType>

The mapping of the input to evaluate to the shape that the evaluator expects

model

model: EvaluationModelV4 | LanguageModel

`Optional`name

name?: string

`Optional`optimizationDirection

optimizationDirection?: OptimizationDirection

`Optional`promptTemplate

promptTemplate?: PromptTemplate

`Optional`telemetry

telemetry?: TelemetryConfig