Evaluations - Get

Service:

AI Foundry

API Version:

2025-05-15-preview

Get an evaluation run by name.

GET {endpoint}/evaluations/runs/{name}?api-version=2025-05-15-preview

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string (uri)	Project endpoint. In the form "https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/_project" if your Foundry Hub has only one Project, or to use the default Project in your Hub. Or in the form "https://<your-ai-services-account-name>.services.ai.azure.com/api/projects/<your-project-name>" if you want to explicitly specify the Foundry Project name.
name	path	True	string	Identifier of the evaluation.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
x-ms-client-request-id		string (uuid)	An opaque, globally-unique, client-generated string identifier for the request.

Responses

Name	Type	Description
200 OK	Evaluation	The request has succeeded. Headers x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	An unexpected error response. Headers x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Scopes

Name	Description
https://ai.azure.com/.default

Examples

Evaluations_Get_MaximumSet

Sample request

HTTP

GET {endpoint}/evaluations/runs/so?api-version=2025-05-15-preview

Sample response

Status code:

200

{
  "id": "aarhggbojnh",
  "data": {
    "type": "InputData"
  },
  "displayName": "ymjxkodggqrhjnmusta",
  "description": "cuviaxytqckkybxwc",
  "status": "uhejnohmiiogajkx",
  "tags": {
    "key30": "nqrdpedyhkjzgrbtqhxbmkdmlpdf"
  },
  "properties": {
    "key9192": "e"
  },
  "evaluators": {
    "key2735": {
      "id": "gujwtvhptykq",
      "initParams": {},
      "dataMapping": {
        "key7400": "ijkjfvoswni"
      }
    }
  }
}

Definitions

Name	Description
Azure.Core.Foundations.Error	The error object.
Azure.Core.Foundations.ErrorResponse	A response containing error details.
Azure.Core.Foundations.InnerError	An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
Evaluation	Evaluation Definition
EvaluatorConfiguration	Evaluator Configuration
InputDataset	Dataset as source for evaluation.

Azure.Core.Foundations.Error

Object

The error object.

Name	Type	Description
code	string	One of a server-defined set of error codes.
details	Azure.Core.Foundations.Error[]	An array of details about specific errors that led to this reported error.
innererror	Azure.Core.Foundations.InnerError	An object containing more specific information than the current object about the error.
message	string	A human-readable representation of the error.
target	string	The target of the error.

Azure.Core.Foundations.ErrorResponse

Object

A response containing error details.

Name	Type	Description
error	Azure.Core.Foundations.Error	The error object.

Azure.Core.Foundations.InnerError

Object

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Name	Type	Description
code	string	One of a server-defined set of error codes.
innererror	Azure.Core.Foundations.InnerError	Inner error.

Evaluation

Object

Evaluation Definition

Name	Type	Description
data	InputData: InputDataset	Data for evaluation.
description	string	Description of the evaluation. It can be used to store additional information about the evaluation and is mutable.
displayName	string	Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique.
evaluators	<string,  EvaluatorConfiguration>	Evaluators to be used for the evaluation.
id	string	Identifier of the evaluation.
properties	object	Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed.
status	string	Status of the evaluation. It is set by service and is read-only.
tags	object	Evaluation's tags. Unlike properties, tags are fully mutable.

EvaluatorConfiguration

Object

Evaluator Configuration

Name	Type	Description
dataMapping	object	Data parameters of the evaluator.
id	string	Identifier of the evaluator.
initParams		Initialization parameters of the evaluator.

InputDataset

Object

Dataset as source for evaluation.

Name	Type	Description
id	string	Evaluation input data
type	string: dataset	Type of the data