{ "swagger": "2.0", "info": { "title": "Azure AI", "version": "2025-05-01", "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": [], "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" } } } } }, "definitions": { "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" ] }, "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" }, "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" ] }, "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" }, "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" }, "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" }, "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" ] } }, "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" } } }