diff --git a/custom-words.txt b/custom-words.txt index 5027b540a04c..1313bfa4152b 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -67,6 +67,8 @@ ambari amlcompute amortizedcost analysisservices +analyzeconversations +analyzetext AND'ed Annotatable anomalydetector diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 29ee9f913c87..65b5e663d574 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -29,6 +29,8 @@ These settings apply only when `--tag=release_2022_05_01` is specified on the co ``` 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 title: Microsoft Cognitive Language Service modelerfour: 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..ac7e1764e035 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json @@ -0,0 +1,3095 @@ +{ + "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": { + "204": { + "description": "The job was successfully canceled." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + } + } + } + }, + "/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" + }, + "ConversationalAnalysisAuthoringExportedCluOrchestration": { + "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": "ExportedCluOrchestration" + }, + "ConversationalAnalysisAuthoringExportedCluOrchestrationOptions": { + "description": "Represents the orchestration options for a Conversational project target.", + "required": [ + "cluOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "cluOrchestration": { + "description": "The Conversational project target details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedCluOrchestration" + } + }, + "x-ms-discriminator-value": "clu", + "x-ms-client-name": "ExportedCluOrchestrationOptions" + }, + "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": [ + "kind" + ], + "type": "object", + "properties": { + "kind": { + "description": "The kind of the target used in the orchestration flow.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationKind" + } + }, + "discriminator": "kind", + "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": [ + "clu", + "luis" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "value": "clu", + "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" + }, + "ConversationalAnalysisAuthoringExportedQnaOrchestration": { + "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": "ExportedQnaOrchestration" + }, + "ConversationalAnalysisAuthoringExportedQnaOrchestrationOptions": { + "description": "Represents the orchestration options for a Question Answering project target.", + "required": [ + "qnaOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "qnaOrchestration": { + "description": "The Question Answering project details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQnaOrchestration" + } + }, + "x-ms-discriminator-value": "qna", + "x-ms-client-name": "ExportedQnaOrchestrationOptions" + }, + "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" + }, + "ConversationalAnalysisAuthoringOrchestrationKind": { + "enum": [ + "luis", + "clu", + "qna" + ], + "type": "string", + "x-ms-enum": { + "name": "OrchestrationKind", + "modelAsString": true + }, + "x-ms-client-name": "OrchestrationKind" + }, + "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 CLU, 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": [ + "clu", + "luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "value": "clu", + "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 CLU, 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/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json new file mode 100644 index 000000000000..9bc14684dc74 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json @@ -0,0 +1,2965 @@ +{ + "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": { + "204": { + "description": "The job was successfully canceled." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" + } + } + } + }, + "/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" + }, + "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" + }, + "TextAnalysisAuthoringCustomNamedEntityRecognitionDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom named entity recognition project.", + "required": [ + "customNamedEntityRecognitionResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customNamedEntityRecognitionResult": { + "description": "Represents the evaluation prediction for named entity recognition.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentNamedEntityRecognitionEvaluationResult" + } + }, + "x-ms-discriminator-value": "customNamedEntityRecognition", + "x-ms-client-name": "CustomNamedEntityRecognitionDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomNamedEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom named entity recognition project.", + "required": [ + "customNamedEntityRecognitionEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customNamedEntityRecognitionEvaluation": { + "description": "Contains the data related to extraction evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary" + } + }, + "x-ms-discriminator-value": "customNamedEntityRecognition", + "x-ms-client-name": "CustomNamedEntityRecognitionEvaluationSummary" + }, + "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" + }, + "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" + }, + "TextAnalysisAuthoringDocumentNamedEntityRecognitionEvaluationResult": { + "description": "Represents the named 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": "DocumentNamedEntityRecognitionEvaluationResult" + }, + "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" + }, + "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" + }, + "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" + }, + "TextAnalysisAuthoringExportedCustomNamedEntityRecognitionDocument": { + "description": "Represents an exported document for a custom named 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": "ExportedCustomNamedEntityRecognitionDocument" + }, + "TextAnalysisAuthoringExportedCustomNamedEntityRecognitionProjectAssets": { + "description": "Represents the exported assets for a named 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/TextAnalysisAuthoringExportedCustomNamedEntityRecognitionDocument" + } + } + }, + "x-ms-discriminator-value": "customNamedEntityRecognition", + "x-ms-client-name": "ExportedCustomNamedEntityRecognitionProjectAssets" + }, + "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" + }, + "TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom named 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": "NamedEntityRecognitionEvaluationSummary" + }, + "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", + "customNamedEntityRecognition" + ], + "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": "customNamedEntityRecognition", + "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", + "customNamedEntityRecognition" + ], + "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": "customNamedEntityRecognition", + "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 index 01e2dcda559c..21a98335c7fe 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/common.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/common.json @@ -110,7 +110,11 @@ "AzureCognitiveSearchThrottling", "AzureCognitiveSearchIndexLimitReached", "InternalServerError", - "ServiceUnavailable" + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" ] }, "InnerErrorCode": { 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..9e9f2078c34f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "204": {} + } +} 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..4d715808ffda --- /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..0d3a6c5ccad5 --- /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..df03d76725eb --- /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..6706a4180b60 --- /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..503a15f5aa65 --- /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..fa7107d98678 --- /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..818700374270 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "204": {} + } +} 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..2575f970b5b5 --- /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": "customNamedEntityRecognition", + "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": "customNamedEntityRecognition", + "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": "customNamedEntityRecognition", + "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..aca95b34fef3 --- /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": "customNamedEntityRecognition", + "customNamedEntityRecognitionResult": { + "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": "customNamedEntityRecognition", + "customNamedEntityRecognitionResult": { + "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..4b6c3df844ab --- /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": "customNamedEntityRecognition", + "customNamedEntityRecognitionEvaluation": { + "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..41ddeb1afd91 --- /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": "customNamedEntityRecognition", + "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..4c9d208f5d95 --- /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": "customNamedEntityRecognition" + }, + "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..6d9db0e680bf --- /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": "customNamedEntityRecognition", + "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": "customNamedEntityRecognition", + "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..214769fc5c9e --- /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": "customNamedEntityRecognition", + "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" + } + } + } +}