Skip to main content
Microsoft Foundry
Sign in
View as Markdown
View as Markdown
Evaluators

Update an evaluator version

PATCH
/evaluators/{name}/versions/{version}

Updates the specified evaluator version in place.

Path Parameters
namestringrequired
The name of the resource
versionstringrequired
The version of the EvaluatorVersion to update.
Request BodyEvaluator resourceContent-Type: application/json
display_namestring
Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
metadataobject
Metadata about the evaluator
categoriesenum[]
The categories of the evaluator
qualitysafetyagents
supported_evaluation_levelsenum[]
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).
turnconversation
descriptionstring
The asset description text.
tagsobject
Tag dictionary. Tags can be added, removed, and updated.
Responses
display_namestring
Display Name for evaluator. It helps to find the evaluator easily in AI Foundry. It does not need to be unique.
metadataobject
Metadata about the evaluator
evaluator_typeenumrequired
The type of the evaluator
builtincustom
categoriesenum[]required
The categories of the evaluator
qualitysafetyagents
supported_evaluation_levelsenum[]
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).
turnconversation
definitioncode | prompt | rubric | endpointrequired
Base evaluator configuration with discriminator
One of the following:
codeCodeBasedEvaluatorDefinition
Code-based evaluator definition using python code
promptPromptBasedEvaluatorDefinition
Prompt-based evaluator
rubricRubricBasedEvaluatorDefinition
Rubric-based evaluator definition — stores dimensions produced by the generate API. Used for both quality and safety evaluators.
endpointEndpointBasedEvaluatorDefinition
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.
generation_artifactsEvaluatorGenerationArtifacts
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.
datasetDatasetReferencerequired
Reference to a versioned Foundry Dataset.
kindsstring[]required
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_idstring
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.
warningsenum[]
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.
input_quality
created_bystringrequired
Creator of the evaluator
created_atstringrequired
Creation date/time of the evaluator
modified_atstringrequired
Last modified date/time of the evaluator
idstring
Asset ID, a unique identifier for the asset
namestringrequired
The name of the resource
versionstringrequired
The version of the resource