Azure.AI.Projects (preview:2025-07-31)

2025/08/21 • 27 new methods

Connections_List (new)
Description :  List all connections in the project, without populating connection credentials
Reference :  Link ¶

⚼ Request

GET:  /connections
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
connectionType:
{
Description: List connections of this specific type ,
Required: False ,
}
string ,
defaultConnection:
{
Description: List connections that are default connections ,
Required: False ,
}
boolean ,
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 Connection items ,
}
{
value:
{
Description: The Connection items on this page ,
Required: True ,
}
[
{
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
id:
{
Description: A unique identifier for the connection, generated by the service ,
Required: True ,
}
string ,
type:
{
Description: Category of the connection ,
Enum:
{
AzureOpenAI: Azure OpenAI Service ,
AzureBlob: Azure Blob Storage, with specified container ,
AzureStorageAccount: Azure Blob Storage, with container not specified (used by Agents) ,
CognitiveSearch: Azure AI Search ,
CosmosDB: CosmosDB ,
ApiKey: Generic connection that uses API Key authentication ,
AppConfig: Application Configuration ,
AppInsights: Application Insights ,
CustomKeys: Custom Keys ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The connection URL to be used for this service ,
Required: True ,
}
string ,
isDefault:
{
Description: Whether the connection is tagged as the default connection of its type ,
Required: True ,
}
boolean ,
credentials:
{
Description: The credentials used by the connection ,
Required: True ,
}
{
type:
{
Description: The type of credential used by the connection ,
Enum:
{
ApiKey: API Key credential ,
AAD: Entra ID credential (formerly known as AAD) ,
SAS: Shared Access Signature (SAS) credential ,
CustomKeys: Custom credential ,
None: No credential ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the connection ,
Required: True ,
}
object ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
Connections_Get (new)
Description :  Get a connection by name, without populating connection credentials
Reference :  Link ¶

⚼ Request

GET:  /connections/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The friendly name of the connection, provided by the user. ,
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: Response from the list and get connections operations ,
}
{
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
id:
{
Description: A unique identifier for the connection, generated by the service ,
Required: True ,
}
string ,
type:
{
Description: Category of the connection ,
Enum:
{
AzureOpenAI: Azure OpenAI Service ,
AzureBlob: Azure Blob Storage, with specified container ,
AzureStorageAccount: Azure Blob Storage, with container not specified (used by Agents) ,
CognitiveSearch: Azure AI Search ,
CosmosDB: CosmosDB ,
ApiKey: Generic connection that uses API Key authentication ,
AppConfig: Application Configuration ,
AppInsights: Application Insights ,
CustomKeys: Custom Keys ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The connection URL to be used for this service ,
Required: True ,
}
string ,
isDefault:
{
Description: Whether the connection is tagged as the default connection of its type ,
Required: True ,
}
boolean ,
credentials:
{
Description: The credentials used by the connection ,
Required: True ,
}
{
type:
{
Description: The type of credential used by the connection ,
Enum:
{
ApiKey: API Key credential ,
AAD: Entra ID credential (formerly known as AAD) ,
SAS: Shared Access Signature (SAS) credential ,
CustomKeys: Custom credential ,
None: No credential ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the connection ,
Required: True ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Connections_GetWithCredentials (new)
Description :  Get a connection by name, with its connection credentials
Reference :  Link ¶

⚼ Request

POST:  /connections/{name}/getConnectionWithCredentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The friendly name of the connection, provided by the user. ,
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: Response from the list and get connections operations ,
}
{
name:
{
Description: The friendly name of the connection, provided by the user. ,
Required: True ,
}
string ,
id:
{
Description: A unique identifier for the connection, generated by the service ,
Required: True ,
}
string ,
type:
{
Description: Category of the connection ,
Enum:
{
AzureOpenAI: Azure OpenAI Service ,
AzureBlob: Azure Blob Storage, with specified container ,
AzureStorageAccount: Azure Blob Storage, with container not specified (used by Agents) ,
CognitiveSearch: Azure AI Search ,
CosmosDB: CosmosDB ,
ApiKey: Generic connection that uses API Key authentication ,
AppConfig: Application Configuration ,
AppInsights: Application Insights ,
CustomKeys: Custom Keys ,
}
,
Required: True ,
}
enum ,
target:
{
Description: The connection URL to be used for this service ,
Required: True ,
}
string ,
isDefault:
{
Description: Whether the connection is tagged as the default connection of its type ,
Required: True ,
}
boolean ,
credentials:
{
Description: The credentials used by the connection ,
Required: True ,
}
{
type:
{
Description: The type of credential used by the connection ,
Enum:
{
ApiKey: API Key credential ,
AAD: Entra ID credential (formerly known as AAD) ,
SAS: Shared Access Signature (SAS) credential ,
CustomKeys: Custom credential ,
None: No credential ,
}
,
Required: True ,
}
enum ,
}
,
metadata:
{
Description: Metadata of the connection ,
Required: True ,
}
object ,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Datasets_ListLatest (new)
Description :  List the latest version of each DatasetVersion
Reference :  Link ¶

⚼ Request

GET:  /datasets
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DatasetVersion items on this page ,
Required: True ,
}
[
{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
Datasets_ListVersions (new)
Description :  List all versions of the given DatasetVersion
Reference :  Link ¶

⚼ Request

GET:  /datasets/{name}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The DatasetVersion items on this page ,
Required: True ,
}
[
{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
Datasets_GetVersion (new)
Description :  Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.
Reference :  Link ¶

⚼ Request

GET:  /datasets/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the DatasetVersion to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
}
,
}
,
}
Datasets_CreateOrUpdateVersion (new)
Description :  Create a new or update an existing DatasetVersion with the given version id
Reference :  Link ¶

⚼ Request

PATCH:  /datasets/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the DatasetVersion to create or update. ,
Required: True ,
}
string ,
datasetVersion:
{
Description: The DatasetVersion to create or update. ,
Required: True ,
}
{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
dataUri:
{
Description: URI of the data. Example: https://go.microsoft.com/fwlink/?linkid=2202330 ,
Required: True ,
}
string ,
type:
{
Description: Dataset type ,
Enum:
{
uri_file: URI file. ,
uri_folder: URI folder. ,
}
,
Required: True ,
}
enum ,
isReference:
{
Description: Indicates if the dataset holds a reference to the storage, or the dataset manages storage itself. If true, the underlying data will not be deleted when the dataset version is deleted ,
Required: False ,
}
boolean ,
connectionName:
{
Description: The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset ,
Required: False ,
}
string ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
}
,
}
,
}
Datasets_DeleteVersion (new)
Description :  Delete the specific version of the DatasetVersion. The service returns 204 No Content if the DatasetVersion was deleted successfully or if the DatasetVersion does not exist.
Reference :  Link ¶

⚼ Request

DELETE:  /datasets/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the DatasetVersion to delete. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
,
}
,
}
Datasets_GetCredentials (new)
Description :  Get the SAS credential to access the storage account associated with a Dataset version.
Reference :  Link ¶

⚼ Request

POST:  /datasets/{name}/versions/{version}/credentials
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the DatasetVersion to operate on. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
blobReference:
{
Description: Credential info to access the storage account. ,
Required: True ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Required: True ,
}
string ,
storageAccountArmId:
{
Description: ARM ID of the storage account to use. ,
Required: True ,
}
string ,
credential:
{
Description: Credential info to access the storage account. ,
Required: True ,
}
{
sasUri:
{
Description: SAS uri ,
Required: True ,
}
string ,
type:
{
Description: Type of credential ,
Enum:
{
SAS: No description available. ,
}
,
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 ,
}
,
}
,
}
,
}
Datasets_StartPendingUploadVersion (new)
Description :  Start a new or get an existing pending upload of a dataset for a specific version.
Reference :  Link ¶

⚼ Request

POST:  /datasets/{name}/versions/{version}/startPendingUpload
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the DatasetVersion to operate on. ,
Required: True ,
}
string ,
pendingUploadRequest:
{
Description: The pending upload request parameters ,
Required: True ,
}
{
pendingUploadId:
{
Description: If PendingUploadId is not provided, a random GUID will be used. ,
Required: False ,
}
string ,
connectionName:
{
Description: Azure Storage Account connection name to use for generating temporary SAS token ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: BlobReference is the only supported type. ,
Enum:
{
BlobReference: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (200)

{
blobReference:
{
Description: Container-level read, write, list SAS. ,
Required: True ,
}
{
blobUri:
{
Description: Blob URI path for client to upload data. Example: https://blob.windows.core.net/Container/Path ,
Required: True ,
}
string ,
storageAccountArmId:
{
Description: ARM ID of the storage account to use. ,
Required: True ,
}
string ,
credential:
{
Description: Credential info to access the storage account. ,
Required: True ,
}
{
sasUri:
{
Description: SAS uri ,
Required: True ,
}
string ,
type:
{
Description: Type of credential ,
Enum:
{
SAS: No description available. ,
}
,
Required: True ,
}
enum ,
}
,
}
,
pendingUploadId:
{
Description: ID for this upload request. ,
Required: True ,
}
string ,
version:
{
Description: Version of asset to be created if user did not specify version when initially creating upload ,
Required: False ,
}
string ,
pendingUploadType:
{
Description: BlobReference is the only supported type ,
Enum:
{
BlobReference: No description available. ,
}
,
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 ,
}
,
}
,
}
,
}
Deployments_List (new)
Description :  List all deployed models in the project
Reference :  Link ¶

⚼ Request

GET:  /deployments
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
modelPublisher:
{
Description: Model publisher to filter models by ,
Required: False ,
}
string ,
modelName:
{
Description: Model name (the publisher specific name) to filter models by ,
Required: False ,
}
string ,
deploymentType:
{
Description: Type of deployment to filter list by ,
Required: False ,
}
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 Deployment items ,
}
{
value:
{
Description: The Deployment items on this page ,
Required: True ,
}
[
{
type:
{
Description: The type of the deployment ,
Enum:
{
ModelDeployment: Model deployment ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Name of the deployment ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
Deployments_Get (new)
Description :  Get a deployed model.
Reference :  Link ¶

⚼ Request

GET:  /deployments/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Name of the deployment ,
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: Model Deployment Definition ,
}
{
type:
{
Description: The type of the deployment ,
Enum:
{
ModelDeployment: Model deployment ,
}
,
Required: True ,
}
enum ,
name:
{
Description: Name of the deployment ,
Required: True ,
}
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_List (new)
Description :  List evaluation runs
Reference :  Link ¶

⚼ Request

GET:  /evaluations/runs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
filter:
{
Description: Filter expression to narrow down the list of evaluations based on specific criteria. Supports filtering by properties such as status, tags, or properties to help manage large evaluation collections. ,
Required: False ,
}
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 ,
dataSource:
{
Description: Data source configuration that specifies where the evaluation data comes from. This replaces the legacy 'data' field and provides more flexible data source options. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of data source being used for evaluation ,
Enum:
{
inlineData: Use inline JSON data provided directly in the request ,
dataset: Use a dataset that has been registered and stored in AI Foundry workspace ,
FoundryModelInline: Use data generated by running a model deployment against inline queries provided in the request ,
FoundryModelDataset: Use data generated by running a model deployment against a registered dataset ,
}
,
Required: True ,
}
enum ,
}
,
resultSettings:
{
Description: Configuration settings that control how evaluation results are processed, stored, and exported ,
Required: False ,
}
{
additionalDestinations:
{
Description: List of external storage destinations where evaluation results should be exported in addition to the default AI Foundry storage ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of external storage destination ,
Enum:
{
appInsightsStorage: Export evaluation results to Azure Application Insights for monitoring and analytics ,
storageAccountStorage: Export evaluation results to Azure Blob Storage for data archival and custom processing ,
}
,
Required: True ,
}
enum ,
connectionName:
{
Description: Name of the connection resource configured in the AI Foundry workspace. This connection must be properly configured with appropriate credentials before use. ,
Required: True ,
}
string ,
state:
{
Description: Current state of the export operation to this destination. This field is managed by the service and cannot be modified by clients. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
state:
{
Description: Current operational state of the evaluation. This field is managed by the service and reflects the evaluation's progress from initiation to completion. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
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 ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
summary:
{
Description: Aggregated summary of evaluation results for each configured evaluator. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
{
evaluatorStatus:
{
Description: Status of each evaluator from the input request. ,
Required: True ,
}
[
{
name:
{
Description: Name of the evaluator from the input request. ,
Required: True ,
}
string ,
id:
{
Description: Identifier of the evaluator from the input request. ,
Required: True ,
}
string ,
state:
{
Description: State of the evaluation for this evaluator. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error message if the evaluator failed to process. ,
Required: False ,
}
string ,
usage:
{
Description: Usage statistics for the evaluation ,
Required: True ,
}
{
inputTokens:
{
Description: Total number of input tokens consumed during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
outputTokens:
{
Description: Total number of output tokens generated during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
metrics:
{
Description: Aggregated metrics that summarize evaluation results across multiple data rows. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: True ,
}
string ,
evaluatorName:
{
Description: Name provided for the evaluator in the input request. ,
Required: True ,
}
string ,
statistics:
{
Description: Statistical summary of evaluation results including aggregated scores and pass/fail rates. ,
Required: True ,
}
{
sampleCount:
{
Description: Total number of rows that were evaluated. ,
Format: int64 ,
Required: True ,
}
integer ,
passRate:
{
Description: Proportion of evaluation results that passed the specified criteria or threshold, expressed as a value between 0 and 1. ,
Format: float ,
Required: False ,
}
number ,
min:
{
Description: Lowest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
max:
{
Description: Highest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
average:
{
Description: Arithmetic mean of all score values in the evaluation results. ,
Format: float ,
Required: False ,
}
number ,
standardDeviation:
{
Description: Standard deviation of score values, indicating the variability or spread of scores around the average. ,
Format: float ,
Required: False ,
}
number ,
confidenceInterval95th:
{
Description: Confidence interval for the average score, providing a range within which the pass average is likely to fall (95th percentile). ,
Required: False ,
}
{
lowerBound:
{
Description: Lower bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
upperBound:
{
Description: Upper bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
}
,
labelFrequency:
{
Description: Label frequency distribution, showing how often each label appears in the evaluation results. This can help identify common themes or issues across evaluated data rows. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: Metadata about the metric ,
Required: True ,
}
{
evaluatorId:
{
Description: Unique identifier of the evaluator that produced this result ,
Required: True ,
}
string ,
desiredDirection:
{
Description: Desired direction for the evaluation score. ,
Enum:
{
increase: Indicates that a higher score is desirable for this evaluator ,
decrease: Indicates that a lower score is desirable for this evaluator ,
neutral: Indicates that the score should be neutral, meaning it does not have a preferred direction ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value that this score is compared against to determine the evaluation outcome ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of metric generated ,
Enum:
{
continuous: Continuous metric type, representing a numerical score ,
categorical: Categorical metric type, representing discrete categories or labels ,
ordinal: Ordinal metric type, representing ordered categories ,
}
,
Required: True ,
}
enum ,
}
,
additionalDetails:
{
Description: Additional metadata about the aggregated metric, such as processing details or custom fields ,
Required: False ,
}
object ,
}
,
]
,
}
,
resultDatasetId:
{
Description: Unique identifier of the dataset containing detailed evaluation results. This dataset is created automatically upon evaluation completion and contains row-by-row results for analysis. The identifier follows the format: azureai://accounts/{resourceName}/projects/{projectName}/datasets/{datasetName}/versions/{versionNumber}. Note: This dataset is only available when the result retention policy permits detailed result storage. ,
Required: False ,
}
string ,
systemData:
{
Description: System-generated metadata containing internal service information for debugging and operational purposes. This field is managed by the service and cannot be modified by clients. ,
Required: False ,
}
object ,
}
,
]
,
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 (new)
Description :  Get an evaluation run by name.
Reference :  Link ¶

⚼ Request

GET:  /evaluations/runs/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
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:
{
retry-after:
{
Description: Recommended time interval in seconds before making another request when the evaluation is still processing. This helps prevent excessive polling and reduces server load during long-running evaluations. ,
}
string ,
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 ,
dataSource:
{
Description: Data source configuration that specifies where the evaluation data comes from. This replaces the legacy 'data' field and provides more flexible data source options. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of data source being used for evaluation ,
Enum:
{
inlineData: Use inline JSON data provided directly in the request ,
dataset: Use a dataset that has been registered and stored in AI Foundry workspace ,
FoundryModelInline: Use data generated by running a model deployment against inline queries provided in the request ,
FoundryModelDataset: Use data generated by running a model deployment against a registered dataset ,
}
,
Required: True ,
}
enum ,
}
,
resultSettings:
{
Description: Configuration settings that control how evaluation results are processed, stored, and exported ,
Required: False ,
}
{
additionalDestinations:
{
Description: List of external storage destinations where evaluation results should be exported in addition to the default AI Foundry storage ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of external storage destination ,
Enum:
{
appInsightsStorage: Export evaluation results to Azure Application Insights for monitoring and analytics ,
storageAccountStorage: Export evaluation results to Azure Blob Storage for data archival and custom processing ,
}
,
Required: True ,
}
enum ,
connectionName:
{
Description: Name of the connection resource configured in the AI Foundry workspace. This connection must be properly configured with appropriate credentials before use. ,
Required: True ,
}
string ,
state:
{
Description: Current state of the export operation to this destination. This field is managed by the service and cannot be modified by clients. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
state:
{
Description: Current operational state of the evaluation. This field is managed by the service and reflects the evaluation's progress from initiation to completion. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
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 ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
summary:
{
Description: Aggregated summary of evaluation results for each configured evaluator. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
{
evaluatorStatus:
{
Description: Status of each evaluator from the input request. ,
Required: True ,
}
[
{
name:
{
Description: Name of the evaluator from the input request. ,
Required: True ,
}
string ,
id:
{
Description: Identifier of the evaluator from the input request. ,
Required: True ,
}
string ,
state:
{
Description: State of the evaluation for this evaluator. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error message if the evaluator failed to process. ,
Required: False ,
}
string ,
usage:
{
Description: Usage statistics for the evaluation ,
Required: True ,
}
{
inputTokens:
{
Description: Total number of input tokens consumed during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
outputTokens:
{
Description: Total number of output tokens generated during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
metrics:
{
Description: Aggregated metrics that summarize evaluation results across multiple data rows. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: True ,
}
string ,
evaluatorName:
{
Description: Name provided for the evaluator in the input request. ,
Required: True ,
}
string ,
statistics:
{
Description: Statistical summary of evaluation results including aggregated scores and pass/fail rates. ,
Required: True ,
}
{
sampleCount:
{
Description: Total number of rows that were evaluated. ,
Format: int64 ,
Required: True ,
}
integer ,
passRate:
{
Description: Proportion of evaluation results that passed the specified criteria or threshold, expressed as a value between 0 and 1. ,
Format: float ,
Required: False ,
}
number ,
min:
{
Description: Lowest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
max:
{
Description: Highest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
average:
{
Description: Arithmetic mean of all score values in the evaluation results. ,
Format: float ,
Required: False ,
}
number ,
standardDeviation:
{
Description: Standard deviation of score values, indicating the variability or spread of scores around the average. ,
Format: float ,
Required: False ,
}
number ,
confidenceInterval95th:
{
Description: Confidence interval for the average score, providing a range within which the pass average is likely to fall (95th percentile). ,
Required: False ,
}
{
lowerBound:
{
Description: Lower bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
upperBound:
{
Description: Upper bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
}
,
labelFrequency:
{
Description: Label frequency distribution, showing how often each label appears in the evaluation results. This can help identify common themes or issues across evaluated data rows. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: Metadata about the metric ,
Required: True ,
}
{
evaluatorId:
{
Description: Unique identifier of the evaluator that produced this result ,
Required: True ,
}
string ,
desiredDirection:
{
Description: Desired direction for the evaluation score. ,
Enum:
{
increase: Indicates that a higher score is desirable for this evaluator ,
decrease: Indicates that a lower score is desirable for this evaluator ,
neutral: Indicates that the score should be neutral, meaning it does not have a preferred direction ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value that this score is compared against to determine the evaluation outcome ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of metric generated ,
Enum:
{
continuous: Continuous metric type, representing a numerical score ,
categorical: Categorical metric type, representing discrete categories or labels ,
ordinal: Ordinal metric type, representing ordered categories ,
}
,
Required: True ,
}
enum ,
}
,
additionalDetails:
{
Description: Additional metadata about the aggregated metric, such as processing details or custom fields ,
Required: False ,
}
object ,
}
,
]
,
}
,
resultDatasetId:
{
Description: Unique identifier of the dataset containing detailed evaluation results. This dataset is created automatically upon evaluation completion and contains row-by-row results for analysis. The identifier follows the format: azureai://accounts/{resourceName}/projects/{projectName}/datasets/{datasetName}/versions/{versionNumber}. Note: This dataset is only available when the result retention policy permits detailed result storage. ,
Required: False ,
}
string ,
systemData:
{
Description: System-generated metadata containing internal service information for debugging and operational purposes. This field is managed by the service and cannot be modified by clients. ,
Required: False ,
}
object ,
}
,
}

⚐ 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_Update (new)
Description :  Updates specific properties of an existing evaluation. Supports modification of metadata fields including description, display name, and tags. Note: Core evaluation configuration such as data sources and evaluators cannot be modified after creation.
Reference :  Link ¶

⚼ Request

PATCH:  /evaluations/runs/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
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 ,
resource:
{
Description: The resource instance. ,
Required: True ,
}
{
dataSource:
{
Description: Data source configuration that specifies where the evaluation data comes from. This replaces the legacy 'data' field and provides more flexible data source options. ,
Required: False ,
}
{
type:
{
Description: Specifies the type of data source being used for evaluation ,
Enum:
{
inlineData: Use inline JSON data provided directly in the request ,
dataset: Use a dataset that has been registered and stored in AI Foundry workspace ,
FoundryModelInline: Use data generated by running a model deployment against inline queries provided in the request ,
FoundryModelDataset: Use data generated by running a model deployment against a registered dataset ,
}
,
Required: True ,
}
enum ,
}
,
resultSettings:
{
Description: Configuration settings that control how evaluation results are processed, stored, and exported ,
Required: False ,
}
{
additionalDestinations:
{
Description: List of external storage destinations where evaluation results should be exported in addition to the default AI Foundry storage ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of external storage destination ,
Enum:
{
appInsightsStorage: Export evaluation results to Azure Application Insights for monitoring and analytics ,
storageAccountStorage: Export evaluation results to Azure Blob Storage for data archival and custom processing ,
}
,
Required: True ,
}
enum ,
connectionName:
{
Description: Name of the connection resource configured in the AI Foundry workspace. This connection must be properly configured with appropriate credentials before use. ,
Required: True ,
}
string ,
state:
{
Description: Current state of the export operation to this destination. This field is managed by the service and cannot be modified by clients. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
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: False ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}

⚐ 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 ,
dataSource:
{
Description: Data source configuration that specifies where the evaluation data comes from. This replaces the legacy 'data' field and provides more flexible data source options. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of data source being used for evaluation ,
Enum:
{
inlineData: Use inline JSON data provided directly in the request ,
dataset: Use a dataset that has been registered and stored in AI Foundry workspace ,
FoundryModelInline: Use data generated by running a model deployment against inline queries provided in the request ,
FoundryModelDataset: Use data generated by running a model deployment against a registered dataset ,
}
,
Required: True ,
}
enum ,
}
,
resultSettings:
{
Description: Configuration settings that control how evaluation results are processed, stored, and exported ,
Required: False ,
}
{
additionalDestinations:
{
Description: List of external storage destinations where evaluation results should be exported in addition to the default AI Foundry storage ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of external storage destination ,
Enum:
{
appInsightsStorage: Export evaluation results to Azure Application Insights for monitoring and analytics ,
storageAccountStorage: Export evaluation results to Azure Blob Storage for data archival and custom processing ,
}
,
Required: True ,
}
enum ,
connectionName:
{
Description: Name of the connection resource configured in the AI Foundry workspace. This connection must be properly configured with appropriate credentials before use. ,
Required: True ,
}
string ,
state:
{
Description: Current state of the export operation to this destination. This field is managed by the service and cannot be modified by clients. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
state:
{
Description: Current operational state of the evaluation. This field is managed by the service and reflects the evaluation's progress from initiation to completion. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
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 ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
summary:
{
Description: Aggregated summary of evaluation results for each configured evaluator. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
{
evaluatorStatus:
{
Description: Status of each evaluator from the input request. ,
Required: True ,
}
[
{
name:
{
Description: Name of the evaluator from the input request. ,
Required: True ,
}
string ,
id:
{
Description: Identifier of the evaluator from the input request. ,
Required: True ,
}
string ,
state:
{
Description: State of the evaluation for this evaluator. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error message if the evaluator failed to process. ,
Required: False ,
}
string ,
usage:
{
Description: Usage statistics for the evaluation ,
Required: True ,
}
{
inputTokens:
{
Description: Total number of input tokens consumed during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
outputTokens:
{
Description: Total number of output tokens generated during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
metrics:
{
Description: Aggregated metrics that summarize evaluation results across multiple data rows. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: True ,
}
string ,
evaluatorName:
{
Description: Name provided for the evaluator in the input request. ,
Required: True ,
}
string ,
statistics:
{
Description: Statistical summary of evaluation results including aggregated scores and pass/fail rates. ,
Required: True ,
}
{
sampleCount:
{
Description: Total number of rows that were evaluated. ,
Format: int64 ,
Required: True ,
}
integer ,
passRate:
{
Description: Proportion of evaluation results that passed the specified criteria or threshold, expressed as a value between 0 and 1. ,
Format: float ,
Required: False ,
}
number ,
min:
{
Description: Lowest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
max:
{
Description: Highest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
average:
{
Description: Arithmetic mean of all score values in the evaluation results. ,
Format: float ,
Required: False ,
}
number ,
standardDeviation:
{
Description: Standard deviation of score values, indicating the variability or spread of scores around the average. ,
Format: float ,
Required: False ,
}
number ,
confidenceInterval95th:
{
Description: Confidence interval for the average score, providing a range within which the pass average is likely to fall (95th percentile). ,
Required: False ,
}
{
lowerBound:
{
Description: Lower bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
upperBound:
{
Description: Upper bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
}
,
labelFrequency:
{
Description: Label frequency distribution, showing how often each label appears in the evaluation results. This can help identify common themes or issues across evaluated data rows. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: Metadata about the metric ,
Required: True ,
}
{
evaluatorId:
{
Description: Unique identifier of the evaluator that produced this result ,
Required: True ,
}
string ,
desiredDirection:
{
Description: Desired direction for the evaluation score. ,
Enum:
{
increase: Indicates that a higher score is desirable for this evaluator ,
decrease: Indicates that a lower score is desirable for this evaluator ,
neutral: Indicates that the score should be neutral, meaning it does not have a preferred direction ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value that this score is compared against to determine the evaluation outcome ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of metric generated ,
Enum:
{
continuous: Continuous metric type, representing a numerical score ,
categorical: Categorical metric type, representing discrete categories or labels ,
ordinal: Ordinal metric type, representing ordered categories ,
}
,
Required: True ,
}
enum ,
}
,
additionalDetails:
{
Description: Additional metadata about the aggregated metric, such as processing details or custom fields ,
Required: False ,
}
object ,
}
,
]
,
}
,
resultDatasetId:
{
Description: Unique identifier of the dataset containing detailed evaluation results. This dataset is created automatically upon evaluation completion and contains row-by-row results for analysis. The identifier follows the format: azureai://accounts/{resourceName}/projects/{projectName}/datasets/{datasetName}/versions/{versionNumber}. Note: This dataset is only available when the result retention policy permits detailed result storage. ,
Required: False ,
}
string ,
systemData:
{
Description: System-generated metadata containing internal service information for debugging and operational purposes. This field is managed by the service and cannot be modified by clients. ,
Required: False ,
}
object ,
}
,
}

⚐ 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_Delete (new)
Description :  Delete an evaluation run by name
Reference :  Link ¶

⚼ Request

DELETE:  /evaluations/runs/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
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 (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
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_Cancel (new)
Description :  Cancel an evaluation run by name
Reference :  Link ¶

⚼ Request

POST:  /evaluations/runs/{id}:cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
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 (204)

{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
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_CreateBatch (new)
Description :  Creates a new evaluation with the specified configuration.
Reference :  Link ¶

⚼ Request

POST:  /evaluations/runs:runBatch
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
Repeatability-Request-ID:
{
Description: Unique, client-generated identifier for ensuring request idempotency. Use the same ID for retries to prevent duplicate evaluations. ,
Required: False ,
}
string ,
Repeatability-First-Sent:
{
Description: Timestamp indicating when this request was first initiated. Used in conjunction with repeatability-request-id for idempotency control. ,
Format: date-time ,
Required: False ,
}
string ,
evaluation:
{
Description: Complete evaluation configuration including data source, evaluators, and result settings ,
Required: True ,
}
{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
dataSource:
{
Description: Data source configuration that specifies where the evaluation data comes from. This replaces the legacy 'data' field and provides more flexible data source options. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of data source being used for evaluation ,
Enum:
{
inlineData: Use inline JSON data provided directly in the request ,
dataset: Use a dataset that has been registered and stored in AI Foundry workspace ,
FoundryModelInline: Use data generated by running a model deployment against inline queries provided in the request ,
FoundryModelDataset: Use data generated by running a model deployment against a registered dataset ,
}
,
Required: True ,
}
enum ,
}
,
resultSettings:
{
Description: Configuration settings that control how evaluation results are processed, stored, and exported ,
Required: False ,
}
{
additionalDestinations:
{
Description: List of external storage destinations where evaluation results should be exported in addition to the default AI Foundry storage ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of external storage destination ,
Enum:
{
appInsightsStorage: Export evaluation results to Azure Application Insights for monitoring and analytics ,
storageAccountStorage: Export evaluation results to Azure Blob Storage for data archival and custom processing ,
}
,
Required: True ,
}
enum ,
connectionName:
{
Description: Name of the connection resource configured in the AI Foundry workspace. This connection must be properly configured with appropriate credentials before use. ,
Required: True ,
}
string ,
state:
{
Description: Current state of the export operation to this destination. This field is managed by the service and cannot be modified by clients. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
state:
{
Description: Current operational state of the evaluation. This field is managed by the service and reflects the evaluation's progress from initiation to completion. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
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 ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
summary:
{
Description: Aggregated summary of evaluation results for each configured evaluator. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
{
evaluatorStatus:
{
Description: Status of each evaluator from the input request. ,
Required: True ,
}
[
{
name:
{
Description: Name of the evaluator from the input request. ,
Required: True ,
}
string ,
id:
{
Description: Identifier of the evaluator from the input request. ,
Required: True ,
}
string ,
state:
{
Description: State of the evaluation for this evaluator. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error message if the evaluator failed to process. ,
Required: False ,
}
string ,
usage:
{
Description: Usage statistics for the evaluation ,
Required: True ,
}
{
inputTokens:
{
Description: Total number of input tokens consumed during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
outputTokens:
{
Description: Total number of output tokens generated during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
metrics:
{
Description: Aggregated metrics that summarize evaluation results across multiple data rows. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: True ,
}
string ,
evaluatorName:
{
Description: Name provided for the evaluator in the input request. ,
Required: True ,
}
string ,
statistics:
{
Description: Statistical summary of evaluation results including aggregated scores and pass/fail rates. ,
Required: True ,
}
{
sampleCount:
{
Description: Total number of rows that were evaluated. ,
Format: int64 ,
Required: True ,
}
integer ,
passRate:
{
Description: Proportion of evaluation results that passed the specified criteria or threshold, expressed as a value between 0 and 1. ,
Format: float ,
Required: False ,
}
number ,
min:
{
Description: Lowest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
max:
{
Description: Highest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
average:
{
Description: Arithmetic mean of all score values in the evaluation results. ,
Format: float ,
Required: False ,
}
number ,
standardDeviation:
{
Description: Standard deviation of score values, indicating the variability or spread of scores around the average. ,
Format: float ,
Required: False ,
}
number ,
confidenceInterval95th:
{
Description: Confidence interval for the average score, providing a range within which the pass average is likely to fall (95th percentile). ,
Required: False ,
}
{
lowerBound:
{
Description: Lower bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
upperBound:
{
Description: Upper bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
}
,
labelFrequency:
{
Description: Label frequency distribution, showing how often each label appears in the evaluation results. This can help identify common themes or issues across evaluated data rows. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: Metadata about the metric ,
Required: True ,
}
{
evaluatorId:
{
Description: Unique identifier of the evaluator that produced this result ,
Required: True ,
}
string ,
desiredDirection:
{
Description: Desired direction for the evaluation score. ,
Enum:
{
increase: Indicates that a higher score is desirable for this evaluator ,
decrease: Indicates that a lower score is desirable for this evaluator ,
neutral: Indicates that the score should be neutral, meaning it does not have a preferred direction ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value that this score is compared against to determine the evaluation outcome ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of metric generated ,
Enum:
{
continuous: Continuous metric type, representing a numerical score ,
categorical: Categorical metric type, representing discrete categories or labels ,
ordinal: Ordinal metric type, representing ordered categories ,
}
,
Required: True ,
}
enum ,
}
,
additionalDetails:
{
Description: Additional metadata about the aggregated metric, such as processing details or custom fields ,
Required: False ,
}
object ,
}
,
]
,
}
,
resultDatasetId:
{
Description: Unique identifier of the dataset containing detailed evaluation results. This dataset is created automatically upon evaluation completion and contains row-by-row results for analysis. The identifier follows the format: azureai://accounts/{resourceName}/projects/{projectName}/datasets/{datasetName}/versions/{versionNumber}. Note: This dataset is only available when the result retention policy permits detailed result storage. ,
Required: False ,
}
string ,
systemData:
{
Description: System-generated metadata containing internal service information for debugging and operational purposes. This field is managed by the service and cannot be modified by clients. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the evaluation. ,
Required: True ,
}
string ,
dataSource:
{
Description: Data source configuration that specifies where the evaluation data comes from. This replaces the legacy 'data' field and provides more flexible data source options. ,
Required: True ,
}
{
type:
{
Description: Specifies the type of data source being used for evaluation ,
Enum:
{
inlineData: Use inline JSON data provided directly in the request ,
dataset: Use a dataset that has been registered and stored in AI Foundry workspace ,
FoundryModelInline: Use data generated by running a model deployment against inline queries provided in the request ,
FoundryModelDataset: Use data generated by running a model deployment against a registered dataset ,
}
,
Required: True ,
}
enum ,
}
,
resultSettings:
{
Description: Configuration settings that control how evaluation results are processed, stored, and exported ,
Required: False ,
}
{
additionalDestinations:
{
Description: List of external storage destinations where evaluation results should be exported in addition to the default AI Foundry storage ,
Required: False ,
}
[
{
type:
{
Description: Specifies the type of external storage destination ,
Enum:
{
appInsightsStorage: Export evaluation results to Azure Application Insights for monitoring and analytics ,
storageAccountStorage: Export evaluation results to Azure Blob Storage for data archival and custom processing ,
}
,
Required: True ,
}
enum ,
connectionName:
{
Description: Name of the connection resource configured in the AI Foundry workspace. This connection must be properly configured with appropriate credentials before use. ,
Required: True ,
}
string ,
state:
{
Description: Current state of the export operation to this destination. This field is managed by the service and cannot be modified by clients. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
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 ,
state:
{
Description: Current operational state of the evaluation. This field is managed by the service and reflects the evaluation's progress from initiation to completion. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
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 ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
summary:
{
Description: Aggregated summary of evaluation results for each configured evaluator. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
{
evaluatorStatus:
{
Description: Status of each evaluator from the input request. ,
Required: True ,
}
[
{
name:
{
Description: Name of the evaluator from the input request. ,
Required: True ,
}
string ,
id:
{
Description: Identifier of the evaluator from the input request. ,
Required: True ,
}
string ,
state:
{
Description: State of the evaluation for this evaluator. ,
Enum:
{
NotStarted: The operation has not started. ,
Running: The operation is in progress. ,
Succeeded: The operation has completed successfully. ,
Failed: The operation has failed. ,
Canceled: The operation has been canceled by the user. ,
}
,
Required: True ,
}
enum ,
error:
{
Description: Error message if the evaluator failed to process. ,
Required: False ,
}
string ,
usage:
{
Description: Usage statistics for the evaluation ,
Required: True ,
}
{
inputTokens:
{
Description: Total number of input tokens consumed during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
outputTokens:
{
Description: Total number of output tokens generated during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
}
,
]
,
metrics:
{
Description: Aggregated metrics that summarize evaluation results across multiple data rows. This provides a high-level overview of performance across all data rows. ,
Required: False ,
}
[
{
name:
{
Description: Name of the metric ,
Required: True ,
}
string ,
evaluatorName:
{
Description: Name provided for the evaluator in the input request. ,
Required: True ,
}
string ,
statistics:
{
Description: Statistical summary of evaluation results including aggregated scores and pass/fail rates. ,
Required: True ,
}
{
sampleCount:
{
Description: Total number of rows that were evaluated. ,
Format: int64 ,
Required: True ,
}
integer ,
passRate:
{
Description: Proportion of evaluation results that passed the specified criteria or threshold, expressed as a value between 0 and 1. ,
Format: float ,
Required: False ,
}
number ,
min:
{
Description: Lowest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
max:
{
Description: Highest score value observed across all evaluation results. ,
Format: float ,
Required: False ,
}
number ,
average:
{
Description: Arithmetic mean of all score values in the evaluation results. ,
Format: float ,
Required: False ,
}
number ,
standardDeviation:
{
Description: Standard deviation of score values, indicating the variability or spread of scores around the average. ,
Format: float ,
Required: False ,
}
number ,
confidenceInterval95th:
{
Description: Confidence interval for the average score, providing a range within which the pass average is likely to fall (95th percentile). ,
Required: False ,
}
{
lowerBound:
{
Description: Lower bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
upperBound:
{
Description: Upper bound of the confidence interval for the average score, providing a range within which the true average is likely to fall. ,
Format: float ,
Required: True ,
}
number ,
}
,
labelFrequency:
{
Description: Label frequency distribution, showing how often each label appears in the evaluation results. This can help identify common themes or issues across evaluated data rows. ,
Required: False ,
}
object ,
}
,
metadata:
{
Description: Metadata about the metric ,
Required: True ,
}
{
evaluatorId:
{
Description: Unique identifier of the evaluator that produced this result ,
Required: True ,
}
string ,
desiredDirection:
{
Description: Desired direction for the evaluation score. ,
Enum:
{
increase: Indicates that a higher score is desirable for this evaluator ,
decrease: Indicates that a lower score is desirable for this evaluator ,
neutral: Indicates that the score should be neutral, meaning it does not have a preferred direction ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value that this score is compared against to determine the evaluation outcome ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of metric generated ,
Enum:
{
continuous: Continuous metric type, representing a numerical score ,
categorical: Categorical metric type, representing discrete categories or labels ,
ordinal: Ordinal metric type, representing ordered categories ,
}
,
Required: True ,
}
enum ,
}
,
additionalDetails:
{
Description: Additional metadata about the aggregated metric, such as processing details or custom fields ,
Required: False ,
}
object ,
}
,
]
,
}
,
resultDatasetId:
{
Description: Unique identifier of the dataset containing detailed evaluation results. This dataset is created automatically upon evaluation completion and contains row-by-row results for analysis. The identifier follows the format: azureai://accounts/{resourceName}/projects/{projectName}/datasets/{datasetName}/versions/{versionNumber}. Note: This dataset is only available when the result retention policy permits detailed result storage. ,
Required: False ,
}
string ,
systemData:
{
Description: System-generated metadata containing internal service information for debugging and operational purposes. This field is managed by the service and cannot be modified by clients. ,
Required: False ,
}
object ,
}

⚐ 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_CreateSingle (new)
Description :  Independent API operation to perform a single evaluation and immediately get a result.
Reference :  Link ¶

⚼ Request

POST:  /evaluations/runs:runSingle
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
singleEvaluation:
{
Description: Complete evaluation configuration including data source, evaluators, and result settings ,
Required: True ,
}
{
dataSource:
{
Description: Input data to evaluate. Single row support only. ,
Required: True ,
}
{
id:
{
Description: Optional unique identifier for the inline data source. This can be an agent id or a custom identifier to distinguish between different inline data sources. ,
Required: False ,
}
string ,
data:
{
Description: Inline data structured according to the specified format ,
Required: False ,
}
{
dataFormat:
{
Description: Format of the inline data structure ,
Enum:
{
queryResponseMessageFormat: Query-response pairs for Q&A and chatbot evaluations ,
evaluationMessagesFormat: Multi-turn conversations with role-based messages and tool definitions ,
inlineJsonFormat: Flexible JSON format for custom data structures ,
}
,
Required: True ,
}
enum ,
}
,
inlineDatasetId:
{
Description: Dataset id for the uploaded inline data. ,
Required: True ,
}
string ,
}
,
evaluators:
{
Description: Evaluators to be used for the evaluation. ,
Required: True ,
}
[
{
id:
{
Description: Identifier of the evaluator. ,
Required: True ,
}
string ,
name:
{
Description: Name of the evaluator. It can be used for identify the evaluator in the evaluation results. ,
Required: False ,
}
string ,
initializationParameters:
{
Description: Initialization parameters of the evaluator. ,
Required: False ,
}
object ,
dataMapping:
{
Description: Data parameters of the evaluator. ,
Required: False ,
}
object ,
}
,
]
,
properties:
{
Description: Evaluation's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
metrics:
{
Description: Evaluation results from all the configured evaluators. ,
Required: False ,
}
[
{
name:
{
Description: Name of the evaluation metric ,
Required: True ,
}
string ,
evaluatorName:
{
Description: Name provided for the evaluator in the input request. ,
Required: True ,
}
string ,
score:
{
Description: Score assigned by the evaluator to the specific data row ,
Format: float ,
Required: False ,
}
number ,
labels:
{
Description: Optional labels associated with the evaluation result. ,
Required: False ,
}
[
string ,
]
,
outcome:
{
Description: Outcome of the evaluation ,
Enum:
{
pass: The evaluation completed successfully and met the specified criteria or threshold ,
fail: The evaluation completed but did not meet the specified criteria or threshold ,
error: The evaluation resulted in an error for this particular data row ,
}
,
Required: False ,
}
enum ,
reasoning:
{
Description: Reasoning or explanation provided by the evaluator for the score assigned to this data row ,
Required: True ,
}
string ,
error:
{
Description: Error message describing why the evaluation failed for this data row, if applicable ,
Required: False ,
}
string ,
metadata:
{
Description: Metadata about the evaluation result ,
Required: True ,
}
{
evaluatorId:
{
Description: Unique identifier of the evaluator that produced this result ,
Required: True ,
}
string ,
desiredDirection:
{
Description: Desired direction for the evaluation score. ,
Enum:
{
increase: Indicates that a higher score is desirable for this evaluator ,
decrease: Indicates that a lower score is desirable for this evaluator ,
neutral: Indicates that the score should be neutral, meaning it does not have a preferred direction ,
}
,
Required: False ,
}
enum ,
threshold:
{
Description: Threshold value that this score is compared against to determine the evaluation outcome ,
Format: float ,
Required: False ,
}
number ,
type:
{
Description: Type of metric generated ,
Enum:
{
continuous: Continuous metric type, representing a numerical score ,
categorical: Categorical metric type, representing discrete categories or labels ,
ordinal: Ordinal metric type, representing ordered categories ,
}
,
Required: True ,
}
enum ,
}
,
usage:
{
Description: Token consumption for this metric evaluation ,
Required: False ,
}
{
inputTokens:
{
Description: Total number of input tokens consumed during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
outputTokens:
{
Description: Total number of output tokens generated during the evaluation process ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
additionalDetails:
{
Description: Additional metadata about the evaluation result, such as processing details or custom fields ,
Required: False ,
}
object ,
}
,
]
,
}

⚐ 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 ,
}
,
}
,
}
,
}
Indexes_ListLatest (new)
Description :  List the latest version of each Index
Reference :  Link ¶

⚼ Request

GET:  /indexes
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Index items on this page ,
Required: True ,
}
[
{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
Indexes_ListVersions (new)
Description :  List all versions of the given Index
Reference :  Link ¶

⚼ Request

GET:  /indexes/{name}/versions
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The Index items on this page ,
Required: True ,
}
[
{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
Indexes_GetVersion (new)
Description :  Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.
Reference :  Link ¶

⚼ Request

GET:  /indexes/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the Index to retrieve. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
}
,
}
,
}
Indexes_CreateOrUpdateVersion (new)
Description :  Create a new or update an existing Index with the given version id
Reference :  Link ¶

⚼ Request

PATCH:  /indexes/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The specific version id of the Index to create or update. ,
Required: True ,
}
string ,
index:
{
Description: The Index to create or update. ,
Required: True ,
}
{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ Response (201)

{
type:
{
Description: Type of index ,
Enum:
{
AzureSearch: Azure search ,
CosmosDBNoSqlVectorStore: CosmosDB ,
ManagedAzureSearch: Managed Azure Search ,
}
,
Required: True ,
}
enum ,
id:
{
Description: Asset ID, a unique identifier for the asset ,
Required: False ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the resource ,
Required: True ,
}
string ,
description:
{
Description: The asset description text. ,
Required: False ,
}
string ,
tags:
{
Description: Tag dictionary. Tags can be added, removed, and updated. ,
Required: False ,
}
object ,
}

⚐ 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 ,
}
,
}
,
}
,
}
Indexes_DeleteVersion (new)
Description :  Delete the specific version of the Index. The service returns 204 No Content if the Index was deleted successfully or if the Index does not exist.
Reference :  Link ¶

⚼ Request

DELETE:  /indexes/{name}/versions/{version}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: The name of the resource ,
Required: True ,
}
string ,
version:
{
Description: The version of the Index to delete. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
}
,
}
,
}
RedTeams_List (new)
Description :  List a redteam by name.
Reference :  Link ¶

⚼ Request

GET:  /redTeams/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 RedTeam items ,
}
{
value:
{
Description: The RedTeam items on this page ,
Required: True ,
}
[
{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
string ,
}
,
}
,
]
,
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 ,
}
,
}
,
}
,
}
RedTeams_Get (new)
Description :  Get a redteam by name.
Reference :  Link ¶

⚼ Request

GET:  /redTeams/runs/{name}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
name:
{
Description: Identifier of the red team run. ,
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: Red team details. ,
}
{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}
RedTeams_Create (new)
Description :  Creates a redteam run.
Reference :  Link ¶

⚼ Request

POST:  /redTeams/runs:run
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
RedTeam:
{
Description: Redteam to be run ,
Required: True ,
}
{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the red team run. ,
Required: True ,
}
string ,
displayName:
{
Description: Name of the red-team run. ,
Required: False ,
}
string ,
numTurns:
{
Description: Number of simulation rounds. ,
Format: int32 ,
Required: False ,
}
integer ,
attackStrategies:
{
Description: List of attack strategies or nested lists of attack strategies. ,
Required: False ,
}
[
string ,
]
,
simulationOnly:
{
Description: Simulation-only or Simulation + Evaluation. Default false, if true the scan outputs conversation not evaluation result. ,
Required: False ,
}
boolean ,
riskCategories:
{
Description: List of risk categories to generate attack objectives for. ,
Required: False ,
}
[
string ,
]
,
applicationScenario:
{
Description: Application scenario for the red team operation, to generate scenario specific attacks. ,
Required: False ,
}
string ,
tags:
{
Description: Red team's tags. Unlike properties, tags are fully mutable. ,
Required: False ,
}
object ,
properties:
{
Description: Red team's properties. Unlike tags, properties are add-only. Once added, a property cannot be removed. ,
Required: False ,
}
object ,
status:
{
Description: Status of the red-team. It is set by service and is read-only. ,
Required: False ,
}
string ,
target:
{
Description: Target configuration for the red-team run. ,
Required: True ,
}
{
type:
{
Description: Type of the model configuration. ,
Required: True ,
}
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 ,
}
,
}
,
}
,
}