Azure.AI.Projects (preview:2025-05-15)

2025/07/16 • 3 updated methods

Evaluations_List (updated)
Description :  List evaluation runs
Reference :  Link ¶

⚶ Changes

{
  "#id": "Evaluations_List",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_0e48e5cf54a848ac85dc81d0a59d06e4": {
              "#name": "target",
              "Description": "Specifies the type and configuration of the entity used for this evaluation.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "type",
                  "Description": "Discriminator that defines the type of the evaluation target.",
                  "Enum": [
                    [
                      "modelResponseGeneration",
                      "Evaluation target that uses a model for response generation."
                    ]
                  ],
                  "Required": true,
                  "Type": "string"
                }
              ]
            }
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /evaluations/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of Evaluation items ,
}
{
value:
{
Description: The Evaluation items on this page ,
Required: True ,
}
[
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
target:
{
Description: Specifies the type and configuration of the entity used for this evaluation. ,
Required: False ,
}
{
type:
{
Description: Discriminator that defines the type of the evaluation target. ,
Enum:
{
modelResponseGeneration: Evaluation target that uses a model for response generation. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Evaluations_Get (updated)
Description :  Get an evaluation run by name.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Evaluations_Get",
  "$responses": {
    "200": {
      "$properties": {
        "@added_1b3a528163c340d4b79d52cdf7a3ecc8": {
          "#name": "target",
          "Description": "Specifies the type and configuration of the entity used for this evaluation.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "type",
              "Description": "Discriminator that defines the type of the evaluation target.",
              "Enum": [
                [
                  "modelResponseGeneration",
                  "Evaluation target that uses a model for response generation."
                ]
              ],
              "Required": true,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

GET:  /evaluations/runs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Evaluation Definition ,
}
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
target:
{
Description: Specifies the type and configuration of the entity used for this evaluation. ,
Required: False ,
}
{
type:
{
Description: Discriminator that defines the type of the evaluation target. ,
Enum:
{
modelResponseGeneration: Evaluation target that uses a model for response generation. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
Evaluations_Create (updated)
Description :  Creates an evaluation run.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Evaluations_Create",
  "$parameters": {
    "evaluation": {
      "$properties": {
        "@added_73349941fe2949ef85f2f16398b6aa52": {
          "#name": "target",
          "Description": "Specifies the type and configuration of the entity used for this evaluation.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "type",
              "Description": "Discriminator that defines the type of the evaluation target.",
              "Enum": [
                [
                  "modelResponseGeneration",
                  "Evaluation target that uses a model for response generation."
                ]
              ],
              "Required": true,
              "Type": "string"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "201": {
      "$properties": {
        "@added_43e8fb011f544b2395ee0041145570d1": {
          "#name": "target",
          "Description": "Specifies the type and configuration of the entity used for this evaluation.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "type",
              "Description": "Discriminator that defines the type of the evaluation target.",
              "Enum": [
                [
                  "modelResponseGeneration",
                  "Evaluation target that uses a model for response generation."
                ]
              ],
              "Required": true,
              "Type": "string"
            }
          ]
        }
      }
    }
  }
}

⚼ Request

POST:  /evaluations/runs:run
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
evaluation:
{
Description: Evaluation to be run ,
Required: True ,
}
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
target:
{
Description: Specifies the type and configuration of the entity used for this evaluation. ,
Required: False ,
}
{
type:
{
Description: Discriminator that defines the type of the evaluation target. ,
Enum:
{
modelResponseGeneration: Evaluation target that uses a model for response generation. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
data:
{
Description: Data for evaluation. ,
Required: True ,
}
{
type:
{
Description: Type of the data ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: Display Name for evaluation. It helps to find the evaluation easily in AI Foundry. It does not need to be unique. ,
Required: False ,
}
string ,
description:
{
Description: Description of the evaluation. It can be used to store additional information about the evaluation and is mutable. ,
Required: False ,
}
string ,
status:
{
Description: Status of the evaluation. It is set by service and is read-only. ,
Required: False ,
}
string ,
tags:
{
Description: Evaluation's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
object ,
target:
{
Description: Specifies the type and configuration of the entity used for this evaluation. ,
Required: False ,
}
{
type:
{
Description: Discriminator that defines the type of the evaluation target. ,
Enum:
{
modelResponseGeneration: Evaluation target that uses a model for response generation. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}