Preparing search index...
The search index is not available
Arize Phoenix TS
Arize Phoenix TS
@arizeai/phoenix-evals
llm/createDocumentRelevanceEvaluator
DocumentRelevanceEvaluatorArgs
Interface DocumentRelevanceEvaluatorArgs<RecordType>
interface
DocumentRelevanceEvaluatorArgs
<
RecordType
extends
Record
<
string
,
unknown
>
=
DocumentRelevanceEvaluationRecord
,
>
{
choices
?:
ClassificationChoicesMap
;
inputMapping
?:
ObjectMapping
<
RecordType
>
;
model
:
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?
input
Mapping?
model
name?
optimization
Direction?
prompt
Template?
telemetry?
Properties
Optional
choices
choices
?:
ClassificationChoicesMap
Optional
input
Mapping
inputMapping
?:
ObjectMapping
<
RecordType
>
The mapping of the input to evaluate to the shape that the evaluator expects
model
model
:
LanguageModel
Optional
name
name
?:
string
Optional
optimization
Direction
optimizationDirection
?:
OptimizationDirection
Optional
prompt
Template
promptTemplate
?:
PromptTemplate
Optional
telemetry
telemetry
?:
TelemetryConfig
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Properties
choices
input
Mapping
model
name
optimization
Direction
prompt
Template
telemetry
Arize Phoenix TS
Loading...
The mapping of the input to evaluate to the shape that the evaluator expects