{
"swagger": "2.0",
"info": {
"title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring",
"version": "2025-11-01",
"description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview.",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"x-ms-parameterized-host": {
"hostTemplate": "{Endpoint}/language",
"useSchemePrefix": false,
"parameters": [
{
"name": "Endpoint",
"in": "path",
"description": "Supported Cognitive Services endpoint e.g., https://.api.cognitiveservices.azure.com.",
"required": true,
"type": "string",
"format": "uri",
"x-ms-skip-url-encoding": true
}
]
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"ApiKeyAuth": []
},
{
"OAuth2Auth": [
"https://cognitiveservices.azure.com/.default"
]
}
],
"securityDefinitions": {
"ApiKeyAuth": {
"type": "apiKey",
"name": "Ocp-Apim-Subscription-Key",
"in": "header"
},
"OAuth2Auth": {
"type": "oauth2",
"flow": "accessCode",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"https://cognitiveservices.azure.com/.default": ""
},
"tokenUrl": "https://login.microsoftonline.com/common/oauth2/token"
}
},
"tags": [],
"paths": {
"/authoring/analyze-conversations/projects": {
"get": {
"operationId": "ConversationAuthoringListProjects",
"description": "Lists the existing projects.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectMetadata"
}
},
"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": {
"Successful List Projects": {
"$ref": "./examples/SuccessfulListProjects.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/{projectName}": {
"get": {
"operationId": "ConversationAuthoringProject_GetProject",
"description": "Gets the details of a project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata"
}
},
"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": {
"Successful Get Project": {
"$ref": "./examples/SuccessfulGetProject.json"
}
}
},
"patch": {
"operationId": "ConversationAuthoringProject_CreateProject",
"description": "Creates a new project or updates an existing one.",
"consumes": [
"application/merge-patch+json"
],
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "body",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata"
}
},
"201": {
"description": "The request has succeeded and a new resource has been created as a result.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata"
}
},
"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": {
"Successful Create Project": {
"$ref": "./examples/SuccessfulCreateProject.json"
}
}
},
"delete": {
"operationId": "ConversationAuthoringProject_DeleteProject",
"description": "Deletes a project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Delete Project": {
"$ref": "./examples/SuccessfulDeleteProject.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/:export": {
"post": {
"operationId": "ConversationAuthoringProject_Export",
"description": "Triggers a job to export a project's data.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "format",
"in": "query",
"description": "The format of the exported project file to use.",
"required": false,
"type": "string",
"enum": [
"Conversation",
"Luis"
],
"x-ms-enum": {
"name": "ExportedProjectFormat",
"modelAsString": true,
"values": [
{
"name": "Conversation",
"value": "Conversation",
"description": "Specifies the format for a conversational project."
},
{
"name": "Luis",
"value": "Luis",
"description": "Specifies the format for an application that was exported from LUIS."
}
]
},
"x-ms-client-name": "ExportedProjectFormat"
},
{
"name": "stringIndexType",
"in": "query",
"description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.",
"required": true,
"type": "string",
"enum": [
"Utf16CodeUnit",
"Utf8CodeUnit",
"Utf32CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
},
{
"name": "Utf8CodeUnit",
"value": "Utf8CodeUnit"
},
{
"name": "Utf32CodeUnit",
"value": "Utf32CodeUnit"
}
]
}
},
{
"name": "assetKind",
"in": "query",
"description": "Kind of asset to export.",
"required": false,
"type": "string"
},
{
"name": "trainedModelLabel",
"in": "query",
"description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.",
"required": false,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Export Project": {
"$ref": "./examples/SuccessfulExportProject.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/:import": {
"post": {
"operationId": "ConversationAuthoringProject_Import",
"description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "format",
"in": "query",
"description": "The format of the exported project file to use.",
"required": false,
"type": "string",
"enum": [
"Conversation",
"Luis"
],
"x-ms-enum": {
"name": "ExportedProjectFormat",
"modelAsString": true,
"values": [
{
"name": "Conversation",
"value": "Conversation",
"description": "Specifies the format for a conversational project."
},
{
"name": "Luis",
"value": "Luis",
"description": "Specifies the format for an application that was exported from LUIS."
}
]
},
"x-ms-client-name": "ExportedProjectFormat"
},
{
"name": "body",
"in": "body",
"description": "The project data to import.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedProject"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Import Project": {
"$ref": "./examples/SuccessfulImportProject.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/:train": {
"post": {
"operationId": "ConversationAuthoringProject_Train",
"description": "Triggers a training job for a project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "body",
"in": "body",
"description": "The training input parameters.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobOptions"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Train Project": {
"$ref": "./examples/SuccessfulTrainProject.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments": {
"get": {
"operationId": "ConversationAuthoringListDeployments",
"description": "Lists the deployments belonging to a project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectDeployment"
}
},
"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": {
"Successful List Deployments": {
"$ref": "./examples/SuccessfulListDeployments.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": {
"get": {
"operationId": "ConversationAuthoringDeployment_GetDeployment",
"description": "Gets the details of a deployment.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "deploymentName",
"in": "path",
"description": "Represents deployment name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment"
}
},
"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": {
"Successful Get Deployment": {
"$ref": "./examples/SuccessfulGetDeployment.json"
}
}
},
"put": {
"operationId": "ConversationAuthoringDeployment_DeployProject",
"description": "Creates a new deployment or replaces an existing one.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "deploymentName",
"in": "path",
"description": "The name of the specific deployment of the project to use.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "The new deployment info.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringCreateDeploymentOptions"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Deploy Project": {
"$ref": "./examples/SuccessfulDeployProject.json"
}
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "ConversationAuthoringDeployment_DeleteDeployment",
"description": "Deletes a project deployment.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "deploymentName",
"in": "path",
"description": "The name of the specific deployment of the project to use.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Delete Deployment": {
"$ref": "./examples/SuccessfulDeleteDeployment.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": {
"post": {
"operationId": "ConversationAuthoringDeployment_DeleteDeploymentFromResources",
"description": "Deletes a deployment from the specified project-assigned resources.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "deploymentName",
"in": "path",
"description": "The name of the specific deployment of the project to use.",
"required": true,
"type": "string"
},
{
"name": "body",
"in": "body",
"description": "The Language or AIService resource list for deleting the deployment.\\r\\n The deployment will only be deleted from the specified resources, and will remain for the rest.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectAzureResourceIds"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Delete Deployment From Resources": {
"$ref": "./examples/SuccessfulDeleteDeploymentFromResources.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringDeployment_GetDeploymentDeleteFromResourcesStatus",
"description": "Gets the status of an existing delete deployment from specific resources job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "deploymentName",
"in": "path",
"description": "Represents deployment name.",
"required": true,
"type": "string"
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState"
}
},
"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": {
"Successful Get Deployment Delete From Resources Status": {
"$ref": "./examples/SuccessfulGetDeploymentDeleteFromResourcesStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringDeployment_GetDeploymentStatus",
"description": "Gets the status of an existing deployment job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "deploymentName",
"in": "path",
"description": "Represents deployment name.",
"required": true,
"type": "string"
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringDeploymentJobState"
}
},
"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": {
"Successful Get Deployment Status": {
"$ref": "./examples/SuccessfulGetDeploymentStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": {
"post": {
"operationId": "ConversationAuthoringProject_SwapDeployments",
"description": "Swaps two existing deployments with each other.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "body",
"in": "body",
"description": "The job object to swap two deployments.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsOptions"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Swap Deployments": {
"$ref": "./examples/SuccessfulSwapDeployments.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetSwapDeploymentsStatus",
"description": "Gets the status of an existing swap deployment job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringSwapDeploymentsJobState"
}
},
"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": {
"Successful Get Swap Deployments Status": {
"$ref": "./examples/SuccessfulGetSwapDeploymentsStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetExportStatus",
"description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportProjectJobState"
}
},
"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": {
"Successful Get Export Status": {
"$ref": "./examples/SuccessfulGetExportStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetImportStatus",
"description": "Gets the status for an import.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringImportProjectJobState"
}
},
"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": {
"Successful Get Import Status": {
"$ref": "./examples/SuccessfulGetImportStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/models": {
"get": {
"operationId": "ConversationAuthoringListTrainedModels",
"description": "Lists the trained models belonging to a project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectTrainedModel"
}
},
"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": {
"Successful List Models": {
"$ref": "./examples/SuccessfulListModels.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": {
"get": {
"operationId": "ConversationAuthoringTrainedModel_GetTrainedModel",
"description": "Gets the details of a trained model.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "trainedModelLabel",
"in": "path",
"description": "The trained model label.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel"
}
},
"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": {
"Successful Get Model": {
"$ref": "./examples/SuccessfulGetModel.json"
}
}
},
"delete": {
"operationId": "ConversationAuthoringTrainedModel_DeleteTrainedModel",
"description": "Deletes an existing trained model.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "trainedModelLabel",
"in": "path",
"description": "The trained model label.",
"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": {
"Successful Delete Model": {
"$ref": "./examples/SuccessfulDeleteModel.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": {
"post": {
"operationId": "ConversationAuthoringTrainedModel_LoadSnapshot",
"description": "Restores the snapshot of this trained model to be the current working directory of the project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "trainedModelLabel",
"in": "path",
"description": "The trained model label.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Load Snapshot": {
"$ref": "./examples/SuccessfulLoadSnapshot.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": {
"get": {
"operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationResults",
"description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "trainedModelLabel",
"in": "path",
"description": "The trained model label.",
"required": true,
"type": "string"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/StringIndexTypeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringUtteranceEvaluationResult"
}
},
"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": {
"Successful Get Model Evaluation": {
"$ref": "./examples/SuccessfulGetModelEvaluation.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": {
"get": {
"operationId": "ConversationAuthoringTrainedModel_GetModelEvaluationSummary",
"description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "trainedModelLabel",
"in": "path",
"description": "The trained model label.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationSummary"
}
},
"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": {
"Successful Get Model Evaluation Summary": {
"$ref": "./examples/SuccessfulGetModelEvaluationSummary.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringTrainedModel_GetLoadSnapshotStatus",
"description": "Gets the status for loading a snapshot.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "trainedModelLabel",
"in": "path",
"description": "The trained model label.",
"required": true,
"type": "string"
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringLoadSnapshotJobState"
}
},
"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": {
"Successful Get Load Snapshot Status": {
"$ref": "./examples/SuccessfulGetLoadSnapshotStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/resources": {
"get": {
"operationId": "ConversationAuthoringListProjectResources",
"description": "Lists the Language or AIService resources assigned to the project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringProjectResourceInfo"
}
},
"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": {
"Successful List Project Resources": {
"$ref": "./examples/SuccessfulListProjectResources.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/resources/:assign": {
"post": {
"operationId": "ConversationAuthoringProject_AssignProjectResources",
"description": "Assign new Language or AIService Azure resources to a project to allowing deployment to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "body",
"in": "body",
"description": "The new project resources to be assigned.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectResourceAssignments"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Assign Project Resources": {
"$ref": "./examples/SuccessfulAssignProjectResources.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": {
"post": {
"operationId": "ConversationAuthoringProject_UnassignProjectResources",
"description": "Unassign resources from a project. This disallows deployment to these resources.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "body",
"in": "body",
"description": "The list of Language or AIService Azure resource IDs to be unassigned.",
"required": true,
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectAzureResourceIds"
}
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Unassign Project Resources": {
"$ref": "./examples/SuccessfulUnassignProjectResources.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetAssignProjectResourcesStatus",
"description": "Gets the status of an existing assign project resources job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectResourcesJobState"
}
},
"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": {
"Successful Get Assign Project Resources Status": {
"$ref": "./examples/SuccessfulGetAssignProjectResourcesStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetUnassignProjectResourcesStatus",
"description": "Gets the status of an existing unassign project resources job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectResourcesJobState"
}
},
"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": {
"Successful Get Unassign Project Resources Status": {
"$ref": "./examples/SuccessfulGetUnassignProjectResourcesStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/train/jobs": {
"get": {
"operationId": "ConversationAuthoringListTrainingJobs",
"description": "Lists the non-expired training jobs created for a project.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingJobState"
}
},
"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": {
"Successful List Training Jobs": {
"$ref": "./examples/SuccessfulListTrainingJobs.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetTrainingStatus",
"description": "Gets the status for a training job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The new project name.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState"
}
},
"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": {
"Successful Get Train Status": {
"$ref": "./examples/SuccessfulGetTrainStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": {
"post": {
"operationId": "ConversationAuthoringProject_CancelTrainingJob",
"description": "Triggers a cancellation for a running training job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "projectName",
"in": "path",
"description": "The name of the project to use.",
"required": true,
"type": "string",
"maxLength": 100
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"headers": {
"Operation-Location": {
"type": "string",
"format": "uri",
"description": "The location for monitoring the operation state."
}
}
},
"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": {
"Successful Cancel Training Job": {
"$ref": "./examples/SuccessfulCancelTrainingJob.json"
}
},
"x-ms-long-running-operation": true
}
},
"/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": {
"get": {
"operationId": "ConversationAuthoringProject_GetProjectDeletionStatus",
"description": "Gets the status for a project deletion job.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"name": "jobId",
"in": "path",
"description": "The job ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeletionJobState"
}
},
"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": {
"Successful Get Project Deletion Status": {
"$ref": "./examples/SuccessfulGetProjectDeletionStatus.json"
}
}
}
},
"/authoring/analyze-conversations/projects/global/deployments/resources": {
"get": {
"operationId": "ConversationAuthoringListAssignedResourceDeployments",
"description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata"
}
},
"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": {
"Successful List Assigned Resource Deployments": {
"$ref": "./examples/SuccessfulListAssignedResourceDeployments.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/global/languages": {
"get": {
"operationId": "ConversationAuthoringListSupportedLanguages",
"description": "Lists the supported languages for the given project type.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/ProjectKindQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringSupportedLanguage"
}
},
"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": {
"Successful Get Supported Languages": {
"$ref": "./examples/SuccessfulGetSupportedLanguages.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/global/prebuilt-entities": {
"get": {
"operationId": "ConversationAuthoringListSupportedPrebuiltEntities",
"description": "Lists the supported prebuilt entities that can be used while creating composed entities.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.language"
},
{
"$ref": "#/parameters/SupportedPrebuiltEntitiesQueryParameter.multilingual"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringPrebuiltEntity"
}
},
"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": {
"Successful Get Supported Prebuilt Entities": {
"$ref": "./examples/SuccessfulGetSupportedPrebuiltEntities.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/authoring/analyze-conversations/projects/global/training-config-versions": {
"get": {
"operationId": "ConversationAuthoringListTrainingConfigVersions",
"description": "Lists the support training config version for a given project type.",
"parameters": [
{
"$ref": "#/parameters/Azure.Core.Foundations.ApiVersionParameter"
},
{
"$ref": "#/parameters/Azure.Core.TopQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.SkipQueryParameter"
},
{
"$ref": "#/parameters/Azure.Core.MaxPageSizeQueryParameter"
},
{
"$ref": "#/parameters/ProjectKindQueryParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PagedAnalyzeConversationAuthoringTrainingConfigVersion"
}
},
"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": {
"Successful Get Supported Training Config Versions": {
"$ref": "./examples/SuccessfulGetSupportedTrainingConfigVersions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
}
},
"definitions": {
"AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata": {
"type": "object",
"description": "Represents the metadata for an assigned deployment",
"properties": {
"deploymentName": {
"type": "string",
"description": "Represents the deployment name."
},
"lastDeployedDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents deployment last deployed time."
},
"deploymentExpirationDate": {
"type": "string",
"format": "date",
"description": "Represents deployment expiration date in the runtime."
}
},
"required": [
"deploymentName",
"lastDeployedDateTime",
"deploymentExpirationDate"
]
},
"AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": {
"type": "object",
"description": "Represents the metadata for assigned deployments for a project.",
"properties": {
"projectName": {
"type": "string",
"description": "Represents the project name.",
"readOnly": true
},
"deploymentsMetadata": {
"type": "array",
"description": "Represents the resource region.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentMetadata"
}
}
},
"required": [
"projectName",
"deploymentsMetadata"
]
},
"AnalyzeConversationAuthoringConfusionMatrixCell": {
"type": "object",
"description": "Represents a cell in a confusion matrix.",
"properties": {
"normalizedValue": {
"type": "number",
"format": "float",
"description": "Represents normalized value in percentages."
},
"rawValue": {
"type": "number",
"format": "float",
"description": "Represents raw value."
}
},
"required": [
"normalizedValue",
"rawValue"
]
},
"AnalyzeConversationAuthoringConfusionMatrixRow": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixCell"
}
},
"AnalyzeConversationAuthoringConversationExportedEntity": {
"type": "object",
"description": "Represents an entity with its components.",
"properties": {
"category": {
"type": "string",
"description": "The category of the entity."
},
"compositionSetting": {
"$ref": "#/definitions/CompositionSetting",
"description": "The behavior to follow when the entity's components overlap with each other."
},
"entities": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityList",
"description": "The list component of the entity."
},
"prebuilts": {
"type": "array",
"description": "The prebuilt entities components.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedPrebuiltEntity"
}
},
"regex": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegex",
"description": "The regex component of the entity."
},
"requiredComponents": {
"type": "array",
"description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.",
"items": {
"type": "string"
}
}
},
"required": [
"category"
]
},
"AnalyzeConversationAuthoringConversationExportedIntent": {
"type": "object",
"description": "Represents an exported intent of a conversational project.",
"properties": {
"category": {
"type": "string",
"description": "The intent category."
}
},
"required": [
"category"
]
},
"AnalyzeConversationAuthoringConversationExportedProjectAsset": {
"type": "object",
"description": "Represents the exported assets of a conversational project.",
"properties": {
"intents": {
"type": "array",
"description": "The intents defined in the project.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedIntent"
}
},
"entities": {
"type": "array",
"description": "The entities defined in the project.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedEntity"
}
},
"utterances": {
"type": "array",
"description": "The utterances defined in the project.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringConversationExportedUtterance"
}
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets"
}
],
"x-ms-discriminator-value": "Conversation"
},
"AnalyzeConversationAuthoringConversationExportedUtterance": {
"type": "object",
"description": "Represents an exported utterance for a conversational project.",
"properties": {
"entities": {
"type": "array",
"description": "Represents the entity labels of the utterance.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedUtteranceEntityLabel"
}
},
"text": {
"type": "string",
"description": "The utterance text."
},
"language": {
"type": "string",
"description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
},
"intent": {
"type": "string",
"description": "The intent of the utterance."
},
"dataset": {
"$ref": "#/definitions/DatasetType",
"description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'."
}
},
"required": [
"text",
"intent"
]
},
"AnalyzeConversationAuthoringCreateDeploymentOptions": {
"type": "object",
"description": "Represents the options for creating or updating a project deployment.",
"properties": {
"trainedModelLabel": {
"type": "string",
"description": "Represents the trained model label."
},
"assignedResourceIds": {
"type": "array",
"description": "Represents the Language or AIService resource IDs that if provided,\\n the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.",
"items": {
"type": "string"
}
}
},
"required": [
"trainedModelLabel"
]
},
"AnalyzeConversationAuthoringCreateProjectOptions": {
"type": "object",
"description": "Represents the options used to create or update a project.",
"properties": {
"projectKind": {
"$ref": "#/definitions/ProjectKind",
"description": "Represents the project kind."
},
"settings": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings",
"description": "The project settings."
},
"projectName": {
"type": "string",
"description": "The new project name."
},
"multilingual": {
"type": "boolean",
"description": "Whether the project would be used for multiple languages or not."
},
"description": {
"type": "string",
"description": "The project description."
},
"language": {
"type": "string",
"description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
}
},
"required": [
"projectKind",
"projectName",
"language"
]
},
"AnalyzeConversationAuthoringDeploymentDeleteFromResourcesJobState": {
"type": "object",
"description": "Represents the state of an existing delete deployment from specific resources job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringDeploymentJobState": {
"type": "object",
"description": "Represents the state of a deployment job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringEntitiesEvaluationSummary": {
"type": "object",
"description": "Represents the evaluation result summary for the project's entities.",
"properties": {
"confusionMatrix": {
"type": "object",
"description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.",
"additionalProperties": {
"$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow"
}
},
"entities": {
"type": "object",
"description": "Represents the entities evaluation summary.",
"additionalProperties": {
"$ref": "#/definitions/AnalyzeConversationAuthoringEntityEvaluationSummary"
}
},
"microF1": {
"type": "number",
"format": "float",
"description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive."
},
"microPrecision": {
"type": "number",
"format": "float",
"description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive."
},
"microRecall": {
"type": "number",
"format": "float",
"description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive."
},
"macroF1": {
"type": "number",
"format": "float",
"description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive."
},
"macroPrecision": {
"type": "number",
"format": "float",
"description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive."
},
"macroRecall": {
"type": "number",
"format": "float",
"description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive."
}
},
"required": [
"confusionMatrix",
"entities",
"microF1",
"microPrecision",
"microRecall",
"macroF1",
"macroPrecision",
"macroRecall"
]
},
"AnalyzeConversationAuthoringEntityEvaluationSummary": {
"type": "object",
"description": "Represents the evaluation result for an entity.",
"properties": {
"f1": {
"type": "number",
"format": "double",
"description": "Represents the model F1 score"
},
"precision": {
"type": "number",
"format": "double",
"description": "Represents the model precision"
},
"recall": {
"type": "number",
"format": "double",
"description": "Represents the model precision"
},
"truePositiveCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of true positive"
},
"trueNegativeCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of true negative"
},
"falsePositiveCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of false positive"
},
"falseNegativeCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of false negative"
}
},
"required": [
"f1",
"precision",
"recall",
"truePositiveCount",
"trueNegativeCount",
"falsePositiveCount",
"falseNegativeCount"
]
},
"AnalyzeConversationAuthoringEvaluationOptions": {
"type": "object",
"description": "Represents the options used running the evaluation.",
"properties": {
"kind": {
"$ref": "#/definitions/EvaluationKind",
"description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage."
},
"trainingSplitPercentage": {
"type": "integer",
"format": "int32",
"description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage."
},
"testingSplitPercentage": {
"type": "integer",
"format": "int32",
"description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage."
}
}
},
"AnalyzeConversationAuthoringEvaluationSummary": {
"type": "object",
"description": "Represents the evaluation result summary.",
"properties": {
"entitiesEvaluation": {
"$ref": "#/definitions/AnalyzeConversationAuthoringEntitiesEvaluationSummary",
"description": "Contains the data related to entities evaluation."
},
"intentsEvaluation": {
"$ref": "#/definitions/AnalyzeConversationAuthoringIntentsEvaluationSummary",
"description": "Contains the data related to intents evaluation."
},
"evaluationOptions": {
"$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions",
"description": "The options that were used while running the evaluation."
}
},
"required": [
"entitiesEvaluation",
"intentsEvaluation"
]
},
"AnalyzeConversationAuthoringExportProjectJobState": {
"type": "object",
"description": "Represents the state of an export job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"resultUrl": {
"type": "string",
"description": "The URL to use in order to download the exported project."
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringExportedConversationOrchestration": {
"type": "object",
"description": "Defines the orchestration details for a Conversational project target.",
"properties": {
"projectName": {
"type": "string",
"description": "The name of the targeted project."
},
"deploymentName": {
"type": "string",
"description": "The name of the targeted deployment."
}
},
"required": [
"projectName",
"deploymentName"
]
},
"AnalyzeConversationAuthoringExportedConversationOrchestrationOptions": {
"type": "object",
"description": "Represents the orchestration options for a Conversational project target.",
"properties": {
"conversationOrchestration": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedConversationOrchestration",
"description": "The Conversational project target details."
}
},
"required": [
"conversationOrchestration"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions"
}
],
"x-ms-discriminator-value": "Conversation"
},
"AnalyzeConversationAuthoringExportedEntityList": {
"type": "object",
"description": "Represents a list component of an entity.",
"properties": {
"sublists": {
"type": "array",
"description": "The sub-lists of the list component.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntitySublist"
}
}
}
},
"AnalyzeConversationAuthoringExportedEntityListSynonym": {
"type": "object",
"description": "Represents a list of synonyms inside a list component",
"properties": {
"language": {
"type": "string",
"description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
},
"values": {
"type": "array",
"description": "The list of synonyms.",
"items": {
"type": "string"
}
}
}
},
"AnalyzeConversationAuthoringExportedEntityRegex": {
"type": "object",
"description": "Represents a regex component of an entity.",
"properties": {
"expressions": {
"type": "array",
"description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityRegexExpression"
}
}
}
},
"AnalyzeConversationAuthoringExportedEntityRegexExpression": {
"type": "object",
"description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions",
"properties": {
"regexKey": {
"type": "string",
"description": "The key of the regex expression."
},
"language": {
"type": "string",
"description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
},
"regexPattern": {
"type": "string",
"description": "The regex pattern."
}
}
},
"AnalyzeConversationAuthoringExportedEntitySublist": {
"type": "object",
"description": "Represents a sub-list inside a list component.",
"properties": {
"listKey": {
"type": "string",
"description": "The key of the sub-list."
},
"synonyms": {
"type": "array",
"description": "The phrases of that correspond to the sub-list.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedEntityListSynonym"
}
}
}
},
"AnalyzeConversationAuthoringExportedLuisOrchestration": {
"type": "object",
"description": "Defines the orchestration details for a LUIS application target.",
"properties": {
"appId": {
"$ref": "#/definitions/Azure.Core.uuid",
"description": "The LUIS application ID."
},
"appVersion": {
"type": "string",
"description": "The targeted version Id."
},
"slotName": {
"type": "string",
"description": "The targeted slot name."
}
},
"required": [
"appId"
]
},
"AnalyzeConversationAuthoringExportedLuisOrchestrationOptions": {
"type": "object",
"description": "Represents the orchestration options for a LUIS application target.",
"properties": {
"luisOrchestration": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedLuisOrchestration",
"description": "The LUIS application target details."
}
},
"required": [
"luisOrchestration"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions"
}
],
"x-ms-discriminator-value": "Luis"
},
"AnalyzeConversationAuthoringExportedOrchestrationOptions": {
"type": "object",
"description": "Represents the options used to define the orchestration behavior of an intent.",
"properties": {
"targetProjectKind": {
"$ref": "#/definitions/OrchestrationTargetProjectKind"
}
},
"discriminator": "targetProjectKind",
"required": [
"targetProjectKind"
]
},
"AnalyzeConversationAuthoringExportedPrebuiltEntity": {
"type": "object",
"description": "Represents an exported prebuilt entity component",
"properties": {
"category": {
"type": "string",
"description": "The prebuilt entity category."
}
},
"required": [
"category"
]
},
"AnalyzeConversationAuthoringExportedProject": {
"type": "object",
"description": "Represents an exported project.",
"properties": {
"projectFileVersion": {
"type": "string",
"description": "The version of the exported file."
},
"stringIndexType": {
"$ref": "#/definitions/StringIndexType",
"description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets."
},
"metadata": {
"$ref": "#/definitions/AnalyzeConversationAuthoringCreateProjectOptions",
"description": "Represents the project metadata."
},
"assets": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets",
"description": "Represents the project assets."
}
},
"required": [
"projectFileVersion",
"stringIndexType",
"metadata"
]
},
"AnalyzeConversationAuthoringExportedProjectAssets": {
"type": "object",
"description": "Represents the assets of an exported project.",
"properties": {
"projectKind": {
"$ref": "#/definitions/ProjectKind",
"description": "The type of project containing the assets."
}
},
"discriminator": "projectKind",
"required": [
"projectKind"
]
},
"AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration": {
"type": "object",
"description": "Defines the orchestration details for a Question Answering project target.",
"properties": {
"projectName": {
"type": "string",
"description": "The name of the target project."
}
},
"required": [
"projectName"
]
},
"AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestrationOptions": {
"type": "object",
"description": "Represents the orchestration options for a Question Answering project target.",
"properties": {
"questionAnsweringOrchestration": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedQuestionAnsweringOrchestration",
"description": "The Question Answering project details."
}
},
"required": [
"questionAnsweringOrchestration"
],
"allOf": [
{
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions"
}
],
"x-ms-discriminator-value": "QuestionAnswering"
},
"AnalyzeConversationAuthoringExportedUtteranceEntityLabel": {
"type": "object",
"description": "Represents an entity label for an utterance.",
"properties": {
"category": {
"type": "string",
"description": "The category of the entity label."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "Start position for the entity text."
},
"length": {
"type": "integer",
"format": "int32",
"description": "Length for the entity text."
}
},
"required": [
"category",
"offset",
"length"
]
},
"AnalyzeConversationAuthoringImportProjectJobState": {
"type": "object",
"description": "Represents the state of an import job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringIntentEvaluationSummary": {
"type": "object",
"description": "The evaluation summary for an intent.",
"properties": {
"f1": {
"type": "number",
"format": "double",
"description": "Represents the model precision"
},
"precision": {
"type": "number",
"format": "double",
"description": "Represents the model recall"
},
"recall": {
"type": "number",
"format": "double",
"description": "Represents the model F1 score"
},
"truePositiveCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of true positive"
},
"trueNegativeCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of true negative"
},
"falsePositiveCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of false positive"
},
"falseNegativeCount": {
"type": "integer",
"format": "int32",
"description": "Represents the count of false negative"
}
},
"required": [
"f1",
"precision",
"recall",
"truePositiveCount",
"trueNegativeCount",
"falsePositiveCount",
"falseNegativeCount"
]
},
"AnalyzeConversationAuthoringIntentsEvaluationSummary": {
"type": "object",
"description": "Represents the evaluation summary for the project's intents.",
"properties": {
"confusionMatrix": {
"type": "object",
"description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.",
"additionalProperties": {
"$ref": "#/definitions/AnalyzeConversationAuthoringConfusionMatrixRow"
}
},
"intents": {
"type": "object",
"description": "Represents the intents evaluation summary.",
"additionalProperties": {
"$ref": "#/definitions/AnalyzeConversationAuthoringIntentEvaluationSummary"
}
},
"microF1": {
"type": "number",
"format": "float",
"description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive."
},
"microPrecision": {
"type": "number",
"format": "float",
"description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive."
},
"microRecall": {
"type": "number",
"format": "float",
"description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive."
},
"macroF1": {
"type": "number",
"format": "float",
"description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive."
},
"macroPrecision": {
"type": "number",
"format": "float",
"description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive."
},
"macroRecall": {
"type": "number",
"format": "float",
"description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive."
}
},
"required": [
"confusionMatrix",
"intents",
"microF1",
"microPrecision",
"microRecall",
"macroF1",
"macroPrecision",
"macroRecall"
]
},
"AnalyzeConversationAuthoringLoadSnapshotJobState": {
"type": "object",
"description": "Represents the state of loading a snapshot job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringOrchestrationExportedIntent": {
"type": "object",
"description": "Represents an exported intent for an orchestration project.",
"properties": {
"orchestration": {
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedOrchestrationOptions",
"description": "Specifies the behavior of this intent in the orchestration flow."
},
"category": {
"type": "string",
"description": "The intent category."
}
},
"required": [
"category"
]
},
"AnalyzeConversationAuthoringOrchestrationExportedProjectAsset": {
"type": "object",
"description": "Represents the assets of an orchestration project.",
"properties": {
"intents": {
"type": "array",
"description": "Represents the intents of the project.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedIntent"
}
},
"utterances": {
"type": "array",
"description": "Represents the utterances of the project.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringOrchestrationExportedUtterance"
}
}
},
"allOf": [
{
"$ref": "#/definitions/AnalyzeConversationAuthoringExportedProjectAssets"
}
],
"x-ms-discriminator-value": "Orchestration"
},
"AnalyzeConversationAuthoringOrchestrationExportedUtterance": {
"type": "object",
"description": "Represents an utterance of an orchestration project.",
"properties": {
"text": {
"type": "string",
"description": "The utterance text."
},
"language": {
"type": "string",
"description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
},
"intent": {
"type": "string",
"description": "The intent of the utterance."
},
"dataset": {
"type": "string",
"description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'."
}
},
"required": [
"text",
"intent"
]
},
"AnalyzeConversationAuthoringPrebuiltEntity": {
"type": "object",
"description": "Represents a supported prebuilt entity.",
"properties": {
"category": {
"type": "string",
"description": "The prebuilt entity category.",
"readOnly": true
},
"description": {
"type": "string",
"description": "The description."
},
"examples": {
"type": "string",
"description": "English examples for the entity."
}
},
"required": [
"category",
"description",
"examples"
]
},
"AnalyzeConversationAuthoringProjectAzureResourceIds": {
"type": "object",
"description": "Represents the payload for deleting a project deployment.",
"properties": {
"assignedResourceIds": {
"type": "array",
"description": "Represents the Language or AIService resource IDs to unassign from the project or delete the deployment from.",
"items": {
"type": "string"
}
}
}
},
"AnalyzeConversationAuthoringProjectDeletionJobState": {
"type": "object",
"description": "Represents the state of a project deletion job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringProjectDeployment": {
"type": "object",
"description": "Represents a project deployment.",
"properties": {
"deploymentName": {
"type": "string",
"description": "Represents deployment name.",
"readOnly": true
},
"modelId": {
"type": "string",
"description": "Represents deployment modelId."
},
"lastTrainedDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents deployment last trained time."
},
"lastDeployedDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents deployment last deployed time."
},
"deploymentExpirationDate": {
"type": "string",
"format": "date",
"description": "Represents deployment expiration date in the runtime."
},
"modelTrainingConfigVersion": {
"type": "string",
"description": "Represents model training config version."
},
"assignedResources": {
"type": "array",
"description": "Represents the metadata of the assigned Azure resources.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectResourceInfo"
}
}
},
"required": [
"deploymentName",
"modelId",
"lastTrainedDateTime",
"lastDeployedDateTime",
"deploymentExpirationDate",
"modelTrainingConfigVersion",
"assignedResources"
]
},
"AnalyzeConversationAuthoringProjectMetadata": {
"type": "object",
"description": "Represents the metadata of a project.",
"properties": {
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the project creation datetime."
},
"lastModifiedDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the project creation datetime."
},
"lastTrainedDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the project last trained datetime."
},
"lastDeployedDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the project last deployed datetime."
},
"projectKind": {
"$ref": "#/definitions/ProjectKind",
"description": "Represents the project kind.",
"x-ms-mutability": [
"read",
"create"
]
},
"settings": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectSettings",
"description": "The project settings.",
"x-ms-mutability": [
"read",
"create"
]
},
"projectName": {
"type": "string",
"description": "The new project name.",
"maxLength": 100,
"x-ms-mutability": [
"read",
"create"
]
},
"multilingual": {
"type": "boolean",
"description": "Whether the project would be used for multiple languages or not.",
"x-ms-mutability": [
"read",
"create"
]
},
"description": {
"type": "string",
"description": "The project description.",
"x-ms-mutability": [
"read",
"create"
]
},
"language": {
"type": "string",
"description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"required": [
"createdDateTime",
"lastModifiedDateTime",
"projectKind",
"projectName",
"language"
]
},
"AnalyzeConversationAuthoringProjectResourceAssignmentInfo": {
"type": "object",
"description": "Represents metadata for the Azure resource..",
"properties": {
"azureResourceId": {
"type": "string",
"description": "Represents the Azure resource ID."
},
"customDomain": {
"type": "string",
"description": "Represents the Azure resource custom domain."
},
"region": {
"type": "string",
"description": "Represents the Azure resource region."
}
},
"required": [
"azureResourceId",
"customDomain",
"region"
]
},
"AnalyzeConversationAuthoringProjectResourceAssignments": {
"type": "object",
"description": "Represents the payload for assigning Azure resources to a project.",
"properties": {
"projectResources": {
"type": "array",
"description": "Represents the metadata for the project resources to be assigned.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectResourceAssignmentInfo"
}
}
},
"required": [
"projectResources"
]
},
"AnalyzeConversationAuthoringProjectResourceInfo": {
"type": "object",
"description": "Represents the assigned project resource.",
"properties": {
"azureResourceId": {
"type": "string",
"description": "The Azure resource ID of the language or AI resource.",
"readOnly": true
},
"region": {
"type": "string",
"description": "The Azure resource region."
}
},
"required": [
"azureResourceId",
"region"
]
},
"AnalyzeConversationAuthoringProjectResourcesJobState": {
"type": "object",
"description": "Represents the state of a project resources job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringProjectSettings": {
"type": "object",
"description": "Represents the settings used to define the project behavior.",
"properties": {
"confidenceThreshold": {
"type": "number",
"format": "float",
"description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive."
}
},
"required": [
"confidenceThreshold"
]
},
"AnalyzeConversationAuthoringProjectTrainedModel": {
"type": "object",
"description": "Represents a trained model.",
"properties": {
"label": {
"type": "string",
"description": "The trained model label.",
"readOnly": true
},
"modelId": {
"type": "string",
"description": "The model ID."
},
"lastTrainedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last trained date time of the model."
},
"lastTrainingDurationInSeconds": {
"type": "integer",
"format": "int32",
"description": "The duration of the model's last training request in seconds."
},
"modelExpirationDate": {
"type": "string",
"format": "date",
"description": "The model expiration date."
},
"modelTrainingConfigVersion": {
"type": "string",
"description": "The model training config version."
},
"hasSnapshot": {
"type": "boolean",
"description": "The flag to indicate if the trained model has a snapshot ready."
}
},
"required": [
"label",
"modelId",
"lastTrainedDateTime",
"lastTrainingDurationInSeconds",
"modelExpirationDate",
"modelTrainingConfigVersion",
"hasSnapshot"
]
},
"AnalyzeConversationAuthoringSubTrainingJobState": {
"type": "object",
"description": "Represents the detailed state of a training sub-operation.",
"properties": {
"percentComplete": {
"type": "integer",
"format": "int32",
"description": "Represents progress percentage."
},
"startDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the start date time."
},
"endDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the end date time."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "Represents the status of the sub-operation."
}
},
"required": [
"percentComplete",
"status"
]
},
"AnalyzeConversationAuthoringSupportedLanguage": {
"type": "object",
"description": "Represents a supported language.",
"properties": {
"languageName": {
"type": "string",
"description": "The language name.",
"readOnly": true
},
"languageCode": {
"type": "string",
"description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
}
},
"required": [
"languageName",
"languageCode"
]
},
"AnalyzeConversationAuthoringSwapDeploymentsJobState": {
"type": "object",
"description": "Represents the state of a deployment job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status"
]
},
"AnalyzeConversationAuthoringSwapDeploymentsOptions": {
"type": "object",
"description": "Represents the options for swapping two deployments together.",
"properties": {
"firstDeploymentName": {
"type": "string",
"description": "Represents the first deployment name."
},
"secondDeploymentName": {
"type": "string",
"description": "Represents the second deployment name."
}
},
"required": [
"firstDeploymentName",
"secondDeploymentName"
]
},
"AnalyzeConversationAuthoringTrainingConfigVersion": {
"type": "object",
"description": "Represents a training config version.",
"properties": {
"trainingConfigVersion": {
"type": "string",
"description": "Represents the version of the config.",
"readOnly": true
},
"modelExpirationDate": {
"type": "string",
"format": "date",
"description": "Represents the training config version expiration date."
}
},
"required": [
"trainingConfigVersion",
"modelExpirationDate"
]
},
"AnalyzeConversationAuthoringTrainingJobOptions": {
"type": "object",
"description": "Represents the options for starting a new training job.",
"properties": {
"modelLabel": {
"type": "string",
"description": "Represents the output model label."
},
"trainingConfigVersion": {
"type": "string",
"description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version."
},
"trainingMode": {
"$ref": "#/definitions/TrainingMode",
"description": "Represents the mode of the training operation."
},
"evaluationOptions": {
"$ref": "#/definitions/AnalyzeConversationAuthoringEvaluationOptions",
"description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20."
}
},
"required": [
"modelLabel",
"trainingMode"
]
},
"AnalyzeConversationAuthoringTrainingJobResult": {
"type": "object",
"description": "Represents the output of a training job.",
"properties": {
"modelLabel": {
"type": "string",
"description": "Represents trained model label."
},
"trainingConfigVersion": {
"type": "string",
"description": "Represents training config version."
},
"trainingMode": {
"$ref": "#/definitions/TrainingMode",
"description": "Represents the mode of the training operation."
},
"trainingStatus": {
"$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState",
"description": "Represents the model training status."
},
"evaluationStatus": {
"$ref": "#/definitions/AnalyzeConversationAuthoringSubTrainingJobState",
"description": "Represents model evaluation status."
},
"estimatedEndDateTime": {
"type": "string",
"format": "date-time",
"description": "Represents the estimated end date time for training and evaluation."
}
},
"required": [
"modelLabel",
"trainingConfigVersion",
"trainingStatus"
]
},
"AnalyzeConversationAuthoringTrainingJobState": {
"type": "object",
"description": "Represents the state of a training job.",
"properties": {
"jobId": {
"type": "string",
"description": "The job ID.",
"readOnly": true
},
"createdDateTime": {
"type": "string",
"format": "date-time",
"description": "The creation date time of the job."
},
"lastUpdatedDateTime": {
"type": "string",
"format": "date-time",
"description": "The last date time the job was updated."
},
"expirationDateTime": {
"type": "string",
"format": "date-time",
"description": "The expiration date time of the job."
},
"status": {
"$ref": "#/definitions/JobStatus",
"description": "The job status."
},
"warnings": {
"type": "array",
"description": "The warnings that were encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"errors": {
"type": "array",
"description": "The errors encountered while executing the job.",
"items": {
"$ref": "#/definitions/Azure.Core.Foundations.Error"
}
},
"result": {
"$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobResult",
"description": "Represents training tasks detailed result."
}
},
"required": [
"jobId",
"createdDateTime",
"lastUpdatedDateTime",
"status",
"result"
]
},
"AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult": {
"type": "object",
"description": "Represents the comparison between the expected and predicted entities for an utterance.",
"properties": {
"expectedEntities": {
"type": "array",
"description": "Represents the expected entity labels.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult"
}
},
"predictedEntities": {
"type": "array",
"description": "Represents the predicted entity labels.",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntityEvaluationResult"
}
}
},
"required": [
"expectedEntities",
"predictedEntities"
]
},
"AnalyzeConversationAuthoringUtteranceEntityEvaluationResult": {
"type": "object",
"description": "Represents the evaluation output of an entity label or prediction.",
"properties": {
"category": {
"type": "string",
"description": "Represents the entity category."
},
"offset": {
"type": "integer",
"format": "int32",
"description": "Represents the entity offset index relative to the original text."
},
"length": {
"type": "integer",
"format": "int32",
"description": "Represents the entity length."
}
},
"required": [
"category",
"offset",
"length"
]
},
"AnalyzeConversationAuthoringUtteranceEvaluationResult": {
"type": "object",
"description": "Represents the evaluation result for an utterance.",
"properties": {
"text": {
"type": "string",
"description": "Represents the utterance text.",
"readOnly": true
},
"language": {
"type": "string",
"description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc."
},
"entitiesResult": {
"$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEntitiesEvaluationResult",
"description": "Represents the entities results for the utterance."
},
"intentsResult": {
"$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult",
"description": "Represents the intents results for the utterance."
}
},
"required": [
"text",
"language",
"entitiesResult",
"intentsResult"
]
},
"AnalyzeConversationAuthoringUtteranceIntentsEvaluationResult": {
"type": "object",
"description": "Represents the comparison between the expected and the predicted intent for an utterance.",
"properties": {
"expectedIntent": {
"type": "string",
"description": "Represents the utterance's expected intent."
},
"predictedIntent": {
"type": "string",
"description": "Represents the utterance's predicted intent."
}
},
"required": [
"expectedIntent",
"predictedIntent"
]
},
"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."
}
}
},
"Azure.Core.uuid": {
"type": "string",
"format": "uuid",
"description": "Universally Unique Identifier"
},
"CompositionSetting": {
"type": "string",
"enum": [
"returnLongestOverlap",
"requireExactOverlap",
"separateComponents",
"combineComponents"
],
"x-ms-enum": {
"name": "CompositionSetting",
"modelAsString": true,
"values": [
{
"name": "returnLongestOverlap",
"value": "returnLongestOverlap",
"description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned."
},
{
"name": "requireExactOverlap",
"value": "requireExactOverlap",
"description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return."
},
{
"name": "separateComponents",
"value": "separateComponents",
"description": "Every component's match or prediction is returned as a separate instance of the entity."
},
{
"name": "combineComponents",
"value": "combineComponents",
"description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them."
}
]
}
},
"DatasetType": {
"type": "string",
"description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.",
"enum": [
"Train",
"Test"
],
"x-ms-enum": {
"name": "DatasetType",
"modelAsString": true,
"values": [
{
"name": "Train",
"value": "Train",
"description": "Split the data into training and test sets according to user-defined percentages."
},
{
"name": "Test",
"value": "Test",
"description": "Split the data according to the chosen dataset for every example in the data."
}
]
}
},
"EvaluationKind": {
"type": "string",
"enum": [
"percentage",
"manual"
],
"x-ms-enum": {
"name": "EvaluationKind",
"modelAsString": true,
"values": [
{
"name": "percentage",
"value": "percentage",
"description": "Split the data into training and test sets according to user-defined percentages."
},
{
"name": "manual",
"value": "manual",
"description": "Split the data according to the chosen dataset for every example in the data."
}
]
}
},
"JobStatus": {
"type": "string",
"enum": [
"notStarted",
"running",
"succeeded",
"failed",
"cancelled",
"cancelling",
"partiallyCompleted"
],
"x-ms-enum": {
"name": "JobStatus",
"modelAsString": true,
"values": [
{
"name": "notStarted",
"value": "notStarted"
},
{
"name": "running",
"value": "running"
},
{
"name": "succeeded",
"value": "succeeded"
},
{
"name": "failed",
"value": "failed"
},
{
"name": "cancelled",
"value": "cancelled"
},
{
"name": "cancelling",
"value": "cancelling"
},
{
"name": "partiallyCompleted",
"value": "partiallyCompleted"
}
]
}
},
"OrchestrationTargetProjectKind": {
"type": "string",
"enum": [
"Luis",
"Conversation",
"QuestionAnswering"
],
"x-ms-enum": {
"name": "OrchestrationTargetProjectKind",
"modelAsString": true,
"values": [
{
"name": "Luis",
"value": "Luis"
},
{
"name": "Conversation",
"value": "Conversation"
},
{
"name": "QuestionAnswering",
"value": "QuestionAnswering"
}
]
}
},
"PagedAnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringAssignedProjectDeploymentsMetadata"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringPrebuiltEntity": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringPrebuiltEntity items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringPrebuiltEntity items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringPrebuiltEntity"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringProjectDeployment": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringProjectDeployment items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringProjectDeployment items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectDeployment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringProjectMetadata": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringProjectMetadata items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringProjectMetadata items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectMetadata"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringProjectResourceInfo": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringProjectResourceInfo items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringProjectResourceInfo items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectResourceInfo"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringProjectTrainedModel": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringProjectTrainedModel items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringProjectTrainedModel items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringProjectTrainedModel"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringSupportedLanguage": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringSupportedLanguage items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringSupportedLanguage items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringSupportedLanguage"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringTrainingConfigVersion": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringTrainingConfigVersion items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringTrainingConfigVersion items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringTrainingConfigVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringTrainingJobState": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringTrainingJobState items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringTrainingJobState items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringTrainingJobState"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PagedAnalyzeConversationAuthoringUtteranceEvaluationResult": {
"type": "object",
"description": "Paged collection of AnalyzeConversationAuthoringUtteranceEvaluationResult items",
"properties": {
"value": {
"type": "array",
"description": "The AnalyzeConversationAuthoringUtteranceEvaluationResult items on this page",
"items": {
"$ref": "#/definitions/AnalyzeConversationAuthoringUtteranceEvaluationResult"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ProjectKind": {
"type": "string",
"enum": [
"Conversation",
"Orchestration"
],
"x-ms-enum": {
"name": "ProjectKind",
"modelAsString": true,
"values": [
{
"name": "Conversation",
"value": "Conversation",
"description": "A project to build natural language into apps, bots, and IoT devices."
},
{
"name": "Orchestration",
"value": "Orchestration",
"description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project."
}
]
}
},
"StringIndexType": {
"type": "string",
"enum": [
"Utf16CodeUnit",
"Utf8CodeUnit",
"Utf32CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
},
{
"name": "Utf8CodeUnit",
"value": "Utf8CodeUnit"
},
{
"name": "Utf32CodeUnit",
"value": "Utf32CodeUnit"
}
]
}
},
"TrainingMode": {
"type": "string",
"enum": [
"advanced",
"standard"
],
"x-ms-enum": {
"name": "TrainingMode",
"modelAsString": true,
"values": [
{
"name": "advanced",
"value": "advanced",
"description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects."
},
{
"name": "standard",
"value": "standard",
"description": "Faster training times for quicker iterations."
}
]
}
}
},
"parameters": {
"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"
},
"Azure.Core.MaxPageSizeQueryParameter": {
"name": "maxpagesize",
"in": "query",
"description": "The maximum number of result items per page.",
"required": false,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
},
"Azure.Core.SkipQueryParameter": {
"name": "skip",
"in": "query",
"description": "The number of result items to skip.",
"required": false,
"type": "integer",
"format": "int32",
"default": 0,
"x-ms-parameter-location": "method"
},
"Azure.Core.TopQueryParameter": {
"name": "top",
"in": "query",
"description": "The number of result items to return.",
"required": false,
"type": "integer",
"format": "int32",
"x-ms-parameter-location": "method"
},
"ProjectKindQueryParameter": {
"name": "projectKind",
"in": "query",
"description": "The project kind.",
"required": true,
"type": "string",
"enum": [
"Conversation",
"Orchestration"
],
"x-ms-enum": {
"name": "ProjectKind",
"modelAsString": true,
"values": [
{
"name": "Conversation",
"value": "Conversation",
"description": "A project to build natural language into apps, bots, and IoT devices."
},
{
"name": "Orchestration",
"value": "Orchestration",
"description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project."
}
]
},
"x-ms-parameter-location": "method",
"x-ms-client-name": "ProjectKind"
},
"StringIndexTypeQueryParameter": {
"name": "stringIndexType",
"in": "query",
"description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.",
"required": true,
"type": "string",
"enum": [
"Utf16CodeUnit",
"Utf8CodeUnit",
"Utf32CodeUnit"
],
"x-ms-enum": {
"name": "StringIndexType",
"modelAsString": true,
"values": [
{
"name": "Utf16CodeUnit",
"value": "Utf16CodeUnit",
"description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript."
},
{
"name": "Utf8CodeUnit",
"value": "Utf8CodeUnit"
},
{
"name": "Utf32CodeUnit",
"value": "Utf32CodeUnit"
}
]
},
"x-ms-parameter-location": "method"
},
"SupportedPrebuiltEntitiesQueryParameter.language": {
"name": "language",
"in": "query",
"description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
},
"SupportedPrebuiltEntitiesQueryParameter.multilingual": {
"name": "multilingual",
"in": "query",
"description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.",
"required": false,
"type": "string",
"x-ms-parameter-location": "method"
}
}
}