diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 4cb9d8c36626..3c0514083f66 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -6,10 +6,10 @@ This is the AutoRest configuration file the Cognitive Services Language SDK. ## Releases -The current preview release of Conversational Language Understanding and Text Analytics is 2022-05-15-preview. - The current stable release of Question Answering is 2021-10-01. +The current stable release of Conversational Language Understanding and Language is 2022-05-01. + ```yaml tag: release_2022_05_15_preview add-credentials: true @@ -22,6 +22,7 @@ directive: where: $.definitions.CurrencyResolution.properties.ISO4217 reason: ISO should be upper case. ``` + ### Release 2022-05-15-preview These settings apply only when `--tag=release_2022_05_15_preview` is specified on the command line. @@ -39,6 +40,21 @@ modelerfour: ``` +### Release 2022-05-01 + +These settings apply only when `--tag=release_2022_05_01` is specified on the command line. + +``` yaml $(tag) == 'release_2022_05_01' +input-file: + - stable/2022-05-01/textanalytics.json + - stable/2022-05-01/analyzetext-authoring.json + - stable/2022-05-01/analyzeconversations-authoring.json + - stable/2022-05-01/analyzeconversations.json +title: + Microsoft Cognitive Language Service +modelerfour: + lenient-model-deduplication: true +``` ### Release 2022-03-01-preview These settings apply only when `--tag=release_2022_03_01_preview` is specified on the command line. diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json new file mode 100644 index 000000000000..1fa9bf1742a3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json @@ -0,0 +1,3102 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", + "version": "2022-05-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://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/authoring/analyze-conversations/projects": { + "get": { + "description": "Lists the existing projects.", + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of projects.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}": { + "patch": { + "description": "Creates a new project or updates an existing one.", + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + } + } + }, + "get": { + "description": "Gets the details of a project.", + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the project.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + } + } + }, + "delete": { + "description": "Deletes a project.", + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:export": { + "post": { + "description": "Triggers a job to export a project's data.", + "operationId": "ConversationalAnalysisAuthoring_Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "in": "query", + "name": "assetKind", + "description": "Kind of asset to export.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:import": { + "post": { + "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", + "operationId": "ConversationalAnalysisAuthoring_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:train": { + "post": { + "description": "Triggers a training job for a project.", + "operationId": "ConversationalAnalysisAuthoring_Train", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments": { + "get": { + "description": "Lists the deployments belonging to a project.", + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all deployments.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "description": "Swaps two existing deployments with each other.", + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { + "get": { + "description": "Gets the details of a deployment.", + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Deployment info.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + } + } + }, + "put": { + "description": "Creates a new deployment or replaces an existing one.", + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes a project deployment.", + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing deployment job.", + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing swap deployment job.", + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The swap deployment job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "description": "Gets the status for an import.", + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models": { + "get": { + "description": "Lists the trained models belonging to a project.", + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all trained models.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { + "get": { + "description": "Gets the details of a trained model.", + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trained model info", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + } + } + }, + "delete": { + "description": "Deletes an existing trained model.", + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Deleted successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "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.", + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the evaluation predictions.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "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.", + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all evaluation results.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { + "get": { + "description": "Lists the non-expired training jobs created for a project.", + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the training jobs.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { + "get": { + "description": "Gets the status for a training job.", + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The training job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "description": "Triggers a cancellation for a running training job.", + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the job cancellation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { + "get": { + "description": "Gets the status for a project deletion job.", + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The project deletion job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/global/languages": { + "get": { + "description": "Lists the supported languages for the given project type.", + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported languages.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Supported Languages": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/global/prebuilt-entities": { + "get": { + "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "language", + "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.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "in": "query", + "name": "multilingual", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported prebuilt entities.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Prebuilt Entities": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/global/training-config-versions": { + "get": { + "description": "Lists the support training config version for a given project type.", + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of config versions.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + } + }, + "definitions": { + "ConversationalAnalysisAuthoringCompositionSetting": { + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" + ], + "type": "string", + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "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." + }, + { + "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." + }, + { + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the entity." + }, + { + "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." + } + ] + }, + "x-ms-client-name": "CompositionSetting" + }, + "ConversationalAnalysisAuthoringConfusionMatrix": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" + }, + "x-ms-client-name": "ConfusionMatrix" + }, + "ConversationalAnalysisAuthoringConfusionMatrixCell": { + "description": "Represents a cell in a confusion matrix.", + "required": [ + "normalizedValue", + "rawValue" + ], + "type": "object", + "properties": { + "normalizedValue": { + "format": "float", + "description": "Represents normalized value in percentages.", + "type": "number" + }, + "rawValue": { + "format": "float", + "description": "Represents raw value.", + "type": "number" + } + }, + "x-ms-client-name": "ConfusionMatrixCell" + }, + "ConversationalAnalysisAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" + }, + "x-ms-client-name": "ConfusionMatrixRow" + }, + "ConversationalAnalysisAuthoringConversationExportedEntity": { + "description": "Represents an entity with its components.", + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "description": "The category of the entity.", + "type": "string" + }, + "compositionSetting": { + "description": "The behavior to follow when the entity's components overlap with each other.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" + }, + "list": { + "description": "The list component of the entity.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" + }, + "prebuilts": { + "description": "The prebuilt entities components.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" + } + } + }, + "x-ms-client-name": "ConversationExportedEntity" + }, + "ConversationalAnalysisAuthoringConversationExportedIntent": { + "description": "Represents an exported intent of a conversational project.", + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "description": "The intent category.", + "type": "string" + } + }, + "x-ms-client-name": "ConversationExportedIntent" + }, + "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { + "description": "Represents the exported assets of a conversational project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "intents": { + "description": "The intents defined in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" + } + }, + "entities": { + "description": "The entities defined in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" + } + }, + "utterances": { + "description": "The utterances defined in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" + } + } + }, + "x-ms-discriminator-value": "Conversation", + "x-ms-client-name": "ConversationExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringConversationExportedUtterance": { + "description": "Represents an exported utterance for a conversational project.", + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "entities": { + "description": "Represents the entity labels of the utterance.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" + } + }, + "text": { + "description": "The utterance text.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + }, + "intent": { + "description": "The intent of the utterance.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ConversationExportedUtterance" + }, + "ConversationalAnalysisAuthoringCreateDeploymentOptions": { + "description": "Represents the options for creating or updating a project deployment.", + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "Represents the trained model label.", + "type": "string" + } + }, + "x-ms-client-name": "CreateDeploymentOptions" + }, + "ConversationalAnalysisAuthoringCreateProjectOptions": { + "description": "Represents the options used to create or update a project.", + "required": [ + "projectKind", + "projectName", + "language" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + } + }, + "x-ms-client-name": "CreateProjectOptions" + }, + "ConversationalAnalysisAuthoringDeploymentJobState": { + "description": "Represents the state of a deployment job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "DeploymentJobState" + }, + "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { + "description": "Represents the evaluation result summary for the project's entities.", + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "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.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + }, + "entities": { + "description": "Represents the entities evaluation summary.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall", + "type": "number" + } + }, + "x-ms-client-name": "EntitiesEvaluationSummary" + }, + "ConversationalAnalysisAuthoringEntityEvaluationSummary": { + "description": "Represents the evaluation result for an entity.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "EntityEvaluationSummary" + }, + "ConversationalAnalysisAuthoringEvaluationKind": { + "enum": [ + "percentage", + "manual" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + }, + "x-ms-client-name": "EvaluationKind" + }, + "ConversationalAnalysisAuthoringEvaluationOptions": { + "description": "Represents the options used running the evaluation.", + "type": "object", + "properties": { + "kind": { + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" + }, + "trainingSplitPercentage": { + "format": "int32", + "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + }, + "testingSplitPercentage": { + "format": "int32", + "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + } + }, + "x-ms-client-name": "EvaluationOptions" + }, + "ConversationalAnalysisAuthoringEvaluationResults": { + "description": "Represent a list of utterances' evaluation results.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The utterances evaluation results.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EvaluationResults" + }, + "ConversationalAnalysisAuthoringEvaluationSummary": { + "description": "Represents the evaluation result summary.", + "required": [ + "entitiesEvaluation", + "intentsEvaluation" + ], + "type": "object", + "properties": { + "entitiesEvaluation": { + "description": "Contains the data related to entities evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" + }, + "intentsEvaluation": { + "description": "Contains the data related to intents evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" + }, + "evaluationOptions": { + "description": "The options that were used while running the evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + } + }, + "x-ms-client-name": "EvaluationSummary" + }, + "ConversationalAnalysisAuthoringExportedConversationOrchestration": { + "description": "Defines the orchestration details for a Conversational project target.", + "required": [ + "projectName", + "deploymentName" + ], + "type": "object", + "properties": { + "projectName": { + "description": "The name of the targeted project.", + "type": "string" + }, + "deploymentName": { + "description": "The name of the targeted deployment.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedConversationOrchestration" + }, + "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { + "description": "Represents the orchestration options for a Conversational project target.", + "required": [ + "conversationOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "conversationOrchestration": { + "description": "The Conversational project target details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" + } + }, + "x-ms-discriminator-value": "Conversation", + "x-ms-client-name": "ExportedConversationOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedEntityList": { + "description": "Represents a list component of an entity.", + "type": "object", + "properties": { + "sublists": { + "description": "The sub-lists of the list component.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" + } + } + }, + "x-ms-client-name": "ExportedEntityList" + }, + "ConversationalAnalysisAuthoringExportedEntityListSynonym": { + "description": "Represents a list of synonyms inside a list component", + "type": "object", + "properties": { + "language": { + "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.", + "type": "string" + }, + "values": { + "description": "The list of synonyms.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "ExportedEntityListSynonym" + }, + "ConversationalAnalysisAuthoringExportedEntitySublist": { + "description": "Represents a sub-list inside a list component.", + "type": "object", + "properties": { + "listKey": { + "description": "The key of the sub-list.", + "type": "string" + }, + "synonyms": { + "description": "The phrases of that correspond to the sub-list.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" + } + } + }, + "x-ms-client-name": "ExportedEntitySublist" + }, + "ConversationalAnalysisAuthoringExportedLuisOrchestration": { + "description": "Defines the orchestration details for a LUIS application target.", + "required": [ + "appId" + ], + "type": "object", + "properties": { + "appId": { + "format": "uuid", + "description": "The LUIS application ID.", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "appVersion": { + "description": "The targeted version Id.", + "type": "string" + }, + "slotName": { + "description": "The targeted slot name.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedLuisOrchestration" + }, + "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "description": "Represents the orchestration options for a LUIS application target.", + "required": [ + "luisOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "luisOrchestration": { + "description": "The LUIS application target details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" + } + }, + "x-ms-discriminator-value": "Luis", + "x-ms-client-name": "ExportedLuisOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { + "description": "Represents the options used to define the orchestration behavior of an intent.", + "required": [ + "targetProjectKind" + ], + "type": "object", + "properties": { + "targetProjectKind": { + "description": "The kind of the target used in the orchestration flow.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" + } + }, + "discriminator": "targetProjectKind", + "x-ms-client-name": "ExportedOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { + "description": "Represents an exported prebuilt entity component", + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "description": "The prebuilt entity category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedPrebuiltEntity" + }, + "ConversationalAnalysisAuthoringExportedProject": { + "description": "Represents an exported project.", + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "projectFileVersion": { + "description": "The version of the exported file.", + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + }, + "x-ms-client-name": "ExportedProject" + }, + "ConversationalAnalysisAuthoringExportedProjectAssets": { + "description": "Represents the assets of an exported project.", + "required": [ + "projectKind" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "The type of project containing the assets.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "ExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringExportedProjectFormat": { + "enum": [ + "Conversation", + "Luis" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { + "description": "Defines the orchestration details for a Question Answering project target.", + "required": [ + "projectName" + ], + "type": "object", + "properties": { + "projectName": { + "description": "The name of the target project.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" + }, + "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "description": "Represents the orchestration options for a Question Answering project target.", + "required": [ + "questionAnsweringOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "questionAnsweringOrchestration": { + "description": "The Question Answering project details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" + } + }, + "x-ms-discriminator-value": "QuestionAnswering", + "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { + "description": "Represents an entity label for an utterance.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "The category of the entity label.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Start position for the entity text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Length for the entity text.", + "type": "integer" + } + }, + "x-ms-client-name": "ExportedUtteranceEntityLabel" + }, + "ConversationalAnalysisAuthoringExportProjectJobState": { + "description": "Represents the state of an export job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "properties": { + "resultUrl": { + "description": "The URL to use in order to download the exported project.", + "type": "string" + } + }, + "x-ms-client-name": "ExportProjectJobState" + }, + "ConversationalAnalysisAuthoringImportProjectJobState": { + "description": "Represents the state of an import job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ImportProjectJobState" + }, + "ConversationalAnalysisAuthoringIntentEvaluationSummary": { + "description": "The evaluation summary for an intent.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "IntentEvaluationSummary" + }, + "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { + "description": "Represents the evaluation summary for the project's intents.", + "required": [ + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "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.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + }, + "intents": { + "description": "Represents the intents evaluation summary.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall", + "type": "number" + } + }, + "x-ms-client-name": "IntentsEvaluationSummary" + }, + "ConversationalAnalysisAuthoringJobState": { + "description": "Represents a job's state.", + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "The job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation date time of the job.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "The last date time the job was updated.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date time of the job.", + "type": "string" + }, + "status": { + "description": "The job status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + }, + "warnings": { + "description": "The warnings that were encountered while executing the job.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" + } + }, + "errors": { + "description": "The errors encountered while executing the job.", + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + }, + "x-ms-client-name": "JobState" + }, + "ConversationalAnalysisAuthoringJobStatus": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + }, + "x-ms-client-name": "JobStatus" + }, + "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { + "description": "Represents an exported intent for an orchestration project.", + "required": [ + "category" + ], + "type": "object", + "properties": { + "orchestration": { + "description": "Specifies the behavior of this intent in the orchestration flow.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + }, + "category": { + "description": "The intent category.", + "type": "string" + } + }, + "x-ms-client-name": "OrchestrationExportedIntent" + }, + "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { + "description": "Represents the assets of an orchestration project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "intents": { + "description": "Represents the intents of the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" + } + }, + "utterances": { + "description": "Represents the utterances of the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" + } + } + }, + "x-ms-discriminator-value": "Orchestration", + "x-ms-client-name": "OrchestrationExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { + "description": "Represents an utterance of an orchestration project.", + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "text": { + "description": "The utterance text.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + }, + "intent": { + "description": "The intent of the utterance.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "OrchestrationExportedUtterance" + }, + "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering" + ], + "type": "string", + "x-ms-enum": { + "name": "OrchestrationTargetProjectKind", + "modelAsString": true + }, + "x-ms-client-name": "OrchestrationTargetProjectKind" + }, + "ConversationalAnalysisAuthoringPrebuiltEntities": { + "description": "Represents a list of the retrieved supported prebuilt entities.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The supported prebuilt entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "PrebuiltEntities" + }, + "ConversationalAnalysisAuthoringPrebuiltEntity": { + "description": "Represents a supported prebuilt entity.", + "required": [ + "category", + "description", + "examples" + ], + "type": "object", + "properties": { + "category": { + "description": "The prebuilt entity category.", + "type": "string" + }, + "description": { + "description": "The description.", + "type": "string" + }, + "examples": { + "description": "English examples for the entity.", + "type": "string" + } + }, + "x-ms-client-name": "PrebuiltEntity" + }, + "ConversationalAnalysisAuthoringProjectDeletionJobState": { + "description": "Represents the state of a project deletion job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ProjectDeletionJobState" + }, + "ConversationalAnalysisAuthoringProjectDeployment": { + "description": "Represents a project deployment.", + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "deploymentName": { + "description": "Represents deployment name.", + "type": "string" + }, + "modelId": { + "description": "Represents deployment modelId.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents deployment last trained time.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents deployment last deployed time.", + "type": "string" + }, + "deploymentExpirationDate": { + "format": "date", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents model training config version.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectDeployment" + }, + "ConversationalAnalysisAuthoringProjectDeployments": { + "description": "Represents a list of retrieved deployments.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectDeployments" + }, + "ConversationalAnalysisAuthoringProjectKind": { + "enum": [ + "Conversation", + "Orchestration" + ], + "type": "string", + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + "ConversationalAnalysisAuthoringProjectMetadata": { + "description": "Represents the metadata of a project.", + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ], + "type": "object", + "properties": { + "createdDateTime": { + "format": "date-time", + "description": "Represents the project creation datetime.", + "type": "string" + }, + "lastModifiedDateTime": { + "format": "date-time", + "description": "Represents the project creation datetime.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents the project last trained datetime.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents the project last deployed datetime.", + "type": "string" + }, + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectMetadata" + }, + "ConversationalAnalysisAuthoringProjectSettings": { + "description": "Represents the settings used to define the project behavior.", + "required": [ + "confidenceThreshold" + ], + "type": "object", + "properties": { + "confidenceThreshold": { + "format": "float", + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\".", + "type": "number" + } + }, + "x-ms-client-name": "ProjectSettings" + }, + "ConversationalAnalysisAuthoringProjectsMetadata": { + "description": "Represents a list of retrieved projects' metadata.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of projects.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectsMetadata" + }, + "ConversationalAnalysisAuthoringProjectTrainedModel": { + "description": "Represents a trained model.", + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "label": { + "description": "The trained model label.", + "type": "string" + }, + "modelId": { + "description": "The model ID.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "The last trained date time of the model.", + "type": "string" + }, + "lastTrainingDurationInSeconds": { + "format": "int32", + "description": "The duration of the model's last training request in seconds.", + "type": "integer" + }, + "modelExpirationDate": { + "format": "date", + "description": "The model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "The model training config version.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectTrainedModel" + }, + "ConversationalAnalysisAuthoringProjectTrainedModels": { + "description": "Represents a list of retrieved trained models.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectTrainedModels" + }, + "ConversationalAnalysisAuthoringStringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "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." + } + ] + }, + "x-ms-client-name": "StringIndexType" + }, + "ConversationalAnalysisAuthoringSubTrainingJobState": { + "description": "Represents the detailed state of a training sub-operation.", + "required": [ + "percentComplete", + "status" + ], + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Represents progress percentage.", + "type": "integer" + }, + "startDateTime": { + "format": "date-time", + "description": "Represents the start date time.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Represents the end date time.", + "type": "string" + }, + "status": { + "description": "Represents the status of the sub-operation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + } + }, + "x-ms-client-name": "SubTrainingJobState" + }, + "ConversationalAnalysisAuthoringSupportedLanguage": { + "description": "Represents a supported language.", + "required": [ + "languageName", + "languageCode" + ], + "type": "object", + "properties": { + "languageName": { + "description": "The language name.", + "type": "string" + }, + "languageCode": { + "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.", + "type": "string" + } + }, + "x-ms-client-name": "SupportedLanguage" + }, + "ConversationalAnalysisAuthoringSupportedLanguages": { + "description": "Represents a list of retrieved languages.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the languages.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "SupportedLanguages" + }, + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { + "description": "Represents the options for swapping two deployments together.", + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ], + "type": "object", + "properties": { + "firstDeploymentName": { + "description": "Represents the first deployment name.", + "type": "string" + }, + "secondDeploymentName": { + "description": "Represents the second deployment name.", + "type": "string" + } + }, + "x-ms-client-name": "SwapDeploymentsOptions" + }, + "ConversationalAnalysisAuthoringTrainingConfigVersion": { + "description": "Represents a training config version.", + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ], + "type": "object", + "properties": { + "trainingConfigVersion": { + "description": "Represents the version of the config.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date", + "description": "Represents the training config version expiration date.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingConfigVersion" + }, + "ConversationalAnalysisAuthoringTrainingConfigVersions": { + "description": "Represents a list of training config versions.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the training config versions.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingConfigVersions" + }, + "ConversationalAnalysisAuthoringTrainingJobOptions": { + "description": "Represents the options for starting a new training job.", + "required": [ + "modelLabel", + "trainingMode" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents the output model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", + "type": "string" + }, + "trainingMode": { + "description": "Represents the mode of the training operation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + }, + "evaluationOptions": { + "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + } + }, + "x-ms-client-name": "TrainingJobOptions" + }, + "ConversationalAnalysisAuthoringTrainingJobResult": { + "description": "Represents the output of a training job.", + "required": [ + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents trained model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "trainingMode": { + "description": "Represents the mode of the training operation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + }, + "trainingStatus": { + "description": "Represents the model training status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + }, + "evaluationStatus": { + "description": "Represents model evaluation status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + }, + "estimatedEndDateTime": { + "format": "date-time", + "description": "Represents the estimated end date time for training and evaluation.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingJobResult" + }, + "ConversationalAnalysisAuthoringTrainingJobs": { + "description": "Represents a list of retrieved training jobs.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingJobs" + }, + "ConversationalAnalysisAuthoringTrainingJobState": { + "description": "Represents the state of a training job.", + "required": [ + "result" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "properties": { + "result": { + "description": "Represents training tasks detailed result.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" + } + }, + "x-ms-client-name": "TrainingJobState" + }, + "ConversationalAnalysisAuthoringTrainingMode": { + "enum": [ + "advanced", + "standard" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." + }, + { + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + }, + "x-ms-client-name": "TrainingMode" + }, + "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { + "description": "Represents the comparison between the expected and predicted entities for an utterance.", + "required": [ + "expectedEntities", + "predictedEntities" + ], + "type": "object", + "properties": { + "expectedEntities": { + "description": "Represents the expected entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" + } + }, + "predictedEntities": { + "description": "Represents the predicted entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" + } + } + }, + "x-ms-client-name": "UtteranceEntitiesEvaluationResult" + }, + "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { + "description": "Represents the evaluation output of an entity label or prediction.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "Represents the entity category.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Represents the entity offset index relative to the original text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Represents the entity length.", + "type": "integer" + } + }, + "x-ms-client-name": "UtteranceEntityEvaluationResult" + }, + "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "description": "Represents the evaluation result for an utterance.", + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ], + "type": "object", + "properties": { + "text": { + "description": "Represents the utterance text.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + }, + "entitiesResult": { + "description": "Represents the entities results for the utterance.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" + }, + "intentsResult": { + "description": "Represents the intents results for the utterance.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" + } + }, + "x-ms-client-name": "UtteranceEvaluationResult" + }, + "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { + "description": "Represents the comparison between the expected and the predicted intent for an utterance.", + "required": [ + "expectedIntent", + "predictedIntent" + ], + "type": "object", + "properties": { + "expectedIntent": { + "description": "Represents the utterance's expected intent.", + "type": "string" + }, + "predictedIntent": { + "description": "Represents the utterance's predicted intent.", + "type": "string" + } + }, + "x-ms-client-name": "UtteranceIntentsEvaluationResult" + }, + "ConversationalAnalysisAuthoringWarning": { + "description": "Represents a warning that was encountered while executing the request.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The warning code.", + "type": "string" + }, + "message": { + "description": "The warning message.", + "type": "string" + } + }, + "x-ms-client-name": "Warning" + } + }, + "parameters": { + "ConversationalAnalysisAuthoringFormatQueryParameter": { + "in": "query", + "name": "format", + "description": "The format of the exported project file to use.", + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { + "in": "query", + "name": "stringIndexType", + "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" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "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." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringJobIdPathParameter": { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model label.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringProjectKindQueryParameter": { + "in": "query", + "name": "projectKind", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "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" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations.json new file mode 100644 index 000000000000..acb284570911 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations.json @@ -0,0 +1,1430 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations", + "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "version": "2022-05-01" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/:analyze-conversations": { + "post": { + "operationId": "ConversationAnalysis_AnalyzeConversation", + "description": "Analyzes the input conversation utterance.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "A single conversational task to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeConversationTask" + }, + "required": true + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The conversation analysis response.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Conversation project result": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversations.json" + }, + "Orchestration result": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitration.json" + }, + "Orchestration direct target result": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" + } + } + } + } + }, + "definitions": { + "AnalyzeConversationTaskKind": { + "type": "string", + "description": "Enumeration of supported Conversation tasks.", + "enum": [ + "Conversation" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskKind", + "modelAsString": true + } + }, + "AnalyzeConversationTaskResultsKind": { + "type": "string", + "description": "Enumeration of supported conversational task results", + "enum": [ + "ConversationResult" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskResultsKind", + "modelAsString": true + } + }, + "AnalyzeConversationTask": { + "description": "The base class of a conversation input task.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskKind" + } + } + }, + "AnalyzeConversationTaskResult": { + "description": "The base class of a conversation task result.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" + } + } + }, + "ConversationalTask": { + "description": "The input for a custom conversation task.", + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTask" + } + ], + "properties": { + "analysisInput": { + "$ref": "#/definitions/ConversationAnalysisOptions" + }, + "parameters": { + "$ref": "#/definitions/ConversationTaskParameters" + } + }, + "x-ms-discriminator-value": "Conversation", + "required": [ + "analysisInput", + "parameters" + ] + }, + "ConversationTaskParameters": { + "type": "object", + "description": "Input parameters necessary for a Conversation task.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the project to use." + }, + "deploymentName": { + "type": "string", + "description": "The name of the deployment to use." + }, + "verbose": { + "type": "boolean", + "description": "If true, the service will return more detailed information in the response." + }, + "isLoggingEnabled": { + "type": "boolean", + "description": "If true, the service will keep the query for further review." + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + }, + "directTarget": { + "type": "string", + "description": "The name of a target project to forward the request to." + }, + "targetProjectParameters": { + "type": "object", + "description": "A dictionary representing the parameters for each target project.", + "additionalProperties": { + "$ref": "#/definitions/AnalysisParameters" + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "ConversationalTaskResult": { + "description": "The results of a Conversation task.", + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + ], + "type": "object", + "properties": { + "result": { + "$ref": "#/definitions/AnalyzeConversationResult" + } + }, + "required": [ + "result" + ], + "x-ms-discriminator-value": "ConversationResult" + }, + "ConversationItemBase": { + "type": "object", + "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript).", + "properties": { + "id": { + "description": "The ID of a conversation item.", + "type": "string" + }, + "participantId": { + "description": "The participant ID of a conversation item.", + "type": "string" + }, + "language": { + "description": "The override language of a conversation item in BCP 47 language representation.", + "type": "string" + }, + "modality": { + "$ref": "#/definitions/Modality" + } + }, + "required": [ + "participantId", + "id" + ], + "additionalProperties": true + }, + "TextConversationItem": { + "description": "The text modality of an input conversation.", + "allOf": [ + { + "$ref": "#/definitions/ConversationItemBase" + } + ], + "properties": { + "text": { + "description": "The text input", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "ConversationAnalysisOptions": { + "type": "object", + "description": "The input ConversationItem and its optional parameters", + "required": [ + "conversationItem" + ], + "properties": { + "conversationItem": { + "$ref": "#/definitions/ConversationItemBase" + } + } + }, + "AnalysisParameters": { + "type": "object", + "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", + "required": [ + "targetProjectKind" + ], + "discriminator": "targetProjectKind", + "properties": { + "targetProjectKind": { + "type": "string", + "description": "The type of a target service.", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering", + "NonLinked" + ], + "x-ms-enum": { + "name": "targetProjectKind", + "modelAsString": true + } + }, + "apiVersion": { + "type": "string", + "description": "The API version to use when call a specific target service." + } + } + }, + "NoneLinkedTargetIntentResult": { + "type": "object", + "description": "A wrap up of non-linked intent response.", + "x-ms-discriminator-value": "NonLinked", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + } + }, + "LuisParameters": { + "description": "This is a set of request parameters for LUIS Generally Available projects.", + "x-ms-discriminator-value": "Luis", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "properties": { + "query": { + "type": "string", + "maxLength": 500, + "description": "The utterance to predict." + }, + "callingOptions": { + "type": "object", + "description": "This customizes how the service calls LUIS Generally Available projects.", + "$ref": "#/definitions/LuisCallingOptions" + } + }, + "additionalProperties": true + }, + "LuisCallingOptions": { + "description": "This customizes how the service calls LUIS Generally Available projects.", + "type": "object", + "properties": { + "verbose": { + "description": "Enable verbose response.", + "type": "boolean" + }, + "log": { + "description": "Save log to add in training utterances later.", + "type": "boolean" + }, + "show-all-intents": { + "description": "Set true to show all intents.", + "type": "boolean" + }, + "timezoneOffset": { + "type": "number", + "description": "The timezone offset for the location of the request." + }, + "spellCheck": { + "type": "boolean", + "description": "Enable spell checking." + }, + "bing-spell-check-subscription-key": { + "description": "The subscription key to use when enabling Bing spell check", + "type": "string" + } + } + }, + "ConversationParameters": { + "type": "object", + "description": "This is a set of request parameters for Customized Conversation projects.", + "x-ms-discriminator-value": "Conversation", + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "properties": { + "callingOptions": { + "type": "object", + "$ref": "#/definitions/ConversationCallingOptions" + } + } + }, + "ConversationCallingOptions": { + "type": "object", + "description": "The option to set to call a Conversation project.", + "properties": { + "language": { + "description": "The language of the query in BCP 47 language representation..", + "type": "string" + }, + "verbose": { + "description": "If true, the service will return more detailed information.", + "type": "boolean" + }, + "isLoggingEnabled": { + "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", + "type": "boolean" + } + } + }, + "QuestionAnsweringParameters": { + "type": "object", + "description": "This is a set of request parameters for Question Answering knowledge bases.", + "x-ms-discriminator-value": "QuestionAnswering", + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "properties": { + "callingOptions": { + "description": "The options sent to a Question Answering KB.", + "$ref": "common.json#/definitions/AnswersOptions" + } + } + }, + "AnalyzeConversationResult": { + "type": "object", + "description": "Represents a conversation analysis response.", + "required": [ + "query", + "prediction" + ], + "properties": { + "query": { + "type": "string", + "description": "The conversation utterance given by the caller." + }, + "detectedLanguage": { + "type": "string", + "description": "The system detected language for the query in BCP 47 language representation.." + }, + "prediction": { + "description": "The prediction result of a conversation project.", + "$ref": "#/definitions/BasePrediction" + } + } + }, + "BasePrediction": { + "type": "object", + "description": "This is the base class of prediction", + "required": [ + "projectKind" + ], + "discriminator": "projectKind", + "properties": { + "projectKind": { + "type": "string", + "description": "The type of the project.", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "projectKind", + "modelAsString": true + } + }, + "topIntent": { + "type": "string", + "description": "The intent with the highest score." + } + } + }, + "OrchestrationPrediction": { + "type": "object", + "description": "This represents the prediction result of an Orchestration project.", + "x-ms-discriminator-value": "Orchestration", + "required": [ + "intents" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "properties": { + "intents": { + "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TargetIntentResult" + } + } + } + }, + "TargetIntentResult": { + "type": "object", + "description": "This is the base class of an intent prediction", + "discriminator": "targetProjectKind", + "required": [ + "confidenceScore", + "targetProjectKind" + ], + "properties": { + "targetProjectKind": { + "type": "string", + "description": "This discriminator property specifies the type of the target project that returns the response.", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering", + "NonLinked" + ], + "x-ms-enum": { + "name": "targetProjectKind", + "modelAsString": true + } + }, + "apiVersion": { + "type": "string", + "description": "The API version used to call a target service." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidence", + "description": "The prediction score and it ranges from 0.0 to 1.0.", + "minimum": 0, + "maximum": 1 + } + } + }, + "ConversationTargetIntentResult": { + "type": "object", + "description": "A wrap up of Conversation project response.", + "x-ms-discriminator-value": "Conversation", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "type": "object", + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + } + }, + "ConversationResult": { + "type": "object", + "description": "The response returned by a Conversation project.", + "required": [ + "query" + ], + "properties": { + "query": { + "description": "The same query given in request.", + "type": "string" + }, + "detectedLanguage": { + "description": "The detected language from the query in BCP 47 language representation..", + "type": "string" + }, + "prediction": { + "description": "The predicted result for the query.", + "$ref": "#/definitions/ConversationPrediction" + } + } + }, + "ConversationPrediction": { + "type": "object", + "description": "Represents the prediction section of a Conversation project.", + "x-ms-discriminator-value": "Conversation", + "required": [ + "intents", + "entities" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "properties": { + "intents": { + "description": "The intent classification results.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationIntent" + } + }, + "entities": { + "description": "The entity extraction results.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationEntity" + } + } + } + }, + "ConversationIntent": { + "type": "object", + "description": "The intent classification result of a Conversation project.", + "required": [ + "category", + "confidenceScore" + ], + "properties": { + "category": { + "description": "A predicted class.", + "type": "string" + }, + "confidenceScore": { + "format": "float", + "x-ms-client-name": "confidence", + "description": "The confidence score of the class from 0.0 to 1.0.", + "type": "number", + "minimum": 0, + "maximum": 1 + } + } + }, + "ConversationEntity": { + "type": "object", + "description": "The entity extraction result of a Conversation project.", + "required": [ + "category", + "text", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "category": { + "description": "The entity category.", + "type": "string" + }, + "text": { + "description": "The predicted entity text.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "The starting index of this entity in the query.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "The length of the text.", + "type": "integer" + }, + "confidenceScore": { + "format": "float", + "x-ms-client-name": "confidence", + "description": "The entity confidence score.", + "type": "number" + }, + "resolutions": { + "description": "The collection of entity resolution objects.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseResolution" + } + }, + "extraInformation": { + "description": "The collection of entity extra information objects.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseExtraInformation" + } + } + } + }, + "BaseExtraInformation": { + "description": "The abstract base object for entity extra information.", + "type": "object", + "discriminator": "extraInformationKind", + "properties": { + "extraInformationKind": { + "description": "The extra information object kind.", + "type": "string", + "enum": [ + "EntitySubtype", + "ListKey" + ], + "x-ms-enum": { + "name": "ExtraInformationKind", + "modelAsString": true + } + } + }, + "required": [ + "extraInformationKind" + ] + }, + "EntitySubtype": { + "description": "The concrete entity Subtype model of extra information.", + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "EntitySubtype", + "properties": { + "value": { + "type": "string", + "description": "The Subtype of an extracted entity type." + } + } + }, + "ListKey": { + "description": "The list key extra data kind.", + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "ListKey", + "properties": { + "key": { + "type": "string", + "description": "The canonical form of the extracted entity." + } + } + }, + "BaseResolution": { + "description": "The abstract base class for entity resolutions.", + "type": "object", + "discriminator": "resolutionKind", + "properties": { + "resolutionKind": { + "description": "The entity resolution object kind.", + "type": "string", + "enum": [ + "Boolean", + "DateTime", + "Number", + "Ordinal", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency", + "NumericRange", + "TemporalSpan" + ], + "x-ms-enum": { + "name": "ResolutionKind", + "modelAsString": true + } + } + }, + "required": [ + "resolutionKind" + ] + }, + "QuantityResolution": { + "description": "Represents resolutions for quantities.", + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + } + }, + "required": [ + "value" + ] + }, + "AgeResolution": { + "description": "Represents the Age entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Age", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true + }, + "description": "The Age Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "VolumeResolution": { + "description": "Represents the volume entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Volume", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true + }, + "description": "The Volume Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "SpeedResolution": { + "description": "Represents the speed entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Speed", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knot", + "FootPerSecond", + "FootPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true + }, + "description": "The speed Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "AreaResolution": { + "description": "Represents the area entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Area", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true + }, + "description": "The area Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "LengthResolution": { + "description": "Represents the length entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Length", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Pt" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true + }, + "description": "The length Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "InformationResolution": { + "description": "Represents the information (data) entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Information", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true + }, + "description": "The information (data) Unit of measurement." + } + }, + "required": [ + "unit" + ] + }, + "TemperatureResolution": { + "description": "Represents the temperature entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Temperature", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true + }, + "description": "The temperature Unit of measurement." + } + }, + "required": [ + "unit" + ] + }, + "WeightResolution": { + "description": "Represents the weight entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Weight", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true + }, + "description": "The weight Unit of measurement." + } + }, + "required": [ + "unit" + ] + }, + "CurrencyResolution": { + "description": "Represents the currency entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Currency", + "properties": { + "ISO4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." + }, + "value": { + "type": "number", + "format": "double", + "description": "The money amount captured in the extracted entity" + }, + "unit": { + "type": "string", + "description": "The unit of the amount captured in the extracted entity" + } + }, + "required": [ + "value", + "unit" + ] + }, + "BooleanResolution": { + "description": "A resolution for boolean expressions", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Boolean", + "properties": { + "value": { + "type": "boolean" + } + }, + "required": [ + "value" + ] + }, + "DateTimeResolution": { + "description": "A resolution for datetime entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "DateTime", + "properties": { + "timex": { + "$ref": "#/definitions/TimeExpression" + }, + "dateTimeSubKind": { + "type": "string", + "enum": [ + "Time", + "Date", + "DateTime", + "Duration", + "Set" + ], + "x-ms-enum": { + "name": "DateTimeSubKind", + "modelAsString": true + }, + "description": "The DateTime SubKind" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier" + } + }, + "required": [ + "timex", + "dateTimeSubKind", + "value" + ] + }, + "NumberResolution": { + "description": "A resolution for numeric entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Number", + "properties": { + "numberKind": { + "type": "string", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true + }, + "description": "The type of the extracted number entity." + }, + "value": { + "type": "string", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ] + }, + "OrdinalResolution": { + "description": "A resolution for ordinal numbers entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "Ordinal", + "properties": { + "offset": { + "type": "string", + "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" + }, + "relativeTo": { + "type": "string", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true + }, + "description": "The reference point that the ordinal number denotes." + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ] + }, + "TemporalSpanResolution": { + "description": "represents the resolution of a date and/or time span.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "TemporalSpan", + "properties": { + "begin": { + "$ref": "#/definitions/TimeExpression" + }, + "end": { + "$ref": "#/definitions/TimeExpression" + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier" + } + } + }, + "NumericRangeResolution": { + "description": "represents the resolution of numeric intervals.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "NumericRange", + "properties": { + "rangeKind": { + "type": "string", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true + }, + "description": "The kind of range that the resolution object represents." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ] + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true + } + }, + "TimeExpression": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "LuisTargetIntentResult": { + "type": "object", + "description": "It is a wrap up of LUIS Generally Available response.", + "x-ms-discriminator-value": "Luis", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "type": "object", + "description": "The actual response from a LUIS Generally Available application." + } + } + }, + "QuestionAnsweringTargetIntentResult": { + "type": "object", + "description": "It is a wrap up a Question Answering KB response.", + "x-ms-discriminator-value": "QuestionAnswering", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "description": "The generated answer by a Question Answering KB.", + "$ref": "common.json#/definitions/AnswersResult" + } + } + }, + "Modality": { + "type": "string", + "description": "Enumeration of supported conversational modalities.", + "enum": [ + "transcript", + "text" + ], + "x-ms-enum": { + "name": "InputModality", + "modelAsString": true + } + } + }, + "parameters": { + "ConversationAnalysisOptions": { + "name": "ConversationAnalysisOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationAnalysisOptions" + }, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json new file mode 100644 index 000000000000..10558a147039 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json @@ -0,0 +1,2972 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Text Authoring", + "version": "2022-05-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://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview." + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/authoring/analyze-text/projects": { + "get": { + "description": "Lists the existing projects.", + "operationId": "TextAnalysisAuthoring_ListProjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of projects.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}": { + "patch": { + "description": "Creates a new project or updates an existing one.", + "operationId": "TextAnalysisAuthoring_CreateProject", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" + } + } + }, + "get": { + "description": "Gets the details of a project.", + "operationId": "TextAnalysisAuthoring_GetProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the project.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" + } + } + }, + "delete": { + "description": "Deletes a project.", + "operationId": "TextAnalysisAuthoring_DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:export": { + "post": { + "description": "Triggers a job to export a project's data.", + "operationId": "TextAnalysisAuthoring_Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "in": "query", + "name": "assetKind", + "description": "Kind of asset to export.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:import": { + "post": { + "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", + "operationId": "TextAnalysisAuthoring_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:train": { + "post": { + "description": "Triggers a training job for a project.", + "operationId": "TextAnalysisAuthoring_Train", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments": { + "get": { + "description": "Lists the deployments belonging to a project.", + "operationId": "TextAnalysisAuthoring_ListDeployments", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all deployments.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { + "post": { + "description": "Swaps two existing deployments with each other.", + "operationId": "TextAnalysisAuthoring_SwapDeployments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { + "get": { + "description": "Gets the details of a deployment.", + "operationId": "TextAnalysisAuthoring_GetDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Deployment info.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" + } + } + }, + "put": { + "description": "Creates a new deployment or replaces an existing one.", + "operationId": "TextAnalysisAuthoring_DeployProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes a project deployment.", + "operationId": "TextAnalysisAuthoring_DeleteDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing deployment job.", + "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing swap deployment job.", + "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The swap deployment job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "operationId": "TextAnalysisAuthoring_GetExportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "description": "Gets the status for an import.", + "operationId": "TextAnalysisAuthoring_GetImportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models": { + "get": { + "description": "Lists the trained models belonging to a project.", + "operationId": "TextAnalysisAuthoring_ListTrainedModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all trained models.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { + "get": { + "description": "Gets the details of a trained model.", + "operationId": "TextAnalysisAuthoring_GetTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trained model info", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" + } + } + }, + "delete": { + "description": "Deletes an existing trained model.", + "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Deleted successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "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.", + "operationId": "TextAnalysisAuthoring_GetModelEvaluationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the evaluation results.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "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.", + "operationId": "TextAnalysisAuthoring_GetModelEvaluationSummary", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all evaluation results.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/train/jobs": { + "get": { + "description": "Lists the non-expired training jobs created for a project.", + "operationId": "TextAnalysisAuthoring_ListTrainingJobs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the training jobs.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobs" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { + "get": { + "description": "Gets the status for a training job.", + "operationId": "TextAnalysisAuthoring_GetTrainingStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The training job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "description": "Triggers a cancellation for a running training job.", + "operationId": "TextAnalysisAuthoring_CancelTrainingJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the job cancellation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { + "get": { + "description": "Gets the status for a project deletion job.", + "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The project deletion job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/global/languages": { + "get": { + "description": "Lists the supported languages.", + "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported languages.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguages" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Supported Languages": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/global/training-config-versions": { + "get": { + "description": "Lists the support training config version for a given project type.", + "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all trained models.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + } + }, + "definitions": { + "TextAnalysisAuthoringConfusionMatrix": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" + }, + "x-ms-client-name": "ConfusionMatrix" + }, + "TextAnalysisAuthoringConfusionMatrixCell": { + "description": "Represents a cell in a confusion matrix.", + "required": [ + "normalizedValue", + "rawValue" + ], + "type": "object", + "properties": { + "normalizedValue": { + "format": "float", + "description": "Represents normalized value in percentages.", + "type": "number" + }, + "rawValue": { + "format": "float", + "description": "Represents raw value.", + "type": "number" + } + }, + "x-ms-client-name": "ConfusionMatrixCell" + }, + "TextAnalysisAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" + }, + "x-ms-client-name": "ConfusionMatrixRow" + }, + "TextAnalysisAuthoringCreateDeploymentOptions": { + "description": "Represents the options for creating or updating a project deployment.", + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "Represents the trained model label.", + "type": "string" + } + }, + "x-ms-client-name": "CreateDeploymentOptions" + }, + "TextAnalysisAuthoringCreateProjectOptions": { + "description": "Represents the options used to create or update a project.", + "required": [ + "projectKind", + "storageInputContainerName", + "projectName", + "language" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "The project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "storageInputContainerName": { + "description": "The storage container name.", + "type": "string" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + } + }, + "x-ms-client-name": "CreateProjectOptions" + }, + "TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom entity recognition project.", + "required": [ + "customEntityRecognitionResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customEntityRecognitionResult": { + "description": "Represents the evaluation prediction for entity recognition.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomEntityRecognition", + "x-ms-client-name": "CustomEntityRecognitionDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom entity recognition project.", + "required": [ + "customEntityRecognitionEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customEntityRecognitionEvaluation": { + "description": "Contains the data related to extraction evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomEntityRecognition", + "x-ms-client-name": "CustomEntityRecognitionEvaluationSummary" + }, + "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom multi-label classification project.", + "required": [ + "customMultiLabelClassificationResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customMultiLabelClassificationResult": { + "description": "Represents the evaluation prediction for multi label classification.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomMultiLabelClassification", + "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom multi-label classification project.", + "required": [ + "customMultiLabelClassificationEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customMultiLabelClassificationEvaluation": { + "description": "Contains the data related to multi label classification evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomMultiLabelClassification", + "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom single-label classification project.", + "required": [ + "customSingleLabelClassificationResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customSingleLabelClassificationResult": { + "description": "Represents the evaluation prediction for single label classification.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomSingleLabelClassification", + "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom single-label classification project.", + "required": [ + "customSingleLabelClassificationEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customSingleLabelClassificationEvaluation": { + "description": "Contains the data related to single label classification evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomSingleLabelClassification", + "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringDeploymentJobState": { + "description": "Represents the state of a deployment job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "DeploymentJobState" + }, + "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { + "description": "Represents an evaluation result entity label.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "Represents the entity category.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Represents the entity offset index relative to the original text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Represents the entity length.", + "type": "integer" + } + }, + "x-ms-client-name": "DocumentEntityLabelEvaluationResult" + }, + "TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult": { + "description": "Represents the entity recognition evaluation result for a document.", + "required": [ + "entities" + ], + "type": "object", + "properties": { + "entities": { + "description": "Represents the document labelled entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" + } + } + }, + "x-ms-client-name": "DocumentEntityRecognitionEvaluationResult" + }, + "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { + "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", + "required": [ + "expectedEntities", + "predictedEntities", + "regionOffset", + "regionLength" + ], + "type": "object", + "properties": { + "expectedEntities": { + "description": "Represents the region's expected entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" + } + }, + "predictedEntities": { + "description": "Represents the region's predicted entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" + } + }, + "regionOffset": { + "format": "int32", + "description": "Represents the region offset.", + "type": "integer" + }, + "regionLength": { + "format": "int32", + "description": "Represents the region length.", + "type": "integer" + } + }, + "x-ms-client-name": "DocumentEntityRegionEvaluationResult" + }, + "TextAnalysisAuthoringDocumentEvaluationResult": { + "description": "Represents the evaluation result of a document.", + "required": [ + "location", + "language", + "projectKind" + ], + "type": "object", + "properties": { + "location": { + "description": "Represents the document path.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "DocumentEvaluationResult" + }, + "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { + "description": "Represents the comparison between the expected and predicted classes that are result from the evaluation operation.", + "required": [ + "expectedClasses", + "predictedClasses" + ], + "type": "object", + "properties": { + "expectedClasses": { + "description": "Represents the document's expected classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "predictedClasses": { + "description": "Represents the document's predicted classes.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" + }, + "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { + "description": "Represents the comparison between the expected and predicted class that result from an evaluation operation.", + "required": [ + "expectedClass", + "predictedClass" + ], + "type": "object", + "properties": { + "expectedClass": { + "description": "Represents the document's expected class.", + "type": "string" + }, + "predictedClass": { + "description": "Represents the document's predicted class.", + "type": "string" + } + }, + "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" + }, + "TextAnalysisAuthoringEntityEvaluationSummary": { + "description": "Represents the evaluation summary for an entity.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "EntityEvaluationSummary" + }, + "TextAnalysisAuthoringEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom entity recognition project.", + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "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.", + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" + }, + "entities": { + "description": "Represents the entities evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall", + "type": "number" + } + }, + "x-ms-client-name": "EntityRecognitionEvaluationSummary" + }, + "TextAnalysisAuthoringEvaluationKind": { + "enum": [ + "percentage", + "manual" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + }, + "x-ms-client-name": "EvaluationKind" + }, + "TextAnalysisAuthoringEvaluationOptions": { + "description": "Represents the options used running the evaluation.", + "type": "object", + "properties": { + "kind": { + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationKind" + }, + "trainingSplitPercentage": { + "format": "int32", + "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + }, + "testingSplitPercentage": { + "format": "int32", + "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + } + }, + "x-ms-client-name": "EvaluationOptions" + }, + "TextAnalysisAuthoringEvaluationResults": { + "description": "Represents a list of results for an evaluation operation.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "THe list of documents evaluation results.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EvaluationResults" + }, + "TextAnalysisAuthoringEvaluationSummary": { + "description": "Represents the summary for an evaluation operation.", + "required": [ + "projectKind", + "evaluationOptions" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project type that the evaluation ran on.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "evaluationOptions": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "EvaluationSummary" + }, + "TextAnalysisAuthoringExportedClass": { + "description": "Represents a class of an exported project.", + "type": "object", + "properties": { + "category": { + "description": "The class category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedClass" + }, + "TextAnalysisAuthoringExportedCustomEntityRecognitionDocument": { + "description": "Represents an exported document for a custom entity recognition project.", + "type": "object", + "properties": { + "entities": { + "description": "The list of entity labels belonging to the document.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentRegion" + } + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomEntityRecognitionDocument" + }, + "TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets": { + "description": "Represents the exported assets for a entity recognition project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "entities": { + "description": "The list of entities belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" + } + }, + "documents": { + "description": "The list of documents belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument" + } + } + }, + "x-ms-discriminator-value": "CustomEntityRecognition", + "x-ms-client-name": "ExportedCustomEntityRecognitionProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { + "description": "Represents an exported document of a custom multi-label classification project.", + "type": "object", + "properties": { + "classes": { + "description": "The document classes.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" + } + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" + }, + "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { + "description": "Represents the exported assets for a custom multi-label classification project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "classes": { + "description": "The list of classes in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" + } + }, + "documents": { + "description": "The list of documents in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" + } + } + }, + "x-ms-discriminator-value": "CustomMultiLabelClassification", + "x-ms-client-name": "ExportedCustomMultiLabelClassificationProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { + "description": "Represents an exported document for a custom single-label classification project.", + "type": "object", + "properties": { + "class": { + "description": "The class of the documents.", + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" + }, + "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { + "description": "Represents the exported assets for a single-label classification project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "classes": { + "description": "The list of classes belonging to this project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" + } + }, + "documents": { + "description": "The list of documents belonging to this project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" + } + } + }, + "x-ms-discriminator-value": "CustomSingleLabelClassification", + "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" + }, + "TextAnalysisAuthoringExportedDocumentClass": { + "description": "Represents a classification label for a document.", + "type": "object", + "properties": { + "category": { + "type": "string" + } + }, + "x-ms-client-name": "ExportedDocumentClass" + }, + "TextAnalysisAuthoringExportedDocumentEntityLabel": { + "description": "Represents an entity label for a document.", + "type": "object", + "properties": { + "category": { + "description": "The entity category.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Start position for the entity text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Length for the entity text.", + "type": "integer" + } + }, + "x-ms-client-name": "ExportedDocumentEntityLabel" + }, + "TextAnalysisAuthoringExportedDocumentRegion": { + "description": "Represents a region in a document for entity labeling.", + "type": "object", + "properties": { + "regionOffset": { + "format": "int32", + "description": "Start position for the region.", + "type": "integer" + }, + "regionLength": { + "format": "int32", + "description": "Length for the region text.", + "type": "integer" + }, + "labels": { + "description": "The list of entity labels belonging to this region.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" + } + } + }, + "x-ms-client-name": "ExportedDocumentRegion" + }, + "TextAnalysisAuthoringExportedEntity": { + "description": "Represents an entity in an exported project.", + "type": "object", + "properties": { + "category": { + "description": "The entity category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedEntity" + }, + "TextAnalysisAuthoringExportedProject": { + "description": "Represents an exported project.", + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "projectFileVersion": { + "description": "The version of the exported file.", + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/TextAnalysisAuthoringStringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + }, + "x-ms-client-name": "ExportedProject" + }, + "TextAnalysisAuthoringExportedProjectAssets": { + "description": "Represents the assets of an exported project.", + "required": [ + "projectKind" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "The type of the project the assets belong to.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "ExportedProjectAssets" + }, + "TextAnalysisAuthoringExportProjectJobState": { + "description": "Represents the state of an export job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "properties": { + "resultUrl": { + "description": "The URL to use in order to download the exported project.", + "type": "string" + } + }, + "x-ms-client-name": "ExportProjectJobState" + }, + "TextAnalysisAuthoringImportProjectJobState": { + "description": "Represents the state of an import job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ImportProjectJobState" + }, + "TextAnalysisAuthoringJobState": { + "description": "Represents a job's state.", + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "The job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation date time of the job.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "The last date time the job was updated.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date time of the job.", + "type": "string" + }, + "status": { + "description": "The job status.", + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" + }, + "warnings": { + "description": "The warnings that were encountered while executing the job.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringWarning" + } + }, + "errors": { + "description": "The errors encountered while executing the job.", + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + }, + "x-ms-client-name": "JobState" + }, + "TextAnalysisAuthoringJobStatus": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + }, + "x-ms-client-name": "JobStatus" + }, + "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { + "description": "Represents the evaluation summary of a class in a multi-label classification project.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "MultiLabelClassEvaluationSummary" + }, + "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a multi-label classification project.", + "required": [ + "classes", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "classes": { + "description": "Represents the classes evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall", + "type": "number" + } + }, + "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringProjectDeletionJobState": { + "description": "Represents the state of a project deletion job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ProjectDeletionJobState" + }, + "TextAnalysisAuthoringProjectDeployment": { + "description": "Represents a project deployment.", + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "deploymentName": { + "description": "Represents deployment name.", + "type": "string" + }, + "modelId": { + "description": "Represents deployment modelId.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents deployment last trained time.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents deployment last deployed time.", + "type": "string" + }, + "deploymentExpirationDate": { + "format": "date", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents model training config version.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectDeployment" + }, + "TextAnalysisAuthoringProjectDeployments": { + "description": "Represents a list of retrieved deployments.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectDeployments" + }, + "TextAnalysisAuthoringProjectKind": { + "enum": [ + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "CustomEntityRecognition" + ], + "type": "string", + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "CustomSingleLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." + }, + { + "value": "CustomMultiLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." + }, + { + "value": "CustomEntityRecognition", + "description": "For building an extraction model to identify your domain categories using your own data." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + "TextAnalysisAuthoringProjectMetadata": { + "description": "Represents the metadata of a project.", + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "storageInputContainerName", + "projectName", + "language" + ], + "type": "object", + "properties": { + "createdDateTime": { + "format": "date-time", + "description": "Represents the project creation datetime.", + "type": "string" + }, + "lastModifiedDateTime": { + "format": "date-time", + "description": "Represents the project last modification datetime.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents the project last training datetime.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents the project last deployment datetime.", + "type": "string" + }, + "projectKind": { + "description": "The project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "storageInputContainerName": { + "description": "The storage container name.", + "type": "string" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "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.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectMetadata" + }, + "TextAnalysisAuthoringProjectSettings": { + "description": "Represents the settings used to define the project behavior.", + "type": "object", + "x-ms-client-name": "ProjectSettings" + }, + "TextAnalysisAuthoringProjectsMetadata": { + "description": "Represents a list of retrieved projects' metadata.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of projects.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectsMetadata" + }, + "TextAnalysisAuthoringProjectTrainedModel": { + "description": "Represents a trained model.", + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "label": { + "description": "The trained model label.", + "type": "string" + }, + "modelId": { + "description": "The model ID.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "The last trained date time of the model.", + "type": "string" + }, + "lastTrainingDurationInSeconds": { + "format": "int32", + "description": "The duration of the model's last training request in seconds.", + "type": "integer" + }, + "modelExpirationDate": { + "format": "date", + "description": "The model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "The model training config version.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectTrainedModel" + }, + "TextAnalysisAuthoringProjectTrainedModels": { + "description": "Represents a list of retrieved trained models.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectTrainedModels" + }, + "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { + "description": "Represents the evaluation summary for a class in a single-label classification project.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "SingleLabelClassEvaluationSummary" + }, + "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom single-label classification project.", + "required": [ + "confusionMatrix", + "classes", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two classes (the two classes can be the same). The matrix is between the class that was labelled and the class that was predicted.", + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" + }, + "classes": { + "description": "Represents the classes evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall", + "type": "number" + } + }, + "x-ms-client-name": "SingleLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringStringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "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." + } + ] + }, + "x-ms-client-name": "StringIndexType" + }, + "TextAnalysisAuthoringSubTrainingJobState": { + "description": "Represents the detailed state of a training sub-operation.", + "required": [ + "percentComplete", + "status" + ], + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Represents progress percentage.", + "type": "integer" + }, + "startDateTime": { + "format": "date-time", + "description": "Represents the start date time.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Represents the end date time.", + "type": "string" + }, + "status": { + "description": "Represents the status of the sub-operation.", + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" + } + }, + "x-ms-client-name": "SubTrainingJobState" + }, + "TextAnalysisAuthoringSupportedLanguage": { + "description": "Represents a supported language.", + "required": [ + "languageName", + "languageCode" + ], + "type": "object", + "properties": { + "languageName": { + "description": "The language name.", + "type": "string" + }, + "languageCode": { + "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.", + "type": "string" + } + }, + "x-ms-client-name": "SupportedLanguage" + }, + "TextAnalysisAuthoringSupportedLanguages": { + "description": "Represents a list of retrieved languages.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the languages.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "SupportedLanguages" + }, + "TextAnalysisAuthoringSwapDeploymentsOptions": { + "description": "Represents the options for swapping two deployments together.", + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ], + "type": "object", + "properties": { + "firstDeploymentName": { + "description": "Represents the first deployment name.", + "type": "string" + }, + "secondDeploymentName": { + "description": "Represents the second deployment name.", + "type": "string" + } + }, + "x-ms-client-name": "SwapDeploymentsOptions" + }, + "TextAnalysisAuthoringTrainingConfigVersion": { + "description": "Represents a training config version.", + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ], + "type": "object", + "properties": { + "trainingConfigVersion": { + "description": "Represents the version of the config.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date", + "description": "Represents the training config version expiration date.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingConfigVersion" + }, + "TextAnalysisAuthoringTrainingConfigVersions": { + "description": "Represents a list of training config versions.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the training config versions.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingConfigVersions" + }, + "TextAnalysisAuthoringTrainingJobOptions": { + "description": "Represents the options for starting a new training job.", + "required": [ + "modelLabel", + "trainingConfigVersion" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents the output model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "evaluationOptions": { + "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" + } + }, + "x-ms-client-name": "TrainingJobOptions" + }, + "TextAnalysisAuthoringTrainingJobResult": { + "description": "Represents the output of a training job.", + "required": [ + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents trained model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "trainingStatus": { + "description": "Represents model train status.", + "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" + }, + "evaluationStatus": { + "description": "Represents model evaluation status.", + "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" + }, + "estimatedEndDateTime": { + "format": "date-time", + "description": "Represents the estimate end date time for training and evaluation.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingJobResult" + }, + "TextAnalysisAuthoringTrainingJobs": { + "description": "Represents a list of retrieved training jobs.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingJobs" + }, + "TextAnalysisAuthoringTrainingJobState": { + "description": "Represents the state of a training job.", + "required": [ + "result" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "properties": { + "result": { + "description": "Represents training tasks detailed result.", + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" + } + }, + "x-ms-client-name": "TrainingJobState" + }, + "TextAnalysisAuthoringWarning": { + "description": "Represents a warning that was encountered while executing the request.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The warning code.", + "type": "string" + }, + "message": { + "description": "The warning message.", + "type": "string" + } + }, + "x-ms-client-name": "Warning" + } + }, + "parameters": { + "TextAnalysisAuthoringStringIndexTypeQueryParameter": { + "in": "query", + "name": "stringIndexType", + "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" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "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." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextAnalysisAuthoringJobIdPathParameter": { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TextAnalysisAuthoringTrainedModelLabelPathParameter": { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model label.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TextAnalysisAuthoringProjectKindQueryParameter": { + "in": "query", + "name": "projectKind", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "CustomEntityRecognition" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "CustomSingleLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." + }, + { + "value": "CustomMultiLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." + }, + { + "value": "CustomEntityRecognition", + "description": "For building an extraction model to identify your domain categories using your own data." + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/common.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/common.json new file mode 100644 index 000000000000..2d83fd32e604 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/common.json @@ -0,0 +1,596 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service", + "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://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", + "version": "2022-05-01" + }, + "paths": {}, + "definitions": { + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "additionalProperties": false, + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/Error" + } + }, + "required": [ + "error" + ] + }, + "Error": { + "type": "object", + "description": "The error object.", + "additionalProperties": true, + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/ErrorCode" + }, + "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/Error" + } + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/InnerErrorCode" + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Error details." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + }, + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ] + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true + }, + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ] + }, + "Language": { + "type": "string", + "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + }, + "StringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned 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." + } + ] + } + }, + "AnswersResult": { + "type": "object", + "description": "Represents List of Question Answers.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents Answer Result list.", + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswer" + } + } + } + }, + "KnowledgeBaseAnswer": { + "type": "object", + "description": "Represents knowledge base answer.", + "additionalProperties": false, + "properties": { + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer text." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidence", + "description": "Answer confidence score, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "id": { + "type": "integer", + "x-ms-client-name": "qnaId", + "description": "ID of the QnA result.", + "format": "int32" + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "type": "object", + "$ref": "#/definitions/KnowledgeBaseAnswerDialog" + }, + "answerSpan": { + "type": "object", + "x-ms-client-name": "shortAnswer", + "description": "Answer span object of QnA with respect to user's question.", + "$ref": "#/definitions/AnswerSpan" + } + } + }, + "KnowledgeBaseAnswerDialog": { + "type": "object", + "description": "Dialog associated with Answer.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" + } + } + } + }, + "KnowledgeBaseAnswerPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt - used in ordering of the prompts.", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "QnA ID corresponding to the prompt.", + "format": "int32" + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "AnswerSpan": { + "type": "object", + "description": "Answer span object of QnA.", + "additionalProperties": false, + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "confidenceScore": { + "type": "number", + "x-ms-client-name": "confidence", + "description": "Predicted score of answer span, value ranges from 0 to 1.", + "format": "double", + "maximum": 1, + "minimum": 0 + }, + "offset": { + "type": "integer", + "description": "The answer span offset from the start of answer.", + "format": "int32" + }, + "length": { + "type": "integer", + "description": "The length of the answer span.", + "format": "int32" + } + } + }, + "AnswersOptions": { + "type": "object", + "description": "Parameters to query a knowledge base.", + "additionalProperties": false, + "properties": { + "qnaId": { + "type": "integer", + "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", + "format": "int32" + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "description": "Max number of answers to be returned for the question.", + "format": "int32" + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score for answers, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "context": { + "x-ms-client-name": "answerContext", + "description": "Context object with previous QnA's information.", + "$ref": "#/definitions/KnowledgeBaseAnswerContext" + }, + "rankerType": { + "type": "string", + "x-ms-client-name": "rankerKind", + "description": "Type of ranker to be used.", + "x-ms-enum": { + "name": "RankerKind", + "modelAsString": true, + "values": [ + { + "value": "QuestionOnly", + "description": "Question only ranker." + }, + { + "value": "Default", + "description": "Default ranker." + } + ] + }, + "enum": [ + "Default", + "QuestionOnly" + ] + }, + "filters": { + "description": "Filter QnAs based on given metadata list and knowledge base sources.", + "$ref": "#/definitions/QueryFilters" + }, + "answerSpanRequest": { + "x-ms-client-name": "shortAnswerOptions", + "description": "To configure Answer span prediction feature.", + "$ref": "#/definitions/ShortAnswerOptions" + }, + "includeUnstructuredSources": { + "type": "boolean", + "description": "(Optional) Flag to enable Query over Unstructured Sources." + } + } + }, + "KnowledgeBaseAnswerContext": { + "type": "object", + "description": "Context object with previous QnA's information.", + "additionalProperties": false, + "required": [ + "previousQnaId" + ], + "properties": { + "previousQnaId": { + "type": "integer", + "description": "Previous turn top answer result QnA ID.", + "format": "int32" + }, + "previousUserQuery": { + "type": "string", + "x-ms-client-name": "previousQuestion", + "description": "Previous user query." + } + } + }, + "QueryFilters": { + "type": "object", + "description": "filters over knowledge base.", + "additionalProperties": false, + "properties": { + "metadataFilter": { + "type": "object", + "$ref": "#/definitions/MetadataFilter" + }, + "sourceFilter": { + "type": "object", + "$ref": "#/definitions/SourceFilter" + }, + "logicalOperation": { + "type": "string", + "description": "Logical operation used to join metadata filter with source filter.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataFilter": { + "type": "object", + "description": "Find QnAs that are associated with the given list of metadata.", + "additionalProperties": false, + "properties": { + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataRecord" + } + }, + "logicalOperation": { + "type": "string", + "description": "Operation used to join metadata filters.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataRecord": { + "type": "object", + "description": "Object to provide the key value pair for each metadata.", + "additionalProperties": false, + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Metadata Key from Metadata dictionary used in the QnA." + }, + "value": { + "type": "string", + "description": "Metadata Value from Metadata dictionary used in the QnA." + } + } + }, + "SourceFilter": { + "type": "array", + "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", + "items": { + "type": "string" + } + }, + "LogicalOperationKind": { + "type": "string", + "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true + }, + "enum": [ + "AND", + "OR" + ] + }, + "ShortAnswerOptions": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "additionalProperties": false, + "required": [ + "enable" + ], + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or disable Answer Span prediction.", + "enum": [ + true + ], + "x-ms-enum": { + "name": "enable", + "modelAsString": false + } + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "topAnswersWithSpan": { + "type": "integer", + "x-ms-client-name": "top", + "description": "Number of Top answers to be considered for span prediction from 1 to 10.", + "format": "int32", + "maximum": 10, + "minimum": 1 + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "ProjectNameQueryParameter": { + "name": "projectName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the project to use.", + "x-ms-parameter-location": "method" + }, + "ProjectNamePathParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 100, + "description": "The name of the project to use.", + "x-ms-parameter-location": "method" + }, + "DeploymentNameQueryParameter": { + "name": "deploymentName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the specific deployment of the project to use.", + "x-ms-parameter-location": "method" + }, + "DeploymentNamePathParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the specific deployment of the project to use.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "TopParameter": { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "MaxPageSizeParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsCancelRequest.json new file mode 100644 index 000000000000..305dc1c4a152 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsCancelRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json new file mode 100644 index 000000000000..666554f36257 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "EntityRecognitionLROResults", + "taskName": "Recognize Entities", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip" + }, + { + "category": "Location", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "subcategory": "GPE", + "text": "Seattle" + }, + { + "category": "DateTime", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "subcategory": "DateRange", + "text": "last week" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "subcategory": "GPE", + "text": "NYC" + }, + { + "category": "DateTime", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "subcategory": "Date", + "text": "tomorrow" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + }, + { + "kind": "CustomEntityRecognitionLROResults", + "taskName": "Recognize US Regions", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.85, + "length": 17, + "offset": 45, + "text": "Pacific Northwest" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.88, + "length": 10, + "offset": 63, + "text": "East Coast" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json new file mode 100644 index 000000000000..abe71f94bb2b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": [ + { + "kind": "EntityRecognition", + "taskName": "Recognize Entities", + "parameters": { + "modelVersion": "latest" + } + }, + { + "kind": "CustomEntityRecognition", + "taskName": "Recognize US Regions", + "parameters": { + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..d5df598b293d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityLinking", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityLinkingResults", + "results": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulEntityRecognitionRequest.json new file mode 100644 index 000000000000..9c147e0235f4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulEntityRecognitionRequest.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Organization", + "confidenceScore": 0.84, + "length": 9, + "offset": 0, + "text": "Microsoft" + }, + { + "category": "Person", + "confidenceScore": 0.85, + "length": 10, + "offset": 25, + "text": "Bill Gates" + }, + { + "category": "Person", + "confidenceScore": 0.9, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "confidenceScore": 0.55, + "length": 7, + "offset": 33, + "subcategory": "GPE", + "text": "Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulKeyPhraseExtractionRequest.json new file mode 100644 index 000000000000..51f349ea396a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulKeyPhraseExtractionRequest.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "body": { + "kind": "KeyPhraseExtraction", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "KeyPhraseExtractionResults", + "results": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulLanguageDetectionRequest.json new file mode 100644 index 000000000000..530d4add09e1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulLanguageDetectionRequest.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "body": { + "kind": "LanguageDetection", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "LanguageDetectionResults", + "results": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish" + }, + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulPiiEntityRecognitionRequest.json new file mode 100644 index 000000000000..e6c01e0a4940 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulPiiEntityRecognitionRequest.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "U.S. Social Security Number (SSN)", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987" + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABA Routing Number", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025" + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "Brazil CPF Number", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68" + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2019-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulSentimentAnalysisRequest.json new file mode 100644 index 000000000000..9c0df829cdc9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/SuccessfulSentimentAnalysisRequest.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "Endpoint": "{Endpoint}", + "body": { + "kind": "SentimentAnalysis", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "SentimentAnalysisResults", + "results": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..c67a9b319923 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..f80e7b03be2f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2022-05-01", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..f4b4f40dd3bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..78ff85284bc7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..1ee6f36f07f4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..b18e321a085c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "model1" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..e37a38e4a655 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..df32acf3b9a0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..13896261ae32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..9da036422508 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-01", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..17de29ce5a87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..b7a5996b24a1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..d35cca16e65d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "text": "send the email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [], + "predictedEntities": [] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send a mail to daniel", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 15, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i forgot to add an important part to that email to james . please set it up to edit", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ], + "predictedEntities": [ + { + "category": "Category", + "offset": 19, + "length": 9 + }, + { + "category": "ContactName", + "offset": 51, + "length": 5 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send email to a and tian", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 14, + "length": 1 + }, + { + "category": "ContactName", + "offset": 20, + "length": 4 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send thomas an email", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 5, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add more to the email message i am sending to vincent", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 56, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to lily roth and abc123@microsoft.com", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 9 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "i need to add something else to my email to cheryl", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 44, + "length": 6 + } + ] + }, + "intentsResult": { + "expectedIntent": "AddMore", + "predictedIntent": "AddMore" + } + }, + { + "text": "send an email to larry , joseph and billy larkson", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 17, + "length": 5 + }, + { + "category": "ContactName", + "offset": 25, + "length": 6 + }, + { + "category": "ContactName", + "offset": 36, + "length": 13 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + }, + { + "text": "send mail to dorothy", + "language": "en-us", + "entitiesResult": { + "expectedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ], + "predictedEntities": [ + { + "category": "ContactName", + "offset": 13, + "length": 7 + } + ] + }, + "intentsResult": { + "expectedIntent": "SendEmail", + "predictedIntent": "SendEmail" + } + } + ], + "nextLink": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/evaluation/result/?api-version=2022-05-01&top=2147483637&skip=10&maxpagesize=10" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..bccb012b07d4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,526 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..cc641b9973af --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..ebbe34f6cae4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..25b4413a8cdb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,402 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "English (UK)", + "languageCode": "en-gb" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Zulu", + "languageCode": "zu" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Bengali", + "languageCode": "bn" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian (Farsi)", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Oriya", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..84b3877acd38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Media.Artist", + "description": "Artist name", + "examples": "Phil Collins" + }, + { + "category": "Media.Title", + "description": "Drama name, Song title", + "examples": "Hey Jude" + }, + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "Geography.Location", + "description": "Parent of all location subtypes", + "examples": "Tokyo, Asia, Taj Mahal" + }, + { + "category": "Geography.Location.POI", + "description": "Place of interest", + "examples": "National park, Eifel tower" + }, + { + "category": "Geography.Location.City", + "description": "City names", + "examples": "Cairo, London" + }, + { + "category": "Geography.Location.State", + "description": "US State names", + "examples": "Texas, California" + }, + { + "category": "Geography.Location.Continent", + "description": "Continent names", + "examples": "Asia, Europe" + }, + { + "category": "Geography.Location.CountryRegion", + "description": "Country names", + "examples": "Japan, France" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Geography.Address", + "description": "Full US addresses", + "examples": "123 main street, TX 75080" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..4a263938cad0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..b53a88ffab6d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..f3c67aea14f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..a2f90000500f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read" + }, + { + "category": "Delete" + } + ], + "entities": [ + { + "category": "Sender" + } + ], + "utterances": [ + { + "text": "Open Blake's email", + "dataset": "Train", + "intent": "Read", + "entities": [ + { + "category": "Sender", + "offset": 5, + "length": 5 + } + ] + }, + { + "text": "Delete last email", + "language": "en-gb", + "dataset": "Test", + "intent": "Delete", + "entities": [] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..cc60b9e2751a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListModels.json new file mode 100644 index 000000000000..8eece09f0cc2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListModels.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..1dcd3b351abb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T14:03:16Z", + "lastModifiedDateTime": "2022-04-18T14:03:16Z", + "projectKind": "Conversation", + "projectName": "myproject1", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..fdd2ab3ef83b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..badff28b42f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..92443c1032e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..280f5a5af80e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..70343dd71b69 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCreateProject.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "body": { + "projectName": "LoanAgreements", + "language": "en", + "projectKind": "CustomEntityRecognition", + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "multilingual": false, + "storageInputContainerName": "loanagreements" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..c3fef5a64f11 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "deploymentName": "staging" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/staging/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..c3540d43939f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteModel.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..448dc97831b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteProject.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..67a86c333977 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeployProject.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "deploymentName": "production", + "body": { + "trainedModelLabel": "model1" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..c67c21112611 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulExportProject.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "stringIndexType": "Utf16CodeUnit" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..cc84bd54c875 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeployment.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "deploymentName": "staging" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..1659f46939bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..3d7c476f6964 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetExportStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "resultUrl": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/export/jobs/c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000/result?api-version=2022-05-01", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..5bfc685d2a6f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetImportStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..ba8c002721bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModel.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..c51493f48b84 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "trainedModelLabel": "model2", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "location": "11.txt", + "language": "en-us", + "projectKind": "CustomEntityRecognition", + "customEntityRecognitionResult": { + "entities": [ + { + "expectedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 181, + "length": 34 + }, + { + "category": "BorrowerCity", + "offset": 225, + "length": 6 + }, + { + "category": "BorrowerState", + "offset": 242, + "length": 8 + }, + { + "category": "LenderName", + "offset": 271, + "length": 12 + }, + { + "category": "LenderAddress", + "offset": 310, + "length": 20 + }, + { + "category": "LenderCity", + "offset": 340, + "length": 8 + }, + { + "category": "LenderState", + "offset": 359, + "length": 11 + }, + { + "category": "LoanAmountWords", + "offset": 448, + "length": 52 + }, + { + "category": "LoanAmountNumbers", + "offset": 502, + "length": 10 + }, + { + "category": "Interest", + "offset": 588, + "length": 2 + } + ], + "predictedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 200, + "length": 15 + }, + { + "category": "BorrowerCity", + "offset": 225, + "length": 6 + }, + { + "category": "BorrowerState", + "offset": 242, + "length": 8 + }, + { + "category": "LenderName", + "offset": 271, + "length": 12 + }, + { + "category": "LenderAddress", + "offset": 310, + "length": 20 + }, + { + "category": "LenderCity", + "offset": 340, + "length": 8 + }, + { + "category": "LenderState", + "offset": 359, + "length": 11 + }, + { + "category": "LoanAmountWords", + "offset": 448, + "length": 52 + }, + { + "category": "LoanAmountNumbers", + "offset": 502, + "length": 10 + }, + { + "category": "Interest", + "offset": 588, + "length": 2 + } + ], + "regionOffset": 0, + "regionLength": 1780 + } + ] + } + }, + { + "location": "01.txt", + "language": "en-us", + "projectKind": "CustomEntityRecognition", + "customEntityRecognitionResult": { + "entities": [ + { + "expectedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 200, + "length": 13 + }, + { + "category": "BorrowerCity", + "offset": 223, + "length": 9 + }, + { + "category": "BorrowerState", + "offset": 243, + "length": 8 + }, + { + "category": "LenderName", + "offset": 273, + "length": 14 + }, + { + "category": "LenderAddress", + "offset": 314, + "length": 15 + }, + { + "category": "LenderCity", + "offset": 339, + "length": 10 + }, + { + "category": "LenderState", + "offset": 360, + "length": 8 + }, + { + "category": "LoanAmountWords", + "offset": 446, + "length": 66 + }, + { + "category": "LoanAmountNumbers", + "offset": 514, + "length": 11 + }, + { + "category": "Interest", + "offset": 601, + "length": 2 + } + ], + "predictedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 200, + "length": 13 + }, + { + "category": "BorrowerCity", + "offset": 223, + "length": 9 + }, + { + "category": "BorrowerState", + "offset": 243, + "length": 8 + }, + { + "category": "LenderName", + "offset": 273, + "length": 14 + }, + { + "category": "LenderAddress", + "offset": 314, + "length": 15 + }, + { + "category": "LenderCity", + "offset": 339, + "length": 10 + }, + { + "category": "LenderState", + "offset": 360, + "length": 8 + }, + { + "category": "LoanAmountWords", + "offset": 446, + "length": 66 + }, + { + "category": "LoanAmountNumbers", + "offset": 514, + "length": 11 + }, + { + "category": "Interest", + "offset": 601, + "length": 2 + } + ], + "regionOffset": 0, + "regionLength": 1793 + } + ] + } + } + ], + "nextLink": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2022-05-01&top=2147483645&skip=2&maxpagesize=2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..e3ca0debf84e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,232 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "trainedModelLabel": "model2" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "CustomEntityRecognition", + "customEntityRecognitionEvaluation": { + "confusionMatrix": { + "BorrowerAddress": { + "BorrowerAddress": { + "normalizedValue": 86.206894, + "rawValue": 3.4482758 + }, + "$none": { + "normalizedValue": 13.793103, + "rawValue": 0.55172414 + } + }, + "BorrowerCity": { + "BorrowerCity": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "BorrowerName": { + "BorrowerName": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "BorrowerState": { + "BorrowerState": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Interest": { + "Interest": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderAddress": { + "LenderAddress": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderCity": { + "LenderCity": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderName": { + "LenderName": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderState": { + "LenderState": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LoanAmountNumbers": { + "LoanAmountNumbers": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LoanAmountWords": { + "LoanAmountWords": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.81485, + "rawValue": 51.90372 + }, + "BorrowerAddress": { + "normalizedValue": 0.18315019, + "rawValue": 0.0952381 + }, + "Interest": { + "normalizedValue": 0.002005294, + "rawValue": 0.0010427529 + } + } + }, + "entities": { + "Date": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "BorrowerName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "BorrowerAddress": { + "f1": 0.6666666865348816, + "precision": 0.6000000238418579, + "recall": 0.75, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "BorrowerCity": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "BorrowerState": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderAddress": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderCity": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderState": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LoanAmountWords": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LoanAmountNumbers": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Interest": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + } + }, + "microF1": 0.94845366, + "microPrecision": 0.93877554, + "microRecall": 0.9583333, + "macroF1": 0.9513889, + "macroPrecision": 0.9458334, + "macroRecall": 0.9583333 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..14544ccd2b95 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..ebbe34f6cae4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "129d3182-625d-496c-bcf9-43686e85160b_637858368000000000", + "createdDateTime": "2022-04-18T14:02:34Z", + "lastUpdatedDateTime": "2022-04-18T14:02:34Z", + "expirationDateTime": "2022-04-25T14:02:34Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..ee06f3f95309 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,393 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "languageName": "English", + "languageCode": "en" + }, + { + "languageName": "English", + "languageCode": "en-us" + }, + { + "languageName": "French", + "languageCode": "fr" + }, + { + "languageName": "Italian", + "languageCode": "it" + }, + { + "languageName": "Spanish", + "languageCode": "es" + }, + { + "languageName": "German", + "languageCode": "de" + }, + { + "languageName": "Portuguese (Brazil)", + "languageCode": "pt-br" + }, + { + "languageName": "Portuguese (Portugal)", + "languageCode": "pt-pt" + }, + { + "languageName": "Afrikaans", + "languageCode": "af" + }, + { + "languageName": "Amharic", + "languageCode": "am" + }, + { + "languageName": "Arabic", + "languageCode": "ar" + }, + { + "languageName": "Assamese", + "languageCode": "as" + }, + { + "languageName": "Azerbaijani", + "languageCode": "az" + }, + { + "languageName": "Belarusian", + "languageCode": "be" + }, + { + "languageName": "Bulgarian", + "languageCode": "bg" + }, + { + "languageName": "Bengali", + "languageCode": "bn" + }, + { + "languageName": "Breton", + "languageCode": "br" + }, + { + "languageName": "Bosnian", + "languageCode": "bs" + }, + { + "languageName": "Catalan", + "languageCode": "ca" + }, + { + "languageName": "Czech", + "languageCode": "cs" + }, + { + "languageName": "Welsh", + "languageCode": "cy" + }, + { + "languageName": "Danish", + "languageCode": "da" + }, + { + "languageName": "Greek", + "languageCode": "el" + }, + { + "languageName": "Esperanto", + "languageCode": "eo" + }, + { + "languageName": "Estonian", + "languageCode": "et" + }, + { + "languageName": "Basque", + "languageCode": "eu" + }, + { + "languageName": "Persian (Farsi)", + "languageCode": "fa" + }, + { + "languageName": "Finnish", + "languageCode": "fi" + }, + { + "languageName": "Western Frisian", + "languageCode": "fy" + }, + { + "languageName": "Irish", + "languageCode": "ga" + }, + { + "languageName": "Scottish Gaelic", + "languageCode": "gd" + }, + { + "languageName": "Galician", + "languageCode": "gl" + }, + { + "languageName": "Gujarati", + "languageCode": "gu" + }, + { + "languageName": "Hausa", + "languageCode": "ha" + }, + { + "languageName": "Hebrew", + "languageCode": "he" + }, + { + "languageName": "Hindi", + "languageCode": "hi" + }, + { + "languageName": "Croatian", + "languageCode": "hr" + }, + { + "languageName": "Hungarian", + "languageCode": "hu" + }, + { + "languageName": "Armenian", + "languageCode": "hy" + }, + { + "languageName": "Indonesian", + "languageCode": "id" + }, + { + "languageName": "Japanese", + "languageCode": "ja" + }, + { + "languageName": "Javanese", + "languageCode": "jv" + }, + { + "languageName": "Georgian", + "languageCode": "ka" + }, + { + "languageName": "Kazakh", + "languageCode": "kk" + }, + { + "languageName": "Khmer", + "languageCode": "km" + }, + { + "languageName": "Kannada", + "languageCode": "kn" + }, + { + "languageName": "Korean", + "languageCode": "ko" + }, + { + "languageName": "Kurdish (Kurmanji)", + "languageCode": "ku" + }, + { + "languageName": "Kyrgyz", + "languageCode": "ky" + }, + { + "languageName": "Latin", + "languageCode": "la" + }, + { + "languageName": "Lao", + "languageCode": "lo" + }, + { + "languageName": "Lithuanian", + "languageCode": "lt" + }, + { + "languageName": "Latvian", + "languageCode": "lv" + }, + { + "languageName": "Malagasy", + "languageCode": "mg" + }, + { + "languageName": "Macedonian", + "languageCode": "mk" + }, + { + "languageName": "Malayalam", + "languageCode": "ml" + }, + { + "languageName": "Mongolian", + "languageCode": "mn" + }, + { + "languageName": "Marathi", + "languageCode": "mr" + }, + { + "languageName": "Malay", + "languageCode": "ms" + }, + { + "languageName": "Burmese", + "languageCode": "my" + }, + { + "languageName": "Nepali", + "languageCode": "ne" + }, + { + "languageName": "Dutch", + "languageCode": "nl" + }, + { + "languageName": "Norwegian (Bokmal)", + "languageCode": "nb" + }, + { + "languageName": "Oriya", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..350c1c1a7361 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectKind": "CustomEntityRecognition" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..2b7c90f19a8f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..828d60a771b7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..85cf8fa34aa6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulImportProject.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "settings": {}, + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + }, + "assets": { + "projectKind": "CustomEntityRecognition", + "entities": [ + { + "category": "Date" + }, + { + "category": "LenderName" + }, + { + "category": "LenderAddress" + } + ], + "documents": [ + { + "location": "01.txt", + "language": "en-us", + "entities": [ + { + "regionOffset": 0, + "regionLength": 1793, + "labels": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "LenderName", + "offset": 273, + "length": 14 + }, + { + "category": "LenderAddress", + "offset": 314, + "length": 15 + } + ] + } + ] + }, + { + "location": "02.txt", + "language": "en-us", + "entities": [ + { + "regionOffset": 0, + "regionLength": 1804, + "labels": [ + { + "category": "Date", + "offset": 5, + "length": 10 + }, + { + "category": "LenderName", + "offset": 284, + "length": 10 + }, + { + "category": "LenderAddress", + "offset": 321, + "length": 20 + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..08d8108d94cf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListDeployments.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "deploymentName": "production", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T16:03:51Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "deploymentName": "staging", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49.4334381Z", + "lastDeployedDateTime": "2022-04-18T15:53:04Z", + "deploymentExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListModels.json new file mode 100644 index 000000000000..bf9a51084b1f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListModels.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "label": "model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2022-04-18T15:47:49Z", + "lastTrainingDurationInSeconds": 186, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..8374f85b7d8f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListProjects.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "CustomMultiLabelClassification", + "storageInputContainerName": "loanagreements", + "projectName": "MoviesSummary", + "multilingual": false, + "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..8657b9131ec8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..d2e8c6545950 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulSwapDeployments.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..d60ab6faae73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulTrainProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "body": { + "modelLabel": "model1", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversations.json new file mode 100644 index 000000000000..7aebc0f85d7c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversations.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "id": "1", + "participantId": "1", + "text": "play In the air tonight from Phil Collins" + } + }, + "parameters": { + "projectName": "{project-name}", + "deploymentName": "{deployment-name}", + "stringIndexType": "TextElement_V8" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "play In the air tonight from Phil Collins", + "prediction": { + "topIntent": "PlayMusic", + "projectKind": "Conversation", + "intents": [ + { + "category": "PlayMusic", + "confidenceScore": 1 + }, + { + "category": "SearchCreativeWork", + "confidenceScore": 0 + }, + { + "category": "AddToPlaylist", + "confidenceScore": 0 + } + ], + "entities": [ + { + "category": "Media.Artist", + "text": "Phil Collins", + "offset": 29, + "length": 12, + "confidenceScore": 1 + } + ] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json new file mode 100644 index 000000000000..896cb3a17afd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "participantId": "1", + "id": "1", + "modality": "text", + "language": "en-GB", + "text": "How do I integrate QnA Maker and LUIS?" + } + }, + "parameters": { + "projectName": "{project-name}", + "deploymentName": "{deployment-name}", + "verbose": true, + "isLoggingEnabled": false, + "stringIndexType": "TextElement_V8" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "trains from London", + "prediction": { + "topIntent": "Rail", + "projectKind": "Orchestration", + "intents": { + "Rail": { + "confidenceScore": 1, + "targetProjectKind": "Conversation", + "result": { + "query": "trains from London", + "prediction": { + "topIntent": "Timetable", + "projectKind": "Conversation", + "intents": [ + { + "category": "Timetable", + "confidenceScore": 0.99968535 + }, + { + "category": "Locomotive", + "confidenceScore": 0.000314623 + } + ], + "entities": [] + } + } + }, + "Tree": { + "confidenceScore": 0.2641529, + "targetProjectKind": "QuestionAnswering" + }, + "None": { + "confidenceScore": 0, + "targetProjectKind": "NonLinked" + } + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json new file mode 100644 index 000000000000..ce9308a12ac2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "text": "Ports and connectors", + "participantId": "1", + "id": "1" + } + }, + "parameters": { + "projectName": "prj1", + "deploymentName": "dep1", + "directTarget": "qnaProject", + "targetProjectParameters": { + "qnaProject": { + "targetProjectKind": "QuestionAnswering", + "callingOptions": { + "context": { + "previousUserQuery": "Meet Surface Pro 4", + "previousQnaId": 4 + }, + "top": 1, + "question": "App Service overview" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "App Service overview", + "prediction": { + "projectKind": "Orchestration", + "topIntent": "qnaTargetApp", + "intents": { + "qnaTargetApp": { + "targetProjectKind": "QuestionAnswering", + "confidenceScore": 1, + "result": { + "answers": [ + { + "questions": [ + "App Service overview" + ], + "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", + "confidenceScore": 0.7384000000000001, + "id": 1, + "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", + "metadata": {}, + "dialog": { + "isContextOnly": false, + "prompts": [] + } + } + ] + } + } + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics.json new file mode 100644 index 000000000000..d871c14f05ca --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics.json @@ -0,0 +1,2665 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service", + "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://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", + "version": "2022-05-01" + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/:analyze-text": { + "post": { + "summary": "Request text analysis over a collection of documents.", + "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", + "operationId": "AnalyzeText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "description": "Collection of documents to analyze and a single task to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeTextTask" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "A successful call result", + "schema": { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entity Linking Request": { + "$ref": "./examples/SuccessfulEntityLinkingRequest.json" + }, + "Successful Entity Recognition Request": { + "$ref": "./examples/SuccessfulEntityRecognitionRequest.json" + }, + "Successful Key Phrase Extraction Request": { + "$ref": "./examples/SuccessfulKeyPhraseExtractionRequest.json" + }, + "Successful PII Entity Recognition Request": { + "$ref": "./examples/SuccessfulPiiEntityRecognitionRequest.json" + }, + "Successful Language Detection Request": { + "$ref": "./examples/SuccessfulLanguageDetectionRequest.json" + }, + "Successful Sentiment Analysis Request": { + "$ref": "./examples/SuccessfulSentimentAnalysisRequest.json" + } + } + } + }, + "/analyze-text/jobs": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", + "operationId": "AnalyzeText_SubmitJob", + "summary": "Submit text analysis job", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Collection of documents to analyze and one or more tasks to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeTextJobsInput" + }, + "required": true + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Submit Analysis Job Request": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-text/jobs/{jobId}": { + "get": { + "produces": [ + "application/json" + ], + "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", + "operationId": "AnalyzeText_JobStatus", + "summary": "Get analysis status and results", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobId" + }, + { + "$ref": "#/parameters/ShowStats" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + } + ], + "responses": { + "200": { + "description": "Analysis job status and metadata.", + "schema": { + "$ref": "#/definitions/AnalyzeTextJobState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Text Analysis Job Status Request": { + "$ref": "./examples/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" + } + } + } + }, + "/analyze-text/jobs/{jobId}:cancel": { + "post": { + "produces": [ + "application/json" + ], + "description": "Cancel a long-running Text Analysis job.", + "operationId": "AnalyzeText_CancelJob", + "summary": "Cancel a long-running Text Analysis job", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobId" + } + ], + "responses": { + "202": { + "description": "Cancel Job request has been received.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Job Delete Request": { + "$ref": ".//examples//SuccessfulAnalyzeTextJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AnalyzeTextTaskKind": { + "type": "string", + "description": "Enumeration of supported Text Analysis tasks.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "LanguageDetection", + "EntityLinking" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskKind", + "modelAsString": true + } + }, + "AnalyzeTextLROTaskKind": { + "type": "string", + "description": "Enumeration of supported long-running Text Analysis tasks.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "EntityLinking", + "Healthcare", + "CustomEntityRecognition", + "CustomSingleLabelClassification", + "CustomMultiLabelClassification" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROTaskKind", + "modelAsString": true + } + }, + "AnalyzeTextTaskResultsKind": { + "type": "string", + "description": "Enumeration of supported Text Analysis task results.", + "enum": [ + "SentimentAnalysisResults", + "EntityRecognitionResults", + "PiiEntityRecognitionResults", + "KeyPhraseExtractionResults", + "LanguageDetectionResults", + "EntityLinkingResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskResultsKind", + "modelAsString": true + } + }, + "AnalyzeTextLROResultsKind": { + "type": "string", + "description": "Enumeration of supported Text Analysis long-running operation task results.", + "enum": [ + "SentimentAnalysisLROResults", + "EntityRecognitionLROResults", + "PiiEntityRecognitionLROResults", + "KeyPhraseExtractionLROResults", + "EntityLinkingLROResults", + "HealthcareLROResults", + "CustomEntityRecognitionLROResults", + "CustomSingleLabelClassificationLROResults", + "CustomMultiLabelClassificationLROResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROResultsKind", + "modelAsString": true + } + }, + "MultiLanguageAnalysisInput": { + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + } + }, + "LanguageDetectionAnalysisInput": { + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "AnalyzeTextTask": { + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskKind" + } + } + }, + "AnalyzeTextLROTask": { + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextLROTaskKind" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskIdentifier" + } + ] + }, + "AnalyzeTextTaskResult": { + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskResultsKind" + } + } + }, + "AnalyzeTextEntityLinkingInput": { + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "AnalyzeTextEntityRecognitionInput": { + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "AnalyzeTextKeyPhraseExtractionInput": { + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "AnalyzeTextPiiEntitiesRecognitionInput": { + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/PiiTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "AnalyzeTextLanguageDetectionInput": { + "properties": { + "analysisInput": { + "$ref": "#/definitions/LanguageDetectionAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/LanguageDetectionTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "LanguageDetection" + }, + "AnalyzeTextSentimentAnalysisInput": { + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "AnalyzeTextJobsInput": { + "properties": { + "displayName": { + "description": "Optional display name for the analysis job.", + "type": "string" + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "tasks": { + "description": "The set of tasks to execute on the input documents.", + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "TaskIdentifier": { + "type": "object", + "description": "Base task object.", + "properties": { + "taskName": { + "type": "string" + } + } + }, + "TaskParameters": { + "type": "object", + "description": "Base parameters object for a text analysis task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "default": false + } + } + }, + "PreBuiltTaskParameters": { + "type": "object", + "description": "Parameters object for a text analysis task using pre-built models.", + "properties": { + "modelVersion": { + "type": "string", + "default": "latest" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskParameters" + } + ] + }, + "PreBuiltResult": { + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + }, + "required": [ + "errors", + "modelVersion" + ] + }, + "CustomTaskParameters": { + "type": "object", + "description": "Parameters object for a text analysis task using custom models.", + "properties": { + "projectName": { + "type": "string" + }, + "deploymentName": { + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskParameters" + } + ], + "required": [ + "projectName", + "deploymentName" + ] + }, + "CustomResult": { + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "errors", + "projectName", + "deploymentName" + ] + }, + "CustomEntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Entities task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomTaskParameters" + } + ] + }, + "CustomEntitiesLROTask": { + "type": "object", + "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomEntitiesTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomEntityRecognition" + }, + "CustomEntitiesResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/EntitiesDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "CustomSingleLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Single Classification task.", + "allOf": [ + { + "$ref": "#/definitions/CustomTaskParameters" + } + ] + }, + "CustomSingleLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into single label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomSingleLabelClassification" + }, + "CustomLabelClassificationResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/ClassificationDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "ClassificationResult": { + "type": "object", + "required": [ + "category", + "confidenceScore" + ], + "properties": { + "category": { + "type": "string", + "description": "Classification type." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the recognized class." + } + } + }, + "CustomMultiLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Multi Classification task.", + "allOf": [ + { + "$ref": "#/definitions/CustomTaskParameters" + } + ] + }, + "CustomMultiLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into multi label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomMultiLabelClassification" + }, + "ClassificationDocumentResult": { + "type": "object", + "properties": { + "class": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationResult" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "class" + ] + }, + "HealthcareTaskParameters": { + "type": "object", + "description": "Supported parameters for a Healthcare task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "HealthcareLROTask": { + "type": "object", + "properties": { + "parameters": { + "$ref": "#/definitions/HealthcareTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "Healthcare" + }, + "HealthcareResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/definitions/HealthcareEntitiesDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "HealthcareEntitiesDocumentResult": { + "type": "object", + "properties": { + "entities": { + "description": "Healthcare entities.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "entities", + "relations" + ] + }, + "HealthcareEntity": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "x-ms-enum": { + "name": "healthcareEntityCategory", + "modelAsString": true + }, + "type": "string", + "description": "Healthcare Entity Category.", + "enum": [ + "BODY_STRUCTURE", + "AGE", + "GENDER", + "EXAMINATION_NAME", + "DATE", + "DIRECTION", + "FREQUENCY", + "MEASUREMENT_VALUE", + "MEASUREMENT_UNIT", + "RELATIONAL_OPERATOR", + "TIME", + "GENE_OR_PROTEIN", + "VARIANT", + "ADMINISTRATIVE_EVENT", + "CARE_ENVIRONMENT", + "HEALTHCARE_PROFESSION", + "DIAGNOSIS", + "SYMPTOM_OR_SIGN", + "CONDITION_QUALIFIER", + "MEDICATION_CLASS", + "MEDICATION_NAME", + "DOSAGE", + "MEDICATION_FORM", + "MEDICATION_ROUTE", + "FAMILY_RELATION", + "TREATMENT_NAME" + ] + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "assertion": { + "type": "object", + "$ref": "#/definitions/HealthcareAssertion" + }, + "name": { + "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", + "type": "string" + }, + "links": { + "description": "Entity references in known data sources.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntityLink" + } + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "HealthcareRelation": { + "type": "object", + "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", + "required": [ + "relationType", + "entities" + ], + "properties": { + "relationType": { + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", + "type": "string", + "enum": [ + "Abbreviation", + "DirectionOfBodyStructure", + "DirectionOfCondition", + "DirectionOfExamination", + "DirectionOfTreatment", + "DosageOfMedication", + "FormOfMedication", + "FrequencyOfMedication", + "FrequencyOfTreatment", + "QualifierOfCondition", + "RelationOfExamination", + "RouteOfMedication", + "TimeOfCondition", + "TimeOfEvent", + "TimeOfExamination", + "TimeOfMedication", + "TimeOfTreatment", + "UnitOfCondition", + "UnitOfExamination", + "ValueOfCondition", + "ValueOfExamination" + ], + "x-ms-enum": { + "name": "relationType", + "modelAsString": true + } + }, + "entities": { + "description": "The entities in the relation.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareRelationEntity" + } + } + } + }, + "HealthcareAssertion": { + "type": "object", + "properties": { + "conditionality": { + "description": "Describes any conditionality on the entity.", + "type": "string", + "enum": [ + "hypothetical", + "conditional" + ], + "x-ms-enum": { + "name": "Conditionality", + "modelAsString": false + } + }, + "certainty": { + "description": "Describes the entities certainty and polarity.", + "type": "string", + "enum": [ + "positive", + "positivePossible", + "neutralPossible", + "negativePossible", + "negative" + ], + "x-ms-enum": { + "name": "Certainty", + "modelAsString": false + } + }, + "association": { + "description": "Describes if the entity is the subject of the text or if it describes someone else.", + "type": "string", + "enum": [ + "subject", + "other" + ], + "x-ms-enum": { + "name": "Association", + "modelAsString": false + } + } + } + }, + "HealthcareRelationEntity": { + "type": "object", + "required": [ + "ref", + "role" + ], + "properties": { + "ref": { + "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", + "type": "string" + }, + "role": { + "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", + "type": "string" + } + } + }, + "HealthcareEntityLink": { + "type": "object", + "required": [ + "dataSource", + "id" + ], + "properties": { + "dataSource": { + "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", + "type": "string" + }, + "id": { + "description": "Entity id in the given source catalog.", + "type": "string" + } + } + }, + "SentimentAnalysisTaskParameters": { + "type": "object", + "description": "Supported parameters for a Sentiment Analysis task.", + "properties": { + "opinionMining": { + "type": "boolean", + "default": false + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "SentimentAnalysisLROTask": { + "type": "object", + "description": "An object representing the task definition for a Sentiment Analysis task.", + "properties": { + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "SentimentTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "SentimentAnalysisResults" + }, + "SentimentResponse": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Sentiment analysis per document.", + "items": { + "allOf": [ + { + "$ref": "#/definitions/SentimentDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "SentimentDocumentResult": { + "type": "object", + "properties": { + "sentiment": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "sentences": { + "type": "array", + "description": "Sentence level sentiment analysis.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "sentiment", + "confidenceScores", + "sentences" + ] + }, + "SentimentConfidenceScorePerLabel": { + "type": "object", + "required": [ + "positive", + "neutral", + "negative" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "neutral": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." + }, + "SentenceSentiment": { + "type": "object", + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + }, + "targets": { + "type": "array", + "description": "The array of sentence targets for the sentence.", + "items": { + "$ref": "#/definitions/SentenceTarget" + } + }, + "assessments": { + "type": "array", + "description": "The array of assessments for the sentence.", + "items": { + "$ref": "#/definitions/SentenceAssessment" + } + } + } + }, + "SentenceTarget": { + "type": "object", + "required": [ + "confidenceScores", + "length", + "offset", + "relations", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Targeted sentiment in the sentence." + }, + "confidenceScores": { + "description": "Target sentiment confidence scores for the target in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "relations": { + "type": "array", + "description": "The array of either assessment or target objects which is related to the target.", + "items": { + "$ref": "#/definitions/TargetRelation" + } + } + } + }, + "SentenceAssessment": { + "type": "object", + "required": [ + "confidenceScores", + "isNegated", + "length", + "offset", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Assessment sentiment in the sentence." + }, + "confidenceScores": { + "description": "Assessment sentiment confidence scores in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The assessment offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the assessment." + }, + "text": { + "type": "string", + "description": "The assessment text detected." + }, + "isNegated": { + "type": "boolean", + "description": "The indicator representing if the assessment is negated." + } + } + }, + "TargetRelation": { + "type": "object", + "required": [ + "ref", + "relationType" + ], + "properties": { + "relationType": { + "type": "string", + "enum": [ + "assessment", + "target" + ], + "x-ms-enum": { + "name": "TargetRelationType", + "modelAsString": false + }, + "description": "The type related to the target." + }, + "ref": { + "type": "string", + "description": "The JSON pointer indicating the linked object." + } + } + }, + "TargetConfidenceScoreLabel": { + "type": "object", + "required": [ + "negative", + "positive" + ], + "properties": { + "positive": { + "type": "number", + "format": "double" + }, + "negative": { + "type": "number", + "format": "double" + } + }, + "description": "Represents the confidence scores across all sentiment classes: positive, neutral, negative." + }, + "EntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Recognition task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "EntitiesLROTask": { + "type": "object", + "description": "An object representing the task definition for an Entities Recognition task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "EntitiesTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityRecognitionResults" + }, + "EntitiesResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/EntitiesDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "EntitiesDocumentResult": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "entities" + ] + }, + "Entity": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "EntityLinkingTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Linking task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "EntityLinkingLROTask": { + "type": "object", + "description": "An object representing the task definition for an Entity Linking task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "EntityLinkingTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityLinkingResults" + }, + "EntityLinkingResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/LinkedEntitiesDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "LinkedEntitiesDocumentResult": { + "type": "object", + "required": [ + "entities" + ], + "properties": { + "entities": { + "type": "array", + "description": "Recognized well known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ] + }, + "LinkedEntity": { + "type": "object", + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ], + "properties": { + "name": { + "type": "string", + "description": "Entity Linking formal name." + }, + "matches": { + "type": "array", + "description": "List of instances this entity appears in the text.", + "items": { + "$ref": "#/definitions/Match" + } + }, + "language": { + "type": "string", + "description": "Language used in the data source." + }, + "id": { + "type": "string", + "description": "Unique identifier of the recognized entity from the data source." + }, + "url": { + "type": "string", + "description": "URL for the entity's page from the data source." + }, + "dataSource": { + "type": "string", + "description": "Data source used to extract entity linking, such as Wiki/Bing etc." + }, + "bingId": { + "type": "string", + "description": "Bing Entity Search API unique identifier of the recognized entity." + } + } + }, + "Match": { + "type": "object", + "required": [ + "confidenceScore", + "text", + "offset", + "length" + ], + "properties": { + "confidenceScore": { + "type": "number", + "format": "double", + "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + }, + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity match text." + } + } + }, + "PiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a PII Entities Recognition task.", + "properties": { + "domain": { + "$ref": "#/definitions/PiiDomain" + }, + "piiCategories": { + "$ref": "#/definitions/PiiCategories" + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "PiiLROTask": { + "type": "object", + "description": "An object representing the task definition for a PII Entities Recognition task.", + "properties": { + "parameters": { + "$ref": "#/definitions/PiiTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "PiiTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "PiiEntityRecognitionResults" + }, + "PiiResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/PiiEntitiesDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "PiiDomain": { + "type": "string", + "description": "The PII domain used for PII Entity Recognition.", + "default": "none", + "enum": [ + "phi", + "none" + ], + "x-ms-enum": { + "name": "PiiDomain", + "modelAsString": true, + "values": [ + { + "name": "phi", + "description": "Indicates that entities in the Personal Health Information domain should be redacted.", + "value": "phi" + }, + { + "name": "none", + "description": "Indicates that no domain is specified.", + "value": "none" + } + ] + } + }, + "PiiEntitiesDocumentResult": { + "type": "object", + "properties": { + "redactedText": { + "type": "string", + "description": "Returns redacted text." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "redactedText", + "entities" + ] + }, + "PiiCategories": { + "description": "(Optional) describes the PII categories to return", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ] + }, + "type": "array", + "uniqueItems": true + }, + "KeyPhraseTaskParameters": { + "type": "object", + "description": "Supported parameters for a Key Phrase Extraction task.", + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "KeyPhraseLROTask": { + "type": "object", + "description": "An object representing the task definition for a Key Phrase Extraction task.", + "properties": { + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "KeyPhraseTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "KeyPhraseExtractionResults" + }, + "KeyPhraseResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/KeyPhrasesDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "KeyPhrasesDocumentResult": { + "type": "object", + "properties": { + "keyPhrases": { + "type": "array", + "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "keyPhrases" + ] + }, + "LanguageDetectionTaskParameters": { + "type": "object", + "description": "Supported parameters for a Language Detection task.", + "allOf": [ + { + "$ref": "#/definitions/PreBuiltTaskParameters" + } + ] + }, + "LanguageDetectionTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/LanguageDetectionResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "LanguageDetectionResults" + }, + "LanguageDetectionResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/LanguageDetectionDocumentResult" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "LanguageDetectionDocumentResult": { + "type": "object", + "properties": { + "detectedLanguage": { + "description": "Detected Language.", + "$ref": "#/definitions/DetectedLanguage" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "detectedLanguage" + ] + }, + "DetectedLanguage": { + "type": "object", + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ], + "properties": { + "name": { + "type": "string", + "description": "Long name of a detected language (e.g. English, French)." + }, + "iso6391Name": { + "type": "string", + "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + } + } + }, + "AnalyzeTextJobState": { + "allOf": [ + { + "$ref": "#/definitions/JobState" + }, + { + "$ref": "#/definitions/TasksState" + }, + { + "$ref": "#/definitions/AnalyzeTextJobStatistics" + } + ] + }, + "Pagination": { + "properties": { + "nextLink": { + "type": "string" + } + }, + "type": "object" + }, + "JobState": { + "properties": { + "displayName": { + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "type": "string" + }, + "jobId": { + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "State" + } + }, + "errors": { + "items": { + "$ref": "common.json#/definitions/Error" + }, + "type": "array" + }, + "nextLink": { + "type": "string" + } + }, + "required": [ + "jobId", + "lastUpdatedDateTime", + "createdDateTime", + "status" + ] + }, + "JobErrors": { + "properties": { + "errors": { + "items": { + "$ref": "common.json#/definitions/Error" + }, + "type": "array" + } + }, + "type": "object" + }, + "AnalyzeTextJobStatistics": { + "properties": { + "statistics": { + "$ref": "#/definitions/RequestStatistics" + } + }, + "type": "object" + }, + "TasksState": { + "properties": { + "tasks": { + "properties": { + "completed": { + "type": "integer" + }, + "failed": { + "type": "integer" + }, + "inProgress": { + "type": "integer" + }, + "total": { + "type": "integer" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + } + }, + "required": [ + "total", + "completed", + "failed", + "inProgress" + ], + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "TaskState": { + "properties": { + "lastUpdateDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "State" + } + } + }, + "required": [ + "status", + "lastUpdateDateTime" + ], + "type": "object" + }, + "AnalyzeTextLROResult": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextLROResultsKind" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "#/definitions/TaskIdentifier" + } + ], + "required": [ + "kind" + ] + }, + "EntityRecognitionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityRecognitionLROResults" + }, + "CustomEntityRecognitionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomEntitiesResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" + }, + "CustomSingleLabelClassificationLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" + }, + "CustomMultiLabelClassificationLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" + }, + "EntityLinkingLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityLinkingLROResults" + }, + "PiiEntityRecognitionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" + }, + "HealthcareLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/HealthcareResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "HealthcareLROResults" + }, + "SentimentLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "SentimentAnalysisLROResults" + }, + "KeyPhraseExtractionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" + }, + "DocumentResponse": { + "type": "object", + "properties": {} + }, + "DocumentResult": { + "type": "object", + "required": [ + "id", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "DocumentError": { + "type": "object", + "required": [ + "id", + "error" + ], + "properties": { + "id": { + "type": "string", + "description": "Document Id." + }, + "error": { + "type": "object", + "description": "Document Error.", + "$ref": "common.json#/definitions/Error" + } + } + }, + "DocumentWarning": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "LongWordsInDocument", + "DocumentTruncated" + ], + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + } + }, + "DocumentStatistics": { + "type": "object", + "required": [ + "charactersCount", + "transactionsCount" + ], + "properties": { + "charactersCount": { + "type": "integer", + "format": "int32", + "description": "Number of text elements recognized in the document." + }, + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of transactions for the document." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "RequestStatistics": { + "type": "object", + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ], + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "MultiLanguageInput": { + "type": "object", + "description": "Contains an input document to be analyzed by the service.", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + } + } + }, + "LanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "text": { + "type": "string" + }, + "countryHint": { + "type": "string" + } + } + } + }, + "parameters": { + "ShowStats": { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "JobId": { + "description": "Job ID", + "format": "uuid", + "in": "path", + "name": "jobId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +}