EvaluatorVersion interface

Package:

@azure/ai-projects

Evaluator Definition

Properties

categories	The categories of the evaluator
created_at	Creation date/time of the evaluator
created_by	Creator of the evaluator
definition	Definition of the evaluator
description	The asset description text.
display_name	Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
evaluator_type	The type of the evaluator
generation_artifacts	Provenance artifacts from the generation pipeline. Read-only; present only on evaluator versions created via an EvaluatorGenerationJob. Each artifact resolves to a versioned Foundry Dataset.
id	Asset ID, a unique identifier for the asset
metadata	Metadata about the evaluator
modified_at	Last modified date/time of the evaluator
name	The name of the resource
supported_evaluation_levels	Evaluation levels this evaluator supports (e.g., turn, conversation). When omitted on create, the service defaults to ["turn"]. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only turn; custom prompt-based evaluators support exactly one level (turn or conversation).
tags	Tag dictionary. Tags can be added, removed, and updated.
version	The version of the resource

Property Details

categories

The categories of the evaluator

categories: EvaluatorCategory[]

Property Value

EvaluatorCategory[]

created_at

Creation date/time of the evaluator

created_at?: string

Property Value

string

created_by

Creator of the evaluator

created_by?: string

Property Value

string

definition

Definition of the evaluator

definition: EvaluatorDefinitionUnion

Property Value

EvaluatorDefinitionUnion

description

The asset description text.

description?: string

Property Value

string

display_name

Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.

display_name?: string

Property Value

string

evaluator_type

The type of the evaluator

evaluator_type: EvaluatorType

Property Value

EvaluatorType

generation_artifacts

Provenance artifacts from the generation pipeline. Read-only; present only on evaluator versions created via an EvaluatorGenerationJob. Each artifact resolves to a versioned Foundry Dataset.

generation_artifacts?: EvaluatorGenerationArtifacts

Property Value

EvaluatorGenerationArtifacts

id

Asset ID, a unique identifier for the asset

id?: string

Property Value

string

metadata

Metadata about the evaluator

metadata?: Record<string, string>

Property Value

Record<string, string>

modified_at

Last modified date/time of the evaluator

modified_at?: string

Property Value

string

name

The name of the resource

name: string

Property Value

string

supported_evaluation_levels

Evaluation levels this evaluator supports (e.g., turn, conversation). When omitted on create, the service defaults to ["turn"]. On update, omitting this field leaves it unchanged; an empty list is rejected. Custom code-based evaluators support only turn; custom prompt-based evaluators support exactly one level (turn or conversation).

supported_evaluation_levels?: EvaluationLevel[]

Property Value

EvaluationLevel[]

tags

Tag dictionary. Tags can be added, removed, and updated.

tags?: Record<string, string>

Property Value

Record<string, string>

version

The version of the resource

version?: string

Property Value

string