{ "swagger": "2.0", "info": { "title": "Azure AI", "version": "v1", "x-typespec-generated": [ { "emitter": "@azure-tools/typespec-autorest" } ] }, "schemes": [ "https" ], "x-ms-parameterized-host": { "hostTemplate": "{endpoint}", "useSchemePrefix": false, "parameters": [ { "name": "endpoint", "in": "path", "description": "Foundry Project endpoint in the form\n\"https://{ai-services-account-name}.services.ai.azure.com/api/projects/{project-name}\".\nIf you only have one Project in your Foundry Hub, or to target the default Project\nin your Hub, use the form\n\"https://{ai-services-account-name}.services.ai.azure.com/api/projects/_project\"", "required": true, "type": "string", "format": "uri", "x-ms-skip-url-encoding": true } ] }, "produces": [ "application/json" ], "consumes": [ "application/json" ], "security": [ { "OAuth2Auth": [ "https://ai.azure.com/.default" ] } ], "securityDefinitions": { "OAuth2Auth": { "type": "oauth2", "flow": "implicit", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/v2.0/authorize", "scopes": { "https://ai.azure.com/.default": "" } } }, "tags": [ { "name": "Evals" } ], "paths": { "/connections": { "get": { "operationId": "Connections_List", "description": "List all connections in the project, without populating connection credentials", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "connectionType", "in": "query", "description": "List connections of this specific type", "required": false, "type": "string", "enum": [ "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", "AppInsights", "CustomKeys" ], "x-ms-enum": { "name": "ConnectionType", "modelAsString": true, "values": [ { "name": "AzureOpenAI", "value": "AzureOpenAI", "description": "Azure OpenAI Service" }, { "name": "AzureBlobStorage", "value": "AzureBlob", "description": "Azure Blob Storage, with specified container" }, { "name": "AzureStorageAccount", "value": "AzureStorageAccount", "description": "Azure Blob Storage, with container not specified (used by Agents)" }, { "name": "AzureAISearch", "value": "CognitiveSearch", "description": "Azure AI Search" }, { "name": "CosmosDB", "value": "CosmosDB", "description": "CosmosDB" }, { "name": "APIKey", "value": "ApiKey", "description": "Generic connection that uses API Key authentication" }, { "name": "ApplicationConfiguration", "value": "AppConfig", "description": "Application Configuration" }, { "name": "ApplicationInsights", "value": "AppInsights", "description": "Application Insights" }, { "name": "Custom", "value": "CustomKeys", "description": "Custom Keys" } ] } }, { "name": "defaultConnection", "in": "query", "description": "List connections that are default connections", "required": false, "type": "boolean" }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PagedConnection" }, "headers": { "x-ms-client-request-id": { "type": "string", "format": "uuid", "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Connections_List_MaximumSet": { "$ref": "./examples/Connections_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/connections/{name}": { "get": { "operationId": "Connections_Get", "description": "Get a connection by name, without populating connection credentials", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The friendly name of the connection, provided by the user.", "required": true, "type": "string" }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Connection" }, "headers": { "x-ms-client-request-id": { "type": "string", "format": "uuid", "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Connections_Get_MaximumSet": { "$ref": "./examples/Connections_Get_MaximumSet_Gen.json" } } } }, "/connections/{name}/getConnectionWithCredentials": { "post": { "operationId": "Connections_GetWithCredentials", "description": "Get a connection by name, with its connection credentials", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The friendly name of the connection, provided by the user.", "required": true, "type": "string" }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Connection" }, "headers": { "x-ms-client-request-id": { "type": "string", "format": "uuid", "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Connections_GetWithCredentials_MaximumSet": { "$ref": "./examples/Connections_GetWithCredentials_MaximumSet_Gen.json" } } } }, "/datasets": { "get": { "operationId": "Datasets_ListLatest", "description": "List the latest version of each DatasetVersion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PagedDatasetVersion" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_ListLatest_MaximumSet": { "$ref": "./examples/Datasets_ListLatest_MaximumSet_Gen.json" }, "Datasets_ListLatest_MinimumSet": { "$ref": "./examples/Datasets_ListLatest_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/datasets/{name}/versions": { "get": { "operationId": "Datasets_ListVersions", "description": "List all versions of the given DatasetVersion", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PagedDatasetVersion" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_ListVersions_MaximumSet": { "$ref": "./examples/Datasets_ListVersions_MaximumSet_Gen.json" }, "Datasets_ListVersions_MinimumSet": { "$ref": "./examples/Datasets_ListVersions_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/datasets/{name}/versions/{version}": { "get": { "operationId": "Datasets_GetVersion", "description": "Get the specific version of the DatasetVersion. The service returns 404 Not Found error if the DatasetVersion does not exist.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The specific version id of the DatasetVersion to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DatasetVersion" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_GetVersion_MaximumSet": { "$ref": "./examples/Datasets_GetVersion_MaximumSet_Gen.json" }, "Datasets_GetVersion_MinimumSet": { "$ref": "./examples/Datasets_GetVersion_MinimumSet_Gen.json" } } }, "patch": { "operationId": "Datasets_CreateOrUpdateVersion", "description": "Create a new or update an existing DatasetVersion with the given version id", "consumes": [ "application/merge-patch+json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The specific version id of the DatasetVersion to create or update.", "required": true, "type": "string" }, { "name": "datasetVersion", "in": "body", "description": "The DatasetVersion to create or update.", "required": true, "schema": { "$ref": "#/definitions/DatasetVersion" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DatasetVersion" } }, "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/DatasetVersion" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_CreateOrUpdateVersion_MaximumSet": { "$ref": "./examples/Datasets_CreateOrUpdateVersion_MaximumSet_Gen.json" }, "Datasets_CreateOrUpdateVersion_MinimumSet": { "$ref": "./examples/Datasets_CreateOrUpdateVersion_MinimumSet_Gen.json" } } }, "delete": { "operationId": "Datasets_DeleteVersion", "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.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The version of the DatasetVersion to delete.", "required": true, "type": "string" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_DeleteVersion_MaximumSet": { "$ref": "./examples/Datasets_DeleteVersion_MaximumSet_Gen.json" }, "Datasets_DeleteVersion_MinimumSet": { "$ref": "./examples/Datasets_DeleteVersion_MinimumSet_Gen.json" } } } }, "/datasets/{name}/versions/{version}/credentials": { "post": { "operationId": "Datasets_GetCredentials", "description": "Get the SAS credential to access the storage account associated with a Dataset version.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The specific version id of the DatasetVersion to operate on.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/AssetCredentialResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_GetCredentials_MaximumSet": { "$ref": "./examples/Datasets_GetCredentials_MaximumSet_Gen.json" }, "Datasets_GetCredentials_MinimumSet": { "$ref": "./examples/Datasets_GetCredentials_MinimumSet_Gen.json" } } } }, "/datasets/{name}/versions/{version}/startPendingUpload": { "post": { "operationId": "Datasets_StartPendingUploadVersion", "description": "Start a new or get an existing pending upload of a dataset for a specific version.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The specific version id of the DatasetVersion to operate on.", "required": true, "type": "string" }, { "name": "pendingUploadRequest", "in": "body", "description": "The pending upload request parameters", "required": true, "schema": { "$ref": "#/definitions/PendingUploadRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PendingUploadResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Datasets_StartPendingUploadVersion_MaximumSet": { "$ref": "./examples/Datasets_StartPendingUploadVersion_MaximumSet_Gen.json" }, "Datasets_StartPendingUploadVersion_MinimumSet": { "$ref": "./examples/Datasets_StartPendingUploadVersion_MinimumSet_Gen.json" } } } }, "/deployments": { "get": { "operationId": "Deployments_List", "description": "List all deployed models in the project", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "modelPublisher", "in": "query", "description": "Model publisher to filter models by", "required": false, "type": "string" }, { "name": "modelName", "in": "query", "description": "Model name (the publisher specific name) to filter models by", "required": false, "type": "string" }, { "name": "deploymentType", "in": "query", "description": "Type of deployment to filter list by", "required": false, "type": "string", "enum": [ "ModelDeployment" ], "x-ms-enum": { "name": "DeploymentType", "modelAsString": true, "values": [ { "name": "ModelDeployment", "value": "ModelDeployment", "description": "Model deployment" } ] } }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PagedDeployment" }, "headers": { "x-ms-client-request-id": { "type": "string", "format": "uuid", "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Deployments_List_MaximumSet": { "$ref": "./examples/Deployments_List_MaximumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/deployments/{name}": { "get": { "operationId": "Deployments_Get", "description": "Get a deployed model.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "Name of the deployment", "required": true, "type": "string" }, { "$ref": "#/parameters/Azure.Core.ClientRequestIdHeader" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Deployment" }, "headers": { "x-ms-client-request-id": { "type": "string", "format": "uuid", "description": "An opaque, globally-unique, client-generated string identifier for the request." } } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Deployments_Get_MaximumSet": { "$ref": "./examples/Deployments_Get_MaximumSet_Gen.json" } } } }, "/indexes": { "get": { "operationId": "Indexes_ListLatest", "description": "List the latest version of each Index", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PagedIndex" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Indexes_ListLatest_MaximumSet": { "$ref": "./examples/Indexes_ListLatest_MaximumSet_Gen.json" }, "Indexes_ListLatest_MinimumSet": { "$ref": "./examples/Indexes_ListLatest_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/indexes/{name}/versions": { "get": { "operationId": "Indexes_ListVersions", "description": "List all versions of the given Index", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/PagedIndex" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Indexes_ListVersions_MaximumSet": { "$ref": "./examples/Indexes_ListVersions_MaximumSet_Gen.json" }, "Indexes_ListVersions_MinimumSet": { "$ref": "./examples/Indexes_ListVersions_MinimumSet_Gen.json" } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/indexes/{name}/versions/{version}": { "get": { "operationId": "Indexes_GetVersion", "description": "Get the specific version of the Index. The service returns 404 Not Found error if the Index does not exist.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The specific version id of the Index to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Index" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Indexes_GetVersion_MaximumSet": { "$ref": "./examples/Indexes_GetVersion_MaximumSet_Gen.json" }, "Indexes_GetVersion_MinimumSet": { "$ref": "./examples/Indexes_GetVersion_MinimumSet_Gen.json" } } }, "patch": { "operationId": "Indexes_CreateOrUpdateVersion", "description": "Create a new or update an existing Index with the given version id", "consumes": [ "application/merge-patch+json" ], "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The specific version id of the Index to create or update.", "required": true, "type": "string" }, { "name": "index", "in": "body", "description": "The Index to create or update.", "required": true, "schema": { "$ref": "#/definitions/Index" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Index" } }, "201": { "description": "The request has succeeded and a new resource has been created as a result.", "schema": { "$ref": "#/definitions/Index" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Indexes_CreateOrUpdateVersion_MaximumSet": { "$ref": "./examples/Indexes_CreateOrUpdateVersion_MaximumSet_Gen.json" }, "Indexes_CreateOrUpdateVersion_MinimumSet": { "$ref": "./examples/Indexes_CreateOrUpdateVersion_MinimumSet_Gen.json" } } }, "delete": { "operationId": "Indexes_DeleteVersion", "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.", "parameters": [ { "$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter" }, { "name": "name", "in": "path", "description": "The name of the resource", "required": true, "type": "string" }, { "name": "version", "in": "path", "description": "The version of the Index to delete.", "required": true, "type": "string" } ], "responses": { "204": { "description": "There is no content to send for this request, but the headers may be useful." }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/Azure.Core.Foundations.ErrorResponse" }, "headers": { "x-ms-error-code": { "type": "string", "description": "String error code indicating what went wrong." } } } }, "x-ms-examples": { "Indexes_DeleteVersion_MaximumSet": { "$ref": "./examples/Indexes_DeleteVersion_MaximumSet_Gen.json" }, "Indexes_DeleteVersion_MinimumSet": { "$ref": "./examples/Indexes_DeleteVersion_MinimumSet_Gen.json" } } } }, "/openai/evals": { "get": { "operationId": "OpenAIEvals_ListEvals", "tags": [ "Evals" ], "summary": "List all evaluations", "description": "List evaluations for a project.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "after", "in": "query", "description": "Identifier for the last run from the previous pagination request.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of runs to retrieve.", "required": false, "type": "integer", "format": "int64", "default": 20 }, { "name": "order", "in": "query", "description": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.", "required": false, "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "x-ms-enum": { "modelAsString": false } }, { "name": "order_by", "in": "query", "description": "Evals can be ordered by creation time or last updated time. Use\n`created_at` for creation time or `updated_at` for last updated time.", "required": false, "type": "string", "default": "created_at", "enum": [ "created_at", "updated_at" ], "x-ms-enum": { "modelAsString": false } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "object", "description": "The response data for a requested list of items.", "properties": { "data": { "type": "array", "description": "The requested list of items.", "items": { "$ref": "#/definitions/Eval" } }, "first_id": { "type": "string", "description": "The first ID represented in this list." }, "last_id": { "type": "string", "description": "The last ID represented in this list." }, "has_more": { "type": "boolean", "description": "A value indicating whether there are additional values available not captured in this list." } }, "required": [ "data", "has_more" ] } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } }, "post": { "operationId": "OpenAIEvals_CreateEval", "tags": [ "Evals" ], "summary": "Create evaluation", "description": "Create the structure of an evaluation that can be used to test a model's performance.\nAn evaluation is a set of testing criteria and the config for a data source, which dictates the schema of the data used in the evaluation. After creating an evaluation, you can run it on different models and model parameters. We support several types of graders and datasources.\nFor more information, see the [Evals guide](https://platform.openai.com/docs/guides/evals).", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateEvalRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Eval" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } } }, "/openai/evals/{eval_id}": { "get": { "operationId": "OpenAIEvals_GetEval", "tags": [ "Evals" ], "summary": "Get an evaluation", "description": "Get an evaluation by ID.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Eval" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } }, "post": { "operationId": "OpenAIEvals_UpdateEval", "tags": [ "Evals" ], "summary": "Update an evaluation", "description": "Update certain properties of an evaluation.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to update.", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/UpdateEvalParametersBody" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/Eval" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } }, "delete": { "operationId": "OpenAIEvals_DeleteEval", "tags": [ "Evals" ], "summary": "Delete an evaluation", "description": "Delete an evaluation.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to delete.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeleteEvalResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } } }, "/openai/evals/{eval_id}/runs": { "get": { "operationId": "OpenAIEvals_ListRuns", "tags": [ "Evals" ], "summary": "Get a list of runs for an evaluation", "description": "Get a list of runs for an evaluation.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to retrieve runs for.", "required": true, "type": "string" }, { "name": "after", "in": "query", "description": "Identifier for the last run from the previous pagination request.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of runs to retrieve.", "required": false, "type": "integer", "format": "int64", "default": 20 }, { "name": "order", "in": "query", "description": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.", "required": false, "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "x-ms-enum": { "modelAsString": false } }, { "name": "status", "in": "query", "description": "Filter runs by status. One of `queued` | `in_progress` | `failed` | `completed` | `canceled`.", "required": false, "type": "string", "enum": [ "queued", "in_progress", "completed", "canceled", "failed" ], "x-ms-enum": { "modelAsString": false } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "object", "description": "The response data for a requested list of items.", "properties": { "data": { "type": "array", "description": "The requested list of items.", "items": { "$ref": "#/definitions/EvalRun" } }, "first_id": { "type": "string", "description": "The first ID represented in this list." }, "last_id": { "type": "string", "description": "The last ID represented in this list." }, "has_more": { "type": "boolean", "description": "A value indicating whether there are additional values available not captured in this list." } }, "required": [ "data", "has_more" ] } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } }, "post": { "operationId": "OpenAIEvals_CreateEvalRun", "tags": [ "Evals" ], "summary": "Create evaluation run", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to create a run for.", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/CreateEvalRunRequest" } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/EvalRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } } }, "/openai/evals/{eval_id}/runs/{run_id}": { "get": { "operationId": "OpenAIEvals_GetEvalRun", "tags": [ "Evals" ], "summary": "Get an evaluation run", "description": "Get an evaluation run by ID.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to retrieve runs for.", "required": true, "type": "string" }, { "name": "run_id", "in": "path", "description": "The ID of the run to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/EvalRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } }, "post": { "operationId": "OpenAIEvals_CancelEvalRun", "tags": [ "Evals" ], "summary": "Cancel evaluation run", "description": "Cancel an ongoing evaluation run.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation whose run you want to cancel.", "required": true, "type": "string" }, { "name": "run_id", "in": "path", "description": "The ID of the run to cancel.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/EvalRun" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } }, "delete": { "operationId": "OpenAIEvals_DeleteEvalRun", "tags": [ "Evals" ], "summary": "Delete evaluation run", "description": "Delete an eval run.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to delete the run from.", "required": true, "type": "string" }, { "name": "run_id", "in": "path", "description": "The ID of the run to delete.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/DeleteEvalRunResponse" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } } }, "/openai/evals/{eval_id}/runs/{run_id}/output_items": { "get": { "operationId": "OpenAIEvals_GetEvalRunOutputItems", "tags": [ "Evals" ], "summary": "Get evaluation run output items", "description": "Get a list of output items for an evaluation run.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "required": true, "type": "string" }, { "name": "run_id", "in": "path", "description": "The ID of the run to retrieve output items for.", "required": true, "type": "string" }, { "name": "after", "in": "query", "description": "Identifier for the last run from the previous pagination request.", "required": false, "type": "string" }, { "name": "limit", "in": "query", "description": "Number of runs to retrieve.", "required": false, "type": "integer", "format": "int64", "default": 20 }, { "name": "order", "in": "query", "description": "Sort order for runs by timestamp. Use `asc` for ascending order or `desc` for descending order. Defaults to `asc`.", "required": false, "type": "string", "default": "asc", "enum": [ "asc", "desc" ], "x-ms-enum": { "modelAsString": false } }, { "name": "status", "in": "query", "description": "Filter output items by status. Use `failed` to filter by failed output\nitems or `pass` to filter by passed output items.", "required": false, "type": "string", "enum": [ "fail", "pass" ], "x-ms-enum": { "modelAsString": false } } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "type": "object", "description": "The response data for a requested list of items.", "properties": { "data": { "type": "array", "description": "The requested list of items.", "items": { "$ref": "#/definitions/EvalRunOutputItem" } }, "first_id": { "type": "string", "description": "The first ID represented in this list." }, "last_id": { "type": "string", "description": "The last ID represented in this list." }, "has_more": { "type": "boolean", "description": "A value indicating whether there are additional values available not captured in this list." } }, "required": [ "data", "has_more" ] } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } } }, "/openai/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}": { "get": { "operationId": "OpenAIEvals_GetEvalRunOutputItem", "tags": [ "Evals" ], "summary": "Get an output item of an evaluation run", "description": "Get an evaluation run output item by ID.", "parameters": [ { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-client-name": "apiVersion" }, { "name": "eval_id", "in": "path", "description": "The ID of the evaluation to retrieve runs for.", "required": true, "type": "string" }, { "name": "run_id", "in": "path", "description": "The ID of the run to retrieve.", "required": true, "type": "string" }, { "name": "output_item_id", "in": "path", "description": "The ID of the output item to retrieve.", "required": true, "type": "string" } ], "responses": { "200": { "description": "The request has succeeded.", "schema": { "$ref": "#/definitions/EvalRunOutputItem" } }, "default": { "description": "An unexpected error response.", "schema": { "$ref": "#/definitions/ApiErrorResponse" } } } } } }, "definitions": { "ApiErrorResponse": { "type": "object", "description": "Error response for API failures.", "properties": { "error": { "$ref": "#/definitions/OpenAI.Error" } }, "required": [ "error" ] }, "ApiKeyCredentials": { "type": "object", "description": "API Key Credential definition", "properties": { "key": { "type": "string", "description": "API Key", "readOnly": true, "x-ms-client-name": "apiKey" } }, "allOf": [ { "$ref": "#/definitions/BaseCredentials" } ], "x-ms-discriminator-value": "ApiKey" }, "AssetCredentialResponse": { "type": "object", "description": "Represents a reference to a blob for consumption", "properties": { "blobReference": { "$ref": "#/definitions/BlobReference", "description": "Credential info to access the storage account." } }, "required": [ "blobReference" ] }, "Azure.Core.Foundations.Error": { "type": "object", "description": "The error object.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error." }, "details": { "type": "array", "description": "An array of details about specific errors that led to this reported error.", "items": { "$ref": "#/definitions/Azure.Core.Foundations.Error" } }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "An object containing more specific information than the current object about the error." } }, "required": [ "code", "message" ] }, "Azure.Core.Foundations.ErrorResponse": { "type": "object", "description": "A response containing error details.", "properties": { "error": { "$ref": "#/definitions/Azure.Core.Foundations.Error", "description": "The error object." } }, "required": [ "error" ] }, "Azure.Core.Foundations.InnerError": { "type": "object", "description": "An object containing more specific information about the error. As per Azure REST API guidelines - https://aka.ms/AzureRestApiGuidelines#handling-errors.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "innererror": { "$ref": "#/definitions/Azure.Core.Foundations.InnerError", "description": "Inner error." } } }, "AzureAISearchIndex": { "type": "object", "description": "Azure AI Search Index Definition", "properties": { "connectionName": { "type": "string", "description": "Name of connection to Azure AI Search", "x-ms-mutability": [ "create" ] }, "indexName": { "type": "string", "description": "Name of index in Azure AI Search resource to attach", "x-ms-mutability": [ "create" ] }, "fieldMapping": { "$ref": "#/definitions/FieldMapping", "description": "Field mapping configuration", "x-ms-mutability": [ "create" ] } }, "required": [ "connectionName", "indexName" ], "allOf": [ { "$ref": "#/definitions/Index" } ], "x-ms-discriminator-value": "AzureSearch" }, "BaseCredentials": { "type": "object", "description": "A base class for connection credentials", "properties": { "type": { "$ref": "#/definitions/CredentialType", "description": "The type of credential used by the connection", "readOnly": true } }, "discriminator": "type", "required": [ "type" ] }, "BlobReference": { "type": "object", "description": "Blob reference details.", "properties": { "blobUri": { "type": "string", "description": "Blob URI path for client to upload data. Example: `https://blob.windows.core.net/Container/Path`" }, "storageAccountArmId": { "type": "string", "description": "ARM ID of the storage account to use." }, "credential": { "$ref": "#/definitions/SasCredential", "description": "Credential info to access the storage account." } }, "required": [ "blobUri", "storageAccountArmId", "credential" ] }, "CompletionMessageToolCallChunk": { "type": "object", "description": "Tool call details within a message.", "properties": { "id": { "type": "string", "description": "The Id for the tool call." }, "type": { "type": "string", "description": "The type of tool call, which is always \"function\".", "enum": [ "function" ], "x-ms-enum": { "modelAsString": false } }, "function": { "$ref": "#/definitions/FunctionToolCall", "description": "Details of the function tool call, if applicable." } }, "required": [ "id", "type" ] }, "Connection": { "type": "object", "description": "Response from the list and get connections operations", "properties": { "name": { "type": "string", "description": "The friendly name of the connection, provided by the user.", "readOnly": true }, "id": { "type": "string", "description": "A unique identifier for the connection, generated by the service", "readOnly": true }, "type": { "$ref": "#/definitions/ConnectionType", "description": "Category of the connection", "readOnly": true }, "target": { "type": "string", "description": "The connection URL to be used for this service", "readOnly": true }, "isDefault": { "type": "boolean", "description": "Whether the connection is tagged as the default connection of its type", "readOnly": true }, "credentials": { "$ref": "#/definitions/BaseCredentials", "description": "The credentials used by the connection", "readOnly": true }, "metadata": { "type": "object", "description": "Metadata of the connection", "additionalProperties": { "type": "string" }, "readOnly": true } }, "required": [ "name", "id", "type", "target", "isDefault", "credentials", "metadata" ] }, "ConnectionType": { "type": "string", "description": "The Type (or category) of the connection", "enum": [ "AzureOpenAI", "AzureBlob", "AzureStorageAccount", "CognitiveSearch", "CosmosDB", "ApiKey", "AppConfig", "AppInsights", "CustomKeys" ], "x-ms-enum": { "name": "ConnectionType", "modelAsString": true, "values": [ { "name": "AzureOpenAI", "value": "AzureOpenAI", "description": "Azure OpenAI Service" }, { "name": "AzureBlobStorage", "value": "AzureBlob", "description": "Azure Blob Storage, with specified container" }, { "name": "AzureStorageAccount", "value": "AzureStorageAccount", "description": "Azure Blob Storage, with container not specified (used by Agents)" }, { "name": "AzureAISearch", "value": "CognitiveSearch", "description": "Azure AI Search" }, { "name": "CosmosDB", "value": "CosmosDB", "description": "CosmosDB" }, { "name": "APIKey", "value": "ApiKey", "description": "Generic connection that uses API Key authentication" }, { "name": "ApplicationConfiguration", "value": "AppConfig", "description": "Application Configuration" }, { "name": "ApplicationInsights", "value": "AppInsights", "description": "Application Insights" }, { "name": "Custom", "value": "CustomKeys", "description": "Custom Keys" } ] } }, "CosmosDBIndex": { "type": "object", "description": "CosmosDB Vector Store Index Definition", "properties": { "connectionName": { "type": "string", "description": "Name of connection to CosmosDB", "x-ms-mutability": [ "create" ] }, "databaseName": { "type": "string", "description": "Name of the CosmosDB Database", "x-ms-mutability": [ "create" ] }, "containerName": { "type": "string", "description": "Name of CosmosDB Container", "x-ms-mutability": [ "create" ] }, "embeddingConfiguration": { "$ref": "#/definitions/EmbeddingConfiguration", "description": "Embedding model configuration", "x-ms-mutability": [ "create" ] }, "fieldMapping": { "$ref": "#/definitions/FieldMapping", "description": "Field mapping configuration", "x-ms-mutability": [ "create" ] } }, "required": [ "connectionName", "databaseName", "containerName", "embeddingConfiguration", "fieldMapping" ], "allOf": [ { "$ref": "#/definitions/Index" } ], "x-ms-discriminator-value": "CosmosDBNoSqlVectorStore" }, "CreateEvalRequest": { "type": "object", "title": "CreateEvalRequest", "properties": { "name": { "type": "string", "description": "The name of the evaluation." }, "metadata": { "$ref": "#/definitions/OpenAI.Metadata", "x-nullable": true }, "data_source_config": { "description": "The configuration for the data source used for the evaluation runs. Dictates the schema of the data used in the evaluation." }, "testing_criteria": { "type": "array", "description": "A list of graders for all eval runs in this group. Graders can reference variables in the data source using double curly braces notation, like `{{item.variable_name}}`. To reference the model's output, use the `sample` namespace (ie, `{{sample.output_text}}`).", "items": {} }, "properties": { "type": "object", "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "additionalProperties": { "type": "string" } } }, "required": [ "data_source_config", "testing_criteria" ] }, "CreateEvalRunRequest": { "type": "object", "title": "CreateEvalRunRequest", "properties": { "name": { "type": "string", "description": "The name of the run." }, "metadata": { "$ref": "#/definitions/OpenAI.Metadata", "x-nullable": true }, "data_source": { "description": "Details about the run's data source." }, "properties": { "type": "object", "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "additionalProperties": { "type": "string" } } }, "required": [ "data_source" ] }, "CredentialType": { "type": "string", "description": "The credential type used by the connection", "enum": [ "ApiKey", "AAD", "SAS", "CustomKeys", "None" ], "x-ms-enum": { "name": "CredentialType", "modelAsString": true, "values": [ { "name": "apiKey", "value": "ApiKey", "description": "API Key credential" }, { "name": "entraId", "value": "AAD", "description": "Entra ID credential (formerly known as AAD)" }, { "name": "SAS", "value": "SAS", "description": "Shared Access Signature (SAS) credential" }, { "name": "custom", "value": "CustomKeys", "description": "Custom credential" }, { "name": "None", "value": "None", "description": "No credential" } ] } }, "CustomCredential": { "type": "object", "description": "Custom credential definition", "additionalProperties": { "type": "string" }, "allOf": [ { "$ref": "#/definitions/BaseCredentials" } ], "x-ms-discriminator-value": "CustomKeys" }, "DatasetType": { "type": "string", "description": "Enum to determine the type of data.", "enum": [ "uri_file", "uri_folder" ], "x-ms-enum": { "name": "DatasetType", "modelAsString": true, "values": [ { "name": "uri_file", "value": "uri_file", "description": "URI file." }, { "name": "uri_folder", "value": "uri_folder", "description": "URI folder." } ] } }, "DatasetVersion": { "type": "object", "description": "DatasetVersion Definition", "properties": { "dataUri": { "type": "string", "description": "URI of the data ([example](https://go.microsoft.com/fwlink/?linkid=2202330))", "minLength": 1, "pattern": "[a-zA-Z0-9_]", "x-ms-mutability": [ "read", "create" ] }, "type": { "$ref": "#/definitions/DatasetType", "description": "Dataset type" }, "isReference": { "type": "boolean", "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", "readOnly": true }, "connectionName": { "type": "string", "description": "The Azure Storage Account connection name. Required if startPendingUploadVersion was not called before creating the Dataset", "x-ms-mutability": [ "read", "create" ] }, "id": { "type": "string", "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { "type": "string", "description": "The name of the resource", "readOnly": true }, "version": { "type": "string", "description": "The version of the resource", "readOnly": true }, "description": { "type": "string", "description": "The asset description text.", "x-ms-mutability": [ "update", "create" ] }, "tags": { "type": "object", "description": "Tag dictionary. Tags can be added, removed, and updated.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "update", "create" ] } }, "discriminator": "type", "required": [ "dataUri", "type", "name", "version" ] }, "DeleteEvalResponse": { "type": "object", "description": "A deleted evaluation Object", "properties": { "object": { "type": "string", "description": "The object type. Always 'eval.deleted'.", "enum": [ "eval.deleted" ], "x-ms-enum": { "modelAsString": false } }, "eval_id": { "type": "string", "description": "id of the eval." }, "deleted": { "type": "boolean", "description": "Whether the eval was successfully deleted." } }, "required": [ "object", "eval_id", "deleted" ] }, "DeleteEvalRunResponse": { "type": "object", "description": "A deleted evaluation run Object.", "properties": { "object": { "type": "string", "description": "The object type. Always 'eval.deleted'.", "enum": [ "eval.deleted" ], "x-ms-enum": { "modelAsString": false } }, "run_id": { "type": "string", "description": "id of the eval." }, "deleted": { "type": "boolean", "description": "Whether the eval was successfully deleted." } } }, "Deployment": { "type": "object", "description": "Model Deployment Definition", "properties": { "type": { "$ref": "#/definitions/DeploymentType", "description": "The type of the deployment" }, "name": { "type": "string", "description": "Name of the deployment", "readOnly": true } }, "discriminator": "type", "required": [ "type", "name" ] }, "DeploymentType": { "type": "string", "enum": [ "ModelDeployment" ], "x-ms-enum": { "name": "DeploymentType", "modelAsString": true, "values": [ { "name": "ModelDeployment", "value": "ModelDeployment", "description": "Model deployment" } ] } }, "EmbeddingConfiguration": { "type": "object", "description": "Embedding configuration class", "properties": { "modelDeploymentName": { "type": "string", "description": "Deployment name of embedding model. It can point to a model deployment either in the parent AIServices or a connection.", "x-ms-mutability": [ "create" ] }, "embeddingField": { "type": "string", "description": "Embedding field", "x-ms-mutability": [ "create" ] } }, "required": [ "modelDeploymentName", "embeddingField" ] }, "EntraIDCredentials": { "type": "object", "description": "Entra ID credential definition", "allOf": [ { "$ref": "#/definitions/BaseCredentials" } ], "x-ms-discriminator-value": "AAD" }, "Eval": { "type": "object", "title": "Eval", "description": "An Eval object with a data source config and testing criteria.\nAn Eval represents a task to be done for your LLM integration.\nLike:\n- Improve the quality of my chatbot\n- See how well my chatbot handles customer support\n- Check if o4-mini is better at my usecase than gpt-4o", "properties": { "object": { "type": "string", "description": "The object type.", "default": "eval", "enum": [ "eval" ], "x-ms-enum": { "modelAsString": false }, "x-stainless-const": true }, "id": { "type": "string", "description": "Unique identifier for the evaluation." }, "name": { "type": "string", "description": "The name of the evaluation." }, "data_source_config": { "description": "Configuration of data sources used in runs of the evaluation." }, "testing_criteria": { "type": "array", "description": "A list of testing criteria.", "items": {} }, "created_at": { "type": "integer", "format": "unixtime", "description": "The Unix timestamp (in seconds) for when the eval was created." }, "metadata": { "$ref": "#/definitions/OpenAI.Metadata", "x-nullable": true }, "modified_at": { "$ref": "#/definitions/integer", "description": "Unix timestamp (in seconds) when the evaluation run was last modified." }, "created_by": { "type": "string", "description": "the name of the person who created the run." }, "properties": { "type": "object", "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "additionalProperties": { "type": "string" } } }, "required": [ "object", "id", "name", "data_source_config", "testing_criteria", "created_at", "metadata" ], "x-oaiMeta": { "name": "The eval object", "group": "evals", "example": "{\n \"object\": \"eval\",\n \"id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"data_source_config\": {\n \"type\": \"custom\",\n \"item_schema\": {\n \"type\": \"object\",\n \"properties\": {\n \"label\": {\"type\": \"string\"},\n },\n \"required\": [\"label\"]\n },\n \"include_sample_schema\": true\n },\n \"testing_criteria\": [\n {\n \"name\": \"My string check grader\",\n \"type\": \"string_check\",\n \"input\": \"{{sample.output_text}}\",\n \"reference\": \"{{item.label}}\",\n \"operation\": \"eq\",\n }\n ],\n \"name\": \"External Data Eval\",\n \"created_at\": 1739314509,\n \"metadata\": {\n \"test\": \"synthetics\",\n }\n}\n" } }, "EvalRun": { "type": "object", "title": "EvalRun", "description": "A schema representing an evaluation run.", "properties": { "object": { "type": "string", "description": "The type of the object. Always \"eval.run\".", "default": "eval.run", "enum": [ "eval.run" ], "x-ms-enum": { "modelAsString": false }, "x-stainless-const": true }, "id": { "type": "string", "description": "Unique identifier for the evaluation run." }, "eval_id": { "type": "string", "description": "The identifier of the associated evaluation." }, "status": { "type": "string", "description": "The status of the evaluation run." }, "model": { "type": "string", "description": "The model that is evaluated, if applicable." }, "name": { "type": "string", "description": "The name of the evaluation run." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the evaluation run was created." }, "report_url": { "type": "string", "description": "The URL to the rendered evaluation run report on the UI dashboard." }, "result_counts": { "$ref": "#/definitions/OpenAI.EvalRunResultCounts", "description": "Counters summarizing the outcomes of the evaluation run." }, "per_model_usage": { "type": "array", "description": "Usage statistics for each model during the evaluation run.", "items": { "$ref": "#/definitions/OpenAI.EvalRunPerModelUsage" } }, "per_testing_criteria_results": { "type": "array", "description": "Results per testing criteria applied during the evaluation run.", "items": { "$ref": "#/definitions/OpenAI.EvalRunPerTestingCriteriaResults" } }, "data_source": { "description": "Information about the run's data source." }, "metadata": { "$ref": "#/definitions/OpenAI.Metadata", "x-nullable": true }, "error": { "$ref": "#/definitions/OpenAI.EvalApiError" }, "modified_at": { "$ref": "#/definitions/integer", "description": "Unix timestamp (in seconds) when the evaluation run was last modified." }, "created_by": { "type": "string", "description": "the name of the person who created the run." }, "properties": { "type": "object", "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "additionalProperties": { "type": "string" } } }, "required": [ "object", "id", "eval_id", "status", "model", "name", "created_at", "report_url", "result_counts", "per_model_usage", "per_testing_criteria_results", "data_source", "metadata", "error" ], "x-oaiMeta": { "name": "The eval run object", "group": "evals", "example": "{\n \"object\": \"eval.run\",\n \"id\": \"evalrun_67e57965b480819094274e3a32235e4c\",\n \"eval_id\": \"eval_67e579652b548190aaa83ada4b125f47\",\n \"report_url\": \"https://platform.openai.com/evaluations/eval_67e579652b548190aaa83ada4b125f47?run_id=evalrun_67e57965b480819094274e3a32235e4c\",\n \"status\": \"queued\",\n \"model\": \"gpt-4o-mini\",\n \"name\": \"gpt-4o-mini\",\n \"created_at\": 1743092069,\n \"result_counts\": {\n \"total\": 0,\n \"errored\": 0,\n \"failed\": 0,\n \"passed\": 0\n },\n \"per_model_usage\": null,\n \"per_testing_criteria_results\": null,\n \"data_source\": {\n \"type\": \"completions\",\n \"source\": {\n \"type\": \"file_content\",\n \"content\": [\n {\n \"item\": {\n \"input\": \"Tech Company Launches Advanced Artificial Intelligence Platform\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Central Bank Increases Interest Rates Amid Inflation Concerns\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Summit Addresses Climate Change Strategies\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Major Retailer Reports Record-Breaking Holiday Sales\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"National Team Qualifies for World Championship Finals\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Stock Markets Rally After Positive Economic Data Released\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Manufacturer Announces Merger with Competitor\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Breakthrough in Renewable Energy Technology Unveiled\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"World Leaders Sign Historic Climate Agreement\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Professional Athlete Sets New Record in Championship Event\",\n \"ground_truth\": \"Sports\"\n }\n },\n {\n \"item\": {\n \"input\": \"Financial Institutions Adapt to New Regulatory Requirements\",\n \"ground_truth\": \"Business\"\n }\n },\n {\n \"item\": {\n \"input\": \"Tech Conference Showcases Advances in Artificial Intelligence\",\n \"ground_truth\": \"Technology\"\n }\n },\n {\n \"item\": {\n \"input\": \"Global Markets Respond to Oil Price Fluctuations\",\n \"ground_truth\": \"Markets\"\n }\n },\n {\n \"item\": {\n \"input\": \"International Cooperation Strengthened Through New Treaty\",\n \"ground_truth\": \"World\"\n }\n },\n {\n \"item\": {\n \"input\": \"Sports League Announces Revised Schedule for Upcoming Season\",\n \"ground_truth\": \"Sports\"\n }\n }\n ]\n },\n \"input_messages\": {\n \"type\": \"template\",\n \"template\": [\n {\n \"type\": \"message\",\n \"role\": \"developer\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"Categorize a given news headline into one of the following topics: Technology, Markets, World, Business, or Sports.\n\n# Steps\n\n1. Analyze the content of the news headline to understand its primary focus.\n2. Extract the subject matter, identifying any key indicators or keywords.\n3. Use the identified indicators to determine the most suitable category out of the five options: Technology, Markets, World, Business, or Sports.\n4. Ensure only one category is selected per headline.\n\n# Output Format\n\nRespond with the chosen category as a single word. For instance: \"Technology\", \"Markets\", \"World\", \"Business\", or \"Sports\".\n\n# Examples\n\n**Input**: \"Apple Unveils New iPhone Model, Featuring Advanced AI Features\"\n**Output**: \"Technology\"\n\n**Input**: \"Global Stocks Mixed as Investors Await Central Bank Decisions\"\n**Output**: \"Markets\"\n\n**Input**: \"War in Ukraine: Latest Updates on Negotiation Status\"\n**Output**: \"World\"\n\n**Input**: \"Microsoft in Talks to Acquire Gaming Company for $2 Billion\"\n**Output**: \"Business\"\n\n**Input**: \"Manchester United Secures Win in Premier League Football Match\"\n**Output**: \"Sports\"\n\n# Notes\n\n- If the headline appears to fit into more than one category, choose the most dominant theme.\n- Keywords or phrases such as \"stocks\", \"company acquisition\", \"match\", or technological brands can be good indicators for classification.\n\"\n }\n },\n {\n \"type\": \"message\",\n \"role\": \"user\",\n \"content\": {\n \"type\": \"input_text\",\n \"text\": \"{{item.input}}\"\n }\n }\n ]\n },\n \"model\": \"gpt-4o-mini\",\n \"sampling_params\": {\n \"seed\": 42,\n \"temperature\": 1.0,\n \"top_p\": 1.0,\n \"max_completions_tokens\": 2048\n }\n },\n \"error\": null,\n \"metadata\": {}\n}\n" } }, "EvalRunOutputItem": { "type": "object", "title": "EvalRunOutputItem", "description": "A schema representing an evaluation run output item.", "properties": { "object": { "type": "string", "description": "The type of the object. Always \"eval.run.output_item\".", "default": "eval.run.output_item", "enum": [ "eval.run.output_item" ], "x-ms-enum": { "modelAsString": false }, "x-stainless-const": true }, "id": { "type": "string", "description": "Unique identifier for the evaluation run output item." }, "run_id": { "type": "string", "description": "The identifier of the evaluation run associated with this output item." }, "eval_id": { "type": "string", "description": "The identifier of the evaluation group." }, "created_at": { "type": "integer", "format": "unixtime", "description": "Unix timestamp (in seconds) when the evaluation run was created." }, "status": { "type": "string", "description": "The status of the evaluation run." }, "datasource_item_id": { "$ref": "#/definitions/OpenAI.integer", "description": "The identifier for the data source item." }, "datasource_item": { "type": "object", "description": "Details of the input data source item.", "additionalProperties": {} }, "results": { "type": "array", "description": "A list of grader results for this output item.", "items": { "$ref": "#/definitions/EvalRunOutputItemResult" } }, "sample": { "$ref": "#/definitions/OpenAI.EvalRunOutputItemSample", "description": "A sample containing the input and output of the evaluation run." } }, "required": [ "object", "id", "run_id", "eval_id", "created_at", "status", "datasource_item_id", "datasource_item", "results", "sample" ], "x-oaiMeta": { "name": "The eval run output item object", "group": "evals", "example": "{\n \"object\": \"eval.run.output_item\",\n \"id\": \"outputitem_67abd55eb6548190bb580745d5644a33\",\n \"run_id\": \"evalrun_67abd54d60ec8190832b46859da808f7\",\n \"eval_id\": \"eval_67abd54d9b0081909a86353f6fb9317a\",\n \"created_at\": 1739314509,\n \"status\": \"pass\",\n \"datasource_item_id\": 137,\n \"datasource_item\": {\n \"teacher\": \"To grade essays, I only check for style, content, and grammar.\",\n \"student\": \"I am a student who is trying to write the best essay.\"\n },\n \"results\": [\n {\n \"name\": \"String Check Grader\",\n \"type\": \"string-check-grader\",\n \"score\": 1.0,\n \"passed\": true,\n }\n ],\n \"sample\": {\n \"input\": [\n {\n \"role\": \"system\",\n \"content\": \"You are an evaluator bot...\"\n },\n {\n \"role\": \"user\",\n \"content\": \"You are assessing...\"\n }\n ],\n \"output\": [\n {\n \"role\": \"assistant\",\n \"content\": \"The rubric is not clear nor concise.\"\n }\n ],\n \"finish_reason\": \"stop\",\n \"model\": \"gpt-4o-2024-08-06\",\n \"usage\": {\n \"total_tokens\": 521,\n \"completion_tokens\": 2,\n \"prompt_tokens\": 519,\n \"cached_tokens\": 0\n },\n \"error\": null,\n \"temperature\": 1.0,\n \"max_completion_tokens\": 2048,\n \"top_p\": 1.0,\n \"seed\": 42\n }\n}\n" } }, "EvalRunOutputItemResult": { "type": "object", "title": "EvalRunOutputItemResult", "description": "A single grader result for an evaluation run output item.", "properties": { "name": { "type": "string", "description": "The name of the grader." }, "type": { "type": "string", "description": "The grader type (for example, \"string-check-grader\")." }, "score": { "$ref": "#/definitions/OpenAI.numeric", "description": "The numeric score produced by the grader." }, "passed": { "type": "boolean", "description": "Whether the grader considered the output a pass." }, "sample": { "type": "object", "description": "Optional sample or intermediate data produced by the grader.", "x-nullable": true, "additionalProperties": {} }, "metric": { "type": "string", "description": "The name of the metric (e.g., \"fluency\", \"f1_score\")." }, "label": { "type": "string", "description": "The label associated with the test criteria metric (e.g., \"pass\", \"fail\", \"good\", \"bad\")." }, "threshold": { "type": "number", "format": "float", "description": "The threshold used to determine pass/fail for this test criteria, if it is numerical." }, "reason": { "type": "string", "description": "The reason for the test criteria metric." }, "properties": { "type": "object", "description": "Additional details about the test criteria metric.", "additionalProperties": { "type": "string" } } }, "required": [ "name", "score", "passed" ], "additionalProperties": {} }, "EvalRunOutputItemSampleInput": { "type": "object", "description": "A message in the evaluation run.", "properties": { "role": { "type": "string" }, "content": { "type": "string" }, "tool_calls": { "type": "array", "description": "Tool calls made within the message, if any.", "items": { "$ref": "#/definitions/CompletionMessageToolCallChunk" } } }, "required": [ "role", "content", "tool_calls" ] }, "EvalRunOutputItemSampleOutput": { "type": "object", "description": "A message in the evaluation run.", "properties": { "role": { "type": "string" }, "content": { "type": "string" }, "tool_calls": { "type": "array", "description": "Tool calls made within the message, if any.", "items": { "$ref": "#/definitions/CompletionMessageToolCallChunk" } } }, "required": [ "tool_calls" ] }, "FieldMapping": { "type": "object", "description": "Field mapping configuration class", "properties": { "contentFields": { "type": "array", "description": "List of fields with text content", "items": { "type": "string" }, "x-ms-mutability": [ "create" ] }, "filepathField": { "type": "string", "description": "Path of file to be used as a source of text content", "x-ms-mutability": [ "create" ] }, "titleField": { "type": "string", "description": "Field containing the title of the document", "x-ms-mutability": [ "create" ] }, "urlField": { "type": "string", "description": "Field containing the url of the document", "x-ms-mutability": [ "create" ] }, "vectorFields": { "type": "array", "description": "List of fields with vector content", "items": { "type": "string" }, "x-ms-mutability": [ "create" ] }, "metadataFields": { "type": "array", "description": "List of fields with metadata content", "items": { "type": "string" }, "x-ms-mutability": [ "create" ] } }, "required": [ "contentFields" ] }, "FileDatasetVersion": { "type": "object", "description": "FileDatasetVersion Definition", "allOf": [ { "$ref": "#/definitions/DatasetVersion" } ], "x-ms-discriminator-value": "uri_file" }, "FolderDatasetVersion": { "type": "object", "description": "FileDatasetVersion Definition", "allOf": [ { "$ref": "#/definitions/DatasetVersion" } ], "x-ms-discriminator-value": "uri_folder" }, "FunctionToolCall": { "type": "object", "description": "Details of a function tool call.", "properties": { "name": { "type": "string", "description": "The name of the function to call." }, "arguments": { "type": "string", "description": "The arguments to call the function with, as generated by the model in JSON format." } }, "required": [ "name", "arguments" ] }, "Index": { "type": "object", "description": "Index resource Definition", "properties": { "type": { "$ref": "#/definitions/IndexType", "description": "Type of index" }, "id": { "type": "string", "description": "Asset ID, a unique identifier for the asset", "readOnly": true }, "name": { "type": "string", "description": "The name of the resource", "readOnly": true }, "version": { "type": "string", "description": "The version of the resource", "readOnly": true }, "description": { "type": "string", "description": "The asset description text.", "x-ms-mutability": [ "update", "create" ] }, "tags": { "type": "object", "description": "Tag dictionary. Tags can be added, removed, and updated.", "additionalProperties": { "type": "string" }, "x-ms-mutability": [ "update", "create" ] } }, "discriminator": "type", "required": [ "type", "name", "version" ] }, "IndexType": { "type": "string", "enum": [ "AzureSearch", "CosmosDBNoSqlVectorStore", "ManagedAzureSearch" ], "x-ms-enum": { "name": "IndexType", "modelAsString": true, "values": [ { "name": "azureSearch", "value": "AzureSearch", "description": "Azure search" }, { "name": "cosmosDB", "value": "CosmosDBNoSqlVectorStore", "description": "CosmosDB" }, { "name": "managedAzureSearch", "value": "ManagedAzureSearch", "description": "Managed Azure Search" } ] } }, "ManagedAzureAISearchIndex": { "type": "object", "description": "Managed Azure AI Search Index Definition", "properties": { "vectorStoreId": { "type": "string", "description": "Vector store id of managed index", "x-ms-mutability": [ "create" ] } }, "required": [ "vectorStoreId" ], "allOf": [ { "$ref": "#/definitions/Index" } ], "x-ms-discriminator-value": "ManagedAzureSearch" }, "ModelDeployment": { "type": "object", "description": "Model Deployment Definition", "properties": { "modelName": { "type": "string", "description": "Publisher-specific name of the deployed model", "readOnly": true }, "modelVersion": { "type": "string", "description": "Publisher-specific version of the deployed model", "readOnly": true }, "modelPublisher": { "type": "string", "description": "Name of the deployed model's publisher", "readOnly": true }, "capabilities": { "type": "object", "description": "Capabilities of deployed model", "additionalProperties": { "type": "string" }, "readOnly": true }, "sku": { "$ref": "#/definitions/Sku", "description": "Sku of the model deployment", "readOnly": true }, "connectionName": { "type": "string", "description": "Name of the connection the deployment comes from", "readOnly": true } }, "required": [ "modelName", "modelVersion", "modelPublisher", "capabilities", "sku" ], "allOf": [ { "$ref": "#/definitions/Deployment" } ], "x-ms-discriminator-value": "ModelDeployment" }, "NoAuthenticationCredentials": { "type": "object", "description": "Credentials that do not require authentication", "allOf": [ { "$ref": "#/definitions/BaseCredentials" } ], "x-ms-discriminator-value": "None" }, "OpenAI.Error": { "type": "object", "properties": { "code": { "type": "string", "x-nullable": true }, "message": { "type": "string" }, "param": { "type": "string", "x-nullable": true }, "type": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/definitions/OpenAI.Error" } }, "additionalInfo": { "type": "object", "additionalProperties": {} }, "debugInfo": { "type": "object", "additionalProperties": {} } }, "required": [ "code", "message", "param", "type" ] }, "OpenAI.EvalApiError": { "type": "object", "title": "EvalApiError", "description": "An object representing an error response from the Eval API.", "properties": { "code": { "type": "string", "description": "The error code." }, "message": { "type": "string", "description": "The error message." } }, "required": [ "code", "message" ], "x-oaiMeta": { "name": "The API error object", "group": "evals", "example": "{\n \"code\": \"internal_error\",\n \"message\": \"The eval run failed due to an internal error.\"\n}\n" } }, "OpenAI.EvalRunOutputItemSample": { "type": "object", "properties": { "input": { "type": "array", "items": { "$ref": "#/definitions/EvalRunOutputItemSampleInput" } }, "output": { "type": "array", "items": { "$ref": "#/definitions/EvalRunOutputItemSampleOutput" } }, "finish_reason": { "type": "string" }, "model": { "type": "string" }, "usage": { "$ref": "#/definitions/OpenAI.EvalRunOutputItemSampleUsage" }, "error": { "$ref": "#/definitions/OpenAI.EvalApiError" }, "temperature": { "$ref": "#/definitions/OpenAI.numeric" }, "max_completion_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "top_p": { "$ref": "#/definitions/OpenAI.numeric" }, "seed": { "$ref": "#/definitions/OpenAI.integer" } }, "required": [ "input", "output", "finish_reason", "model", "usage", "error", "temperature", "max_completion_tokens", "top_p", "seed" ] }, "OpenAI.EvalRunOutputItemSampleUsage": { "type": "object", "properties": { "total_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "completion_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "prompt_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "cached_tokens": { "$ref": "#/definitions/OpenAI.integer" } }, "required": [ "total_tokens", "completion_tokens", "prompt_tokens", "cached_tokens" ] }, "OpenAI.EvalRunPerModelUsage": { "type": "object", "properties": { "model_name": { "type": "string", "x-stainless-naming": { "python": { "property_name": "run_model_name" } } }, "invocation_count": { "$ref": "#/definitions/OpenAI.integer" }, "prompt_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "completion_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "total_tokens": { "$ref": "#/definitions/OpenAI.integer" }, "cached_tokens": { "$ref": "#/definitions/OpenAI.integer" } }, "required": [ "model_name", "invocation_count", "prompt_tokens", "completion_tokens", "total_tokens", "cached_tokens" ] }, "OpenAI.EvalRunPerTestingCriteriaResults": { "type": "object", "properties": { "testing_criteria": { "type": "string" }, "passed": { "$ref": "#/definitions/OpenAI.integer" }, "failed": { "$ref": "#/definitions/OpenAI.integer" } }, "required": [ "testing_criteria", "passed", "failed" ] }, "OpenAI.EvalRunResultCounts": { "type": "object", "properties": { "total": { "$ref": "#/definitions/OpenAI.integer" }, "errored": { "$ref": "#/definitions/OpenAI.integer" }, "failed": { "$ref": "#/definitions/OpenAI.integer" }, "passed": { "$ref": "#/definitions/OpenAI.integer" } }, "required": [ "total", "errored", "failed", "passed" ] }, "OpenAI.Metadata": { "type": "object", "description": "Set of 16 key-value pairs that can be attached to an object. This can be\nuseful for storing additional information about the object in a structured\nformat, and querying for objects via API or the dashboard.\nKeys are strings with a maximum length of 64 characters. Values are strings\nwith a maximum length of 512 characters.", "additionalProperties": { "type": "string" }, "x-oaiTypeLabel": "map" }, "OpenAI.integer": { "type": "integer", "format": "int64" }, "OpenAI.numeric": { "type": "number", "format": "double" }, "PagedConnection": { "type": "object", "description": "Paged collection of Connection items", "properties": { "value": { "type": "array", "description": "The Connection items on this page", "items": { "$ref": "#/definitions/Connection" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PagedDatasetVersion": { "type": "object", "description": "Paged collection of DatasetVersion items", "properties": { "value": { "type": "array", "description": "The DatasetVersion items on this page", "items": { "$ref": "#/definitions/DatasetVersion" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PagedDeployment": { "type": "object", "description": "Paged collection of Deployment items", "properties": { "value": { "type": "array", "description": "The Deployment items on this page", "items": { "$ref": "#/definitions/Deployment" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PagedIndex": { "type": "object", "description": "Paged collection of Index items", "properties": { "value": { "type": "array", "description": "The Index items on this page", "items": { "$ref": "#/definitions/Index" } }, "nextLink": { "type": "string", "format": "uri", "description": "The link to the next page of items" } }, "required": [ "value" ] }, "PendingUploadRequest": { "type": "object", "description": "Represents a request for a pending upload.", "properties": { "pendingUploadId": { "type": "string", "description": "If PendingUploadId is not provided, a random GUID will be used." }, "connectionName": { "type": "string", "description": "Azure Storage Account connection name to use for generating temporary SAS token" }, "pendingUploadType": { "type": "string", "description": "BlobReference is the only supported type.", "enum": [ "BlobReference" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "pendingUploadType" ] }, "PendingUploadResponse": { "type": "object", "description": "Represents the response for a pending upload request", "properties": { "blobReference": { "$ref": "#/definitions/BlobReference", "description": "Container-level read, write, list SAS." }, "pendingUploadId": { "type": "string", "description": "ID for this upload request." }, "version": { "type": "string", "description": "Version of asset to be created if user did not specify version when initially creating upload" }, "pendingUploadType": { "type": "string", "description": "BlobReference is the only supported type", "enum": [ "BlobReference" ], "x-ms-enum": { "modelAsString": false } } }, "required": [ "blobReference", "pendingUploadId", "pendingUploadType" ] }, "SASCredentials": { "type": "object", "description": "Shared Access Signature (SAS) credential definition", "properties": { "SAS": { "type": "string", "description": "SAS token", "readOnly": true, "x-ms-client-name": "sasToken" } }, "allOf": [ { "$ref": "#/definitions/BaseCredentials" } ], "x-ms-discriminator-value": "SAS" }, "SasCredential": { "type": "object", "description": "SAS Credential definition", "properties": { "sasUri": { "type": "string", "description": "SAS uri", "readOnly": true }, "type": { "type": "string", "description": "Type of credential", "enum": [ "SAS" ], "x-ms-enum": { "modelAsString": false }, "readOnly": true } }, "required": [ "sasUri", "type" ] }, "Sku": { "type": "object", "description": "Sku information", "properties": { "capacity": { "type": "integer", "format": "int64", "description": "Sku capacity" }, "family": { "type": "string", "description": "Sku family" }, "name": { "type": "string", "description": "Sku name" }, "size": { "type": "string", "description": "Sku size" }, "tier": { "type": "string", "description": "Sku tier" } }, "required": [ "capacity", "family", "name", "size", "tier" ] }, "UpdateEvalParametersBody": { "type": "object", "properties": { "name": { "type": "string" }, "metadata": { "$ref": "#/definitions/OpenAI.Metadata", "x-nullable": true }, "properties": { "type": "object", "description": "Set of immutable 16 key-value pairs that can be attached to an object for storing additional information.\n Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.", "additionalProperties": { "type": "string" } } } }, "integer": { "type": "integer", "format": "int64" } }, "parameters": { "Azure.Core.ClientRequestIdHeader": { "name": "x-ms-client-request-id", "in": "header", "description": "An opaque, globally-unique, client-generated string identifier for the request.", "required": false, "type": "string", "format": "uuid", "x-ms-parameter-location": "method", "x-ms-client-name": "clientRequestId" }, "Azure.Core.Foundations.ApiVersionParameter": { "name": "api-version", "in": "query", "description": "The API version to use for this operation.", "required": true, "type": "string", "minLength": 1, "x-ms-parameter-location": "method", "x-ms-client-name": "apiVersion" } } }