Evaluators
Create an evaluator version
Creates a new evaluator version with an auto-incremented version identifier.
Parametry dotazů
api-version
string
vyžadováno
The API version to use for this operation.
Parametry cesty
name
string
vyžadováno
The name of the resource
Text požadavku
display_name
string
Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
metadata
object
Metadata about the evaluator
evaluator_type
string | enum
vyžadováno
The type of the evaluator
enum
categories
EvaluatorCategory[]
vyžadováno
The categories of the evaluator
supported_evaluation_levels
EvaluationLevel[]
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).
definition
code | prompt | rubric | endpoint
vyžadováno
Base evaluator configuration with discriminator
code
CodeBasedEvaluatorDefinition
Code-based evaluator definition using python code
type
enum
vyžadováno
code_text
string
Inline code text for the evaluator
entry_point
string
The entry point Python file name for the uploaded evaluator code (e.g. 'answer_length_evaluator.py')
image_tag
string
The container image tag to use for evaluator code execution
blob_uri
string
The blob URI for the evaluator storage
prompt
PromptBasedEvaluatorDefinition
Prompt-based evaluator
type
enum
vyžadováno
prompt_text
string
vyžadováno
The prompt text used for evaluation
rubric
RubricBasedEvaluatorDefinition
Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.
type
enum
vyžadováno
dimensions
Dimension[]
vyžadováno
The set of dimensions — the scoring blueprint used by the LLM judge. Quality evaluators include a non-editable residual dimension with id 'general_quality' (always_applicable: true); safety evaluators include 'general_policy_compliance'. Both use the same Dimension structure.
pass_threshold
number
Pass/fail threshold for the aggregate rubric score, on the same normalized 0.0-1.0 scale as the emitted score. When the runtime weighted average meets or exceeds this value, the result is pass. Defaults to 0.5 (equivalent to a raw 1-5 weighted average of 3.0). The 'any dimension scored 1 → fail' rule still applies regardless of this threshold.
endpoint
EndpointBasedEvaluatorDefinition
Endpoint-based evaluator definition. The customer owns and hosts an HTTP endpoint that implements the evaluation contract. The evaluator references a Project Connection by name; the connection stores the endpoint URL and credentials (API Key or Entra ID). At execution time, the service resolves the connection to obtain the endpoint URL and authentication details, then calls the endpoint for each evaluation row.
type
enum
vyžadováno
connection_name
string
vyžadováno
Name of the Project Connection that stores the endpoint URL and credentials. The connection must exist on the project and have a non-empty target URL. Supported auth types: ApiKey (sends api-key header) and AAD/Entra ID (acquires a bearer token via the project's Managed Identity).
description
string
The asset description text.
tags
object
Tag dictionary. Tags can be added, removed, and updated.
Odpovědi
The request has succeeded and a new resource has been created as a result.
Text
display_name
string
Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
metadata
object
Metadata about the evaluator
evaluator_type
string | enum
vyžadováno
The type of the evaluator
enum
categories
EvaluatorCategory[]
vyžadováno
The categories of the evaluator
supported_evaluation_levels
EvaluationLevel[]
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).
definition
code | prompt | rubric | endpoint
vyžadováno
Base evaluator configuration with discriminator
code
CodeBasedEvaluatorDefinition
Code-based evaluator definition using python code
type
enum
vyžadováno
code_text
string
Inline code text for the evaluator
entry_point
string
The entry point Python file name for the uploaded evaluator code (e.g. 'answer_length_evaluator.py')
image_tag
string
The container image tag to use for evaluator code execution
blob_uri
string
The blob URI for the evaluator storage
prompt
PromptBasedEvaluatorDefinition
Prompt-based evaluator
type
enum
vyžadováno
prompt_text
string
vyžadováno
The prompt text used for evaluation
rubric
RubricBasedEvaluatorDefinition
Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.
type
enum
vyžadováno
dimensions
Dimension[]
vyžadováno
The set of dimensions — the scoring blueprint used by the LLM judge. Quality evaluators include a non-editable residual dimension with id 'general_quality' (always_applicable: true); safety evaluators include 'general_policy_compliance'. Both use the same Dimension structure.
pass_threshold
number
Pass/fail threshold for the aggregate rubric score, on the same normalized 0.0-1.0 scale as the emitted score. When the runtime weighted average meets or exceeds this value, the result is pass. Defaults to 0.5 (equivalent to a raw 1-5 weighted average of 3.0). The 'any dimension scored 1 → fail' rule still applies regardless of this threshold.
endpoint
EndpointBasedEvaluatorDefinition
Endpoint-based evaluator definition. The customer owns and hosts an HTTP endpoint that implements the evaluation contract. The evaluator references a Project Connection by name; the connection stores the endpoint URL and credentials (API Key or Entra ID). At execution time, the service resolves the connection to obtain the endpoint URL and authentication details, then calls the endpoint for each evaluation row.
type
enum
vyžadováno
connection_name
string
vyžadováno
Name of the Project Connection that stores the endpoint URL and credentials. The connection must exist on the project and have a non-empty target URL. Supported auth types: ApiKey (sends api-key header) and AAD/Entra ID (acquires a bearer token via the project's Managed Identity).
generation_artifacts
EvaluatorGenerationArtifacts
Service-managed provenance artifacts produced by an evaluator generation job. Present only on EvaluatorVersion resources created via the generation pipeline. The combined-JSONL Foundry Dataset is read-only and resolves to a versioned dataset in a service-reserved namespace.
dataset
DatasetReference
vyžadováno
Reference to a versioned Foundry Dataset.
name
string
vyžadováno
Dataset name.
version
string
vyžadováno
Dataset version.
kinds
string[]
vyžadováno
The kinds of rows present in dataset. Always contains "spec" (the generated evaluation specification, a Markdown document describing what the evaluator measures). May additionally contain "tools" (when the generation pipeline produced or inferred OpenAI tool schemas) and/or "context" (when supplementary materials such as file uploads or trace samples were used during generation).
generation_job_id
string
Read-only provenance link back to the EvaluatorGenerationJob that produced this version. Present only on evaluator versions created via the generation pipeline; absent for manually-created versions and unaffected by subsequent PATCH calls.
warnings
GenerationWarningType[]
Categories of warnings surfaced on this generated evaluator version. Present only on versions created via an EvaluatorGenerationJob when the paired job produced non-empty warnings. Absent (treat as no warnings) when the version is not from generation, when the paired job was clean, or when a subsequent PATCH to definition cleared the paired job's advisories. Follow generation_job_id to fetch the detailed warning payloads.
created_by
string
vyžadováno
Creator of the evaluator
created_at
string
vyžadováno
Creation date/time of the evaluator
modified_at
string
vyžadováno
Last modified date/time of the evaluator
id
string
Asset ID, a unique identifier for the asset
name
string
vyžadováno
The name of the resource
version
string
vyžadováno
The version of the resource
Žádost
POST /evaluators/{name}/versions HTTP/1.1
Response
Status: 201
Content-Type: application/json
Status: 4XX
Content-Type: application/json
Status: 5XX
Content-Type: application/json