diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json index 9c9cfc2cf9ea..9496201c3494 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-04-15-preview/analyzeconversations-authoring.json @@ -62,7 +62,7 @@ "paths": { "/authoring/analyze-conversations/projects": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListProjects", + "operationId": "ListProjects", "description": "Lists the existing projects.", "parameters": [ { @@ -92,11 +92,6 @@ } } }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -104,7 +99,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetProject", + "operationId": "GetProject", "description": "Gets the details of a project.", "parameters": [ { @@ -132,15 +127,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } } }, "patch": { - "operationId": "AnalyzeConversationAuthoring_CreateProject", + "operationId": "CreateProject", "description": "Creates a new project or updates an existing one.", "consumes": [ "application/merge-patch+json" @@ -186,15 +176,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } } }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteProject", + "operationId": "DeleteProject", "description": "Deletes a project.", "parameters": [ { @@ -227,17 +212,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { "post": { - "operationId": "AnalyzeConversationAuthoring_CopyProjectAuthorization", + "operationId": "CopyProjectAuthorization", "description": "Generates a copy project operation authorization to the current target Azure resource.", "parameters": [ { @@ -273,17 +253,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Copy Project Authorization": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/:copy": { "post": { - "operationId": "AnalyzeConversationAuthoring_CopyProject", + "operationId": "CopyProject", "description": "Copies an existing project to another Azure resource.", "parameters": [ { @@ -325,17 +300,12 @@ } } }, - "x-ms-examples": { - "Successful Copy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "operationId": "AnalyzeConversationAuthoring_Export", + "operationId": "Export", "description": "Triggers a job to export a project's data.", "parameters": [ { @@ -431,17 +401,12 @@ } } }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "operationId": "AnalyzeConversationAuthoring_Import", + "operationId": "Import", "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "parameters": [ { @@ -511,17 +476,12 @@ } } }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "operationId": "AnalyzeConversationAuthoring_Train", + "operationId": "Train", "description": "Triggers a training job for a project.", "parameters": [ { @@ -563,17 +523,12 @@ } } }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetCopyProjectStatus", + "operationId": "GetCopyProjectStatus", "description": "Gets the status of an existing copy project job.", "parameters": [ { @@ -608,17 +563,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Copy Project Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListDeployments", + "operationId": "ListDeployments", "description": "Lists the deployments belonging to a project.", "parameters": [ { @@ -656,11 +606,6 @@ } } }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -668,7 +613,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeployment", + "operationId": "GetDeployment", "description": "Gets the details of a deployment.", "parameters": [ { @@ -703,15 +648,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } } }, "put": { - "operationId": "AnalyzeConversationAuthoring_DeployProject", + "operationId": "DeployProject", "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { @@ -760,15 +700,10 @@ } } }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, "x-ms-long-running-operation": true }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteDeployment", + "operationId": "DeleteDeployment", "description": "Deletes a project deployment.", "parameters": [ { @@ -808,17 +743,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { "post": { - "operationId": "AnalyzeConversationAuthoring_DeleteDeploymentFromResources", + "operationId": "DeleteDeploymentFromResources", "description": "Deletes a project deployment from the specified assigned resources.", "parameters": [ { @@ -867,17 +797,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Deployment From Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeploymentDeleteFromResourcesStatus", + "operationId": "GetDeploymentDeleteFromResourcesStatus", "description": "Gets the status of an existing delete deployment from specific resources job.", "parameters": [ { @@ -919,17 +844,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeploymentStatus", + "operationId": "GetDeploymentStatus", "description": "Gets the status of an existing deployment job.", "parameters": [ { @@ -971,17 +891,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { "post": { - "operationId": "AnalyzeConversationAuthoring_SwapDeployments", + "operationId": "SwapDeployments", "description": "Swaps two existing deployments with each other.", "parameters": [ { @@ -1023,17 +938,12 @@ } } }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSwapDeploymentsStatus", + "operationId": "GetSwapDeploymentsStatus", "description": "Gets the status of an existing swap deployment job.", "parameters": [ { @@ -1068,17 +978,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetExportStatus", + "operationId": "GetExportStatus", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "parameters": [ { @@ -1113,17 +1018,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetImportStatus", + "operationId": "GetImportStatus", "description": "Gets the status for an import.", "parameters": [ { @@ -1158,17 +1058,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainedModels", + "operationId": "ListTrainedModels", "description": "Lists the trained models belonging to a project.", "parameters": [ { @@ -1206,11 +1101,6 @@ } } }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1218,7 +1108,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetTrainedModel", + "operationId": "GetTrainedModel", "description": "Gets the details of a trained model.", "parameters": [ { @@ -1253,15 +1143,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } } }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteTrainedModel", + "operationId": "DeleteTrainedModel", "description": "Deletes an existing trained model.", "parameters": [ { @@ -1293,17 +1178,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { "post": { - "operationId": "AnalyzeConversationAuthoring_EvaluateModel", + "operationId": "EvaluateModel", "description": "Triggers evaluation operation on a trained model.", "parameters": [ { @@ -1352,17 +1232,12 @@ } } }, - "x-ms-examples": { - "Successful Evaluation Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "operationId": "AnalyzeConversationAuthoring_LoadSnapshot", + "operationId": "LoadSnapshot", "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "parameters": [ { @@ -1402,17 +1277,12 @@ } } }, - "x-ms-examples": { - "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetEvaluationStatus", + "operationId": "GetEvaluationStatus", "description": "Gets the status for an evaluation job.", "parameters": [ { @@ -1454,17 +1324,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Evaluation Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetModelEvaluationResults", + "operationId": "GetModelEvaluationResults", "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "parameters": [ { @@ -1512,11 +1377,6 @@ } } }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1524,7 +1384,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetModelEvaluationSummary", + "operationId": "GetModelEvaluationSummary", "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { @@ -1559,17 +1419,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetLoadSnapshotStatus", + "operationId": "GetLoadSnapshotStatus", "description": "Gets the status for loading a snapshot.", "parameters": [ { @@ -1611,17 +1466,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListDeploymentResources", + "operationId": "ListDeploymentResources", "description": "Lists the deployments resources assigned to the project.", "parameters": [ { @@ -1659,11 +1509,6 @@ } } }, - "x-ms-examples": { - "Successful List Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1671,7 +1516,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { "post": { - "operationId": "AnalyzeConversationAuthoring_AssignDeploymentResources", + "operationId": "AssignDeploymentResources", "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", "parameters": [ { @@ -1713,17 +1558,12 @@ } } }, - "x-ms-examples": { - "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { "post": { - "operationId": "AnalyzeConversationAuthoring_UnassignDeploymentResources", + "operationId": "UnassignDeploymentResources", "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", "parameters": [ { @@ -1765,17 +1605,12 @@ } } }, - "x-ms-examples": { - "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetAssignDeploymentResourcesStatus", + "operationId": "GetAssignDeploymentResourcesStatus", "description": "Gets the status of an existing assign deployment resources job.", "parameters": [ { @@ -1810,17 +1645,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetUnassignDeploymentResourcesStatus", + "operationId": "GetUnassignDeploymentResourcesStatus", "description": "Gets the status of an existing unassign deployment resources job.", "parameters": [ { @@ -1855,17 +1685,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainingJobs", + "operationId": "ListTrainingJobs", "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { @@ -1903,11 +1728,6 @@ } } }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1915,7 +1735,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetTrainingStatus", + "operationId": "GetTrainingStatus", "description": "Gets the status for a training job.", "parameters": [ { @@ -1950,17 +1770,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "operationId": "AnalyzeConversationAuthoring_CancelTrainingJob", + "operationId": "CancelTrainingJob", "description": "Triggers a cancellation for a running training job.", "parameters": [ { @@ -2000,17 +1815,12 @@ } } }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetProjectDeletionStatus", + "operationId": "GetProjectDeletionStatus", "description": "Gets the status for a project deletion job.", "parameters": [ { @@ -2037,17 +1847,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } } } }, "/authoring/analyze-conversations/projects/global/deployments/resources": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListAssignedResourceDeployments", + "operationId": "ListAssignedResourceDeployments", "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", "parameters": [ { @@ -2091,17 +1896,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" - } } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSupportedLanguages", + "operationId": "GetSupportedLanguages", "description": "Lists the supported languages for the given project type.", "parameters": [ { @@ -2179,17 +1979,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSupportedPrebuiltEntities", + "operationId": "GetSupportedPrebuiltEntities", "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "parameters": [ { @@ -2247,17 +2042,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainingConfigVersions", + "operationId": "ListTrainingConfigVersions", "description": "Lists the support training config version for a given project type.", "parameters": [ { @@ -2335,11 +2125,6 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } } } } diff --git a/specification/cognitiveservices/data-plane/Language/preview/2024-11-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2024-11-15-preview/analyzeconversations-authoring.json index c417d5698c4c..e0cd5a75ea7c 100644 --- a/specification/cognitiveservices/data-plane/Language/preview/2024-11-15-preview/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/preview/2024-11-15-preview/analyzeconversations-authoring.json @@ -62,7 +62,7 @@ "paths": { "/authoring/analyze-conversations/projects": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListProjects", + "operationId": "ListProjects", "description": "Lists the existing projects.", "parameters": [ { @@ -92,11 +92,6 @@ } } }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -104,7 +99,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetProject", + "operationId": "GetProject", "description": "Gets the details of a project.", "parameters": [ { @@ -132,15 +127,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } } }, "patch": { - "operationId": "AnalyzeConversationAuthoring_CreateProject", + "operationId": "CreateProject", "description": "Creates a new project or updates an existing one.", "consumes": [ "application/merge-patch+json" @@ -186,15 +176,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } } }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteProject", + "operationId": "DeleteProject", "description": "Deletes a project.", "parameters": [ { @@ -227,17 +212,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { "post": { - "operationId": "AnalyzeConversationAuthoring_CopyProjectAuthorization", + "operationId": "CopyProjectAuthorization", "description": "Generates a copy project operation authorization to the current target Azure resource.", "parameters": [ { @@ -273,17 +253,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Copy Project Authorization": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/:copy": { "post": { - "operationId": "AnalyzeConversationAuthoring_CopyProject", + "operationId": "CopyProject", "description": "Copies an existing project to another Azure resource.", "parameters": [ { @@ -325,17 +300,12 @@ } } }, - "x-ms-examples": { - "Successful Copy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "operationId": "AnalyzeConversationAuthoring_Export", + "operationId": "Export", "description": "Triggers a job to export a project's data.", "parameters": [ { @@ -431,17 +401,12 @@ } } }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "operationId": "AnalyzeConversationAuthoring_Import", + "operationId": "Import", "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "parameters": [ { @@ -511,17 +476,12 @@ } } }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "operationId": "AnalyzeConversationAuthoring_Train", + "operationId": "Train", "description": "Triggers a training job for a project.", "parameters": [ { @@ -563,17 +523,12 @@ } } }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetCopyProjectStatus", + "operationId": "GetCopyProjectStatus", "description": "Gets the status of an existing copy project job.", "parameters": [ { @@ -608,17 +563,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Copy Project Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListDeployments", + "operationId": "ListDeployments", "description": "Lists the deployments belonging to a project.", "parameters": [ { @@ -656,11 +606,6 @@ } } }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -668,7 +613,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeployment", + "operationId": "GetDeployment", "description": "Gets the details of a deployment.", "parameters": [ { @@ -703,15 +648,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } } }, "put": { - "operationId": "AnalyzeConversationAuthoring_DeployProject", + "operationId": "DeployProject", "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { @@ -760,15 +700,10 @@ } } }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, "x-ms-long-running-operation": true }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteDeployment", + "operationId": "DeleteDeployment", "description": "Deletes a project deployment.", "parameters": [ { @@ -808,17 +743,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { "post": { - "operationId": "AnalyzeConversationAuthoring_DeleteDeploymentFromResources", + "operationId": "DeleteDeploymentFromResources", "description": "Deletes a project deployment from the specified assigned resources.", "parameters": [ { @@ -867,17 +797,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Deployment From Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeploymentDeleteFromResourcesStatus", + "operationId": "GetDeploymentDeleteFromResourcesStatus", "description": "Gets the status of an existing delete deployment from specific resources job.", "parameters": [ { @@ -919,17 +844,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentDeleteFromResourcesStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeploymentStatus", + "operationId": "GetDeploymentStatus", "description": "Gets the status of an existing deployment job.", "parameters": [ { @@ -971,17 +891,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { "post": { - "operationId": "AnalyzeConversationAuthoring_SwapDeployments", + "operationId": "SwapDeployments", "description": "Swaps two existing deployments with each other.", "parameters": [ { @@ -1023,17 +938,12 @@ } } }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSwapDeploymentsStatus", + "operationId": "GetSwapDeploymentsStatus", "description": "Gets the status of an existing swap deployment job.", "parameters": [ { @@ -1068,17 +978,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetExportStatus", + "operationId": "GetExportStatus", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "parameters": [ { @@ -1113,17 +1018,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/exported-models": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListExportedModels", + "operationId": "ListExportedModels", "description": "Lists the exported models belonging to a project.", "parameters": [ { @@ -1161,11 +1061,6 @@ } } }, - "x-ms-examples": { - "Successful List Exported Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListExportedModels.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1173,7 +1068,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetExportedModel", + "operationId": "GetExportedModel", "description": "Gets the details of an exported model.", "parameters": [ { @@ -1208,15 +1103,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Exported Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportedModel.json" - } } }, "put": { - "operationId": "AnalyzeConversationAuthoring_CreateOrUpdateExportedModel", + "operationId": "CreateOrUpdateExportedModel", "description": "Creates a new exported model or replaces an existing one.", "parameters": [ { @@ -1264,15 +1154,10 @@ } } }, - "x-ms-examples": { - "Successful Create Exported Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateExportedModel.json" - } - }, "x-ms-long-running-operation": true }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteExportedModel", + "operationId": "DeleteExportedModel", "description": "Deletes an existing exported model.", "parameters": [ { @@ -1311,17 +1196,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Exported Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteExportedModel.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetExportedModelJobStatus", + "operationId": "GetExportedModelJobStatus", "description": "Gets the status for an existing job to create or update an exported model.", "parameters": [ { @@ -1363,17 +1243,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Exported Model Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportedModelStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetImportStatus", + "operationId": "GetImportStatus", "description": "Gets the status for an import.", "parameters": [ { @@ -1408,17 +1283,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainedModels", + "operationId": "ListTrainedModels", "description": "Lists the trained models belonging to a project.", "parameters": [ { @@ -1456,11 +1326,6 @@ } } }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1468,7 +1333,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetTrainedModel", + "operationId": "GetTrainedModel", "description": "Gets the details of a trained model.", "parameters": [ { @@ -1503,15 +1368,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } } }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteTrainedModel", + "operationId": "DeleteTrainedModel", "description": "Deletes an existing trained model.", "parameters": [ { @@ -1543,17 +1403,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { "post": { - "operationId": "AnalyzeConversationAuthoring_EvaluateModel", + "operationId": "EvaluateModel", "description": "Triggers evaluation operation on a trained model.", "parameters": [ { @@ -1602,17 +1457,12 @@ } } }, - "x-ms-examples": { - "Successful Evaluation Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "operationId": "AnalyzeConversationAuthoring_LoadSnapshot", + "operationId": "LoadSnapshot", "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "parameters": [ { @@ -1652,17 +1502,12 @@ } } }, - "x-ms-examples": { - "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetEvaluationStatus", + "operationId": "GetEvaluationStatus", "description": "Gets the status for an evaluation job.", "parameters": [ { @@ -1704,17 +1549,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Evaluation Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetModelEvaluationResults", + "operationId": "GetModelEvaluationResults", "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "parameters": [ { @@ -1762,11 +1602,6 @@ } } }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1774,7 +1609,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetModelEvaluationSummary", + "operationId": "GetModelEvaluationSummary", "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { @@ -1809,17 +1644,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetLoadSnapshotStatus", + "operationId": "GetLoadSnapshotStatus", "description": "Gets the status for loading a snapshot.", "parameters": [ { @@ -1861,17 +1691,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListDeploymentResources", + "operationId": "ListDeploymentResources", "description": "Lists the deployments resources assigned to the project.", "parameters": [ { @@ -1909,11 +1734,6 @@ } } }, - "x-ms-examples": { - "Successful List Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1921,7 +1741,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { "post": { - "operationId": "AnalyzeConversationAuthoring_AssignDeploymentResources", + "operationId": "AssignDeploymentResources", "description": "Assign new Azure resources to a project to allow deploying new deployments to them. This API is available only via AAD authentication and not supported via subscription key authentication. For more details about AAD authentication, check here: https://learn.microsoft.com/en-us/azure/cognitive-services/authentication?tabs=powershell#authenticate-with-azure-active-directory", "parameters": [ { @@ -1963,17 +1783,12 @@ } } }, - "x-ms-examples": { - "Successful Assign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { "post": { - "operationId": "AnalyzeConversationAuthoring_UnassignDeploymentResources", + "operationId": "UnassignDeploymentResources", "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", "parameters": [ { @@ -2015,17 +1830,12 @@ } } }, - "x-ms-examples": { - "Successful Unassign Deployment Resources": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetAssignDeploymentResourcesStatus", + "operationId": "GetAssignDeploymentResourcesStatus", "description": "Gets the status of an existing assign deployment resources job.", "parameters": [ { @@ -2060,17 +1870,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Assign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetUnassignDeploymentResourcesStatus", + "operationId": "GetUnassignDeploymentResourcesStatus", "description": "Gets the status of an existing unassign deployment resources job.", "parameters": [ { @@ -2105,17 +1910,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Unassign Deployment Resources Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainingJobs", + "operationId": "ListTrainingJobs", "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { @@ -2153,11 +1953,6 @@ } } }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -2165,7 +1960,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetTrainingStatus", + "operationId": "GetTrainingStatus", "description": "Gets the status for a training job.", "parameters": [ { @@ -2200,17 +1995,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "operationId": "AnalyzeConversationAuthoring_CancelTrainingJob", + "operationId": "CancelTrainingJob", "description": "Triggers a cancellation for a running training job.", "parameters": [ { @@ -2250,17 +2040,12 @@ } } }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetProjectDeletionStatus", + "operationId": "GetProjectDeletionStatus", "description": "Gets the status for a project deletion job.", "parameters": [ { @@ -2287,17 +2072,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } } } }, "/authoring/analyze-conversations/projects/global/deployments/resources": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListAssignedResourceDeployments", + "operationId": "ListAssignedResourceDeployments", "description": "Lists the deployments to which an Azure resource is assigned. This doesn't return deployments belonging to projects owned by this resource. It only returns deployments belonging to projects owned by other resources.", "parameters": [ { @@ -2341,17 +2121,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful List Assigned Resource Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" - } } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSupportedLanguages", + "operationId": "GetSupportedLanguages", "description": "Lists the supported languages for the given project type.", "parameters": [ { @@ -2429,17 +2204,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSupportedPrebuiltEntities", + "operationId": "GetSupportedPrebuiltEntities", "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "parameters": [ { @@ -2497,17 +2267,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainingConfigVersions", + "operationId": "ListTrainingConfigVersions", "description": "Lists the support training config version for a given project type.", "parameters": [ { @@ -2585,11 +2350,6 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } } } } diff --git a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json index 538cd010e2e5..daada8d452d2 100644 --- a/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json +++ b/specification/cognitiveservices/data-plane/Language/stable/2023-04-01/analyzeconversations-authoring.json @@ -62,7 +62,7 @@ "paths": { "/authoring/analyze-conversations/projects": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListProjects", + "operationId": "ListProjects", "description": "Lists the existing projects.", "parameters": [ { @@ -92,11 +92,6 @@ } } }, - "x-ms-examples": { - "Successful List Projects": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -104,7 +99,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetProject", + "operationId": "GetProject", "description": "Gets the details of a project.", "parameters": [ { @@ -132,15 +127,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" - } } }, "patch": { - "operationId": "AnalyzeConversationAuthoring_CreateProject", + "operationId": "CreateProject", "description": "Creates a new project or updates an existing one.", "consumes": [ "application/merge-patch+json" @@ -186,15 +176,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Create Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" - } } }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteProject", + "operationId": "DeleteProject", "description": "Deletes a project.", "parameters": [ { @@ -227,17 +212,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:export": { "post": { - "operationId": "AnalyzeConversationAuthoring_Export", + "operationId": "Export", "description": "Triggers a job to export a project's data.", "parameters": [ { @@ -333,17 +313,12 @@ } } }, - "x-ms-examples": { - "Successful Export Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:import": { "post": { - "operationId": "AnalyzeConversationAuthoring_Import", + "operationId": "Import", "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", "parameters": [ { @@ -413,17 +388,12 @@ } } }, - "x-ms-examples": { - "Successful Import Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/:train": { "post": { - "operationId": "AnalyzeConversationAuthoring_Train", + "operationId": "Train", "description": "Triggers a training job for a project.", "parameters": [ { @@ -465,17 +435,12 @@ } } }, - "x-ms-examples": { - "Successful Train Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListDeployments", + "operationId": "ListDeployments", "description": "Lists the deployments belonging to a project.", "parameters": [ { @@ -513,11 +478,6 @@ } } }, - "x-ms-examples": { - "Successful List Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -525,7 +485,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeployment", + "operationId": "GetDeployment", "description": "Gets the details of a deployment.", "parameters": [ { @@ -560,15 +520,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" - } } }, "put": { - "operationId": "AnalyzeConversationAuthoring_DeployProject", + "operationId": "DeployProject", "description": "Creates a new deployment or replaces an existing one.", "parameters": [ { @@ -617,15 +572,10 @@ } } }, - "x-ms-examples": { - "Successful Deploy Project": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" - } - }, "x-ms-long-running-operation": true }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteDeployment", + "operationId": "DeleteDeployment", "description": "Deletes a project deployment.", "parameters": [ { @@ -665,17 +615,12 @@ } } }, - "x-ms-examples": { - "Successful Delete Deployment": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetDeploymentStatus", + "operationId": "GetDeploymentStatus", "description": "Gets the status of an existing deployment job.", "parameters": [ { @@ -717,17 +662,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Deployment Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { "post": { - "operationId": "AnalyzeConversationAuthoring_SwapDeployments", + "operationId": "SwapDeployments", "description": "Swaps two existing deployments with each other.", "parameters": [ { @@ -769,17 +709,12 @@ } } }, - "x-ms-examples": { - "Successful Swap Deployments": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSwapDeploymentsStatus", + "operationId": "GetSwapDeploymentsStatus", "description": "Gets the status of an existing swap deployment job.", "parameters": [ { @@ -814,17 +749,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Swap Deployments Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetExportStatus", + "operationId": "GetExportStatus", "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", "parameters": [ { @@ -859,17 +789,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Export Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetImportStatus", + "operationId": "GetImportStatus", "description": "Gets the status for an import.", "parameters": [ { @@ -904,17 +829,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Import Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainedModels", + "operationId": "ListTrainedModels", "description": "Lists the trained models belonging to a project.", "parameters": [ { @@ -952,11 +872,6 @@ } } }, - "x-ms-examples": { - "Successful List Models": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -964,7 +879,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetTrainedModel", + "operationId": "GetTrainedModel", "description": "Gets the details of a trained model.", "parameters": [ { @@ -999,15 +914,10 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" - } } }, "delete": { - "operationId": "AnalyzeConversationAuthoring_DeleteTrainedModel", + "operationId": "DeleteTrainedModel", "description": "Deletes an existing trained model.", "parameters": [ { @@ -1039,17 +949,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Delete Model": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { "post": { - "operationId": "AnalyzeConversationAuthoring_LoadSnapshot", + "operationId": "LoadSnapshot", "description": "Restores the snapshot of this trained model to be the current working directory of the project.", "parameters": [ { @@ -1089,17 +994,12 @@ } } }, - "x-ms-examples": { - "Successful Load Snapshot": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetModelEvaluationResults", + "operationId": "GetModelEvaluationResults", "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", "parameters": [ { @@ -1147,11 +1047,6 @@ } } }, - "x-ms-examples": { - "Successful Get Model Evaluation": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1159,7 +1054,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetModelEvaluationSummary", + "operationId": "GetModelEvaluationSummary", "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", "parameters": [ { @@ -1194,17 +1089,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Model Evaluation Summary": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetLoadSnapshotStatus", + "operationId": "GetLoadSnapshotStatus", "description": "Gets the status for loading a snapshot.", "parameters": [ { @@ -1246,17 +1136,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Load Snapshot Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainingJobs", + "operationId": "ListTrainingJobs", "description": "Lists the non-expired training jobs created for a project.", "parameters": [ { @@ -1294,11 +1179,6 @@ } } }, - "x-ms-examples": { - "Successful List Training Jobs": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" - } - }, "x-ms-pageable": { "nextLinkName": "nextLink" } @@ -1306,7 +1186,7 @@ }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetTrainingStatus", + "operationId": "GetTrainingStatus", "description": "Gets the status for a training job.", "parameters": [ { @@ -1341,17 +1221,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Train Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" - } } } }, "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { "post": { - "operationId": "AnalyzeConversationAuthoring_CancelTrainingJob", + "operationId": "CancelTrainingJob", "description": "Triggers a cancellation for a running training job.", "parameters": [ { @@ -1391,17 +1266,12 @@ } } }, - "x-ms-examples": { - "Successful Cancel Training Job": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" - } - }, "x-ms-long-running-operation": true } }, "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetProjectDeletionStatus", + "operationId": "GetProjectDeletionStatus", "description": "Gets the status for a project deletion job.", "parameters": [ { @@ -1428,17 +1298,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Project Deletion Status": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" - } } } }, "/authoring/analyze-conversations/projects/global/languages": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSupportedLanguages", + "operationId": "GetSupportedLanguages", "description": "Lists the supported languages for the given project type.", "parameters": [ { @@ -1510,17 +1375,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Languages": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" - } } } }, "/authoring/analyze-conversations/projects/global/prebuilt-entities": { "get": { - "operationId": "AnalyzeConversationAuthoring_GetSupportedPrebuiltEntities", + "operationId": "GetSupportedPrebuiltEntities", "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", "parameters": [ { @@ -1578,17 +1438,12 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Prebuilt Entities": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" - } } } }, "/authoring/analyze-conversations/projects/global/training-config-versions": { "get": { - "operationId": "AnalyzeConversationAuthoring_ListTrainingConfigVersions", + "operationId": "ListTrainingConfigVersions", "description": "Lists the support training config version for a given project type.", "parameters": [ { @@ -1660,11 +1515,6 @@ "$ref": "#/definitions/ErrorResponse" } } - }, - "x-ms-examples": { - "Successful Get Supported Training Config Versions": { - "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" - } } } }