From 2dc24a2e64399ddd471dbffb7a1b45679268cf15 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Fri, 15 Apr 2022 06:09:13 +0200 Subject: [PATCH 01/24] Add Language authoring 2022-05-01 APIs --- .../data-plane/Language/readme.md | 2 + .../ConversationalAnalysis-authoring.json | 2905 ++++++++++++++++ .../2022-05-01/CustomText-Authoring.json | 2910 +++++++++++++++++ 3 files changed, 5817 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 29ee9f913c87..e7c8492fa7ae 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/CustomText-Authoring.json + - stable/2022-05-01/ConversationalAnalysis-authoring.json title: Microsoft Cognitive Language Service modelerfour: diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json new file mode 100644 index 000000000000..7bac1d5cec80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json @@ -0,0 +1,2905 @@ +{ + "swagger": "2.0", + "info": { + "title": "Language - Conversational Language Understanding Authoring APIs (2022-05-01)", + "version": "2022-05-01" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language/authoring/analyze-conversations/projects", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/": { + "get": { + "summary": "List projects", + "description": "Lists the existing projects.", + "operationId": "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/ProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}": { + "patch": { + "summary": "Create project", + "description": "Creates a new project or updates an existing one.", + "operationId": "CreateProject", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "projectCreateObject", + "description": "The project parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "summary": "Get project details", + "description": "Gets the details of a project.", + "operationId": "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/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete project", + "description": "Deletes a project.", + "operationId": "DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Successfully triggered the project deletion operation.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/:export": { + "post": { + "summary": "Export project", + "description": "Triggers a job to export a project's data.", + "operationId": "Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/FormatInQuery" + }, + { + "$ref": "#/parameters/StringIndexTypeInQuery" + }, + { + "in": "query", + "name": "assetKind", + "description": "Kind of asset to export.", + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/:import": { + "post": { + "summary": "Import project", + "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": "Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/FormatInQuery" + }, + { + "in": "body", + "name": "projectFileImportObject", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportedProject" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/:train": { + "post": { + "summary": "Train project", + "description": "Triggers a training job for a project.", + "operationId": "Train", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "trainingJobCreateObject", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TrainingJobOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/deployments": { + "get": { + "summary": "List deployments", + "description": "Lists the deployments belonging to a project.", + "operationId": "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/ProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/deployments/:swap": { + "post": { + "summary": "Swap deployments", + "description": "Swaps two existing deployments with each other.", + "operationId": "SwapDeployments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "swappingDeploymentJobObject", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/SwapDeploymentsOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/deployments/{deploymentName}": { + "get": { + "summary": "Get deployment details", + "description": "Gets the details of a deployment.", + "operationId": "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/ProjectDeployment" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "summary": "Update deployment", + "description": "Creates a new deployment or replaces an existing one.", + "operationId": "DeployProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "createOrReplaceDeploymentJobObject", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "summary": "Delete deployment", + "description": "Deletes a project deployment.", + "operationId": "DeleteDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "summary": "Get deployment status", + "description": "Gets the status of an existing deployment job.", + "operationId": "GetDeploymentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/DeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "summary": "Gets swap deployments status", + "description": "Gets the status of an existing swap deployment job.", + "operationId": "GetSwapDeploymentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The swap deployment job result.", + "schema": { + "$ref": "#/definitions/DeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/export/jobs/{jobId}": { + "get": { + "summary": "Get export status", + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "operationId": "GetExportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/ExportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/export/jobs/{jobId}/result": { + "get": { + "summary": "Get export result", + "description": "Gets the result of an export job.", + "operationId": "GetExportResult", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The exported json project object.", + "schema": { + "$ref": "#/definitions/ExportedProject" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/import/jobs/{jobId}": { + "get": { + "summary": "Get import status", + "description": "Gets the status for an import.", + "operationId": "GetImportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/ImportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/models": { + "get": { + "summary": "List trained models", + "description": "Lists the trained models belonging to a project.", + "operationId": "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/ProjectTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/models/{trainedModelLabel}": { + "get": { + "summary": "Get trained model details", + "description": "Gets the details of a trained model.", + "operationId": "GetTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trained model info", + "schema": { + "$ref": "#/definitions/ProjectTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete trained model", + "description": "Deletes an existing trained model.", + "operationId": "DeleteTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Deleted successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "summary": "Get trained model evaluation result", + "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": "GetModelEvaluationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/StringIndexTypeInQuery" + }, + { + "$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/EvaluationResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "summary": "Get trained model evaluation summary", + "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": "GetModelEvaluationSummary", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all evaluation results.", + "schema": { + "$ref": "#/definitions/EvaluationSummary" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/train/jobs": { + "get": { + "summary": "List training jobs", + "description": "Lists the non-expired training jobs created for a project.", + "operationId": "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/TrainingJobs" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/train/jobs/{jobId}": { + "get": { + "summary": "Get training status", + "description": "Gets the status for a training job.", + "operationId": "GetTrainingStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The training job result.", + "schema": { + "$ref": "#/definitions/TrainingJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "summary": "Cancel training", + "description": "Triggers a cancelation for a running training job.", + "operationId": "CancelTrainingJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "The job was succesfully canceled." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/global/deletion-jobs/{jobId}": { + "get": { + "summary": "Get project deletion status", + "description": "Gets the status for a project deletion job.", + "operationId": "GetProjectDeletionStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The project deletion job result.", + "schema": { + "$ref": "#/definitions/ProjectDeletionJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/global/languages": { + "get": { + "summary": "List supported languages", + "description": "Lists the supported languages for the given project type.", + "operationId": "GetSupportedLanguages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ProjectKindInQuery" + }, + { + "$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/SupportedLanguages" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/global/prebuilt-entities": { + "get": { + "summary": "List supported prebuilt entities", + "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", + "operationId": "GetSupportedPrebuiltEntities", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "language", + "description": "The language to get supported prebuilt entities for. Required if multilingual is false.", + "type": "string" + }, + { + "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" + }, + { + "$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/PrebuiltEntities" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/global/training-config-versions": { + "get": { + "summary": "List training config versions", + "description": "Lists the support training config version for a given project type.", + "operationId": "ListTrainingConfigVersions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ProjectKindInQuery" + }, + { + "$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/TrainingConfigVersions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + } + }, + "definitions": { + "CompositionSetting": { + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" + ], + "type": "string", + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true + } + }, + "ConfusionMatrix": { + "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" + } + } + }, + "CreateDeploymentOptions": { + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "Represents the trained model label.", + "type": "string" + } + } + }, + "CreateProjectOptions": { + "required": [ + "projectKind", + "settings", + "projectName", + "language" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ProjectKind" + }, + "settings": { + "description": "Gets or sets the project settings.", + "$ref": "#/definitions/ProjectSettings" + }, + "projectName": { + "description": "Gets or sets the new project name.", + "type": "string" + }, + "multilingual": { + "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "type": "boolean" + }, + "description": { + "description": "Gets or sets the new project description.", + "type": "string" + }, + "language": { + "description": "Gets or sets the project language.", + "type": "string" + } + } + }, + "DeploymentJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "EntitiesEvaluationSummary": { + "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 entity)\n the matrix is between the actual entity that was labelled and the entity that was predicted.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConfusionMatrix" + } + } + }, + "entities": { + "description": "Represents the entities evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EntityEvaluationSummary" + } + }, + "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" + } + } + }, + "EntityEvaluationSummary": { + "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" + } + } + }, + "Error": { + "description": "Represents the definition of the error that occurred.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "target": { + "description": "The target that caused the error, if applicable.", + "type": "string" + }, + "details": { + "description": "An array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ErrorCode": { + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Forbidden", + "NotFound", + "Unauthorized", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning", + "InternalServerError" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "ErrorResponse": { + "description": "Represents the error that occurred.", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EvaluationKind": { + "enum": [ + "percentage", + "manual" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true + } + }, + "EvaluationOptions": { + "type": "object", + "properties": { + "kind": { + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", + "$ref": "#/definitions/EvaluationKind" + }, + "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" + } + } + }, + "EvaluationResults": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the utterances predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/UtteranceEvaluationResult" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "EvaluationSummary": { + "required": [ + "entitiesEvaluation", + "intentsEvaluation" + ], + "type": "object", + "properties": { + "entitiesEvaluation": { + "description": "Contains the data related to entities evaluation.", + "$ref": "#/definitions/EntitiesEvaluationSummary" + }, + "intentsEvaluation": { + "description": "Contains the data related to intents evaluation.", + "$ref": "#/definitions/IntentsEvaluation" + }, + "evaluationOptions": { + "$ref": "#/definitions/EvaluationOptions" + } + } + }, + "ExportedCluOrchestration": { + "required": [ + "projectName", + "deploymentName" + ], + "type": "object", + "properties": { + "projectName": { + "type": "string" + }, + "deploymentName": { + "type": "string" + } + } + }, + "ExportedCluOrchestrationOptions": { + "required": [ + "cluOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedOrchestrationOptions" + } + ], + "properties": { + "cluOrchestration": { + "$ref": "#/definitions/ExportedCluOrchestration" + } + }, + "x-ms-discriminator-value": "clu" + }, + "ExportedEntity": { + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "compositionSetting": { + "$ref": "#/definitions/CompositionSetting" + }, + "list": { + "$ref": "#/definitions/ExportedEntityList" + }, + "prebuilts": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedPrebuiltEntity" + } + } + } + }, + "ExportedEntityList": { + "type": "object", + "properties": { + "sublists": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedEntitySublist" + } + } + } + }, + "ExportedEntityListSynonym": { + "type": "object", + "properties": { + "language": { + "type": "string" + }, + "values": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExportedEntitySublist": { + "type": "object", + "properties": { + "listKey": { + "type": "string" + }, + "synonyms": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedEntityListSynonym" + } + } + } + }, + "ExportedIntent": { + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "orchestration": { + "$ref": "#/definitions/ExportedOrchestrationOptions" + } + } + }, + "ExportedLuisOrchestration": { + "required": [ + "appId" + ], + "type": "object", + "properties": { + "appId": { + "format": "uuid", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "appVersion": { + "type": "string" + }, + "slotName": { + "type": "string" + } + } + }, + "ExportedLuisOrchestrationOptions": { + "required": [ + "luisOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedOrchestrationOptions" + } + ], + "properties": { + "luisOrchestration": { + "$ref": "#/definitions/ExportedLuisOrchestration" + } + }, + "x-ms-discriminator-value": "luis" + }, + "ExportedOrchestrationOptions": { + "type": "object", + "properties": { + "kind": { + "$ref": "#/definitions/OrchestrationKind" + } + }, + "discriminator": "kind" + }, + "ExportedPrebuiltEntity": { + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "type": "string" + } + } + }, + "ExportedProject": { + "required": [ + "api-version", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "api-version": { + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/StringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/CreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/ExportedProjectAssets" + } + } + }, + "ExportedProjectAssets": { + "type": "object", + "properties": { + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedIntent" + } + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedEntity" + } + }, + "utterances": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedUtterance" + } + } + } + }, + "ExportedProjectFormat": { + "enum": [ + "clu", + "luis" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true + } + }, + "ExportedQnaOrchestration": { + "required": [ + "projectName" + ], + "type": "object", + "properties": { + "projectName": { + "type": "string" + } + } + }, + "ExportedQnaOrchestrationOptions": { + "required": [ + "qnaOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedOrchestrationOptions" + } + ], + "properties": { + "qnaOrchestration": { + "$ref": "#/definitions/ExportedQnaOrchestration" + } + }, + "x-ms-discriminator-value": "qna" + }, + "ExportedUtterance": { + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "language": { + "type": "string" + }, + "intent": { + "type": "string" + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedUtteranceEntityLabel" + } + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + } + }, + "ExportedUtteranceEntityLabel": { + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "offset": { + "format": "int32", + "type": "integer" + }, + "length": { + "format": "int32", + "type": "integer" + } + } + }, + "ExportProjectJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "resultUrl": { + "type": "string" + }, + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ImportProjectJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "IntentEvaluation": { + "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" + } + } + }, + "IntentsEvaluation": { + "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 intent)\n the matrix is between the actual intent that was labelled and the intent that was predicted.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConfusionMatrix" + } + } + }, + "intents": { + "description": "Represents the intents evaluation.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/IntentEvaluation" + } + }, + "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" + } + } + }, + "JobStatus": { + "enum": [ + "unknown", + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "OrchestrationKind": { + "enum": [ + "luis", + "clu", + "qna" + ], + "type": "string", + "x-ms-enum": { + "name": "OrchestrationKind", + "modelAsString": true + } + }, + "PrebuiltEntities": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The supported prebuilt entities.", + "type": "array", + "items": { + "$ref": "#/definitions/PrebuiltEntity" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string" + } + } + }, + "PrebuiltEntity": { + "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" + } + } + }, + "ProjectDeletionJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ProjectDeployment": { + "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-time", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents model training config version.", + "type": "string" + } + } + }, + "ProjectDeployments": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/ProjectDeployment" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "ProjectKind": { + "enum": [ + "conversation", + "orchestration" + ], + "type": "string", + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true + } + }, + "ProjectMetadata": { + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "lastTrainedDateTime", + "lastDeployedDateTime", + "projectKind", + "settings", + "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/ProjectKind" + }, + "settings": { + "description": "Gets or sets the project settings.", + "$ref": "#/definitions/ProjectSettings" + }, + "projectName": { + "description": "Gets or sets the new project name.", + "type": "string" + }, + "multilingual": { + "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "type": "boolean" + }, + "description": { + "description": "Gets or sets the new project description.", + "type": "string" + }, + "language": { + "description": "Gets or sets the project language.", + "type": "string" + } + } + }, + "ProjectSettings": { + "required": [ + "confidenceThreshold" + ], + "type": "object", + "properties": { + "confidenceThreshold": { + "format": "float", + "type": "number" + } + } + }, + "ProjectsMetadata": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the projects.", + "type": "array", + "items": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "ProjectTrainedModel": { + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "label": { + "description": "Represents trained model label.", + "type": "string" + }, + "modelId": { + "description": "Represents the ID of this model. The model ID has the format \"{version}-{yyyyMMddThhmmss}-{Guid.NewGuid()}\".", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents trained model last trained time.", + "type": "string" + }, + "lastTrainingDurationInSeconds": { + "format": "int32", + "description": "Represents trained model last training duration in seconds.", + "type": "integer" + }, + "modelExpirationDate": { + "format": "date-time", + "description": "Represents model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents the model training config version.", + "type": "string" + } + } + }, + "ProjectTrainedModels": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/ProjectTrainedModel" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "StringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true + } + }, + "SubTrainingJobState": { + "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 job.", + "$ref": "#/definitions/JobStatus" + } + } + }, + "SupportedLanguage": { + "required": [ + "languageName", + "languageCode" + ], + "type": "object", + "properties": { + "languageName": { + "description": "Gets or sets the language name.", + "type": "string" + }, + "languageCode": { + "description": "Gets or sets the language code.", + "type": "string" + } + } + }, + "SupportedLanguages": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of supported objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedLanguage" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string" + } + } + }, + "SwapDeploymentsOptions": { + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ], + "type": "object", + "properties": { + "firstDeploymentName": { + "description": "Represents the first deployment name.", + "type": "string" + }, + "secondDeploymentName": { + "description": "Represents the second deployment name.", + "type": "string" + } + } + }, + "TrainingConfigVersion": { + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ], + "type": "object", + "properties": { + "trainingConfigVersion": { + "description": "Represents the training config version.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date-time", + "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", + "type": "string" + } + } + }, + "TrainingConfigVersions": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the training config versions.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingConfigVersion" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "TrainingJobOptions": { + "required": [ + "modelLabel", + "trainingMode" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents training model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.\n By default, \"latest\" value is used which uses the latest released training config version.", + "type": "string" + }, + "trainingMode": { + "description": "Represents the training mode of the training operation.", + "$ref": "#/definitions/TrainingMode" + }, + "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/EvaluationOptions" + } + } + }, + "TrainingJobResult": { + "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 training mode of the training operation.", + "$ref": "#/definitions/TrainingMode" + }, + "trainingStatus": { + "description": "Represents model train status.", + "$ref": "#/definitions/SubTrainingJobState" + }, + "evaluationStatus": { + "description": "Represents model evaluation status.", + "$ref": "#/definitions/SubTrainingJobState" + }, + "estimatedEndDateTime": { + "format": "date-time", + "description": "Represents the estimate end date time for training and evaluation.", + "type": "string" + } + } + }, + "TrainingJobs": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingJobState" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "TrainingJobState": { + "required": [ + "result", + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "result": { + "description": "Represents training tasks detailed result.", + "$ref": "#/definitions/TrainingJobResult" + }, + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "TrainingMode": { + "enum": [ + "advanced", + "standard" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true + } + }, + "UtteranceEntitiesEvaluationResult": { + "required": [ + "expectedEntities", + "actualEntities" + ], + "type": "object", + "properties": { + "expectedEntities": { + "description": "Represents the entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/UtteranceEntityEvaluationResult" + } + }, + "actualEntities": { + "description": "Represents the predicted entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/UtteranceEntityEvaluationResult" + } + } + } + }, + "UtteranceEntityEvaluationResult": { + "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" + } + } + }, + "UtteranceEvaluationResult": { + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ], + "type": "object", + "properties": { + "text": { + "description": "Represents the utterance text.", + "type": "string" + }, + "language": { + "description": "Represents the utterance language.", + "type": "string" + }, + "entitiesResult": { + "description": "Represents the entities results for the utterance.", + "$ref": "#/definitions/UtteranceEntitiesEvaluationResult" + }, + "intentsResult": { + "description": "Represents the intents results for the utterance.", + "$ref": "#/definitions/UtteranceIntentsEvaluationResult" + } + } + }, + "UtteranceIntentsEvaluationResult": { + "required": [ + "expectedIntent", + "actualIntent" + ], + "type": "object", + "properties": { + "expectedIntent": { + "description": "Represents the utterance's labeled intent.", + "type": "string" + }, + "actualIntent": { + "description": "Represents the utterance's predicted intent.", + "type": "string" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "FormatInQuery": { + "in": "query", + "name": "format", + "description": "The format of the project to export. The currently supported format is `clu`.", + "type": "string", + "enum": [ + "clu", + "luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "StringIndexTypeInQuery": { + "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 + }, + "x-ms-parameter-location": "method" + }, + "ProjectKindInQuery": { + "in": "query", + "name": "projectKind", + "description": "The project kind to get the supported languages for.", + "required": true, + "type": "string", + "enum": [ + "conversation", + "orchestration" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json new file mode 100644 index 000000000000..3927ff2db5a4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json @@ -0,0 +1,2910 @@ +{ + "swagger": "2.0", + "info": { + "title": "Language - Custom Text Authoring APIs (2022-05-01)", + "version": "2022-05-01" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language/authoring/analyze-text/projects", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "paths": { + "/": { + "get": { + "summary": "List projects", + "description": "Lists the existing projects.", + "operationId": "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/ProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}": { + "patch": { + "summary": "Create project", + "description": "Creates a new project or updates an existing one.", + "operationId": "CreateProject", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "projectCreateObject", + "description": "The project parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "summary": "Get project details", + "description": "Gets the details of a project.", + "operationId": "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/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete project", + "description": "Deletes a project.", + "operationId": "DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Successfully triggered the project deletion operation.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/:export": { + "post": { + "summary": "Export project", + "description": "Triggers a job to export a project's data.", + "operationId": "Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/StringIndexTypeInQuery" + }, + { + "in": "query", + "name": "format", + "description": "The format of the project to export. The currently supported format is `JSON`.", + "type": "string" + }, + { + "in": "query", + "name": "assetKind", + "description": "Kind of asset to export.", + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/:import": { + "post": { + "summary": "Import project", + "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": "Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "projectFileImportObject", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportedDocument" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/:train": { + "post": { + "summary": "Train project", + "description": "Triggers a training job for a project.", + "operationId": "Train", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "trainingJobCreateObject", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TrainingJobOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/deployments": { + "get": { + "summary": "List deployments", + "description": "Lists the deployments belonging to a project.", + "operationId": "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/ProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/deployments/:swap": { + "post": { + "summary": "Swap deployments", + "description": "Swaps two existing deployments with each other.", + "operationId": "SwapDeployments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "swappingDeploymentJobObject", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/SwapDeploymentsOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/deployments/{deploymentName}": { + "get": { + "summary": "Get deployment details", + "description": "Gets the details of a deployment.", + "operationId": "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/ProjectDeployment" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "summary": "Update deployment", + "description": "Creates a new deployment or replaces an existing one.", + "operationId": "DeployProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "createOrReplaceDeploymentJobObject", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "summary": "Delete deployment", + "description": "Deletes a project deployment.", + "operationId": "DeleteDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "operation-location header for 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": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "summary": "Get deployment status", + "description": "Gets the status of an existing deployment job.", + "operationId": "GetDeploymentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/DeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "summary": "Gets swap deployments status", + "description": "Gets the status of an existing swap deployment job.", + "operationId": "GetSwapDeploymentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The swap deployment job result.", + "schema": { + "$ref": "#/definitions/DeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/export/jobs/{jobId}": { + "get": { + "summary": "Get export status", + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "operationId": "GetExportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/ExportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/export/jobs/{jobId}/result": { + "get": { + "summary": "Get export result", + "description": "Gets the result of an export job.", + "operationId": "GetExportResult", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The exported json project object.", + "schema": { + "$ref": "#/definitions/ExportedDocument" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/import/jobs/{jobId}": { + "get": { + "summary": "Get import status", + "description": "Gets the status for an import.", + "operationId": "GetImportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/ImportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/models": { + "get": { + "summary": "List trained models", + "description": "Lists the trained models belonging to a project.", + "operationId": "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/ProjectTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/models/{trainedModelLabel}": { + "get": { + "summary": "Get trained model details", + "description": "Gets the details of a trained model.", + "operationId": "GetTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trained model info", + "schema": { + "$ref": "#/definitions/ProjectTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "summary": "Delete trained model", + "description": "Deletes an existing trained model.", + "operationId": "DeleteTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Deleted successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "summary": "Get trained model evaluation result", + "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": "GetModelEvaluationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/StringIndexTypeInQuery" + }, + { + "$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/EvaluationResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "summary": "Get trained model evaluation summary", + "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": "GetModelEvaluationSummary", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model name.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all evaluation results.", + "schema": { + "$ref": "#/definitions/EvaluationSummary" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/train/jobs": { + "get": { + "summary": "List training jobs", + "description": "Lists the non-expired training jobs created for a project.", + "operationId": "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/TrainingJobs" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/{projectName}/train/jobs/{jobId}": { + "get": { + "summary": "Get training status", + "description": "Gets the status for a training job.", + "operationId": "GetTrainingStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The training job result.", + "schema": { + "$ref": "#/definitions/TrainingJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "summary": "Cancel training", + "description": "Triggers a cancelation for a running training job.", + "operationId": "CancelTrainingJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "The job was succesfully canceled." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/global/deletion-jobs/{jobId}": { + "get": { + "summary": "Get project deletion status", + "description": "Gets the status for a project deletion job.", + "operationId": "GetProjectDeletionStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The project deletion job result.", + "schema": { + "$ref": "#/definitions/ProjectDeletionJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/global/languages": { + "get": { + "summary": "List supported languages", + "description": "Lists the supported languages.", + "operationId": "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/SupportedLanguages" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/global/training-config-versions": { + "get": { + "summary": "List training config versions", + "description": "Lists the support training config version for a given project type.", + "operationId": "ListTrainingConfigVersions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ProjectKindInQuery" + }, + { + "$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/TrainingConfigVersions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + } + }, + "definitions": { + "ConfusionMatrix": { + "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" + } + } + }, + "CreateDeploymentOptions": { + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "Represents the trained model label.", + "type": "string" + } + } + }, + "CreateProjectOptions": { + "required": [ + "projectKind", + "storageInputContainerName", + "settings", + "projectName", + "language" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Gets or sets the new project model kind.", + "$ref": "#/definitions/ProjectKind" + }, + "storageInputContainerName": { + "description": "Gets or sets the storage container name.", + "type": "string" + }, + "settings": { + "description": "Gets or sets the project settings.", + "$ref": "#/definitions/ProjectSettings" + }, + "projectName": { + "description": "Gets or sets the new project name.", + "type": "string" + }, + "multilingual": { + "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "type": "boolean" + }, + "description": { + "description": "Gets or sets the new project description.", + "type": "string" + }, + "language": { + "description": "Gets or sets the project language.", + "type": "string" + } + } + }, + "CustomMultiLabelClassificationDocumentEvaluationPrediction": { + "required": [ + "customMultiLabelClassificationResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DocumentEvaluationResult" + } + ], + "properties": { + "customMultiLabelClassificationResult": { + "description": "Represents the evaluation prediction for multi label classification.", + "$ref": "#/definitions/DocumentMultiLabelClassificationEvaluationResult" + } + }, + "x-ms-discriminator-value": "customMultiLabelClassification" + }, + "CustomMultiLabelClassificationEvaluationSummary": { + "required": [ + "customMultiLabelClassificationEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EvaluationSummary" + } + ], + "properties": { + "customMultiLabelClassificationEvaluation": { + "description": "Contains the data related to multi label classification evaluation.", + "$ref": "#/definitions/MultiLabelClassificationEvaluationSummary" + } + }, + "x-ms-discriminator-value": "customMultiLabelClassification" + }, + "CustomNamedEntityRecognitionDocumentEvaluationPrediction": { + "required": [ + "customNamedEntityRecognitionResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DocumentEvaluationResult" + } + ], + "properties": { + "customNamedEntityRecognitionResult": { + "description": "Represents the evaluation prediction for named entity recognition.", + "$ref": "#/definitions/DocumentNamedEntityRecognitionEvaluationResult" + } + }, + "x-ms-discriminator-value": "customNamedEntityRecognition" + }, + "CustomNamedEntityRecognitionEvaluationSummary": { + "required": [ + "customNamedEntityRecognitionEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EvaluationSummary" + } + ], + "properties": { + "customNamedEntityRecognitionEvaluation": { + "description": "Contains the data related to extraction evaluation.", + "$ref": "#/definitions/NamedEntityRecognitionEvaluationSummary" + } + }, + "x-ms-discriminator-value": "customNamedEntityRecognition" + }, + "CustomSingleLabelClassificationDocumentEvaluationPrediction": { + "required": [ + "customSingleLabelClassificationResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DocumentEvaluationResult" + } + ], + "properties": { + "customSingleLabelClassificationResult": { + "description": "Represents the evaluation prediction for single label classification.", + "$ref": "#/definitions/DocumentSingleLabelClassificationEvaluationResult" + } + }, + "x-ms-discriminator-value": "customSingleLabelClassification" + }, + "CustomSingleLabelClassificationEvaluationSummary": { + "required": [ + "customSingleLabelClassificationEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EvaluationSummary" + } + ], + "properties": { + "customSingleLabelClassificationEvaluation": { + "description": "Contains the data related to single label classification evaluation.", + "$ref": "#/definitions/SingleLabelClassificationEvaluationSummary" + } + }, + "x-ms-discriminator-value": "customSingleLabelClassification" + }, + "DeploymentJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "DocumentEntityLabelEvaluationResult": { + "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" + } + } + }, + "DocumentEntityRegionEvaluationResult": { + "required": [ + "expectedEntities", + "actualEntities", + "regionOffset", + "regionLength" + ], + "type": "object", + "properties": { + "expectedEntities": { + "description": "Represents the region's labeled entities.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentEntityLabelEvaluationResult" + } + }, + "actualEntities": { + "description": "Represents the region's predicted entities.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentEntityLabelEvaluationResult" + } + }, + "regionOffset": { + "format": "int32", + "description": "Represents the region offset.", + "type": "integer" + }, + "regionLength": { + "format": "int32", + "description": "Represents the region length.", + "type": "integer" + } + } + }, + "DocumentEvaluationResult": { + "required": [ + "location", + "language", + "projectKind" + ], + "type": "object", + "properties": { + "location": { + "description": "Represents the document path.", + "type": "string" + }, + "language": { + "description": "Represents the document language.", + "type": "string" + }, + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ProjectKind" + } + }, + "discriminator": "projectKind" + }, + "DocumentMultiLabelClassificationEvaluationResult": { + "required": [ + "expectedClasses", + "actualClasses" + ], + "type": "object", + "properties": { + "expectedClasses": { + "description": "Represents the document's labeled classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "actualClasses": { + "description": "Represents the document's predicted classes.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DocumentNamedEntityRecognitionEvaluationResult": { + "required": [ + "entities" + ], + "type": "object", + "properties": { + "entities": { + "description": "Represents the document labelled entities.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentEntityRegionEvaluationResult" + } + } + } + }, + "DocumentSingleLabelClassificationEvaluationResult": { + "required": [ + "expectedClass", + "actualClass" + ], + "type": "object", + "properties": { + "expectedClass": { + "description": "Represents the document's labeled class.", + "type": "string" + }, + "actualClass": { + "description": "Represents the document's predicted class.", + "type": "string" + } + } + }, + "EntityEvaluationSummary": { + "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" + } + } + }, + "Error": { + "description": "Represents the definition of the error that occurred.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "target": { + "description": "The target that caused the error, if applicable.", + "type": "string" + }, + "details": { + "description": "An array of details about specific errors that led to this reported error.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ErrorCode": { + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Forbidden", + "NotFound", + "Unauthorized", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning", + "InternalServerError" + ], + "type": "string", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + } + }, + "ErrorResponse": { + "description": "Represents the error that occurred.", + "required": [ + "error" + ], + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/Error" + } + } + }, + "EvaluationKind": { + "enum": [ + "percentage", + "manual" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true + } + }, + "EvaluationOptions": { + "type": "object", + "properties": { + "kind": { + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", + "$ref": "#/definitions/EvaluationKind" + }, + "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" + } + } + }, + "EvaluationResults": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the documents predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentEvaluationResult" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "EvaluationSummary": { + "required": [ + "projectKind", + "customNamedEntityRecognitionEvaluation", + "evaluationOptions" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the model kind.", + "$ref": "#/definitions/ProjectKind" + }, + "customNamedEntityRecognitionEvaluation": { + "description": "Contains the data related to extraction evaluation.", + "$ref": "#/definitions/NamedEntityRecognitionEvaluationSummary" + }, + "evaluationOptions": { + "$ref": "#/definitions/EvaluationOptions" + } + }, + "discriminator": "projectKind" + }, + "ExportedClass": { + "type": "object", + "properties": { + "category": { + "type": "string" + } + } + }, + "ExportedCustomMultiLabelClassificationDocument": { + "type": "object", + "properties": { + "classes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedDocumentClass" + } + }, + "location": { + "type": "string" + }, + "language": { + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + } + }, + "ExportedCustomMultiLabelClassificationProjectAssets": { + "type": "object", + "properties": { + "classes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedClass" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedCustomMultiLabelClassificationDocument" + } + } + } + }, + "ExportedCustomNamedEntityRecognitionDocument": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedDocumentRegion" + } + }, + "location": { + "type": "string" + }, + "language": { + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + } + }, + "ExportedCustomNamedEntityRecognitionProjectAssets": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedEntity" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedCustomNamedEntityRecognitionDocument" + } + } + } + }, + "ExportedCustomSingleLabelClassificationDocument": { + "type": "object", + "properties": { + "class": { + "$ref": "#/definitions/ExportedDocumentClass" + }, + "location": { + "type": "string" + }, + "language": { + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + } + }, + "ExportedCustomSingleLabelClassificationProjectAssets": { + "type": "object", + "properties": { + "classes": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedClass" + } + }, + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedCustomSingleLabelClassificationDocument" + } + } + } + }, + "ExportedDocument": { + "required": [ + "api-version", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "api-version": { + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/StringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/CreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/ExportedProjectAssets" + } + } + }, + "ExportedDocumentClass": { + "type": "object", + "properties": { + "category": { + "type": "string" + } + } + }, + "ExportedDocumentEntityLabel": { + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "offset": { + "format": "int32", + "type": "integer" + }, + "length": { + "format": "int32", + "type": "integer" + } + } + }, + "ExportedDocumentRegion": { + "type": "object", + "properties": { + "regionOffset": { + "format": "int32", + "type": "integer" + }, + "regionLength": { + "format": "int32", + "type": "integer" + }, + "labels": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedDocumentEntityLabel" + } + } + } + }, + "ExportedEntity": { + "type": "object", + "properties": { + "category": { + "type": "string" + } + } + }, + "ExportedProjectAssets": { + "type": "object", + "properties": { + "projectKind": { + "$ref": "#/definitions/ProjectKind" + } + }, + "discriminator": "projectKind" + }, + "ExportProjectJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "resultUrl": { + "type": "string" + }, + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ImportProjectJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "JobStatus": { + "enum": [ + "unknown", + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "MultiLabelClassEvaluationSummary": { + "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" + } + } + }, + "MultiLabelClassificationEvaluationSummary": { + "required": [ + "classes", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "classes": { + "description": "Represents the classes evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MultiLabelClassEvaluationSummary" + } + }, + "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" + } + } + }, + "NamedEntityRecognitionEvaluationSummary": { + "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)\n the matrix is between the actual entity that was labelled and the entity that was predicted.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConfusionMatrix" + } + } + }, + "entities": { + "description": "Represents the entities evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EntityEvaluationSummary" + } + }, + "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" + } + } + }, + "ProjectDeletionJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + }, + "ProjectDeployment": { + "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-time", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents model training config version.", + "type": "string" + } + } + }, + "ProjectDeployments": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/ProjectDeployment" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "ProjectKind": { + "enum": [ + "customSingleLabelClassification", + "customMultiLabelClassification", + "customNamedEntityRecognition" + ], + "type": "string", + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true + } + }, + "ProjectMetadata": { + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "lastTrainedDateTime", + "lastDeployedDateTime", + "projectKind", + "storageInputContainerName", + "settings", + "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": "Gets or sets the new project model kind.", + "$ref": "#/definitions/ProjectKind" + }, + "storageInputContainerName": { + "description": "Gets or sets the storage container name.", + "type": "string" + }, + "settings": { + "description": "Gets or sets the project settings.", + "$ref": "#/definitions/ProjectSettings" + }, + "projectName": { + "description": "Gets or sets the new project name.", + "type": "string" + }, + "multilingual": { + "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "type": "boolean" + }, + "description": { + "description": "Gets or sets the new project description.", + "type": "string" + }, + "language": { + "description": "Gets or sets the project language.", + "type": "string" + } + } + }, + "ProjectSettings": { + "type": "object" + }, + "ProjectsMetadata": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the projects.", + "type": "array", + "items": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "ProjectTrainedModel": { + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "label": { + "description": "Represents trained model label.", + "type": "string" + }, + "modelId": { + "description": "Represents the ID of this model. The model ID has the format \"{version}-{yyyyMMddThhmmss}-{Guid.NewGuid()}\".", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents trained model last trained time.", + "type": "string" + }, + "lastTrainingDurationInSeconds": { + "format": "int32", + "description": "Represents trained model last training duration in seconds.", + "type": "integer" + }, + "modelExpirationDate": { + "format": "date-time", + "description": "Represents model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents the model training config version.", + "type": "string" + } + } + }, + "ProjectTrainedModels": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/ProjectTrainedModel" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "SingleLabelClassEvaluationSummary": { + "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" + } + } + }, + "SingleLabelClassificationEvaluationSummary": { + "required": [ + "confusionMatrix", + "classes", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two classifiers (the two classifiers can be the same entity)\n the matrix is between the actual classifier that was labelled and the classifier that was predicted.", + "type": "object", + "additionalProperties": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConfusionMatrix" + } + } + }, + "classes": { + "description": "Represents the classes evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/SingleLabelClassEvaluationSummary" + } + }, + "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" + } + } + }, + "StringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true + } + }, + "SubTrainingJobState": { + "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 job.", + "$ref": "#/definitions/JobStatus" + } + } + }, + "SupportedLanguage": { + "required": [ + "languageName", + "languageCode" + ], + "type": "object", + "properties": { + "languageName": { + "description": "Gets or sets the language name.", + "type": "string" + }, + "languageCode": { + "description": "Gets or sets the language code.", + "type": "string" + } + } + }, + "SupportedLanguages": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of supported objects.", + "type": "array", + "items": { + "$ref": "#/definitions/SupportedLanguage" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string" + } + } + }, + "SwapDeploymentsOptions": { + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ], + "type": "object", + "properties": { + "firstDeploymentName": { + "description": "Represents the first deployment name.", + "type": "string" + }, + "secondDeploymentName": { + "description": "Represents the second deployment name.", + "type": "string" + } + } + }, + "TrainingConfigVersion": { + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ], + "type": "object", + "properties": { + "trainingConfigVersion": { + "description": "Represents the training config version.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date-time", + "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", + "type": "string" + } + } + }, + "TrainingConfigVersions": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the training config versions.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingConfigVersion" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "TrainingJobOptions": { + "required": [ + "modelLabel", + "trainingConfigVersion" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents training 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/EvaluationOptions" + } + } + }, + "TrainingJobResult": { + "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/SubTrainingJobState" + }, + "evaluationStatus": { + "description": "Represents model evaluation status.", + "$ref": "#/definitions/SubTrainingJobState" + }, + "estimatedEndDateTime": { + "format": "date-time", + "description": "Represents the estimate end date time for training and evaluation.", + "type": "string" + } + } + }, + "TrainingJobs": { + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "Gets or sets the jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/TrainingJobState" + } + }, + "nextLink": { + "description": "Gets or sets the next page link.", + "type": "string" + } + } + }, + "TrainingJobState": { + "required": [ + "result", + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "result": { + "description": "Represents training tasks detailed result.", + "$ref": "#/definitions/TrainingJobResult" + }, + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/JobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "StringIndexTypeInQuery": { + "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 + }, + "x-ms-parameter-location": "method" + }, + "ProjectKindInQuery": { + "in": "query", + "name": "projectKind", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "customSingleLabelClassification", + "customMultiLabelClassification", + "customNamedEntityRecognition" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + } +} \ No newline at end of file From e87cd8805dc0b69ca1046bf28cefdc9035cd78fa Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Fri, 15 Apr 2022 19:01:51 +0200 Subject: [PATCH 02/24] Some build fixes --- .../data-plane/Language/readme.md | 4 +- ...n => conversationalanalysisauthoring.json} | 52 +++++++++---------- ...uthoring.json => customtextauthoring.json} | 46 ++++++++-------- 3 files changed, 47 insertions(+), 55 deletions(-) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/{ConversationalAnalysis-authoring.json => conversationalanalysisauthoring.json} (98%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/{CustomText-Authoring.json => customtextauthoring.json} (98%) diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index e7c8492fa7ae..b738bb457396 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -29,8 +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/CustomText-Authoring.json - - stable/2022-05-01/ConversationalAnalysis-authoring.json + - stable/2022-05-01/customtextauthoring.json + - stable/2022-05-01/conversationalanalysisauthoring.json title: Microsoft Cognitive Language Service modelerfour: diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 7bac1d5cec80..f120eb334b46 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/ConversationalAnalysis-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1,30 +1,32 @@ { "swagger": "2.0", "info": { - "title": "Language - Conversational Language Understanding Authoring APIs (2022-05-01)", + "title": "Language - Conversational Language Understanding Authoring", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", "version": "2022-05-01" }, - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language/authoring/analyze-conversations/projects", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, "securityDefinitions": { - "apiKeyHeader": { + "apim_key": { "type": "apiKey", + "description": "A subscription key for a Language service resource.", "name": "Ocp-Apim-Subscription-Key", "in": "header" } }, "security": [ { - "apiKeyHeader": [] + "apim_key": [] } ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language/authoring/analyze-conversations/projects", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, "paths": { "/": { "get": { @@ -1040,7 +1042,7 @@ "/{projectName}/train/jobs/{jobId}/:cancel": { "post": { "summary": "Cancel training", - "description": "Triggers a cancelation for a running training job.", + "description": "Triggers a cancellation for a running training job.", "operationId": "CancelTrainingJob", "produces": [ "application/json" @@ -1062,7 +1064,7 @@ ], "responses": { "204": { - "description": "The job was succesfully canceled." + "description": "The job was successfully canceled." }, "default": { "description": "Error response.", @@ -1268,7 +1270,7 @@ "modelAsString": true } }, - "ConfusionMatrix": { + "ConfusionMatrixEntry": { "required": [ "normalizedValue", "rawValue" @@ -1402,7 +1404,7 @@ "additionalProperties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/ConfusionMatrix" + "$ref": "#/definitions/ConfusionMatrixEntry" } } }, @@ -1769,6 +1771,9 @@ "x-ms-discriminator-value": "luis" }, "ExportedOrchestrationOptions": { + "required": [ + "kind" + ], "type": "object", "properties": { "kind": { @@ -2093,7 +2098,7 @@ "additionalProperties": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/ConfusionMatrix" + "$ref": "#/definitions/ConfusionMatrixEntry" } } }, @@ -2434,7 +2439,7 @@ "type": "string" }, "modelId": { - "description": "Represents the ID of this model. The model ID has the format \"{version}-{yyyyMMddThhmmss}-{Guid.NewGuid()}\".", + "description": "Represents the ID of this model.", "type": "string" }, "lastTrainedDateTime": { @@ -2846,15 +2851,6 @@ } }, "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, "FormatInQuery": { "in": "query", "name": "format", @@ -2902,4 +2898,4 @@ "x-ms-parameter-location": "method" } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 3927ff2db5a4..117d9ea1d790 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/CustomText-Authoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1,30 +1,32 @@ { "swagger": "2.0", "info": { - "title": "Language - Custom Text Authoring APIs (2022-05-01)", + "title": "Language - Text Analysis Authoring", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", "version": "2022-05-01" }, - "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language/authoring/analyze-text/projects", - "useSchemePrefix": false, - "parameters": [ - { - "$ref": "#/parameters/Endpoint" - } - ] - }, "securityDefinitions": { - "apiKeyHeader": { + "apim_key": { "type": "apiKey", + "description": "A subscription key for a Language service resource.", "name": "Ocp-Apim-Subscription-Key", "in": "header" } }, "security": [ { - "apiKeyHeader": [] + "apim_key": [] } ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language/authoring/analyze-text/projects", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, "paths": { "/": { "get": { @@ -1040,7 +1042,7 @@ "/{projectName}/train/jobs/{jobId}/:cancel": { "post": { "summary": "Cancel training", - "description": "Triggers a cancelation for a running training job.", + "description": "Triggers a cancellation for a running training job.", "operationId": "CancelTrainingJob", "produces": [ "application/json" @@ -1062,7 +1064,7 @@ ], "responses": { "204": { - "description": "The job was succesfully canceled." + "description": "The job was successfully canceled." }, "default": { "description": "Error response.", @@ -1940,6 +1942,9 @@ } }, "ExportedProjectAssets": { + "required": [ + "projectKind" + ], "type": "object", "properties": { "projectKind": { @@ -2452,7 +2457,7 @@ "type": "string" }, "modelId": { - "description": "Represents the ID of this model. The model ID has the format \"{version}-{yyyyMMddThhmmss}-{Guid.NewGuid()}\".", + "description": "Represents the ID of this model.", "type": "string" }, "lastTrainedDateTime": { @@ -2865,15 +2870,6 @@ } }, "parameters": { - "Endpoint": { - "name": "Endpoint", - "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", - "x-ms-parameter-location": "client", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, "StringIndexTypeInQuery": { "in": "query", "name": "stringIndexType", @@ -2907,4 +2903,4 @@ "x-ms-parameter-location": "method" } } -} \ No newline at end of file +} From b1497077f837de52093691d104d59840c3f07c16 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Fri, 15 Apr 2022 19:54:53 +0200 Subject: [PATCH 03/24] Add polymerphism for CLU exported project --- .../conversationalanalysisauthoring.json | 240 ++++++++++++------ 1 file changed, 157 insertions(+), 83 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index f120eb334b46..213e3684b270 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1289,6 +1289,97 @@ } } }, + "ConversationExportedEntity": { + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "type": "string" + }, + "compositionSetting": { + "$ref": "#/definitions/CompositionSetting" + }, + "list": { + "$ref": "#/definitions/ExportedEntityList" + }, + "prebuilts": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedPrebuiltEntity" + } + } + } + }, + "ConversationExportedIntent": { + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "type": "string" + } + } + }, + "ConversationExportedProjectAssets": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedProjectAssets" + } + ], + "properties": { + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/ConversationExportedIntent" + } + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/ConversationExportedEntity" + } + }, + "utterances": { + "type": "array", + "items": { + "$ref": "#/definitions/ConversationExportedUtterance" + } + } + }, + "x-ms-discriminator-value": "conversation" + }, + "ConversationExportedUtterance": { + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/ExportedUtteranceEntityLabel" + } + }, + "text": { + "type": "string" + }, + "language": { + "type": "string" + }, + "intent": { + "type": "string" + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + } + }, "CreateDeploymentOptions": { "required": [ "trainedModelLabel" @@ -1658,29 +1749,6 @@ }, "x-ms-discriminator-value": "clu" }, - "ExportedEntity": { - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "type": "string" - }, - "compositionSetting": { - "$ref": "#/definitions/CompositionSetting" - }, - "list": { - "$ref": "#/definitions/ExportedEntityList" - }, - "prebuilts": { - "type": "array", - "items": { - "$ref": "#/definitions/ExportedPrebuiltEntity" - } - } - } - }, "ExportedEntityList": { "type": "object", "properties": { @@ -1720,20 +1788,6 @@ } } }, - "ExportedIntent": { - "required": [ - "category" - ], - "type": "object", - "properties": { - "category": { - "type": "string" - }, - "orchestration": { - "$ref": "#/definitions/ExportedOrchestrationOptions" - } - } - }, "ExportedLuisOrchestration": { "required": [ "appId" @@ -1819,27 +1873,16 @@ } }, "ExportedProjectAssets": { + "required": [ + "projectKind" + ], "type": "object", "properties": { - "intents": { - "type": "array", - "items": { - "$ref": "#/definitions/ExportedIntent" - } - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/ExportedEntity" - } - }, - "utterances": { - "type": "array", - "items": { - "$ref": "#/definitions/ExportedUtterance" - } + "projectKind": { + "$ref": "#/definitions/ProjectKind" } - } + }, + "discriminator": "projectKind" }, "ExportedProjectFormat": { "enum": [ @@ -1880,34 +1923,6 @@ }, "x-ms-discriminator-value": "qna" }, - "ExportedUtterance": { - "required": [ - "text", - "intent" - ], - "type": "object", - "properties": { - "text": { - "type": "string" - }, - "language": { - "type": "string" - }, - "intent": { - "type": "string" - }, - "entities": { - "type": "array", - "items": { - "$ref": "#/definitions/ExportedUtteranceEntityLabel" - } - }, - "dataset": { - "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", - "type": "string" - } - } - }, "ExportedUtteranceEntityLabel": { "required": [ "category", @@ -2158,6 +2173,65 @@ "modelAsString": true } }, + "OrchestrationExportedIntent": { + "required": [ + "category" + ], + "type": "object", + "properties": { + "orchestration": { + "$ref": "#/definitions/ExportedOrchestrationOptions" + }, + "category": { + "type": "string" + } + } + }, + "OrchestrationExportedProjectAssets": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedProjectAssets" + } + ], + "properties": { + "intents": { + "type": "array", + "items": { + "$ref": "#/definitions/OrchestrationExportedIntent" + } + }, + "utterances": { + "type": "array", + "items": { + "$ref": "#/definitions/OrchestrationExportedUtterance" + } + } + }, + "x-ms-discriminator-value": "orchestration" + }, + "OrchestrationExportedUtterance": { + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "text": { + "type": "string" + }, + "language": { + "type": "string" + }, + "intent": { + "type": "string" + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + } + }, "OrchestrationKind": { "enum": [ "luis", From 31a88a0a1f215ca2ebbc19fcd4a1fda8bad8ba15 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Fri, 15 Apr 2022 19:58:23 +0200 Subject: [PATCH 04/24] Rename the api-version property in the import body --- .../stable/2022-05-01/conversationalanalysisauthoring.json | 4 ++-- .../Language/stable/2022-05-01/customtextauthoring.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 213e3684b270..560549407d4b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1849,13 +1849,13 @@ }, "ExportedProject": { "required": [ - "api-version", + "project-file-version", "stringIndexType", "metadata" ], "type": "object", "properties": { - "api-version": { + "project-file-version": { "type": "string" }, "stringIndexType": { diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 117d9ea1d790..c865ae9c8fb7 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1867,13 +1867,13 @@ }, "ExportedDocument": { "required": [ - "api-version", + "project-file-version", "stringIndexType", "metadata" ], "type": "object", "properties": { - "api-version": { + "project-file-version": { "type": "string" }, "stringIndexType": { From 1c7e8bd5c0de27f88174f3ffb84ca59628596eb8 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sat, 16 Apr 2022 06:50:37 +0200 Subject: [PATCH 05/24] Retrigger CI From 278318b7ee8020173c05195f005c1c2a28caf302 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sat, 16 Apr 2022 07:28:46 +0200 Subject: [PATCH 06/24] Update the hostTemplate and the operation Ids --- .../conversationalanalysisauthoring.json | 108 +++++++++--------- .../2022-05-01/customtextauthoring.json | 104 ++++++++--------- 2 files changed, 106 insertions(+), 106 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 560549407d4b..1dc90f335716 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -19,7 +19,7 @@ } ], "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language/authoring/analyze-conversations/projects", + "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { @@ -28,11 +28,11 @@ ] }, "paths": { - "/": { + "/authoring/analyze-conversations/projects": { "get": { "summary": "List projects", "description": "Lists the existing projects.", - "operationId": "ListProjects", + "operationId": "ConversationalAnalysisAuthoring_ListProjects", "produces": [ "application/json" ], @@ -70,11 +70,11 @@ } } }, - "/{projectName}": { + "/authoring/analyze-conversations/projects/{projectName}": { "patch": { "summary": "Create project", "description": "Creates a new project or updates an existing one.", - "operationId": "CreateProject", + "operationId": "ConversationalAnalysisAuthoring_CreateProject", "consumes": [ "application/merge-patch+json" ], @@ -122,7 +122,7 @@ "get": { "summary": "Get project details", "description": "Gets the details of a project.", - "operationId": "GetProject", + "operationId": "ConversationalAnalysisAuthoring_GetProject", "produces": [ "application/json" ], @@ -152,7 +152,7 @@ "delete": { "summary": "Delete project", "description": "Deletes a project.", - "operationId": "DeleteProject", + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", "produces": [ "application/json" ], @@ -184,11 +184,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/:export": { + "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { "summary": "Export project", "description": "Triggers a job to export a project's data.", - "operationId": "Export", + "operationId": "ConversationalAnalysisAuthoring_Export", "produces": [ "application/json" ], @@ -232,11 +232,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/:import": { + "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { "summary": "Import project", "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": "Import", + "operationId": "ConversationalAnalysisAuthoring_Import", "consumes": [ "application/json" ], @@ -283,11 +283,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/:train": { + "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { "summary": "Train project", "description": "Triggers a training job for a project.", - "operationId": "Train", + "operationId": "ConversationalAnalysisAuthoring_Train", "consumes": [ "application/json" ], @@ -331,11 +331,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/deployments": { + "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { "summary": "List deployments", "description": "Lists the deployments belonging to a project.", - "operationId": "ListDeployments", + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", "produces": [ "application/json" ], @@ -376,11 +376,11 @@ } } }, - "/{projectName}/deployments/:swap": { + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { "post": { "summary": "Swap deployments", "description": "Swaps two existing deployments with each other.", - "operationId": "SwapDeployments", + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", "consumes": [ "application/json" ], @@ -424,11 +424,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/deployments/{deploymentName}": { + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { "summary": "Get deployment details", "description": "Gets the details of a deployment.", - "operationId": "GetDeployment", + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", "produces": [ "application/json" ], @@ -461,7 +461,7 @@ "put": { "summary": "Update deployment", "description": "Creates a new deployment or replaces an existing one.", - "operationId": "DeployProject", + "operationId": "ConversationalAnalysisAuthoring_DeployProject", "consumes": [ "application/json" ], @@ -510,7 +510,7 @@ "delete": { "summary": "Delete deployment", "description": "Deletes a project deployment.", - "operationId": "DeleteDeployment", + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", "produces": [ "application/json" ], @@ -545,11 +545,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { "summary": "Get deployment status", "description": "Gets the status of an existing deployment job.", - "operationId": "GetDeploymentStatus", + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", "produces": [ "application/json" ], @@ -587,11 +587,11 @@ } } }, - "/{projectName}/deployments/swap/jobs/{jobId}": { + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { "summary": "Gets swap deployments status", "description": "Gets the status of an existing swap deployment job.", - "operationId": "GetSwapDeploymentsStatus", + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", "produces": [ "application/json" ], @@ -626,11 +626,11 @@ } } }, - "/{projectName}/export/jobs/{jobId}": { + "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { "summary": "Get export status", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "GetExportStatus", + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", "produces": [ "application/json" ], @@ -665,11 +665,11 @@ } } }, - "/{projectName}/export/jobs/{jobId}/result": { + "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}/result": { "get": { "summary": "Get export result", "description": "Gets the result of an export job.", - "operationId": "GetExportResult", + "operationId": "ConversationalAnalysisAuthoring_GetExportResult", "produces": [ "application/json" ], @@ -704,11 +704,11 @@ } } }, - "/{projectName}/import/jobs/{jobId}": { + "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { "summary": "Get import status", "description": "Gets the status for an import.", - "operationId": "GetImportStatus", + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", "produces": [ "application/json" ], @@ -743,11 +743,11 @@ } } }, - "/{projectName}/models": { + "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { "summary": "List trained models", "description": "Lists the trained models belonging to a project.", - "operationId": "ListTrainedModels", + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", "produces": [ "application/json" ], @@ -788,11 +788,11 @@ } } }, - "/{projectName}/models/{trainedModelLabel}": { + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { "summary": "Get trained model details", "description": "Gets the details of a trained model.", - "operationId": "GetTrainedModel", + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", "produces": [ "application/json" ], @@ -829,7 +829,7 @@ "delete": { "summary": "Delete trained model", "description": "Deletes an existing trained model.", - "operationId": "DeleteTrainedModel", + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", "produces": [ "application/json" ], @@ -861,11 +861,11 @@ } } }, - "/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { "summary": "Get trained model evaluation result", "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": "GetModelEvaluationResults", + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", "produces": [ "application/json" ], @@ -916,11 +916,11 @@ } } }, - "/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { "summary": "Get trained model evaluation summary", "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": "GetModelEvaluationSummary", + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", "produces": [ "application/json" ], @@ -955,11 +955,11 @@ } } }, - "/{projectName}/train/jobs": { + "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { "summary": "List training jobs", "description": "Lists the non-expired training jobs created for a project.", - "operationId": "ListTrainingJobs", + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", "produces": [ "application/json" ], @@ -1000,11 +1000,11 @@ } } }, - "/{projectName}/train/jobs/{jobId}": { + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { "summary": "Get training status", "description": "Gets the status for a training job.", - "operationId": "GetTrainingStatus", + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", "produces": [ "application/json" ], @@ -1039,11 +1039,11 @@ } } }, - "/{projectName}/train/jobs/{jobId}/:cancel": { + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { "summary": "Cancel training", "description": "Triggers a cancellation for a running training job.", - "operationId": "CancelTrainingJob", + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", "produces": [ "application/json" ], @@ -1075,11 +1075,11 @@ } } }, - "/global/deletion-jobs/{jobId}": { + "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { "summary": "Get project deletion status", "description": "Gets the status for a project deletion job.", - "operationId": "GetProjectDeletionStatus", + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", "produces": [ "application/json" ], @@ -1111,11 +1111,11 @@ } } }, - "/global/languages": { + "/authoring/analyze-conversations/projects/global/languages": { "get": { "summary": "List supported languages", "description": "Lists the supported languages for the given project type.", - "operationId": "GetSupportedLanguages", + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", "produces": [ "application/json" ], @@ -1156,11 +1156,11 @@ } } }, - "/global/prebuilt-entities": { + "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { "summary": "List supported prebuilt entities", "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", - "operationId": "GetSupportedPrebuiltEntities", + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", "produces": [ "application/json" ], @@ -1210,11 +1210,11 @@ } } }, - "/global/training-config-versions": { + "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { "summary": "List training config versions", "description": "Lists the support training config version for a given project type.", - "operationId": "ListTrainingConfigVersions", + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", "produces": [ "application/json" ], diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index c865ae9c8fb7..bbc0e0f663a4 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -19,7 +19,7 @@ } ], "x-ms-parameterized-host": { - "hostTemplate": "{Endpoint}/language/authoring/analyze-text/projects", + "hostTemplate": "{Endpoint}/language", "useSchemePrefix": false, "parameters": [ { @@ -28,11 +28,11 @@ ] }, "paths": { - "/": { + "/authoring/analyze-text/projects": { "get": { "summary": "List projects", "description": "Lists the existing projects.", - "operationId": "ListProjects", + "operationId": "TextAnalysisAuthoring_ListProjects", "produces": [ "application/json" ], @@ -70,11 +70,11 @@ } } }, - "/{projectName}": { + "/authoring/analyze-text/projects/{projectName}": { "patch": { "summary": "Create project", "description": "Creates a new project or updates an existing one.", - "operationId": "CreateProject", + "operationId": "TextAnalysisAuthoring_CreateProject", "consumes": [ "application/merge-patch+json" ], @@ -122,7 +122,7 @@ "get": { "summary": "Get project details", "description": "Gets the details of a project.", - "operationId": "GetProject", + "operationId": "TextAnalysisAuthoring_GetProject", "produces": [ "application/json" ], @@ -152,7 +152,7 @@ "delete": { "summary": "Delete project", "description": "Deletes a project.", - "operationId": "DeleteProject", + "operationId": "TextAnalysisAuthoring_DeleteProject", "produces": [ "application/json" ], @@ -184,11 +184,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/:export": { + "/authoring/analyze-text/projects/{projectName}/:export": { "post": { "summary": "Export project", "description": "Triggers a job to export a project's data.", - "operationId": "Export", + "operationId": "TextAnalysisAuthoring_Export", "produces": [ "application/json" ], @@ -235,11 +235,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/:import": { + "/authoring/analyze-text/projects/{projectName}/:import": { "post": { "summary": "Import project", "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": "Import", + "operationId": "TextAnalysisAuthoring_Import", "consumes": [ "application/json" ], @@ -283,11 +283,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/:train": { + "/authoring/analyze-text/projects/{projectName}/:train": { "post": { "summary": "Train project", "description": "Triggers a training job for a project.", - "operationId": "Train", + "operationId": "TextAnalysisAuthoring_Train", "consumes": [ "application/json" ], @@ -331,11 +331,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/deployments": { + "/authoring/analyze-text/projects/{projectName}/deployments": { "get": { "summary": "List deployments", "description": "Lists the deployments belonging to a project.", - "operationId": "ListDeployments", + "operationId": "TextAnalysisAuthoring_ListDeployments", "produces": [ "application/json" ], @@ -376,11 +376,11 @@ } } }, - "/{projectName}/deployments/:swap": { + "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { "post": { "summary": "Swap deployments", "description": "Swaps two existing deployments with each other.", - "operationId": "SwapDeployments", + "operationId": "TextAnalysisAuthoring_SwapDeployments", "consumes": [ "application/json" ], @@ -424,11 +424,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/deployments/{deploymentName}": { + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { "get": { "summary": "Get deployment details", "description": "Gets the details of a deployment.", - "operationId": "GetDeployment", + "operationId": "TextAnalysisAuthoring_GetDeployment", "produces": [ "application/json" ], @@ -461,7 +461,7 @@ "put": { "summary": "Update deployment", "description": "Creates a new deployment or replaces an existing one.", - "operationId": "DeployProject", + "operationId": "TextAnalysisAuthoring_DeployProject", "consumes": [ "application/json" ], @@ -510,7 +510,7 @@ "delete": { "summary": "Delete deployment", "description": "Deletes a project deployment.", - "operationId": "DeleteDeployment", + "operationId": "TextAnalysisAuthoring_DeleteDeployment", "produces": [ "application/json" ], @@ -545,11 +545,11 @@ "x-ms-long-running-operation": true } }, - "/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { "summary": "Get deployment status", "description": "Gets the status of an existing deployment job.", - "operationId": "GetDeploymentStatus", + "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", "produces": [ "application/json" ], @@ -587,11 +587,11 @@ } } }, - "/{projectName}/deployments/swap/jobs/{jobId}": { + "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { "summary": "Gets swap deployments status", "description": "Gets the status of an existing swap deployment job.", - "operationId": "GetSwapDeploymentsStatus", + "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", "produces": [ "application/json" ], @@ -626,11 +626,11 @@ } } }, - "/{projectName}/export/jobs/{jobId}": { + "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { "get": { "summary": "Get export status", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", - "operationId": "GetExportStatus", + "operationId": "TextAnalysisAuthoring_GetExportStatus", "produces": [ "application/json" ], @@ -665,11 +665,11 @@ } } }, - "/{projectName}/export/jobs/{jobId}/result": { + "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}/result": { "get": { "summary": "Get export result", "description": "Gets the result of an export job.", - "operationId": "GetExportResult", + "operationId": "TextAnalysisAuthoring_GetExportResult", "produces": [ "application/json" ], @@ -704,11 +704,11 @@ } } }, - "/{projectName}/import/jobs/{jobId}": { + "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { "get": { "summary": "Get import status", "description": "Gets the status for an import.", - "operationId": "GetImportStatus", + "operationId": "TextAnalysisAuthoring_GetImportStatus", "produces": [ "application/json" ], @@ -743,11 +743,11 @@ } } }, - "/{projectName}/models": { + "/authoring/analyze-text/projects/{projectName}/models": { "get": { "summary": "List trained models", "description": "Lists the trained models belonging to a project.", - "operationId": "ListTrainedModels", + "operationId": "TextAnalysisAuthoring_ListTrainedModels", "produces": [ "application/json" ], @@ -788,11 +788,11 @@ } } }, - "/{projectName}/models/{trainedModelLabel}": { + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { "get": { "summary": "Get trained model details", "description": "Gets the details of a trained model.", - "operationId": "GetTrainedModel", + "operationId": "TextAnalysisAuthoring_GetTrainedModel", "produces": [ "application/json" ], @@ -829,7 +829,7 @@ "delete": { "summary": "Delete trained model", "description": "Deletes an existing trained model.", - "operationId": "DeleteTrainedModel", + "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", "produces": [ "application/json" ], @@ -861,11 +861,11 @@ } } }, - "/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { "summary": "Get trained model evaluation result", "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": "GetModelEvaluationResults", + "operationId": "TextAnalysisAuthoring_GetModelEvaluationResults", "produces": [ "application/json" ], @@ -916,11 +916,11 @@ } } }, - "/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { "summary": "Get trained model evaluation summary", "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": "GetModelEvaluationSummary", + "operationId": "TextAnalysisAuthoring_GetModelEvaluationSummary", "produces": [ "application/json" ], @@ -955,11 +955,11 @@ } } }, - "/{projectName}/train/jobs": { + "/authoring/analyze-text/projects/{projectName}/train/jobs": { "get": { "summary": "List training jobs", "description": "Lists the non-expired training jobs created for a project.", - "operationId": "ListTrainingJobs", + "operationId": "TextAnalysisAuthoring_ListTrainingJobs", "produces": [ "application/json" ], @@ -1000,11 +1000,11 @@ } } }, - "/{projectName}/train/jobs/{jobId}": { + "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { "get": { "summary": "Get training status", "description": "Gets the status for a training job.", - "operationId": "GetTrainingStatus", + "operationId": "TextAnalysisAuthoring_GetTrainingStatus", "produces": [ "application/json" ], @@ -1039,11 +1039,11 @@ } } }, - "/{projectName}/train/jobs/{jobId}/:cancel": { + "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { "summary": "Cancel training", "description": "Triggers a cancellation for a running training job.", - "operationId": "CancelTrainingJob", + "operationId": "TextAnalysisAuthoring_CancelTrainingJob", "produces": [ "application/json" ], @@ -1075,11 +1075,11 @@ } } }, - "/global/deletion-jobs/{jobId}": { + "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { "get": { "summary": "Get project deletion status", "description": "Gets the status for a project deletion job.", - "operationId": "GetProjectDeletionStatus", + "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", "produces": [ "application/json" ], @@ -1111,11 +1111,11 @@ } } }, - "/global/languages": { + "/authoring/analyze-text/projects/global/languages": { "get": { "summary": "List supported languages", "description": "Lists the supported languages.", - "operationId": "GetSupportedLanguages", + "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", "produces": [ "application/json" ], @@ -1153,11 +1153,11 @@ } } }, - "/global/training-config-versions": { + "/authoring/analyze-text/projects/global/training-config-versions": { "get": { "summary": "List training config versions", "description": "Lists the support training config version for a given project type.", - "operationId": "ListTrainingConfigVersions", + "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", "produces": [ "application/json" ], From c53ca8723d1eba0fe007ccb7ba551b83935c954b Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sat, 16 Apr 2022 19:56:59 +0200 Subject: [PATCH 07/24] Use the common error objects --- .../Language/stable/2022-05-01/common.json | 6 +- .../conversationalanalysisauthoring.json | 78 +++++++++---------- .../2022-05-01/customtextauthoring.json | 76 +++++++++--------- 3 files changed, 82 insertions(+), 78 deletions(-) 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/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 1dc90f335716..920a19f90d3b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -60,7 +60,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -114,7 +114,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -144,7 +144,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -177,7 +177,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -225,7 +225,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -276,7 +276,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -324,7 +324,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -366,7 +366,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -417,7 +417,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -453,7 +453,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -501,7 +501,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -538,7 +538,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -581,7 +581,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -620,7 +620,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -659,7 +659,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -698,7 +698,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -737,7 +737,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -778,7 +778,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -821,7 +821,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -855,7 +855,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -906,7 +906,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -949,7 +949,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -990,7 +990,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1033,7 +1033,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -1069,7 +1069,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -1105,7 +1105,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -1146,7 +1146,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1200,7 +1200,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1245,7 +1245,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1464,14 +1464,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -1984,14 +1984,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -2033,14 +2033,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -2323,14 +2323,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -2809,14 +2809,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index bbc0e0f663a4..ac321e857231 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -60,7 +60,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -114,7 +114,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -144,7 +144,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -177,7 +177,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -228,7 +228,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -276,7 +276,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -324,7 +324,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -366,7 +366,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -417,7 +417,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -453,7 +453,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -501,7 +501,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -538,7 +538,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -581,7 +581,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -620,7 +620,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -659,7 +659,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -698,7 +698,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -737,7 +737,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -778,7 +778,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -821,7 +821,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -855,7 +855,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -906,7 +906,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -949,7 +949,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -990,7 +990,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1033,7 +1033,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -1069,7 +1069,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -1105,7 +1105,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } } @@ -1143,7 +1143,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1188,7 +1188,7 @@ "default": { "description": "Error response.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "common.json#/definitions/ErrorResponse" } } }, @@ -1416,14 +1416,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -1993,14 +1993,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -2042,14 +2042,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -2270,14 +2270,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } @@ -2856,14 +2856,14 @@ "description": "Gets or sets the warnings.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } }, "errors": { "description": "Gets or sets the errors.", "type": "array", "items": { - "$ref": "#/definitions/Error" + "$ref": "common.json#/definitions/Error" } } } From 6762a71a710dd6f7abd22e915ec17e1aee76e248 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sat, 16 Apr 2022 20:05:36 +0200 Subject: [PATCH 08/24] Remove redundant definitions --- .../conversationalanalysisauthoring.json | 60 ------------------- .../2022-05-01/customtextauthoring.json | 60 ------------------- 2 files changed, 120 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 920a19f90d3b..bae40ac3af9c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1587,66 +1587,6 @@ } } }, - "Error": { - "description": "Represents the definition of the error that occurred.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target that caused the error, if applicable.", - "type": "string" - }, - "details": { - "description": "An array of details about specific errors that led to this reported error.", - "type": "array", - "items": { - "$ref": "#/definitions/Error" - } - } - } - }, - "ErrorCode": { - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Forbidden", - "NotFound", - "Unauthorized", - "Timeout", - "QuotaExceeded", - "Conflict", - "Warning", - "InternalServerError" - ], - "type": "string", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - } - }, - "ErrorResponse": { - "description": "Represents the error that occurred.", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/Error" - } - } - }, "EvaluationKind": { "enum": [ "percentage", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index ac321e857231..8fbdc1da86fb 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1614,66 +1614,6 @@ } } }, - "Error": { - "description": "Represents the definition of the error that occurred.", - "required": [ - "code", - "message" - ], - "type": "object", - "properties": { - "code": { - "description": "The error code.", - "$ref": "#/definitions/ErrorCode" - }, - "message": { - "description": "The error message.", - "type": "string" - }, - "target": { - "description": "The target that caused the error, if applicable.", - "type": "string" - }, - "details": { - "description": "An array of details about specific errors that led to this reported error.", - "type": "array", - "items": { - "$ref": "#/definitions/Error" - } - } - } - }, - "ErrorCode": { - "enum": [ - "InvalidRequest", - "InvalidArgument", - "Forbidden", - "NotFound", - "Unauthorized", - "Timeout", - "QuotaExceeded", - "Conflict", - "Warning", - "InternalServerError" - ], - "type": "string", - "x-ms-enum": { - "name": "ErrorCode", - "modelAsString": true - } - }, - "ErrorResponse": { - "description": "Represents the error that occurred.", - "required": [ - "error" - ], - "type": "object", - "properties": { - "error": { - "$ref": "#/definitions/Error" - } - } - }, "EvaluationKind": { "enum": [ "percentage", From 455762d0443452299df363472bedbbd621ef7612 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sat, 16 Apr 2022 20:56:03 +0200 Subject: [PATCH 09/24] Update the stringIndexType --- .../conversationalanalysisauthoring.json | 14 +++----------- .../stable/2022-05-01/customtextauthoring.json | 14 +++----------- 2 files changed, 6 insertions(+), 22 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index bae40ac3af9c..571bbb62c185 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1800,7 +1800,7 @@ }, "stringIndexType": { "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/StringIndexType" + "$ref": "common.json#/definitions/StringIndexType" }, "metadata": { "description": "Represents the project metadata.", @@ -2497,16 +2497,6 @@ } } }, - "StringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true - } - }, "SubTrainingJobState": { "required": [ "percentComplete", @@ -2887,6 +2877,8 @@ "required": true, "type": "string", "enum": [ + "TextElements_v8", + "UnicodeCodePoint", "Utf16CodeUnit" ], "x-ms-enum": { diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 8fbdc1da86fb..8c78bf77de08 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1818,7 +1818,7 @@ }, "stringIndexType": { "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/StringIndexType" + "$ref": "common.json#/definitions/StringIndexType" }, "metadata": { "description": "Represents the project metadata.", @@ -2552,16 +2552,6 @@ } } }, - "StringIndexType": { - "enum": [ - "Utf16CodeUnit" - ], - "type": "string", - "x-ms-enum": { - "name": "StringIndexType", - "modelAsString": true - } - }, "SubTrainingJobState": { "required": [ "percentComplete", @@ -2817,6 +2807,8 @@ "required": true, "type": "string", "enum": [ + "TextElements_v8", + "UnicodeCodePoint", "Utf16CodeUnit" ], "x-ms-enum": { From c17f4eb6eb0cec8d8da150806d5e6310a785c778 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sun, 17 Apr 2022 01:22:17 +0200 Subject: [PATCH 10/24] Revert "Update the stringIndexType" This reverts commit 455762d0443452299df363472bedbbd621ef7612. --- .../conversationalanalysisauthoring.json | 14 +++++++++++--- .../stable/2022-05-01/customtextauthoring.json | 14 +++++++++++--- 2 files changed, 22 insertions(+), 6 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 571bbb62c185..bae40ac3af9c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1800,7 +1800,7 @@ }, "stringIndexType": { "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "common.json#/definitions/StringIndexType" + "$ref": "#/definitions/StringIndexType" }, "metadata": { "description": "Represents the project metadata.", @@ -2497,6 +2497,16 @@ } } }, + "StringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true + } + }, "SubTrainingJobState": { "required": [ "percentComplete", @@ -2877,8 +2887,6 @@ "required": true, "type": "string", "enum": [ - "TextElements_v8", - "UnicodeCodePoint", "Utf16CodeUnit" ], "x-ms-enum": { diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 8c78bf77de08..8fbdc1da86fb 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1818,7 +1818,7 @@ }, "stringIndexType": { "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "common.json#/definitions/StringIndexType" + "$ref": "#/definitions/StringIndexType" }, "metadata": { "description": "Represents the project metadata.", @@ -2552,6 +2552,16 @@ } } }, + "StringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true + } + }, "SubTrainingJobState": { "required": [ "percentComplete", @@ -2807,8 +2817,6 @@ "required": true, "type": "string", "enum": [ - "TextElements_v8", - "UnicodeCodePoint", "Utf16CodeUnit" ], "x-ms-enum": { From 900869e45228fc6d98bd00e541086a218b59e4de Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sun, 17 Apr 2022 13:12:43 +0200 Subject: [PATCH 11/24] Fix import/export object in CT --- .../2022-05-01/customtextauthoring.json | 78 ++++++++++++------- 1 file changed, 48 insertions(+), 30 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 8fbdc1da86fb..1550e818e605 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -256,7 +256,7 @@ "description": "The project data to import.", "required": true, "schema": { - "$ref": "#/definitions/ExportedDocument" + "$ref": "#/definitions/ExportedProject" } }, { @@ -692,7 +692,7 @@ "200": { "description": "The exported json project object.", "schema": { - "$ref": "#/definitions/ExportedDocument" + "$ref": "#/definitions/ExportedProject" } }, "default": { @@ -1717,6 +1717,11 @@ }, "ExportedCustomMultiLabelClassificationProjectAssets": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedProjectAssets" + } + ], "properties": { "classes": { "type": "array", @@ -1730,7 +1735,8 @@ "$ref": "#/definitions/ExportedCustomMultiLabelClassificationDocument" } } - } + }, + "x-ms-discriminator-value": "customMultiLabelClassification" }, "ExportedCustomNamedEntityRecognitionDocument": { "type": "object", @@ -1755,6 +1761,11 @@ }, "ExportedCustomNamedEntityRecognitionProjectAssets": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedProjectAssets" + } + ], "properties": { "entities": { "type": "array", @@ -1768,7 +1779,8 @@ "$ref": "#/definitions/ExportedCustomNamedEntityRecognitionDocument" } } - } + }, + "x-ms-discriminator-value": "customNamedEntityRecognition" }, "ExportedCustomSingleLabelClassificationDocument": { "type": "object", @@ -1790,6 +1802,11 @@ }, "ExportedCustomSingleLabelClassificationProjectAssets": { "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExportedProjectAssets" + } + ], "properties": { "classes": { "type": "array", @@ -1803,32 +1820,8 @@ "$ref": "#/definitions/ExportedCustomSingleLabelClassificationDocument" } } - } - }, - "ExportedDocument": { - "required": [ - "project-file-version", - "stringIndexType", - "metadata" - ], - "type": "object", - "properties": { - "project-file-version": { - "type": "string" - }, - "stringIndexType": { - "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/StringIndexType" - }, - "metadata": { - "description": "Represents the project metadata.", - "$ref": "#/definitions/CreateProjectOptions" - }, - "assets": { - "description": "Represents the project assets.", - "$ref": "#/definitions/ExportedProjectAssets" - } - } + }, + "x-ms-discriminator-value": "customSingleLabelClassification" }, "ExportedDocumentClass": { "type": "object", @@ -1881,6 +1874,31 @@ } } }, + "ExportedProject": { + "required": [ + "project-file-version", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "project-file-version": { + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/StringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/CreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/ExportedProjectAssets" + } + } + }, "ExportedProjectAssets": { "required": [ "projectKind" From 8da3a7370ed2e3b8d7f772dd723909213d722d27 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Sun, 17 Apr 2022 13:50:37 +0200 Subject: [PATCH 12/24] Rename actual to predicted --- .../conversationalanalysisauthoring.json | 57 +++-------------- .../2022-05-01/customtextauthoring.json | 63 ++++--------------- 2 files changed, 21 insertions(+), 99 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index bae40ac3af9c..1710eb5206f1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -665,45 +665,6 @@ } } }, - "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}/result": { - "get": { - "summary": "Get export result", - "description": "Gets the result of an export job.", - "operationId": "ConversationalAnalysisAuthoring_GetExportResult", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The exported json project object.", - "schema": { - "$ref": "#/definitions/ExportedProject" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - } - } - }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { "summary": "Get import status", @@ -1490,7 +1451,7 @@ "type": "object", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same entity)\n the matrix is between the actual entity that was labelled and the entity that was predicted.", + "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.", "type": "object", "additionalProperties": { "type": "object", @@ -2048,7 +2009,7 @@ "type": "object", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two intents (the two intents can be the same intent)\n the matrix is between the actual intent that was labelled and the intent that was predicted.", + "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.", "type": "object", "additionalProperties": { "type": "object", @@ -2639,7 +2600,7 @@ "type": "string" }, "trainingConfigVersion": { - "description": "Represents training config version.\n By default, \"latest\" value is used which uses the latest released training config version.", + "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", "type": "string" }, "trainingMode": { @@ -2775,18 +2736,18 @@ "UtteranceEntitiesEvaluationResult": { "required": [ "expectedEntities", - "actualEntities" + "predictedEntities" ], "type": "object", "properties": { "expectedEntities": { - "description": "Represents the entity labels.", + "description": "Represents the expected entity labels.", "type": "array", "items": { "$ref": "#/definitions/UtteranceEntityEvaluationResult" } }, - "actualEntities": { + "predictedEntities": { "description": "Represents the predicted entity labels.", "type": "array", "items": { @@ -2849,15 +2810,15 @@ "UtteranceIntentsEvaluationResult": { "required": [ "expectedIntent", - "actualIntent" + "predictedIntent" ], "type": "object", "properties": { "expectedIntent": { - "description": "Represents the utterance's labeled intent.", + "description": "Represents the utterance's expected intent.", "type": "string" }, - "actualIntent": { + "predictedIntent": { "description": "Represents the utterance's predicted intent.", "type": "string" } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 1550e818e605..c8af2d859e8a 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -665,45 +665,6 @@ } } }, - "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}/result": { - "get": { - "summary": "Get export result", - "description": "Gets the result of an export job.", - "operationId": "TextAnalysisAuthoring_GetExportResult", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "common.json#/parameters/ProjectNamePathParameter" - }, - { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" - }, - { - "$ref": "common.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "The exported json project object.", - "schema": { - "$ref": "#/definitions/ExportedProject" - } - }, - "default": { - "description": "Error response.", - "schema": { - "$ref": "common.json#/definitions/ErrorResponse" - } - } - } - } - }, "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { "get": { "summary": "Get import status", @@ -1455,21 +1416,21 @@ "DocumentEntityRegionEvaluationResult": { "required": [ "expectedEntities", - "actualEntities", + "predictedEntities", "regionOffset", "regionLength" ], "type": "object", "properties": { "expectedEntities": { - "description": "Represents the region's labeled entities.", + "description": "Represents the region's expected entity labels.", "type": "array", "items": { "$ref": "#/definitions/DocumentEntityLabelEvaluationResult" } }, - "actualEntities": { - "description": "Represents the region's predicted entities.", + "predictedEntities": { + "description": "Represents the region's predicted entity labels.", "type": "array", "items": { "$ref": "#/definitions/DocumentEntityLabelEvaluationResult" @@ -1513,18 +1474,18 @@ "DocumentMultiLabelClassificationEvaluationResult": { "required": [ "expectedClasses", - "actualClasses" + "predictedClasses" ], "type": "object", "properties": { "expectedClasses": { - "description": "Represents the document's labeled classes.", + "description": "Represents the document's expected classes.", "type": "array", "items": { "type": "string" } }, - "actualClasses": { + "predictedClasses": { "description": "Represents the document's predicted classes.", "type": "array", "items": { @@ -1551,15 +1512,15 @@ "DocumentSingleLabelClassificationEvaluationResult": { "required": [ "expectedClass", - "actualClass" + "predictedClass" ], "type": "object", "properties": { "expectedClass": { - "description": "Represents the document's labeled class.", + "description": "Represents the document's expected class.", "type": "string" }, - "actualClass": { + "predictedClass": { "description": "Represents the document's predicted class.", "type": "string" } @@ -2143,7 +2104,7 @@ "type": "object", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two entities (the two entities can be the same)\n the matrix is between the actual entity that was labelled and the entity that was predicted.", + "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.", "type": "object", "additionalProperties": { "type": "object", @@ -2522,7 +2483,7 @@ "type": "object", "properties": { "confusionMatrix": { - "description": "Represents the confusion matrix between two classifiers (the two classifiers can be the same entity)\n the matrix is between the actual classifier that was labelled and the classifier that was predicted.", + "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.", "type": "object", "additionalProperties": { "type": "object", From 0ef0aa211a8738f9e71ab5ac79392d219759cee2 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Tue, 19 Apr 2022 05:31:04 +0200 Subject: [PATCH 13/24] Add the APIs examples --- .../conversationalanalysisauthoring.json | 218 ++++++-- .../2022-05-01/customtextauthoring.json | 209 +++++-- .../SuccessfulCancelTrainingJob.json | 12 + .../SuccessfulCreateProject.json | 44 ++ .../SuccessfulDeleteDeployment.json | 16 + .../SuccessfulDeleteModel.json | 12 + .../SuccessfulDeleteProject.json | 15 + .../SuccessfulDeployProject.json | 19 + .../SuccessfulExportProject.json | 16 + .../SuccessfulGetDeployment.json | 22 + ...SuccessfulGetDeploymentDeletionStatus.json | 22 + .../SuccessfulGetDeploymentStatus.json | 22 + .../SuccessfulGetExportStatus.json | 22 + .../SuccessfulGetImportStatus.json | 21 + .../SuccessfulGetModel.json | 22 + .../SuccessfulGetModelEvaluation.json | 284 ++++++++++ .../SuccessfulGetModelEvaluationSummary.json | 526 ++++++++++++++++++ .../SuccessfulGetProject.json | 24 + .../SuccessfulGetProjectDeletionStatus.json | 20 + .../SuccessfulGetSupportedLanguages.json | 402 +++++++++++++ ...uccessfulGetSupportedPrebuiltEntities.json | 133 +++++ ...fulGetSupportedTrainingConfigVersions.json | 22 + .../SuccessfulGetSwapDeploymentsStatus.json | 21 + .../SuccessfulGetTrainStatus.json | 36 ++ .../SuccessfulImportProject.json | 66 +++ .../SuccessfulListDeployments.json | 33 ++ .../SuccessfulListModels.json | 34 ++ .../SuccessfulListProjects.json | 35 ++ .../SuccessfulListTrainingJobs.json | 90 +++ .../SuccessfulSwapDeployments.json | 19 + .../SuccessfulTrainProject.json | 25 + .../SuccessfulCancelTrainingJob.json | 12 + .../SuccessfulCreateProject.json | 47 ++ .../SuccessfulDeleteDeployment.json | 16 + .../SuccessfulDeleteModel.json | 12 + .../SuccessfulDeleteProject.json | 15 + .../SuccessfulDeployProject.json | 20 + .../SuccessfulExportProject.json | 16 + .../SuccessfulGetDeployment.json | 22 + ...SuccessfulGetDeploymentDeletionStatus.json | 22 + .../SuccessfulGetDeploymentStatus.json | 22 + .../SuccessfulGetExportStatus.json | 22 + .../SuccessfulGetImportStatus.json | 21 + .../SuccessfulGetModel.json | 22 + .../SuccessfulGetModelEvaluation.json | 295 ++++++++++ .../SuccessfulGetModelEvaluationSummary.json | 232 ++++++++ .../SuccessfulGetProject.json | 24 + .../SuccessfulGetProjectDeletionStatus.json | 20 + .../SuccessfulGetSupportedLanguages.json | 393 +++++++++++++ ...fulGetSupportedTrainingConfigVersions.json | 22 + .../SuccessfulGetSwapDeploymentsStatus.json | 21 + .../SuccessfulGetTrainStatus.json | 36 ++ .../SuccessfulImportProject.json | 98 ++++ .../SuccessfulListDeployments.json | 33 ++ .../SuccessfulListModels.json | 34 ++ .../SuccessfulListProjects.json | 37 ++ .../SuccessfulListTrainingJobs.json | 87 +++ .../SuccessfulSwapDeployments.json | 20 + .../SuccessfulTrainProject.json | 24 + 59 files changed, 4007 insertions(+), 100 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index 1710eb5206f1..c6560728699d 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "title": "Language - Conversational Language Understanding Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", - "version": "2022-05-01" + "title": "Language - Conversational Language Understanding Authoring APIs (2022-05-01)", + "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": { @@ -30,7 +30,6 @@ "paths": { "/authoring/analyze-conversations/projects": { "get": { - "summary": "List projects", "description": "Lists the existing projects.", "operationId": "ConversationalAnalysisAuthoring_ListProjects", "produces": [ @@ -64,6 +63,11 @@ } } }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListProjects.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -72,7 +76,6 @@ }, "/authoring/analyze-conversations/projects/{projectName}": { "patch": { - "summary": "Create project", "description": "Creates a new project or updates an existing one.", "operationId": "ConversationalAnalysisAuthoring_CreateProject", "consumes": [ @@ -87,7 +90,7 @@ }, { "in": "body", - "name": "projectCreateObject", + "name": "createProjectOptions", "description": "The project parameters.", "required": true, "schema": { @@ -117,10 +120,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulCreateProject.json" + } } }, "get": { - "summary": "Get project details", "description": "Gets the details of a project.", "operationId": "ConversationalAnalysisAuthoring_GetProject", "produces": [ @@ -147,10 +154,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetProject.json" + } } }, "delete": { - "summary": "Delete project", "description": "Deletes a project.", "operationId": "ConversationalAnalysisAuthoring_DeleteProject", "produces": [ @@ -181,12 +192,16 @@ } } }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "summary": "Export project", "description": "Triggers a job to export a project's data.", "operationId": "ConversationalAnalysisAuthoring_Export", "produces": [ @@ -229,12 +244,16 @@ } } }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulExportProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "summary": "Import project", "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": [ @@ -252,7 +271,7 @@ }, { "in": "body", - "name": "projectFileImportObject", + "name": "exportedProject", "description": "The project data to import.", "required": true, "schema": { @@ -280,12 +299,16 @@ } } }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulImportProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "summary": "Train project", "description": "Triggers a training job for a project.", "operationId": "ConversationalAnalysisAuthoring_Train", "consumes": [ @@ -300,7 +323,7 @@ }, { "in": "body", - "name": "trainingJobCreateObject", + "name": "trainingJobOptions", "description": "The training input parameters.", "required": true, "schema": { @@ -328,12 +351,16 @@ } } }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulTrainProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "summary": "List deployments", "description": "Lists the deployments belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListDeployments", "produces": [ @@ -370,6 +397,11 @@ } } }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListDeployments.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -378,7 +410,6 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { "post": { - "summary": "Swap deployments", "description": "Swaps two existing deployments with each other.", "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", "consumes": [ @@ -393,7 +424,7 @@ }, { "in": "body", - "name": "swappingDeploymentJobObject", + "name": "swapDeploymentsOptions", "description": "The job object to swap two deployments.", "required": true, "schema": { @@ -421,12 +452,16 @@ } } }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "summary": "Get deployment details", "description": "Gets the details of a deployment.", "operationId": "ConversationalAnalysisAuthoring_GetDeployment", "produces": [ @@ -456,10 +491,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json" + } } }, "put": { - "summary": "Update deployment", "description": "Creates a new deployment or replaces an existing one.", "operationId": "ConversationalAnalysisAuthoring_DeployProject", "consumes": [ @@ -477,7 +516,7 @@ }, { "in": "body", - "name": "createOrReplaceDeploymentJobObject", + "name": "createDeploymentOptions", "description": "The new deployment info.", "required": true, "schema": { @@ -505,10 +544,14 @@ } } }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeployProject.json" + } + }, "x-ms-long-running-operation": true }, "delete": { - "summary": "Delete deployment", "description": "Deletes a project deployment.", "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", "produces": [ @@ -542,12 +585,16 @@ } } }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "summary": "Get deployment status", "description": "Gets the status of an existing deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", "produces": [ @@ -584,12 +631,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "summary": "Gets swap deployments status", "description": "Gets the status of an existing swap deployment job.", "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", "produces": [ @@ -623,12 +674,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "summary": "Get export status", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", "produces": [ @@ -662,12 +717,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "summary": "Get import status", "description": "Gets the status for an import.", "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", "produces": [ @@ -701,12 +760,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "summary": "List trained models", "description": "Lists the trained models belonging to a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", "produces": [ @@ -743,6 +806,11 @@ } } }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListModels.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -751,7 +819,6 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "summary": "Get trained model details", "description": "Gets the details of a trained model.", "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", "produces": [ @@ -785,10 +852,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetModel.json" + } } }, "delete": { - "summary": "Delete trained model", "description": "Deletes an existing trained model.", "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", "produces": [ @@ -819,12 +890,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "summary": "Get trained model evaluation result", "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": [ @@ -871,6 +946,11 @@ } } }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -879,7 +959,6 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "summary": "Get trained model evaluation summary", "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": [ @@ -913,12 +992,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "summary": "List training jobs", "description": "Lists the non-expired training jobs created for a project.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", "produces": [ @@ -955,6 +1038,11 @@ } } }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -963,7 +1051,6 @@ }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "summary": "Get training status", "description": "Gets the status for a training job.", "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", "produces": [ @@ -997,12 +1084,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json" + } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "summary": "Cancel training", "description": "Triggers a cancellation for a running training job.", "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", "produces": [ @@ -1033,12 +1124,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json" + } } } }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "summary": "Get project deletion status", "description": "Gets the status for a project deletion job.", "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", "produces": [ @@ -1069,12 +1164,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json" + } } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "summary": "List supported languages", "description": "Lists the supported languages for the given project type.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", "produces": [ @@ -1111,6 +1210,11 @@ } } }, + "x-ms-examples": { + "Successful Supported Languages": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -1119,7 +1223,6 @@ }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "summary": "List supported prebuilt entities", "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", "produces": [ @@ -1165,6 +1268,11 @@ } } }, + "x-ms-examples": { + "Successful Get Supported Prebuilt Entities": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -1173,7 +1281,6 @@ }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "summary": "List training config versions", "description": "Lists the support training config version for a given project type.", "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", "produces": [ @@ -1210,6 +1317,11 @@ } } }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -1356,7 +1468,6 @@ "CreateProjectOptions": { "required": [ "projectKind", - "settings", "projectName", "language" ], @@ -1594,7 +1705,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2161,7 +2273,8 @@ }, "nextLink": { "description": "The next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2266,7 +2379,7 @@ "type": "string" }, "deploymentExpirationDate": { - "format": "date-time", + "format": "date", "description": "Represents deployment expiration date in the runtime.", "type": "string" }, @@ -2292,7 +2405,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2311,10 +2425,7 @@ "required": [ "createdDateTime", "lastModifiedDateTime", - "lastTrainedDateTime", - "lastDeployedDateTime", "projectKind", - "settings", "projectName", "language" ], @@ -2394,7 +2505,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2428,7 +2540,7 @@ "type": "integer" }, "modelExpirationDate": { - "format": "date-time", + "format": "date", "description": "Represents model expiration date.", "type": "string" }, @@ -2454,7 +2566,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2529,7 +2642,8 @@ }, "nextLink": { "description": "The next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2562,7 +2676,7 @@ "type": "string" }, "modelExpirationDate": { - "format": "date-time", + "format": "date", "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", "type": "string" } @@ -2584,7 +2698,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2664,7 +2779,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index c8af2d859e8a..4dd91bc2eb6c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1,9 +1,9 @@ { "swagger": "2.0", "info": { - "title": "Language - Text Analysis Authoring", - "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview.0", - "version": "2022-05-01" + "title": "Language - Custom Text Authoring APIs (2022-05-01)", + "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": { @@ -30,7 +30,6 @@ "paths": { "/authoring/analyze-text/projects": { "get": { - "summary": "List projects", "description": "Lists the existing projects.", "operationId": "TextAnalysisAuthoring_ListProjects", "produces": [ @@ -64,6 +63,11 @@ } } }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/textanalysisauthoring/SuccessfulListProjects.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -72,7 +76,6 @@ }, "/authoring/analyze-text/projects/{projectName}": { "patch": { - "summary": "Create project", "description": "Creates a new project or updates an existing one.", "operationId": "TextAnalysisAuthoring_CreateProject", "consumes": [ @@ -87,7 +90,7 @@ }, { "in": "body", - "name": "projectCreateObject", + "name": "createProjectOptions", "description": "The project parameters.", "required": true, "schema": { @@ -117,10 +120,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulCreateProject.json" + } } }, "get": { - "summary": "Get project details", "description": "Gets the details of a project.", "operationId": "TextAnalysisAuthoring_GetProject", "produces": [ @@ -147,10 +154,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetProject.json" + } } }, "delete": { - "summary": "Delete project", "description": "Deletes a project.", "operationId": "TextAnalysisAuthoring_DeleteProject", "produces": [ @@ -181,12 +192,16 @@ } } }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulDeleteProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-text/projects/{projectName}/:export": { "post": { - "summary": "Export project", "description": "Triggers a job to export a project's data.", "operationId": "TextAnalysisAuthoring_Export", "produces": [ @@ -232,12 +247,16 @@ } } }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulExportProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-text/projects/{projectName}/:import": { "post": { - "summary": "Import project", "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": [ @@ -252,7 +271,7 @@ }, { "in": "body", - "name": "projectFileImportObject", + "name": "exportedProject", "description": "The project data to import.", "required": true, "schema": { @@ -280,12 +299,16 @@ } } }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulImportProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-text/projects/{projectName}/:train": { "post": { - "summary": "Train project", "description": "Triggers a training job for a project.", "operationId": "TextAnalysisAuthoring_Train", "consumes": [ @@ -300,7 +323,7 @@ }, { "in": "body", - "name": "trainingJobCreateObject", + "name": "trainingJobOptions", "description": "The training input parameters.", "required": true, "schema": { @@ -328,12 +351,16 @@ } } }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulTrainProject.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-text/projects/{projectName}/deployments": { "get": { - "summary": "List deployments", "description": "Lists the deployments belonging to a project.", "operationId": "TextAnalysisAuthoring_ListDeployments", "produces": [ @@ -370,6 +397,11 @@ } } }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/textanalysisauthoring/SuccessfulListDeployments.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -378,7 +410,6 @@ }, "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { "post": { - "summary": "Swap deployments", "description": "Swaps two existing deployments with each other.", "operationId": "TextAnalysisAuthoring_SwapDeployments", "consumes": [ @@ -393,7 +424,7 @@ }, { "in": "body", - "name": "swappingDeploymentJobObject", + "name": "swapDeploymentsOptions", "description": "The job object to swap two deployments.", "required": true, "schema": { @@ -421,12 +452,16 @@ } } }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/textanalysisauthoring/SuccessfulSwapDeployments.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { "get": { - "summary": "Get deployment details", "description": "Gets the details of a deployment.", "operationId": "TextAnalysisAuthoring_GetDeployment", "produces": [ @@ -456,10 +491,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetDeployment.json" + } } }, "put": { - "summary": "Update deployment", "description": "Creates a new deployment or replaces an existing one.", "operationId": "TextAnalysisAuthoring_DeployProject", "consumes": [ @@ -477,7 +516,7 @@ }, { "in": "body", - "name": "createOrReplaceDeploymentJobObject", + "name": "createDeploymentOptions", "description": "The new deployment info.", "required": true, "schema": { @@ -505,10 +544,14 @@ } } }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/textanalysisauthoring/SuccessfulDeployProject.json" + } + }, "x-ms-long-running-operation": true }, "delete": { - "summary": "Delete deployment", "description": "Deletes a project deployment.", "operationId": "TextAnalysisAuthoring_DeleteDeployment", "produces": [ @@ -542,12 +585,16 @@ } } }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/textanalysisauthoring/SuccessfulDeleteDeployment.json" + } + }, "x-ms-long-running-operation": true } }, "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "summary": "Get deployment status", "description": "Gets the status of an existing deployment job.", "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", "produces": [ @@ -584,12 +631,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "summary": "Gets swap deployments status", "description": "Gets the status of an existing swap deployment job.", "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", "produces": [ @@ -623,12 +674,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { "get": { - "summary": "Get export status", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "operationId": "TextAnalysisAuthoring_GetExportStatus", "produces": [ @@ -662,12 +717,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetExportStatus.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { "get": { - "summary": "Get import status", "description": "Gets the status for an import.", "operationId": "TextAnalysisAuthoring_GetImportStatus", "produces": [ @@ -701,12 +760,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetImportStatus.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/models": { "get": { - "summary": "List trained models", "description": "Lists the trained models belonging to a project.", "operationId": "TextAnalysisAuthoring_ListTrainedModels", "produces": [ @@ -743,6 +806,11 @@ } } }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/textanalysisauthoring/SuccessfulListModels.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -751,7 +819,6 @@ }, "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "summary": "Get trained model details", "description": "Gets the details of a trained model.", "operationId": "TextAnalysisAuthoring_GetTrainedModel", "produces": [ @@ -785,10 +852,14 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetModel.json" + } } }, "delete": { - "summary": "Delete trained model", "description": "Deletes an existing trained model.", "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", "produces": [ @@ -819,12 +890,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/textanalysisauthoring/SuccessfulDeleteModel.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "summary": "Get trained model evaluation result", "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": [ @@ -871,6 +946,11 @@ } } }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -879,7 +959,6 @@ }, "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "summary": "Get trained model evaluation summary", "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": [ @@ -913,12 +992,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/train/jobs": { "get": { - "summary": "List training jobs", "description": "Lists the non-expired training jobs created for a project.", "operationId": "TextAnalysisAuthoring_ListTrainingJobs", "produces": [ @@ -955,6 +1038,11 @@ } } }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/textanalysisauthoring/SuccessfulListTrainingJobs.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -963,7 +1051,6 @@ }, "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { "get": { - "summary": "Get training status", "description": "Gets the status for a training job.", "operationId": "TextAnalysisAuthoring_GetTrainingStatus", "produces": [ @@ -997,12 +1084,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetTrainStatus.json" + } } } }, "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "summary": "Cancel training", "description": "Triggers a cancellation for a running training job.", "operationId": "TextAnalysisAuthoring_CancelTrainingJob", "produces": [ @@ -1033,12 +1124,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json" + } } } }, "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { "get": { - "summary": "Get project deletion status", "description": "Gets the status for a project deletion job.", "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", "produces": [ @@ -1069,12 +1164,16 @@ "$ref": "common.json#/definitions/ErrorResponse" } } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json" + } } } }, "/authoring/analyze-text/projects/global/languages": { "get": { - "summary": "List supported languages", "description": "Lists the supported languages.", "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", "produces": [ @@ -1108,6 +1207,11 @@ } } }, + "x-ms-examples": { + "Successful Supported Languages": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -1116,7 +1220,6 @@ }, "/authoring/analyze-text/projects/global/training-config-versions": { "get": { - "summary": "List training config versions", "description": "Lists the support training config version for a given project type.", "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", "produces": [ @@ -1153,6 +1256,11 @@ } } }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, "x-ms-pageable": { "nextLinkName": "nextLink", "itemName": "value" @@ -1196,7 +1304,6 @@ "required": [ "projectKind", "storageInputContainerName", - "settings", "projectName", "language" ], @@ -1621,7 +1728,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2231,7 +2339,7 @@ "type": "string" }, "deploymentExpirationDate": { - "format": "date-time", + "format": "date", "description": "Represents deployment expiration date in the runtime.", "type": "string" }, @@ -2257,7 +2365,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2277,11 +2386,8 @@ "required": [ "createdDateTime", "lastModifiedDateTime", - "lastTrainedDateTime", - "lastDeployedDateTime", "projectKind", "storageInputContainerName", - "settings", "projectName", "language" ], @@ -2356,7 +2462,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2390,7 +2497,7 @@ "type": "integer" }, "modelExpirationDate": { - "format": "date-time", + "format": "date", "description": "Represents model expiration date.", "type": "string" }, @@ -2416,7 +2523,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2602,7 +2710,8 @@ }, "nextLink": { "description": "The next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2635,7 +2744,7 @@ "type": "string" }, "modelExpirationDate": { - "format": "date-time", + "format": "date", "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", "type": "string" } @@ -2657,7 +2766,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, @@ -2729,7 +2839,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } } }, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..0ef3c35512d8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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": {} + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..85d4c6830d89 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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", + "createProjectOptions": { + "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:01", + "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/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..f4b4f40dd3bc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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/conversationalanalysisauthoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..9dce739b9f83 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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": {} + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..1ee6f36f07f4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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/conversationalanalysisauthoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..c97af8844771 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "deploymentName": "production", + "createDeploymentOptions": { + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..86ab3f9e3ac1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..df32acf3b9a0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json new file mode 100644 index 000000000000..fe3304b08043 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "deploymentName": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000", + "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000", + "createdDateTime": "2022-04-18T16:20:48Z", + "lastUpdatedDateTime": "2022-04-18T16:20:54Z", + "expirationDateTime": "2022-04-25T16:20:48Z", + "status": "succeeded" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..e4672fc9f927 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..5aca88ee2b45 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..aeedb39606c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..ebbc7b555e32 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..e47b1a81d43b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..faf8c183a320 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..69237114c6f6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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:01", + "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/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..ebbe34f6cae4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..22bfbfee747d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..198a5a4c3768 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..e9469df1c16d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..b46bc17bb41d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..22823a9d091d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..5add3f81ffa3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "exportedProject": { + "project-file-version": "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..3f83f4361722 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListModels.json new file mode 100644 index 000000000000..8eece09f0cc2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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/conversationalanalysisauthoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..fa7107d98678 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..c9d5d848cf91 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..803a7f62f68a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "swapDeploymentsOptions": { + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..8f4cd6d5bcde --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "EmailApp", + "trainingJobOptions": { + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..3dd0cfe958c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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": {} + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..c667ba835f41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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:01", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..c3fef5a64f11 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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/textanalysisauthoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..fe2bb1ba6d07 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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": {} + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..448dc97831b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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/textanalysisauthoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..d9396cbd7c06 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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", + "createDeploymentOptions": { + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..6951694d278a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..cc84bd54c875 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json new file mode 100644 index 000000000000..00642438c1d6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "deploymentName": "staging", + "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000", + "createdDateTime": "2022-04-18T16:20:48Z", + "lastUpdatedDateTime": "2022-04-18T16:20:54Z", + "expirationDateTime": "2022-04-25T16:20:48Z", + "status": "succeeded" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..4a1d267713a5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..0651f7515082 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..a674c94ae869 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..061d3d2b8644 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..26543307f971 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..fee4ac4f9d69 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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 + } + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..895fa3b4692b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json @@ -0,0 +1,24 @@ +{ + "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:01", + "projectKind": "customNamedEntityRecognition", + "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/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..ebbe34f6cae4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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/textanalysisauthoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..4bab6866bfdb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..1dcfc48a0622 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..b6c471af03c8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..f2ce95f361b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,36 @@ +{ + "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", + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..7aa5e932bb83 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "body": { + "project-file-version": "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": { + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..06602ee7be8d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListModels.json new file mode 100644 index 000000000000..bf9a51084b1f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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/textanalysisauthoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..1bc7eff23b49 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json @@ -0,0 +1,37 @@ +{ + "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:01", + "projectKind": "customNamedEntityRecognition", + "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", + "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/textanalysisauthoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..05c3189fbe1d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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 + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..9793aa7f6dae --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/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", + "swapDeploymentsOptions": { + "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" + } + } + } +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..5b2d532b68dd --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2022-05-01", + "projectName": "LoanAgreements", + "trainingJobOptions": { + "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" + } + } + } +} \ No newline at end of file From 260ff87af9ab6a2d75e2eb6d5067cfdff3a7f0e9 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Tue, 19 Apr 2022 05:42:32 +0200 Subject: [PATCH 14/24] Fix the examples validations --- .../SuccessfulCreateProject.json | 2 +- ...SuccessfulGetDeploymentDeletionStatus.json | 22 ------------------- .../SuccessfulGetProject.json | 2 +- .../SuccessfulCreateProject.json | 4 ++-- ...SuccessfulGetDeploymentDeletionStatus.json | 22 ------------------- .../SuccessfulGetProject.json | 5 +++-- .../SuccessfulGetTrainStatus.json | 1 - .../SuccessfulImportProject.json | 3 ++- .../SuccessfulListProjects.json | 6 +++-- 9 files changed, 13 insertions(+), 54 deletions(-) delete mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json delete mode 100644 specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json index 85d4c6830d89..8dfab07fcaa9 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json @@ -32,7 +32,7 @@ "createdDateTime": "2022-04-18T13:53:03Z", "lastModifiedDateTime": "2022-04-18T13:53:03Z", "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", "projectKind": "conversation", "projectName": "myproject", "multilingual": false, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json deleted file mode 100644 index fe3304b08043..000000000000 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-01", - "projectName": "EmailApp", - "deploymentName": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000", - "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000", - "createdDateTime": "2022-04-18T16:20:48Z", - "lastUpdatedDateTime": "2022-04-18T16:20:54Z", - "expirationDateTime": "2022-04-25T16:20:48Z", - "status": "succeeded" - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json index 69237114c6f6..0d3a6c5ccad5 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json @@ -12,7 +12,7 @@ "createdDateTime": "2022-04-18T13:53:03Z", "lastModifiedDateTime": "2022-04-18T13:53:03Z", "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", "projectKind": "conversation", "projectName": "myproject", "multilingual": false, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json index c667ba835f41..9ab8a7ca0ca5 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json @@ -5,7 +5,7 @@ "Content-Type": "application/merge-patch+json", "api-version": "2022-05-01", "projectName": "LoanAgreements", - "body": { + "createProjectOptions": { "projectName": "LoanAgreements", "language": "en", "projectKind": "customNamedEntityRecognition", @@ -34,7 +34,7 @@ "createdDateTime": "2022-04-18T13:53:03Z", "lastModifiedDateTime": "2022-04-18T13:53:03Z", "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", "projectKind": "customNamedEntityRecognition", "storageInputContainerName": "loanagreements", "projectName": "LoanAgreements", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json deleted file mode 100644 index 00642438c1d6..000000000000 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentDeletionStatus.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "Endpoint": "{Endpoint}", - "Ocp-Apim-Subscription-Key": "{API key}", - "api-version": "2022-05-01", - "projectName": "LoanAgreements", - "deploymentName": "staging", - "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000" - }, - "responses": { - "200": { - "headers": {}, - "body": { - "jobId": "61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000", - "createdDateTime": "2022-04-18T16:20:48Z", - "lastUpdatedDateTime": "2022-04-18T16:20:54Z", - "expirationDateTime": "2022-04-25T16:20:48Z", - "status": "succeeded" - } - } - } -} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json index 895fa3b4692b..0f52a3f8d7a1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json @@ -12,8 +12,9 @@ "createdDateTime": "2022-04-18T13:53:03Z", "lastModifiedDateTime": "2022-04-18T13:53:03Z", "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01", + "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.", @@ -21,4 +22,4 @@ } } } -} +} \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json index f2ce95f361b5..f2e39cb46caa 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json @@ -13,7 +13,6 @@ "result": { "modelLabel": "model1", "trainingConfigVersion": "2022-05-01", - "trainingMode": "standard", "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", "trainingStatus": { "percentComplete": 3, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json index 7aa5e932bb83..ad95475cca98 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json @@ -5,7 +5,7 @@ "Content-Type": "application/json", "api-version": "2022-05-01", "projectName": "LoanAgreements", - "body": { + "exportedProject": { "project-file-version": "2022-05-01", "stringIndexType": "Utf16CodeUnit", "metadata": { @@ -18,6 +18,7 @@ "language": "en" }, "assets": { + "projectKind": "customNamedEntityRecognition", "entities": [ { "category": "Date" diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json index 1bc7eff23b49..6cf7f5983f55 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json @@ -13,8 +13,9 @@ "createdDateTime": "2022-04-18T13:53:03Z", "lastModifiedDateTime": "2022-04-18T13:53:03Z", "lastTrainedDateTime": "2022-04-18T14:14:28Z", - "lastDeployedDateTime": "2022-04-18T14:49:01", + "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.", @@ -24,6 +25,7 @@ "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\".", @@ -34,4 +36,4 @@ } } } -} +} \ No newline at end of file From 6e42245a1b3fc8858ad9e701ab6d72d1c5c62bac Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Tue, 19 Apr 2022 05:44:27 +0200 Subject: [PATCH 15/24] Fix prettier --- .../SuccessfulCancelTrainingJob.json | 2 +- .../conversationalanalysisauthoring/SuccessfulDeleteModel.json | 2 +- .../SuccessfulDeployProject.json | 2 +- .../SuccessfulExportProject.json | 2 +- .../SuccessfulGetDeploymentStatus.json | 2 +- .../SuccessfulGetExportStatus.json | 2 +- .../SuccessfulGetImportStatus.json | 2 +- .../conversationalanalysisauthoring/SuccessfulGetModel.json | 2 +- .../SuccessfulGetModelEvaluation.json | 2 +- .../SuccessfulGetModelEvaluationSummary.json | 2 +- .../SuccessfulGetSupportedLanguages.json | 2 +- .../SuccessfulGetSupportedPrebuiltEntities.json | 2 +- .../SuccessfulGetSupportedTrainingConfigVersions.json | 2 +- .../SuccessfulGetSwapDeploymentsStatus.json | 2 +- .../SuccessfulGetTrainStatus.json | 2 +- .../SuccessfulImportProject.json | 2 +- .../SuccessfulListDeployments.json | 2 +- .../SuccessfulListTrainingJobs.json | 2 +- .../SuccessfulSwapDeployments.json | 2 +- .../conversationalanalysisauthoring/SuccessfulTrainProject.json | 2 +- .../textanalysisauthoring/SuccessfulCancelTrainingJob.json | 2 +- .../examples/textanalysisauthoring/SuccessfulCreateProject.json | 2 +- .../examples/textanalysisauthoring/SuccessfulDeleteModel.json | 2 +- .../examples/textanalysisauthoring/SuccessfulDeployProject.json | 2 +- .../examples/textanalysisauthoring/SuccessfulExportProject.json | 2 +- .../textanalysisauthoring/SuccessfulGetDeploymentStatus.json | 2 +- .../textanalysisauthoring/SuccessfulGetExportStatus.json | 2 +- .../textanalysisauthoring/SuccessfulGetImportStatus.json | 2 +- .../examples/textanalysisauthoring/SuccessfulGetModel.json | 2 +- .../textanalysisauthoring/SuccessfulGetModelEvaluation.json | 2 +- .../SuccessfulGetModelEvaluationSummary.json | 2 +- .../examples/textanalysisauthoring/SuccessfulGetProject.json | 2 +- .../textanalysisauthoring/SuccessfulGetSupportedLanguages.json | 2 +- .../SuccessfulGetSupportedTrainingConfigVersions.json | 2 +- .../SuccessfulGetSwapDeploymentsStatus.json | 2 +- .../textanalysisauthoring/SuccessfulGetTrainStatus.json | 2 +- .../examples/textanalysisauthoring/SuccessfulImportProject.json | 2 +- .../textanalysisauthoring/SuccessfulListDeployments.json | 2 +- .../examples/textanalysisauthoring/SuccessfulListProjects.json | 2 +- .../textanalysisauthoring/SuccessfulListTrainingJobs.json | 2 +- .../textanalysisauthoring/SuccessfulSwapDeployments.json | 2 +- .../examples/textanalysisauthoring/SuccessfulTrainProject.json | 2 +- 42 files changed, 42 insertions(+), 42 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json index 0ef3c35512d8..9e9f2078c34f 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json @@ -9,4 +9,4 @@ "responses": { "204": {} } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json index 9dce739b9f83..78ff85284bc7 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json @@ -9,4 +9,4 @@ "responses": { "204": {} } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json index c97af8844771..a3a368eaf42c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json @@ -16,4 +16,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json index 86ab3f9e3ac1..e37a38e4a655 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json @@ -13,4 +13,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json index e4672fc9f927..13896261ae32 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json index 5aca88ee2b45..9da036422508 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json index aeedb39606c8..17de29ce5a87 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json @@ -18,4 +18,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json index ebbc7b555e32..b7a5996b24a1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json index e47b1a81d43b..d35cca16e65d 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json @@ -281,4 +281,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json index faf8c183a320..bccb012b07d4 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json @@ -523,4 +523,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json index 22bfbfee747d..df03d76725eb 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json @@ -399,4 +399,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json index 198a5a4c3768..84b3877acd38 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json @@ -130,4 +130,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json index e9469df1c16d..6706a4180b60 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json index b46bc17bb41d..b53a88ffab6d 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json @@ -18,4 +18,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json index 22823a9d091d..f3c67aea14f3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json @@ -33,4 +33,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json index 5add3f81ffa3..569635394d05 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json @@ -63,4 +63,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json index 3f83f4361722..cc60b9e2751a 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json @@ -30,4 +30,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json index c9d5d848cf91..fdd2ab3ef83b 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json @@ -87,4 +87,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json index 803a7f62f68a..2f74f96fba95 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json @@ -16,4 +16,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json index 8f4cd6d5bcde..c93044ea59b7 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json @@ -22,4 +22,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json index 3dd0cfe958c3..818700374270 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json @@ -9,4 +9,4 @@ "responses": { "204": {} } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json index 9ab8a7ca0ca5..ae82e1df76ea 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json @@ -44,4 +44,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json index fe2bb1ba6d07..c3540d43939f 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json @@ -9,4 +9,4 @@ "responses": { "204": {} } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json index d9396cbd7c06..74b2be0eee74 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json @@ -17,4 +17,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json index 6951694d278a..c67c21112611 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json @@ -13,4 +13,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json index 4a1d267713a5..1659f46939bf 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json index 0651f7515082..3d7c476f6964 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json index a674c94ae869..5bfc685d2a6f 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json @@ -18,4 +18,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json index 061d3d2b8644..ba8c002721bc 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json index 26543307f971..aca95b34fef3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json @@ -292,4 +292,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json index fee4ac4f9d69..4b6c3df844ab 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json @@ -229,4 +229,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json index 0f52a3f8d7a1..41ddeb1afd91 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json @@ -22,4 +22,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json index 4bab6866bfdb..ee06f3f95309 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json @@ -390,4 +390,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json index 1dcfc48a0622..4c9d208f5d95 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -19,4 +19,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json index b6c471af03c8..2b7c90f19a8f 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json @@ -18,4 +18,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json index f2e39cb46caa..828d60a771b7 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json @@ -32,4 +32,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json index ad95475cca98..d72f9b40db98 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json @@ -96,4 +96,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json index 06602ee7be8d..08d8108d94cf 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json @@ -30,4 +30,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json index 6cf7f5983f55..214769fc5c9e 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json @@ -36,4 +36,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json index 05c3189fbe1d..8657b9131ec8 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json @@ -84,4 +84,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json index 9793aa7f6dae..c6645519a430 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json @@ -17,4 +17,4 @@ } } } -} \ No newline at end of file +} diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json index 5b2d532b68dd..28da114daa9f 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json @@ -21,4 +21,4 @@ } } } -} \ No newline at end of file +} From 10491deb2fffa9b43703d97e5344a953cf891404 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Tue, 19 Apr 2022 23:22:23 +0200 Subject: [PATCH 16/24] Fix autorest issues --- .../conversationalanalysisauthoring.json | 570 ++++++++++-------- .../2022-05-01/customtextauthoring.json | 541 +++++++++-------- 2 files changed, 614 insertions(+), 497 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index c6560728699d..caf692bbe552 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -53,7 +53,7 @@ "200": { "description": "The metadata of projects.", "schema": { - "$ref": "#/definitions/ProjectsMetadata" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" } }, "default": { @@ -94,7 +94,7 @@ "description": "The project parameters.", "required": true, "schema": { - "$ref": "#/definitions/CreateProjectOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" } }, { @@ -105,13 +105,13 @@ "200": { "description": "The metadata of the updated project, if it already exists.", "schema": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "201": { "description": "The metadata of the created project.", "schema": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { @@ -145,7 +145,7 @@ "200": { "description": "The metadata of the project.", "schema": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "default": { @@ -212,10 +212,10 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "$ref": "#/parameters/FormatInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatInQuery" }, { - "$ref": "#/parameters/StringIndexTypeInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeInQuery" }, { "in": "query", @@ -267,7 +267,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "$ref": "#/parameters/FormatInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatInQuery" }, { "in": "body", @@ -275,7 +275,7 @@ "description": "The project data to import.", "required": true, "schema": { - "$ref": "#/definitions/ExportedProject" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" } }, { @@ -327,7 +327,7 @@ "description": "The training input parameters.", "required": true, "schema": { - "$ref": "#/definitions/TrainingJobOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" } }, { @@ -387,7 +387,7 @@ "200": { "description": "List of all deployments.", "schema": { - "$ref": "#/definitions/ProjectDeployments" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" } }, "default": { @@ -428,7 +428,7 @@ "description": "The job object to swap two deployments.", "required": true, "schema": { - "$ref": "#/definitions/SwapDeploymentsOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" } }, { @@ -482,7 +482,7 @@ "200": { "description": "The Deployment info.", "schema": { - "$ref": "#/definitions/ProjectDeployment" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "default": { @@ -520,7 +520,7 @@ "description": "The new deployment info.", "required": true, "schema": { - "$ref": "#/definitions/CreateDeploymentOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" } }, { @@ -622,7 +622,7 @@ "200": { "description": "The deployment job result.", "schema": { - "$ref": "#/definitions/DeploymentJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" } }, "default": { @@ -665,7 +665,7 @@ "200": { "description": "The swap deployment job result.", "schema": { - "$ref": "#/definitions/DeploymentJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" } }, "default": { @@ -708,7 +708,7 @@ "200": { "description": "The status of the long running operation.", "schema": { - "$ref": "#/definitions/ExportProjectJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" } }, "default": { @@ -751,7 +751,7 @@ "200": { "description": "The details of the long running operation.", "schema": { - "$ref": "#/definitions/ImportProjectJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" } }, "default": { @@ -796,7 +796,7 @@ "200": { "description": "List of all trained models.", "schema": { - "$ref": "#/definitions/ProjectTrainedModels" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" } }, "default": { @@ -843,7 +843,7 @@ "200": { "description": "Trained model info", "schema": { - "$ref": "#/definitions/ProjectTrainedModel" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "default": { @@ -917,7 +917,7 @@ "type": "string" }, { - "$ref": "#/parameters/StringIndexTypeInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeInQuery" }, { "$ref": "common.json#/parameters/TopParameter" @@ -936,7 +936,7 @@ "200": { "description": "List of the evaluation predictions.", "schema": { - "$ref": "#/definitions/EvaluationResults" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" } }, "default": { @@ -983,7 +983,7 @@ "200": { "description": "List of all evaluation results.", "schema": { - "$ref": "#/definitions/EvaluationSummary" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" } }, "default": { @@ -1028,7 +1028,7 @@ "200": { "description": "List of the training jobs.", "schema": { - "$ref": "#/definitions/TrainingJobs" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" } }, "default": { @@ -1075,7 +1075,7 @@ "200": { "description": "The training job result.", "schema": { - "$ref": "#/definitions/TrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "default": { @@ -1155,7 +1155,7 @@ "200": { "description": "The project deletion job result.", "schema": { - "$ref": "#/definitions/ProjectDeletionJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" } }, "default": { @@ -1181,7 +1181,7 @@ ], "parameters": [ { - "$ref": "#/parameters/ProjectKindInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindInQuery" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1200,7 +1200,7 @@ "200": { "description": "The list of supported languages.", "schema": { - "$ref": "#/definitions/SupportedLanguages" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" } }, "default": { @@ -1258,7 +1258,7 @@ "200": { "description": "The list of supported prebuilt entities.", "schema": { - "$ref": "#/definitions/PrebuiltEntities" + "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" } }, "default": { @@ -1288,7 +1288,7 @@ ], "parameters": [ { - "$ref": "#/parameters/ProjectKindInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindInQuery" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1307,7 +1307,7 @@ "200": { "description": "List of config versions.", "schema": { - "$ref": "#/definitions/TrainingConfigVersions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" } }, "default": { @@ -1330,7 +1330,7 @@ } }, "definitions": { - "CompositionSetting": { + "ConversationalAnalysisAuthoringCompositionSetting": { "enum": [ "returnLongestOverlap", "requireExactOverlap", @@ -1341,9 +1341,17 @@ "x-ms-enum": { "name": "CompositionSetting", "modelAsString": true - } + }, + "x-ms-client-name": "CompositionSetting" + }, + "ConversationalAnalysisAuthoringConfusionMatrix": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" + }, + "x-ms-client-name": "ConfusionMatrix" }, - "ConfusionMatrixEntry": { + "ConversationalAnalysisAuthoringConfusionMatrixEntry": { "required": [ "normalizedValue", "rawValue" @@ -1360,9 +1368,17 @@ "description": "Represents raw value.", "type": "number" } - } + }, + "x-ms-client-name": "ConfusionMatrixEntry" + }, + "ConversationalAnalysisAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixEntry" + }, + "x-ms-client-name": "ConfusionMatrixRow" }, - "ConversationExportedEntity": { + "ConversationalAnalysisAuthoringConversationExportedEntity": { "required": [ "category" ], @@ -1372,20 +1388,21 @@ "type": "string" }, "compositionSetting": { - "$ref": "#/definitions/CompositionSetting" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" }, "list": { - "$ref": "#/definitions/ExportedEntityList" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" }, "prebuilts": { "type": "array", "items": { - "$ref": "#/definitions/ExportedPrebuiltEntity" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" } } - } + }, + "x-ms-client-name": "ConversationExportedEntity" }, - "ConversationExportedIntent": { + "ConversationalAnalysisAuthoringConversationExportedIntent": { "required": [ "category" ], @@ -1394,38 +1411,40 @@ "category": { "type": "string" } - } + }, + "x-ms-client-name": "ConversationExportedIntent" }, - "ConversationExportedProjectAssets": { + "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" } ], "properties": { "intents": { "type": "array", "items": { - "$ref": "#/definitions/ConversationExportedIntent" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" } }, "entities": { "type": "array", "items": { - "$ref": "#/definitions/ConversationExportedEntity" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" } }, "utterances": { "type": "array", "items": { - "$ref": "#/definitions/ConversationExportedUtterance" + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" } } }, - "x-ms-discriminator-value": "conversation" + "x-ms-discriminator-value": "conversation", + "x-ms-client-name": "ConversationExportedProjectAssets" }, - "ConversationExportedUtterance": { + "ConversationalAnalysisAuthoringConversationExportedUtterance": { "required": [ "text", "intent" @@ -1435,7 +1454,7 @@ "entities": { "type": "array", "items": { - "$ref": "#/definitions/ExportedUtteranceEntityLabel" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" } }, "text": { @@ -1451,9 +1470,10 @@ "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", "type": "string" } - } + }, + "x-ms-client-name": "ConversationExportedUtterance" }, - "CreateDeploymentOptions": { + "ConversationalAnalysisAuthoringCreateDeploymentOptions": { "required": [ "trainedModelLabel" ], @@ -1463,9 +1483,10 @@ "description": "Represents the trained model label.", "type": "string" } - } + }, + "x-ms-client-name": "CreateDeploymentOptions" }, - "CreateProjectOptions": { + "ConversationalAnalysisAuthoringCreateProjectOptions": { "required": [ "projectKind", "projectName", @@ -1475,11 +1496,11 @@ "properties": { "projectKind": { "description": "Represents the project kind.", - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" }, "settings": { "description": "Gets or sets the project settings.", - "$ref": "#/definitions/ProjectSettings" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" }, "projectName": { "description": "Gets or sets the new project name.", @@ -1497,9 +1518,10 @@ "description": "Gets or sets the project language.", "type": "string" } - } + }, + "x-ms-client-name": "CreateProjectOptions" }, - "DeploymentJobState": { + "ConversationalAnalysisAuthoringDeploymentJobState": { "required": [ "jobId", "createdDateTime", @@ -1530,7 +1552,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -1546,9 +1568,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "DeploymentJobState" }, - "EntitiesEvaluationSummary": { + "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { "required": [ "confusionMatrix", "entities", @@ -1563,19 +1586,13 @@ "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConfusionMatrixEntry" - } - } + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" }, "entities": { "description": "Represents the entities evaluation", "type": "object", "additionalProperties": { - "$ref": "#/definitions/EntityEvaluationSummary" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" } }, "microF1": { @@ -1608,9 +1625,10 @@ "description": "Represents the macro recall", "type": "number" } - } + }, + "x-ms-client-name": "EntitiesEvaluationSummary" }, - "EntityEvaluationSummary": { + "ConversationalAnalysisAuthoringEntityEvaluationSummary": { "required": [ "f1", "precision", @@ -1657,9 +1675,10 @@ "description": "Represents the count of false negative", "type": "integer" } - } + }, + "x-ms-client-name": "EntityEvaluationSummary" }, - "EvaluationKind": { + "ConversationalAnalysisAuthoringEvaluationKind": { "enum": [ "percentage", "manual" @@ -1668,14 +1687,15 @@ "x-ms-enum": { "name": "EvaluationKind", "modelAsString": true - } + }, + "x-ms-client-name": "EvaluationKind" }, - "EvaluationOptions": { + "ConversationalAnalysisAuthoringEvaluationOptions": { "type": "object", "properties": { "kind": { "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/EvaluationKind" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" }, "trainingSplitPercentage": { "format": "int32", @@ -1687,9 +1707,10 @@ "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", "type": "integer" } - } + }, + "x-ms-client-name": "EvaluationOptions" }, - "EvaluationResults": { + "ConversationalAnalysisAuthoringEvaluationResults": { "required": [ "value", "nextLink" @@ -1700,17 +1721,17 @@ "description": "Gets or sets the utterances predictions.", "type": "array", "items": { - "$ref": "#/definitions/UtteranceEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "EvaluationResults" }, - "EvaluationSummary": { + "ConversationalAnalysisAuthoringEvaluationSummary": { "required": [ "entitiesEvaluation", "intentsEvaluation" @@ -1719,18 +1740,19 @@ "properties": { "entitiesEvaluation": { "description": "Contains the data related to entities evaluation.", - "$ref": "#/definitions/EntitiesEvaluationSummary" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" }, "intentsEvaluation": { "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/IntentsEvaluation" + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluation" }, "evaluationOptions": { - "$ref": "#/definitions/EvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" } - } + }, + "x-ms-client-name": "EvaluationSummary" }, - "ExportedCluOrchestration": { + "ConversationalAnalysisAuthoringExportedCluOrchestration": { "required": [ "projectName", "deploymentName" @@ -1743,37 +1765,40 @@ "deploymentName": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedCluOrchestration" }, - "ExportedCluOrchestrationOptions": { + "ConversationalAnalysisAuthoringExportedCluOrchestrationOptions": { "required": [ "cluOrchestration" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], "properties": { "cluOrchestration": { - "$ref": "#/definitions/ExportedCluOrchestration" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedCluOrchestration" } }, - "x-ms-discriminator-value": "clu" + "x-ms-discriminator-value": "clu", + "x-ms-client-name": "ExportedCluOrchestrationOptions" }, - "ExportedEntityList": { + "ConversationalAnalysisAuthoringExportedEntityList": { "type": "object", "properties": { "sublists": { "type": "array", "items": { - "$ref": "#/definitions/ExportedEntitySublist" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" } } - } + }, + "x-ms-client-name": "ExportedEntityList" }, - "ExportedEntityListSynonym": { + "ConversationalAnalysisAuthoringExportedEntityListSynonym": { "type": "object", "properties": { "language": { @@ -1785,9 +1810,10 @@ "type": "string" } } - } + }, + "x-ms-client-name": "ExportedEntityListSynonym" }, - "ExportedEntitySublist": { + "ConversationalAnalysisAuthoringExportedEntitySublist": { "type": "object", "properties": { "listKey": { @@ -1796,12 +1822,13 @@ "synonyms": { "type": "array", "items": { - "$ref": "#/definitions/ExportedEntityListSynonym" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" } } - } + }, + "x-ms-client-name": "ExportedEntitySublist" }, - "ExportedLuisOrchestration": { + "ConversationalAnalysisAuthoringExportedLuisOrchestration": { "required": [ "appId" ], @@ -1818,38 +1845,41 @@ "slotName": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedLuisOrchestration" }, - "ExportedLuisOrchestrationOptions": { + "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { "required": [ "luisOrchestration" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], "properties": { "luisOrchestration": { - "$ref": "#/definitions/ExportedLuisOrchestration" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" } }, - "x-ms-discriminator-value": "luis" + "x-ms-discriminator-value": "luis", + "x-ms-client-name": "ExportedLuisOrchestrationOptions" }, - "ExportedOrchestrationOptions": { + "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { "required": [ "kind" ], "type": "object", "properties": { "kind": { - "$ref": "#/definitions/OrchestrationKind" + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationKind" } }, - "discriminator": "kind" + "discriminator": "kind", + "x-ms-client-name": "ExportedOrchestrationOptions" }, - "ExportedPrebuiltEntity": { + "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { "required": [ "category" ], @@ -1858,9 +1888,10 @@ "category": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedPrebuiltEntity" }, - "ExportedProject": { + "ConversationalAnalysisAuthoringExportedProject": { "required": [ "project-file-version", "stringIndexType", @@ -1873,31 +1904,33 @@ }, "stringIndexType": { "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/StringIndexType" + "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" }, "metadata": { "description": "Represents the project metadata.", - "$ref": "#/definitions/CreateProjectOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" }, "assets": { "description": "Represents the project assets.", - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" } - } + }, + "x-ms-client-name": "ExportedProject" }, - "ExportedProjectAssets": { + "ConversationalAnalysisAuthoringExportedProjectAssets": { "required": [ "projectKind" ], "type": "object", "properties": { "projectKind": { - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" } }, - "discriminator": "projectKind" + "discriminator": "projectKind", + "x-ms-client-name": "ExportedProjectAssets" }, - "ExportedProjectFormat": { + "ConversationalAnalysisAuthoringExportedProjectFormat": { "enum": [ "clu", "luis" @@ -1906,9 +1939,10 @@ "x-ms-enum": { "name": "ExportedProjectFormat", "modelAsString": true - } + }, + "x-ms-client-name": "ExportedProjectFormat" }, - "ExportedQnaOrchestration": { + "ConversationalAnalysisAuthoringExportedQnaOrchestration": { "required": [ "projectName" ], @@ -1917,26 +1951,28 @@ "projectName": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedQnaOrchestration" }, - "ExportedQnaOrchestrationOptions": { + "ConversationalAnalysisAuthoringExportedQnaOrchestrationOptions": { "required": [ "qnaOrchestration" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" } ], "properties": { "qnaOrchestration": { - "$ref": "#/definitions/ExportedQnaOrchestration" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQnaOrchestration" } }, - "x-ms-discriminator-value": "qna" + "x-ms-discriminator-value": "qna", + "x-ms-client-name": "ExportedQnaOrchestrationOptions" }, - "ExportedUtteranceEntityLabel": { + "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { "required": [ "category", "offset", @@ -1955,9 +1991,10 @@ "format": "int32", "type": "integer" } - } + }, + "x-ms-client-name": "ExportedUtteranceEntityLabel" }, - "ExportProjectJobState": { + "ConversationalAnalysisAuthoringExportProjectJobState": { "required": [ "jobId", "createdDateTime", @@ -1991,7 +2028,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2007,9 +2044,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "ExportProjectJobState" }, - "ImportProjectJobState": { + "ConversationalAnalysisAuthoringImportProjectJobState": { "required": [ "jobId", "createdDateTime", @@ -2040,7 +2078,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2056,9 +2094,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "ImportProjectJobState" }, - "IntentEvaluation": { + "ConversationalAnalysisAuthoringIntentEvaluation": { "required": [ "f1", "precision", @@ -2105,9 +2144,10 @@ "description": "Represents the count of false negative", "type": "integer" } - } + }, + "x-ms-client-name": "IntentEvaluation" }, - "IntentsEvaluation": { + "ConversationalAnalysisAuthoringIntentsEvaluation": { "required": [ "confusionMatrix", "intents", @@ -2122,19 +2162,13 @@ "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConfusionMatrixEntry" - } - } + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" }, "intents": { "description": "Represents the intents evaluation.", "type": "object", "additionalProperties": { - "$ref": "#/definitions/IntentEvaluation" + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluation" } }, "microF1": { @@ -2167,9 +2201,10 @@ "description": "Represents the macro recall", "type": "number" } - } + }, + "x-ms-client-name": "IntentsEvaluation" }, - "JobStatus": { + "ConversationalAnalysisAuthoringJobStatus": { "enum": [ "unknown", "notStarted", @@ -2184,46 +2219,49 @@ "x-ms-enum": { "name": "JobStatus", "modelAsString": true - } + }, + "x-ms-client-name": "JobStatus" }, - "OrchestrationExportedIntent": { + "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { "required": [ "category" ], "type": "object", "properties": { "orchestration": { - "$ref": "#/definitions/ExportedOrchestrationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" }, "category": { "type": "string" } - } + }, + "x-ms-client-name": "OrchestrationExportedIntent" }, - "OrchestrationExportedProjectAssets": { + "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" } ], "properties": { "intents": { "type": "array", "items": { - "$ref": "#/definitions/OrchestrationExportedIntent" + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" } }, "utterances": { "type": "array", "items": { - "$ref": "#/definitions/OrchestrationExportedUtterance" + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" } } }, - "x-ms-discriminator-value": "orchestration" + "x-ms-discriminator-value": "orchestration", + "x-ms-client-name": "OrchestrationExportedProjectAssets" }, - "OrchestrationExportedUtterance": { + "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { "required": [ "text", "intent" @@ -2243,9 +2281,10 @@ "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", "type": "string" } - } + }, + "x-ms-client-name": "OrchestrationExportedUtterance" }, - "OrchestrationKind": { + "ConversationalAnalysisAuthoringOrchestrationKind": { "enum": [ "luis", "clu", @@ -2255,9 +2294,10 @@ "x-ms-enum": { "name": "OrchestrationKind", "modelAsString": true - } + }, + "x-ms-client-name": "OrchestrationKind" }, - "PrebuiltEntities": { + "ConversationalAnalysisAuthoringPrebuiltEntities": { "required": [ "value", "nextLink" @@ -2268,17 +2308,17 @@ "description": "The supported prebuilt entities.", "type": "array", "items": { - "$ref": "#/definitions/PrebuiltEntity" + "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" } }, "nextLink": { "description": "The next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "PrebuiltEntities" }, - "PrebuiltEntity": { + "ConversationalAnalysisAuthoringPrebuiltEntity": { "required": [ "category", "description", @@ -2298,9 +2338,10 @@ "description": "English examples for the entity.", "type": "string" } - } + }, + "x-ms-client-name": "PrebuiltEntity" }, - "ProjectDeletionJobState": { + "ConversationalAnalysisAuthoringProjectDeletionJobState": { "required": [ "jobId", "createdDateTime", @@ -2331,7 +2372,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2347,9 +2388,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "ProjectDeletionJobState" }, - "ProjectDeployment": { + "ConversationalAnalysisAuthoringProjectDeployment": { "required": [ "deploymentName", "modelId", @@ -2387,9 +2429,10 @@ "description": "Represents model training config version.", "type": "string" } - } + }, + "x-ms-client-name": "ProjectDeployment" }, - "ProjectDeployments": { + "ConversationalAnalysisAuthoringProjectDeployments": { "required": [ "value", "nextLink" @@ -2400,17 +2443,17 @@ "description": "Gets or sets the deployments.", "type": "array", "items": { - "$ref": "#/definitions/ProjectDeployment" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "ProjectDeployments" }, - "ProjectKind": { + "ConversationalAnalysisAuthoringProjectKind": { "enum": [ "conversation", "orchestration" @@ -2419,9 +2462,10 @@ "x-ms-enum": { "name": "ProjectKind", "modelAsString": true - } + }, + "x-ms-client-name": "ProjectKind" }, - "ProjectMetadata": { + "ConversationalAnalysisAuthoringProjectMetadata": { "required": [ "createdDateTime", "lastModifiedDateTime", @@ -2453,11 +2497,11 @@ }, "projectKind": { "description": "Represents the project kind.", - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" }, "settings": { "description": "Gets or sets the project settings.", - "$ref": "#/definitions/ProjectSettings" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" }, "projectName": { "description": "Gets or sets the new project name.", @@ -2475,9 +2519,10 @@ "description": "Gets or sets the project language.", "type": "string" } - } + }, + "x-ms-client-name": "ProjectMetadata" }, - "ProjectSettings": { + "ConversationalAnalysisAuthoringProjectSettings": { "required": [ "confidenceThreshold" ], @@ -2487,9 +2532,10 @@ "format": "float", "type": "number" } - } + }, + "x-ms-client-name": "ProjectSettings" }, - "ProjectsMetadata": { + "ConversationalAnalysisAuthoringProjectsMetadata": { "required": [ "value", "nextLink" @@ -2500,17 +2546,17 @@ "description": "Gets or sets the projects.", "type": "array", "items": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "ProjectsMetadata" }, - "ProjectTrainedModel": { + "ConversationalAnalysisAuthoringProjectTrainedModel": { "required": [ "label", "modelId", @@ -2548,9 +2594,10 @@ "description": "Represents the model training config version.", "type": "string" } - } + }, + "x-ms-client-name": "ProjectTrainedModel" }, - "ProjectTrainedModels": { + "ConversationalAnalysisAuthoringProjectTrainedModels": { "required": [ "value", "nextLink" @@ -2561,17 +2608,17 @@ "description": "Gets or sets the jobs.", "type": "array", "items": { - "$ref": "#/definitions/ProjectTrainedModel" + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "ProjectTrainedModels" }, - "StringIndexType": { + "ConversationalAnalysisAuthoringStringIndexType": { "enum": [ "Utf16CodeUnit" ], @@ -2579,9 +2626,10 @@ "x-ms-enum": { "name": "StringIndexType", "modelAsString": true - } + }, + "x-ms-client-name": "StringIndexType" }, - "SubTrainingJobState": { + "ConversationalAnalysisAuthoringSubTrainingJobState": { "required": [ "percentComplete", "status" @@ -2605,11 +2653,12 @@ }, "status": { "description": "Represents the status of the job.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" } - } + }, + "x-ms-client-name": "SubTrainingJobState" }, - "SupportedLanguage": { + "ConversationalAnalysisAuthoringSupportedLanguage": { "required": [ "languageName", "languageCode" @@ -2624,9 +2673,10 @@ "description": "Gets or sets the language code.", "type": "string" } - } + }, + "x-ms-client-name": "SupportedLanguage" }, - "SupportedLanguages": { + "ConversationalAnalysisAuthoringSupportedLanguages": { "required": [ "value", "nextLink" @@ -2637,17 +2687,17 @@ "description": "The list of supported objects.", "type": "array", "items": { - "$ref": "#/definitions/SupportedLanguage" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" } }, "nextLink": { "description": "The next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "SupportedLanguages" }, - "SwapDeploymentsOptions": { + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { "required": [ "firstDeploymentName", "secondDeploymentName" @@ -2662,9 +2712,10 @@ "description": "Represents the second deployment name.", "type": "string" } - } + }, + "x-ms-client-name": "SwapDeploymentsOptions" }, - "TrainingConfigVersion": { + "ConversationalAnalysisAuthoringTrainingConfigVersion": { "required": [ "trainingConfigVersion", "modelExpirationDate" @@ -2680,9 +2731,10 @@ "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", "type": "string" } - } + }, + "x-ms-client-name": "TrainingConfigVersion" }, - "TrainingConfigVersions": { + "ConversationalAnalysisAuthoringTrainingConfigVersions": { "required": [ "value", "nextLink" @@ -2693,17 +2745,17 @@ "description": "Gets or sets the training config versions.", "type": "array", "items": { - "$ref": "#/definitions/TrainingConfigVersion" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "TrainingConfigVersions" }, - "TrainingJobOptions": { + "ConversationalAnalysisAuthoringTrainingJobOptions": { "required": [ "modelLabel", "trainingMode" @@ -2720,15 +2772,16 @@ }, "trainingMode": { "description": "Represents the training mode of the training operation.", - "$ref": "#/definitions/TrainingMode" + "$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/EvaluationOptions" + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" } - } + }, + "x-ms-client-name": "TrainingJobOptions" }, - "TrainingJobResult": { + "ConversationalAnalysisAuthoringTrainingJobResult": { "required": [ "modelLabel", "trainingConfigVersion", @@ -2746,24 +2799,25 @@ }, "trainingMode": { "description": "Represents the training mode of the training operation.", - "$ref": "#/definitions/TrainingMode" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" }, "trainingStatus": { "description": "Represents model train status.", - "$ref": "#/definitions/SubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" }, "evaluationStatus": { "description": "Represents model evaluation status.", - "$ref": "#/definitions/SubTrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" }, "estimatedEndDateTime": { "format": "date-time", "description": "Represents the estimate end date time for training and evaluation.", "type": "string" } - } + }, + "x-ms-client-name": "TrainingJobResult" }, - "TrainingJobs": { + "ConversationalAnalysisAuthoringTrainingJobs": { "required": [ "value", "nextLink" @@ -2774,17 +2828,17 @@ "description": "Gets or sets the jobs.", "type": "array", "items": { - "$ref": "#/definitions/TrainingJobState" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "TrainingJobs" }, - "TrainingJobState": { + "ConversationalAnalysisAuthoringTrainingJobState": { "required": [ "result", "jobId", @@ -2797,7 +2851,7 @@ "properties": { "result": { "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/TrainingJobResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" }, "jobId": { "description": "Gets or sets the job ID.", @@ -2820,7 +2874,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2836,9 +2890,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "TrainingJobState" }, - "TrainingMode": { + "ConversationalAnalysisAuthoringTrainingMode": { "enum": [ "advanced", "standard" @@ -2847,9 +2902,10 @@ "x-ms-enum": { "name": "TrainingMode", "modelAsString": true - } + }, + "x-ms-client-name": "TrainingMode" }, - "UtteranceEntitiesEvaluationResult": { + "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { "required": [ "expectedEntities", "predictedEntities" @@ -2860,19 +2916,20 @@ "description": "Represents the expected entity labels.", "type": "array", "items": { - "$ref": "#/definitions/UtteranceEntityEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" } }, "predictedEntities": { "description": "Represents the predicted entity labels.", "type": "array", "items": { - "$ref": "#/definitions/UtteranceEntityEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" } } - } + }, + "x-ms-client-name": "UtteranceEntitiesEvaluationResult" }, - "UtteranceEntityEvaluationResult": { + "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { "required": [ "category", "offset", @@ -2894,9 +2951,10 @@ "description": "Represents the entity length.", "type": "integer" } - } + }, + "x-ms-client-name": "UtteranceEntityEvaluationResult" }, - "UtteranceEvaluationResult": { + "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { "required": [ "text", "language", @@ -2915,15 +2973,16 @@ }, "entitiesResult": { "description": "Represents the entities results for the utterance.", - "$ref": "#/definitions/UtteranceEntitiesEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" }, "intentsResult": { "description": "Represents the intents results for the utterance.", - "$ref": "#/definitions/UtteranceIntentsEvaluationResult" + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" } - } + }, + "x-ms-client-name": "UtteranceEvaluationResult" }, - "UtteranceIntentsEvaluationResult": { + "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { "required": [ "expectedIntent", "predictedIntent" @@ -2938,11 +2997,12 @@ "description": "Represents the utterance's predicted intent.", "type": "string" } - } + }, + "x-ms-client-name": "UtteranceIntentsEvaluationResult" } }, "parameters": { - "FormatInQuery": { + "ConversationalAnalysisAuthoringFormatInQuery": { "in": "query", "name": "format", "description": "The format of the project to export. The currently supported format is `clu`.", @@ -2957,7 +3017,7 @@ }, "x-ms-parameter-location": "method" }, - "StringIndexTypeInQuery": { + "ConversationalAnalysisAuthoringStringIndexTypeInQuery": { "in": "query", "name": "stringIndexType", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", @@ -2972,7 +3032,7 @@ }, "x-ms-parameter-location": "method" }, - "ProjectKindInQuery": { + "ConversationalAnalysisAuthoringProjectKindInQuery": { "in": "query", "name": "projectKind", "description": "The project kind to get the supported languages for.", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 4dd91bc2eb6c..4214e9f5b296 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -53,7 +53,7 @@ "200": { "description": "The metadata of projects.", "schema": { - "$ref": "#/definitions/ProjectsMetadata" + "$ref": "#/definitions/TextAnalysisAuthoringProjectsMetadata" } }, "default": { @@ -94,7 +94,7 @@ "description": "The project parameters.", "required": true, "schema": { - "$ref": "#/definitions/CreateProjectOptions" + "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" } }, { @@ -105,13 +105,13 @@ "200": { "description": "The metadata of the updated project, if it already exists.", "schema": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" } }, "201": { "description": "The metadata of the created project.", "schema": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" } }, "default": { @@ -145,7 +145,7 @@ "200": { "description": "The metadata of the project.", "schema": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" } }, "default": { @@ -212,7 +212,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "$ref": "#/parameters/StringIndexTypeInQuery" + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeInQuery" }, { "in": "query", @@ -275,7 +275,7 @@ "description": "The project data to import.", "required": true, "schema": { - "$ref": "#/definitions/ExportedProject" + "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" } }, { @@ -327,7 +327,7 @@ "description": "The training input parameters.", "required": true, "schema": { - "$ref": "#/definitions/TrainingJobOptions" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" } }, { @@ -387,7 +387,7 @@ "200": { "description": "List of all deployments.", "schema": { - "$ref": "#/definitions/ProjectDeployments" + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployments" } }, "default": { @@ -428,7 +428,7 @@ "description": "The job object to swap two deployments.", "required": true, "schema": { - "$ref": "#/definitions/SwapDeploymentsOptions" + "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" } }, { @@ -482,7 +482,7 @@ "200": { "description": "The Deployment info.", "schema": { - "$ref": "#/definitions/ProjectDeployment" + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" } }, "default": { @@ -520,7 +520,7 @@ "description": "The new deployment info.", "required": true, "schema": { - "$ref": "#/definitions/CreateDeploymentOptions" + "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" } }, { @@ -622,7 +622,7 @@ "200": { "description": "The deployment job result.", "schema": { - "$ref": "#/definitions/DeploymentJobState" + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" } }, "default": { @@ -665,7 +665,7 @@ "200": { "description": "The swap deployment job result.", "schema": { - "$ref": "#/definitions/DeploymentJobState" + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" } }, "default": { @@ -708,7 +708,7 @@ "200": { "description": "The status of the long running operation.", "schema": { - "$ref": "#/definitions/ExportProjectJobState" + "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" } }, "default": { @@ -751,7 +751,7 @@ "200": { "description": "The details of the long running operation.", "schema": { - "$ref": "#/definitions/ImportProjectJobState" + "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" } }, "default": { @@ -796,7 +796,7 @@ "200": { "description": "List of all trained models.", "schema": { - "$ref": "#/definitions/ProjectTrainedModels" + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModels" } }, "default": { @@ -843,7 +843,7 @@ "200": { "description": "Trained model info", "schema": { - "$ref": "#/definitions/ProjectTrainedModel" + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" } }, "default": { @@ -917,7 +917,7 @@ "type": "string" }, { - "$ref": "#/parameters/StringIndexTypeInQuery" + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeInQuery" }, { "$ref": "common.json#/parameters/TopParameter" @@ -936,7 +936,7 @@ "200": { "description": "List of the evaluation results.", "schema": { - "$ref": "#/definitions/EvaluationResults" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationResults" } }, "default": { @@ -983,7 +983,7 @@ "200": { "description": "List of all evaluation results.", "schema": { - "$ref": "#/definitions/EvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" } }, "default": { @@ -1028,7 +1028,7 @@ "200": { "description": "List of the training jobs.", "schema": { - "$ref": "#/definitions/TrainingJobs" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobs" } }, "default": { @@ -1075,7 +1075,7 @@ "200": { "description": "The training job result.", "schema": { - "$ref": "#/definitions/TrainingJobState" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" } }, "default": { @@ -1155,7 +1155,7 @@ "200": { "description": "The project deletion job result.", "schema": { - "$ref": "#/definitions/ProjectDeletionJobState" + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" } }, "default": { @@ -1197,7 +1197,7 @@ "200": { "description": "The list of supported languages.", "schema": { - "$ref": "#/definitions/SupportedLanguages" + "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguages" } }, "default": { @@ -1227,7 +1227,7 @@ ], "parameters": [ { - "$ref": "#/parameters/ProjectKindInQuery" + "$ref": "#/parameters/TextAnalysisAuthoringProjectKindInQuery" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1246,7 +1246,7 @@ "200": { "description": "List of all trained models.", "schema": { - "$ref": "#/definitions/TrainingConfigVersions" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersions" } }, "default": { @@ -1269,7 +1269,14 @@ } }, "definitions": { - "ConfusionMatrix": { + "TextAnalysisAuthoringConfusionMatrix": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" + }, + "x-ms-client-name": "ConfusionMatrix" + }, + "TextAnalysisAuthoringConfusionMatrixEntry": { "required": [ "normalizedValue", "rawValue" @@ -1286,9 +1293,17 @@ "description": "Represents raw value.", "type": "number" } - } + }, + "x-ms-client-name": "ConfusionMatrixEntry" + }, + "TextAnalysisAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixEntry" + }, + "x-ms-client-name": "ConfusionMatrixRow" }, - "CreateDeploymentOptions": { + "TextAnalysisAuthoringCreateDeploymentOptions": { "required": [ "trainedModelLabel" ], @@ -1298,9 +1313,10 @@ "description": "Represents the trained model label.", "type": "string" } - } + }, + "x-ms-client-name": "CreateDeploymentOptions" }, - "CreateProjectOptions": { + "TextAnalysisAuthoringCreateProjectOptions": { "required": [ "projectKind", "storageInputContainerName", @@ -1311,7 +1327,7 @@ "properties": { "projectKind": { "description": "Gets or sets the new project model kind.", - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" }, "storageInputContainerName": { "description": "Gets or sets the storage container name.", @@ -1319,7 +1335,7 @@ }, "settings": { "description": "Gets or sets the project settings.", - "$ref": "#/definitions/ProjectSettings" + "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" }, "projectName": { "description": "Gets or sets the new project name.", @@ -1337,117 +1353,124 @@ "description": "Gets or sets the project language.", "type": "string" } - } + }, + "x-ms-client-name": "CreateProjectOptions" }, - "CustomMultiLabelClassificationDocumentEvaluationPrediction": { + "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationPrediction": { "required": [ "customMultiLabelClassificationResult" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DocumentEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" } ], "properties": { "customMultiLabelClassificationResult": { "description": "Represents the evaluation prediction for multi label classification.", - "$ref": "#/definitions/DocumentMultiLabelClassificationEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult" } }, - "x-ms-discriminator-value": "customMultiLabelClassification" + "x-ms-discriminator-value": "customMultiLabelClassification", + "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationPrediction" }, - "CustomMultiLabelClassificationEvaluationSummary": { + "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { "required": [ "customMultiLabelClassificationEvaluation" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/EvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" } ], "properties": { "customMultiLabelClassificationEvaluation": { "description": "Contains the data related to multi label classification evaluation.", - "$ref": "#/definitions/MultiLabelClassificationEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary" } }, - "x-ms-discriminator-value": "customMultiLabelClassification" + "x-ms-discriminator-value": "customMultiLabelClassification", + "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" }, - "CustomNamedEntityRecognitionDocumentEvaluationPrediction": { + "TextAnalysisAuthoringCustomNamedEntityRecognitionDocumentEvaluationPrediction": { "required": [ "customNamedEntityRecognitionResult" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DocumentEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" } ], "properties": { "customNamedEntityRecognitionResult": { "description": "Represents the evaluation prediction for named entity recognition.", - "$ref": "#/definitions/DocumentNamedEntityRecognitionEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentNamedEntityRecognitionEvaluationResult" } }, - "x-ms-discriminator-value": "customNamedEntityRecognition" + "x-ms-discriminator-value": "customNamedEntityRecognition", + "x-ms-client-name": "CustomNamedEntityRecognitionDocumentEvaluationPrediction" }, - "CustomNamedEntityRecognitionEvaluationSummary": { + "TextAnalysisAuthoringCustomNamedEntityRecognitionEvaluationSummary": { "required": [ "customNamedEntityRecognitionEvaluation" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/EvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" } ], "properties": { "customNamedEntityRecognitionEvaluation": { "description": "Contains the data related to extraction evaluation.", - "$ref": "#/definitions/NamedEntityRecognitionEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary" } }, - "x-ms-discriminator-value": "customNamedEntityRecognition" + "x-ms-discriminator-value": "customNamedEntityRecognition", + "x-ms-client-name": "CustomNamedEntityRecognitionEvaluationSummary" }, - "CustomSingleLabelClassificationDocumentEvaluationPrediction": { + "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationPrediction": { "required": [ "customSingleLabelClassificationResult" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/DocumentEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" } ], "properties": { "customSingleLabelClassificationResult": { "description": "Represents the evaluation prediction for single label classification.", - "$ref": "#/definitions/DocumentSingleLabelClassificationEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult" } }, - "x-ms-discriminator-value": "customSingleLabelClassification" + "x-ms-discriminator-value": "customSingleLabelClassification", + "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationPrediction" }, - "CustomSingleLabelClassificationEvaluationSummary": { + "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { "required": [ "customSingleLabelClassificationEvaluation" ], "type": "object", "allOf": [ { - "$ref": "#/definitions/EvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" } ], "properties": { "customSingleLabelClassificationEvaluation": { "description": "Contains the data related to single label classification evaluation.", - "$ref": "#/definitions/SingleLabelClassificationEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary" } }, - "x-ms-discriminator-value": "customSingleLabelClassification" + "x-ms-discriminator-value": "customSingleLabelClassification", + "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" }, - "DeploymentJobState": { + "TextAnalysisAuthoringDeploymentJobState": { "required": [ "jobId", "createdDateTime", @@ -1478,7 +1501,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -1494,9 +1517,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "DeploymentJobState" }, - "DocumentEntityLabelEvaluationResult": { + "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { "required": [ "category", "offset", @@ -1518,9 +1542,10 @@ "description": "Represents the entity length.", "type": "integer" } - } + }, + "x-ms-client-name": "DocumentEntityLabelEvaluationResult" }, - "DocumentEntityRegionEvaluationResult": { + "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { "required": [ "expectedEntities", "predictedEntities", @@ -1533,14 +1558,14 @@ "description": "Represents the region's expected entity labels.", "type": "array", "items": { - "$ref": "#/definitions/DocumentEntityLabelEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" } }, "predictedEntities": { "description": "Represents the region's predicted entity labels.", "type": "array", "items": { - "$ref": "#/definitions/DocumentEntityLabelEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" } }, "regionOffset": { @@ -1553,9 +1578,10 @@ "description": "Represents the region length.", "type": "integer" } - } + }, + "x-ms-client-name": "DocumentEntityRegionEvaluationResult" }, - "DocumentEvaluationResult": { + "TextAnalysisAuthoringDocumentEvaluationResult": { "required": [ "location", "language", @@ -1573,12 +1599,13 @@ }, "projectKind": { "description": "Represents the project kind.", - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" } }, - "discriminator": "projectKind" + "discriminator": "projectKind", + "x-ms-client-name": "DocumentEvaluationResult" }, - "DocumentMultiLabelClassificationEvaluationResult": { + "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { "required": [ "expectedClasses", "predictedClasses" @@ -1599,9 +1626,10 @@ "type": "string" } } - } + }, + "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" }, - "DocumentNamedEntityRecognitionEvaluationResult": { + "TextAnalysisAuthoringDocumentNamedEntityRecognitionEvaluationResult": { "required": [ "entities" ], @@ -1611,12 +1639,13 @@ "description": "Represents the document labelled entities.", "type": "array", "items": { - "$ref": "#/definitions/DocumentEntityRegionEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" } } - } + }, + "x-ms-client-name": "DocumentNamedEntityRecognitionEvaluationResult" }, - "DocumentSingleLabelClassificationEvaluationResult": { + "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { "required": [ "expectedClass", "predictedClass" @@ -1631,9 +1660,10 @@ "description": "Represents the document's predicted class.", "type": "string" } - } + }, + "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" }, - "EntityEvaluationSummary": { + "TextAnalysisAuthoringEntityEvaluationSummary": { "required": [ "f1", "precision", @@ -1680,9 +1710,10 @@ "description": "Represents the count of false negative", "type": "integer" } - } + }, + "x-ms-client-name": "EntityEvaluationSummary" }, - "EvaluationKind": { + "TextAnalysisAuthoringEvaluationKind": { "enum": [ "percentage", "manual" @@ -1691,14 +1722,15 @@ "x-ms-enum": { "name": "EvaluationKind", "modelAsString": true - } + }, + "x-ms-client-name": "EvaluationKind" }, - "EvaluationOptions": { + "TextAnalysisAuthoringEvaluationOptions": { "type": "object", "properties": { "kind": { "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", - "$ref": "#/definitions/EvaluationKind" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationKind" }, "trainingSplitPercentage": { "format": "int32", @@ -1710,9 +1742,10 @@ "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", "type": "integer" } - } + }, + "x-ms-client-name": "EvaluationOptions" }, - "EvaluationResults": { + "TextAnalysisAuthoringEvaluationResults": { "required": [ "value", "nextLink" @@ -1723,17 +1756,17 @@ "description": "Gets or sets the documents predictions.", "type": "array", "items": { - "$ref": "#/definitions/DocumentEvaluationResult" + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "EvaluationResults" }, - "EvaluationSummary": { + "TextAnalysisAuthoringEvaluationSummary": { "required": [ "projectKind", "customNamedEntityRecognitionEvaluation", @@ -1743,33 +1776,35 @@ "properties": { "projectKind": { "description": "Represents the model kind.", - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" }, "customNamedEntityRecognitionEvaluation": { "description": "Contains the data related to extraction evaluation.", - "$ref": "#/definitions/NamedEntityRecognitionEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary" }, "evaluationOptions": { - "$ref": "#/definitions/EvaluationOptions" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" } }, - "discriminator": "projectKind" + "discriminator": "projectKind", + "x-ms-client-name": "EvaluationSummary" }, - "ExportedClass": { + "TextAnalysisAuthoringExportedClass": { "type": "object", "properties": { "category": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedClass" }, - "ExportedCustomMultiLabelClassificationDocument": { + "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { "type": "object", "properties": { "classes": { "type": "array", "items": { - "$ref": "#/definitions/ExportedDocumentClass" + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" } }, "location": { @@ -1782,38 +1817,40 @@ "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", "type": "string" } - } + }, + "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" }, - "ExportedCustomMultiLabelClassificationProjectAssets": { + "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" } ], "properties": { "classes": { "type": "array", "items": { - "$ref": "#/definitions/ExportedClass" + "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" } }, "documents": { "type": "array", "items": { - "$ref": "#/definitions/ExportedCustomMultiLabelClassificationDocument" + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" } } }, - "x-ms-discriminator-value": "customMultiLabelClassification" + "x-ms-discriminator-value": "customMultiLabelClassification", + "x-ms-client-name": "ExportedCustomMultiLabelClassificationProjectAssets" }, - "ExportedCustomNamedEntityRecognitionDocument": { + "TextAnalysisAuthoringExportedCustomNamedEntityRecognitionDocument": { "type": "object", "properties": { "entities": { "type": "array", "items": { - "$ref": "#/definitions/ExportedDocumentRegion" + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentRegion" } }, "location": { @@ -1826,36 +1863,38 @@ "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", "type": "string" } - } + }, + "x-ms-client-name": "ExportedCustomNamedEntityRecognitionDocument" }, - "ExportedCustomNamedEntityRecognitionProjectAssets": { + "TextAnalysisAuthoringExportedCustomNamedEntityRecognitionProjectAssets": { "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" } ], "properties": { "entities": { "type": "array", "items": { - "$ref": "#/definitions/ExportedEntity" + "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" } }, "documents": { "type": "array", "items": { - "$ref": "#/definitions/ExportedCustomNamedEntityRecognitionDocument" + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomNamedEntityRecognitionDocument" } } }, - "x-ms-discriminator-value": "customNamedEntityRecognition" + "x-ms-discriminator-value": "customNamedEntityRecognition", + "x-ms-client-name": "ExportedCustomNamedEntityRecognitionProjectAssets" }, - "ExportedCustomSingleLabelClassificationDocument": { + "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { "type": "object", "properties": { "class": { - "$ref": "#/definitions/ExportedDocumentClass" + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" }, "location": { "type": "string" @@ -1867,40 +1906,43 @@ "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", "type": "string" } - } + }, + "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" }, - "ExportedCustomSingleLabelClassificationProjectAssets": { + "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { "type": "object", "allOf": [ { - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" } ], "properties": { "classes": { "type": "array", "items": { - "$ref": "#/definitions/ExportedClass" + "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" } }, "documents": { "type": "array", "items": { - "$ref": "#/definitions/ExportedCustomSingleLabelClassificationDocument" + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" } } }, - "x-ms-discriminator-value": "customSingleLabelClassification" + "x-ms-discriminator-value": "customSingleLabelClassification", + "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" }, - "ExportedDocumentClass": { + "TextAnalysisAuthoringExportedDocumentClass": { "type": "object", "properties": { "category": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedDocumentClass" }, - "ExportedDocumentEntityLabel": { + "TextAnalysisAuthoringExportedDocumentEntityLabel": { "type": "object", "properties": { "category": { @@ -1914,9 +1956,10 @@ "format": "int32", "type": "integer" } - } + }, + "x-ms-client-name": "ExportedDocumentEntityLabel" }, - "ExportedDocumentRegion": { + "TextAnalysisAuthoringExportedDocumentRegion": { "type": "object", "properties": { "regionOffset": { @@ -1930,20 +1973,22 @@ "labels": { "type": "array", "items": { - "$ref": "#/definitions/ExportedDocumentEntityLabel" + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" } } - } + }, + "x-ms-client-name": "ExportedDocumentRegion" }, - "ExportedEntity": { + "TextAnalysisAuthoringExportedEntity": { "type": "object", "properties": { "category": { "type": "string" } - } + }, + "x-ms-client-name": "ExportedEntity" }, - "ExportedProject": { + "TextAnalysisAuthoringExportedProject": { "required": [ "project-file-version", "stringIndexType", @@ -1956,31 +2001,33 @@ }, "stringIndexType": { "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", - "$ref": "#/definitions/StringIndexType" + "$ref": "#/definitions/TextAnalysisAuthoringStringIndexType" }, "metadata": { "description": "Represents the project metadata.", - "$ref": "#/definitions/CreateProjectOptions" + "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" }, "assets": { "description": "Represents the project assets.", - "$ref": "#/definitions/ExportedProjectAssets" + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" } - } + }, + "x-ms-client-name": "ExportedProject" }, - "ExportedProjectAssets": { + "TextAnalysisAuthoringExportedProjectAssets": { "required": [ "projectKind" ], "type": "object", "properties": { "projectKind": { - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" } }, - "discriminator": "projectKind" + "discriminator": "projectKind", + "x-ms-client-name": "ExportedProjectAssets" }, - "ExportProjectJobState": { + "TextAnalysisAuthoringExportProjectJobState": { "required": [ "jobId", "createdDateTime", @@ -2014,7 +2061,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2030,9 +2077,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "ExportProjectJobState" }, - "ImportProjectJobState": { + "TextAnalysisAuthoringImportProjectJobState": { "required": [ "jobId", "createdDateTime", @@ -2063,7 +2111,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2079,9 +2127,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "ImportProjectJobState" }, - "JobStatus": { + "TextAnalysisAuthoringJobStatus": { "enum": [ "unknown", "notStarted", @@ -2096,9 +2145,10 @@ "x-ms-enum": { "name": "JobStatus", "modelAsString": true - } + }, + "x-ms-client-name": "JobStatus" }, - "MultiLabelClassEvaluationSummary": { + "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { "required": [ "f1", "precision", @@ -2145,9 +2195,10 @@ "description": "Represents the count of false negative", "type": "integer" } - } + }, + "x-ms-client-name": "MultiLabelClassEvaluationSummary" }, - "MultiLabelClassificationEvaluationSummary": { + "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { "required": [ "classes", "microF1", @@ -2163,7 +2214,7 @@ "description": "Represents the classes evaluation", "type": "object", "additionalProperties": { - "$ref": "#/definitions/MultiLabelClassEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" } }, "microF1": { @@ -2196,9 +2247,10 @@ "description": "Represents the macro recall", "type": "number" } - } + }, + "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" }, - "NamedEntityRecognitionEvaluationSummary": { + "TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary": { "required": [ "confusionMatrix", "entities", @@ -2213,19 +2265,13 @@ "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConfusionMatrix" - } - } + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" }, "entities": { "description": "Represents the entities evaluation", "type": "object", "additionalProperties": { - "$ref": "#/definitions/EntityEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" } }, "microF1": { @@ -2258,9 +2304,10 @@ "description": "Represents the macro recall", "type": "number" } - } + }, + "x-ms-client-name": "NamedEntityRecognitionEvaluationSummary" }, - "ProjectDeletionJobState": { + "TextAnalysisAuthoringProjectDeletionJobState": { "required": [ "jobId", "createdDateTime", @@ -2291,7 +2338,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2307,9 +2354,10 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "ProjectDeletionJobState" }, - "ProjectDeployment": { + "TextAnalysisAuthoringProjectDeployment": { "required": [ "deploymentName", "modelId", @@ -2347,9 +2395,10 @@ "description": "Represents model training config version.", "type": "string" } - } + }, + "x-ms-client-name": "ProjectDeployment" }, - "ProjectDeployments": { + "TextAnalysisAuthoringProjectDeployments": { "required": [ "value", "nextLink" @@ -2360,17 +2409,17 @@ "description": "Gets or sets the deployments.", "type": "array", "items": { - "$ref": "#/definitions/ProjectDeployment" + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "ProjectDeployments" }, - "ProjectKind": { + "TextAnalysisAuthoringProjectKind": { "enum": [ "customSingleLabelClassification", "customMultiLabelClassification", @@ -2380,9 +2429,10 @@ "x-ms-enum": { "name": "ProjectKind", "modelAsString": true - } + }, + "x-ms-client-name": "ProjectKind" }, - "ProjectMetadata": { + "TextAnalysisAuthoringProjectMetadata": { "required": [ "createdDateTime", "lastModifiedDateTime", @@ -2415,7 +2465,7 @@ }, "projectKind": { "description": "Gets or sets the new project model kind.", - "$ref": "#/definitions/ProjectKind" + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" }, "storageInputContainerName": { "description": "Gets or sets the storage container name.", @@ -2423,7 +2473,7 @@ }, "settings": { "description": "Gets or sets the project settings.", - "$ref": "#/definitions/ProjectSettings" + "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" }, "projectName": { "description": "Gets or sets the new project name.", @@ -2441,12 +2491,14 @@ "description": "Gets or sets the project language.", "type": "string" } - } + }, + "x-ms-client-name": "ProjectMetadata" }, - "ProjectSettings": { - "type": "object" + "TextAnalysisAuthoringProjectSettings": { + "type": "object", + "x-ms-client-name": "ProjectSettings" }, - "ProjectsMetadata": { + "TextAnalysisAuthoringProjectsMetadata": { "required": [ "value", "nextLink" @@ -2457,17 +2509,17 @@ "description": "Gets or sets the projects.", "type": "array", "items": { - "$ref": "#/definitions/ProjectMetadata" + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "ProjectsMetadata" }, - "ProjectTrainedModel": { + "TextAnalysisAuthoringProjectTrainedModel": { "required": [ "label", "modelId", @@ -2505,9 +2557,10 @@ "description": "Represents the model training config version.", "type": "string" } - } + }, + "x-ms-client-name": "ProjectTrainedModel" }, - "ProjectTrainedModels": { + "TextAnalysisAuthoringProjectTrainedModels": { "required": [ "value", "nextLink" @@ -2518,17 +2571,17 @@ "description": "Gets or sets the jobs.", "type": "array", "items": { - "$ref": "#/definitions/ProjectTrainedModel" + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "ProjectTrainedModels" }, - "SingleLabelClassEvaluationSummary": { + "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { "required": [ "f1", "precision", @@ -2575,9 +2628,10 @@ "description": "Represents the count of false negative", "type": "integer" } - } + }, + "x-ms-client-name": "SingleLabelClassEvaluationSummary" }, - "SingleLabelClassificationEvaluationSummary": { + "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { "required": [ "confusionMatrix", "classes", @@ -2592,19 +2646,13 @@ "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.", - "type": "object", - "additionalProperties": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/ConfusionMatrix" - } - } + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" }, "classes": { "description": "Represents the classes evaluation", "type": "object", "additionalProperties": { - "$ref": "#/definitions/SingleLabelClassEvaluationSummary" + "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" } }, "microF1": { @@ -2637,9 +2685,10 @@ "description": "Represents the macro recall", "type": "number" } - } + }, + "x-ms-client-name": "SingleLabelClassificationEvaluationSummary" }, - "StringIndexType": { + "TextAnalysisAuthoringStringIndexType": { "enum": [ "Utf16CodeUnit" ], @@ -2647,9 +2696,10 @@ "x-ms-enum": { "name": "StringIndexType", "modelAsString": true - } + }, + "x-ms-client-name": "StringIndexType" }, - "SubTrainingJobState": { + "TextAnalysisAuthoringSubTrainingJobState": { "required": [ "percentComplete", "status" @@ -2673,11 +2723,12 @@ }, "status": { "description": "Represents the status of the job.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" } - } + }, + "x-ms-client-name": "SubTrainingJobState" }, - "SupportedLanguage": { + "TextAnalysisAuthoringSupportedLanguage": { "required": [ "languageName", "languageCode" @@ -2692,9 +2743,10 @@ "description": "Gets or sets the language code.", "type": "string" } - } + }, + "x-ms-client-name": "SupportedLanguage" }, - "SupportedLanguages": { + "TextAnalysisAuthoringSupportedLanguages": { "required": [ "value", "nextLink" @@ -2705,17 +2757,17 @@ "description": "The list of supported objects.", "type": "array", "items": { - "$ref": "#/definitions/SupportedLanguage" + "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" } }, "nextLink": { "description": "The next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "SupportedLanguages" }, - "SwapDeploymentsOptions": { + "TextAnalysisAuthoringSwapDeploymentsOptions": { "required": [ "firstDeploymentName", "secondDeploymentName" @@ -2730,9 +2782,10 @@ "description": "Represents the second deployment name.", "type": "string" } - } + }, + "x-ms-client-name": "SwapDeploymentsOptions" }, - "TrainingConfigVersion": { + "TextAnalysisAuthoringTrainingConfigVersion": { "required": [ "trainingConfigVersion", "modelExpirationDate" @@ -2748,9 +2801,10 @@ "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", "type": "string" } - } + }, + "x-ms-client-name": "TrainingConfigVersion" }, - "TrainingConfigVersions": { + "TextAnalysisAuthoringTrainingConfigVersions": { "required": [ "value", "nextLink" @@ -2761,17 +2815,17 @@ "description": "Gets or sets the training config versions.", "type": "array", "items": { - "$ref": "#/definitions/TrainingConfigVersion" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "TrainingConfigVersions" }, - "TrainingJobOptions": { + "TextAnalysisAuthoringTrainingJobOptions": { "required": [ "modelLabel", "trainingConfigVersion" @@ -2788,11 +2842,12 @@ }, "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/EvaluationOptions" + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" } - } + }, + "x-ms-client-name": "TrainingJobOptions" }, - "TrainingJobResult": { + "TextAnalysisAuthoringTrainingJobResult": { "required": [ "modelLabel", "trainingConfigVersion", @@ -2810,20 +2865,21 @@ }, "trainingStatus": { "description": "Represents model train status.", - "$ref": "#/definitions/SubTrainingJobState" + "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" }, "evaluationStatus": { "description": "Represents model evaluation status.", - "$ref": "#/definitions/SubTrainingJobState" + "$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" }, - "TrainingJobs": { + "TextAnalysisAuthoringTrainingJobs": { "required": [ "value", "nextLink" @@ -2834,17 +2890,17 @@ "description": "Gets or sets the jobs.", "type": "array", "items": { - "$ref": "#/definitions/TrainingJobState" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" } }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string", - "x-nullable": true + "type": "string" } - } + }, + "x-ms-client-name": "TrainingJobs" }, - "TrainingJobState": { + "TextAnalysisAuthoringTrainingJobState": { "required": [ "result", "jobId", @@ -2857,7 +2913,7 @@ "properties": { "result": { "description": "Represents training tasks detailed result.", - "$ref": "#/definitions/TrainingJobResult" + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" }, "jobId": { "description": "Gets or sets the job ID.", @@ -2880,7 +2936,7 @@ }, "status": { "description": "Gets or sets the job status.", - "$ref": "#/definitions/JobStatus" + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" }, "warnings": { "description": "Gets or sets the warnings.", @@ -2896,11 +2952,12 @@ "$ref": "common.json#/definitions/Error" } } - } + }, + "x-ms-client-name": "TrainingJobState" } }, "parameters": { - "StringIndexTypeInQuery": { + "TextAnalysisAuthoringStringIndexTypeInQuery": { "in": "query", "name": "stringIndexType", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", @@ -2915,7 +2972,7 @@ }, "x-ms-parameter-location": "method" }, - "ProjectKindInQuery": { + "TextAnalysisAuthoringProjectKindInQuery": { "in": "query", "name": "projectKind", "description": "The project kind.", From c33d7df13c2a16efc602ccb5e529693c9a63a103 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Tue, 19 Apr 2022 23:29:01 +0200 Subject: [PATCH 17/24] Fix nextLink examples regression --- .../conversationalanalysisauthoring.json | 24 ++++++++++++------- .../2022-05-01/customtextauthoring.json | 21 ++++++++++------ 2 files changed, 30 insertions(+), 15 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json index caf692bbe552..b451a16930d1 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json @@ -1726,7 +1726,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "EvaluationResults" @@ -2313,7 +2314,8 @@ }, "nextLink": { "description": "The next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "PrebuiltEntities" @@ -2448,7 +2450,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ProjectDeployments" @@ -2551,7 +2554,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ProjectsMetadata" @@ -2613,7 +2617,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ProjectTrainedModels" @@ -2692,7 +2697,8 @@ }, "nextLink": { "description": "The next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "SupportedLanguages" @@ -2750,7 +2756,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "TrainingConfigVersions" @@ -2833,7 +2840,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "TrainingJobs" diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json index 4214e9f5b296..2f1059766631 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json @@ -1761,7 +1761,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "EvaluationResults" @@ -2414,7 +2415,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ProjectDeployments" @@ -2514,7 +2516,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ProjectsMetadata" @@ -2576,7 +2579,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "ProjectTrainedModels" @@ -2762,7 +2766,8 @@ }, "nextLink": { "description": "The next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "SupportedLanguages" @@ -2820,7 +2825,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "TrainingConfigVersions" @@ -2895,7 +2901,8 @@ }, "nextLink": { "description": "Gets or sets the next page link.", - "type": "string" + "type": "string", + "x-nullable": true } }, "x-ms-client-name": "TrainingJobs" From 4caf2df6566101e2a17a85b7afd856aa534c1429 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Tue, 19 Apr 2022 23:50:39 +0200 Subject: [PATCH 18/24] Retrigger CI From 5f1a94223c497c378b3415daf45f84efd1ae19ad Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Thu, 21 Apr 2022 03:30:43 +0200 Subject: [PATCH 19/24] Renaming the swagger files --- ...analysisauthoring.json => analyzeconversations-authoring.json} | 0 .../{customtextauthoring.json => textanalytics-authoring.json} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/{conversationalanalysisauthoring.json => analyzeconversations-authoring.json} (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/{customtextauthoring.json => textanalytics-authoring.json} (100%) diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/conversationalanalysisauthoring.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics-authoring.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/customtextauthoring.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics-authoring.json From 0cbb547657af78ae5838b9fb666f373a99fae3cd Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Thu, 21 Apr 2022 04:53:50 +0200 Subject: [PATCH 20/24] Apply PR feedback - part 1 --- .../data-plane/Language/readme.md | 4 +- .../analyzeconversations-authoring.json | 523 +++++++----------- ...horing.json => analyzetext-authoring.json} | 399 ++++--------- .../SuccessfulCancelTrainingJob.json | 0 .../SuccessfulCreateProject.json | 2 +- .../SuccessfulDeleteDeployment.json | 0 .../SuccessfulDeleteModel.json | 0 .../SuccessfulDeleteProject.json | 0 .../SuccessfulDeployProject.json | 2 +- .../SuccessfulExportProject.json | 0 .../SuccessfulGetDeployment.json | 0 .../SuccessfulGetDeploymentStatus.json | 0 .../SuccessfulGetExportStatus.json | 0 .../SuccessfulGetImportStatus.json | 0 .../SuccessfulGetModel.json | 0 .../SuccessfulGetModelEvaluation.json | 0 .../SuccessfulGetModelEvaluationSummary.json | 0 .../SuccessfulGetProject.json | 0 .../SuccessfulGetProjectDeletionStatus.json | 0 .../SuccessfulGetSupportedLanguages.json | 0 ...uccessfulGetSupportedPrebuiltEntities.json | 0 ...fulGetSupportedTrainingConfigVersions.json | 0 .../SuccessfulGetSwapDeploymentsStatus.json | 0 .../SuccessfulGetTrainStatus.json | 0 .../SuccessfulImportProject.json | 2 +- .../SuccessfulListDeployments.json | 0 .../SuccessfulListModels.json | 0 .../SuccessfulListProjects.json | 0 .../SuccessfulListTrainingJobs.json | 0 .../SuccessfulSwapDeployments.json | 2 +- .../SuccessfulTrainProject.json | 2 +- .../SuccessfulCancelTrainingJob.json | 0 .../SuccessfulCreateProject.json | 2 +- .../SuccessfulDeleteDeployment.json | 0 .../SuccessfulDeleteModel.json | 0 .../SuccessfulDeleteProject.json | 0 .../SuccessfulDeployProject.json | 2 +- .../SuccessfulExportProject.json | 0 .../SuccessfulGetDeployment.json | 0 .../SuccessfulGetDeploymentStatus.json | 0 .../SuccessfulGetExportStatus.json | 0 .../SuccessfulGetImportStatus.json | 0 .../SuccessfulGetModel.json | 0 .../SuccessfulGetModelEvaluation.json | 0 .../SuccessfulGetModelEvaluationSummary.json | 0 .../SuccessfulGetProject.json | 0 .../SuccessfulGetProjectDeletionStatus.json | 0 .../SuccessfulGetSupportedLanguages.json | 0 ...fulGetSupportedTrainingConfigVersions.json | 0 .../SuccessfulGetSwapDeploymentsStatus.json | 0 .../SuccessfulGetTrainStatus.json | 0 .../SuccessfulImportProject.json | 2 +- .../SuccessfulListDeployments.json | 0 .../SuccessfulListModels.json | 0 .../SuccessfulListProjects.json | 0 .../SuccessfulListTrainingJobs.json | 0 .../SuccessfulSwapDeployments.json | 2 +- .../SuccessfulTrainProject.json | 2 +- 58 files changed, 307 insertions(+), 639 deletions(-) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/{textanalytics-authoring.json => analyzetext-authoring.json} (89%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulCancelTrainingJob.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulCreateProject.json (97%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulDeleteDeployment.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulDeleteModel.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulDeleteProject.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulDeployProject.json (94%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulExportProject.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetDeployment.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetDeploymentStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetExportStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetImportStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetModel.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetModelEvaluation.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetModelEvaluationSummary.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetProject.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetProjectDeletionStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetSupportedLanguages.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetSupportedPrebuiltEntities.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetSupportedTrainingConfigVersions.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetSwapDeploymentsStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulGetTrainStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulImportProject.json (98%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulListDeployments.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulListModels.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulListProjects.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulListTrainingJobs.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulSwapDeployments.json (94%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{conversationalanalysisauthoring => analyzeconversations-authoring}/SuccessfulTrainProject.json (96%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulCancelTrainingJob.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulCreateProject.json (98%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulDeleteDeployment.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulDeleteModel.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulDeleteProject.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulDeployProject.json (94%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulExportProject.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetDeployment.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetDeploymentStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetExportStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetImportStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetModel.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetModelEvaluation.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetModelEvaluationSummary.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetProject.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetProjectDeletionStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetSupportedLanguages.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetSupportedTrainingConfigVersions.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetSwapDeploymentsStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulGetTrainStatus.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulImportProject.json (99%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulListDeployments.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulListModels.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulListProjects.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulListTrainingJobs.json (100%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulSwapDeployments.json (94%) rename specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/{textanalysisauthoring => analyzetext-authoring}/SuccessfulTrainProject.json (95%) diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index b738bb457396..65b5e663d574 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -29,8 +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/customtextauthoring.json - - stable/2022-05-01/conversationalanalysisauthoring.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 index b451a16930d1..4c97db74d195 100644 --- 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 @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Language - Conversational Language Understanding Authoring APIs (2022-05-01)", + "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." }, @@ -65,7 +65,7 @@ }, "x-ms-examples": { "Successful List Projects": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListProjects.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" } }, "x-ms-pageable": { @@ -90,7 +90,7 @@ }, { "in": "body", - "name": "createProjectOptions", + "name": "body", "description": "The project parameters.", "required": true, "schema": { @@ -123,7 +123,7 @@ }, "x-ms-examples": { "Successful Create Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulCreateProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" } } }, @@ -157,7 +157,7 @@ }, "x-ms-examples": { "Successful Get Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" } } }, @@ -177,7 +177,7 @@ ], "responses": { "202": { - "description": "Successfully triggered the project deletion operation.", + "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.", @@ -194,7 +194,7 @@ }, "x-ms-examples": { "Successful Delete Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" } }, "x-ms-long-running-operation": true @@ -212,16 +212,17 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" }, { "in": "query", "name": "assetKind", "description": "Kind of asset to export.", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -229,7 +230,7 @@ ], "responses": { "202": { - "description": "", + "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.", @@ -246,7 +247,7 @@ }, "x-ms-examples": { "Successful Export Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulExportProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" } }, "x-ms-long-running-operation": true @@ -267,11 +268,11 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryParameter" }, { "in": "body", - "name": "exportedProject", + "name": "body", "description": "The project data to import.", "required": true, "schema": { @@ -284,7 +285,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -301,7 +302,7 @@ }, "x-ms-examples": { "Successful Import Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulImportProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" } }, "x-ms-long-running-operation": true @@ -323,7 +324,7 @@ }, { "in": "body", - "name": "trainingJobOptions", + "name": "body", "description": "The training input parameters.", "required": true, "schema": { @@ -336,7 +337,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -353,7 +354,7 @@ }, "x-ms-examples": { "Successful Train Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulTrainProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" } }, "x-ms-long-running-operation": true @@ -399,7 +400,7 @@ }, "x-ms-examples": { "Successful List Deployments": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListDeployments.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" } }, "x-ms-pageable": { @@ -424,7 +425,7 @@ }, { "in": "body", - "name": "swapDeploymentsOptions", + "name": "body", "description": "The job object to swap two deployments.", "required": true, "schema": { @@ -437,7 +438,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -454,7 +455,7 @@ }, "x-ms-examples": { "Successful Swap Deployments": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" } }, "x-ms-long-running-operation": true @@ -494,7 +495,7 @@ }, "x-ms-examples": { "Successful Get Deployment": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" } } }, @@ -516,7 +517,7 @@ }, { "in": "body", - "name": "createDeploymentOptions", + "name": "body", "description": "The new deployment info.", "required": true, "schema": { @@ -529,7 +530,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -546,7 +547,7 @@ }, "x-ms-examples": { "Successful Deploy Project": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeployProject.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" } }, "x-ms-long-running-operation": true @@ -570,7 +571,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -587,7 +588,7 @@ }, "x-ms-examples": { "Successful Delete Deployment": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" } }, "x-ms-long-running-operation": true @@ -608,11 +609,7 @@ "$ref": "common.json#/parameters/DeploymentNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -634,7 +631,7 @@ }, "x-ms-examples": { "Successful Get Deployment Status": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" } } } @@ -651,11 +648,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -677,7 +670,7 @@ }, "x-ms-examples": { "Successful Get Swap Deployments Status": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" } } } @@ -694,11 +687,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -720,7 +709,7 @@ }, "x-ms-examples": { "Successful Get Export Status": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" } } } @@ -737,11 +726,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -763,7 +748,7 @@ }, "x-ms-examples": { "Successful Get Import Status": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" } } } @@ -808,7 +793,7 @@ }, "x-ms-examples": { "Successful List Models": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListModels.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" } }, "x-ms-pageable": { @@ -829,11 +814,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -855,7 +836,7 @@ }, "x-ms-examples": { "Successful Get Model": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetModel.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" } } }, @@ -870,11 +851,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -893,7 +870,7 @@ }, "x-ms-examples": { "Successful Delete Model": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" } } } @@ -910,14 +887,10 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" }, { - "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" }, { "$ref": "common.json#/parameters/TopParameter" @@ -948,7 +921,7 @@ }, "x-ms-examples": { "Successful Get Model Evaluation": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" } }, "x-ms-pageable": { @@ -959,7 +932,7 @@ }, "/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).", + "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" @@ -969,11 +942,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -995,7 +964,7 @@ }, "x-ms-examples": { "Successful Get Model Evaluation Summary": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" } } } @@ -1040,7 +1009,7 @@ }, "x-ms-examples": { "Successful List Training Jobs": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" } }, "x-ms-pageable": { @@ -1061,11 +1030,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -1087,7 +1052,7 @@ }, "x-ms-examples": { "Successful Get Train Status": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" } } } @@ -1104,11 +1069,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -1127,7 +1088,7 @@ }, "x-ms-examples": { "Successful Cancel Training Job": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" } } } @@ -1141,11 +1102,7 @@ ], "parameters": [ { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -1167,7 +1124,7 @@ }, "x-ms-examples": { "Successful Get Project Deletion Status": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" } } } @@ -1181,7 +1138,7 @@ ], "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1212,7 +1169,7 @@ }, "x-ms-examples": { "Successful Supported Languages": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" } }, "x-ms-pageable": { @@ -1232,14 +1189,16 @@ { "in": "query", "name": "language", - "description": "The language to get supported prebuilt entities for. Required if multilingual is false.", - "type": "string" + "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" + "type": "string", + "x-ms-parameter-location": "method" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1270,7 +1229,7 @@ }, "x-ms-examples": { "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" } }, "x-ms-pageable": { @@ -1288,7 +1247,7 @@ ], "parameters": [ { - "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindInQuery" + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1319,7 +1278,7 @@ }, "x-ms-examples": { "Successful Get Supported Training Config Versions": { - "$ref": "./examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json" + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" } }, "x-ms-pageable": { @@ -1340,7 +1299,25 @@ "type": "string", "x-ms-enum": { "name": "CompositionSetting", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "returnLongestOverlap", + "description": "When 2 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 2 or more components are found in the text and overlap, the components's spans are merged together into one span combining all of them." + } + ] }, "x-ms-client-name": "CompositionSetting" }, @@ -1461,6 +1438,7 @@ "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": { @@ -1515,60 +1493,19 @@ "type": "string" }, "language": { - "description": "Gets or sets the project language.", + "description": "Gets or sets 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": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", - "properties": { - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" } - }, + ], "x-ms-client-name": "DeploymentJobState" }, "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { @@ -1803,6 +1740,7 @@ "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": { @@ -1996,106 +1934,26 @@ "x-ms-client-name": "ExportedUtteranceEntityLabel" }, "ConversationalAnalysisAuthoringExportProjectJobState": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], "properties": { "resultUrl": { "type": "string" - }, - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } } }, "x-ms-client-name": "ExportProjectJobState" }, "ConversationalAnalysisAuthoringImportProjectJobState": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", - "properties": { - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" } - }, + ], "x-ms-client-name": "ImportProjectJobState" }, "ConversationalAnalysisAuthoringIntentEvaluation": { @@ -2205,6 +2063,56 @@ }, "x-ms-client-name": "IntentsEvaluation" }, + "ConversationalAnalysisAuthoringJobState": { + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "expirationDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "Gets or sets the job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "Gets or sets the created time.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "Gets or sets the last updated time.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "Gets or sets the expiration time.", + "type": "string" + }, + "status": { + "description": "Gets or sets the job status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + }, + "warnings": { + "description": "Gets or sets the warnings.", + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + }, + "errors": { + "description": "Gets or sets the errors.", + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + }, + "x-ms-client-name": "JobState" + }, "ConversationalAnalysisAuthoringJobStatus": { "enum": [ "unknown", @@ -2273,6 +2181,7 @@ "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": { @@ -2344,53 +2253,12 @@ "x-ms-client-name": "PrebuiltEntity" }, "ConversationalAnalysisAuthoringProjectDeletionJobState": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", - "properties": { - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" } - }, + ], "x-ms-client-name": "ProjectDeletionJobState" }, "ConversationalAnalysisAuthoringProjectDeployment": { @@ -2519,7 +2387,7 @@ "type": "string" }, "language": { - "description": "Gets or sets the project language.", + "description": "Gets or sets 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" } }, @@ -2848,55 +2716,18 @@ }, "ConversationalAnalysisAuthoringTrainingJobState": { "required": [ - "result", - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" + "result" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], "properties": { "result": { "description": "Represents training tasks detailed result.", "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" - }, - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } } }, "x-ms-client-name": "TrainingJobState" @@ -2976,7 +2807,7 @@ "type": "string" }, "language": { - "description": "Represents the utterance 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": { @@ -3010,10 +2841,10 @@ } }, "parameters": { - "ConversationalAnalysisAuthoringFormatInQuery": { + "ConversationalAnalysisAuthoringFormatQueryParameter": { "in": "query", "name": "format", - "description": "The format of the project to export. The currently supported format is `clu`.", + "description": "The format of the exported project file to use.", "type": "string", "enum": [ "clu", @@ -3025,7 +2856,7 @@ }, "x-ms-parameter-location": "method" }, - "ConversationalAnalysisAuthoringStringIndexTypeInQuery": { + "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { "in": "query", "name": "stringIndexType", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", @@ -3040,10 +2871,26 @@ }, "x-ms-parameter-location": "method" }, - "ConversationalAnalysisAuthoringProjectKindInQuery": { + "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 to get the supported languages for.", + "description": "The project kind.", "required": true, "type": "string", "enum": [ diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json similarity index 89% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics-authoring.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json index 2f1059766631..028b16d40d19 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/textanalytics-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzetext-authoring.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "Language - Custom Text Authoring APIs (2022-05-01)", + "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." }, @@ -65,7 +65,7 @@ }, "x-ms-examples": { "Successful List Projects": { - "$ref": "./examples/textanalysisauthoring/SuccessfulListProjects.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" } }, "x-ms-pageable": { @@ -90,7 +90,7 @@ }, { "in": "body", - "name": "createProjectOptions", + "name": "body", "description": "The project parameters.", "required": true, "schema": { @@ -123,7 +123,7 @@ }, "x-ms-examples": { "Successful Create Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulCreateProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" } } }, @@ -157,7 +157,7 @@ }, "x-ms-examples": { "Successful Get Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" } } }, @@ -177,7 +177,7 @@ ], "responses": { "202": { - "description": "Successfully triggered the project deletion operation.", + "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.", @@ -194,7 +194,7 @@ }, "x-ms-examples": { "Successful Delete Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulDeleteProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" } }, "x-ms-long-running-operation": true @@ -212,19 +212,14 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeInQuery" - }, - { - "in": "query", - "name": "format", - "description": "The format of the project to export. The currently supported format is `JSON`.", - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" }, { "in": "query", "name": "assetKind", "description": "Kind of asset to export.", - "type": "string" + "type": "string", + "x-ms-parameter-location": "method" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -232,7 +227,7 @@ ], "responses": { "202": { - "description": "", + "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.", @@ -249,7 +244,7 @@ }, "x-ms-examples": { "Successful Export Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulExportProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" } }, "x-ms-long-running-operation": true @@ -271,7 +266,7 @@ }, { "in": "body", - "name": "exportedProject", + "name": "body", "description": "The project data to import.", "required": true, "schema": { @@ -284,7 +279,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -301,7 +296,7 @@ }, "x-ms-examples": { "Successful Import Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulImportProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" } }, "x-ms-long-running-operation": true @@ -323,7 +318,7 @@ }, { "in": "body", - "name": "trainingJobOptions", + "name": "body", "description": "The training input parameters.", "required": true, "schema": { @@ -336,7 +331,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -353,7 +348,7 @@ }, "x-ms-examples": { "Successful Train Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulTrainProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" } }, "x-ms-long-running-operation": true @@ -399,7 +394,7 @@ }, "x-ms-examples": { "Successful List Deployments": { - "$ref": "./examples/textanalysisauthoring/SuccessfulListDeployments.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" } }, "x-ms-pageable": { @@ -424,7 +419,7 @@ }, { "in": "body", - "name": "swapDeploymentsOptions", + "name": "body", "description": "The job object to swap two deployments.", "required": true, "schema": { @@ -437,7 +432,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -454,7 +449,7 @@ }, "x-ms-examples": { "Successful Swap Deployments": { - "$ref": "./examples/textanalysisauthoring/SuccessfulSwapDeployments.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" } }, "x-ms-long-running-operation": true @@ -494,7 +489,7 @@ }, "x-ms-examples": { "Successful Get Deployment": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetDeployment.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" } } }, @@ -516,7 +511,7 @@ }, { "in": "body", - "name": "createDeploymentOptions", + "name": "body", "description": "The new deployment info.", "required": true, "schema": { @@ -529,7 +524,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -546,7 +541,7 @@ }, "x-ms-examples": { "Successful Deploy Project": { - "$ref": "./examples/textanalysisauthoring/SuccessfulDeployProject.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" } }, "x-ms-long-running-operation": true @@ -570,7 +565,7 @@ ], "responses": { "202": { - "description": "operation-location header for the status of the job.", + "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.", @@ -587,7 +582,7 @@ }, "x-ms-examples": { "Successful Delete Deployment": { - "$ref": "./examples/textanalysisauthoring/SuccessfulDeleteDeployment.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" } }, "x-ms-long-running-operation": true @@ -608,11 +603,7 @@ "$ref": "common.json#/parameters/DeploymentNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -634,7 +625,7 @@ }, "x-ms-examples": { "Successful Get Deployment Status": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" } } } @@ -651,11 +642,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -677,7 +664,7 @@ }, "x-ms-examples": { "Successful Get Swap Deployments Status": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" } } } @@ -694,11 +681,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -720,7 +703,7 @@ }, "x-ms-examples": { "Successful Get Export Status": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetExportStatus.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" } } } @@ -737,11 +720,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -763,7 +742,7 @@ }, "x-ms-examples": { "Successful Get Import Status": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetImportStatus.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" } } } @@ -808,7 +787,7 @@ }, "x-ms-examples": { "Successful List Models": { - "$ref": "./examples/textanalysisauthoring/SuccessfulListModels.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" } }, "x-ms-pageable": { @@ -829,11 +808,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -855,7 +830,7 @@ }, "x-ms-examples": { "Successful Get Model": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetModel.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" } } }, @@ -870,11 +845,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -893,7 +864,7 @@ }, "x-ms-examples": { "Successful Delete Model": { - "$ref": "./examples/textanalysisauthoring/SuccessfulDeleteModel.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" } } } @@ -910,14 +881,10 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" }, { - "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeInQuery" + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" }, { "$ref": "common.json#/parameters/TopParameter" @@ -948,7 +915,7 @@ }, "x-ms-examples": { "Successful Get Model Evaluation": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" } }, "x-ms-pageable": { @@ -959,7 +926,7 @@ }, "/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).", + "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" @@ -969,11 +936,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "trainedModelLabel", - "description": "The trained model name.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -995,7 +958,7 @@ }, "x-ms-examples": { "Successful Get Model Evaluation Summary": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" } } } @@ -1040,7 +1003,7 @@ }, "x-ms-examples": { "Successful List Training Jobs": { - "$ref": "./examples/textanalysisauthoring/SuccessfulListTrainingJobs.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" } }, "x-ms-pageable": { @@ -1061,11 +1024,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -1087,7 +1046,7 @@ }, "x-ms-examples": { "Successful Get Train Status": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetTrainStatus.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" } } } @@ -1104,11 +1063,7 @@ "$ref": "common.json#/parameters/ProjectNamePathParameter" }, { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -1127,7 +1082,7 @@ }, "x-ms-examples": { "Successful Cancel Training Job": { - "$ref": "./examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" } } } @@ -1141,11 +1096,7 @@ ], "parameters": [ { - "in": "path", - "name": "jobId", - "description": "The job ID.", - "required": true, - "type": "string" + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" }, { "$ref": "common.json#/parameters/ApiVersionParameter" @@ -1167,7 +1118,7 @@ }, "x-ms-examples": { "Successful Get Project Deletion Status": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" } } } @@ -1209,7 +1160,7 @@ }, "x-ms-examples": { "Successful Supported Languages": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" } }, "x-ms-pageable": { @@ -1227,7 +1178,7 @@ ], "parameters": [ { - "$ref": "#/parameters/TextAnalysisAuthoringProjectKindInQuery" + "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryParameter" }, { "$ref": "common.json#/parameters/TopParameter" @@ -1258,7 +1209,7 @@ }, "x-ms-examples": { "Successful Get Supported Training Config Versions": { - "$ref": "./examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json" + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" } }, "x-ms-pageable": { @@ -1350,7 +1301,7 @@ "type": "string" }, "language": { - "description": "Gets or sets the project language.", + "description": "Gets or sets 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" } }, @@ -1471,53 +1422,12 @@ "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" }, "TextAnalysisAuthoringDeploymentJobState": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", - "properties": { - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" } - }, + ], "x-ms-client-name": "DeploymentJobState" }, "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { @@ -1594,7 +1504,7 @@ "type": "string" }, "language": { - "description": "Represents the document 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": { @@ -1812,6 +1722,7 @@ "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": { @@ -1858,6 +1769,7 @@ "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": { @@ -1901,6 +1813,7 @@ "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": { @@ -2029,59 +1942,29 @@ "x-ms-client-name": "ExportedProjectAssets" }, "TextAnalysisAuthoringExportProjectJobState": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], "properties": { "resultUrl": { "type": "string" - }, - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } } }, "x-ms-client-name": "ExportProjectJobState" }, "TextAnalysisAuthoringImportProjectJobState": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ImportProjectJobState" + }, + "TextAnalysisAuthoringJobState": { "required": [ "jobId", "createdDateTime", @@ -2129,7 +2012,7 @@ } } }, - "x-ms-client-name": "ImportProjectJobState" + "x-ms-client-name": "JobState" }, "TextAnalysisAuthoringJobStatus": { "enum": [ @@ -2309,53 +2192,12 @@ "x-ms-client-name": "NamedEntityRecognitionEvaluationSummary" }, "TextAnalysisAuthoringProjectDeletionJobState": { - "required": [ - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" - ], "type": "object", - "properties": { - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" } - }, + ], "x-ms-client-name": "ProjectDeletionJobState" }, "TextAnalysisAuthoringProjectDeployment": { @@ -2490,7 +2332,7 @@ "type": "string" }, "language": { - "description": "Gets or sets the project language.", + "description": "Gets or sets 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" } }, @@ -2909,62 +2751,25 @@ }, "TextAnalysisAuthoringTrainingJobState": { "required": [ - "result", - "jobId", - "createdDateTime", - "lastUpdatedDateTime", - "expirationDateTime", - "status" + "result" ], "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], "properties": { "result": { "description": "Represents training tasks detailed result.", "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" - }, - "jobId": { - "description": "Gets or sets the job ID.", - "type": "string" - }, - "createdDateTime": { - "format": "date-time", - "description": "Gets or sets the created time.", - "type": "string" - }, - "lastUpdatedDateTime": { - "format": "date-time", - "description": "Gets or sets the last updated time.", - "type": "string" - }, - "expirationDateTime": { - "format": "date-time", - "description": "Gets or sets the expiration time.", - "type": "string" - }, - "status": { - "description": "Gets or sets the job status.", - "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" - }, - "warnings": { - "description": "Gets or sets the warnings.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } - }, - "errors": { - "description": "Gets or sets the errors.", - "type": "array", - "items": { - "$ref": "common.json#/definitions/Error" - } } }, "x-ms-client-name": "TrainingJobState" } }, "parameters": { - "TextAnalysisAuthoringStringIndexTypeInQuery": { + "TextAnalysisAuthoringStringIndexTypeQueryParameter": { "in": "query", "name": "stringIndexType", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", @@ -2979,7 +2784,23 @@ }, "x-ms-parameter-location": "method" }, - "TextAnalysisAuthoringProjectKindInQuery": { + "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.", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json similarity index 97% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json index 8dfab07fcaa9..4d715808ffda 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulCreateProject.json @@ -5,7 +5,7 @@ "Content-Type": "application/merge-patch+json", "api-version": "2022-05-01", "projectName": "myproject", - "createProjectOptions": { + "body": { "projectName": "myproject", "language": "en", "projectKind": "conversation", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteModel.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeleteProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json similarity index 94% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json index a3a368eaf42c..b18e321a085c 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulDeployProject.json @@ -5,7 +5,7 @@ "api-version": "2022-05-01", "projectName": "EmailApp", "deploymentName": "production", - "createDeploymentOptions": { + "body": { "trainedModelLabel": "model1" } }, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulExportProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulExportProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeployment.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModel.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModel.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedPrebuiltEntities.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json index 569635394d05..3ed7d6e19dcd 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulImportProject.json @@ -4,7 +4,7 @@ "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2022-05-01", "projectName": "EmailApp", - "exportedProject": { + "body": { "project-file-version": "2022-05-01", "stringIndexType": "Utf16CodeUnit", "metadata": { diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListDeployments.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListDeployments.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListModels.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListModels.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListModels.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListProjects.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListProjects.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json similarity index 94% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json index 2f74f96fba95..badff28b42f3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json @@ -4,7 +4,7 @@ "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2022-05-01", "projectName": "EmailApp", - "swapDeploymentsOptions": { + "body": { "firstDeploymentName": "production", "secondDeploymentName": "staging" } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json similarity index 96% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json index c93044ea59b7..92443c1032e3 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/conversationalanalysisauthoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzeconversations-authoring/SuccessfulTrainProject.json @@ -4,7 +4,7 @@ "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2022-05-01", "projectName": "EmailApp", - "trainingJobOptions": { + "body": { "modelLabel": "model1", "trainingMode": "standard", "trainingConfigVersion": "latest", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCancelTrainingJob.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCreateProject.json similarity index 98% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCreateProject.json index ae82e1df76ea..2575f970b5b5 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulCreateProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulCreateProject.json @@ -5,7 +5,7 @@ "Content-Type": "application/merge-patch+json", "api-version": "2022-05-01", "projectName": "LoanAgreements", - "createProjectOptions": { + "body": { "projectName": "LoanAgreements", "language": "en", "projectKind": "customNamedEntityRecognition", diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteDeployment.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteModel.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteModel.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeleteProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeleteProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeployProject.json similarity index 94% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeployProject.json index 74b2be0eee74..67a86c333977 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulDeployProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulDeployProject.json @@ -6,7 +6,7 @@ "api-version": "2022-05-01", "projectName": "LoanAgreements", "deploymentName": "production", - "createDeploymentOptions": { + "body": { "trainedModelLabel": "model1" } }, diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulExportProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulExportProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulExportProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeployment.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeployment.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeployment.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetDeploymentStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetExportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetExportStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetExportStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetImportStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetImportStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetImportStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModel.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModel.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModel.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluation.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetModelEvaluationSummary.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProject.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProject.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetProjectDeletionStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedLanguages.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSupportedTrainingConfigVersions.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetSwapDeploymentsStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulGetTrainStatus.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulImportProject.json similarity index 99% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulImportProject.json index d72f9b40db98..3c7a58ed3b4d 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulImportProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulImportProject.json @@ -5,7 +5,7 @@ "Content-Type": "application/json", "api-version": "2022-05-01", "projectName": "LoanAgreements", - "exportedProject": { + "body": { "project-file-version": "2022-05-01", "stringIndexType": "Utf16CodeUnit", "metadata": { diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListDeployments.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListDeployments.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListDeployments.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListModels.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListModels.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListModels.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListProjects.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListProjects.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListProjects.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json similarity index 100% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulListTrainingJobs.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulSwapDeployments.json similarity index 94% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulSwapDeployments.json index c6645519a430..d2e8c6545950 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulSwapDeployments.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulSwapDeployments.json @@ -5,7 +5,7 @@ "Content-Type": "application/json", "api-version": "2022-05-01", "projectName": "LoanAgreements", - "swapDeploymentsOptions": { + "body": { "firstDeploymentName": "production", "secondDeploymentName": "staging" } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulTrainProject.json similarity index 95% rename from specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json rename to specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulTrainProject.json index 28da114daa9f..d60ab6faae73 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/textanalysisauthoring/SuccessfulTrainProject.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/examples/analyzetext-authoring/SuccessfulTrainProject.json @@ -4,7 +4,7 @@ "Ocp-Apim-Subscription-Key": "{API key}", "api-version": "2022-05-01", "projectName": "LoanAgreements", - "trainingJobOptions": { + "body": { "modelLabel": "model1", "trainingConfigVersion": "latest", "evaluationOptions": { From 017551d5675e85d43a8ac573c4ea3dbfbfb7c47b Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Thu, 21 Apr 2022 07:12:49 +0200 Subject: [PATCH 21/24] Add the documentation for the schemas --- .../analyzeconversations-authoring.json | 338 ++++++++++++++---- .../2022-05-01/analyzetext-authoring.json | 162 ++++++--- 2 files changed, 373 insertions(+), 127 deletions(-) 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 index 4c97db74d195..34044fa20275 100644 --- 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 @@ -1189,7 +1189,7 @@ { "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.", + "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" }, @@ -1303,7 +1303,7 @@ "values": [ { "value": "returnLongestOverlap", - "description": "When 2 or more components are found in the text and overlap, the component with the longest set of characters is returned." + "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", @@ -1315,7 +1315,7 @@ }, { "value": "combineComponents", - "description": "When 2 or more components are found in the text and overlap, the components's spans are merged together into one span combining all of them." + "description": "When two or more components are found in the text and overlap, the components's spans are merged together into one span combining all of them." } ] }, @@ -1328,7 +1328,8 @@ }, "x-ms-client-name": "ConfusionMatrix" }, - "ConversationalAnalysisAuthoringConfusionMatrixEntry": { + "ConversationalAnalysisAuthoringConfusionMatrixCell": { + "description": "Represents a cell in a confusion matrix.", "required": [ "normalizedValue", "rawValue" @@ -1346,31 +1347,36 @@ "type": "number" } }, - "x-ms-client-name": "ConfusionMatrixEntry" + "x-ms-client-name": "ConfusionMatrixCell" }, "ConversationalAnalysisAuthoringConfusionMatrixRow": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixEntry" + "$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" @@ -1380,18 +1386,21 @@ "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": [ { @@ -1400,18 +1409,21 @@ ], "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" @@ -1422,6 +1434,7 @@ "x-ms-client-name": "ConversationExportedProjectAssets" }, "ConversationalAnalysisAuthoringConversationExportedUtterance": { + "description": "Represents an exported utterance for a conversational project.", "required": [ "text", "intent" @@ -1429,19 +1442,22 @@ "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.", + "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": { @@ -1452,6 +1468,7 @@ "x-ms-client-name": "ConversationExportedUtterance" }, "ConversationalAnalysisAuthoringCreateDeploymentOptions": { + "description": "Represents the options for creating or updating a project deployment.", "required": [ "trainedModelLabel" ], @@ -1465,6 +1482,7 @@ "x-ms-client-name": "CreateDeploymentOptions" }, "ConversationalAnalysisAuthoringCreateProjectOptions": { + "description": "Represents the options used to create or update a project.", "required": [ "projectKind", "projectName", @@ -1477,29 +1495,30 @@ "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" }, "settings": { - "description": "Gets or sets the project settings.", + "description": "The project settings.", "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" }, "projectName": { - "description": "Gets or sets the new project name.", + "description": "The new project name.", "type": "string" }, "multilingual": { - "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "description": "Whether the project would be used for multiple languages or not.", "type": "boolean" }, "description": { - "description": "Gets or sets the new project description.", + "description": "The project description.", "type": "string" }, "language": { - "description": "Gets or sets 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.", + "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": [ { @@ -1509,6 +1528,7 @@ "x-ms-client-name": "DeploymentJobState" }, "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { + "description": "Represents the evaluation result summary for the project's entities.", "required": [ "confusionMatrix", "entities", @@ -1526,7 +1546,7 @@ "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" }, "entities": { - "description": "Represents the entities evaluation", + "description": "Represents the entities evaluation summary.", "type": "object", "additionalProperties": { "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" @@ -1566,6 +1586,7 @@ "x-ms-client-name": "EntitiesEvaluationSummary" }, "ConversationalAnalysisAuthoringEntityEvaluationSummary": { + "description": "Represents the evaluation result for an entity.", "required": [ "f1", "precision", @@ -1623,11 +1644,22 @@ "type": "string", "x-ms-enum": { "name": "EvaluationKind", - "modelAsString": true + "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": { @@ -1648,6 +1680,7 @@ "x-ms-client-name": "EvaluationOptions" }, "ConversationalAnalysisAuthoringEvaluationResults": { + "description": "Represent a list of utterances' evaluation results.", "required": [ "value", "nextLink" @@ -1655,14 +1688,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the utterances predictions.", + "description": "The utterances evaluation results.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -1670,6 +1703,7 @@ "x-ms-client-name": "EvaluationResults" }, "ConversationalAnalysisAuthoringEvaluationSummary": { + "description": "Represents the evaluation result summary.", "required": [ "entitiesEvaluation", "intentsEvaluation" @@ -1682,15 +1716,17 @@ }, "intentsEvaluation": { "description": "Contains the data related to intents evaluation.", - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluation" + "$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" @@ -1698,15 +1734,18 @@ "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" ], @@ -1718,6 +1757,7 @@ ], "properties": { "cluOrchestration": { + "description": "The Conversational project target details.", "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedCluOrchestration" } }, @@ -1725,9 +1765,11 @@ "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" @@ -1737,13 +1779,15 @@ "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.", + "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" @@ -1753,12 +1797,15 @@ "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" @@ -1768,6 +1815,7 @@ "x-ms-client-name": "ExportedEntitySublist" }, "ConversationalAnalysisAuthoringExportedLuisOrchestration": { + "description": "Defines the orchestration details for a LUIS application target.", "required": [ "appId" ], @@ -1775,19 +1823,23 @@ "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" ], @@ -1799,6 +1851,7 @@ ], "properties": { "luisOrchestration": { + "description": "The LUIS application target details.", "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" } }, @@ -1806,12 +1859,14 @@ "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" } }, @@ -1819,18 +1874,21 @@ "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": [ "project-file-version", "stringIndexType", @@ -1839,6 +1897,7 @@ "type": "object", "properties": { "project-file-version": { + "description": "The version of the exported file.", "type": "string" }, "stringIndexType": { @@ -1857,12 +1916,14 @@ "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" } }, @@ -1877,23 +1938,36 @@ "type": "string", "x-ms-enum": { "name": "ExportedProjectFormat", - "modelAsString": true + "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" ], @@ -1905,6 +1979,7 @@ ], "properties": { "qnaOrchestration": { + "description": "The Question Answering project details.", "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQnaOrchestration" } }, @@ -1912,6 +1987,7 @@ "x-ms-client-name": "ExportedQnaOrchestrationOptions" }, "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { + "description": "Represents an entity label for an utterance.", "required": [ "category", "offset", @@ -1920,20 +1996,24 @@ "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": [ { @@ -1942,12 +2022,14 @@ ], "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": [ { @@ -1956,7 +2038,8 @@ ], "x-ms-client-name": "ImportProjectJobState" }, - "ConversationalAnalysisAuthoringIntentEvaluation": { + "ConversationalAnalysisAuthoringIntentEvaluationSummary": { + "description": "The evaluation summary for an intent.", "required": [ "f1", "precision", @@ -2004,9 +2087,10 @@ "type": "integer" } }, - "x-ms-client-name": "IntentEvaluation" + "x-ms-client-name": "IntentEvaluationSummary" }, - "ConversationalAnalysisAuthoringIntentsEvaluation": { + "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { + "description": "Represents the evaluation summary for the project's intents.", "required": [ "confusionMatrix", "intents", @@ -2024,10 +2108,10 @@ "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" }, "intents": { - "description": "Represents the intents evaluation.", + "description": "Represents the intents evaluation summary.", "type": "object", "additionalProperties": { - "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluation" + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" } }, "microF1": { @@ -2061,50 +2145,50 @@ "type": "number" } }, - "x-ms-client-name": "IntentsEvaluation" + "x-ms-client-name": "IntentsEvaluationSummary" }, "ConversationalAnalysisAuthoringJobState": { + "description": "Represents a job's state.", "required": [ "jobId", "createdDateTime", "lastUpdatedDateTime", - "expirationDateTime", "status" ], "type": "object", "properties": { "jobId": { - "description": "Gets or sets the job ID.", + "description": "The job ID.", "type": "string" }, "createdDateTime": { "format": "date-time", - "description": "Gets or sets the created time.", + "description": "The creation date time of the job.", "type": "string" }, "lastUpdatedDateTime": { "format": "date-time", - "description": "Gets or sets the last updated time.", + "description": "The last date time the job was updated.", "type": "string" }, "expirationDateTime": { "format": "date-time", - "description": "Gets or sets the expiration time.", + "description": "The expiration date time of the job.", "type": "string" }, "status": { - "description": "Gets or sets the job status.", + "description": "The job status.", "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" }, "warnings": { - "description": "Gets or sets the warnings.", + "description": "The warnings that were encountered while executing the job.", "type": "array", "items": { - "$ref": "common.json#/definitions/Error" + "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" } }, "errors": { - "description": "Gets or sets the errors.", + "description": "The errors encountered while executing the job.", "type": "array", "items": { "$ref": "common.json#/definitions/Error" @@ -2115,7 +2199,6 @@ }, "ConversationalAnalysisAuthoringJobStatus": { "enum": [ - "unknown", "notStarted", "running", "succeeded", @@ -2132,21 +2215,25 @@ "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": [ { @@ -2155,12 +2242,14 @@ ], "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" @@ -2171,6 +2260,7 @@ "x-ms-client-name": "OrchestrationExportedProjectAssets" }, "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { + "description": "Represents an utterance of an orchestration project.", "required": [ "text", "intent" @@ -2178,13 +2268,15 @@ "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.", + "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": { @@ -2208,6 +2300,7 @@ "x-ms-client-name": "OrchestrationKind" }, "ConversationalAnalysisAuthoringPrebuiltEntities": { + "description": "Represents a list of the retrieved supported prebuilt entities.", "required": [ "value", "nextLink" @@ -2230,6 +2323,7 @@ "x-ms-client-name": "PrebuiltEntities" }, "ConversationalAnalysisAuthoringPrebuiltEntity": { + "description": "Represents a supported prebuilt entity.", "required": [ "category", "description", @@ -2253,6 +2347,7 @@ "x-ms-client-name": "PrebuiltEntity" }, "ConversationalAnalysisAuthoringProjectDeletionJobState": { + "description": "Represents the state of a project deletion job.", "type": "object", "allOf": [ { @@ -2262,6 +2357,7 @@ "x-ms-client-name": "ProjectDeletionJobState" }, "ConversationalAnalysisAuthoringProjectDeployment": { + "description": "Represents a project deployment.", "required": [ "deploymentName", "modelId", @@ -2303,6 +2399,7 @@ "x-ms-client-name": "ProjectDeployment" }, "ConversationalAnalysisAuthoringProjectDeployments": { + "description": "Represents a list of retrieved deployments.", "required": [ "value", "nextLink" @@ -2310,14 +2407,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the deployments.", + "description": "The list of retrieved deployments.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2332,11 +2429,22 @@ "type": "string", "x-ms-enum": { "name": "ProjectKind", - "modelAsString": true + "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", @@ -2371,29 +2479,30 @@ "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" }, "settings": { - "description": "Gets or sets the project settings.", + "description": "The project settings.", "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" }, "projectName": { - "description": "Gets or sets the new project name.", + "description": "The new project name.", "type": "string" }, "multilingual": { - "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "description": "Whether the project would be used for multiple languages or not.", "type": "boolean" }, "description": { - "description": "Gets or sets the new project description.", + "description": "The project description.", "type": "string" }, "language": { - "description": "Gets or sets 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.", + "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" ], @@ -2401,12 +2510,14 @@ "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" @@ -2414,14 +2525,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the projects.", + "description": "The list of projects.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2429,6 +2540,7 @@ "x-ms-client-name": "ProjectsMetadata" }, "ConversationalAnalysisAuthoringProjectTrainedModel": { + "description": "Represents a trained model.", "required": [ "label", "modelId", @@ -2440,36 +2552,37 @@ "type": "object", "properties": { "label": { - "description": "Represents trained model label.", + "description": "The trained model label.", "type": "string" }, "modelId": { - "description": "Represents the ID of this model.", + "description": "The model ID.", "type": "string" }, "lastTrainedDateTime": { "format": "date-time", - "description": "Represents trained model last trained time.", + "description": "The last trained date time of the model.", "type": "string" }, "lastTrainingDurationInSeconds": { "format": "int32", - "description": "Represents trained model last training duration in seconds.", + "description": "The duration of the model's last training request in seconds.", "type": "integer" }, "modelExpirationDate": { "format": "date", - "description": "Represents model expiration date.", + "description": "The model expiration date.", "type": "string" }, "modelTrainingConfigVersion": { - "description": "Represents the model training config version.", + "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" @@ -2477,14 +2590,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the jobs.", + "description": "The list of retrieved jobs.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2498,11 +2611,18 @@ "type": "string", "x-ms-enum": { "name": "StringIndexType", - "modelAsString": true + "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" @@ -2525,13 +2645,14 @@ "type": "string" }, "status": { - "description": "Represents the status of the job.", + "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" @@ -2539,17 +2660,18 @@ "type": "object", "properties": { "languageName": { - "description": "Gets or sets the language name.", + "description": "The language name.", "type": "string" }, "languageCode": { - "description": "Gets or sets the language code.", + "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" @@ -2557,7 +2679,7 @@ "type": "object", "properties": { "value": { - "description": "The list of supported objects.", + "description": "The list of the languages.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" @@ -2572,6 +2694,7 @@ "x-ms-client-name": "SupportedLanguages" }, "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { + "description": "Represents the options for swapping two deployments together.", "required": [ "firstDeploymentName", "secondDeploymentName" @@ -2590,6 +2713,7 @@ "x-ms-client-name": "SwapDeploymentsOptions" }, "ConversationalAnalysisAuthoringTrainingConfigVersion": { + "description": "Represents a training config version.", "required": [ "trainingConfigVersion", "modelExpirationDate" @@ -2597,18 +2721,19 @@ "type": "object", "properties": { "trainingConfigVersion": { - "description": "Represents the training config version.", + "description": "Represents the version of the config.", "type": "string" }, "modelExpirationDate": { "format": "date", - "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", + "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" @@ -2616,14 +2741,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the training config versions.", + "description": "The list of the training config versions.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2631,6 +2756,7 @@ "x-ms-client-name": "TrainingConfigVersions" }, "ConversationalAnalysisAuthoringTrainingJobOptions": { + "description": "Represents the options for starting a new training job.", "required": [ "modelLabel", "trainingMode" @@ -2638,7 +2764,7 @@ "type": "object", "properties": { "modelLabel": { - "description": "Represents training model label.", + "description": "Represents the output model label.", "type": "string" }, "trainingConfigVersion": { @@ -2646,7 +2772,7 @@ "type": "string" }, "trainingMode": { - "description": "Represents the training mode of the training operation.", + "description": "Represents the mode of the training operation.", "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" }, "evaluationOptions": { @@ -2657,6 +2783,7 @@ "x-ms-client-name": "TrainingJobOptions" }, "ConversationalAnalysisAuthoringTrainingJobResult": { + "description": "Represents the output of a training job.", "required": [ "modelLabel", "trainingConfigVersion", @@ -2673,11 +2800,11 @@ "type": "string" }, "trainingMode": { - "description": "Represents the training mode of the training operation.", + "description": "Represents the mode of the training operation.", "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" }, "trainingStatus": { - "description": "Represents model train status.", + "description": "Represents the model training status.", "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" }, "evaluationStatus": { @@ -2686,13 +2813,14 @@ }, "estimatedEndDateTime": { "format": "date-time", - "description": "Represents the estimate end date time for training and evaluation.", + "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" @@ -2700,14 +2828,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the jobs.", + "description": "The list of jobs.", "type": "array", "items": { "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2715,6 +2843,7 @@ "x-ms-client-name": "TrainingJobs" }, "ConversationalAnalysisAuthoringTrainingJobState": { + "description": "Represents the state of a training job.", "required": [ "result" ], @@ -2740,11 +2869,22 @@ "type": "string", "x-ms-enum": { "name": "TrainingMode", - "modelAsString": true + "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 expcted and predicted entities for an utterance.", "required": [ "expectedEntities", "predictedEntities" @@ -2769,6 +2909,7 @@ "x-ms-client-name": "UtteranceEntitiesEvaluationResult" }, "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { + "description": "Represents the evaluation output of an entity label or prediction.", "required": [ "category", "offset", @@ -2794,6 +2935,7 @@ "x-ms-client-name": "UtteranceEntityEvaluationResult" }, "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "description": "Represents the evaluation result for an utterance.", "required": [ "text", "language", @@ -2807,7 +2949,7 @@ "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.", + "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": { @@ -2822,6 +2964,7 @@ "x-ms-client-name": "UtteranceEvaluationResult" }, "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { + "description": "Represents the comparison between the expected and the predicted intent for an utterance.", "required": [ "expectedIntent", "predictedIntent" @@ -2838,6 +2981,25 @@ } }, "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": { @@ -2852,7 +3014,17 @@ ], "x-ms-enum": { "name": "ExportedProjectFormat", - "modelAsString": true + "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" }, @@ -2867,7 +3039,13 @@ ], "x-ms-enum": { "name": "StringIndexType", - "modelAsString": true + "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" }, @@ -2899,7 +3077,17 @@ ], "x-ms-enum": { "name": "ProjectKind", - "modelAsString": true + "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 index 028b16d40d19..14e54cf1e432 100644 --- 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 @@ -1227,7 +1227,8 @@ }, "x-ms-client-name": "ConfusionMatrix" }, - "TextAnalysisAuthoringConfusionMatrixEntry": { + "TextAnalysisAuthoringConfusionMatrixCell": { + "description": "Represents a cell in a confusion matrix.", "required": [ "normalizedValue", "rawValue" @@ -1245,16 +1246,17 @@ "type": "number" } }, - "x-ms-client-name": "ConfusionMatrixEntry" + "x-ms-client-name": "ConfusionMatrixCell" }, "TextAnalysisAuthoringConfusionMatrixRow": { "type": "object", "additionalProperties": { - "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixEntry" + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" }, "x-ms-client-name": "ConfusionMatrixRow" }, "TextAnalysisAuthoringCreateDeploymentOptions": { + "description": "Represents the options for creating or updating a project deployment.", "required": [ "trainedModelLabel" ], @@ -1289,19 +1291,19 @@ "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" }, "projectName": { - "description": "Gets or sets the new project name.", + "description": "The new project name.", "type": "string" }, "multilingual": { - "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "description": "Whether the project would be used for multiple languages or not.", "type": "boolean" }, "description": { - "description": "Gets or sets the new project description.", + "description": "The project description.", "type": "string" }, "language": { - "description": "Gets or sets 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.", + "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" } }, @@ -1422,6 +1424,7 @@ "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" }, "TextAnalysisAuthoringDeploymentJobState": { + "description": "Represents the state of a deployment job.", "type": "object", "allOf": [ { @@ -1504,7 +1507,7 @@ "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.", + "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": { @@ -1631,11 +1634,22 @@ "type": "string", "x-ms-enum": { "name": "EvaluationKind", - "modelAsString": true + "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": { @@ -1663,14 +1677,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the documents predictions.", + "description": "THe list of documents evaluation results.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -1722,7 +1736,7 @@ "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.", + "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": { @@ -1769,7 +1783,7 @@ "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.", + "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": { @@ -1813,7 +1827,7 @@ "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.", + "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": { @@ -1942,6 +1956,7 @@ "x-ms-client-name": "ExportedProjectAssets" }, "TextAnalysisAuthoringExportProjectJobState": { + "description": "Represents the state of an export job.", "type": "object", "allOf": [ { @@ -1950,12 +1965,14 @@ ], "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": [ { @@ -1965,47 +1982,47 @@ "x-ms-client-name": "ImportProjectJobState" }, "TextAnalysisAuthoringJobState": { + "description": "Represents a job's state.", "required": [ "jobId", "createdDateTime", "lastUpdatedDateTime", - "expirationDateTime", "status" ], "type": "object", "properties": { "jobId": { - "description": "Gets or sets the job ID.", + "description": "The job ID.", "type": "string" }, "createdDateTime": { "format": "date-time", - "description": "Gets or sets the created time.", + "description": "The creation date time of the job.", "type": "string" }, "lastUpdatedDateTime": { "format": "date-time", - "description": "Gets or sets the last updated time.", + "description": "The last date time the job was updated.", "type": "string" }, "expirationDateTime": { "format": "date-time", - "description": "Gets or sets the expiration time.", + "description": "The expiration date time of the job.", "type": "string" }, "status": { - "description": "Gets or sets the job status.", + "description": "The job status.", "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" }, "warnings": { - "description": "Gets or sets the warnings.", + "description": "The warnings that were encountered while executing the job.", "type": "array", "items": { - "$ref": "common.json#/definitions/Error" + "$ref": "#/definitions/TextAnalysisAuthoringWarning" } }, "errors": { - "description": "Gets or sets the errors.", + "description": "The errors encountered while executing the job.", "type": "array", "items": { "$ref": "common.json#/definitions/Error" @@ -2016,7 +2033,6 @@ }, "TextAnalysisAuthoringJobStatus": { "enum": [ - "unknown", "notStarted", "running", "succeeded", @@ -2192,6 +2208,7 @@ "x-ms-client-name": "NamedEntityRecognitionEvaluationSummary" }, "TextAnalysisAuthoringProjectDeletionJobState": { + "description": "Represents the state of a project deletion job.", "type": "object", "allOf": [ { @@ -2201,6 +2218,7 @@ "x-ms-client-name": "ProjectDeletionJobState" }, "TextAnalysisAuthoringProjectDeployment": { + "description": "Represents a project deployment.", "required": [ "deploymentName", "modelId", @@ -2242,6 +2260,7 @@ "x-ms-client-name": "ProjectDeployment" }, "TextAnalysisAuthoringProjectDeployments": { + "description": "Represents a list of retrieved deployments.", "required": [ "value", "nextLink" @@ -2249,14 +2268,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the deployments.", + "description": "The list of retrieved deployments.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2320,19 +2339,19 @@ "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" }, "projectName": { - "description": "Gets or sets the new project name.", + "description": "The new project name.", "type": "string" }, "multilingual": { - "description": "Gets or sets a value indicating whether gets or sets whether the project is multilingual or not.", + "description": "Whether the project would be used for multiple languages or not.", "type": "boolean" }, "description": { - "description": "Gets or sets the new project description.", + "description": "The project description.", "type": "string" }, "language": { - "description": "Gets or sets 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.", + "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" } }, @@ -2350,14 +2369,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the projects.", + "description": "The list of projects.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2365,6 +2384,7 @@ "x-ms-client-name": "ProjectsMetadata" }, "TextAnalysisAuthoringProjectTrainedModel": { + "description": "Represents a trained model.", "required": [ "label", "modelId", @@ -2376,36 +2396,37 @@ "type": "object", "properties": { "label": { - "description": "Represents trained model label.", + "description": "The trained model label.", "type": "string" }, "modelId": { - "description": "Represents the ID of this model.", + "description": "The model ID.", "type": "string" }, "lastTrainedDateTime": { "format": "date-time", - "description": "Represents trained model last trained time.", + "description": "The last trained date time of the model.", "type": "string" }, "lastTrainingDurationInSeconds": { "format": "int32", - "description": "Represents trained model last training duration in seconds.", + "description": "The duration of the model's last training request in seconds.", "type": "integer" }, "modelExpirationDate": { "format": "date", - "description": "Represents model expiration date.", + "description": "The model expiration date.", "type": "string" }, "modelTrainingConfigVersion": { - "description": "Represents the model training config version.", + "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" @@ -2413,14 +2434,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the jobs.", + "description": "The list of retrieved jobs.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2541,11 +2562,18 @@ "type": "string", "x-ms-enum": { "name": "StringIndexType", - "modelAsString": true + "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" @@ -2568,13 +2596,14 @@ "type": "string" }, "status": { - "description": "Represents the status of the job.", + "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" @@ -2582,17 +2611,18 @@ "type": "object", "properties": { "languageName": { - "description": "Gets or sets the language name.", + "description": "The language name.", "type": "string" }, "languageCode": { - "description": "Gets or sets the language code.", + "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" @@ -2600,7 +2630,7 @@ "type": "object", "properties": { "value": { - "description": "The list of supported objects.", + "description": "The list of the languages.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" @@ -2615,6 +2645,7 @@ "x-ms-client-name": "SupportedLanguages" }, "TextAnalysisAuthoringSwapDeploymentsOptions": { + "description": "Represents the options for swapping two deployments together.", "required": [ "firstDeploymentName", "secondDeploymentName" @@ -2633,6 +2664,7 @@ "x-ms-client-name": "SwapDeploymentsOptions" }, "TextAnalysisAuthoringTrainingConfigVersion": { + "description": "Represents a training config version.", "required": [ "trainingConfigVersion", "modelExpirationDate" @@ -2640,18 +2672,19 @@ "type": "object", "properties": { "trainingConfigVersion": { - "description": "Represents the training config version.", + "description": "Represents the version of the config.", "type": "string" }, "modelExpirationDate": { "format": "date", - "description": "Represents the training config version expiration date in the format of (\"yyyy-MM-dd\").", + "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" @@ -2659,14 +2692,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the training config versions.", + "description": "The list of the training config versions.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2735,14 +2768,14 @@ "type": "object", "properties": { "value": { - "description": "Gets or sets the jobs.", + "description": "The list of jobs.", "type": "array", "items": { "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" } }, "nextLink": { - "description": "Gets or sets the next page link.", + "description": "The next page link.", "type": "string", "x-nullable": true } @@ -2766,6 +2799,25 @@ } }, "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": { @@ -2780,7 +2832,13 @@ ], "x-ms-enum": { "name": "StringIndexType", - "modelAsString": true + "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" }, From 006e1287181dc568e0fece495c9d2ed58dc7cb26 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Thu, 21 Apr 2022 07:20:20 +0200 Subject: [PATCH 22/24] Fix spelling errors --- custom-words.txt | 2 ++ .../stable/2022-05-01/analyzeconversations-authoring.json | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) 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/stable/2022-05-01/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2022-05-01/analyzeconversations-authoring.json index 34044fa20275..3e87080fad48 100644 --- 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 @@ -1315,7 +1315,7 @@ }, { "value": "combineComponents", - "description": "When two or more components are found in the text and overlap, the components's spans are merged together into one span combining all of them." + "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." } ] }, @@ -2884,7 +2884,7 @@ "x-ms-client-name": "TrainingMode" }, "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { - "description": "Represents the comparison between the expcted and predicted entities for an utterance.", + "description": "Represents the comparison between the expected and predicted entities for an utterance.", "required": [ "expectedEntities", "predictedEntities" From 4e92bc2ed6169ec9b7b947ba3eb8e15920e381a3 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Thu, 21 Apr 2022 15:41:09 +0200 Subject: [PATCH 23/24] Update the descriptions for the analyzetext-authoring --- .../2022-05-01/analyzetext-authoring.json | 134 ++++++++++++++---- 1 file changed, 110 insertions(+), 24 deletions(-) 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 index 14e54cf1e432..a103198a2f1e 100644 --- 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 @@ -1270,6 +1270,7 @@ "x-ms-client-name": "CreateDeploymentOptions" }, "TextAnalysisAuthoringCreateProjectOptions": { + "description": "Represents the options used to create or update a project.", "required": [ "projectKind", "storageInputContainerName", @@ -1279,15 +1280,15 @@ "type": "object", "properties": { "projectKind": { - "description": "Gets or sets the new project model kind.", + "description": "The project kind.", "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" }, "storageInputContainerName": { - "description": "Gets or sets the storage container name.", + "description": "The storage container name.", "type": "string" }, "settings": { - "description": "Gets or sets the project settings.", + "description": "The project settings.", "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" }, "projectName": { @@ -1309,7 +1310,8 @@ }, "x-ms-client-name": "CreateProjectOptions" }, - "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationPrediction": { + "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom multi-label classification project.", "required": [ "customMultiLabelClassificationResult" ], @@ -1326,9 +1328,10 @@ } }, "x-ms-discriminator-value": "customMultiLabelClassification", - "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationPrediction" + "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationResult" }, "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom multi-label classification project.", "required": [ "customMultiLabelClassificationEvaluation" ], @@ -1347,7 +1350,8 @@ "x-ms-discriminator-value": "customMultiLabelClassification", "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" }, - "TextAnalysisAuthoringCustomNamedEntityRecognitionDocumentEvaluationPrediction": { + "TextAnalysisAuthoringCustomNamedEntityRecognitionDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom named entity recognition project.", "required": [ "customNamedEntityRecognitionResult" ], @@ -1364,9 +1368,10 @@ } }, "x-ms-discriminator-value": "customNamedEntityRecognition", - "x-ms-client-name": "CustomNamedEntityRecognitionDocumentEvaluationPrediction" + "x-ms-client-name": "CustomNamedEntityRecognitionDocumentEvaluationResult" }, "TextAnalysisAuthoringCustomNamedEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom named entity recognition project.", "required": [ "customNamedEntityRecognitionEvaluation" ], @@ -1385,7 +1390,8 @@ "x-ms-discriminator-value": "customNamedEntityRecognition", "x-ms-client-name": "CustomNamedEntityRecognitionEvaluationSummary" }, - "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationPrediction": { + "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom single-label classification project.", "required": [ "customSingleLabelClassificationResult" ], @@ -1402,9 +1408,10 @@ } }, "x-ms-discriminator-value": "customSingleLabelClassification", - "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationPrediction" + "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationResult" }, "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom single-label classification project.", "required": [ "customSingleLabelClassificationEvaluation" ], @@ -1434,6 +1441,7 @@ "x-ms-client-name": "DeploymentJobState" }, "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { + "description": "Represents an evaluation result entity label.", "required": [ "category", "offset", @@ -1459,6 +1467,7 @@ "x-ms-client-name": "DocumentEntityLabelEvaluationResult" }, "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { + "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", "required": [ "expectedEntities", "predictedEntities", @@ -1495,6 +1504,7 @@ "x-ms-client-name": "DocumentEntityRegionEvaluationResult" }, "TextAnalysisAuthoringDocumentEvaluationResult": { + "description": "Represents the evaluation result of a document.", "required": [ "location", "language", @@ -1519,6 +1529,7 @@ "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" @@ -1543,6 +1554,7 @@ "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" }, "TextAnalysisAuthoringDocumentNamedEntityRecognitionEvaluationResult": { + "description": "Represents the named entity recognition evaluation result for a document.", "required": [ "entities" ], @@ -1559,6 +1571,7 @@ "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" @@ -1577,6 +1590,7 @@ "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" }, "TextAnalysisAuthoringEntityEvaluationSummary": { + "description": "Represents the evaluation summary for an entity.", "required": [ "f1", "precision", @@ -1670,6 +1684,7 @@ "x-ms-client-name": "EvaluationOptions" }, "TextAnalysisAuthoringEvaluationResults": { + "description": "Represents a list of results for an evaluation operation.", "required": [ "value", "nextLink" @@ -1692,21 +1707,17 @@ "x-ms-client-name": "EvaluationResults" }, "TextAnalysisAuthoringEvaluationSummary": { + "description": "Represents the summary for an evaluation operation.", "required": [ "projectKind", - "customNamedEntityRecognitionEvaluation", "evaluationOptions" ], "type": "object", "properties": { "projectKind": { - "description": "Represents the model kind.", + "description": "Represents the project type that the evaluation ran on.", "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" }, - "customNamedEntityRecognitionEvaluation": { - "description": "Contains the data related to extraction evaluation.", - "$ref": "#/definitions/TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary" - }, "evaluationOptions": { "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" } @@ -1715,24 +1726,29 @@ "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": { @@ -1747,6 +1763,7 @@ "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" }, "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { + "description": "Represents the exported assets for a custom multi-label classification project.", "type": "object", "allOf": [ { @@ -1755,12 +1772,14 @@ ], "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" @@ -1771,15 +1790,18 @@ "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": { @@ -1794,6 +1816,7 @@ "x-ms-client-name": "ExportedCustomNamedEntityRecognitionDocument" }, "TextAnalysisAuthoringExportedCustomNamedEntityRecognitionProjectAssets": { + "description": "Represents the exported assets for a named entity recognition project.", "type": "object", "allOf": [ { @@ -1802,12 +1825,14 @@ ], "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" @@ -1818,12 +1843,15 @@ "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": { @@ -1838,6 +1866,7 @@ "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" }, "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { + "description": "Represents the exported assets for a single-label classification project.", "type": "object", "allOf": [ { @@ -1846,12 +1875,14 @@ ], "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" @@ -1862,6 +1893,7 @@ "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" }, "TextAnalysisAuthoringExportedDocumentClass": { + "description": "Represents a classification label for a document.", "type": "object", "properties": { "category": { @@ -1871,34 +1903,42 @@ "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" @@ -1908,15 +1948,18 @@ "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": [ "project-file-version", "stringIndexType", @@ -1925,6 +1968,7 @@ "type": "object", "properties": { "project-file-version": { + "description": "The version of the exported file.", "type": "string" }, "stringIndexType": { @@ -1943,12 +1987,14 @@ "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" } }, @@ -2049,6 +2095,7 @@ "x-ms-client-name": "JobStatus" }, "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { + "description": "Represents the evaluation summary of a class in a multi-label classification project.", "required": [ "f1", "precision", @@ -2099,6 +2146,7 @@ "x-ms-client-name": "MultiLabelClassEvaluationSummary" }, "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a multi-label classification project.", "required": [ "classes", "microF1", @@ -2151,6 +2199,7 @@ "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" }, "TextAnalysisAuthoringNamedEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom named entity recognition project.", "required": [ "confusionMatrix", "entities", @@ -2291,11 +2340,26 @@ "type": "string", "x-ms-enum": { "name": "ProjectKind", - "modelAsString": true + "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", @@ -2313,29 +2377,29 @@ }, "lastModifiedDateTime": { "format": "date-time", - "description": "Represents the project creation datetime.", + "description": "Represents the project last modification datetime.", "type": "string" }, "lastTrainedDateTime": { "format": "date-time", - "description": "Represents the project last trained datetime.", + "description": "Represents the project last training datetime.", "type": "string" }, "lastDeployedDateTime": { "format": "date-time", - "description": "Represents the project last deployed datetime.", + "description": "Represents the project last deployment datetime.", "type": "string" }, "projectKind": { - "description": "Gets or sets the new project model kind.", + "description": "The project kind.", "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" }, "storageInputContainerName": { - "description": "Gets or sets the storage container name.", + "description": "The storage container name.", "type": "string" }, "settings": { - "description": "Gets or sets the project settings.", + "description": "The project settings.", "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" }, "projectName": { @@ -2358,10 +2422,12 @@ "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" @@ -2449,6 +2515,7 @@ "x-ms-client-name": "ProjectTrainedModels" }, "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { + "description": "Represents the evaluation summary for a class in a single-label classification project.", "required": [ "f1", "precision", @@ -2499,6 +2566,7 @@ "x-ms-client-name": "SingleLabelClassEvaluationSummary" }, "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom single-label classification project.", "required": [ "confusionMatrix", "classes", @@ -2707,6 +2775,7 @@ "x-ms-client-name": "TrainingConfigVersions" }, "TextAnalysisAuthoringTrainingJobOptions": { + "description": "Represents the options for starting a new training job.", "required": [ "modelLabel", "trainingConfigVersion" @@ -2714,7 +2783,7 @@ "type": "object", "properties": { "modelLabel": { - "description": "Represents training model label.", + "description": "Represents the output model label.", "type": "string" }, "trainingConfigVersion": { @@ -2729,6 +2798,7 @@ "x-ms-client-name": "TrainingJobOptions" }, "TextAnalysisAuthoringTrainingJobResult": { + "description": "Represents the output of a training job.", "required": [ "modelLabel", "trainingConfigVersion", @@ -2761,6 +2831,7 @@ "x-ms-client-name": "TrainingJobResult" }, "TextAnalysisAuthoringTrainingJobs": { + "description": "Represents a list of retrieved training jobs.", "required": [ "value", "nextLink" @@ -2783,6 +2854,7 @@ "x-ms-client-name": "TrainingJobs" }, "TextAnalysisAuthoringTrainingJobState": { + "description": "Represents the state of a training job.", "required": [ "result" ], @@ -2871,7 +2943,21 @@ ], "x-ms-enum": { "name": "ProjectKind", - "modelAsString": true + "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" } From e1a8e9f0541ed7e9b7b6ad2504686acf45095b55 Mon Sep 17 00:00:00 2001 From: Mohamed Abbas Date: Wed, 27 Apr 2022 16:46:47 +0200 Subject: [PATCH 24/24] Rename project-file-version to projectFileVersion --- .../stable/2022-05-01/analyzeconversations-authoring.json | 4 ++-- .../Language/stable/2022-05-01/analyzetext-authoring.json | 4 ++-- .../SuccessfulImportProject.json | 2 +- .../analyzetext-authoring/SuccessfulImportProject.json | 2 +- 4 files changed, 6 insertions(+), 6 deletions(-) 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 index 3e87080fad48..ac7e1764e035 100644 --- 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 @@ -1890,13 +1890,13 @@ "ConversationalAnalysisAuthoringExportedProject": { "description": "Represents an exported project.", "required": [ - "project-file-version", + "projectFileVersion", "stringIndexType", "metadata" ], "type": "object", "properties": { - "project-file-version": { + "projectFileVersion": { "description": "The version of the exported file.", "type": "string" }, 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 index a103198a2f1e..9bc14684dc74 100644 --- 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 @@ -1961,13 +1961,13 @@ "TextAnalysisAuthoringExportedProject": { "description": "Represents an exported project.", "required": [ - "project-file-version", + "projectFileVersion", "stringIndexType", "metadata" ], "type": "object", "properties": { - "project-file-version": { + "projectFileVersion": { "description": "The version of the exported file.", "type": "string" }, 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 index 3ed7d6e19dcd..503a15f5aa65 100644 --- 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 @@ -5,7 +5,7 @@ "api-version": "2022-05-01", "projectName": "EmailApp", "body": { - "project-file-version": "2022-05-01", + "projectFileVersion": "2022-05-01", "stringIndexType": "Utf16CodeUnit", "metadata": { "projectKind": "conversation", 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 index 3c7a58ed3b4d..6d9db0e680bf 100644 --- 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 @@ -6,7 +6,7 @@ "api-version": "2022-05-01", "projectName": "LoanAgreements", "body": { - "project-file-version": "2022-05-01", + "projectFileVersion": "2022-05-01", "stringIndexType": "Utf16CodeUnit", "metadata": { "projectKind": "customNamedEntityRecognition",