From 68dc5ca73c95f630da6b0de2a8bb41a840ddc0e8 Mon Sep 17 00:00:00 2001 From: dhung-msft <39925549+dhung-msft@users.noreply.github.com> Date: Mon, 13 Nov 2023 17:31:54 -0800 Subject: [PATCH] Azure Language Summarization November 2023 Preview Features (#25817) * Add param for query extsum * Custom summary aspects * Rename customAspects -> previewAspects * Add query parameter to abs docsum as well * Add new Recap summary aspect * Modify description * Revert "Add param for query extsum" This reverts commit dd4b89518e5efd89673aed1b94d8c243e892e956. * Bump API version * Bump common.json API version * Update API version in examples * Bump API version to 2023-11-01-preview * Add sentence length bucket param * Deprecate? * Remove unsupported property * Use November 15 for API version * Add inference options parameter for EntityRecognition * Rebase analyze-conversations onto preview API * Add conv examples from preview * Remove obsolete text examples * Update API version in examples * Update README * Address issues * Address heaths comments * Address comments from API review for summarization API * Add files from 2023-04-15-preview to dev/ * Adds base for updating Language from version preview/2023-04-15-preview to version 2023-11-15-preview * Updates readme * Updates API version in new specs and examples * Update API versions in /dev * Non-API change sync between /dev and /specification * Sync summarization API changes to /specification * Remove 'None' length preference in favor of eliding field * Update new NER options and examples * Address PR comments * Fix spacing * Resolve delta between dev and 2023-11-15-preview * Update readme and remove spurious copies * Don't modify existing specifications * Re-add custom word incorrectly removed in #26361 * Add new 'follow-up tasks' preview aspect * Re-add field dropped during rebase * Update descriptions for new aspects * Update tag to latest preview * Re-add additionalProperties element * Update description for query field * Remove changes to dev/ * Revert "Remove changes to dev/" This reverts commit f958c8ce5ea4481a12be8ab1dbc13cd9e1e2a81d. * Reset dev/ to state from upstream/master * Restore readme.csharp.md * Change TasksStatus property formats to int32 --------- Co-authored-by: Bidisha Chakraborty --- custom-words.txt | 1 + .../analyzeconversations-authoring.json | 4282 ++++++++++++++ .../analyzeconversations.json | 2682 +++++++++ .../analyzetext-authoring.json | 5265 +++++++++++++++++ .../2023-11-15-preview/analyzetext.json | 4964 ++++++++++++++++ .../preview/2023-11-15-preview/common.json | 1052 ++++ .../SuccessfulAssignDeploymentResources.json | 29 + .../SuccessfulCancelTrainingJob.json | 16 + .../SuccessfulCopyProject.json | 23 + .../SuccessfulCopyProjectAuthorization.json | 25 + .../SuccessfulCreateProject.json | 44 + .../SuccessfulDeleteDeployment.json | 16 + ...ccessfulDeleteDeploymentFromResources.json | 21 + .../SuccessfulDeleteModel.json | 12 + .../SuccessfulDeleteProject.json | 15 + .../SuccessfulDeployProject.json | 23 + .../SuccessfulEvaluationProject.json | 21 + .../SuccessfulExportProject.json | 16 + ...fulGetAssignDeploymentResourcesStatus.json | 21 + .../SuccessfulGetCopyProjectStatus.json | 21 + .../SuccessfulGetDeployment.json | 32 + .../SuccessfulGetDeploymentStatus.json | 22 + .../SuccessfulGetEvaluationStatus.json | 32 + .../SuccessfulGetExportStatus.json | 22 + .../SuccessfulGetImportStatus.json | 21 + .../SuccessfulGetLoadSnapshotStatus.json | 22 + .../SuccessfulGetModel.json | 23 + .../SuccessfulGetModelEvaluation.json | 284 + .../SuccessfulGetModelEvaluationSummary.json | 526 ++ .../SuccessfulGetProject.json | 24 + .../SuccessfulGetProjectDeletionStatus.json | 20 + .../SuccessfulGetSupportedLanguages.json | 398 ++ ...uccessfulGetSupportedPrebuiltEntities.json | 98 + ...fulGetSupportedTrainingConfigVersions.json | 22 + .../SuccessfulGetSwapDeploymentsStatus.json | 21 + .../SuccessfulGetTrainStatus.json | 36 + ...lGetUnassignDeploymentResourcesStatus.json | 21 + .../SuccessfulImportProject.json | 78 + ...essfulListAssignedResourceDeployments.json | 26 + .../SuccessfulListDeploymentResources.json | 25 + .../SuccessfulListDeployments.json | 49 + .../SuccessfulListModels.json | 36 + .../SuccessfulListProjects.json | 35 + .../SuccessfulListTrainingJobs.json | 90 + .../SuccessfulLoadSnapshot.json | 16 + .../SuccessfulSwapDeployments.json | 19 + .../SuccessfulTrainProject.json | 25 + ...SuccessfulUnassignDeploymentResources.json | 21 + .../SuccessfulAssignDeploymentResources.json | 29 + .../SuccessfulCancelTrainingJob.json | 16 + .../SuccessfulCopyProject.json | 23 + .../SuccessfulCopyProjectAuthorization.json | 26 + .../SuccessfulCreateExportedModel.json | 19 + .../SuccessfulCreateProject.json | 47 + .../SuccessfulDeleteDeployment.json | 16 + ...ccessfulDeleteDeploymentFromResources.json | 21 + .../SuccessfulDeleteExportedModel.json | 16 + .../SuccessfulDeleteModel.json | 12 + .../SuccessfulDeleteProject.json | 15 + .../SuccessfulDeployProject.json | 24 + .../SuccessfulEvaluationProject.json | 21 + .../SuccessfulExportProject.json | 16 + ...fulGetAssignDeploymentResourcesStatus.json | 21 + .../SuccessfulGetCopyProjectStatus.json | 21 + .../SuccessfulGetDeployment.json | 32 + .../SuccessfulGetDeploymentStatus.json | 22 + .../SuccessfulGetEvaluationStatus.json | 32 + .../SuccessfulGetExportStatus.json | 22 + .../SuccessfulGetExportedModel.json | 22 + .../SuccessfulGetExportedModelManifest.json | 34 + .../SuccessfulGetExportedModelStatus.json | 22 + .../SuccessfulGetImportStatus.json | 21 + .../SuccessfulGetLoadSnapshotStatus.json | 22 + .../SuccessfulGetModel.json | 23 + .../SuccessfulGetModelEvaluation.json | 295 + .../SuccessfulGetModelEvaluationSummary.json | 232 + .../SuccessfulGetProject.json | 25 + .../SuccessfulGetProjectDeletionStatus.json | 20 + .../SuccessfulGetSupportedLanguages.json | 389 ++ ...uccessfulGetSupportedPrebuiltEntities.json | 198 + ...fulGetSupportedTrainingConfigVersions.json | 22 + .../SuccessfulGetSwapDeploymentsStatus.json | 21 + .../SuccessfulGetTrainStatus.json | 35 + ...lGetUnassignDeploymentResourcesStatus.json | 21 + .../SuccessfulImportProject.json | 99 + ...essfulListAssignedResourceDeployments.json | 26 + .../SuccessfulListDeploymentResources.json | 25 + .../SuccessfulListDeployments.json | 49 + .../SuccessfulListExportedModels.json | 34 + .../SuccessfulListModels.json | 36 + .../SuccessfulListProjects.json | 39 + .../SuccessfulListTrainingJobs.json | 87 + .../SuccessfulLoadSnapshot.json | 16 + .../SuccessfulSwapDeployments.json | 20 + .../SuccessfulTrainProject.json | 24 + ...SuccessfulUnassignDeploymentResources.json | 21 + .../SuccessfulAnalyzeConversations.json | 61 + ...essfulAnalyzeConversationsArbitration.json | 74 + ...eConversationsArbitrationDirectTarget.json | 75 + ...AnalyzeConversationsJobsCancelRequest.json | 15 + ...cessfulConversationPIIExclusionSubmit.json | 74 + ...ersationPIIExclusionTaskStatusRequest.json | 66 + ...fulConversationPIIRedactionCharSubmit.json | 75 + ...tionPIIRedactionCharTaskStatusRequest.json | 74 + .../SuccessfulConversationPIISubmit.json | 74 + ...ssfulConversationPIITaskStatusRequest.json | 74 + ...SuccessfulConversationSentimentSubmit.json | 47 + ...onversationSentimentTaskStatusRequest.json | 60 + ...ulConversationSummarizationTaskResult.json | 75 + ...rsationSummarizationTaskStatusRequest.json | 59 + ...ulConversationSummarizationTaskSubmit.json | 77 + .../SuccessfulConversationSummarySubmit.json | 61 + ...omConversationSummarizationTaskResult.json | 64 + ...omConversationSummarizationTaskSubmit.json | 78 + .../SuccessfulQueryKnowledgebases.json | 99 + .../SuccessfulQueryText.json | 66 + .../authoring/SuccessfulCreateProject.json | 49 + .../authoring/SuccessfulDeleteProject.json | 17 + .../authoring/SuccessfulGetProject.json | 25 + .../authoring/SuccessfulGetQnas.json | 57 + .../authoring/SuccessfulGetSources.json | 33 + .../authoring/SuccessfulGetSynonyms.json | 30 + .../SuccessfulProjectDeleteJobStatus.json | 22 + .../SuccessfulProjectDeployJobStatus.json | 24 + .../SuccessfulProjectExportJobStatus.json | 24 + .../SuccessfulProjectImportJobStatus.json | 23 + .../SuccessfulProjectListDeployments.json | 22 + .../SuccessfulProjectSubmitDeployJob.json | 18 + .../SuccessfulProjectSubmitExportJob.json | 35 + .../SuccessfulProjectSubmitImportJob.json | 73 + .../SuccessfulProjectsListProjects.json | 35 + ...uccessfulUpdateActiveLearningFeedback.json | 26 + .../authoring/SuccessfulUpdateQnas.json | 74 + .../SuccessfulUpdateQnasJobStatus.json | 23 + .../authoring/SuccessfulUpdateSources.json | 47 + .../SuccessfulUpdateSourcesJobStatus.json | 23 + .../authoring/SuccessfulUpdateSynonyms.json | 28 + ...SuccessfuDynamicClassificationRequest.json | 92 + ...fulAbstractiveSummarizationTaskResult.json | 56 + ...fulAbstractiveSummarizationTaskSubmit.json | 36 + ...uccessfulAnalyzeTextJobsCancelRequest.json | 15 + ...lyzeTextJobsMultipleTaskStatusRequest.json | 178 + ...lyzeTextJobsMultipleTaskSubmitRequest.json | 49 + ...tomAbstractiveSummarizationTaskResult.json | 57 + ...tomAbstractiveSummarizationTaskSubmit.json | 37 + ...SuccessfulCustomHealthcarePostRequest.json | 34 + ...sfulCustomHealthcareTaskStatusRequest.json | 251 + ...tomSentimentAnalysisTaskStatusRequest.json | 75 + ...sfulCustomSentimentAnalysisTaskSubmit.json | 34 + .../text/SuccessfulEntityLinkingRequest.json | 128 + ...sfulEntityRecognitionExclusionRequest.json | 134 + ...sfulEntityRecognitionInclusionRequest.json | 131 + ...ityRecognitionInferenceOptionsRequest.json | 81 + ...cessfulEntityRecognitionOverlapPolicy.json | 77 + .../SuccessfulEntityRecognitionRequest.json | 337 ++ ...sfulHealthcareDocumentTypePostRequest.json | 36 + ...althcareDocumentTypeTaskStatusRequest.json | 552 ++ .../text/SuccessfulHealthcarePostRequest.json | 34 + ...SuccessfulHealthcareTaskStatusRequest.json | 220 + .../SuccessfulKeyPhraseExtractionRequest.json | 71 + .../SuccessfulLanguageDetectionRequest.json | 84 + ...lPiiEntityRecognitionExclusionRequest.json | 77 + ...lPiiEntityRecognitionRedactionRequest.json | 89 + ...SuccessfulPiiEntityRecognitionRequest.json | 88 + .../SuccessfulSentimentAnalysisRequest.json | 148 + .../questionanswering-authoring.json | 1816 ++++++ .../2023-11-15-preview/questionanswering.json | 601 ++ .../data-plane/Language/readme.md | 45 +- 168 files changed, 30636 insertions(+), 5 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations-authoring.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext-authoring.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/common.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryText.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityLinkingRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInferenceOptionsRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcarePostRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering-authoring.json create mode 100644 specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering.json diff --git a/custom-words.txt b/custom-words.txt index cb1f6fb96632..576f624d2b30 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1291,6 +1291,7 @@ importdevices imsi inari inbuild +inclusivity incomingrelationships incrementalcopy indic diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations-authoring.json new file mode 100644 index 000000000000..49b32d3ad523 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations-authoring.json @@ -0,0 +1,4282 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations Authoring", + "version": "2023-11-15-preview", + "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": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + } + }, + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://cognitiveservices.azure.com/.default" + ] + }, + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/authoring/analyze-conversations/projects": { + "get": { + "description": "Lists the existing projects.", + "operationId": "ConversationalAnalysisAuthoring_ListProjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of projects.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}": { + "patch": { + "description": "Creates a new project or updates an existing one.", + "operationId": "ConversationalAnalysisAuthoring_CreateProject", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCreateProject.json" + } + } + }, + "get": { + "description": "Gets the details of a project.", + "operationId": "ConversationalAnalysisAuthoring_GetProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the project.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProject.json" + } + } + }, + "delete": { + "description": "Deletes a project.", + "operationId": "ConversationalAnalysisAuthoring_DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:authorize-copy": { + "post": { + "description": "Generates a copy project operation authorization to the current target Azure resource.", + "operationId": "ConversationalAnalysisAuthoring_CopyProjectAuthorization", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The copy project authorization info.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyAuthorizationOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Payload to send to source resource to initiate project copying.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectOptions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Copy Project Authorization": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:copy": { + "post": { + "description": "Copies an existing project to another Azure resource.", + "operationId": "ConversationalAnalysisAuthoring_CopyProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The copy project info.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Copy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCopyProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:export": { + "post": { + "description": "Triggers a job to export a project's data.", + "operationId": "ConversationalAnalysisAuthoring_Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "in": "query", + "name": "assetKind", + "description": "Kind of asset to export.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "in": "query", + "name": "trainedModelLabel", + "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulExportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:import": { + "post": { + "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", + "operationId": "ConversationalAnalysisAuthoring_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringFormatQueryOptionalParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProject" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulImportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/:train": { + "post": { + "description": "Triggers a training job for a project.", + "operationId": "ConversationalAnalysisAuthoring_Train", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulTrainProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing copy project job.", + "operationId": "ConversationalAnalysisAuthoring_GetCopyProjectStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCopyProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Copy Project Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments": { + "get": { + "description": "Lists the deployments belonging to a project.", + "operationId": "ConversationalAnalysisAuthoring_ListDeployments", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all deployments.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/:swap": { + "post": { + "description": "Swaps two existing deployments with each other.", + "operationId": "ConversationalAnalysisAuthoring_SwapDeployments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSwapDeploymentsOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}": { + "get": { + "description": "Gets the details of a deployment.", + "operationId": "ConversationalAnalysisAuthoring_GetDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Deployment info.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeployment.json" + } + } + }, + "put": { + "description": "Creates a new deployment or replaces an existing one.", + "operationId": "ConversationalAnalysisAuthoring_DeployProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeployProject.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes a project deployment.", + "operationId": "ConversationalAnalysisAuthoring_DeleteDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { + "post": { + "description": "Deletes a project deployment from the specified assigned resources.", + "operationId": "ConversationalAnalysisAuthoring_DeleteDeploymentFromResources", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The options for deleting the deployment.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeleteDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing delete deployment from specific resources job.", + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Delete Deployment From Resources Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing deployment job.", + "operationId": "ConversationalAnalysisAuthoring_GetDeploymentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing swap deployment job.", + "operationId": "ConversationalAnalysisAuthoring_GetSwapDeploymentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The swap deployment job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "operationId": "ConversationalAnalysisAuthoring_GetExportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "description": "Gets the status for an import.", + "operationId": "ConversationalAnalysisAuthoring_GetImportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringImportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models": { + "get": { + "description": "Lists the trained models belonging to a project.", + "operationId": "ConversationalAnalysisAuthoring_ListTrainedModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all trained models.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}": { + "get": { + "description": "Gets the details of a trained model.", + "operationId": "ConversationalAnalysisAuthoring_GetTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trained model info", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModel.json" + } + } + }, + "delete": { + "description": "Deletes an existing trained model.", + "operationId": "ConversationalAnalysisAuthoring_DeleteTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Deleted successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulDeleteModel.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { + "post": { + "description": "Triggers evaluation operation on a trained model.", + "operationId": "ConversationalAnalysisAuthoring_EvaluateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Evaluation": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { + "post": { + "description": "Restores the snapshot of this trained model to be the current working directory of the project.", + "operationId": "ConversationalAnalysisAuthoring_LoadSnapshot", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful 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": { + "description": "Gets the status for an evaluation job.", + "operationId": "ConversationalAnalysisAuthoring_GetEvaluationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The evaluation job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/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": { + "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the evaluation predictions.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", + "operationId": "ConversationalAnalysisAuthoring_GetModelEvaluationSummary", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all evaluation results.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationSummary" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { + "get": { + "description": "Gets the status for loading a snapshot.", + "operationId": "ConversationalAnalysisAuthoring_GetLoadSnapshotStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringLoadSnapshotJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Load Snapshot Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources": { + "get": { + "description": "Lists the deployments resources assigned to the project.", + "operationId": "ConversationalAnalysisAuthoring_ListDeploymentResources", + "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": "The assigned deployment resources.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResources" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/:assign": { + "post": { + "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", + "operationId": "ConversationalAnalysisAuthoring_AssignDeploymentResources", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The new project resources info.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Assign Deployment Resources": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/{projectName}/resources/:unassign": { + "post": { + "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", + "operationId": "ConversationalAnalysisAuthoring_UnassignDeploymentResources", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The info for the deployment resources to be deleted.", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful 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": { + "description": "Gets the status of an existing assign deployment resources job.", + "operationId": "ConversationalAnalysisAuthoring_GetAssignDeploymentResourcesStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The assign deployment resources job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/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": { + "description": "Gets the status of an existing unassign deployment resources job.", + "operationId": "ConversationalAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The unassign deployment resources job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/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": { + "description": "Lists the non-expired training jobs created for a project.", + "operationId": "ConversationalAnalysisAuthoring_ListTrainingJobs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the training jobs.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobs" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}": { + "get": { + "description": "Gets the status for a training job.", + "operationId": "ConversationalAnalysisAuthoring_GetTrainingStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The training job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "description": "Triggers a cancellation for a running training job.", + "operationId": "ConversationalAnalysisAuthoring_CancelTrainingJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the job cancellation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}": { + "get": { + "description": "Gets the status for a project deletion job.", + "operationId": "ConversationalAnalysisAuthoring_GetProjectDeletionStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The project deletion job result.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeletionJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json" + } + } + } + }, + "/authoring/analyze-conversations/projects/global/deployments/resources": { + "get": { + "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.", + "operationId": "ConversationalAnalysisAuthoring_ListAssignedResourceDeployments", + "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 assigned deployments metadata for the resource.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Assigned Resource Deployments": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/global/languages": { + "get": { + "description": "Lists the supported languages for the given project type.", + "operationId": "ConversationalAnalysisAuthoring_GetSupportedLanguages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported languages.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguages" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Supported Languages": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/global/prebuilt-entities": { + "get": { + "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", + "operationId": "ConversationalAnalysisAuthoring_GetSupportedPrebuiltEntities", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "language", + "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "in": "query", + "name": "multilingual", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported prebuilt entities.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntities" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Prebuilt Entities": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-conversations/projects/global/training-config-versions": { + "get": { + "description": "Lists the support training config version for a given project type.", + "operationId": "ConversationalAnalysisAuthoring_ListTrainingConfigVersions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ConversationalAnalysisAuthoringProjectKindQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of config versions.", + "schema": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + } + }, + "definitions": { + "ConversationalAnalysisAuthoringAssignDeploymentResourcesOptions": { + "description": "Represents the options for assigning Azure resources to a project.", + "required": [ + "resourcesMetadata" + ], + "type": "object", + "properties": { + "resourcesMetadata": { + "description": "Represents the metadata for the resources to be assigned.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringResourceMetadata" + } + } + }, + "x-ms-client-name": "AssignDeploymentResourcesOptions" + }, + "ConversationalAnalysisAuthoringAssignedDeploymentResource": { + "description": "Represents the assigned deployment resource.", + "required": [ + "azureResourceId", + "region" + ], + "type": "object", + "properties": { + "azureResourceId": { + "description": "The resource ID.", + "type": "string" + }, + "region": { + "description": "The resource region.", + "type": "string" + } + }, + "x-ms-client-name": "AssignedDeploymentResource" + }, + "ConversationalAnalysisAuthoringAssignedDeploymentResources": { + "description": "Represents the assigned deployment resources.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of assigned deployment resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedDeploymentResource" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "AssignedDeploymentResources" + }, + "ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata": { + "description": "Represents the metadata for an assigned deployment", + "required": [ + "deploymentName", + "lastDeployedDateTime", + "deploymentExpirationDate" + ], + "type": "object", + "properties": { + "deploymentName": { + "description": "Represents the deployment name.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents deployment last deployed time.", + "type": "string" + }, + "deploymentExpirationDate": { + "format": "date", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + } + }, + "x-ms-client-name": "AssignedProjectDeploymentMetadata" + }, + "ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata": { + "description": "Represents the metadata for assigned deployments for a project.", + "required": [ + "projectName", + "deploymentsMetadata" + ], + "type": "object", + "properties": { + "projectName": { + "description": "Represents the project name.", + "type": "string" + }, + "deploymentsMetadata": { + "description": "Represents the resource region.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentMetadata" + } + } + }, + "x-ms-client-name": "AssignedProjectDeploymentsMetadata" + }, + "ConversationalAnalysisAuthoringAssignedResourceDeploymentsMetadata": { + "description": "Represents the metadata for deployments assigned to a resource.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved assigned project deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringAssignedProjectDeploymentsMetadata" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "AssignedResourceDeploymentsMetadata" + }, + "ConversationalAnalysisAuthoringCompositionSetting": { + "enum": [ + "returnLongestOverlap", + "requireExactOverlap", + "separateComponents", + "combineComponents" + ], + "type": "string", + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "value": "returnLongestOverlap", + "description": "When two or more components are found in the text and overlap, the component with the longest set of characters is returned." + }, + { + "value": "requireExactOverlap", + "description": "All components must overlap at the exact same characters in the text for the entity to return. If one of the defined components is not matched or predicted, the entity will not return." + }, + { + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the entity." + }, + { + "value": "combineComponents", + "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." + } + ] + }, + "x-ms-client-name": "CompositionSetting" + }, + "ConversationalAnalysisAuthoringConfusionMatrix": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow" + }, + "x-ms-client-name": "ConfusionMatrix" + }, + "ConversationalAnalysisAuthoringConfusionMatrixCell": { + "description": "Represents a cell in a confusion matrix.", + "required": [ + "normalizedValue", + "rawValue" + ], + "type": "object", + "properties": { + "normalizedValue": { + "format": "float", + "description": "Represents normalized value in percentages.", + "type": "number" + }, + "rawValue": { + "format": "float", + "description": "Represents raw value.", + "type": "number" + } + }, + "x-ms-client-name": "ConfusionMatrixCell" + }, + "ConversationalAnalysisAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell" + }, + "x-ms-client-name": "ConfusionMatrixRow" + }, + "ConversationalAnalysisAuthoringConversationExportedEntity": { + "description": "Represents an entity with its components.", + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "description": "The category of the entity.", + "type": "string" + }, + "compositionSetting": { + "description": "The behavior to follow when the entity's components overlap with each other.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringCompositionSetting" + }, + "list": { + "description": "The list component of the entity.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityList" + }, + "prebuilts": { + "description": "The prebuilt entities components.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedPrebuiltEntity" + } + }, + "regex": { + "description": "The regex component of the entity.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegex" + }, + "requiredComponents": { + "description": "The required components. Allowed values are 'learned', 'list', 'prebuilts' and 'regex'.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "ConversationExportedEntity" + }, + "ConversationalAnalysisAuthoringConversationExportedIntent": { + "description": "Represents an exported intent of a conversational project.", + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "description": "The intent category.", + "type": "string" + } + }, + "x-ms-client-name": "ConversationExportedIntent" + }, + "ConversationalAnalysisAuthoringConversationExportedProjectAssets": { + "description": "Represents the exported assets of a conversational project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "intents": { + "description": "The intents defined in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedIntent" + } + }, + "entities": { + "description": "The entities defined in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedEntity" + } + }, + "utterances": { + "description": "The utterances defined in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringConversationExportedUtterance" + } + } + }, + "x-ms-discriminator-value": "Conversation", + "x-ms-client-name": "ConversationExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringConversationExportedUtterance": { + "description": "Represents an exported utterance for a conversational project.", + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "entities": { + "description": "Represents the entity labels of the utterance.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedUtteranceEntityLabel" + } + }, + "text": { + "description": "The utterance text.", + "type": "string" + }, + "language": { + "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "intent": { + "description": "The intent of the utterance.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ConversationExportedUtterance" + }, + "ConversationalAnalysisAuthoringConversationSummarizationExportedProjectAssets": { + "type": "object", + "properties": { + "conversations": { + "description": "Represents the conversations of the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringCustomConversationSummarizationConversation" + } + } + }, + "x-ms-client-name": "ConversationSummarizationExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringCopyAuthorizationOptions": { + "description": "Represents the options for authorizing a project copy to the current Azure resource.", + "required": [ + "projectKind" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + }, + "storageInputContainerName": { + "description": "The name of the storage container.", + "type": "string" + }, + "allowOverwrite": { + "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization.", + "type": "boolean" + } + }, + "x-ms-client-name": "CopyAuthorizationOptions" + }, + "ConversationalAnalysisAuthoringCopyProjectJobState": { + "description": "Represents the state of a copy job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "CopyProjectJobState" + }, + "ConversationalAnalysisAuthoringCopyProjectOptions": { + "description": "Represents the options for copying an existing project to another Azure resource.", + "required": [ + "projectKind", + "targetProjectName", + "accessToken", + "expiresAt", + "targetResourceId", + "targetResourceRegion" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + }, + "targetProjectName": { + "description": "The project name to be copied-into.", + "type": "string" + }, + "accessToken": { + "description": "The access token.", + "type": "string" + }, + "expiresAt": { + "format": "date-time", + "description": "The expiration of the access token.", + "type": "string" + }, + "targetResourceId": { + "description": "Represents the target Azure resource ID.", + "type": "string" + }, + "targetResourceRegion": { + "description": "Represents the target Azure resource region.", + "type": "string" + } + }, + "x-ms-client-name": "CopyProjectOptions" + }, + "ConversationalAnalysisAuthoringCreateDeploymentOptions": { + "description": "Represents the options for creating or updating a project deployment.", + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "Represents the trained model label.", + "type": "string" + }, + "assignedResourceIds": { + "description": "Represents the resource IDs to be assigned to the deployment.\n If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "CreateDeploymentOptions" + }, + "ConversationalAnalysisAuthoringCreateProjectOptions": { + "description": "Represents the options used to create or update a project.", + "required": [ + "projectKind", + "projectName", + "language" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + }, + "storageInputContainerName": { + "description": "The storage container name in case of conversation summarization.", + "type": "string" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + } + }, + "x-ms-client-name": "CreateProjectOptions" + }, + "ConversationalAnalysisAuthoringCustomConversationSummarizationConversation": { + "description": "Represents an exported conversation for a custom conversation summarization.", + "required": [ + "location" + ], + "type": "object", + "properties": { + "summaryLocation": { + "type": "string" + }, + "location": { + "description": "Represents the conversation file location in the blob store container associated with the project.", + "type": "string" + }, + "language": { + "description": "Represents the language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this conversation. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "CustomConversationSummarizationConversation" + }, + "ConversationalAnalysisAuthoringDeleteDeploymentOptions": { + "description": "Represents the options for deleting a project deployment.", + "type": "object", + "properties": { + "assignedResourceIds": { + "description": "Represents the resource IDs to delete the deployment from.\n If not provided, the deployment will be rolled out from all the resources it is deployed to.\n If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "DeleteDeploymentOptions" + }, + "ConversationalAnalysisAuthoringDeploymentJobState": { + "description": "Represents the state of a deployment job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "DeploymentJobState" + }, + "ConversationalAnalysisAuthoringDeploymentResource": { + "description": "Represents an Azure resource assigned to a deployment.", + "required": [ + "resourceId", + "region" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "Represents the Azure resource Id.", + "type": "string" + }, + "region": { + "description": "Represents the resource region.", + "type": "string" + } + }, + "x-ms-client-name": "DeploymentResource" + }, + "ConversationalAnalysisAuthoringDeploymentResourcesJobState": { + "description": "Represents the state of a deployment resources job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "DeploymentResourcesJobState" + }, + "ConversationalAnalysisAuthoringEntitiesEvaluationSummary": { + "description": "Represents the evaluation result summary for the project's entities.", + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + }, + "entities": { + "description": "Represents the entities evaluation summary.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntityEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "EntitiesEvaluationSummary" + }, + "ConversationalAnalysisAuthoringEntityEvaluationSummary": { + "description": "Represents the evaluation result for an entity.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "EntityEvaluationSummary" + }, + "ConversationalAnalysisAuthoringEvaluationJobResult": { + "required": [ + "evaluationOptions", + "modelLabel", + "trainingConfigVersion", + "percentComplete" + ], + "type": "object", + "properties": { + "evaluationOptions": { + "description": "Represents the options used running the evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + }, + "modelLabel": { + "description": "Represents trained model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "percentComplete": { + "format": "int32", + "description": "Represents progress percentage.", + "type": "integer" + } + }, + "x-ms-client-name": "EvaluationJobResult" + }, + "ConversationalAnalysisAuthoringEvaluationJobState": { + "description": "Represents the state of a evaluation job.", + "required": [ + "result" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "properties": { + "result": { + "description": "Represents evaluation task detailed result.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationJobResult" + } + }, + "x-ms-client-name": "EvaluationJobState" + }, + "ConversationalAnalysisAuthoringEvaluationKind": { + "enum": [ + "percentage", + "manual" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + }, + "x-ms-client-name": "EvaluationKind" + }, + "ConversationalAnalysisAuthoringEvaluationOptions": { + "description": "Represents the options used running the evaluation.", + "type": "object", + "properties": { + "kind": { + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationKind" + }, + "trainingSplitPercentage": { + "format": "int32", + "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + }, + "testingSplitPercentage": { + "format": "int32", + "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + } + }, + "x-ms-client-name": "EvaluationOptions" + }, + "ConversationalAnalysisAuthoringEvaluationResults": { + "description": "Represent a list of utterances' evaluation results.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The utterances evaluation results.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEvaluationResult" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EvaluationResults" + }, + "ConversationalAnalysisAuthoringEvaluationSummary": { + "description": "Represents the evaluation result summary.", + "required": [ + "entitiesEvaluation", + "intentsEvaluation" + ], + "type": "object", + "properties": { + "entitiesEvaluation": { + "description": "Contains the data related to entities evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEntitiesEvaluationSummary" + }, + "intentsEvaluation": { + "description": "Contains the data related to intents evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentsEvaluationSummary" + }, + "evaluationOptions": { + "description": "The options that were used while running the evaluation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + } + }, + "x-ms-client-name": "EvaluationSummary" + }, + "ConversationalAnalysisAuthoringExportedConversationOrchestration": { + "description": "Defines the orchestration details for a Conversational project target.", + "required": [ + "projectName", + "deploymentName" + ], + "type": "object", + "properties": { + "projectName": { + "description": "The name of the targeted project.", + "type": "string" + }, + "deploymentName": { + "description": "The name of the targeted deployment.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedConversationOrchestration" + }, + "ConversationalAnalysisAuthoringExportedConversationOrchestrationOptions": { + "description": "Represents the orchestration options for a Conversational project target.", + "required": [ + "conversationOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "conversationOrchestration": { + "description": "The Conversational project target details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedConversationOrchestration" + } + }, + "x-ms-discriminator-value": "Conversation", + "x-ms-client-name": "ExportedConversationOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedEntityList": { + "description": "Represents a list component of an entity.", + "type": "object", + "properties": { + "sublists": { + "description": "The sub-lists of the list component.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntitySublist" + } + } + }, + "x-ms-client-name": "ExportedEntityList" + }, + "ConversationalAnalysisAuthoringExportedEntityListSynonym": { + "description": "Represents a list of synonyms inside a list component", + "type": "object", + "properties": { + "language": { + "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "values": { + "description": "The list of synonyms.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "ExportedEntityListSynonym" + }, + "ConversationalAnalysisAuthoringExportedEntityRegex": { + "description": "Represents a regex component of an entity.", + "type": "object", + "properties": { + "expressions": { + "description": "The regex expressions of the regex component. These expressions follow the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityRegexExpression" + } + } + }, + "x-ms-client-name": "ExportedEntityRegex" + }, + "ConversationalAnalysisAuthoringExportedEntityRegexExpression": { + "description": "Represents a regex expression inside a regex component. This expression follows the .NET regex syntax. For reference, check here: https://learn.microsoft.com/dotnet/standard/base-types/regular-expressions", + "type": "object", + "properties": { + "regexKey": { + "description": "The key of the regex expression.", + "type": "string" + }, + "language": { + "description": "Represents the language of the regex expression. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "regexPattern": { + "description": "The regex pattern.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedEntityRegexExpression" + }, + "ConversationalAnalysisAuthoringExportedEntitySublist": { + "description": "Represents a sub-list inside a list component.", + "type": "object", + "properties": { + "listKey": { + "description": "The key of the sub-list.", + "type": "string" + }, + "synonyms": { + "description": "The phrases of that correspond to the sub-list.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedEntityListSynonym" + } + } + }, + "x-ms-client-name": "ExportedEntitySublist" + }, + "ConversationalAnalysisAuthoringExportedLuisOrchestration": { + "description": "Defines the orchestration details for a LUIS application target.", + "required": [ + "appId" + ], + "type": "object", + "properties": { + "appId": { + "format": "uuid", + "description": "The LUIS application ID.", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000" + }, + "appVersion": { + "description": "The targeted version Id.", + "type": "string" + }, + "slotName": { + "description": "The targeted slot name.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedLuisOrchestration" + }, + "ConversationalAnalysisAuthoringExportedLuisOrchestrationOptions": { + "description": "Represents the orchestration options for a LUIS application target.", + "required": [ + "luisOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "luisOrchestration": { + "description": "The LUIS application target details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedLuisOrchestration" + } + }, + "x-ms-discriminator-value": "Luis", + "x-ms-client-name": "ExportedLuisOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedOrchestrationOptions": { + "description": "Represents the options used to define the orchestration behavior of an intent.", + "required": [ + "targetProjectKind" + ], + "type": "object", + "properties": { + "targetProjectKind": { + "description": "The kind of the target used in the orchestration flow.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationTargetProjectKind" + } + }, + "discriminator": "targetProjectKind", + "x-ms-client-name": "ExportedOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedPrebuiltEntity": { + "description": "Represents an exported prebuilt entity component", + "required": [ + "category" + ], + "type": "object", + "properties": { + "category": { + "description": "The prebuilt entity category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedPrebuiltEntity" + }, + "ConversationalAnalysisAuthoringExportedProject": { + "description": "Represents an exported project.", + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "projectFileVersion": { + "description": "The version of the exported file.", + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringStringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringCreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + }, + "x-ms-client-name": "ExportedProject" + }, + "ConversationalAnalysisAuthoringExportedProjectAssets": { + "description": "Represents the assets of an exported project.", + "required": [ + "projectKind" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "The type of project containing the assets.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "ExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringExportedProjectFormat": { + "enum": [ + "Conversation", + "Luis" + ], + "type": "string", + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-client-name": "ExportedProjectFormat" + }, + "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration": { + "description": "Defines the orchestration details for a Question Answering project target.", + "required": [ + "projectName" + ], + "type": "object", + "properties": { + "projectName": { + "description": "The name of the target project.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedQuestionAnsweringOrchestration" + }, + "ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestrationOptions": { + "description": "Represents the orchestration options for a Question Answering project target.", + "required": [ + "questionAnsweringOrchestration" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + } + ], + "properties": { + "questionAnsweringOrchestration": { + "description": "The Question Answering project details.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedQuestionAnsweringOrchestration" + } + }, + "x-ms-discriminator-value": "QuestionAnswering", + "x-ms-client-name": "ExportedQuestionAnsweringOrchestrationOptions" + }, + "ConversationalAnalysisAuthoringExportedUtteranceEntityLabel": { + "description": "Represents an entity label for an utterance.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "The category of the entity label.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Start position for the entity text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Length for the entity text.", + "type": "integer" + } + }, + "x-ms-client-name": "ExportedUtteranceEntityLabel" + }, + "ConversationalAnalysisAuthoringExportProjectJobState": { + "description": "Represents the state of an export job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "properties": { + "resultUrl": { + "description": "The URL to use in order to download the exported project.", + "type": "string" + } + }, + "x-ms-client-name": "ExportProjectJobState" + }, + "ConversationalAnalysisAuthoringImportProjectJobState": { + "description": "Represents the state of an import job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ImportProjectJobState" + }, + "ConversationalAnalysisAuthoringIntentEvaluationSummary": { + "description": "The evaluation summary for an intent.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "IntentEvaluationSummary" + }, + "ConversationalAnalysisAuthoringIntentsEvaluationSummary": { + "description": "Represents the evaluation summary for the project's intents.", + "required": [ + "confusionMatrix", + "intents", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two intents (the two intents can be the same). The matrix is between the intent that was labelled and the intent that was predicted.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringConfusionMatrix" + }, + "intents": { + "description": "Represents the intents evaluation summary.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringIntentEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "IntentsEvaluationSummary" + }, + "ConversationalAnalysisAuthoringJobState": { + "description": "Represents a job's state.", + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "The job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation date time of the job.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "The last date time the job was updated.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date time of the job.", + "type": "string" + }, + "status": { + "description": "The job status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + }, + "warnings": { + "description": "The warnings that were encountered while executing the job.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringWarning" + } + }, + "errors": { + "description": "The errors encountered while executing the job.", + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + }, + "x-ms-client-name": "JobState" + }, + "ConversationalAnalysisAuthoringJobStatus": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + }, + "x-ms-client-name": "JobStatus" + }, + "ConversationalAnalysisAuthoringLoadSnapshotJobState": { + "description": "Represents the state of loading a snapshot job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "LoadSnapshotJobState" + }, + "ConversationalAnalysisAuthoringOrchestrationExportedIntent": { + "description": "Represents an exported intent for an orchestration project.", + "required": [ + "category" + ], + "type": "object", + "properties": { + "orchestration": { + "description": "Specifies the behavior of this intent in the orchestration flow.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedOrchestrationOptions" + }, + "category": { + "description": "The intent category.", + "type": "string" + } + }, + "x-ms-client-name": "OrchestrationExportedIntent" + }, + "ConversationalAnalysisAuthoringOrchestrationExportedProjectAssets": { + "description": "Represents the assets of an orchestration project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "intents": { + "description": "Represents the intents of the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedIntent" + } + }, + "utterances": { + "description": "Represents the utterances of the project.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringOrchestrationExportedUtterance" + } + } + }, + "x-ms-discriminator-value": "Orchestration", + "x-ms-client-name": "OrchestrationExportedProjectAssets" + }, + "ConversationalAnalysisAuthoringOrchestrationExportedUtterance": { + "description": "Represents an utterance of an orchestration project.", + "required": [ + "text", + "intent" + ], + "type": "object", + "properties": { + "text": { + "description": "The utterance text.", + "type": "string" + }, + "language": { + "description": "Represents the utterance's language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "intent": { + "description": "The intent of the utterance.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this utterance. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "OrchestrationExportedUtterance" + }, + "ConversationalAnalysisAuthoringOrchestrationTargetProjectKind": { + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering" + ], + "type": "string", + "x-ms-enum": { + "name": "OrchestrationTargetProjectKind", + "modelAsString": true + }, + "x-ms-client-name": "OrchestrationTargetProjectKind" + }, + "ConversationalAnalysisAuthoringPrebuiltEntities": { + "description": "Represents a list of the retrieved supported prebuilt entities.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The supported prebuilt entities.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringPrebuiltEntity" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "PrebuiltEntities" + }, + "ConversationalAnalysisAuthoringPrebuiltEntity": { + "description": "Represents a supported prebuilt entity.", + "required": [ + "category", + "description", + "examples" + ], + "type": "object", + "properties": { + "category": { + "description": "The prebuilt entity category.", + "type": "string" + }, + "description": { + "description": "The description.", + "type": "string" + }, + "examples": { + "description": "English examples for the entity.", + "type": "string" + } + }, + "x-ms-client-name": "PrebuiltEntity" + }, + "ConversationalAnalysisAuthoringProjectDeletionJobState": { + "description": "Represents the state of a project deletion job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ProjectDeletionJobState" + }, + "ConversationalAnalysisAuthoringProjectDeployment": { + "description": "Represents a project deployment.", + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion", + "assignedResources" + ], + "type": "object", + "properties": { + "deploymentName": { + "description": "Represents deployment name.", + "type": "string" + }, + "modelId": { + "description": "Represents deployment modelId.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents deployment last trained time.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents deployment last deployed time.", + "type": "string" + }, + "deploymentExpirationDate": { + "format": "date", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents model training config version.", + "type": "string" + }, + "assignedResources": { + "description": "Represents the metadata of the assigned Azure resources.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringDeploymentResource" + } + } + }, + "x-ms-client-name": "ProjectDeployment" + }, + "ConversationalAnalysisAuthoringProjectDeployments": { + "description": "Represents a list of retrieved deployments.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectDeployment" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectDeployments" + }, + "ConversationalAnalysisAuthoringProjectKind": { + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "type": "string", + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + "ConversationalAnalysisAuthoringProjectMetadata": { + "description": "Represents the metadata of a project.", + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "projectName", + "language" + ], + "type": "object", + "properties": { + "createdDateTime": { + "format": "date-time", + "description": "Represents the project creation datetime.", + "type": "string" + }, + "lastModifiedDateTime": { + "format": "date-time", + "description": "Represents the project creation datetime.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents the project last trained datetime.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents the project last deployed datetime.", + "type": "string" + }, + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectKind" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectSettings" + }, + "storageInputContainerName": { + "description": "The storage container name in case of conversation summarization.", + "type": "string" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectMetadata" + }, + "ConversationalAnalysisAuthoringProjectSettings": { + "description": "Represents the settings used to define the project behavior.", + "required": [ + "confidenceThreshold" + ], + "type": "object", + "properties": { + "confidenceThreshold": { + "format": "float", + "description": "The threshold of the intent with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "ProjectSettings" + }, + "ConversationalAnalysisAuthoringProjectsMetadata": { + "description": "Represents a list of retrieved projects' metadata.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of projects.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectMetadata" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectsMetadata" + }, + "ConversationalAnalysisAuthoringProjectTrainedModel": { + "description": "Represents a trained model.", + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ], + "type": "object", + "properties": { + "label": { + "description": "The trained model label.", + "type": "string" + }, + "modelId": { + "description": "The model ID.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "The last trained date time of the model.", + "type": "string" + }, + "lastTrainingDurationInSeconds": { + "format": "int32", + "description": "The duration of the model's last training request in seconds.", + "type": "integer" + }, + "modelExpirationDate": { + "format": "date", + "description": "The model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "The model training config version.", + "type": "string" + }, + "hasSnapshot": { + "description": "The flag to indicate if the trained model has a snapshot ready.", + "type": "boolean" + } + }, + "x-ms-client-name": "ProjectTrainedModel" + }, + "ConversationalAnalysisAuthoringProjectTrainedModels": { + "description": "Represents a list of retrieved trained models.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of trained models.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringProjectTrainedModel" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectTrainedModels" + }, + "ConversationalAnalysisAuthoringResourceMetadata": { + "description": "Represents metadata for the Azure resource..", + "required": [ + "azureResourceId", + "customDomain", + "region" + ], + "type": "object", + "properties": { + "azureResourceId": { + "description": "Represents the Azure resource ID.", + "type": "string" + }, + "customDomain": { + "description": "Represents the Azure resource custom domain.", + "type": "string" + }, + "region": { + "description": "Represents the Azure resource region.", + "type": "string" + } + }, + "x-ms-client-name": "ResourceMetadata" + }, + "ConversationalAnalysisAuthoringStringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "x-ms-client-name": "StringIndexType" + }, + "ConversationalAnalysisAuthoringSubTrainingJobState": { + "description": "Represents the detailed state of a training sub-operation.", + "required": [ + "percentComplete", + "status" + ], + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Represents progress percentage.", + "type": "integer" + }, + "startDateTime": { + "format": "date-time", + "description": "Represents the start date time.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Represents the end date time.", + "type": "string" + }, + "status": { + "description": "Represents the status of the sub-operation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobStatus" + } + }, + "x-ms-client-name": "SubTrainingJobState" + }, + "ConversationalAnalysisAuthoringSupportedLanguage": { + "description": "Represents a supported language.", + "required": [ + "languageName", + "languageCode" + ], + "type": "object", + "properties": { + "languageName": { + "description": "The language name.", + "type": "string" + }, + "languageCode": { + "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + } + }, + "x-ms-client-name": "SupportedLanguage" + }, + "ConversationalAnalysisAuthoringSupportedLanguages": { + "description": "Represents a list of retrieved languages.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the languages.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringSupportedLanguage" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "SupportedLanguages" + }, + "ConversationalAnalysisAuthoringSwapDeploymentsOptions": { + "description": "Represents the options for swapping two deployments together.", + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ], + "type": "object", + "properties": { + "firstDeploymentName": { + "description": "Represents the first deployment name.", + "type": "string" + }, + "secondDeploymentName": { + "description": "Represents the second deployment name.", + "type": "string" + } + }, + "x-ms-client-name": "SwapDeploymentsOptions" + }, + "ConversationalAnalysisAuthoringTrainingConfigVersion": { + "description": "Represents a training config version.", + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ], + "type": "object", + "properties": { + "trainingConfigVersion": { + "description": "Represents the version of the config.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date", + "description": "Represents the training config version expiration date.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingConfigVersion" + }, + "ConversationalAnalysisAuthoringTrainingConfigVersions": { + "description": "Represents a list of training config versions.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the training config versions.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingConfigVersion" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingConfigVersions" + }, + "ConversationalAnalysisAuthoringTrainingJobOptions": { + "description": "Represents the options for starting a new training job.", + "required": [ + "modelLabel", + "trainingMode" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents the output model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version. By default, \"latest\" value is used which uses the latest released training config version.", + "type": "string" + }, + "trainingMode": { + "description": "Represents the mode of the training operation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + }, + "evaluationOptions": { + "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringEvaluationOptions" + } + }, + "x-ms-client-name": "TrainingJobOptions" + }, + "ConversationalAnalysisAuthoringTrainingJobResult": { + "description": "Represents the output of a training job.", + "required": [ + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents trained model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "trainingMode": { + "description": "Represents the mode of the training operation.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingMode" + }, + "trainingStatus": { + "description": "Represents the model training status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + }, + "evaluationStatus": { + "description": "Represents model evaluation status.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringSubTrainingJobState" + }, + "estimatedEndDateTime": { + "format": "date-time", + "description": "Represents the estimated end date time for training and evaluation.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingJobResult" + }, + "ConversationalAnalysisAuthoringTrainingJobs": { + "description": "Represents a list of retrieved training jobs.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobState" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingJobs" + }, + "ConversationalAnalysisAuthoringTrainingJobState": { + "description": "Represents the state of a training job.", + "required": [ + "result" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationalAnalysisAuthoringJobState" + } + ], + "properties": { + "result": { + "description": "Represents training tasks detailed result.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringTrainingJobResult" + } + }, + "x-ms-client-name": "TrainingJobState" + }, + "ConversationalAnalysisAuthoringTrainingMode": { + "enum": [ + "advanced", + "standard" + ], + "type": "string", + "x-ms-enum": { + "name": "TrainingMode", + "modelAsString": true, + "values": [ + { + "value": "advanced", + "description": "Trains using fine-tuned neural network transformer models. Can train multilingual projects." + }, + { + "value": "standard", + "description": "Faster training times for quicker iterations." + } + ] + }, + "x-ms-client-name": "TrainingMode" + }, + "ConversationalAnalysisAuthoringUnassignDeploymentResourcesOptions": { + "description": "Represents the options to unassign Azure resources from a project.", + "required": [ + "assignedResourceIds" + ], + "type": "object", + "properties": { + "assignedResourceIds": { + "description": "Represents the assigned resource IDs to be unassigned.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "UnassignDeploymentResourcesOptions" + }, + "ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult": { + "description": "Represents the comparison between the expected and predicted entities for an utterance.", + "required": [ + "expectedEntities", + "predictedEntities" + ], + "type": "object", + "properties": { + "expectedEntities": { + "description": "Represents the expected entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" + } + }, + "predictedEntities": { + "description": "Represents the predicted entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult" + } + } + }, + "x-ms-client-name": "UtteranceEntitiesEvaluationResult" + }, + "ConversationalAnalysisAuthoringUtteranceEntityEvaluationResult": { + "description": "Represents the evaluation output of an entity label or prediction.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "Represents the entity category.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Represents the entity offset index relative to the original text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Represents the entity length.", + "type": "integer" + } + }, + "x-ms-client-name": "UtteranceEntityEvaluationResult" + }, + "ConversationalAnalysisAuthoringUtteranceEvaluationResult": { + "description": "Represents the evaluation result for an utterance.", + "required": [ + "text", + "language", + "entitiesResult", + "intentsResult" + ], + "type": "object", + "properties": { + "text": { + "description": "Represents the utterance text.", + "type": "string" + }, + "language": { + "description": "Represents the utterance language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "entitiesResult": { + "description": "Represents the entities results for the utterance.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceEntitiesEvaluationResult" + }, + "intentsResult": { + "description": "Represents the intents results for the utterance.", + "$ref": "#/definitions/ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult" + } + }, + "x-ms-client-name": "UtteranceEvaluationResult" + }, + "ConversationalAnalysisAuthoringUtteranceIntentsEvaluationResult": { + "description": "Represents the comparison between the expected and the predicted intent for an utterance.", + "required": [ + "expectedIntent", + "predictedIntent" + ], + "type": "object", + "properties": { + "expectedIntent": { + "description": "Represents the utterance's expected intent.", + "type": "string" + }, + "predictedIntent": { + "description": "Represents the utterance's predicted intent.", + "type": "string" + } + }, + "x-ms-client-name": "UtteranceIntentsEvaluationResult" + }, + "ConversationalAnalysisAuthoringWarning": { + "description": "Represents a warning that was encountered while executing the request.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The warning code.", + "type": "string" + }, + "message": { + "description": "The warning message.", + "type": "string" + } + }, + "x-ms-client-name": "Warning" + } + }, + "parameters": { + "ConversationalAnalysisAuthoringFormatQueryOptionalParameter": { + "in": "query", + "name": "format", + "description": "The format of the exported project file to use.", + "type": "string", + "enum": [ + "Conversation", + "Luis" + ], + "x-ms-enum": { + "name": "ExportedProjectFormat", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "Specifies the format for a conversational project." + }, + { + "value": "Luis", + "description": "Specifies the format for an application that was exported from LUIS." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringStringIndexTypeQueryParameter": { + "in": "query", + "name": "stringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringJobIdPathParameter": { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringTrainedModelLabelPathParameter": { + "in": "path", + "name": "trainedModelLabel", + "description": "The trained model label.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConversationalAnalysisAuthoringProjectKindQueryParameter": { + "in": "query", + "name": "projectKind", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "Conversation", + "Orchestration", + "CustomConversationSummarization" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "Conversation", + "description": "A project to build natural language into apps, bots, and IoT devices." + }, + { + "value": "Orchestration", + "description": "A project to connect and orchestrate Conversation, Custom question answering and LUIS projects together in one single project." + }, + { + "value": "CustomConversationSummarization", + "description": "A project to build conversation summarization models which are able to summarize long conversations." + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations.json new file mode 100644 index 000000000000..daf3e928d305 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzeconversations.json @@ -0,0 +1,2682 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Conversations", + "description": "The language service conversations API is a suite of natural language processing (NLP) skills that can be used to analyze structured conversations (textual or spoken). The synchronous API in this suite accepts a request and mediates among multiple language projects, such as LUIS Generally Available, Question Answering, Conversational Language Understanding, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload.\n\n In some cases, this API needs to forward requests and responses between the caller and an upstream service. The asynchronous APIs in this suite enable tasks like Conversation Summarization and Conversational PII detection.", + "version": "2023-11-15-preview" + }, + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + } + }, + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://cognitiveservices.azure.com/.default" + ] + }, + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/:analyze-conversations": { + "post": { + "operationId": "ConversationAnalysis_AnalyzeConversation", + "description": "Analyzes the input conversation utterance.", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "A single conversational task to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeConversationTask" + }, + "required": true + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The conversation analysis response.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + }, + "headers": { + "x-ms-error-code": { + "description": "The error code for specific error that occurred.", + "type": "string" + } + } + } + }, + "x-ms-examples": { + "Conversation project result": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversations.json" + }, + "Arbitration result": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitration.json" + }, + "Orchestrator direct target result": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json" + } + } + } + }, + "/analyze-conversations/jobs": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "description": "Submit a collection of conversations for analysis. Specify one or more unique tasks to be executed.", + "operationId": "AnalyzeConversation_SubmitJob", + "summary": "Submit analysis job for conversations", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "The collection of conversations to analyze and one or more tasks to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeConversationJobsInput" + }, + "required": true + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Conversational PII Analysis Job Request": { + "$ref": "./examples/conversations/SuccessfulConversationPIISubmit.json" + }, + "Successful Conversational PII Analysis Exclusion Job Request": { + "$ref": "./examples/conversations/SuccessfulConversationPIIExclusionSubmit.json" + }, + "Successful Conversational PII Analysis Redaction Job Request": { + "$ref": "./examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json" + }, + "Successful Conversation Summarization Analysis Job Request": { + "$ref": "./examples/conversations/SuccessfulConversationSummarySubmit.json" + }, + "Successful Conversation Summarization Task Submit": { + "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json" + }, + "Successful Custom Conversation Summarization Task Submit": { + "$ref": "./examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json" + }, + "Successful Conversation Sentiment Analysis Job Request": { + "$ref": "./examples/conversations/SuccessfulConversationSentimentSubmit.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-conversations/jobs/{jobId}": { + "get": { + "produces": [ + "application/json" + ], + "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", + "operationId": "AnalyzeConversation_JobStatus", + "summary": "Get analysis status and results", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/JobId" + }, + { + "$ref": "common.json#/parameters/ShowStats" + } + ], + "responses": { + "200": { + "description": "Analysis job status and metadata.", + "schema": { + "$ref": "#/definitions/AnalyzeConversationJobState" + } + }, + "default": { + "description": "Error encountered.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Conversation PII Analysis Job Status Request": { + "$ref": "./examples/conversations/SuccessfulConversationPIITaskStatusRequest.json" + }, + "Successful Get Text Conversation Analysis Exclusion Job Status Request": { + "$ref": "./examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json" + }, + "Successful Get Text Conversation Analysis Redaction Job Status Request": { + "$ref": "./examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json" + }, + "Successful Get Text Conversation Analysis Job Status Request": { + "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json" + }, + "Successful Get Conversation Sentiment Analysis Job Status Request": { + "$ref": "./examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json" + }, + "Successful Get Conversation Summarization Result": { + "$ref": "./examples/conversations/SuccessfulConversationSummarizationTaskResult.json" + }, + "Successful Get Custom Conversation Summarization Result": { + "$ref": "./examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json" + } + } + } + }, + "/analyze-conversations/jobs/{jobId}:cancel": { + "post": { + "produces": [ + "application/json" + ], + "description": "Cancel a long-running Text Analysis conversations job.", + "operationId": "AnalyzeConversation_CancelJob", + "summary": "Cancel a long-running Text Analysis conversations job", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/JobId" + } + ], + "responses": { + "202": { + "description": "Cancel Job request has been received.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Job Delete Request": { + "$ref": "./examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AnalyzeConversationTaskKind": { + "type": "string", + "description": "Enumeration of supported Conversation tasks.", + "enum": [ + "Conversation" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskKind", + "modelAsString": true + } + }, + "AnalyzeConversationTaskResultsKind": { + "type": "string", + "description": "Enumeration of supported conversational task results", + "enum": [ + "ConversationResult" + ], + "x-ms-enum": { + "name": "AnalyzeConversationTaskResultsKind", + "modelAsString": true + } + }, + "AnalyzeConversationTask": { + "type": "object", + "description": "The base class of a conversation input task.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskKind" + } + } + }, + "AnalyzeConversationTaskResult": { + "type": "object", + "description": "The base class of a conversation task result.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationTaskResultsKind" + } + } + }, + "ConversationalTask": { + "type": "object", + "description": "The input for a custom conversation task.", + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTask" + } + ], + "properties": { + "analysisInput": { + "$ref": "#/definitions/ConversationAnalysisOptions" + }, + "parameters": { + "$ref": "#/definitions/ConversationTaskParameters" + } + }, + "x-ms-discriminator-value": "Conversation", + "required": [ + "analysisInput", + "parameters" + ] + }, + "ConversationTaskParameters": { + "type": "object", + "description": "Input parameters necessary for a Conversation task.", + "properties": { + "projectName": { + "type": "string", + "description": "The name of the project to use." + }, + "deploymentName": { + "type": "string", + "description": "The name of the deployment to use." + }, + "verbose": { + "type": "boolean", + "description": "If true, the service will return more detailed information in the response." + }, + "isLoggingEnabled": { + "type": "boolean", + "description": "If true, the service will keep the query for further review." + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + }, + "directTarget": { + "type": "string", + "description": "The name of a target project to forward the request to." + }, + "targetProjectParameters": { + "type": "object", + "description": "A dictionary representing the parameters for each target project.", + "additionalProperties": { + "$ref": "#/definitions/AnalysisParameters" + } + } + }, + "required": [ + "projectName", + "deploymentName" + ] + }, + "ConversationalTaskResult": { + "description": "The results of a Conversation task.", + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationTaskResult" + } + ], + "type": "object", + "properties": { + "result": { + "$ref": "#/definitions/AnalyzeConversationResult" + } + }, + "required": [ + "result" + ], + "x-ms-discriminator-value": "ConversationResult" + }, + "ConversationItemBase": { + "type": "object", + "description": "The abstract base for a user input formatted conversation (e.g., Text, Transcript).", + "properties": { + "id": { + "description": "The ID of a conversation item.", + "type": "string" + }, + "participantId": { + "description": "The participant ID of a conversation item.", + "type": "string" + }, + "language": { + "description": "The override language of a conversation item in BCP 47 language representation.", + "type": "string" + }, + "modality": { + "$ref": "#/definitions/Modality" + }, + "role": { + "type": "string", + "description": "The role of the participant.", + "enum": [ + "agent", + "customer", + "generic" + ], + "x-ms-enum": { + "name": "role", + "modelAsString": true + } + } + }, + "required": [ + "participantId", + "id" + ], + "additionalProperties": true + }, + "TextConversationItem": { + "type": "object", + "description": "The text modality of an input conversation.", + "allOf": [ + { + "$ref": "#/definitions/ConversationItemBase" + } + ], + "properties": { + "text": { + "description": "The text input", + "type": "string" + } + }, + "required": [ + "text" + ] + }, + "ConversationAnalysisOptions": { + "type": "object", + "description": "The input ConversationItem and its optional parameters", + "required": [ + "conversationItem" + ], + "properties": { + "conversationItem": { + "$ref": "#/definitions/ConversationItemBase" + } + } + }, + "AnalysisParameters": { + "type": "object", + "description": "This is the parameter set of either the Orchestration project itself or one of the target services.", + "required": [ + "targetProjectKind" + ], + "discriminator": "targetProjectKind", + "properties": { + "targetProjectKind": { + "type": "string", + "description": "The type of a target service.", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering", + "NonLinked" + ], + "x-ms-enum": { + "name": "targetProjectKind", + "modelAsString": true + } + }, + "apiVersion": { + "type": "string", + "description": "The API version to use when call a specific target service." + } + } + }, + "NoneLinkedTargetIntentResult": { + "type": "object", + "description": "A wrap up of non-linked intent response.", + "x-ms-discriminator-value": "NonLinked", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + } + }, + "LuisParameters": { + "description": "This is a set of request parameters for LUIS Generally Available projects.", + "x-ms-discriminator-value": "Luis", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "properties": { + "query": { + "type": "string", + "maxLength": 500, + "description": "The utterance to predict." + }, + "callingOptions": { + "type": "object", + "description": "This customizes how the service calls LUIS Generally Available projects.", + "$ref": "#/definitions/LuisCallingOptions" + } + }, + "additionalProperties": true + }, + "LuisCallingOptions": { + "description": "This customizes how the service calls LUIS Generally Available projects.", + "type": "object", + "properties": { + "verbose": { + "description": "Enable verbose response.", + "type": "boolean" + }, + "log": { + "description": "Save log to add in training utterances later.", + "type": "boolean" + }, + "show-all-intents": { + "description": "Set true to show all intents.", + "type": "boolean" + }, + "timezoneOffset": { + "type": "number", + "description": "The timezone offset for the location of the request." + }, + "spellCheck": { + "type": "boolean", + "description": "Enable spell checking." + }, + "bing-spell-check-subscription-key": { + "description": "The subscription key to use when enabling Bing spell check", + "type": "string" + } + } + }, + "ConversationParameters": { + "type": "object", + "description": "This is a set of request parameters for Customized Conversation projects.", + "x-ms-discriminator-value": "Conversation", + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "properties": { + "callingOptions": { + "type": "object", + "$ref": "#/definitions/ConversationCallingOptions" + } + } + }, + "ConversationCallingOptions": { + "type": "object", + "description": "The option to set to call a Conversation project.", + "properties": { + "language": { + "description": "The language of the query in BCP 47 language representation..", + "type": "string" + }, + "verbose": { + "description": "If true, the service will return more detailed information.", + "type": "boolean" + }, + "isLoggingEnabled": { + "description": "If true, the query will be saved for customers to further review in authoring, to improve the model quality.", + "type": "boolean" + } + } + }, + "QuestionAnsweringParameters": { + "type": "object", + "description": "This is a set of request parameters for Question Answering knowledge bases.", + "x-ms-discriminator-value": "QuestionAnswering", + "allOf": [ + { + "$ref": "#/definitions/AnalysisParameters" + } + ], + "properties": { + "callingOptions": { + "description": "The options sent to a Question Answering KB.", + "$ref": "common.json#/definitions/AnswersOptions" + } + } + }, + "AnalyzeConversationResult": { + "type": "object", + "description": "Represents a conversation analysis response.", + "required": [ + "query", + "prediction" + ], + "properties": { + "query": { + "type": "string", + "description": "The conversation utterance given by the caller." + }, + "detectedLanguage": { + "type": "string", + "description": "The system detected language for the query in BCP 47 language representation.." + }, + "prediction": { + "description": "The prediction result of a conversation project.", + "$ref": "#/definitions/BasePrediction" + } + } + }, + "BasePrediction": { + "type": "object", + "description": "This is the base class of prediction", + "required": [ + "projectKind" + ], + "discriminator": "projectKind", + "properties": { + "projectKind": { + "type": "string", + "description": "The type of the project.", + "enum": [ + "Conversation", + "Orchestration" + ], + "x-ms-enum": { + "name": "projectKind", + "modelAsString": true + } + }, + "topIntent": { + "type": "string", + "description": "The intent with the highest score." + } + } + }, + "OrchestrationPrediction": { + "type": "object", + "description": "This represents the prediction result of an Orchestration project.", + "x-ms-discriminator-value": "Orchestration", + "required": [ + "intents" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "properties": { + "intents": { + "description": "A dictionary that contains all intents. A key is an intent name and a value is its confidence score and target type. The top intent's value also contains the actual response from the target project.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TargetIntentResult" + } + } + } + }, + "TargetIntentResult": { + "type": "object", + "description": "This is the base class of an intent prediction", + "discriminator": "targetProjectKind", + "required": [ + "confidenceScore", + "targetProjectKind" + ], + "properties": { + "targetProjectKind": { + "type": "string", + "description": "This discriminator property specifies the type of the target project that returns the response.", + "enum": [ + "Luis", + "Conversation", + "QuestionAnswering", + "NonLinked" + ], + "x-ms-enum": { + "name": "targetProjectKind", + "modelAsString": true + } + }, + "apiVersion": { + "type": "string", + "description": "The API version used to call a target service." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidence", + "description": "The prediction score and it ranges from 0.0 to 1.0.", + "minimum": 0, + "maximum": 1 + } + } + }, + "ConversationTargetIntentResult": { + "type": "object", + "description": "A wrap up of Conversation project response.", + "x-ms-discriminator-value": "Conversation", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "type": "object", + "$ref": "#/definitions/ConversationResult", + "description": "The actual response from a Conversation project." + } + } + }, + "ConversationResult": { + "type": "object", + "description": "The response returned by a Conversation project.", + "required": [ + "query" + ], + "properties": { + "query": { + "description": "The same query given in request.", + "type": "string" + }, + "detectedLanguage": { + "description": "The detected language from the query in BCP 47 language representation..", + "type": "string" + }, + "prediction": { + "description": "The predicted result for the query.", + "$ref": "#/definitions/ConversationPrediction" + } + } + }, + "ConversationPrediction": { + "type": "object", + "description": "Represents the prediction section of a Conversation project.", + "x-ms-discriminator-value": "Conversation", + "required": [ + "intents", + "entities" + ], + "allOf": [ + { + "$ref": "#/definitions/BasePrediction" + } + ], + "properties": { + "intents": { + "description": "The intent classification results.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationIntent" + } + }, + "entities": { + "description": "The entity extraction results.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationEntity" + } + } + } + }, + "ConversationIntent": { + "type": "object", + "description": "The intent classification result of a Conversation project.", + "required": [ + "category", + "confidenceScore" + ], + "properties": { + "category": { + "description": "A predicted class.", + "type": "string" + }, + "confidenceScore": { + "format": "float", + "x-ms-client-name": "confidence", + "description": "The confidence score of the class from 0.0 to 1.0.", + "type": "number", + "minimum": 0, + "maximum": 1 + } + } + }, + "ConversationEntity": { + "type": "object", + "description": "The entity extraction result of a Conversation project.", + "required": [ + "category", + "text", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "category": { + "description": "The entity category.", + "type": "string" + }, + "text": { + "description": "The predicted entity text.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "The starting index of this entity in the query.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "The length of the text.", + "type": "integer" + }, + "confidenceScore": { + "format": "float", + "x-ms-client-name": "confidence", + "description": "The entity confidence score.", + "type": "number" + }, + "resolutions": { + "description": "The collection of entity resolution objects.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseResolution" + } + }, + "extraInformation": { + "description": "The collection of entity extra information objects.", + "type": "array", + "items": { + "$ref": "#/definitions/BaseExtraInformation" + } + } + } + }, + "BaseResolution": { + "description": "The abstract base class for entity resolutions.", + "type": "object", + "discriminator": "resolutionKind", + "properties": { + "resolutionKind": { + "description": "The entity resolution object kind.", + "type": "string", + "enum": [ + "BooleanResolution", + "DateTimeResolution", + "NumberResolution", + "OrdinalResolution", + "SpeedResolution", + "WeightResolution", + "LengthResolution", + "VolumeResolution", + "AreaResolution", + "AgeResolution", + "InformationResolution", + "TemperatureResolution", + "CurrencyResolution", + "NumericRangeResolution", + "TemporalSpanResolution" + ], + "x-ms-enum": { + "name": "ResolutionKind", + "modelAsString": true + } + } + }, + "required": [ + "resolutionKind" + ] + }, + "QuantityResolution": { + "description": "Represents resolutions for quantities.", + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + } + }, + "required": [ + "value" + ] + }, + "AgeResolution": { + "description": "Represents the Age entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "AgeResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true + }, + "description": "The Age Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "VolumeResolution": { + "description": "Represents the volume entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "VolumeResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true + }, + "description": "The Volume Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "SpeedResolution": { + "description": "Represents the speed entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "SpeedResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knot", + "FootPerSecond", + "FootPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true + }, + "description": "The speed Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "AreaResolution": { + "description": "Represents the area entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "AreaResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true + }, + "description": "The area Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "LengthResolution": { + "description": "Represents the length entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "LengthResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Pt" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true + }, + "description": "The length Unit of measurement" + } + }, + "required": [ + "unit" + ] + }, + "InformationResolution": { + "description": "Represents the information (data) entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "InformationResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true + }, + "description": "The information (data) Unit of measurement." + } + }, + "required": [ + "unit" + ] + }, + "TemperatureResolution": { + "description": "Represents the temperature entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "TemperatureResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true + }, + "description": "The temperature Unit of measurement." + } + }, + "required": [ + "unit" + ] + }, + "WeightResolution": { + "description": "Represents the weight entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "WeightResolution", + "properties": { + "unit": { + "type": "string", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true + }, + "description": "The weight Unit of measurement." + } + }, + "required": [ + "unit" + ] + }, + "CurrencyResolution": { + "description": "Represents the currency entity resolution model.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + }, + { + "$ref": "#/definitions/QuantityResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "CurrencyResolution", + "properties": { + "ISO4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." + }, + "value": { + "type": "number", + "format": "double", + "description": "The money amount captured in the extracted entity" + }, + "unit": { + "type": "string", + "description": "The unit of the amount captured in the extracted entity" + } + }, + "required": [ + "value", + "unit" + ] + }, + "BooleanResolution": { + "description": "A resolution for boolean expressions", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "BooleanResolution", + "properties": { + "value": { + "type": "boolean" + } + }, + "required": [ + "value" + ] + }, + "DateTimeResolution": { + "description": "A resolution for datetime entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "DateTimeResolution", + "properties": { + "timex": { + "$ref": "#/definitions/TimeExpression" + }, + "dateTimeSubKind": { + "type": "string", + "enum": [ + "Time", + "Date", + "DateTime", + "Duration", + "Set" + ], + "x-ms-enum": { + "name": "DateTimeSubKind", + "modelAsString": true + }, + "description": "The DateTime SubKind" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier" + } + }, + "required": [ + "timex", + "dateTimeSubKind", + "value" + ] + }, + "NumberResolution": { + "description": "A resolution for numeric entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "NumberResolution", + "properties": { + "numberKind": { + "type": "string", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true + }, + "description": "The type of the extracted number entity." + }, + "value": { + "type": "number", + "format": "double", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ] + }, + "OrdinalResolution": { + "description": "A resolution for ordinal numbers entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "OrdinalResolution", + "properties": { + "offset": { + "type": "string", + "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" + }, + "relativeTo": { + "type": "string", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true + }, + "description": "The reference point that the ordinal number denotes." + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ] + }, + "TemporalSpanResolution": { + "description": "represents the resolution of a date and/or time span.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "TemporalSpanResolution", + "properties": { + "begin": { + "$ref": "#/definitions/TimeExpression" + }, + "end": { + "$ref": "#/definitions/TimeExpression" + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier" + }, + "timex": { + "type": "string", + "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." + } + } + }, + "NumericRangeResolution": { + "description": "represents the resolution of numeric intervals.", + "allOf": [ + { + "$ref": "#/definitions/BaseResolution" + } + ], + "type": "object", + "x-ms-discriminator-value": "NumericRangeResolution", + "properties": { + "rangeKind": { + "type": "string", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true + }, + "description": "The kind of range that the resolution object represents." + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ] + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true + } + }, + "TimeExpression": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "BaseExtraInformation": { + "description": "The abstract base object for entity extra information.", + "type": "object", + "discriminator": "extraInformationKind", + "properties": { + "extraInformationKind": { + "description": "The extra information object kind.", + "type": "string", + "enum": [ + "EntitySubtype", + "ListKey", + "RegexKey" + ], + "x-ms-enum": { + "name": "ExtraInformationKind", + "modelAsString": true + } + } + }, + "required": [ + "extraInformationKind" + ] + }, + "EntitySubtype": { + "description": "The concrete entity Subtype model of extra information.", + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "EntitySubtype", + "properties": { + "value": { + "type": "string", + "description": "The Subtype of an extracted entity type." + } + } + }, + "ListKey": { + "description": "The list key extra data kind.", + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "ListKey", + "properties": { + "key": { + "type": "string", + "description": "The canonical form of the extracted entity." + } + } + }, + "RegexKey": { + "description": "The regex key extra data kind.", + "allOf": [ + { + "$ref": "#/definitions/BaseExtraInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "RegexKey", + "properties": { + "key": { + "type": "string", + "description": "The key of the regex pattern used in extracting the entity." + }, + "regexPattern": { + "type": "string", + "description": "The .NET regex pattern used in extracting the entity. Please visit https://docs.microsoft.com/dotnet/standard/base-types/regular-expressions for more information about .NET regular expressions." + } + } + }, + "LuisTargetIntentResult": { + "type": "object", + "description": "It is a wrap up of LUIS Generally Available response.", + "x-ms-discriminator-value": "Luis", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "type": "object", + "description": "The actual response from a LUIS Generally Available application." + } + } + }, + "QuestionAnsweringTargetIntentResult": { + "type": "object", + "description": "It is a wrap up a Question Answering KB response.", + "x-ms-discriminator-value": "QuestionAnswering", + "allOf": [ + { + "$ref": "#/definitions/TargetIntentResult" + } + ], + "properties": { + "result": { + "description": "The generated answer by a Question Answering KB.", + "$ref": "common.json#/definitions/AnswersResult" + } + } + }, + "AnalyzeConversationJobsInput": { + "type": "object", + "properties": { + "displayName": { + "description": "Optional display name for the analysis job.", + "type": "string" + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageConversationAnalysisInput" + }, + "tasks": { + "description": "The set of tasks to execute on the input conversation.", + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "AnalyzeConversationLROTask": { + "type": "object", + "description": "The base class for an long running conversation input task.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationLROTaskKind" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/TaskIdentifier" + } + ] + }, + "AnalyzeConversationLROTaskKind": { + "type": "string", + "description": "Enumeration of supported analysis tasks on a collection of conversation.", + "enum": [ + "ConversationalPIITask", + "ConversationalSummarizationTask", + "CustomConversationalSummarizationTask", + "ConversationalSentimentTask" + ], + "x-ms-enum": { + "name": "AnalyzeConversationLROTaskKind", + "modelAsString": true + } + }, + "AnalyzeConversationResultsKind": { + "type": "string", + "description": "Enumeration of supported Conversation Analysis task results.", + "enum": [ + "ConversationalPIIResults", + "ConversationalSummarizationResults", + "CustomConversationalSummarizationResults", + "ConversationalSentimentResults" + ], + "x-ms-enum": { + "name": "AnalyzeConversationResultsKind", + "modelAsString": true + } + }, + "AnalyzeConversationPIITask": { + "type": "object", + "description": "Task definition for a PII redaction in conversations.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationPIITaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalPIITask" + }, + "ConversationPIIItemResult": { + "type": "object", + "required": [ + "id", + "redactedContent", + "entities" + ], + "properties": { + "id": { + "type": "string" + }, + "redactedContent": { + "type": "object", + "$ref": "#/definitions/RedactedTranscriptContent" + }, + "entities": { + "type": "array", + "items": { + "$ref": "#/definitions/Entity" + } + } + } + }, + "MultiLanguageConversationAnalysisInput": { + "type": "object", + "required": [ + "conversations" + ], + "properties": { + "conversations": { + "type": "array", + "items": { + "$ref": "#/definitions/Conversation" + } + } + } + }, + "Conversation": { + "type": "object", + "description": "A complete ordered set of utterances (spoken or written), by one or more speakers to be used for analysis.", + "discriminator": "modality", + "required": [ + "id", + "language", + "modality" + ], + "properties": { + "id": { + "description": "Unique identifier for the conversation.", + "type": "string" + }, + "language": { + "description": "The language of the conversation item in BCP-47 format.", + "type": "string" + }, + "modality": { + "$ref": "#/definitions/Modality" + }, + "domain": { + "$ref": "#/definitions/ConversationDomain" + } + } + }, + "Modality": { + "type": "string", + "description": "Enumeration of supported conversational modalities.", + "enum": [ + "transcript", + "text" + ], + "x-ms-enum": { + "name": "InputModality", + "modelAsString": true + } + }, + "ConversationDomain": { + "type": "string", + "description": "Enumeration of supported conversational domains.", + "enum": [ + "finance", + "healthcare", + "generic" + ], + "x-ms-enum": { + "name": "ConversationDomain", + "modelAsString": true + } + }, + "TextConversation": { + "type": "object", + "x-ms-discriminator-value": "text", + "required": [ + "conversationItems" + ], + "allOf": [ + { + "$ref": "#/definitions/Conversation" + } + ], + "properties": { + "conversationItems": { + "description": "Ordered list of text conversation items in the conversation.", + "type": "array", + "items": { + "$ref": "#/definitions/TextConversationItem" + } + } + } + }, + "TranscriptConversation": { + "type": "object", + "x-ms-discriminator-value": "transcript", + "required": [ + "conversationItems" + ], + "allOf": [ + { + "$ref": "#/definitions/Conversation" + } + ], + "properties": { + "conversationItems": { + "description": "Ordered list of transcript conversation items in the conversation.", + "type": "array", + "items": { + "$ref": "#/definitions/TranscriptConversationItem" + } + } + } + }, + "TranscriptConversationItem": { + "type": "object", + "description": "Additional properties for supporting transcript conversation.", + "required": [ + "text", + "lexical", + "itn", + "maskedItn" + ], + "allOf": [ + { + "$ref": "#/definitions/ConversationItemBase" + } + ], + "properties": { + "itn": { + "type": "string", + "description": "Inverse Text Normalization representation of input. The inverse-text-normalized form is the recognized text from Microsoft's Speech to Text API, with phone numbers, numbers, abbreviations, and other transformations applied." + }, + "maskedItn": { + "type": "string", + "description": "The Inverse Text Normalized format with profanity masking applied." + }, + "text": { + "type": "string", + "description": "The display form of the recognized text from speech to text API, with punctuation and capitalization added." + }, + "lexical": { + "type": "string", + "description": "The lexical form of the recognized text from speech to text API with the actual words recognized." + }, + "wordLevelTimings": { + "type": "array", + "description": "The list of word level audio timing information", + "items": { + "$ref": "#/definitions/WordLevelTiming" + } + }, + "conversationItemLevelTiming": { + "description": "Conversation item level audio timing. This still can help on AI quality if word level audio timings are not available.", + "$ref": "#/definitions/ConversationItemLevelTiming" + } + } + }, + "RedactedTranscriptContent": { + "type": "object", + "description": "The transcript content response generated by the service with all necessary personally identifiable information redacted.", + "properties": { + "itn": { + "type": "string", + "description": "The redacted output for inverse text normalized format input." + }, + "maskedItn": { + "type": "string", + "description": "The redacted output for masked inverse text normalized format input." + }, + "text": { + "type": "string", + "description": "The redacted output for text (Microsoft's Speech to Text 'display') format input." + }, + "lexical": { + "type": "string", + "description": "The redacted output for lexical format input." + }, + "audioTimings": { + "type": "array", + "description": "The list of redacted audio segments.", + "items": { + "$ref": "#/definitions/AudioTiming" + } + } + } + }, + "WordLevelTiming": { + "type": "object", + "description": "Word level timing information generated by the speech to text API. The words in this object should have 1:1 correspondence with the 'lexical' input to allow for audio redaction.", + "properties": { + "word": { + "type": "string", + "description": "The word recognized." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AudioTiming" + } + ] + }, + "AudioTiming": { + "type": "object", + "description": "The audio timing information.", + "properties": { + "offset": { + "description": "Offset from start of speech audio, in ticks. 1 tick = 100 ns.", + "type": "integer", + "format": "int64" + }, + "duration": { + "description": "Duration of word articulation, in ticks. 1 tick = 100 ns.", + "type": "integer", + "format": "int64" + } + } + }, + "Entity": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "AnalyzeConversationConversationPIIResult": { + "type": "object", + "description": "Result from the personally identifiable information detection and redaction operation performed on a list of conversations.", + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "properties": { + "results": { + "$ref": "#/definitions/ConversationPIIResults" + } + }, + "required": [ + "results" + ], + "x-ms-discriminator-value": "ConversationalPIIResults" + }, + "ConversationPIIResults": { + "type": "object", + "description": "The result from PII detection and redaction operation for each conversation.", + "required": [ + "conversations" + ], + "properties": { + "conversations": { + "type": "array", + "items": { + "$ref": "#/definitions/ConversationalPIIResultWithResultBase" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ] + }, + "ConversationalPIIResultWithResultBase": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ConversationPIIResult" + }, + { + "$ref": "#/definitions/ConversationResultBase" + } + ] + }, + "ConversationPIIResult": { + "type": "object", + "description": "The result from PII detection and redaction operation for each conversation.", + "required": [ + "conversationItems" + ], + "properties": { + "conversationItems": { + "description": "Enumeration of PII detection and redaction operation results for all the conversation items in a conversation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationPIIItemResult" + } + } + } + }, + "ConversationPIITaskParameters": { + "type": "object", + "description": "Supported parameters for a Conversational PII detection and redaction task.", + "properties": { + "piiCategories": { + "$ref": "#/definitions/ConversationPIICategories" + }, + "redactAudioTiming": { + "type": "boolean", + "description": "Flag to indicate if response should include audio stream offset and duration for any detected entities to be redacted. By default, audio timing of redacted entities are not included.", + "default": false + }, + "redactionSource": { + "type": "string", + "description": "For transcript conversations, this parameter provides information regarding which content type (ITN, Text, Lexical, Masked ITN) should be used for entity detection. The details of the entities detected - like the offset, length and the text itself - will correspond to the text type selected here.", + "$ref": "#/definitions/TranscriptContentType" + }, + "redactionCharacter": { + "$ref": "common.json#/definitions/RedactionCharacter" + }, + "excludePiiCategories": { + "description": "List of categories that need to be excluded instead of included.", + "$ref": "#/definitions/ConversationPIICategoriesExclude" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "ConversationPIICategories": { + "description": "Describes the PII categories to return for detection. If not provided, 'default' categories will be returned which will vary with the language.", + "items": { + "type": "string", + "x-ms-enum": { + "name": "ConversationPIICategory", + "modelAsString": true + }, + "enum": [ + "Address", + "CreditCardNumber", + "Email", + "Person", + "NumericIdentifier", + "PhoneNumber", + "USSocialSecurityNumber", + "Miscellaneous", + "All", + "Default" + ] + }, + "type": "array", + "uniqueItems": true + }, + "ConversationPIICategoriesExclude": { + "description": "Describes the PII categories to exclude for detection. If not provided, 'default' categories will be returned which will vary with the language.", + "items": { + "type": "string", + "x-ms-enum": { + "name": "ConversationPIICategoriesExclude", + "modelAsString": true + }, + "enum": [ + "Address", + "CreditCardNumber", + "Email", + "Person", + "NumericIdentifier", + "PhoneNumber", + "USSocialSecurityNumber" + ] + }, + "type": "array", + "uniqueItems": true + }, + "TranscriptContentType": { + "type": "string", + "description": "Enumeration of supported transcript content types.", + "enum": [ + "lexical", + "itn", + "maskedItn", + "text" + ], + "x-ms-enum": { + "name": "TranscriptContentType", + "modelAsString": true + } + }, + "AnalyzeConversationSummarizationTask": { + "type": "object", + "description": "Task definition for conversational summarization.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationSummarizationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalSummarizationTask" + }, + "AnalyzeCustomConversationSummarizationTask": { + "type": "object", + "description": "Task definition for custom conversational summarization.", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomConversationSummarizationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "CustomConversationalSummarizationTask" + }, + "ConversationSummarizationTaskParametersBase": { + "type": "object", + "description": "Supported parameters for any conversational summarization task.", + "required": [ + "summaryAspects" + ], + "properties": { + "summaryAspects": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "issue", + "resolution", + "chapterTitle", + "narrative", + "recap", + "follow-up tasks" + ], + "x-ms-enum": { + "name": "SummaryAspect", + "modelAsString": true, + "values": [ + { + "value": "issue", + "description": "A summary of issues in transcripts of web chats and service call transcripts between customer-service agents, and your customers." + }, + { + "value": "resolution", + "description": "A summary of resolutions in transcripts of web chats and service call transcripts between customer-service agents, and your customers." + }, + { + "value": "chapterTitle", + "description": "A chapter title of any conversation. It is usually one phrase or several phrases naturally combined together. Long conversation tends to have more chapters. The chapter boundary can be found from the summary context." + }, + { + "value": "narrative", + "description": "A generic narrative summary of any conversation. It generally converts the conversational language into formal written language, compresses the text length and keeps the salient information." + }, + { + "value": "recap", + "description": "A concise one-paragraph summary to provide a quick overview." + }, + { + "value": "follow-up tasks", + "description": "Action items and tasks that arose during a meeting. " + } + ] + } + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" + } + ] + }, + "ConversationSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for pre-build conversational summarization task.", + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + }, + { + "$ref": "#/definitions/ConversationSummarizationTaskParametersBase" + } + ] + }, + "CustomConversationSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for a custom conversation summarization task.", + "allOf": [ + { + "$ref": "common.json#/definitions/CustomTaskParameters" + }, + { + "$ref": "#/definitions/ConversationSummarizationTaskParametersBase" + } + ] + }, + "AnalyzeConversationSummarizationResult": { + "type": "object", + "description": "Result for the summarization task on the conversation.", + "properties": { + "results": { + "$ref": "#/definitions/SummaryResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "ConversationalSummarizationResults" + }, + "AnalyzeCustomConversationSummarizationResult": { + "type": "object", + "description": "Result for the custom summarization task on the conversation.", + "properties": { + "results": { + "$ref": "#/definitions/CustomSummaryResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomConversationalSummarizationResults" + }, + "SummaryResultBase": { + "type": "object", + "required": [ + "conversations" + ], + "properties": { + "conversations": { + "type": "array", + "items": { + "$ref": "#/definitions/ConversationsSummaryResult" + } + } + } + }, + "SummaryResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SummaryResultBase" + }, + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ] + }, + "CustomSummaryResult": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SummaryResultBase" + }, + { + "$ref": "common.json#/definitions/CustomResult" + } + ] + }, + "ConversationsSummaryResult": { + "type": "object", + "required": [ + "summaries" + ], + "properties": { + "summaries": { + "type": "array", + "items": { + "$ref": "#/definitions/SummaryResultItem" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConversationResultBase" + } + ] + }, + "SummaryResultItem": { + "type": "object", + "properties": { + "aspect": { + "type": "string" + }, + "text": { + "type": "string" + }, + "contexts": { + "type": "array", + "description": "The context list of the summary.", + "items": { + "$ref": "#/definitions/ItemizedSummaryContext" + } + } + }, + "required": [ + "aspect", + "text" + ] + }, + "AnalyzeConversationalSentimentTask": { + "type": "object", + "description": "Task definition for a sentiment analysis in conversations.", + "properties": { + "parameters": { + "$ref": "#/definitions/ConversationalSentimentTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationLROTask" + } + ], + "x-ms-discriminator-value": "ConversationalSentimentTask" + }, + "ConversationalSentimentTaskParameters": { + "type": "object", + "description": "Supported parameters for a Conversational sentiment analysis task.", + "properties": { + "predictionSource": { + "type": "string", + "description": "For transcript conversations, this parameter provides information regarding which content type should be used for sentiment analysis. The details of the sentiment analysis - like the offset, length and the text itself - will correspond to the text type selected here.", + "$ref": "#/definitions/TranscriptContentType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "AnalyzeConversationSentimentResult": { + "type": "object", + "description": "Result from the sentiment analysis operation performed on a list of conversations.", + "allOf": [ + { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + ], + "properties": { + "results": { + "$ref": "#/definitions/ConversationSentimentResults" + } + }, + "required": [ + "results" + ], + "x-ms-discriminator-value": "ConversationalSentimentResults" + }, + "ConversationSentimentResults": { + "type": "object", + "description": "The result from sentiment analysis operation for each conversation.", + "required": [ + "conversations" + ], + "properties": { + "conversations": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/definitions/ConversationSentimentResult" + }, + { + "$ref": "#/definitions/ConversationResultBase" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ] + }, + "ConversationSentimentResult": { + "type": "object", + "description": "The result from sentiment analysis operation for each conversation item.", + "required": [ + "conversationItems" + ], + "properties": { + "conversationItems": { + "description": "Enumeration of Sentiment operation results for all the conversation items in a conversation.", + "type": "array", + "items": { + "$ref": "#/definitions/ConversationSentimentItemResult" + } + } + } + }, + "ConversationSentimentItemResult": { + "type": "object", + "required": [ + "id", + "participantId", + "sentiment", + "confidenceScores" + ], + "properties": { + "id": { + "description": "The identifier for the conversation item", + "type": "string" + }, + "participantId": { + "description": "The identifier for the speaker", + "type": "string" + }, + "sentiment": { + "$ref": "common.json#/definitions/Sentiment" + }, + "confidenceScores": { + "type": "object", + "$ref": "common.json#/definitions/SentimentConfidenceScores" + } + } + }, + "AnalyzeConversationJobState": { + "description": "Contains the status of the analyze conversations job submitted along with related statistics.", + "allOf": [ + { + "$ref": "common.json#/definitions/JobState" + }, + { + "$ref": "#/definitions/ConversationTasksState" + }, + { + "$ref": "#/definitions/AnalyzeConversationJobStatistics" + } + ] + }, + "AnalyzeConversationJobStatistics": { + "description": "Contains the statistics for the job submitted.", + "properties": { + "statistics": { + "$ref": "#/definitions/ConversationRequestStatistics" + } + }, + "type": "object" + }, + "ConversationTasksState": { + "description": "Contains the state for the tasks being executed as part of the analyze conversation job submitted.", + "properties": { + "tasks": { + "properties": { + "completed": { + "description": "Count of tasks completed successfully.", + "type": "integer", + "format": "int32" + }, + "failed": { + "description": "Count of tasks that failed.", + "type": "integer", + "format": "int32" + }, + "inProgress": { + "description": "Count of tasks in progress currently.", + "type": "integer", + "format": "int32" + }, + "total": { + "description": "Total count of tasks submitted as part of the job.", + "type": "integer", + "format": "int32" + }, + "items": { + "description": "List of results from tasks (if available).", + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzeConversationJobResult" + } + } + }, + "required": [ + "total", + "completed", + "failed", + "inProgress" + ], + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "AnalyzeConversationJobResult": { + "type": "object", + "description": "Container for results for all tasks in the conversation job.", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeConversationResultsKind" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/TaskState" + }, + { + "$ref": "common.json#/definitions/TaskIdentifier" + } + ], + "required": [ + "kind" + ] + }, + "ConversationResultBase": { + "type": "object", + "description": "Shared attributes for all conversational task results.", + "required": [ + "id", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty conversation identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "common.json#/definitions/InputWarning" + } + }, + "statistics": { + "$ref": "#/definitions/ConversationStatistics" + } + } + }, + "ConversationStatistics": { + "type": "object", + "description": "If showStats=true was specified in the request this field will contain information about the conversation payload.", + "required": [ + "transactionsCount" + ], + "properties": { + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of text units for the request." + } + } + }, + "ConversationRequestStatistics": { + "type": "object", + "description": "if showStats=true was specified in the request this field will contain information about the request payload.", + "required": [ + "conversationsCount", + "validConversationsCount", + "erroneousConversationsCount" + ], + "properties": { + "conversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of conversations submitted in the request." + }, + "validConversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of conversations documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousConversationsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/RequestStatistics" + } + ] + }, + "ConversationItemLevelTiming": { + "type": "object", + "description": "The conversation item level audio timing.", + "allOf": [ + { + "$ref": "#/definitions/AudioTiming" + } + ] + }, + "ItemizedSummaryContext": { + "type": "object", + "description": "The context of the summary with conversation item id.", + "required": [ + "conversationItemId" + ], + "properties": { + "conversationItemId": { + "type": "string", + "description": "Reference to the id of ConversationItem." + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/SummaryContext" + } + ] + } + }, + "parameters": { + "ConversationAnalysisOptions": { + "name": "ConversationAnalysisOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConversationAnalysisOptions" + }, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext-authoring.json new file mode 100644 index 000000000000..e628c57595ea --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext-authoring.json @@ -0,0 +1,5265 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Analyze Text Authoring", + "version": "2023-11-15-preview", + "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": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + } + }, + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://cognitiveservices.azure.com/.default" + ] + }, + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/authoring/analyze-text/projects": { + "get": { + "description": "Lists the existing projects.", + "operationId": "TextAnalysisAuthoring_ListProjects", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of projects.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Projects": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListProjects.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}": { + "patch": { + "description": "Creates a new project or updates an existing one.", + "operationId": "TextAnalysisAuthoring_CreateProject", + "consumes": [ + "application/merge-patch+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The project parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the updated project, if it already exists.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "201": { + "description": "The metadata of the created project.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Create Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCreateProject.json" + } + } + }, + "get": { + "description": "Gets the details of a project.", + "operationId": "TextAnalysisAuthoring_GetProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metadata of the project.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetProject.json" + } + } + }, + "delete": { + "description": "Deletes a project.", + "operationId": "TextAnalysisAuthoring_DeleteProject", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:authorize-copy": { + "post": { + "description": "Generates a copy project operation authorization to the current target Azure resource.", + "operationId": "TextAnalysisAuthoring_CopyProjectAuthorization", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The copy project authorization info.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCopyAuthorizationOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Payload to send to source resource to initiate project copying.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCopyProjectOptions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Copy Project Authorization": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/:copy": { + "post": { + "description": "Copies an existing project to another Azure resource.", + "operationId": "TextAnalysisAuthoring_CopyProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The copy project info.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCopyProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Copy Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCopyProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:export": { + "post": { + "description": "Triggers a job to export a project's data.", + "operationId": "TextAnalysisAuthoring_Export", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "in": "query", + "name": "assetKind", + "description": "Kind of asset to export.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "in": "query", + "name": "trainedModelLabel", + "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Export Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulExportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:import": { + "post": { + "description": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.", + "operationId": "TextAnalysisAuthoring_Import", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "header", + "name": "format", + "description": "The format of the project to import. The currently supported formats are json and aml formats. If not provided, the default is set to json.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "in": "body", + "name": "body", + "description": "The project data to import.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProject" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Import Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulImportProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/:train": { + "post": { + "description": "Triggers a training job for a project.", + "operationId": "TextAnalysisAuthoring_Train", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Train Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulTrainProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/copy/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing copy project job.", + "operationId": "TextAnalysisAuthoring_GetCopyProjectStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCopyProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Copy Project Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments": { + "get": { + "description": "Lists the deployments belonging to a project.", + "operationId": "TextAnalysisAuthoring_ListDeployments", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all deployments.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Deployments": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/:swap": { + "post": { + "description": "Swaps two existing deployments with each other.", + "operationId": "TextAnalysisAuthoring_SwapDeployments", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The job object to swap two deployments.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringSwapDeploymentsOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Swap Deployments": { + "$ref": "./examples/analyzetext-authoring/SuccessfulSwapDeployments.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}": { + "get": { + "description": "Gets the details of a deployment.", + "operationId": "TextAnalysisAuthoring_GetDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Deployment info.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeployment.json" + } + } + }, + "put": { + "description": "Creates a new deployment or replaces an existing one.", + "operationId": "TextAnalysisAuthoring_DeployProject", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The new deployment info.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringCreateDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Deploy Project": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeployProject.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "description": "Deletes a project deployment.", + "operationId": "TextAnalysisAuthoring_DeleteDeployment", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeployment.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources": { + "post": { + "description": "Deletes a project deployment from the specified assigned resources.", + "operationId": "TextAnalysisAuthoring_DeleteDeploymentFromResources", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The options for deleting the deployment.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeleteDeploymentOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Deployment": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/delete-from-resources/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing delete deployment from specific resources job.", + "operationId": "TextAnalysisAuthoring_GetDeploymentDeleteFromResourcesStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing deployment job.", + "operationId": "TextAnalysisAuthoring_GetDeploymentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The deployment job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Deployment Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing swap deployment job.", + "operationId": "TextAnalysisAuthoring_GetSwapDeploymentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The swap deployment job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Swap Deployments Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "description": "Gets the status of an export job. Once job completes, returns the project metadata, and assets.", + "operationId": "TextAnalysisAuthoring_GetExportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The status of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Export Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/exported-models": { + "get": { + "description": "Lists the exported models belonging to a project.", + "operationId": "TextAnalysisAuthoring_ListExportedModels", + "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 exported models.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Exported Models": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListExportedModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}": { + "get": { + "description": "Gets the details of an exported model.", + "operationId": "TextAnalysisAuthoring_GetExportedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Exported model info", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportedModel.json" + } + } + }, + "delete": { + "description": "Deletes an existing exported model.", + "operationId": "TextAnalysisAuthoring_DeleteExportedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results in triggering the deletion of the exported model.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the deletion job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Exported Model": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json" + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "description": "Creates a new exported model or replaces an existing one.", + "operationId": "TextAnalysisAuthoring_CreateOrUpdateExportedModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The exported model info.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedModelOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Load Snapshot": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCreateExportedModel.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/jobs/{jobId}": { + "get": { + "description": "Gets the status for an existing job to create or update an exported model.", + "operationId": "TextAnalysisAuthoring_GetExportedModelJobStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedModelJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/manifest": { + "get": { + "description": "Gets the details and URL needed to download the exported model.", + "operationId": "TextAnalysisAuthoring_GetExportedModelManifest", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringExportedModelNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The exported model manifest.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedModelManifest" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Exported Model Manifest": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "description": "Gets the status for an import.", + "operationId": "TextAnalysisAuthoring_GetImportStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringImportProjectJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Import Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetImportStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models": { + "get": { + "description": "Lists the trained models belonging to a project.", + "operationId": "TextAnalysisAuthoring_ListTrainedModels", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all trained models.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModels" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Models": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListModels.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}": { + "get": { + "description": "Gets the details of a trained model.", + "operationId": "TextAnalysisAuthoring_GetTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Trained model info", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModel.json" + } + } + }, + "delete": { + "description": "Deletes an existing trained model.", + "operationId": "TextAnalysisAuthoring_DeleteTrainedModel", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "Deleted successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Delete Model": { + "$ref": "./examples/analyzetext-authoring/SuccessfulDeleteModel.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:evaluate": { + "post": { + "description": "Triggers evaluation operation on a trained model.", + "operationId": "TextAnalysisAuthoring_EvaluateModel", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The training input parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Evaluation": { + "$ref": "./examples/analyzetext-authoring/SuccessfulEvaluationProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:load-snapshot": { + "post": { + "description": "Restores the snapshot of this trained model to be the current working directory of the project.", + "operationId": "TextAnalysisAuthoring_LoadSnapshot", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results in loading the working directory with the snapshot of the model provided.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Load Snapshot": { + "$ref": "./examples/analyzetext-authoring/SuccessfulLoadSnapshot.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}": { + "get": { + "description": "Gets the status for an evaluation job.", + "operationId": "TextAnalysisAuthoring_GetEvaluationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The evaluation job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Evaluation Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/result": { + "get": { + "description": "Gets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.", + "operationId": "TextAnalysisAuthoring_GetModelEvaluationResults", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringStringIndexTypeQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the evaluation results.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationResults" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluation/summary-result": { + "get": { + "description": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.", + "operationId": "TextAnalysisAuthoring_GetModelEvaluationSummary", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all evaluation results.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Model Evaluation Summary": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}": { + "get": { + "description": "Gets the status for loading a snapshot.", + "operationId": "TextAnalysisAuthoring_GetLoadSnapshotStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringTrainedModelLabelPathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The details of the long running operation.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringLoadSnapshotJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Load Snapshot Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/resources": { + "get": { + "description": "Lists the deployments resources assigned to the project.", + "operationId": "TextAnalysisAuthoring_ListDeploymentResources", + "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": "The assigned deployment resources.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringAssignedDeploymentResources" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Deployment Resources": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListDeploymentResources.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/resources/:assign": { + "post": { + "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", + "operationId": "TextAnalysisAuthoring_AssignDeploymentResources", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The new project resources info.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringAssignDeploymentResourcesOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Assign Deployment Resources": { + "$ref": "./examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/resources/:unassign": { + "post": { + "description": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them.", + "operationId": "TextAnalysisAuthoring_UnassignDeploymentResources", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "in": "body", + "name": "body", + "description": "The info for the deployment resources to be deleted.", + "required": true, + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringUnassignDeploymentResourcesOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the created job.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Unassign Deployment Resources": { + "$ref": "./examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing assign deployment resources job.", + "operationId": "TextAnalysisAuthoring_GetAssignDeploymentResourcesStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The assign deployment resources job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Assign Deployment Resources Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}": { + "get": { + "description": "Gets the status of an existing unassign deployment resources job.", + "operationId": "TextAnalysisAuthoring_GetUnassignDeploymentResourcesStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The unassign deployment resources job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResourcesJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Unassign Deployment Resources Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/train/jobs": { + "get": { + "description": "Lists the non-expired training jobs created for a project.", + "operationId": "TextAnalysisAuthoring_ListTrainingJobs", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of the training jobs.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobs" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Training Jobs": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListTrainingJobs.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}": { + "get": { + "description": "Gets the status for a training job.", + "operationId": "TextAnalysisAuthoring_GetTrainingStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The training job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Train Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetTrainStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel": { + "post": { + "description": "Triggers a cancellation for a running training job.", + "operationId": "TextAnalysisAuthoring_CancelTrainingJob", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "operation-location": { + "description": "The location of the status API for monitoring the job cancellation.", + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Cancel Training Job": { + "$ref": "./examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/analyze-text/projects/global/deletion-jobs/{jobId}": { + "get": { + "description": "Gets the status for a project deletion job.", + "operationId": "TextAnalysisAuthoring_GetProjectDeletionStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TextAnalysisAuthoringJobIdPathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The project deletion job result.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeletionJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Project Deletion Status": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json" + } + } + } + }, + "/authoring/analyze-text/projects/global/deployments/resources": { + "get": { + "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.", + "operationId": "TextAnalysisAuthoring_ListAssignedResourceDeployments", + "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 assigned deployments metadata for the resource.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringAssignedResourceDeploymentsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful List Assigned Resource Deployments": { + "$ref": "./examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/global/languages": { + "get": { + "description": "Lists the supported languages.", + "operationId": "TextAnalysisAuthoring_GetSupportedLanguages", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryOptionalParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported languages.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguages" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Supported Languages": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/global/prebuilt-entities": { + "get": { + "description": "Lists the supported prebuilt entities that can be used while creating composed entities.", + "operationId": "TextAnalysisAuthoring_GetSupportedPrebuiltEntities", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryOptionalParameter" + }, + { + "in": "query", + "name": "language", + "description": "The language to get supported prebuilt entities for. Required if multilingual is false. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "in": "query", + "name": "multilingual", + "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored.", + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The list of supported prebuilt entities.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringPrebuiltEntities" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Prebuilt Entities": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + }, + "/authoring/analyze-text/projects/global/training-config-versions": { + "get": { + "description": "Lists the support training config version for a given project type.", + "operationId": "TextAnalysisAuthoring_ListTrainingConfigVersions", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/TextAnalysisAuthoringProjectKindQueryParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all trained models.", + "schema": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersions" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Supported Training Config Versions": { + "$ref": "./examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + } + } + } + }, + "definitions": { + "TextAnalysisAuthoringAssignDeploymentResourcesOptions": { + "description": "Represents the options for assigning Azure resources to a project.", + "required": [ + "resourcesMetadata" + ], + "type": "object", + "properties": { + "resourcesMetadata": { + "description": "Represents the metadata for the resources to be assigned.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringResourceMetadata" + } + } + }, + "x-ms-client-name": "AssignDeploymentResourcesOptions" + }, + "TextAnalysisAuthoringAssignedDeploymentResource": { + "description": "Represents the assigned deployment resource.", + "required": [ + "azureResourceId", + "region" + ], + "type": "object", + "properties": { + "azureResourceId": { + "description": "The resource ID.", + "type": "string" + }, + "region": { + "description": "The resource region.", + "type": "string" + } + }, + "x-ms-client-name": "AssignedDeploymentResource" + }, + "TextAnalysisAuthoringAssignedDeploymentResources": { + "description": "Represents the assigned deployment resources.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of assigned deployment resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringAssignedDeploymentResource" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "AssignedDeploymentResources" + }, + "TextAnalysisAuthoringAssignedProjectDeploymentMetadata": { + "description": "Represents the metadata for an assigned deployment", + "required": [ + "deploymentName", + "lastDeployedDateTime", + "deploymentExpirationDate" + ], + "type": "object", + "properties": { + "deploymentName": { + "description": "Represents the deployment name.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents deployment last deployed time.", + "type": "string" + }, + "deploymentExpirationDate": { + "format": "date", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + } + }, + "x-ms-client-name": "AssignedProjectDeploymentMetadata" + }, + "TextAnalysisAuthoringAssignedProjectDeploymentsMetadata": { + "description": "Represents the metadata for assigned deployments for a project.", + "required": [ + "projectName", + "deploymentsMetadata" + ], + "type": "object", + "properties": { + "projectName": { + "description": "Represents the project name.", + "type": "string" + }, + "deploymentsMetadata": { + "description": "Represents the resource region.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringAssignedProjectDeploymentMetadata" + } + } + }, + "x-ms-client-name": "AssignedProjectDeploymentsMetadata" + }, + "TextAnalysisAuthoringAssignedResourceDeploymentsMetadata": { + "description": "Represents the metadata for deployments assigned to a resource.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved assigned project deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringAssignedProjectDeploymentsMetadata" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "AssignedResourceDeploymentsMetadata" + }, + "TextAnalysisAuthoringCompositionSetting": { + "enum": [ + "separateComponents", + "combineComponents" + ], + "type": "string", + "x-ms-enum": { + "name": "CompositionSetting", + "modelAsString": true, + "values": [ + { + "value": "separateComponents", + "description": "Every component's match or prediction is returned as a separate instance of the entity." + }, + { + "value": "combineComponents", + "description": "When two or more components are found in the text and overlap, the components' spans are merged together into one span combining all of them." + } + ] + }, + "x-ms-client-name": "CompositionSetting" + }, + "TextAnalysisAuthoringConfusionMatrix": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixRow" + }, + "x-ms-client-name": "ConfusionMatrix" + }, + "TextAnalysisAuthoringConfusionMatrixCell": { + "description": "Represents a cell in a confusion matrix.", + "required": [ + "normalizedValue", + "rawValue" + ], + "type": "object", + "properties": { + "normalizedValue": { + "format": "float", + "description": "Represents normalized value in percentages.", + "type": "number" + }, + "rawValue": { + "format": "float", + "description": "Represents raw value.", + "type": "number" + } + }, + "x-ms-client-name": "ConfusionMatrixCell" + }, + "TextAnalysisAuthoringConfusionMatrixRow": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrixCell" + }, + "x-ms-client-name": "ConfusionMatrixRow" + }, + "TextAnalysisAuthoringCopyAuthorizationOptions": { + "description": "Represents the options for authorizing a project copy to the current Azure resource.", + "required": [ + "projectKind" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "storageInputContainerName": { + "description": "The name of the storage container.", + "type": "string" + }, + "allowOverwrite": { + "description": "Whether to allow an existing project to be overwritten using the resulting copy authorization.", + "type": "boolean" + } + }, + "x-ms-client-name": "CopyAuthorizationOptions" + }, + "TextAnalysisAuthoringCopyProjectJobState": { + "description": "Represents the state of a copy job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "CopyProjectJobState" + }, + "TextAnalysisAuthoringCopyProjectOptions": { + "description": "Represents the options for copying an existing project to another Azure resource.", + "required": [ + "projectKind", + "targetProjectName", + "accessToken", + "expiresAt", + "targetResourceId", + "targetResourceRegion" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "targetProjectName": { + "description": "The project name to be copied-into.", + "type": "string" + }, + "accessToken": { + "description": "The access token.", + "type": "string" + }, + "expiresAt": { + "format": "date-time", + "description": "The expiration of the access token.", + "type": "string" + }, + "targetResourceId": { + "description": "Represents the target Azure resource ID.", + "type": "string" + }, + "targetResourceRegion": { + "description": "Represents the target Azure resource region.", + "type": "string" + } + }, + "x-ms-client-name": "CopyProjectOptions" + }, + "TextAnalysisAuthoringCreateDeploymentOptions": { + "description": "Represents the options for creating or updating a project deployment.", + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "Represents the trained model label.", + "type": "string" + }, + "assignedResourceIds": { + "description": "Represents the resource IDs to be assigned to the deployment.\n If provided, the deployment will be rolled out to the resources provided here as well as the original resource in which the project is created.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "CreateDeploymentOptions" + }, + "TextAnalysisAuthoringCreateProjectOptions": { + "description": "Represents the options used to create or update a project.", + "required": [ + "projectKind", + "storageInputContainerName", + "projectName", + "language" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "The project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "storageInputContainerName": { + "description": "The storage container name.", + "type": "string" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + } + }, + "x-ms-client-name": "CreateProjectOptions" + }, + "TextAnalysisAuthoringCustomEntityRecognitionDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom entity recognition project.", + "required": [ + "customEntityRecognitionResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customEntityRecognitionResult": { + "description": "Represents the evaluation prediction for entity recognition.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomEntityRecognition", + "x-ms-client-name": "CustomEntityRecognitionDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom entity recognition project.", + "required": [ + "customEntityRecognitionEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customEntityRecognitionEvaluation": { + "description": "Contains the data related to extraction evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomEntityRecognition", + "x-ms-client-name": "CustomEntityRecognitionEvaluationSummary" + }, + "TextAnalysisAuthoringCustomHealthcareDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom entity recognition project.", + "required": [ + "customHealthcareResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customHealthcareResult": { + "description": "Represents the evaluation prediction for entity recognition.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentHealthcareEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomHealthcare", + "x-ms-client-name": "CustomHealthcareDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomHealthcareEvaluationSummary": { + "description": "Represents the evaluation summary for a custom health care project.", + "required": [ + "customHealthcareEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customHealthcareEvaluation": { + "description": "Contains the data related to health care evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringEntityRecognitionEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomHealthcare", + "x-ms-client-name": "CustomHealthcareEvaluationSummary" + }, + "TextAnalysisAuthoringCustomMultiLabelClassificationDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom multi-label classification project.", + "required": [ + "customMultiLabelClassificationResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customMultiLabelClassificationResult": { + "description": "Represents the evaluation prediction for multi label classification.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomMultiLabelClassification", + "x-ms-client-name": "CustomMultiLabelClassificationDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomMultiLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom multi-label classification project.", + "required": [ + "customMultiLabelClassificationEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customMultiLabelClassificationEvaluation": { + "description": "Contains the data related to multi label classification evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomMultiLabelClassification", + "x-ms-client-name": "CustomMultiLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringCustomSingleLabelClassificationDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom single-label classification project.", + "required": [ + "customSingleLabelClassificationResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customSingleLabelClassificationResult": { + "description": "Represents the evaluation prediction for single label classification.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomSingleLabelClassification", + "x-ms-client-name": "CustomSingleLabelClassificationDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomSingleLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom single-label classification project.", + "required": [ + "customSingleLabelClassificationEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customSingleLabelClassificationEvaluation": { + "description": "Contains the data related to single label classification evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomSingleLabelClassification", + "x-ms-client-name": "CustomSingleLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringCustomTextSentimentDocumentEvaluationResult": { + "description": "Represents the document evaluation result for a custom sentiment project.", + "required": [ + "customTextSentimentResult" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + ], + "properties": { + "customTextSentimentResult": { + "description": "Represents the evaluation prediction for text sentiment.", + "$ref": "#/definitions/TextAnalysisAuthoringDocumentTextSentimentEvaluationResult" + } + }, + "x-ms-discriminator-value": "CustomTextSentiment", + "x-ms-client-name": "CustomTextSentimentDocumentEvaluationResult" + }, + "TextAnalysisAuthoringCustomTextSentimentEvaluationSummary": { + "description": "Represents the evaluation summary for a custom text sentiment project.", + "required": [ + "customTextSentimentEvaluation" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationSummary" + } + ], + "properties": { + "customTextSentimentEvaluation": { + "description": "Contains the data related to custom sentiment evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringTextSentimentEvaluationSummary" + } + }, + "x-ms-discriminator-value": "CustomTextSentiment", + "x-ms-client-name": "CustomTextSentimentEvaluationSummary" + }, + "TextAnalysisAuthoringDeleteDeploymentOptions": { + "description": "Represents the options for deleting a project deployment.", + "type": "object", + "properties": { + "assignedResourceIds": { + "description": "Represents the resource IDs to delete the deployment from.\n If not provided, the deployment will be rolled out from all the resources it is deployed to.\n If provided, it will delete the deployment only from the specified assigned resources, and leave it for the rest.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "DeleteDeploymentOptions" + }, + "TextAnalysisAuthoringDeploymentJobState": { + "description": "Represents the state of a deployment job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "DeploymentJobState" + }, + "TextAnalysisAuthoringDeploymentResource": { + "description": "Represents an Azure resource assigned to a deployment.", + "required": [ + "resourceId", + "region" + ], + "type": "object", + "properties": { + "resourceId": { + "description": "Represents the Azure resource Id.", + "type": "string" + }, + "region": { + "description": "Represents the resource region.", + "type": "string" + } + }, + "x-ms-client-name": "DeploymentResource" + }, + "TextAnalysisAuthoringDeploymentResourcesJobState": { + "description": "Represents the state of a deployment resources job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "DeploymentResourcesJobState" + }, + "TextAnalysisAuthoringDocumentEntityLabelEvaluationResult": { + "description": "Represents an evaluation result entity label.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "Represents the entity category.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Represents the entity offset index relative to the original text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Represents the entity length.", + "type": "integer" + } + }, + "x-ms-client-name": "DocumentEntityLabelEvaluationResult" + }, + "TextAnalysisAuthoringDocumentEntityRecognitionEvaluationResult": { + "description": "Represents the entity recognition evaluation result for a document.", + "required": [ + "entities" + ], + "type": "object", + "properties": { + "entities": { + "description": "Represents the document labelled entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" + } + } + }, + "x-ms-client-name": "DocumentEntityRecognitionEvaluationResult" + }, + "TextAnalysisAuthoringDocumentEntityRegionEvaluationResult": { + "description": "Represents the evaluation comparison between the expected and predicted entities of a document region.", + "required": [ + "expectedEntities", + "predictedEntities", + "regionOffset", + "regionLength" + ], + "type": "object", + "properties": { + "expectedEntities": { + "description": "Represents the region's expected entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" + } + }, + "predictedEntities": { + "description": "Represents the region's predicted entity labels.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityLabelEvaluationResult" + } + }, + "regionOffset": { + "format": "int32", + "description": "Represents the region offset.", + "type": "integer" + }, + "regionLength": { + "format": "int32", + "description": "Represents the region length.", + "type": "integer" + } + }, + "x-ms-client-name": "DocumentEntityRegionEvaluationResult" + }, + "TextAnalysisAuthoringDocumentEvaluationResult": { + "description": "Represents the evaluation result of a document.", + "required": [ + "location", + "language", + "projectKind" + ], + "type": "object", + "properties": { + "location": { + "description": "Represents the document path.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "projectKind": { + "description": "Represents the project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "DocumentEvaluationResult" + }, + "TextAnalysisAuthoringDocumentHealthcareEvaluationResult": { + "description": "Represents the healthcare evaluation result for a document.", + "required": [ + "entities" + ], + "type": "object", + "properties": { + "entities": { + "description": "Represents the document labelled entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEntityRegionEvaluationResult" + } + } + }, + "x-ms-client-name": "DocumentHealthcareEvaluationResult" + }, + "TextAnalysisAuthoringDocumentMultiLabelClassificationEvaluationResult": { + "description": "Represents the comparison between the expected and predicted classes that are result from the evaluation operation.", + "required": [ + "expectedClasses", + "predictedClasses" + ], + "type": "object", + "properties": { + "expectedClasses": { + "description": "Represents the document's expected classes.", + "type": "array", + "items": { + "type": "string" + } + }, + "predictedClasses": { + "description": "Represents the document's predicted classes.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "DocumentMultiLabelClassificationEvaluationResult" + }, + "TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult": { + "description": "Represents an evaluation result Sentiment label.", + "required": [ + "category", + "offset", + "length" + ], + "type": "object", + "properties": { + "category": { + "description": "Represents the sentiment category.", + "$ref": "#/definitions/TextAnalysisAuthoringSentiment" + }, + "offset": { + "format": "int32", + "description": "Represents the sentiment offset index relative to the original text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Represents the sentiment length.", + "type": "integer" + } + }, + "x-ms-client-name": "DocumentSentimentLabelEvaluationResult" + }, + "TextAnalysisAuthoringDocumentSingleLabelClassificationEvaluationResult": { + "description": "Represents the comparison between the expected and predicted class that result from an evaluation operation.", + "required": [ + "expectedClass", + "predictedClass" + ], + "type": "object", + "properties": { + "expectedClass": { + "description": "Represents the document's expected class.", + "type": "string" + }, + "predictedClass": { + "description": "Represents the document's predicted class.", + "type": "string" + } + }, + "x-ms-client-name": "DocumentSingleLabelClassificationEvaluationResult" + }, + "TextAnalysisAuthoringDocumentTextSentimentEvaluationResult": { + "description": "Represents the comparison between the expected and predicted sentiment that result from an evaluation operation.", + "required": [ + "expectedSentimentSpans", + "predictedSentimentSpans" + ], + "type": "object", + "properties": { + "expectedSentimentSpans": { + "description": "Represents the document's expected sentiment labels.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult" + } + }, + "predictedSentimentSpans": { + "description": "Represents the document's predicted sentiment labels.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentSentimentLabelEvaluationResult" + } + } + }, + "x-ms-client-name": "DocumentTextSentimentEvaluationResult" + }, + "TextAnalysisAuthoringEntityEvaluationSummary": { + "description": "Represents the evaluation summary for an entity.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "EntityEvaluationSummary" + }, + "TextAnalysisAuthoringEntityRecognitionEvaluationSummary": { + "description": "Represents the evaluation summary for a custom entity recognition project.", + "required": [ + "confusionMatrix", + "entities", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two entities (the two entities can be the same). The matrix is between the entity that was labelled and the entity that was predicted.", + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" + }, + "entities": { + "description": "Represents the entities evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringEntityEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "EntityRecognitionEvaluationSummary" + }, + "TextAnalysisAuthoringEvaluationJobResult": { + "required": [ + "evaluationOptions", + "modelLabel", + "trainingConfigVersion", + "percentComplete" + ], + "type": "object", + "properties": { + "evaluationOptions": { + "description": "Represents the options used running the evaluation.", + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" + }, + "modelLabel": { + "description": "Represents trained model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "percentComplete": { + "format": "int32", + "description": "Represents progress percentage.", + "type": "integer" + } + }, + "x-ms-client-name": "EvaluationJobResult" + }, + "TextAnalysisAuthoringEvaluationJobState": { + "description": "Represents the state of a evaluation job.", + "required": [ + "result" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "properties": { + "result": { + "description": "Represents evaluation task detailed result.", + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationJobResult" + } + }, + "x-ms-client-name": "EvaluationJobState" + }, + "TextAnalysisAuthoringEvaluationKind": { + "enum": [ + "percentage", + "manual" + ], + "type": "string", + "x-ms-enum": { + "name": "EvaluationKind", + "modelAsString": true, + "values": [ + { + "value": "percentage", + "description": "Split the data into training and test sets according to user-defined percentages." + }, + { + "value": "manual", + "description": "Split the data according to the chosen dataset for every example in the data." + } + ] + }, + "x-ms-client-name": "EvaluationKind" + }, + "TextAnalysisAuthoringEvaluationOptions": { + "description": "Represents the options used running the evaluation.", + "type": "object", + "properties": { + "kind": { + "description": "Represents the evaluation kind. By default, the evaluation kind is set to percentage.", + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationKind" + }, + "trainingSplitPercentage": { + "format": "int32", + "description": "Represents the training dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + }, + "testingSplitPercentage": { + "format": "int32", + "description": "Represents the testing dataset split percentage. Only needed in case the evaluation kind is percentage.", + "type": "integer" + } + }, + "x-ms-client-name": "EvaluationOptions" + }, + "TextAnalysisAuthoringEvaluationResults": { + "description": "Represents a list of results for an evaluation operation.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "THe list of documents evaluation results.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDocumentEvaluationResult" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "EvaluationResults" + }, + "TextAnalysisAuthoringEvaluationSummary": { + "description": "Represents the summary for an evaluation operation.", + "required": [ + "projectKind", + "evaluationOptions" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "Represents the project type that the evaluation ran on.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "evaluationOptions": { + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "EvaluationSummary" + }, + "TextAnalysisAuthoringExportedClass": { + "description": "Represents a class of an exported project.", + "type": "object", + "properties": { + "category": { + "description": "The class category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedClass" + }, + "TextAnalysisAuthoringExportedCompositeEntity": { + "description": "Represents an entity in an exported project with composite entities enabled.", + "type": "object", + "properties": { + "compositionSetting": { + "description": "The behavior to follow when the entity's components overlap with each other.", + "$ref": "#/definitions/TextAnalysisAuthoringCompositionSetting" + }, + "list": { + "description": "The list component of the entity.", + "$ref": "#/definitions/TextAnalysisAuthoringExportedEntityList" + }, + "prebuilts": { + "description": "The prebuilt entities components.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedPrebuiltEntity" + } + }, + "category": { + "description": "The entity category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCompositeEntity" + }, + "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument": { + "description": "Represents an exported document for a custom abstractive summarization project.", + "required": [ + "summaryLocation" + ], + "type": "object", + "properties": { + "summaryLocation": { + "description": "Represents the summary file location in the blob store container associated with the project.", + "type": "string" + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomAbstractiveSummarizationDocument" + }, + "TextAnalysisAuthoringExportedCustomAbstractiveSummarizationProjectAssets": { + "description": "Represents the exported assets for an abstractive summarization project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "documents": { + "description": "The list of documents belonging to this project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomAbstractiveSummarizationDocument" + } + } + }, + "x-ms-discriminator-value": "CustomAbstractiveSummarization", + "x-ms-client-name": "ExportedCustomAbstractiveSummarizationProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomEntityRecognitionDocument": { + "description": "Represents an exported document for a custom entity recognition project.", + "type": "object", + "properties": { + "entities": { + "description": "The list of entity labels belonging to the document.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityRegion" + } + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomEntityRecognitionDocument" + }, + "TextAnalysisAuthoringExportedCustomEntityRecognitionProjectAssets": { + "description": "Represents the exported assets for a entity recognition project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "entities": { + "description": "The list of entities belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedEntity" + } + }, + "documents": { + "description": "The list of documents belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomEntityRecognitionDocument" + } + } + }, + "x-ms-discriminator-value": "CustomEntityRecognition", + "x-ms-client-name": "ExportedCustomEntityRecognitionProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomHealthcareDocument": { + "description": "Represents an exported document for a CustomHealthcare project.", + "type": "object", + "properties": { + "entities": { + "description": "The list of entity labels belonging to the document.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityRegion" + } + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomHealthcareDocument" + }, + "TextAnalysisAuthoringExportedCustomHealthcareProjectAssets": { + "description": "Represents the exported assets for a CustomHealthcare project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "entities": { + "description": "The list of entities belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCompositeEntity" + } + }, + "documents": { + "description": "The list of documents belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomHealthcareDocument" + } + } + }, + "x-ms-discriminator-value": "CustomHealthcare", + "x-ms-client-name": "ExportedCustomHealthcareProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument": { + "description": "Represents an exported document of a custom multi-label classification project.", + "type": "object", + "properties": { + "classes": { + "description": "The document classes.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" + } + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomMultiLabelClassificationDocument" + }, + "TextAnalysisAuthoringExportedCustomMultiLabelClassificationProjectAssets": { + "description": "Represents the exported assets for a custom multi-label classification project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "classes": { + "description": "The list of classes in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" + } + }, + "documents": { + "description": "The list of documents in the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomMultiLabelClassificationDocument" + } + } + }, + "x-ms-discriminator-value": "CustomMultiLabelClassification", + "x-ms-client-name": "ExportedCustomMultiLabelClassificationProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument": { + "description": "Represents an exported document for a custom single-label classification project.", + "type": "object", + "properties": { + "class": { + "description": "The class of the documents.", + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentClass" + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomSingleLabelClassificationDocument" + }, + "TextAnalysisAuthoringExportedCustomSingleLabelClassificationProjectAssets": { + "description": "Represents the exported assets for a single-label classification project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "classes": { + "description": "The list of classes belonging to this project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedClass" + } + }, + "documents": { + "description": "The list of documents belonging to this project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomSingleLabelClassificationDocument" + } + } + }, + "x-ms-discriminator-value": "CustomSingleLabelClassification", + "x-ms-client-name": "ExportedCustomSingleLabelClassificationProjectAssets" + }, + "TextAnalysisAuthoringExportedCustomTextSentimentDocument": { + "description": "Represents an exported document for a custom text sentiment project.", + "type": "object", + "properties": { + "sentimentSpans": { + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentSentimentLabel" + } + }, + "location": { + "description": "The location of the document in the storage.", + "type": "string" + }, + "language": { + "description": "Represents the document language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "dataset": { + "description": "The dataset for this document. Allowed values are 'Train' and 'Test'.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedCustomTextSentimentDocument" + }, + "TextAnalysisAuthoringExportedCustomTextSentimentProjectAssets": { + "description": "Represents the exported assets for a custom text sentiment project.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + ], + "properties": { + "documents": { + "description": "The list of documents belonging to the project.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedCustomTextSentimentDocument" + } + } + }, + "x-ms-discriminator-value": "CustomTextSentiment", + "x-ms-client-name": "ExportedCustomTextSentimentProjectAssets" + }, + "TextAnalysisAuthoringExportedDocumentClass": { + "description": "Represents a classification label for a document.", + "type": "object", + "properties": { + "category": { + "type": "string" + } + }, + "x-ms-client-name": "ExportedDocumentClass" + }, + "TextAnalysisAuthoringExportedDocumentEntityLabel": { + "description": "Represents an entity label for a document.", + "type": "object", + "properties": { + "category": { + "description": "The entity category.", + "type": "string" + }, + "offset": { + "format": "int32", + "description": "Start position for the entity text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Length for the entity text.", + "type": "integer" + } + }, + "x-ms-client-name": "ExportedDocumentEntityLabel" + }, + "TextAnalysisAuthoringExportedDocumentEntityRegion": { + "description": "Represents a region in a document for entity labeling.", + "type": "object", + "properties": { + "regionOffset": { + "format": "int32", + "description": "Start position for the region.", + "type": "integer" + }, + "regionLength": { + "format": "int32", + "description": "Length for the region text.", + "type": "integer" + }, + "labels": { + "description": "The list of entity labels belonging to this region.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedDocumentEntityLabel" + } + } + }, + "x-ms-client-name": "ExportedDocumentEntityRegion" + }, + "TextAnalysisAuthoringExportedDocumentSentimentLabel": { + "description": "Represents an entity label for a document.", + "type": "object", + "properties": { + "category": { + "description": "The sentiment category.", + "$ref": "#/definitions/TextAnalysisAuthoringSentiment" + }, + "offset": { + "format": "int32", + "description": "Start position for the sentiment text.", + "type": "integer" + }, + "length": { + "format": "int32", + "description": "Length for the sentiment text.", + "type": "integer" + } + }, + "x-ms-client-name": "ExportedDocumentSentimentLabel" + }, + "TextAnalysisAuthoringExportedEntity": { + "description": "Represents an entity in an exported project.", + "type": "object", + "properties": { + "category": { + "description": "The entity category.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedEntity" + }, + "TextAnalysisAuthoringExportedEntityList": { + "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/TextAnalysisAuthoringExportedEntitySublist" + } + } + }, + "x-ms-client-name": "ExportedEntityList" + }, + "TextAnalysisAuthoringExportedEntityListSynonym": { + "description": "Represents a list of synonyms inside a list component", + "type": "object", + "properties": { + "language": { + "description": "Represents the language of the synonyms. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + }, + "values": { + "description": "The list of synonyms.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "ExportedEntityListSynonym" + }, + "TextAnalysisAuthoringExportedEntitySublist": { + "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/TextAnalysisAuthoringExportedEntityListSynonym" + } + } + }, + "x-ms-client-name": "ExportedEntitySublist" + }, + "TextAnalysisAuthoringExportedModelJobState": { + "description": "Represents the state of a job to create or updated an exported model.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ExportedModelJobState" + }, + "TextAnalysisAuthoringExportedModelManifest": { + "description": "Represents the properties for the exported model manifest.", + "required": [ + "modelFiles" + ], + "type": "object", + "properties": { + "modelFiles": { + "description": "The model files belonging to this model.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringModelFile" + } + } + }, + "x-ms-client-name": "ExportedModelManifest" + }, + "TextAnalysisAuthoringExportedModelOptions": { + "description": "Represents the options for creating or replacing an exported model.", + "required": [ + "trainedModelLabel" + ], + "type": "object", + "properties": { + "trainedModelLabel": { + "description": "The trained model label.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedModelOptions" + }, + "TextAnalysisAuthoringExportedPrebuiltEntity": { + "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" + }, + "TextAnalysisAuthoringExportedProject": { + "description": "Represents an exported project.", + "required": [ + "projectFileVersion", + "stringIndexType", + "metadata" + ], + "type": "object", + "properties": { + "projectFileVersion": { + "description": "The version of the exported file.", + "type": "string" + }, + "stringIndexType": { + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "$ref": "#/definitions/TextAnalysisAuthoringStringIndexType" + }, + "metadata": { + "description": "Represents the project metadata.", + "$ref": "#/definitions/TextAnalysisAuthoringCreateProjectOptions" + }, + "assets": { + "description": "Represents the project assets.", + "$ref": "#/definitions/TextAnalysisAuthoringExportedProjectAssets" + } + }, + "x-ms-client-name": "ExportedProject" + }, + "TextAnalysisAuthoringExportedProjectAssets": { + "description": "Represents the assets of an exported project.", + "required": [ + "projectKind" + ], + "type": "object", + "properties": { + "projectKind": { + "description": "The type of the project the assets belong to.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + } + }, + "discriminator": "projectKind", + "x-ms-client-name": "ExportedProjectAssets" + }, + "TextAnalysisAuthoringExportedTrainedModel": { + "description": "Represents an exported trained model.", + "required": [ + "exportedModelName", + "modelId", + "lastTrainedDateTime", + "lastExportedModelDateTime", + "modelExpirationDate", + "modelTrainingConfigVersion" + ], + "type": "object", + "properties": { + "exportedModelName": { + "description": "The exported model name.", + "type": "string" + }, + "modelId": { + "description": "The model ID.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "The last trained date time of the model.", + "type": "string" + }, + "lastExportedModelDateTime": { + "format": "date-time", + "description": "The last exported date time of the model.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date", + "description": "The model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "The model training config version.", + "type": "string" + } + }, + "x-ms-client-name": "ExportedTrainedModel" + }, + "TextAnalysisAuthoringExportedTrainedModels": { + "description": "Represents a list of exported trained models.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of exported models.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringExportedTrainedModel" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ExportedTrainedModels" + }, + "TextAnalysisAuthoringExportProjectJobState": { + "description": "Represents the state of an export job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "properties": { + "resultUrl": { + "description": "The URL to use in order to download the exported project.", + "type": "string" + } + }, + "x-ms-client-name": "ExportProjectJobState" + }, + "TextAnalysisAuthoringImportProjectJobState": { + "description": "Represents the state of an import job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ImportProjectJobState" + }, + "TextAnalysisAuthoringJobState": { + "description": "Represents a job's state.", + "required": [ + "jobId", + "createdDateTime", + "lastUpdatedDateTime", + "status" + ], + "type": "object", + "properties": { + "jobId": { + "description": "The job ID.", + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "description": "The creation date time of the job.", + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "description": "The last date time the job was updated.", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "description": "The expiration date time of the job.", + "type": "string" + }, + "status": { + "description": "The job status.", + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" + }, + "warnings": { + "description": "The warnings that were encountered while executing the job.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringWarning" + } + }, + "errors": { + "description": "The errors encountered while executing the job.", + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + }, + "x-ms-client-name": "JobState" + }, + "TextAnalysisAuthoringJobStatus": { + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + }, + "x-ms-client-name": "JobStatus" + }, + "TextAnalysisAuthoringLoadSnapshotJobState": { + "description": "Represents the state of loading a snapshot job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "LoadSnapshotJobState" + }, + "TextAnalysisAuthoringModelFile": { + "description": "Represents the properties for the model file.", + "required": [ + "name", + "contentUri" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the file.", + "type": "string" + }, + "contentUri": { + "format": "uri", + "description": "The URI to retrieve the content of the file.", + "type": "string" + } + }, + "x-ms-client-name": "ModelFile" + }, + "TextAnalysisAuthoringMultiLabelClassEvaluationSummary": { + "description": "Represents the evaluation summary of a class in a multi-label classification project.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "MultiLabelClassEvaluationSummary" + }, + "TextAnalysisAuthoringMultiLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a multi-label classification project.", + "required": [ + "classes", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "classes": { + "description": "Represents the classes evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringMultiLabelClassEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "MultiLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringPrebuiltEntities": { + "description": "Represents a list of the retrieved supported prebuilt entities.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The supported prebuilt entities.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringPrebuiltEntity" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "PrebuiltEntities" + }, + "TextAnalysisAuthoringPrebuiltEntity": { + "description": "Represents a supported prebuilt entity.", + "required": [ + "category", + "description", + "examples" + ], + "type": "object", + "properties": { + "category": { + "description": "The prebuilt entity category.", + "type": "string" + }, + "description": { + "description": "The description.", + "type": "string" + }, + "examples": { + "description": "English examples for the entity.", + "type": "string" + } + }, + "x-ms-client-name": "PrebuiltEntity" + }, + "TextAnalysisAuthoringProjectDeletionJobState": { + "description": "Represents the state of a project deletion job.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "x-ms-client-name": "ProjectDeletionJobState" + }, + "TextAnalysisAuthoringProjectDeployment": { + "description": "Represents a project deployment.", + "required": [ + "deploymentName", + "modelId", + "lastTrainedDateTime", + "lastDeployedDateTime", + "deploymentExpirationDate", + "modelTrainingConfigVersion", + "assignedResources" + ], + "type": "object", + "properties": { + "deploymentName": { + "description": "Represents deployment name.", + "type": "string" + }, + "modelId": { + "description": "Represents deployment modelId.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents deployment last trained time.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents deployment last deployed time.", + "type": "string" + }, + "deploymentExpirationDate": { + "format": "date", + "description": "Represents deployment expiration date in the runtime.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "Represents model training config version.", + "type": "string" + }, + "assignedResources": { + "description": "Represents the metadata of the assigned Azure resources.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringDeploymentResource" + } + } + }, + "x-ms-client-name": "ProjectDeployment" + }, + "TextAnalysisAuthoringProjectDeployments": { + "description": "Represents a list of retrieved deployments.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of retrieved deployments.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectDeployment" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectDeployments" + }, + "TextAnalysisAuthoringProjectKind": { + "enum": [ + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "CustomEntityRecognition", + "CustomAbstractiveSummarization", + "CustomHealthcare", + "CustomTextSentiment" + ], + "type": "string", + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "CustomSingleLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." + }, + { + "value": "CustomMultiLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." + }, + { + "value": "CustomEntityRecognition", + "description": "For building an extraction model to identify your domain categories using your own data." + }, + { + "value": "CustomAbstractiveSummarization", + "description": "For building an abstractive summarization models which are able to summarize long documents." + }, + { + "value": "CustomHealthcare", + "description": "For building an text analytics for health model to identify your health domain data." + }, + { + "value": "CustomTextSentiment", + "description": "For building a sentiment models which are able to extract sentiment for long documents." + } + ] + }, + "x-ms-client-name": "ProjectKind" + }, + "TextAnalysisAuthoringProjectMetadata": { + "description": "Represents the metadata of a project.", + "required": [ + "createdDateTime", + "lastModifiedDateTime", + "projectKind", + "storageInputContainerName", + "projectName", + "language" + ], + "type": "object", + "properties": { + "createdDateTime": { + "format": "date-time", + "description": "Represents the project creation datetime.", + "type": "string" + }, + "lastModifiedDateTime": { + "format": "date-time", + "description": "Represents the project last modification datetime.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "Represents the project last training datetime.", + "type": "string" + }, + "lastDeployedDateTime": { + "format": "date-time", + "description": "Represents the project last deployment datetime.", + "type": "string" + }, + "projectKind": { + "description": "The project kind.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectKind" + }, + "storageInputContainerName": { + "description": "The storage container name.", + "type": "string" + }, + "settings": { + "description": "The project settings.", + "$ref": "#/definitions/TextAnalysisAuthoringProjectSettings" + }, + "projectName": { + "description": "The new project name.", + "type": "string" + }, + "multilingual": { + "description": "Whether the project would be used for multiple languages or not.", + "type": "boolean" + }, + "description": { + "description": "The project description.", + "type": "string" + }, + "language": { + "description": "The project language. This is BCP-47 representation of a language. For example, use \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + } + }, + "x-ms-client-name": "ProjectMetadata" + }, + "TextAnalysisAuthoringProjectSettings": { + "description": "Represents the settings used to define the project behavior.", + "type": "object", + "properties": { + "confidenceThreshold": { + "format": "float", + "description": "The threshold of the class with the highest confidence, at which the prediction will automatically be changed to \"None\". The value of the threshold should be between 0 and 1 inclusive.", + "type": "number" + }, + "amlProjectPath": { + "description": "The path to the AML connected project.", + "type": "string" + }, + "isLabelingLocked": { + "description": "Indicates whether the labeling experience can be modified or not.", + "type": "boolean" + }, + "runGptPredictions": { + "description": "Indicates whether to run GPT predictions or not.", + "type": "boolean" + }, + "gptPredictiveLookahead": { + "format": "int32", + "description": "The predictive lookahead for GPT predictions that is specified by the user.", + "type": "integer" + } + }, + "x-ms-client-name": "ProjectSettings" + }, + "TextAnalysisAuthoringProjectsMetadata": { + "description": "Represents a list of retrieved projects' metadata.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of projects.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectMetadata" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectsMetadata" + }, + "TextAnalysisAuthoringProjectTrainedModel": { + "description": "Represents a trained model.", + "required": [ + "label", + "modelId", + "lastTrainedDateTime", + "lastTrainingDurationInSeconds", + "modelExpirationDate", + "modelTrainingConfigVersion", + "hasSnapshot" + ], + "type": "object", + "properties": { + "label": { + "description": "The trained model label.", + "type": "string" + }, + "modelId": { + "description": "The model ID.", + "type": "string" + }, + "lastTrainedDateTime": { + "format": "date-time", + "description": "The last trained date time of the model.", + "type": "string" + }, + "lastTrainingDurationInSeconds": { + "format": "int32", + "description": "The duration of the model's last training request in seconds.", + "type": "integer" + }, + "modelExpirationDate": { + "format": "date", + "description": "The model expiration date.", + "type": "string" + }, + "modelTrainingConfigVersion": { + "description": "The model training config version.", + "type": "string" + }, + "hasSnapshot": { + "description": "The flag to indicate if the trained model has a snapshot ready.", + "type": "boolean" + } + }, + "x-ms-client-name": "ProjectTrainedModel" + }, + "TextAnalysisAuthoringProjectTrainedModels": { + "description": "Represents a list of retrieved trained models.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of trained models.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringProjectTrainedModel" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "ProjectTrainedModels" + }, + "TextAnalysisAuthoringResourceMetadata": { + "description": "Represents metadata for the Azure resource..", + "required": [ + "azureResourceId", + "customDomain", + "region" + ], + "type": "object", + "properties": { + "azureResourceId": { + "description": "Represents the Azure resource ID.", + "type": "string" + }, + "customDomain": { + "description": "Represents the Azure resource custom domain.", + "type": "string" + }, + "region": { + "description": "Represents the Azure resource region.", + "type": "string" + } + }, + "x-ms-client-name": "ResourceMetadata" + }, + "TextAnalysisAuthoringSentiment": { + "enum": [ + "positive", + "negative", + "neutral" + ], + "type": "string", + "x-ms-enum": { + "name": "Sentiment", + "modelAsString": true + }, + "x-ms-client-name": "Sentiment" + }, + "TextAnalysisAuthoringSentimentEvaluationSummary": { + "description": "Represents the evaluation summary for a sentiment in a custom sentiment project.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "SentimentEvaluationSummary" + }, + "TextAnalysisAuthoringSingleLabelClassEvaluationSummary": { + "description": "Represents the evaluation summary for a class in a single-label classification project.", + "required": [ + "f1", + "precision", + "recall", + "truePositiveCount", + "trueNegativeCount", + "falsePositiveCount", + "falseNegativeCount" + ], + "type": "object", + "properties": { + "f1": { + "format": "double", + "description": "Represents the model precision", + "type": "number" + }, + "precision": { + "format": "double", + "description": "Represents the model recall", + "type": "number" + }, + "recall": { + "format": "double", + "description": "Represents the model F1 score", + "type": "number" + }, + "truePositiveCount": { + "format": "int32", + "description": "Represents the count of true positive", + "type": "integer" + }, + "trueNegativeCount": { + "format": "int32", + "description": "Represents the count of true negative", + "type": "integer" + }, + "falsePositiveCount": { + "format": "int32", + "description": "Represents the count of false positive", + "type": "integer" + }, + "falseNegativeCount": { + "format": "int32", + "description": "Represents the count of false negative", + "type": "integer" + } + }, + "x-ms-client-name": "SingleLabelClassEvaluationSummary" + }, + "TextAnalysisAuthoringSingleLabelClassificationEvaluationSummary": { + "description": "Represents the evaluation summary for a custom single-label classification project.", + "required": [ + "confusionMatrix", + "classes", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two classes (the two classes can be the same). The matrix is between the class that was labelled and the class that was predicted.", + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" + }, + "classes": { + "description": "Represents the classes evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringSingleLabelClassEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "SingleLabelClassificationEvaluationSummary" + }, + "TextAnalysisAuthoringSpanSentimentEvaluationSummary": { + "description": "Represents the evaluation summary for a custom sentiment project.", + "required": [ + "confusionMatrix", + "sentiments", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "confusionMatrix": { + "description": "Represents the confusion matrix between two sentiments (the two sentiments can be the same). The matrix is between the sentiment that was labelled and the sentiment that was predicted.", + "$ref": "#/definitions/TextAnalysisAuthoringConfusionMatrix" + }, + "sentiments": { + "description": "Represents the sentiment evaluation", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/TextAnalysisAuthoringSentimentEvaluationSummary" + } + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "SpanSentimentEvaluationSummary" + }, + "TextAnalysisAuthoringStringIndexType": { + "enum": [ + "Utf16CodeUnit" + ], + "type": "string", + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "x-ms-client-name": "StringIndexType" + }, + "TextAnalysisAuthoringSubTrainingJobState": { + "description": "Represents the detailed state of a training sub-operation.", + "required": [ + "percentComplete", + "status" + ], + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Represents progress percentage.", + "type": "integer" + }, + "startDateTime": { + "format": "date-time", + "description": "Represents the start date time.", + "type": "string" + }, + "endDateTime": { + "format": "date-time", + "description": "Represents the end date time.", + "type": "string" + }, + "status": { + "description": "Represents the status of the sub-operation.", + "$ref": "#/definitions/TextAnalysisAuthoringJobStatus" + } + }, + "x-ms-client-name": "SubTrainingJobState" + }, + "TextAnalysisAuthoringSupportedLanguage": { + "description": "Represents a supported language.", + "required": [ + "languageName", + "languageCode" + ], + "type": "object", + "properties": { + "languageName": { + "description": "The language name.", + "type": "string" + }, + "languageCode": { + "description": "The language code. This is BCP-47 representation of a language. For example, \"en\" for English, \"en-gb\" for English (UK), \"es\" for Spanish etc.", + "type": "string" + } + }, + "x-ms-client-name": "SupportedLanguage" + }, + "TextAnalysisAuthoringSupportedLanguages": { + "description": "Represents a list of retrieved languages.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the languages.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringSupportedLanguage" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "SupportedLanguages" + }, + "TextAnalysisAuthoringSwapDeploymentsOptions": { + "description": "Represents the options for swapping two deployments together.", + "required": [ + "firstDeploymentName", + "secondDeploymentName" + ], + "type": "object", + "properties": { + "firstDeploymentName": { + "description": "Represents the first deployment name.", + "type": "string" + }, + "secondDeploymentName": { + "description": "Represents the second deployment name.", + "type": "string" + } + }, + "x-ms-client-name": "SwapDeploymentsOptions" + }, + "TextAnalysisAuthoringTextSentimentEvaluationSummary": { + "description": "Represents the evaluation summary for a custom text sentiment project.", + "required": [ + "spanSentimentsEvaluation", + "microF1", + "microPrecision", + "microRecall", + "macroF1", + "macroPrecision", + "macroRecall" + ], + "type": "object", + "properties": { + "spanSentimentsEvaluation": { + "description": "Represents evaluation of span level sentiments", + "$ref": "#/definitions/TextAnalysisAuthoringSpanSentimentEvaluationSummary" + }, + "microF1": { + "format": "float", + "description": "Represents the micro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microPrecision": { + "format": "float", + "description": "Represents the micro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "microRecall": { + "format": "float", + "description": "Represents the micro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroF1": { + "format": "float", + "description": "Represents the macro F1. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroPrecision": { + "format": "float", + "description": "Represents the macro precision. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + }, + "macroRecall": { + "format": "float", + "description": "Represents the macro recall. Expected value is a float between 0 and 1 inclusive.", + "type": "number" + } + }, + "x-ms-client-name": "TextSentimentEvaluationSummary" + }, + "TextAnalysisAuthoringTrainingConfigVersion": { + "description": "Represents a training config version.", + "required": [ + "trainingConfigVersion", + "modelExpirationDate" + ], + "type": "object", + "properties": { + "trainingConfigVersion": { + "description": "Represents the version of the config.", + "type": "string" + }, + "modelExpirationDate": { + "format": "date", + "description": "Represents the training config version expiration date.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingConfigVersion" + }, + "TextAnalysisAuthoringTrainingConfigVersions": { + "description": "Represents a list of training config versions.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of the training config versions.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingConfigVersion" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingConfigVersions" + }, + "TextAnalysisAuthoringTrainingJobOptions": { + "description": "Represents the options for starting a new training job.", + "required": [ + "modelLabel", + "trainingConfigVersion" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents the output model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "evaluationOptions": { + "description": "Represents the evaluation options. By default, the evaluation kind is percentage, with training split percentage as 80, and testing split percentage as 20.", + "$ref": "#/definitions/TextAnalysisAuthoringEvaluationOptions" + } + }, + "x-ms-client-name": "TrainingJobOptions" + }, + "TextAnalysisAuthoringTrainingJobResult": { + "description": "Represents the output of a training job.", + "required": [ + "modelLabel", + "trainingConfigVersion", + "trainingStatus" + ], + "type": "object", + "properties": { + "modelLabel": { + "description": "Represents trained model label.", + "type": "string" + }, + "trainingConfigVersion": { + "description": "Represents training config version.", + "type": "string" + }, + "trainingStatus": { + "description": "Represents model train status.", + "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" + }, + "evaluationStatus": { + "description": "Represents model evaluation status.", + "$ref": "#/definitions/TextAnalysisAuthoringSubTrainingJobState" + }, + "estimatedEndDateTime": { + "format": "date-time", + "description": "Represents the estimate end date time for training and evaluation.", + "type": "string" + } + }, + "x-ms-client-name": "TrainingJobResult" + }, + "TextAnalysisAuthoringTrainingJobs": { + "description": "Represents a list of retrieved training jobs.", + "required": [ + "value", + "nextLink" + ], + "type": "object", + "properties": { + "value": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobState" + } + }, + "nextLink": { + "description": "The next page link.", + "type": "string", + "x-nullable": true + } + }, + "x-ms-client-name": "TrainingJobs" + }, + "TextAnalysisAuthoringTrainingJobState": { + "description": "Represents the state of a training job.", + "required": [ + "result" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TextAnalysisAuthoringJobState" + } + ], + "properties": { + "result": { + "description": "Represents training tasks detailed result.", + "$ref": "#/definitions/TextAnalysisAuthoringTrainingJobResult" + } + }, + "x-ms-client-name": "TrainingJobState" + }, + "TextAnalysisAuthoringUnassignDeploymentResourcesOptions": { + "description": "Represents the options to unassign Azure resources from a project.", + "required": [ + "assignedResourceIds" + ], + "type": "object", + "properties": { + "assignedResourceIds": { + "description": "Represents the assigned resource IDs to be unassigned.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-client-name": "UnassignDeploymentResourcesOptions" + }, + "TextAnalysisAuthoringWarning": { + "description": "Represents a warning that was encountered while executing the request.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The warning code.", + "type": "string" + }, + "message": { + "description": "The warning message.", + "type": "string" + } + }, + "x-ms-client-name": "Warning" + } + }, + "parameters": { + "TextAnalysisAuthoringStringIndexTypeQueryParameter": { + "in": "query", + "name": "stringIndexType", + "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets.", + "required": true, + "type": "string", + "enum": [ + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "Utf16CodeUnit", + "description": "The offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextAnalysisAuthoringJobIdPathParameter": { + "in": "path", + "name": "jobId", + "description": "The job ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TextAnalysisAuthoringExportedModelNamePathParameter": { + "in": "path", + "name": "exportedModelName", + "description": "The exported model name.", + "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" + }, + "TextAnalysisAuthoringProjectKindQueryOptionalParameter": { + "in": "query", + "name": "projectKind", + "description": "The project kind, default value is CustomSingleLabelClassification.", + "type": "string", + "enum": [ + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "CustomEntityRecognition", + "CustomAbstractiveSummarization", + "CustomHealthcare", + "CustomTextSentiment" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "CustomSingleLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." + }, + { + "value": "CustomMultiLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." + }, + { + "value": "CustomEntityRecognition", + "description": "For building an extraction model to identify your domain categories using your own data." + }, + { + "value": "CustomAbstractiveSummarization", + "description": "For building an abstractive summarization models which are able to summarize long documents." + }, + { + "value": "CustomHealthcare", + "description": "For building an text analytics for health model to identify your health domain data." + }, + { + "value": "CustomTextSentiment", + "description": "For building a sentiment models which are able to extract sentiment for long documents." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "TextAnalysisAuthoringProjectKindQueryParameter": { + "in": "query", + "name": "projectKind", + "description": "The project kind.", + "required": true, + "type": "string", + "enum": [ + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "CustomEntityRecognition", + "CustomAbstractiveSummarization", + "CustomHealthcare", + "CustomTextSentiment" + ], + "x-ms-enum": { + "name": "ProjectKind", + "modelAsString": true, + "values": [ + { + "value": "CustomSingleLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file will have only one label. For example, file 1 is classified as A and file 2 is classified as B." + }, + { + "value": "CustomMultiLabelClassification", + "description": "For building a classification model to classify text using your own data. Each file can have one or many labels. For example, file 1 is classified as A, B, and C and file 2 is classified as B and C." + }, + { + "value": "CustomEntityRecognition", + "description": "For building an extraction model to identify your domain categories using your own data." + }, + { + "value": "CustomAbstractiveSummarization", + "description": "For building an abstractive summarization models which are able to summarize long documents." + }, + { + "value": "CustomHealthcare", + "description": "For building an text analytics for health model to identify your health domain data." + }, + { + "value": "CustomTextSentiment", + "description": "For building a sentiment models which are able to extract sentiment for long documents." + } + ] + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json new file mode 100644 index 000000000000..c7bf4af33b69 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/analyzetext.json @@ -0,0 +1,4964 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Text Analysis", + "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/azure/cognitive-services/language-service/overview.", + "version": "2023-11-15-preview" + }, + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + } + }, + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://cognitiveservices.azure.com/.default" + ] + }, + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/:analyze-text": { + "post": { + "summary": "Request text analysis over a collection of documents.", + "description": "Submit a collection of text documents for analysis. Specify a single unique task to be executed immediately.", + "operationId": "AnalyzeText", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/ShowStats" + }, + { + "description": "Collection of documents to analyze and a single task to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeTextTask" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "A successful call result", + "schema": { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Entity Linking Request": { + "$ref": "./examples/text/SuccessfulEntityLinkingRequest.json" + }, + "Successful Entity Recognition Request": { + "$ref": "./examples/text/SuccessfulEntityRecognitionRequest.json" + }, + "Successful Entity Recognition Inclusion Request": { + "$ref": "./examples/text/SuccessfulEntityRecognitionInclusionRequest.json" + }, + "Successful Entity Recognition Exclusion Request": { + "$ref": "./examples/text/SuccessfulEntityRecognitionExclusionRequest.json" + }, + "Successful Entity Recognition Overlap Policy Request": { + "$ref": "./examples/text/SuccessfulEntityRecognitionOverlapPolicy.json" + }, + "Successful Entity Recognition InferenceOptions Request": { + "$ref": "./examples/text/SuccessfulEntityRecognitionInferenceOptionsRequest.json" + }, + "Successful Key Phrase Extraction Request": { + "$ref": "./examples/text/SuccessfulKeyPhraseExtractionRequest.json" + }, + "Successful PII Entity Recognition Request": { + "$ref": "./examples/text/SuccessfulPiiEntityRecognitionRequest.json" + }, + "Successful PII Entity Recognition Redaction Request": { + "$ref": "./examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json" + }, + "Successful PII Entity Recognition Exclusion Request": { + "$ref": "./examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json" + }, + "Successful Language Detection Request": { + "$ref": "./examples/text/SuccessfulLanguageDetectionRequest.json" + }, + "Successful Sentiment Analysis Request": { + "$ref": "./examples/text/SuccessfulSentimentAnalysisRequest.json" + }, + "Successful Dynamic Classification Request": { + "$ref": "./examples/text/SuccessfuDynamicClassificationRequest.json" + } + } + } + }, + "/analyze-text/jobs": { + "post": { + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "description": "Submit a collection of text documents for analysis. Specify one or more unique tasks to be executed as a long-running operation.", + "operationId": "AnalyzeText_SubmitJob", + "summary": "Submit text analysis job", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Collection of documents to analyze and one or more tasks to execute.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/AnalyzeTextJobsInput" + }, + "required": true + } + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Submit Analysis Job Request": { + "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json" + }, + "Successful Healthcare Post Request": { + "$ref": "./examples/text/SuccessfulHealthcarePostRequest.json" + }, + "Successful Custom Healthcare Post Request": { + "$ref": "./examples/text/SuccessfulCustomHealthcarePostRequest.json" + }, + "Successful Submit Abstractive Summarization Task": { + "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json" + }, + "Successful Submit Custom Abstractive Summarization Task": { + "$ref": "./examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json" + }, + "Successful Healthcare DocumentType Post Request": { + "$ref": "./examples/text/SuccessfulHealthcareDocumentTypePostRequest.json" + }, + "Successful Custom Sentiment Analysis Post Request": { + "$ref": "./examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/analyze-text/jobs/{jobId}": { + "get": { + "produces": [ + "application/json" + ], + "description": "Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are succeeded, the job will transition to the succeeded state and results will be available for each task.", + "operationId": "AnalyzeText_JobStatus", + "summary": "Get analysis status and results", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/JobId" + }, + { + "$ref": "common.json#/parameters/ShowStats" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + } + ], + "responses": { + "200": { + "description": "Analysis job status and metadata.", + "schema": { + "$ref": "#/definitions/AnalyzeTextJobState" + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Get Text Analysis Job Status Request": { + "$ref": "./examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json" + }, + "Successful Get Text Analysis Health Request": { + "$ref": "./examples/text/SuccessfulHealthcareTaskStatusRequest.json" + }, + "Successful Get Text Analysis Custom Health Request": { + "$ref": "./examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json" + }, + "Successful Get Abstractive Summarization Result": { + "$ref": "./examples/text/SuccessfulAbstractiveSummarizationTaskResult.json" + }, + "Successful Get Custom Abstractive Summarization Result": { + "$ref": "./examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json" + }, + "Successful Get Text Analysis Health DocumentType Request": { + "$ref": "./examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json" + }, + "Successful Get Text Analysis Custom Sentiment Analysis Request": { + "$ref": "./examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json" + } + } + } + }, + "/analyze-text/jobs/{jobId}:cancel": { + "post": { + "produces": [ + "application/json" + ], + "description": "Cancel a long-running Text Analysis job.", + "operationId": "AnalyzeText_CancelJob", + "summary": "Cancel a long-running Text Analysis job", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/JobId" + } + ], + "responses": { + "202": { + "description": "Cancel Job request has been received.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Unexpected error", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful Job Delete Request": { + "$ref": "./examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json" + } + }, + "x-ms-long-running-operation": true + } + } + }, + "definitions": { + "AnalyzeTextTaskKind": { + "type": "string", + "description": "Enumeration of supported Text Analysis tasks.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "LanguageDetection", + "EntityLinking", + "DynamicClassification" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskKind", + "modelAsString": true + } + }, + "AnalyzeTextLROTaskKind": { + "type": "string", + "description": "Enumeration of supported long-running Text Analysis tasks.", + "enum": [ + "SentimentAnalysis", + "EntityRecognition", + "PiiEntityRecognition", + "KeyPhraseExtraction", + "EntityLinking", + "Healthcare", + "CustomHealthcare", + "ExtractiveSummarization", + "CustomEntityRecognition", + "CustomSingleLabelClassification", + "CustomMultiLabelClassification", + "AbstractiveSummarization", + "CustomSentimentAnalysis", + "CustomAbstractiveSummarization" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROTaskKind", + "modelAsString": true + } + }, + "AnalyzeTextTaskResultsKind": { + "type": "string", + "description": "Enumeration of supported Text Analysis task results.", + "enum": [ + "SentimentAnalysisResults", + "EntityRecognitionResults", + "PiiEntityRecognitionResults", + "KeyPhraseExtractionResults", + "LanguageDetectionResults", + "EntityLinkingResults", + "DynamicClassificationResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextTaskResultsKind", + "modelAsString": true + } + }, + "AnalyzeTextLROResultsKind": { + "type": "string", + "description": "Enumeration of supported Text Analysis long-running operation task results.", + "enum": [ + "SentimentAnalysisLROResults", + "EntityRecognitionLROResults", + "PiiEntityRecognitionLROResults", + "KeyPhraseExtractionLROResults", + "EntityLinkingLROResults", + "HealthcareLROResults", + "CustomHealthcareLROResults", + "ExtractiveSummarizationLROResults", + "CustomEntityRecognitionLROResults", + "CustomSingleLabelClassificationLROResults", + "CustomMultiLabelClassificationLROResults", + "AbstractiveSummarizationLROResults", + "CustomSentimentAnalysisLROResults", + "CustomAbstractiveSummarizationLROResults" + ], + "x-ms-enum": { + "name": "AnalyzeTextLROResultsKind", + "modelAsString": true + } + }, + "MultiLanguageAnalysisInput": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/MultiLanguageInput" + } + } + } + }, + "LanguageDetectionAnalysisInput": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageInput" + } + } + } + }, + "AnalyzeTextTask": { + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskKind" + } + } + }, + "AnalyzeTextLROTask": { + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextLROTaskKind" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/TaskIdentifier" + } + ] + }, + "AnalyzeTextTaskResult": { + "type": "object", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextTaskResultsKind" + } + } + }, + "AnalyzeTextEntityLinkingInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "AnalyzeTextEntityRecognitionInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "AnalyzeTextKeyPhraseExtractionInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "AnalyzeTextPiiEntitiesRecognitionInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/PiiTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "AnalyzeTextLanguageDetectionInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/LanguageDetectionAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/LanguageDetectionTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "LanguageDetection" + }, + "AnalyzeTextSentimentAnalysisInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "AnalyzeTextDynamicClassificationInput": { + "type": "object", + "properties": { + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "parameters": { + "$ref": "#/definitions/DynamicClassificationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTask" + } + ], + "x-ms-discriminator-value": "DynamicClassification" + }, + "AnalyzeTextJobsInput": { + "type": "object", + "properties": { + "displayName": { + "description": "Optional display name for the analysis job.", + "type": "string" + }, + "defaultLanguage": { + "description": "Default language to use for records requesting automatic language detection.", + "type": "string" + }, + "analysisInput": { + "$ref": "#/definitions/MultiLanguageAnalysisInput" + }, + "tasks": { + "description": "The set of tasks to execute on the input documents.", + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + } + }, + "required": [ + "analysisInput", + "tasks" + ] + }, + "CustomEntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Entities task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomTaskParameters" + } + ] + }, + "CustomEntitiesLROTask": { + "type": "object", + "description": "Use custom models to ease the process of information extraction from unstructured documents like contracts or financial documents", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomEntitiesTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomEntityRecognition" + }, + "CustomEntitiesResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntitiesDocumentResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "EntitiesDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Single entities recognition result with detected language.", + "allOf": [ + { + "$ref": "#/definitions/EntitiesDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "CustomSingleLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Single Classification task.", + "allOf": [ + { + "$ref": "common.json#/definitions/CustomTaskParameters" + } + ] + }, + "CustomSingleLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into single label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomSingleLabelClassificationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomSingleLabelClassification" + }, + "CustomLabelClassificationResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ClassificationDocumentResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "ClassificationDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Classification document result with language detection.", + "allOf": [ + { + "$ref": "#/definitions/ClassificationDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "ClassificationResult": { + "type": "object", + "required": [ + "category", + "confidenceScore" + ], + "properties": { + "category": { + "type": "string", + "description": "Classification type." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the recognized class." + } + } + }, + "CustomMultiLabelClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Multi Classification task.", + "allOf": [ + { + "$ref": "common.json#/definitions/CustomTaskParameters" + } + ] + }, + "CustomMultiLabelClassificationLROTask": { + "type": "object", + "description": "Use custom models to classify text into multi label taxonomy", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomMultiLabelClassificationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomMultiLabelClassification" + }, + "ClassificationDocumentResult": { + "type": "object", + "properties": { + "class": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationResult" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "class" + ] + }, + "DynamicClassificationDocumentResult": { + "type": "object", + "properties": { + "classifications": { + "type": "array", + "items": { + "$ref": "#/definitions/ClassificationResult" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "classifications" + ] + }, + "HealthcareTaskParameters": { + "type": "object", + "description": "Supported parameters for a Healthcare task.", + "properties": { + "fhirVersion": { + "type": "string", + "description": "The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.", + "enum": [ + "4.0.1" + ], + "x-ms-enum": { + "name": "fhirVersion", + "modelAsString": true + } + }, + "documentType": { + "x-ms-enum": { + "name": "healthcareDocumentType", + "modelAsString": true + }, + "type": "string", + "description": "Document type that can be provided as input for Fhir Documents. Expect to have fhirVersion provided when used. Behavior of using None enum is the same as not using the documentType parameter.", + "enum": [ + "None", + "ClinicalTrial", + "DischargeSummary", + "ProgressNote", + "HistoryAndPhysical", + "Consult", + "Imaging", + "Pathology", + "ProcedureNote" + ] + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "CustomHealthcareTaskParameters": { + "type": "object", + "description": "Supported parameters for a custom Healthcare task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomTaskParameters" + } + ] + }, + "HealthcareLROTask": { + "type": "object", + "properties": { + "parameters": { + "$ref": "#/definitions/HealthcareTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "Healthcare" + }, + "CustomHealthcareLROTask": { + "type": "object", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomHealthcareTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomHealthcare" + }, + "HealthcareResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "CustomHealthcareResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomHealthcareEntitiesDocumentResultWithDocumentDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "HealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthcareEntitiesDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "CustomHealthcareEntitiesDocumentResultWithDocumentDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomHealthcareEntitiesDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "HealthcareEntitiesDocumentResult": { + "type": "object", + "properties": { + "entities": { + "description": "Healthcare entities.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + }, + "fhirBundle": { + "type": "object", + "description": "JSON bundle containing a FHIR compatible object for consumption in other Healthcare tools. For additional information see https://www.hl7.org/fhir/overview.html.", + "additionalProperties": {} + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "entities", + "relations" + ] + }, + "CustomHealthcareEntitiesDocumentResult": { + "type": "object", + "properties": { + "entities": { + "description": "Healthcare entities.", + "type": "array", + "items": { + "$ref": "#/definitions/CustomHealthcareEntity" + } + }, + "relations": { + "type": "array", + "description": "Healthcare entity relations.", + "items": { + "$ref": "#/definitions/HealthcareRelation" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "entities", + "relations" + ] + }, + "HealthcareEntity": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "x-ms-enum": { + "name": "healthcareEntityCategory", + "modelAsString": true + }, + "type": "string", + "description": "Healthcare Entity Category.", + "enum": [ + "BodyStructure", + "Age", + "Gender", + "Ethnicity", + "ExaminationName", + "Date", + "Direction", + "Frequency", + "MeasurementValue", + "MeasurementUnit", + "RelationalOperator", + "Time", + "Course", + "GeneOrProtein", + "Variant", + "Expression", + "MutationType", + "AdministrativeEvent", + "CareEnvironment", + "HealthcareProfession", + "Diagnosis", + "SymptomOrSign", + "ConditionQualifier", + "ConditionScale", + "MedicationClass", + "MedicationName", + "Dosage", + "MedicationForm", + "MedicationRoute", + "FamilyRelation", + "TreatmentName", + "Allergen", + "Employment", + "LivingStatus", + "SubstanceUse", + "SubstanceUseAmount" + ] + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + }, + "assertion": { + "type": "object", + "$ref": "#/definitions/HealthcareAssertion" + }, + "name": { + "description": "Preferred name for the entity. Example: 'histologically' would have a 'name' of 'histologic'.", + "type": "string" + }, + "links": { + "description": "Entity references in known data sources.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareEntityLink" + } + } + }, + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ] + }, + "CustomHealthcareEntity": { + "type": "object", + "properties": { + "entityComponentInformation": { + "description": "(Optional) Entity component information listing fired components of the extracted entity. This object only applies for custom healthcare.", + "type": "array", + "items": { + "$ref": "#/definitions/EntityComponentInformation" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/HealthcareEntity" + } + ] + }, + "HealthcareRelation": { + "type": "object", + "description": "Every relation is an entity graph of a certain relationType, where all entities are connected and have specific roles within the relation context.", + "required": [ + "relationType", + "entities" + ], + "properties": { + "relationType": { + "description": "Type of relation. Examples include: `DosageOfMedication` or 'FrequencyOfMedication', etc.", + "type": "string", + "enum": [ + "Abbreviation", + "BodySiteOfCondition", + "BodySiteOfTreatment", + "CourseOfCondition", + "CourseOfExamination", + "CourseOfMedication", + "CourseOfTreatment", + "DirectionOfBodyStructure", + "DirectionOfCondition", + "DirectionOfExamination", + "DirectionOfTreatment", + "DosageOfMedication", + "ExaminationFindsCondition", + "ExpressionOfGene", + "ExpressionOfVariant", + "FormOfMedication", + "FrequencyOfCondition", + "FrequencyOfMedication", + "FrequencyOfTreatment", + "MutationTypeOfGene", + "MutationTypeOfVariant", + "QualifierOfCondition", + "RelationOfExamination", + "RouteOfMedication", + "ScaleOfCondition", + "TimeOfCondition", + "TimeOfEvent", + "TimeOfExamination", + "TimeOfMedication", + "TimeOfTreatment", + "UnitOfCondition", + "UnitOfExamination", + "ValueOfCondition", + "ValueOfExamination", + "VariantOfGene" + ], + "x-ms-enum": { + "name": "relationType", + "modelAsString": true + } + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted relation." + }, + "entities": { + "description": "The entities in the relation.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthcareRelationEntity" + } + } + } + }, + "HealthcareAssertion": { + "type": "object", + "properties": { + "conditionality": { + "description": "Describes any conditionality on the entity.", + "type": "string", + "enum": [ + "hypothetical", + "conditional" + ], + "x-ms-enum": { + "name": "Conditionality", + "modelAsString": false + } + }, + "certainty": { + "description": "Describes the entities certainty and polarity.", + "type": "string", + "enum": [ + "positive", + "positivePossible", + "neutralPossible", + "negativePossible", + "negative" + ], + "x-ms-enum": { + "name": "Certainty", + "modelAsString": false + } + }, + "association": { + "description": "Describes if the entity is the subject of the text or if it describes someone else.", + "type": "string", + "enum": [ + "subject", + "other" + ], + "x-ms-enum": { + "name": "Association", + "modelAsString": false + } + }, + "temporality": { + "description": "Describes temporal information regarding the entity.", + "type": "string", + "enum": [ + "current", + "past", + "future" + ], + "x-ms-enum": { + "name": "Temporality", + "modelAsString": false + } + } + } + }, + "HealthcareRelationEntity": { + "type": "object", + "required": [ + "ref", + "role" + ], + "properties": { + "ref": { + "description": "Reference link object, using a JSON pointer RFC 6901 (URI Fragment Identifier Representation), pointing to the entity .", + "type": "string" + }, + "role": { + "description": "Role of entity in the relationship. For example: 'CD20-positive diffuse large B-cell lymphoma' has the following entities with their roles in parenthesis: CD20 (GeneOrProtein), Positive (Expression), diffuse large B-cell lymphoma (Diagnosis).", + "type": "string" + } + } + }, + "HealthcareEntityLink": { + "type": "object", + "required": [ + "dataSource", + "id" + ], + "properties": { + "dataSource": { + "description": "Entity Catalog. Examples include: UMLS, CHV, MSH, etc.", + "type": "string" + }, + "id": { + "description": "Entity id in the given source catalog.", + "type": "string" + } + } + }, + "EntityComponentInformation": { + "description": "This object contains information of the detected entity components. The possible component types may expand in the future. Parsing code should handle unexpected values gracefully", + "type": "object", + "discriminator": "entityComponentKind", + "properties": { + "entityComponentKind": { + "description": "The component object kind.", + "type": "string", + "enum": [ + "PrebuiltComponent", + "LearnedComponent", + "ListComponent" + ], + "x-ms-enum": { + "name": "entityComponentKind", + "modelAsString": true + } + } + }, + "required": [ + "entityComponentKind" + ] + }, + "PrebuiltComponent": { + "description": "This object contains information of the prebuilt component of the detected entity.", + "allOf": [ + { + "$ref": "#/definitions/EntityComponentInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "PrebuiltComponent", + "properties": { + "value": { + "type": "string", + "description": "The prebuilt component of an extracted entity type." + } + } + }, + "LearnedComponent": { + "description": "This object contains information of the learned component of the detected entity.", + "allOf": [ + { + "$ref": "#/definitions/EntityComponentInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "LearnedComponent", + "properties": { + "value": { + "type": "string", + "description": "The learned component of an extracted entity type." + } + } + }, + "ListComponent": { + "description": "This object contains information of the list component of the detected entity.", + "allOf": [ + { + "$ref": "#/definitions/EntityComponentInformation" + } + ], + "type": "object", + "x-ms-discriminator-value": "ListComponent", + "properties": { + "value": { + "type": "string", + "description": "The list key of an extracted entity type." + } + } + }, + "SentimentAnalysisTaskParameters": { + "type": "object", + "description": "Supported parameters for a Sentiment Analysis task.", + "properties": { + "opinionMining": { + "type": "boolean", + "default": false + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "SentimentAnalysisLROTask": { + "type": "object", + "description": "An object representing the task definition for a Sentiment Analysis task.", + "properties": { + "parameters": { + "$ref": "#/definitions/SentimentAnalysisTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "SentimentAnalysis" + }, + "SentimentTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "SentimentAnalysisResults" + }, + "SentimentResponse": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Sentiment analysis per document.", + "items": { + "$ref": "#/definitions/SentimentDocumentResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "SentimentDocumentResultWithDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SentimentDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "CustomSentimentDocumentResult": { + "type": "object", + "properties": { + "sentiment": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "sentences": { + "type": "array", + "description": "Sentence level sentiment analysis.", + "items": { + "$ref": "#/definitions/CustomSentenceSentiment" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "sentiment", + "confidenceScores", + "sentences" + ] + }, + "CustomSentenceSentiment": { + "type": "object", + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + } + } + }, + "SentimentDocumentResult": { + "type": "object", + "properties": { + "sentiment": { + "type": "string", + "description": "Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "DocumentSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "Document level sentiment confidence scores between 0 and 1 for each sentiment class.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "sentences": { + "type": "array", + "description": "Sentence level sentiment analysis.", + "items": { + "$ref": "#/definitions/SentenceSentiment" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "sentiment", + "confidenceScores", + "sentences" + ] + }, + "SentimentConfidenceScorePerLabel": { + "type": "object", + "required": [ + "positive", + "neutral", + "negative" + ], + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "neutral": { + "type": "number", + "format": "double", + "description": "Confidence score for neutral sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." + }, + "SentenceSentiment": { + "type": "object", + "required": [ + "text", + "sentiment", + "confidenceScores", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The sentence text." + }, + "sentiment": { + "type": "string", + "description": "The predicted Sentiment for the sentence.", + "enum": [ + "positive", + "neutral", + "negative" + ], + "x-ms-enum": { + "name": "SentenceSentimentValue", + "modelAsString": false + } + }, + "confidenceScores": { + "description": "The sentiment confidence score between 0 and 1 for the sentence for all classes.", + "$ref": "#/definitions/SentimentConfidenceScorePerLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + }, + "targets": { + "type": "array", + "description": "The array of sentence targets for the sentence.", + "items": { + "$ref": "#/definitions/SentenceTarget" + } + }, + "assessments": { + "type": "array", + "description": "The array of assessments for the sentence.", + "items": { + "$ref": "#/definitions/SentenceAssessment" + } + } + } + }, + "SentenceTarget": { + "type": "object", + "required": [ + "confidenceScores", + "length", + "offset", + "relations", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Targeted sentiment in the sentence." + }, + "confidenceScores": { + "description": "Target sentiment confidence scores for the target in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The target offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the target." + }, + "text": { + "type": "string", + "description": "The target text detected." + }, + "relations": { + "type": "array", + "description": "The array of either assessment or target objects which is related to the target.", + "items": { + "$ref": "#/definitions/TargetRelation" + } + } + } + }, + "SentenceAssessment": { + "type": "object", + "required": [ + "confidenceScores", + "isNegated", + "length", + "offset", + "sentiment", + "text" + ], + "properties": { + "sentiment": { + "type": "string", + "enum": [ + "positive", + "mixed", + "negative" + ], + "x-ms-enum": { + "name": "TokenSentimentValue", + "modelAsString": false + }, + "description": "Assessment sentiment in the sentence." + }, + "confidenceScores": { + "description": "Assessment sentiment confidence scores in the sentence.", + "$ref": "#/definitions/TargetConfidenceScoreLabel" + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The assessment offset from the start of the sentence." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the assessment." + }, + "text": { + "type": "string", + "description": "The assessment text detected." + }, + "isNegated": { + "type": "boolean", + "description": "The indicator representing if the assessment is negated." + } + } + }, + "TargetRelation": { + "type": "object", + "required": [ + "ref", + "relationType" + ], + "properties": { + "relationType": { + "type": "string", + "enum": [ + "assessment", + "target" + ], + "x-ms-enum": { + "name": "TargetRelationType", + "modelAsString": false + }, + "description": "The type related to the target." + }, + "ref": { + "type": "string", + "description": "The JSON pointer indicating the linked object." + } + } + }, + "TargetConfidenceScoreLabel": { + "type": "object", + "required": [ + "negative", + "positive" + ], + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "description": "Represents the confidence scores across all sentiment classes: positive and negative." + }, + "CustomSentimentAnalysisTaskParameters": { + "type": "object", + "description": "Supported parameters for a Custom Sentiment Analysis task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomTaskParameters" + } + ] + }, + "CustomSentimentAnalysisLROTask": { + "type": "object", + "description": "Use custom models to ease the process of sentiment analysis from documents like product reviews", + "properties": { + "parameters": { + "$ref": "#/definitions/CustomSentimentAnalysisTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomSentimentAnalysis" + }, + "CustomSentimentAnalysisResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Sentiment analysis per document.", + "items": { + "$ref": "#/definitions/CustomSentimentAnalysisResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "CustomSentimentAnalysisResultWithDetectedLanguage": { + "description": "Custom Sentiment analysis result on one document with detected language", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CustomSentimentDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "EntityList": { + "description": "(Optional) describes the entity categories.", + "items": { + "type": "string", + "enum": [ + "Address", + "Numeric", + "Age", + "Currency", + "Number", + "NumberRange", + "Percentage", + "Ordinal", + "Temperature", + "Dimension", + "Length", + "Weight", + "Height", + "Speed", + "Area", + "Volume", + "Information", + "Temporal", + "Date", + "Time", + "DateTime", + "DateRange", + "TimeRange", + "DateTimeRange", + "Duration", + "SetTemporal", + "Event", + "SportsEvent", + "CulturalEvent", + "NaturalEvent", + "Location", + "GPE", + "City", + "State", + "CountryRegion", + "Continent", + "Structural", + "Airport", + "Geological", + "Organization", + "OrganizationMedical", + "OrganizationStockExchange", + "OrganizationSports", + "Person", + "PersonType", + "Email", + "URL", + "IP", + "PhoneNumber", + "Product", + "ComputingProduct", + "Skill" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "Address", + "description": "Specific street-level mentions of locations: house/building numbers, streets, avenues, highways, intersections referenced by name." + }, + { + "value": "Numeric", + "description": "Numeric values, including digits and number words." + }, + { + "value": "Age", + "description": "Age-related values." + }, + { + "value": "Currency", + "description": "Currency-related values." + }, + { + "value": "Number", + "description": "Numbers without a unit" + }, + { + "value": "NumberRange", + "description": "Range of Numbers" + }, + { + "value": "Percentage", + "description": "Percentage-related values." + }, + { + "value": "Ordinal", + "description": "Ordinal numbers." + }, + { + "value": "Temperature", + "description": "Temperature-related values." + }, + { + "value": "Dimension", + "description": "Dimension of measurements" + }, + { + "value": "Length", + "description": "Length of an object." + }, + { + "value": "Weight", + "description": "Weight of an object." + }, + { + "value": "Height", + "description": "Height of an object." + }, + { + "value": "Speed", + "description": "Speed of an object." + }, + { + "value": "Area", + "description": "Area of an object." + }, + { + "value": "Volume", + "description": "Volume of an object." + }, + { + "value": "Information", + "description": "Unit of measure for digital information." + }, + { + "value": "Temporal", + "description": "Items relating to time." + }, + { + "value": "Date", + "description": "Calendar dates." + }, + { + "value": "Time", + "description": "Times of day." + }, + { + "value": "DateTime", + "description": "Calendar dates with time." + }, + { + "value": "DateRange", + "description": "Range of dates." + }, + { + "value": "TimeRange", + "description": "Range of times." + }, + { + "value": "DateTimeRange", + "description": "Range of date and time." + }, + { + "value": "Duration", + "description": "Duration of time." + }, + { + "value": "SetTemporal", + "description": "Set of time-related values." + }, + { + "value": "Event", + "description": "Social, sports, business, political, educational, natural, historical, criminal, violent, legal, military events with a timed period." + }, + { + "value": "SportsEvent", + "description": "Sports event-related values." + }, + { + "value": "CulturalEvent", + "description": "Cultural event-related values." + }, + { + "value": "NaturalEvent", + "description": "Natural event-related values." + }, + { + "value": "Location", + "description": "Particular point or place in physical space." + }, + { + "value": "GPE", + "description": "Cities, countries/regions, states.", + "name": "GeoPoliticalEntity" + }, + { + "value": "City", + "description": "City-related values." + }, + { + "value": "State", + "description": "State-related values." + }, + { + "value": "CountryRegion", + "description": "Country or region-related values." + }, + { + "value": "Continent", + "description": "Continent-related values." + }, + { + "value": "Structural", + "description": "Manmade structures." + }, + { + "value": "Airport", + "description": "Airports." + }, + { + "value": "Geological", + "description": " Geographic and natural features such as rivers, oceans, and deserts." + }, + { + "value": "Organization", + "description": "Corporations, agencies, and other groups of people defined by some established organizational structure. These labels can include companies, political parties/movements, musical bands, sport clubs, government bodies, and public organizations. Nationalities or religions are not ORGANIZATION." + }, + { + "value": "OrganizationMedical", + "description": "Medical companies and groups." + }, + { + "value": "OrganizationStockExchange", + "description": "Stock exchange groups." + }, + { + "value": "OrganizationSports", + "description": "Sports-related organizations." + }, + { + "value": "Person", + "description": "First, last, and middle names, names of fictional characters, and aliases. Titles, such as “Mr.” or “President”, are not considered part of the named entity." + }, + { + "value": "PersonType", + "description": "Human roles classified by a group membership." + }, + { + "value": "Email", + "description": "Email addresses." + }, + { + "value": "URL", + "description": "URLs to websites." + }, + { + "value": "IP", + "description": "network IP addresses." + }, + { + "value": "PhoneNumber", + "description": "Phone numbers (US and EU phone numbers only)." + }, + { + "value": "Product", + "description": "Single or group of commercial, consumable objects, electronics, vehicles, food groups." + }, + { + "value": "ComputingProduct", + "description": "Computing products." + }, + { + "value": "Skill", + "description": "A capability, skill, or expertise." + } + ] + } + }, + "type": "array", + "uniqueItems": true + }, + "BaseEntityOverlapPolicy": { + "description": "The abstract base class for entity OverlapPolicy.", + "type": "object", + "discriminator": "policyKind", + "properties": { + "policyKind": { + "description": "The entity OverlapPolicy object kind.", + "type": "string", + "default": "matchLongest", + "enum": [ + "matchLongest", + "allowOverlap" + ], + "x-ms-enum": { + "name": "policyKind", + "modelAsString": true + } + } + }, + "required": [ + "policyKind" + ] + }, + "EntityInferenceOptions": { + "description": "The class that house the inference options allowed for named entity recognition.", + "type": "object", + "properties": { + "excludeNormalizedValues": { + "description": "Option to include/exclude the detected entity values to be normalized and included in the metadata. The numeric and temporal entity types support value normalization.", + "type": "boolean", + "default": "false" + } + } + }, + "MatchLongestEntityPolicyType": { + "description": "Represents the Match longest overlap policy. No overlapping entities as far as it is possible. 1. If there are overlapping entities, the longest one will be returned. 2. If the set of characters predicted for 2 or more entities are exactly the same, select the entity that has the higher confidence score.3. If the entity scores are identical, return all entities that are still present after applying the previous rules. 3. If there is partial overlap (as in Hello Text Analytics) follow the above steps starting from 1. ", + "allOf": [ + { + "$ref": "#/definitions/BaseEntityOverlapPolicy" + } + ], + "type": "object", + "x-ms-discriminator-value": "matchLongest" + }, + "AllowOverlapEntityPolicyType": { + "description": "Represents the allow overlap policy. Will apply no post processing logic for the entities. Whatever the model predicts is what will be returned to the user. This allows the user to get a full view of every single model's possible values and apply their own custom logic on entity selection", + "allOf": [ + { + "$ref": "#/definitions/BaseEntityOverlapPolicy" + } + ], + "type": "object", + "x-ms-discriminator-value": "allowOverlap" + }, + "EntitiesTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Recognition task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + }, + "inclusionList": { + "description": "(Optional) request parameter that limits the output to the requested entity types included in this list. We will apply inclusionList before exclusionList", + "$ref": "#/definitions/EntityList" + }, + "exclusionList": { + "description": "(Optional) request parameter that filters out any entities that are included the excludeList. When a user specifies an excludeList, they cannot get a prediction returned with an entity in that list. We will apply inclusionList before exclusionList", + "$ref": "#/definitions/EntityList" + }, + "overlapPolicy": { + "description": "(Optional) describes the type of overlap policy to apply to the ner output.", + "$ref": "#/definitions/BaseEntityOverlapPolicy" + }, + "inferenceOptions": { + "description": "(Optional) request parameter that allows the user to provide settings for running the inference.", + "$ref": "#/definitions/EntityInferenceOptions" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "EntitiesLROTask": { + "type": "object", + "description": "An object representing the task definition for an Entities Recognition task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntitiesTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityRecognition" + }, + "EntitiesTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityRecognitionResults" + }, + "EntitiesResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntitiesResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "EntitiesResultWithDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EntitiesDocumentResultWithMetadata" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "EntitiesDocumentResult": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "entities" + ] + }, + "EntitiesDocumentResultWithMetadata": { + "type": "object", + "properties": { + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/EntityWithMetadata" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "entities" + ] + }, + "EntityTag": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Tags are to express some similarities/affinity between entities. Entity Tags will be unique globally." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Detection score between 0 and 1 of the extracted entity." + } + }, + "required": [ + "name" + ] + }, + "Entity": { + "type": "object", + "required": [ + "text", + "category", + "offset", + "length", + "confidenceScore" + ], + "properties": { + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "category": { + "type": "string", + "description": "Entity type." + }, + "subcategory": { + "type": "string", + "description": "(Optional) Entity sub type." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity text. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity text. Use of different 'stringIndexType' values can affect the length returned." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "Confidence score between 0 and 1 of the extracted entity." + } + } + }, + "EntityWithTags": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + } + ], + "type": "object", + "required": [ + "type", + "tags" + ], + "properties": { + "type": { + "type": "string", + "description": "An entity type is the lowest (or finest) granularity at which the entity has been detected. The type maps to the specific metadata attributes associated with the entity detected." + }, + "tags": { + "type": "array", + "description": "List of entity tags. Tags are to express some similarities/affinity between entities.", + "items": { + "$ref": "#/definitions/EntityTag" + } + } + } + }, + "EntityWithMetadata": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EntityWithTags" + } + ], + "properties": { + "metadata": { + "description": "The entity metadata object.", + "type": "object", + "$ref": "#/definitions/BaseMetadata" + } + } + }, + "EntityLinkingTaskParameters": { + "type": "object", + "description": "Supported parameters for an Entity Linking task.", + "properties": { + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "EntityLinkingLROTask": { + "type": "object", + "description": "An object representing the task definition for an Entity Linking task.", + "properties": { + "parameters": { + "$ref": "#/definitions/EntityLinkingTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "EntityLinking" + }, + "EntityLinkingTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityLinkingResults" + }, + "EntityLinkingResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/EntityLinkingResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "EntityLinkingResultWithDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/LinkedEntitiesDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "LinkedEntitiesDocumentResult": { + "type": "object", + "required": [ + "entities" + ], + "properties": { + "entities": { + "type": "array", + "description": "Recognized well known entities in the document.", + "items": { + "$ref": "#/definitions/LinkedEntity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ] + }, + "LinkedEntity": { + "type": "object", + "required": [ + "name", + "matches", + "language", + "url", + "dataSource" + ], + "properties": { + "name": { + "type": "string", + "description": "Entity Linking formal name." + }, + "matches": { + "type": "array", + "description": "List of instances this entity appears in the text.", + "items": { + "$ref": "#/definitions/Match" + } + }, + "language": { + "type": "string", + "description": "Language used in the data source." + }, + "id": { + "type": "string", + "description": "Unique identifier of the recognized entity from the data source." + }, + "url": { + "type": "string", + "description": "URL for the entity's page from the data source." + }, + "dataSource": { + "type": "string", + "description": "Data source used to extract entity linking, such as Wiki/Bing etc." + }, + "bingId": { + "type": "string", + "description": "Bing Entity Search API unique identifier of the recognized entity." + } + } + }, + "AgeUnit": { + "type": "string", + "enum": [ + "Unspecified", + "Year", + "Month", + "Week", + "Day" + ], + "x-ms-enum": { + "name": "AgeUnit", + "modelAsString": true + }, + "description": "The Age Unit of measurement" + }, + "VolumeUnit": { + "type": "string", + "enum": [ + "Unspecified", + "CubicMeter", + "CubicCentimeter", + "CubicMillimeter", + "Hectoliter", + "Decaliter", + "Liter", + "Centiliter", + "Milliliter", + "CubicYard", + "CubicInch", + "CubicFoot", + "CubicMile", + "FluidOunce", + "Teaspoon", + "Tablespoon", + "Pint", + "Quart", + "Cup", + "Gill", + "Pinch", + "FluidDram", + "Barrel", + "Minim", + "Cord", + "Peck", + "Bushel", + "Hogshead" + ], + "x-ms-enum": { + "name": "VolumeUnit", + "modelAsString": true + }, + "description": "The Volume Unit of measurement" + }, + "SpeedUnit": { + "type": "string", + "enum": [ + "Unspecified", + "MetersPerSecond", + "KilometersPerHour", + "KilometersPerMinute", + "KilometersPerSecond", + "MilesPerHour", + "Knots", + "FeetPerSecond", + "FeetPerMinute", + "YardsPerMinute", + "YardsPerSecond", + "MetersPerMillisecond", + "CentimetersPerMillisecond", + "KilometersPerMillisecond" + ], + "x-ms-enum": { + "name": "SpeedUnit", + "modelAsString": true + }, + "description": "The speed Unit of measurement" + }, + "AreaUnit": { + "type": "string", + "enum": [ + "Unspecified", + "SquareKilometer", + "SquareHectometer", + "SquareDecameter", + "SquareDecimeter", + "SquareMeter", + "SquareCentimeter", + "SquareMillimeter", + "SquareInch", + "SquareFoot", + "SquareMile", + "SquareYard", + "Acre" + ], + "x-ms-enum": { + "name": "AreaUnit", + "modelAsString": true + }, + "description": "The area Unit of measurement" + }, + "LengthUnit": { + "type": "string", + "enum": [ + "Unspecified", + "Kilometer", + "Hectometer", + "Decameter", + "Meter", + "Decimeter", + "Centimeter", + "Millimeter", + "Micrometer", + "Nanometer", + "Picometer", + "Mile", + "Yard", + "Inch", + "Foot", + "LightYear", + "Point" + ], + "x-ms-enum": { + "name": "LengthUnit", + "modelAsString": true + }, + "description": "The length Unit of measurement" + }, + "InformationUnit": { + "type": "string", + "enum": [ + "Unspecified", + "Bit", + "Kilobit", + "Megabit", + "Gigabit", + "Terabit", + "Petabit", + "Byte", + "Kilobyte", + "Megabyte", + "Gigabyte", + "Terabyte", + "Petabyte" + ], + "x-ms-enum": { + "name": "InformationUnit", + "modelAsString": true, + "values": [ + { + "value": "Unspecified", + "description": "Unspecified information unit." + }, + { + "value": "Bit", + "description": "Bit information unit. " + }, + { + "value": "Kilobit", + "description": "Kilobit information unit. Usually defined as 1000 bits or 1024 bits." + }, + { + "value": "Megabit", + "description": "Megabit information unit. Usually defined as 1000 kilobits or 1024 kilobits." + }, + { + "value": "Gigabit", + "description": "Gigabit information unit. Usually defined as 1000 megabits or 1024 megabits." + }, + { + "value": "Terabit", + "description": "Terabit information unit. Usually defined as 1000 gigabits or 1024 gigabits." + }, + { + "value": "Petabit", + "description": "Petabit information unit. Usually defined as 1000 terabits or 1024 terabits." + }, + { + "value": "Byte", + "description": "Byte information unit. Usually defined as 8 bits are used to form a byte.." + }, + { + "value": "Kilobyte", + "description": "Kilobyte information unit. Usually defined as 1000 bytes or 1024 bytes." + }, + { + "value": "Megabyte", + "description": "Megabyte information unit. Usually defined as 1000 kilobytes or 1024 kilobytes." + }, + { + "value": "Gigabyte", + "description": "Gigabyte information unit. Usually defined as 1000 megabytes or 1024 megabytes." + }, + { + "value": "Terabyte", + "description": "Terabyte information unit. Usually defined as 1000 gigabytes or 1024 gigabytes." + }, + { + "value": "Petabyte", + "description": "Petabyte information unit. Usually defined as 1000 terabytes or 1024 terabytes." + } + ] + }, + "description": "The information (data) Unit of measurement." + }, + "TemperatureUnit": { + "type": "string", + "enum": [ + "Unspecified", + "Fahrenheit", + "Kelvin", + "Rankine", + "Celsius" + ], + "x-ms-enum": { + "name": "TemperatureUnit", + "modelAsString": true + }, + "description": "The temperature Unit of measurement." + }, + "WeightUnit": { + "type": "string", + "enum": [ + "Unspecified", + "Kilogram", + "Gram", + "Milligram", + "Gallon", + "MetricTon", + "Ton", + "Pound", + "Ounce", + "Grain", + "PennyWeight", + "LongTonBritish", + "ShortTonUS", + "ShortHundredWeightUS", + "Stone", + "Dram" + ], + "x-ms-enum": { + "name": "WeightUnit", + "modelAsString": true + }, + "description": "The weight Unit of measurement." + }, + "NumberKind": { + "type": "string", + "enum": [ + "Integer", + "Decimal", + "Power", + "Fraction", + "Percent", + "Unspecified" + ], + "x-ms-enum": { + "name": "NumberKind", + "modelAsString": true + }, + "description": "The type of the extracted number entity." + }, + "OrdinalRelativeTo": { + "type": "string", + "enum": [ + "Current", + "End", + "Start" + ], + "x-ms-enum": { + "name": "RelativeTo", + "modelAsString": true + }, + "description": "The reference point that the ordinal number denotes." + }, + "RangeInclusivity": { + "type": "string", + "enum": [ + "NoneInclusive", + "LeftInclusive", + "RightInclusive", + "LeftRightInclusive" + ], + "x-ms-enum": { + "name": "RangeInclusivity", + "modelAsString": true + }, + "description": "The range inclusiveness of this property property." + }, + "NumericRangeKind": { + "type": "string", + "enum": [ + "Number", + "Speed", + "Weight", + "Length", + "Volume", + "Area", + "Age", + "Information", + "Temperature", + "Currency" + ], + "x-ms-enum": { + "name": "RangeKind", + "modelAsString": true + }, + "description": "The kind of range that the resolution object represents." + }, + "BaseMetadata": { + "description": "The abstract base class for entity Metadata.", + "type": "object", + "discriminator": "metadataKind", + "properties": { + "metadataKind": { + "description": "The entity Metadata object kind.", + "type": "string", + "enum": [ + "DateMetadata", + "DateTimeMetadata", + "TimeMetadata", + "TemporalSetMetadata", + "NumberMetadata", + "OrdinalMetadata", + "SpeedMetadata", + "WeightMetadata", + "LengthMetadata", + "VolumeMetadata", + "AreaMetadata", + "AgeMetadata", + "InformationMetadata", + "TemperatureMetadata", + "CurrencyMetadata", + "NumericRangeMetadata", + "TemporalSpanMetadata" + ], + "x-ms-enum": { + "name": "MetadataKind", + "modelAsString": true + } + } + }, + "required": [ + "metadataKind" + ] + }, + "QuantityMetadata": { + "description": "Represents Metadata for quantities.", + "type": "object", + "properties": { + "value": { + "type": "number", + "format": "double", + "description": "The numeric value that the extracted text denotes." + } + }, + "required": [ + "value" + ] + }, + "AgeMetadata": { + "description": "Represents the Age entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "AgeMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/AgeUnit" + } + }, + "required": [ + "unit" + ] + }, + "VolumeMetadata": { + "description": "Represents the volume entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "VolumeMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/VolumeUnit" + } + }, + "required": [ + "unit" + ] + }, + "SpeedMetadata": { + "description": "Represents the speed entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "SpeedMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/SpeedUnit" + } + }, + "required": [ + "unit" + ] + }, + "AreaMetadata": { + "description": "Represents the area entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "AreaMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/AreaUnit" + } + }, + "required": [ + "unit" + ] + }, + "LengthMetadata": { + "description": "Represents the length entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "LengthMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/LengthUnit" + } + }, + "required": [ + "unit" + ] + }, + "InformationMetadata": { + "description": "Represents the information (data) entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "InformationMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/InformationUnit" + } + }, + "required": [ + "unit" + ] + }, + "TemperatureMetadata": { + "description": "Represents the temperature entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "TemperatureMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/TemperatureUnit" + } + }, + "required": [ + "unit" + ] + }, + "WeightMetadata": { + "description": "Represents the weight entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "WeightMetadata", + "properties": { + "unit": { + "$ref": "#/definitions/WeightUnit" + } + }, + "required": [ + "unit" + ] + }, + "CurrencyMetadata": { + "description": "Represents the currency entity Metadata model.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/QuantityMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "CurrencyMetadata", + "properties": { + "iso4217": { + "type": "string", + "description": "The alphabetic code based on another ISO standard, ISO 3166, which lists the codes for country names. The first two letters of the ISO 4217 three-letter code are the same as the code for the country name, and, where possible, the third letter corresponds to the first letter of the currency name." + }, + "value": { + "type": "number", + "format": "double", + "description": "The money amount captured in the extracted entity" + }, + "unit": { + "type": "string", + "description": "The unit of the amount captured in the extracted entity" + } + }, + "required": [ + "value", + "unit" + ] + }, + "DateValue": { + "description": "Represents the date value.", + "type": "object", + "properties": { + "timex": { + "$ref": "#/definitions/TimeExpression" + }, + "value": { + "type": "string", + "description": "The actual time that the extracted text denote." + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier" + } + }, + "required": [ + "timex", + "value" + ] + }, + "BaseTemporalMetadata": { + "type": "object", + "properties": { + "dateValues": { + "type": "array", + "description": "The list of date values.", + "items": { + "$ref": "#/definitions/DateValue" + } + } + } + }, + "DateMetadata": { + "description": "A Metadata for date entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/BaseTemporalMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "DateMetadata" + }, + "DateTimeMetadata": { + "description": "A Metadata for datetime entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/BaseTemporalMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "DateTimeMetadata" + }, + "TemporalSetMetadata": { + "description": "A Metadata for temporal set entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/BaseTemporalMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "TemporalSetMetadata" + }, + "TimeMetadata": { + "description": "A Metadata for time entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + }, + { + "$ref": "#/definitions/BaseTemporalMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "TimeMetadata" + }, + "NumberMetadata": { + "description": "A metadata for numeric entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "NumberMetadata", + "properties": { + "numberKind": { + "$ref": "#/definitions/NumberKind" + }, + "value": { + "type": "number", + "format": "double", + "description": "A numeric representation of what the extracted text denotes." + } + }, + "required": [ + "numberKind", + "value" + ] + }, + "OrdinalMetadata": { + "description": "A Metadata for ordinal numbers entity instances.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "OrdinalMetadata", + "properties": { + "offset": { + "type": "string", + "description": "The offset With respect to the reference (e.g., offset = -1 in \"show me the second to last\"" + }, + "relativeTo": { + "$ref": "#/definitions/OrdinalRelativeTo" + }, + "value": { + "type": "string", + "description": "A simple arithmetic expression that the ordinal denotes." + } + }, + "required": [ + "offset", + "relativeTo", + "value" + ] + }, + "TemporalSpanMetadata": { + "description": "represents the Metadata of a date and/or time span.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "TemporalSpanMetadata", + "properties": { + "spanValues": { + "$ref": "#/definitions/TemporalSpanValues" + } + } + }, + "TemporalSpanValues": { + "type": "object", + "properties": { + "begin": { + "$ref": "#/definitions/TimeExpression" + }, + "end": { + "$ref": "#/definitions/TimeExpression" + }, + "duration": { + "type": "string", + "description": "An optional duration value formatted based on the ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601#Durations)" + }, + "modifier": { + "$ref": "#/definitions/TemporalModifier" + }, + "timex": { + "type": "string", + "description": "An optional triplet containing the beginning, the end, and the duration all stated as ISO 8601 formatted strings." + } + } + }, + "NumericRangeMetadata": { + "description": "represents the Metadata of numeric intervals.", + "allOf": [ + { + "$ref": "#/definitions/BaseMetadata" + } + ], + "type": "object", + "x-ms-discriminator-value": "NumericRangeMetadata", + "properties": { + "rangeKind": { + "$ref": "#/definitions/NumericRangeKind" + }, + "minimum": { + "type": "number", + "format": "double", + "description": "The beginning value of the interval." + }, + "maximum": { + "type": "number", + "format": "double", + "description": "The ending value of the interval." + }, + "rangeInclusivity": { + "$ref": "#/definitions/RangeInclusivity" + } + }, + "required": [ + "rangeKind", + "minimum", + "maximum" + ] + }, + "TemporalModifier": { + "type": "string", + "description": "An optional modifier of a date/time instance.", + "enum": [ + "AfterApprox", + "Before", + "BeforeStart", + "Approx", + "ReferenceUndefined", + "SinceEnd", + "AfterMid", + "Start", + "After", + "BeforeEnd", + "Until", + "End", + "Less", + "Since", + "AfterStart", + "BeforeApprox", + "Mid", + "More" + ], + "x-ms-enum": { + "name": "TemporalModifier", + "modelAsString": true + } + }, + "TimeExpression": { + "type": "string", + "description": "An extended ISO 8601 date/time representation as described in (https://github.com/Microsoft/Recognizers-Text/blob/master/Patterns/English/English-DateTime.yaml)" + }, + "Match": { + "type": "object", + "required": [ + "confidenceScore", + "text", + "offset", + "length" + ], + "properties": { + "confidenceScore": { + "type": "number", + "format": "double", + "description": "If a well known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned." + }, + "text": { + "type": "string", + "description": "Entity text as appears in the request." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the entity match text." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "Length for the entity match text." + } + } + }, + "PiiTaskParameters": { + "type": "object", + "description": "Supported parameters for a PII Entities Recognition task.", + "properties": { + "domain": { + "$ref": "#/definitions/PiiDomain" + }, + "piiCategories": { + "$ref": "#/definitions/PiiCategories" + }, + "excludePiiCategories": { + "$ref": "#/definitions/PiiCategoriesExclude" + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + }, + "redactionCharacter": { + "$ref": "common.json#/definitions/RedactionCharacter" + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "PiiLROTask": { + "type": "object", + "description": "An object representing the task definition for a PII Entities Recognition task.", + "properties": { + "parameters": { + "$ref": "#/definitions/PiiTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "PiiEntityRecognition" + }, + "PiiTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "PiiEntityRecognitionResults" + }, + "PiiResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/PIIResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "PIIResultWithDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/PiiEntitiesDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "PiiDomain": { + "type": "string", + "description": "The PII domain used for PII Entity Recognition.", + "default": "none", + "enum": [ + "phi", + "none" + ], + "x-ms-enum": { + "name": "PiiDomain", + "modelAsString": true, + "values": [ + { + "name": "phi", + "description": "Indicates that entities in the Personal Health Information domain should be redacted.", + "value": "phi" + }, + { + "name": "none", + "description": "Indicates that no domain is specified.", + "value": "none" + } + ] + } + }, + "PiiEntitiesDocumentResult": { + "type": "object", + "properties": { + "redactedText": { + "type": "string", + "description": "Returns redacted text." + }, + "entities": { + "type": "array", + "description": "Recognized entities in the document.", + "items": { + "$ref": "#/definitions/Entity" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "redactedText", + "entities" + ] + }, + "PiiCategories": { + "description": "(Optional) describes the PII categories to return", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategory", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address", + "All", + "Default" + ] + }, + "type": "array", + "uniqueItems": true + }, + "PiiCategoriesExclude": { + "description": "(Optional) describes the PII categories to return", + "items": { + "type": "string", + "x-ms-enum": { + "name": "PiiCategoriesExclude", + "modelAsString": true + }, + "enum": [ + "ABARoutingNumber", + "ARNationalIdentityNumber", + "AUBankAccountNumber", + "AUDriversLicenseNumber", + "AUMedicalAccountNumber", + "AUPassportNumber", + "AUTaxFileNumber", + "AUBusinessNumber", + "AUCompanyNumber", + "ATIdentityCard", + "ATTaxIdentificationNumber", + "ATValueAddedTaxNumber", + "AzureDocumentDBAuthKey", + "AzureIAASDatabaseConnectionAndSQLString", + "AzureIoTConnectionString", + "AzurePublishSettingPassword", + "AzureRedisCacheString", + "AzureSAS", + "AzureServiceBusString", + "AzureStorageAccountKey", + "AzureStorageAccountGeneric", + "BENationalNumber", + "BENationalNumberV2", + "BEValueAddedTaxNumber", + "BRCPFNumber", + "BRLegalEntityNumber", + "BRNationalIDRG", + "BGUniformCivilNumber", + "CABankAccountNumber", + "CADriversLicenseNumber", + "CAHealthServiceNumber", + "CAPassportNumber", + "CAPersonalHealthIdentification", + "CASocialInsuranceNumber", + "CLIdentityCardNumber", + "CNResidentIdentityCardNumber", + "CreditCardNumber", + "HRIdentityCardNumber", + "HRNationalIDNumber", + "HRPersonalIdentificationNumber", + "HRPersonalIdentificationOIBNumberV2", + "CYIdentityCard", + "CYTaxIdentificationNumber", + "CZPersonalIdentityNumber", + "CZPersonalIdentityV2", + "DKPersonalIdentificationNumber", + "DKPersonalIdentificationV2", + "DrugEnforcementAgencyNumber", + "EEPersonalIdentificationCode", + "EUDebitCardNumber", + "EUDriversLicenseNumber", + "EUGPSCoordinates", + "EUNationalIdentificationNumber", + "EUPassportNumber", + "EUSocialSecurityNumber", + "EUTaxIdentificationNumber", + "FIEuropeanHealthNumber", + "FINationalID", + "FINationalIDV2", + "FIPassportNumber", + "FRDriversLicenseNumber", + "FRHealthInsuranceNumber", + "FRNationalID", + "FRPassportNumber", + "FRSocialSecurityNumber", + "FRTaxIdentificationNumber", + "FRValueAddedTaxNumber", + "DEDriversLicenseNumber", + "DEPassportNumber", + "DEIdentityCardNumber", + "DETaxIdentificationNumber", + "DEValueAddedNumber", + "GRNationalIDCard", + "GRNationalIDV2", + "GRTaxIdentificationNumber", + "HKIdentityCardNumber", + "HUValueAddedNumber", + "HUPersonalIdentificationNumber", + "HUTaxIdentificationNumber", + "INPermanentAccount", + "INUniqueIdentificationNumber", + "IDIdentityCardNumber", + "InternationalBankingAccountNumber", + "IEPersonalPublicServiceNumber", + "IEPersonalPublicServiceNumberV2", + "ILBankAccountNumber", + "ILNationalID", + "ITDriversLicenseNumber", + "ITFiscalCode", + "ITValueAddedTaxNumber", + "JPBankAccountNumber", + "JPDriversLicenseNumber", + "JPPassportNumber", + "JPResidentRegistrationNumber", + "JPSocialInsuranceNumber", + "JPMyNumberCorporate", + "JPMyNumberPersonal", + "JPResidenceCardNumber", + "LVPersonalCode", + "LTPersonalCode", + "LUNationalIdentificationNumberNatural", + "LUNationalIdentificationNumberNonNatural", + "MYIdentityCardNumber", + "MTIdentityCardNumber", + "MTTaxIDNumber", + "NLCitizensServiceNumber", + "NLCitizensServiceNumberV2", + "NLTaxIdentificationNumber", + "NLValueAddedTaxNumber", + "NZBankAccountNumber", + "NZDriversLicenseNumber", + "NZInlandRevenueNumber", + "NZMinistryOfHealthNumber", + "NZSocialWelfareNumber", + "NOIdentityNumber", + "PHUnifiedMultiPurposeIDNumber", + "PLIdentityCard", + "PLNationalID", + "PLNationalIDV2", + "PLPassportNumber", + "PLTaxIdentificationNumber", + "PLREGONNumber", + "PTCitizenCardNumber", + "PTCitizenCardNumberV2", + "PTTaxIdentificationNumber", + "ROPersonalNumericalCode", + "RUPassportNumberDomestic", + "RUPassportNumberInternational", + "SANationalID", + "SGNationalRegistrationIdentityCardNumber", + "SKPersonalNumber", + "SITaxIdentificationNumber", + "SIUniqueMasterCitizenNumber", + "ZAIdentificationNumber", + "KRResidentRegistrationNumber", + "ESDNI", + "ESSocialSecurityNumber", + "ESTaxIdentificationNumber", + "SQLServerConnectionString", + "SENationalID", + "SENationalIDV2", + "SEPassportNumber", + "SETaxIdentificationNumber", + "SWIFTCode", + "CHSocialSecurityNumber", + "TWNationalID", + "TWPassportNumber", + "TWResidentCertificate", + "THPopulationIdentificationCode", + "TRNationalIdentificationNumber", + "UKDriversLicenseNumber", + "UKElectoralRollNumber", + "UKNationalHealthNumber", + "UKNationalInsuranceNumber", + "UKUniqueTaxpayerNumber", + "USUKPassportNumber", + "USBankAccountNumber", + "USDriversLicenseNumber", + "USIndividualTaxpayerIdentification", + "USSocialSecurityNumber", + "UAPassportNumberDomestic", + "UAPassportNumberInternational", + "Organization", + "Email", + "URL", + "Age", + "PhoneNumber", + "IPAddress", + "Date", + "Person", + "Address" + ] + }, + "type": "array", + "uniqueItems": true + }, + "ExtractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for an Extractive Summarization task.", + "properties": { + "sentenceCount": { + "type": "integer", + "default": 3, + "format": "int64" + }, + "sortBy": { + "$ref": "#/definitions/ExtractiveSummarizationSortingCriteria" + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + }, + "query": { + "type": "string", + "description": "(Optional) If provided, the query will be used to extract most relevant sentences from the document." + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "ExtractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Extractive Summarization task.", + "properties": { + "parameters": { + "$ref": "#/definitions/ExtractiveSummarizationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "ExtractiveSummarization" + }, + "ExtractiveSummarizationResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/ExtractedSummaryDocumentResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "ExtractiveSummarizationSortingCriteria": { + "type": "string", + "default": "Offset", + "description": "The sorting criteria to use for the results of Extractive Summarization.", + "enum": [ + "Offset", + "Rank" + ], + "x-ms-enum": { + "name": "ExtractiveSummarizationSortingCriteria", + "modelAsString": true, + "values": [ + { + "name": "Offset", + "description": "Indicates that results should be sorted in order of appearance in the text.", + "value": "Offset" + }, + { + "name": "Rank", + "description": "Indicates that results should be sorted in order of importance (i.e. rank score) according to the model.", + "value": "Rank" + } + ] + } + }, + "ExtractedSummaryDocumentResultWithDetectedLanguage": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ExtractedSummaryDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "ExtractedSummaryDocumentResult": { + "type": "object", + "properties": { + "sentences": { + "type": "array", + "description": "A ranked list of sentences representing the extracted summary.", + "items": { + "$ref": "#/definitions/ExtractedSummarySentence" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "sentences" + ] + }, + "ExtractedSummarySentence": { + "type": "object", + "required": [ + "text", + "rankScore", + "offset", + "length" + ], + "properties": { + "text": { + "type": "string", + "description": "The extracted sentence text." + }, + "rankScore": { + "type": "number", + "format": "double", + "description": "A double value representing the relevance of the sentence within the summary. Higher values indicate higher importance." + }, + "offset": { + "type": "integer", + "format": "int32", + "description": "The sentence offset from the start of the document, based on the value of the parameter StringIndexType." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the sentence." + } + } + }, + "KeyPhraseTaskParameters": { + "type": "object", + "description": "Supported parameters for a Key Phrase Extraction task.", + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "KeyPhraseLROTask": { + "type": "object", + "description": "An object representing the task definition for a Key Phrase Extraction task.", + "properties": { + "parameters": { + "$ref": "#/definitions/KeyPhraseTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "KeyPhraseExtraction" + }, + "KeyPhraseTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "KeyPhraseExtractionResults" + }, + "KeyPhraseResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/KeyPhrasesDocumentResultWithDetectedLanguage" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "KeyPhrasesDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "Key phrases recognized in a document with detected language", + "allOf": [ + { + "$ref": "#/definitions/KeyPhrasesDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "KeyPhrasesDocumentResult": { + "type": "object", + "properties": { + "keyPhrases": { + "type": "array", + "description": "A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.", + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "keyPhrases" + ] + }, + "LanguageDetectionTaskParameters": { + "type": "object", + "description": "Supported parameters for a Language Detection task.", + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "LanguageDetectionTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/LanguageDetectionResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "LanguageDetectionResults" + }, + "LanguageDetectionResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/LanguageDetectionDocumentResult" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "LanguageDetectionDocumentResult": { + "type": "object", + "properties": { + "detectedLanguage": { + "description": "Detected Language.", + "$ref": "#/definitions/DetectedLanguage" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "detectedLanguage" + ] + }, + "DetectedLanguage": { + "type": "object", + "required": [ + "name", + "iso6391Name", + "confidenceScore" + ], + "properties": { + "name": { + "type": "string", + "description": "Long name of a detected language (e.g. English, French)." + }, + "iso6391Name": { + "type": "string", + "description": "A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr)." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "description": "A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true." + }, + "script": { + "type": "string", + "description": "Identifies the script of the input document.", + "enum": [ + "Latin" + ], + "x-ms-enum": { + "name": "ScriptKind", + "modelAsString": true + } + } + } + }, + "DynamicClassificationTaskParameters": { + "type": "object", + "description": "Supported parameters for a Zero Shot Classification task.", + "properties": { + "classificationType": { + "type": "string", + "description": "Specifies either one or multiple categories per document. Defaults to multi classification which may return more than one class for each document.", + "default": "Multi", + "enum": [ + "Single", + "Multi" + ], + "x-ms-enum": { + "name": "ClassificationType", + "modelAsString": true + } + }, + "categories": { + "type": "array", + "description": "a list of categories to which input is classified to.", + "items": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ], + "required": [ + "categories" + ] + }, + "DynamicClassificationTaskResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/DynamicClassificationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextTaskResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "DynamicClassificationResults" + }, + "DynamicClassificationResult": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "allOf": [ + { + "$ref": "#/definitions/DynamicClassificationDocumentResult" + } + ] + } + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "AnalyzeTextJobState": { + "allOf": [ + { + "$ref": "common.json#/definitions/JobState" + }, + { + "$ref": "#/definitions/TasksState" + }, + { + "$ref": "#/definitions/AnalyzeTextJobStatistics" + } + ] + }, + "Pagination": { + "properties": { + "nextLink": { + "type": "string" + } + }, + "type": "object" + }, + "AnalyzeTextJobStatistics": { + "properties": { + "statistics": { + "$ref": "common.json#/definitions/RequestStatistics" + } + }, + "type": "object" + }, + "TasksState": { + "properties": { + "tasks": { + "properties": { + "completed": { + "type": "integer", + "format": "int32" + }, + "failed": { + "type": "integer", + "format": "int32" + }, + "inProgress": { + "type": "integer", + "format": "int32" + }, + "total": { + "type": "integer", + "format": "int32" + }, + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + } + }, + "required": [ + "total", + "completed", + "failed", + "inProgress" + ], + "type": "object" + } + }, + "required": [ + "tasks" + ], + "type": "object" + }, + "TaskState": { + "properties": { + "lastUpdateDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "type": "string", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "State" + } + } + }, + "required": [ + "status", + "lastUpdateDateTime" + ], + "type": "object" + }, + "AnalyzeTextLROResult": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "$ref": "#/definitions/AnalyzeTextLROResultsKind" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskState" + }, + { + "$ref": "common.json#/definitions/TaskIdentifier" + } + ], + "required": [ + "kind" + ] + }, + "EntityRecognitionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntitiesResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityRecognitionLROResults" + }, + "CustomEntityRecognitionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomEntitiesResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomEntityRecognitionLROResults" + }, + "CustomSingleLabelClassificationLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomSingleLabelClassificationLROResults" + }, + "CustomMultiLabelClassificationLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomLabelClassificationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomMultiLabelClassificationLROResults" + }, + "EntityLinkingLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/EntityLinkingResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "EntityLinkingLROResults" + }, + "PiiEntityRecognitionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/PiiResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "PiiEntityRecognitionLROResults" + }, + "ExtractiveSummarizationLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/ExtractiveSummarizationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "ExtractiveSummarizationLROResults" + }, + "HealthcareLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/HealthcareResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "HealthcareLROResults" + }, + "CustomHealthcareLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomHealthcareResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomHealthcareLROResults" + }, + "SentimentLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/SentimentResponse" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "SentimentAnalysisLROResults" + }, + "CustomSentimentAnalysisLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/CustomSentimentAnalysisResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomSentimentAnalysisLROResults" + }, + "KeyPhraseExtractionLROResult": { + "type": "object", + "properties": { + "results": { + "$ref": "#/definitions/KeyPhraseResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "KeyPhraseExtractionLROResults" + }, + "DocumentResponse": { + "type": "object", + "properties": {} + }, + "DocumentResult": { + "type": "object", + "required": [ + "id", + "warnings" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "warnings": { + "type": "array", + "description": "Warnings encountered while processing document.", + "items": { + "$ref": "#/definitions/DocumentWarning" + } + }, + "statistics": { + "description": "if showStats=true was specified in the request this field will contain information about the document payload.", + "$ref": "#/definitions/DocumentStatistics" + } + } + }, + "DocumentDetectedLanguage": { + "type": "object", + "properties": { + "detectedLanguage": { + "$ref": "#/definitions/DetectedLanguage", + "description": "If 'language' is set to 'auto' for the document in the request this field will contain a 2 letter ISO 639-1 representation of the language detected for this document." + } + } + }, + "DocumentWarning": { + "type": "object", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "enum": [ + "LongWordsInDocument", + "DocumentTruncated" + ], + "x-ms-enum": { + "name": "WarningCodeValue", + "modelAsString": true + }, + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + } + }, + "DocumentStatistics": { + "type": "object", + "required": [ + "charactersCount", + "transactionsCount" + ], + "properties": { + "charactersCount": { + "type": "integer", + "format": "int32", + "description": "Number of text elements recognized in the document." + }, + "transactionsCount": { + "type": "integer", + "format": "int32", + "description": "Number of transactions for the document." + } + }, + "description": "if showStats=true was specified in the request this field will contain information about the document payload." + }, + "DocumentRequestStatistics": { + "type": "object", + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount" + ], + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/RequestStatistics" + } + ], + "description": "if showStats=true was specified in the request this field will contain information about the document request payload." + }, + "MultiLanguageInput": { + "type": "object", + "description": "Contains an input document to be analyzed by the service.", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "A unique, non-empty document identifier." + }, + "text": { + "type": "string", + "description": "The input text to process." + }, + "language": { + "type": "string", + "description": "(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. For Auto Language Detection, use \"auto\". If not set, use \"en\" for English as default." + } + } + }, + "LanguageInput": { + "type": "object", + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique, non-empty document identifier." + }, + "text": { + "type": "string" + }, + "countryHint": { + "type": "string" + } + } + }, + "AbstractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Abstractive Summarization task.", + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "$ref": "#/definitions/AbstractiveSummarizationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "AbstractiveSummarization" + }, + "CustomAbstractiveSummarizationLROTask": { + "type": "object", + "description": "An object representing the task definition for an Custom Abstractive Summarization task.", + "required": [ + "parameters" + ], + "properties": { + "parameters": { + "$ref": "#/definitions/CustomAbstractiveSummarizationTaskParameters" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROTask" + } + ], + "x-ms-discriminator-value": "CustomAbstractiveSummarization" + }, + "AbstractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for the pre-build Abstractive Summarization task.", + "properties": { + "query": { + "type": "string", + "description": "(Optional) When supplied, this option guides the summary to emphasize specific keywords or areas of interest that you specify." + } + }, + "allOf": [ + { + "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" + }, + { + "$ref": "common.json#/definitions/PreBuiltTaskParameters" + } + ] + }, + "CustomAbstractiveSummarizationTaskParameters": { + "type": "object", + "description": "Supported parameters for the Custom Abstractive Summarization task.", + "allOf": [ + { + "$ref": "common.json#/definitions/AbstractiveSummarizationTaskParametersBase" + }, + { + "$ref": "common.json#/definitions/CustomTaskParameters" + } + ] + }, + "AbstractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Abstractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/AbstractiveSummarizationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "AbstractiveSummarizationLROResults" + }, + "CustomAbstractiveSummarizationLROResult": { + "type": "object", + "description": "An object representing the results for an Custom Abstractive Summarization task.", + "properties": { + "results": { + "$ref": "#/definitions/CustomAbstractiveSummarizationResult" + } + }, + "allOf": [ + { + "$ref": "#/definitions/AnalyzeTextLROResult" + } + ], + "required": [ + "results" + ], + "x-ms-discriminator-value": "CustomAbstractiveSummarizationLROResults" + }, + "AbstractiveSummarizationResultBase": { + "type": "object", + "description": "An object representing the summarization results of each document.", + "properties": { + "documents": { + "type": "array", + "description": "Response by document", + "items": { + "$ref": "#/definitions/AbstractiveSummaryDocumentResultWithDetectedLanguage" + } + } + }, + "required": [ + "documents" + ] + }, + "AbstractiveSummaryDocumentResultWithDetectedLanguage": { + "type": "object", + "description": "An object representing the summarization result of a single document with detected language.", + "allOf": [ + { + "$ref": "#/definitions/AbstractiveSummaryDocumentResult" + }, + { + "$ref": "#/definitions/DocumentDetectedLanguage" + } + ] + }, + "AbstractiveSummarizationResult": { + "type": "object", + "description": "An object representing the pre-build summarization results of each document.", + "allOf": [ + { + "$ref": "#/definitions/AbstractiveSummarizationResultBase" + }, + { + "$ref": "common.json#/definitions/PreBuiltResult" + } + ], + "required": [ + "documents" + ] + }, + "CustomAbstractiveSummarizationResult": { + "type": "object", + "description": "An object representing the custom summarization results of each document.", + "allOf": [ + { + "$ref": "#/definitions/AbstractiveSummarizationResultBase" + }, + { + "$ref": "common.json#/definitions/CustomResult" + } + ], + "required": [ + "documents" + ] + }, + "AbstractiveSummaryDocumentResult": { + "type": "object", + "description": "An object representing the summarization result of a single document.", + "properties": { + "summaries": { + "type": "array", + "description": "A list of abstractive summaries.", + "items": { + "$ref": "#/definitions/AbstractiveSummary" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/DocumentResult" + } + ], + "required": [ + "summaries" + ] + }, + "AbstractiveSummary": { + "type": "object", + "description": "An object representing a single summary with context for given document.", + "properties": { + "text": { + "type": "string", + "description": "The text of the summary." + }, + "contexts": { + "type": "array", + "description": "The context list of the summary.", + "items": { + "$ref": "common.json#/definitions/SummaryContext" + } + } + }, + "required": [ + "text" + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/common.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/common.json new file mode 100644 index 000000000000..62a3beaf037a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/common.json @@ -0,0 +1,1052 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", + "version": "2023-11-15-preview" + }, + "paths": {}, + "definitions": { + "ErrorResponse": { + "type": "object", + "description": "Error response.", + "additionalProperties": false, + "properties": { + "error": { + "description": "The error object.", + "$ref": "#/definitions/Error" + } + }, + "required": [ + "error" + ] + }, + "Error": { + "type": "object", + "description": "The error object.", + "additionalProperties": true, + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/ErrorCode" + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error." + }, + "target": { + "type": "string", + "description": "The target of the error." + }, + "details": { + "type": "array", + "description": "An array of details about specific errors that led to this reported error.", + "items": { + "$ref": "#/definitions/Error" + } + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "InnerErrorModel": { + "type": "object", + "description": "An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.", + "additionalProperties": false, + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "description": "One of a server-defined set of error codes.", + "$ref": "#/definitions/InnerErrorCode" + }, + "message": { + "type": "string", + "description": "Error message." + }, + "details": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Error details." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerErrorModel" + } + } + }, + "ErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "x-ms-enum": { + "name": "ErrorCode", + "modelAsString": true + }, + "enum": [ + "InvalidRequest", + "InvalidArgument", + "Unauthorized", + "Forbidden", + "NotFound", + "ProjectNotFound", + "OperationNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchIndexNotFound", + "TooManyRequests", + "AzureCognitiveSearchThrottling", + "AzureCognitiveSearchIndexLimitReached", + "InternalServerError", + "ServiceUnavailable", + "Timeout", + "QuotaExceeded", + "Conflict", + "Warning" + ] + }, + "InnerErrorCode": { + "type": "string", + "description": "Human-readable error code.", + "x-ms-enum": { + "name": "InnerErrorCode", + "modelAsString": true + }, + "enum": [ + "InvalidRequest", + "InvalidParameterValue", + "KnowledgeBaseNotFound", + "AzureCognitiveSearchNotFound", + "AzureCognitiveSearchThrottling", + "ExtractionFailure", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputDocuments", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" + ] + }, + "Language": { + "type": "string", + "description": "Language of the text records. This is BCP-47 representation of a language. For example, use \"en\" for English; \"es\" for Spanish etc. If not set, use \"en\" for English as default." + }, + "RedactionCharacter": { + "type": "string", + "description": "Optional parameter to use a Custom Character to be used for redaction in PII responses. Default character will be * as before. We allow specific ascii characters for redaction.", + "default": "*", + "x-ms-enum": { + "name": "redactionCharacter", + "modelAsString": true + }, + "enum": [ + "!", + "#", + "$", + "%", + "&", + "*", + "+", + "-", + "=", + "?", + "@", + "^", + "_", + "~" + ] + }, + "StringIndexType": { + "type": "string", + "description": "Specifies the method used to interpret string offsets. Defaults to Text Elements (Graphemes) according to Unicode v8.0.0. For additional information see https://aka.ms/text-analytics-offsets.", + "default": "TextElements_v8", + "enum": [ + "TextElements_v8", + "UnicodeCodePoint", + "Utf16CodeUnit" + ], + "x-ms-enum": { + "name": "StringIndexType", + "modelAsString": true, + "values": [ + { + "value": "TextElements_v8", + "description": "Returned offset and length values will correspond to TextElements (Graphemes and Grapheme clusters) confirming to the Unicode 8.0.0 standard. Use this option if your application is written in .Net Framework or .Net Core and you will be using StringInfo." + }, + { + "value": "UnicodeCodePoint", + "description": "Returned offset and length values will correspond to Unicode code points. Use this option if your application is written in a language that support Unicode, for example Python." + }, + { + "value": "Utf16CodeUnit", + "description": "Returned offset and length values will correspond to UTF-16 code units. Use this option if your application is written in a language that support Unicode, for example Java, JavaScript." + } + ] + } + }, + "TaskState": { + "description": "Returns the current state of the task.", + "properties": { + "lastUpdateDateTime": { + "description": "The last updated time in UTC for the task.", + "format": "date-time", + "type": "string" + }, + "status": { + "description": "The status of the task at the mentioned last update time.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "State" + } + } + }, + "required": [ + "status", + "lastUpdateDateTime" + ], + "type": "object" + }, + "TaskIdentifier": { + "type": "object", + "description": "Base task object.", + "properties": { + "taskName": { + "type": "string" + } + } + }, + "TaskParameters": { + "type": "object", + "description": "Base parameters object for a text analysis task.", + "properties": { + "loggingOptOut": { + "type": "boolean", + "default": false + } + } + }, + "PreBuiltTaskParameters": { + "type": "object", + "description": "Parameters object for a text analysis task using pre-built models.", + "properties": { + "modelVersion": { + "type": "string", + "default": "latest" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskParameters" + } + ] + }, + "JobState": { + "properties": { + "displayName": { + "type": "string" + }, + "createdDateTime": { + "format": "date-time", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "type": "string" + }, + "jobId": { + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "enum": [ + "notStarted", + "running", + "succeeded", + "partiallyCompleted", + "failed", + "cancelled", + "cancelling" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "State" + } + }, + "errors": { + "items": { + "$ref": "#/definitions/Error" + }, + "type": "array" + }, + "nextLink": { + "type": "string" + } + }, + "required": [ + "jobId", + "lastUpdatedDateTime", + "createdDateTime", + "status" + ] + }, + "JobErrors": { + "properties": { + "errors": { + "items": { + "$ref": "#/definitions/Error" + }, + "type": "array" + } + }, + "type": "object" + }, + "InputError": { + "type": "object", + "description": "Contains details of errors encountered during a job execution.", + "required": [ + "id", + "error" + ], + "properties": { + "id": { + "type": "string", + "description": "The ID of the input." + }, + "error": { + "type": "object", + "description": "Error encountered.", + "$ref": "#/definitions/Error" + } + } + }, + "InputWarning": { + "type": "object", + "description": "Contains details of warnings encountered during a job execution.", + "required": [ + "code", + "message" + ], + "properties": { + "code": { + "type": "string", + "description": "Warning code." + }, + "message": { + "type": "string", + "description": "Warning message." + }, + "targetRef": { + "type": "string", + "description": "A JSON pointer reference indicating the target object." + } + } + }, + "RequestStatistics": { + "type": "object", + "required": [ + "documentsCount", + "validDocumentsCount", + "erroneousDocumentsCount", + "transactionsCount" + ], + "properties": { + "documentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of documents submitted in the request." + }, + "validDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of valid documents. This excludes empty, over-size limit or non-supported languages documents." + }, + "erroneousDocumentsCount": { + "type": "integer", + "format": "int32", + "description": "Number of invalid documents. This includes empty, over-size limit or non-supported languages documents." + }, + "transactionsCount": { + "type": "integer", + "format": "int64", + "description": "Number of transactions for the request." + } + }, + "additionalProperties": true, + "description": "if showStats=true was specified in the request this field will contain information about the request payload." + }, + "PreBuiltResult": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "modelVersion": { + "type": "string", + "description": "This field indicates which model is used for scoring." + } + }, + "required": [ + "errors", + "modelVersion" + ] + }, + "AnswersResult": { + "type": "object", + "description": "Represents List of Question Answers.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents Answer Result list.", + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswer" + } + } + } + }, + "KnowledgeBaseAnswer": { + "type": "object", + "description": "Represents knowledge base answer.", + "additionalProperties": false, + "properties": { + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer text." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidence", + "description": "Answer confidence score, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "id": { + "type": "integer", + "x-ms-client-name": "qnaId", + "description": "ID of the QnA result.", + "format": "int32" + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "type": "object", + "$ref": "#/definitions/KnowledgeBaseAnswerDialog" + }, + "answerSpan": { + "type": "object", + "x-ms-client-name": "shortAnswer", + "description": "Answer span object of QnA with respect to user's question.", + "$ref": "#/definitions/AnswerSpan" + } + } + }, + "KnowledgeBaseAnswerDialog": { + "type": "object", + "description": "Dialog associated with Answer.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" + } + } + } + }, + "KnowledgeBaseAnswerPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt - used in ordering of the prompts.", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "QnA ID corresponding to the prompt.", + "format": "int32" + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "AnswerSpan": { + "type": "object", + "description": "Answer span object of QnA.", + "additionalProperties": false, + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "confidenceScore": { + "type": "number", + "x-ms-client-name": "confidence", + "description": "Predicted score of answer span, value ranges from 0 to 1.", + "format": "double", + "maximum": 1, + "minimum": 0 + }, + "offset": { + "type": "integer", + "description": "The answer span offset from the start of answer.", + "format": "int32" + }, + "length": { + "type": "integer", + "description": "The length of the answer span.", + "format": "int32" + } + } + }, + "AnswersOptions": { + "type": "object", + "description": "Parameters to query a knowledge base.", + "additionalProperties": false, + "properties": { + "qnaId": { + "type": "integer", + "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", + "format": "int32" + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "description": "Max number of answers to be returned for the question.", + "format": "int32" + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score for answers, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "context": { + "x-ms-client-name": "answerContext", + "description": "Context object with previous QnA's information.", + "$ref": "#/definitions/KnowledgeBaseAnswerContext" + }, + "rankerType": { + "type": "string", + "x-ms-client-name": "rankerKind", + "description": "Type of ranker to be used.", + "x-ms-enum": { + "name": "RankerKind", + "modelAsString": true, + "values": [ + { + "value": "QuestionOnly", + "description": "Question only ranker." + }, + { + "value": "Default", + "description": "Default ranker." + } + ] + }, + "enum": [ + "Default", + "QuestionOnly" + ] + }, + "filters": { + "description": "Filter QnAs based on given metadata list and knowledge base sources.", + "$ref": "#/definitions/QueryFilters" + }, + "answerSpanRequest": { + "x-ms-client-name": "shortAnswerOptions", + "description": "To configure Answer span prediction feature.", + "$ref": "#/definitions/ShortAnswerOptions" + }, + "includeUnstructuredSources": { + "type": "boolean", + "description": "(Optional) Flag to enable Query over Unstructured Sources." + } + } + }, + "KnowledgeBaseAnswerContext": { + "type": "object", + "description": "Context object with previous QnA's information.", + "additionalProperties": false, + "required": [ + "previousQnaId" + ], + "properties": { + "previousQnaId": { + "type": "integer", + "description": "Previous turn top answer result QnA ID.", + "format": "int32" + }, + "previousUserQuery": { + "type": "string", + "x-ms-client-name": "previousQuestion", + "description": "Previous user query." + } + } + }, + "QueryFilters": { + "type": "object", + "description": "filters over knowledge base.", + "additionalProperties": false, + "properties": { + "metadataFilter": { + "type": "object", + "$ref": "#/definitions/MetadataFilter" + }, + "sourceFilter": { + "type": "object", + "$ref": "#/definitions/SourceFilter" + }, + "logicalOperation": { + "type": "string", + "description": "Logical operation used to join metadata filter with source filter.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataFilter": { + "type": "object", + "description": "Find QnAs that are associated with the given list of metadata.", + "additionalProperties": false, + "properties": { + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataRecord" + } + }, + "logicalOperation": { + "type": "string", + "description": "Operation used to join metadata filters.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataRecord": { + "type": "object", + "description": "Object to provide the key value pair for each metadata.", + "additionalProperties": false, + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Metadata Key from Metadata dictionary used in the QnA." + }, + "value": { + "type": "string", + "description": "Metadata Value from Metadata dictionary used in the QnA." + } + } + }, + "SourceFilter": { + "type": "array", + "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", + "items": { + "type": "string" + } + }, + "LogicalOperationKind": { + "type": "string", + "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true + }, + "enum": [ + "AND", + "OR" + ] + }, + "ShortAnswerOptions": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "additionalProperties": false, + "required": [ + "enable" + ], + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or disable Answer Span prediction.", + "enum": [ + true + ], + "x-ms-enum": { + "name": "enable", + "modelAsString": false + } + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "topAnswersWithSpan": { + "type": "integer", + "x-ms-client-name": "top", + "description": "Number of Top answers to be considered for span prediction from 1 to 10.", + "format": "int32", + "maximum": 10, + "minimum": 1 + } + } + }, + "Sentiment": { + "type": "string", + "description": "Predicted sentiment.", + "enum": [ + "positive", + "neutral", + "negative", + "mixed" + ], + "x-ms-enum": { + "name": "TextSentiment", + "modelAsString": true, + "values": [ + { + "value": "positive", + "description": "Positive sentiment." + }, + { + "value": "neutral", + "description": "Neutral sentiment." + }, + { + "value": "negative", + "description": "Negative sentiment." + }, + { + "value": "mixed", + "description": "Mixed sentiment." + } + ] + } + }, + "SentimentConfidenceScores": { + "type": "object", + "required": [ + "positive", + "neutral", + "negative" + ], + "properties": { + "positive": { + "type": "number", + "format": "double", + "description": "Confidence score for positive sentiment" + }, + "neutral": { + "type": "number", + "format": "double", + "description": "Confidence score for neutral sentiment" + }, + "negative": { + "type": "number", + "format": "double", + "description": "Confidence score for negative sentiment" + } + }, + "description": "Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative." + }, + "AbstractiveSummarizationTaskParametersBase": { + "type": "object", + "description": "Supported parameters for an Abstractive Summarization task.", + "properties": { + "sentenceCount": { + "type": "integer", + "format": "int32", + "description": "(NOTE: Recommended to use summaryLength instead) Controls the approximate number of sentences in the output summaries." + }, + "summaryLength": { + "type": "string", + "enum": [ + "short", + "medium", + "long" + ], + "x-ms-enum": { + "name": "SummaryLengthBucket", + "modelAsString": true, + "values": [ + { + "value": "short", + "description": "Instructs model to generate shorter length summaries." + }, + { + "value": "medium", + "description": "Instructs model to generate medium length summaries." + }, + { + "value": "long", + "description": "Instructs model to generate longer length summaries." + } + ] + } + }, + "stringIndexType": { + "$ref": "#/definitions/StringIndexType" + } + } + }, + "SummaryContext": { + "type": "object", + "description": "The context of the summary.", + "required": [ + "offset", + "length" + ], + "properties": { + "offset": { + "type": "integer", + "format": "int32", + "description": "Start position for the context. Use of different 'stringIndexType' values can affect the offset returned." + }, + "length": { + "type": "integer", + "format": "int32", + "description": "The length of the context. Use of different 'stringIndexType' values can affect the length returned." + } + } + }, + "CustomTaskParameters": { + "type": "object", + "description": "Parameters object for a text analysis task using custom models.", + "properties": { + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "allOf": [ + { + "$ref": "#/definitions/TaskParameters" + } + ], + "required": [ + "projectName", + "deploymentName" + ] + }, + "CustomResult": { + "type": "object", + "properties": { + "errors": { + "type": "array", + "description": "Errors by document id.", + "items": { + "$ref": "#/definitions/DocumentError" + } + }, + "statistics": { + "$ref": "#/definitions/RequestStatistics" + }, + "projectName": { + "type": "string", + "description": "This field indicates the project name for the model." + }, + "deploymentName": { + "type": "string", + "description": "This field indicates the deployment name for the model." + } + }, + "required": [ + "errors", + "projectName", + "deploymentName" + ] + }, + "DocumentError": { + "type": "object", + "description": "Contains details of errors encountered during a job execution.", + "required": [ + "id", + "error" + ], + "properties": { + "id": { + "type": "string", + "description": "The id of the input document." + }, + "error": { + "type": "object", + "description": "Error encountered.", + "$ref": "#/definitions/Error" + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "Supported Cognitive Services endpoint (e.g., https://.api.cognitiveservices.azure.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "format": "url", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "ProjectNameQueryParameter": { + "name": "projectName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the project to use.", + "x-ms-parameter-location": "method" + }, + "ProjectNamePathParameter": { + "name": "projectName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 100, + "description": "The name of the project to use.", + "x-ms-parameter-location": "method" + }, + "DeploymentNameQueryParameter": { + "name": "deploymentName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the specific deployment of the project to use.", + "x-ms-parameter-location": "method" + }, + "DeploymentNamePathParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the specific deployment of the project to use.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "TopParameter": { + "name": "top", + "in": "query", + "description": "The maximum number of resources to return from the collection.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "SkipParameter": { + "name": "skip", + "in": "query", + "description": "An offset into the collection of the first resource to be returned.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "MaxPageSizeParameter": { + "name": "maxpagesize", + "in": "query", + "description": "The maximum number of resources to include in a single response.", + "type": "integer", + "format": "int32", + "x-ms-parameter-location": "method" + }, + "ShowStats": { + "name": "showStats", + "in": "query", + "description": "(Optional) if set to true, response will contain request and document level statistics.", + "type": "boolean", + "required": false, + "x-ms-parameter-location": "method" + }, + "JobId": { + "description": "Job ID", + "format": "uuid", + "in": "path", + "name": "jobId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json new file mode 100644 index 000000000000..943e7dcdd284 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulAssignDeploymentResources.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "body": { + "resourcesMetadata": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "customDomain": "lang-test-weu.cognitiveservices.azure.com", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "customDomain": "lang-test-eus.cognitiveservices.azure.com", + "region": "eastus" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..387660ced7a0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json new file mode 100644 index 000000000000..89fdd786fd16 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json new file mode 100644 index 000000000000..2ad3977c028d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCopyProjectAuthorization.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "body": { + "projectKind": "Conversation", + "allowOverwrite": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "Conversation", + "targetProjectName": "EmailApp", + "accessToken": "103fcb47-b095-44c1-aedd-4024a5923275", + "expiresAt": "2023-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..6720c16cf7e3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulCreateProject.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2023-11-15-preview", + "projectName": "myproject", + "body": { + "projectName": "myproject", + "language": "en", + "projectKind": "Conversation", + "description": "This is a sample conversation project.", + "multilingual": false + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..458105aa84ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeployment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json new file mode 100644 index 000000000000..c4ae733dba9b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteDeploymentFromResources.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "deploymentName": "staging", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..1ec91ccc9a39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteModel.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..01ee12153492 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeleteProject.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "myproject" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..3e343c420e6b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulDeployProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66", + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json new file mode 100644 index 000000000000..1b728aa8d6ab --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulEvaluationProject.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "body": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..a74925a1786a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulExportProject.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..76c30ecb7cdc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json new file mode 100644 index 000000000000..76c30ecb7cdc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetCopyProjectStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..67e2b23c4065 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeployment.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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-15-preview", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..d1d278d64741 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json new file mode 100644 index 000000000000..3550e627da23 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetEvaluationStatus.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 60, + "testingSplitPercentage": 40 + }, + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "percentComplete": 30 + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..7816960205c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetExportStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..6cf57959e448 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetImportStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..c4ae955a4162 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..406ae3480991 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModel.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..57c9885788cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluation.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview&top=2147483637&skip={maxpagesize}&maxpagesize={maxpagesize}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..ebafdb6d3f4b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,526 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "entitiesEvaluation": { + "confusionMatrix": { + "Attachment": { + "Attachment": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + }, + "Category": { + "Category": { + "normalizedValue": 91.666664, + "rawValue": 11.0 + }, + "$none": { + "normalizedValue": 8.333333, + "rawValue": 1.0 + } + }, + "ContactName": { + "ContactName": { + "normalizedValue": 91.666664, + "rawValue": 22.0 + }, + "SenderName": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + }, + "$none": { + "normalizedValue": 4.1666665, + "rawValue": 1.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "EmailSubject": { + "EmailSubject": { + "normalizedValue": 93.33333, + "rawValue": 9.333334 + }, + "$none": { + "normalizedValue": 6.6666665, + "rawValue": 0.6666667 + } + }, + "FromRelationshipName": { + "FromRelationshipName": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "Line": { + "Line": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "Message": { + "Message": { + "normalizedValue": 81.2063, + "rawValue": 6.496504 + }, + "EmailSubject": { + "normalizedValue": 7.43007, + "rawValue": 0.5944056 + }, + "$none": { + "normalizedValue": 9.120047, + "rawValue": 0.7296037 + }, + "Date": { + "normalizedValue": 2.2435899, + "rawValue": 0.17948718 + } + }, + "OrderReference": { + "OrderReference": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "PositionReference": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "RelationshipName": { + "RelationshipName": { + "normalizedValue": 66.666664, + "rawValue": 2.0 + }, + "$none": { + "normalizedValue": 33.333332, + "rawValue": 1.0 + } + }, + "SearchTexts": { + "SearchTexts": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "SenderName": { + "SenderName": { + "normalizedValue": 88.888885, + "rawValue": 8.0 + }, + "ContactName": { + "normalizedValue": 11.111111, + "rawValue": 1.0 + } + }, + "Time": { + "$none": { + "normalizedValue": 100.0, + "rawValue": 2.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.739265, + "rawValue": 162.575 + }, + "Category": { + "normalizedValue": 0.2607362, + "rawValue": 0.425 + } + } + }, + "entities": { + "ContactName": { + "f1": 0.9361702799797058, + "precision": 0.95652174949646, + "recall": 0.9166666865348816, + "truePositiveCount": 22, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 2 + }, + "Category": { + "f1": 0.8799999952316284, + "precision": 0.8461538553237915, + "recall": 0.9166666865348816, + "truePositiveCount": 11, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "SenderName": { + "f1": 0.8888888955116272, + "precision": 0.8888888955116272, + "recall": 0.8888888955116272, + "truePositiveCount": 8, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + }, + "EmailSubject": { + "f1": 0.8181817531585693, + "precision": 0.75, + "recall": 0.8999999761581421, + "truePositiveCount": 9, + "trueNegativeCount": 0, + "falsePositiveCount": 3, + "falseNegativeCount": 1 + }, + "Message": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 6, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 2 + }, + "Date": { + "f1": 0.800000011920929, + "precision": 0.6666666865348816, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 0 + }, + "OrderReference": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchTexts": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Attachment": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "RelationshipName": { + "f1": 0.800000011920929, + "precision": 1.0, + "recall": 0.6666666865348816, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + }, + "Line": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 2, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Time": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 2 + }, + "FromRelationshipName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "PositionReference": { + "f1": 0.0, + "precision": 0.0, + "recall": 0.0, + "truePositiveCount": 0, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 1 + } + }, + "microF1": 0.8923077, + "microPrecision": 0.8969072, + "microRecall": 0.8877551, + "macroF1": 0.7766601, + "macroPrecision": 0.7755879, + "macroRecall": 0.78849214 + }, + "intentsEvaluation": { + "confusionMatrix": { + "AddFlag": { + "AddFlag": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "AddMore": { + "AddMore": { + "normalizedValue": 100.0, + "rawValue": 17.0 + } + }, + "Cancel": { + "Cancel": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "CheckMessages": { + "CheckMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "Confirm": { + "Confirm": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Delete": { + "Delete": { + "normalizedValue": 100.0, + "rawValue": 5.0 + } + }, + "Forward": { + "Forward": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "None": { + "None": { + "normalizedValue": 100.0, + "rawValue": 1.0 + } + }, + "QueryLastText": { + "QueryLastText": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "ReadAloud": { + "ReadAloud": { + "normalizedValue": 100.0, + "rawValue": 16.0 + } + }, + "Reply": { + "Reply": { + "normalizedValue": 100.0, + "rawValue": 6.0 + } + }, + "SearchMessages": { + "SearchMessages": { + "normalizedValue": 100.0, + "rawValue": 9.0 + } + }, + "SendEmail": { + "SendEmail": { + "normalizedValue": 100.0, + "rawValue": 20.0 + } + }, + "ShowNext": { + "ShowNext": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "ShowPrevious": { + "ShowPrevious": { + "normalizedValue": 100.0, + "rawValue": 3.0 + } + } + }, + "intents": { + "AddMore": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 17, + "trueNegativeCount": 104, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Cancel": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SendEmail": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 20, + "trueNegativeCount": 101, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "CheckMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "AddFlag": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Reply": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ReadAloud": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 16, + "trueNegativeCount": 105, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "QueryLastText": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "SearchMessages": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 9, + "trueNegativeCount": 112, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Delete": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 5, + "trueNegativeCount": 116, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Forward": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 6, + "trueNegativeCount": 115, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Confirm": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowNext": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 117, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "ShowPrevious": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 3, + "trueNegativeCount": 118, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "None": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 1, + "trueNegativeCount": 120, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + } + }, + "microF1": 1.0, + "microPrecision": 1.0, + "microRecall": 1.0, + "macroF1": 1.0, + "macroPrecision": 1.0, + "macroRecall": 1.0 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..9942cc6d6a3d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "myproject" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "Conversation", + "projectName": "myproject", + "multilingual": false, + "description": "This is a sample conversation project.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..82ffe6b1da66 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..016ca7bcbc5d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,398 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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": "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", + "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": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..e4cf95b7fff0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "Person.Name", + "description": "Name of an individual", + "examples": "john, Sam, Lisa" + }, + { + "category": "General.Event", + "description": "Important events", + "examples": "World War two, Covid 19" + }, + { + "category": "General.Organization", + "description": "Companies and corporations", + "examples": "Microsoft, Amazon" + }, + { + "category": "Choice.Boolean", + "description": "boolean choice", + "examples": "yes, no, agreed" + }, + { + "category": "Quantity.Age", + "description": "Age of a person or thing", + "examples": "10-month-old, 19 years old, 58 year-old" + }, + { + "category": "Quantity.NumberRange", + "description": "a numeric interval", + "examples": "between 25 and 35, 25-35" + }, + { + "category": "Quantity.Number", + "description": "A cardinal number in numeric or text form", + "examples": "ten, forty two, 3.141, 10K" + }, + { + "category": "Quantity.Percentage", + "description": "A percentage, using the symbol % or the word \"percent\"", + "examples": "10%, 5.6 percent" + }, + { + "category": "Quantity.Ordinal", + "description": "An ordinal number in numeric or text form", + "examples": "first, second, tenth, 1st, 2nd, 10th" + }, + { + "category": "Quantity.Dimension", + "description": "Spacial dimensions, including length, distance, area, and volume", + "examples": "2 miles, 650 square kilometres, 9,350 feet" + }, + { + "category": "Quantity.Temperature", + "description": "A temperature in celsius or fahrenheit", + "examples": "32F, 34 degrees celsius, 2 deg C" + }, + { + "category": "Quantity.Currency", + "description": "Monetary amounts, including currency", + "examples": "1000.00 US dollars, £20.00, $ 67.5 B" + }, + { + "category": "DateTime", + "description": "exact date values", + "examples": "May 11th" + }, + { + "category": "Email", + "description": "Email addresses", + "examples": "user@example.net, user_name@example.com, user.Name12@example.net" + }, + { + "category": "Phone Number", + "description": "US phone numbers", + "examples": "123-456-7890, +1 123 456 789, (123)456-789" + }, + { + "category": "URL", + "description": "Websites URLs and links", + "examples": "www.example.com, http://example.net?name=my_name&age=10" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..707b4457c5c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectKind": "Conversation" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..b060ec989aab --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..84b8eac30eb0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..76c30ecb7cdc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..56913bcefd68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulImportProject.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "Conversation", + "settings": { + "confidenceThreshold": 0.7 + }, + "projectName": "EmailApp", + "multilingual": true, + "description": "Trying out CLU", + "language": "en-us" + }, + "assets": { + "projectKind": "Conversation", + "intents": [ + { + "category": "Read" + }, + { + "category": "Delete" + } + ], + "entities": [ + { + "category": "Sender" + }, + { + "category": "Number", + "regex": { + "expressions": [ + { + "regexKey": "UK Phone numbers", + "language": "en-us", + "regexPattern": "/^\\(?([0-9]{3})\\)?[-.\\s]?([0-9]{3})[-.\\s]?([0-9]{4})$/" + } + ] + } + } + ], + "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=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json new file mode 100644 index 000000000000..674f8a6b2f74 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListAssignedResourceDeployments.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "projectName": "Booking", + "deploymentsMetadata": [ + { + "deploymentName": "staging", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "deploymentExpirationDate": "2023-10-28" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json new file mode 100644 index 000000000000..0077589921bf --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeploymentResources.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..acd575bcd6af --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListDeployments.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + }, + { + "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", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json new file mode 100644 index 000000000000..88642a515cf7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListModels.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..a26a417ff349 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListProjects.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview" + }, + "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/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..b12a9a4ecf1b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulListTrainingJobs.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "advanced", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingMode": "standard", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..8ac06f7aabcc --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulLoadSnapshot.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..c5ae6bbdf0f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulSwapDeployments.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..33868da9938e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulTrainProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "body": { + "modelLabel": "model1", + "trainingMode": "standard", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json new file mode 100644 index 000000000000..6918c5196fad --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzeconversations-authoring/SuccessfulUnassignDeploymentResources.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "EmailApp", + "deploymentName": "production", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/EmailApp/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json new file mode 100644 index 000000000000..bf27d49f14c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulAssignDeploymentResources.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "resourcesMetadata": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "customDomain": "lang-test-weu.cognitiveservices.azure.com", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "customDomain": "lang-test-eus.cognitiveservices.azure.com", + "region": "eastus" + } + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/resources/assign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json new file mode 100644 index 000000000000..a61eaec25f77 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCancelTrainingJob.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json new file mode 100644 index 000000000000..0064045fecc0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProject.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "projectKind": "CustomEntityRecognition", + "targetProjectName": "LoanAgreements", + "accessToken": "c0b13e0c-e9fe-4afa-aa11-db3b9b28f5e2", + "expiresAt": "2022-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/copy/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json new file mode 100644 index 000000000000..25c7dc079672 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCopyProjectAuthorization.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "allowOverwrite": false + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "CustomEntityRecognition", + "targetProjectName": "LoanAgreements", + "accessToken": "c0b13e0c-e9fe-4afa-aa11-db3b9b28f5e2", + "expiresAt": "2022-04-18T13:53:03Z", + "targetResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "targetResourceRegion": "westeurope" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json new file mode 100644 index 000000000000..29f14547ec78 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateExportedModel.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1", + "body": { + "trainedModelLabel": "model1" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..29d21b40d229 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulCreateProject.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/merge-patch+json", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "projectName": "LoanAgreements", + "language": "en", + "projectKind": "CustomEntityRecognition", + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "multilingual": false, + "storageInputContainerName": "loanagreements" + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + } + }, + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json new file mode 100644 index 000000000000..931ec2e49c2e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeployment.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json new file mode 100644 index 000000000000..fadf028c7779 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteDeploymentFromResources.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "deploymentName": "staging", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/deployments/staging/delete-from-resources/jobs/61ebb7ef-a207-40d2-82b9-5285440ae579_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json new file mode 100644 index 000000000000..8ba145a7c170 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteExportedModel.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/exported-models/exported-model1/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json new file mode 100644 index 000000000000..4a69462b4f73 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteModel.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model2" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..8cd8c372fab2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeleteProject.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/global/deletion-jobs/129d3182-625d-496c-bcf9-43686e85160b_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json new file mode 100644 index 000000000000..a2a23170f4d0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulDeployProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "deploymentName": "production", + "body": { + "trainedModelLabel": "29886710a2ae49259d62cffca977db66", + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/production/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json new file mode 100644 index 000000000000..c23f45708f61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulEvaluationProject.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model1", + "body": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model1/evaluate/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json new file mode 100644 index 000000000000..3ee1750f1141 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulExportProject.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..836a35533fc6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetAssignDeploymentResourcesStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json new file mode 100644 index 000000000000..836a35533fc6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetCopyProjectStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json new file mode 100644 index 000000000000..c3c671194999 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeployment.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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-15-preview", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json new file mode 100644 index 000000000000..9749469554ba --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetDeploymentStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "deploymentName": "production", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json new file mode 100644 index 000000000000..4c77a1179c42 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetEvaluationStatus.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 60, + "testingSplitPercentage": 40 + }, + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "percentComplete": 30 + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json new file mode 100644 index 000000000000..79d06ed1572b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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=2023-11-15-preview", + "jobId": "c4946bfa-4fbf-493b-bfcf-2d232eb9de69_637858368000000000", + "createdDateTime": "2022-04-18T15:23:07Z", + "lastUpdatedDateTime": "2022-04-18T15:23:08Z", + "expirationDateTime": "2022-04-25T15:23:07Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json new file mode 100644 index 000000000000..0fc51af6c814 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModel.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "exportedModelName": "exported-model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2023-04-18T15:47:49Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json new file mode 100644 index 000000000000..dcf26a528f3e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelManifest.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "modelFiles": [ + { + "name": "customModelFile", + "contentUri": "https://dummy.blob.core.windows.net/custommodel" + }, + { + "name": "customModelFile1", + "contentUri": "https://aicpstaticfilesdev.blob.core.windows.net/custommodel1" + }, + { + "name": "BaseModelfile1", + "contentUri": "https://aicpstaticfilesdev.blob.core.windows.net/basemodel1" + }, + { + "name": "customModelFile2", + "contentUri": "https://aicpstaticfilesdev.blob.core.windows.net/custommodel2" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json new file mode 100644 index 000000000000..bb8127d4fba8 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetExportedModelStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "exportedModelName": "exported-model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2023-04-18T15:44:44Z", + "lastUpdatedDateTime": "2023-04-18T15:45:48Z", + "expirationDateTime": "2023-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json new file mode 100644 index 000000000000..47931db36c5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetImportStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c95efa2a-44e8-461e-8aa5-04b4677bfa84_637858368000000000", + "createdDateTime": "2022-04-18T15:17:20Z", + "lastUpdatedDateTime": "2022-04-18T15:17:22Z", + "expirationDateTime": "2022-04-25T15:17:20Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json new file mode 100644 index 000000000000..c4f927426af1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetLoadSnapshotStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model1", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json new file mode 100644 index 000000000000..922e5ec49975 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModel.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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-15-preview", + "hasSnapshot": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json new file mode 100644 index 000000000000..a59ea92b2c52 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluation.json @@ -0,0 +1,295 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model2", + "stringIndexType": "Utf16CodeUnit", + "maxpagesize": 10 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "location": "11.txt", + "language": "en-us", + "projectKind": "CustomEntityRecognition", + "customEntityRecognitionResult": { + "entities": [ + { + "expectedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 181, + "length": 34 + }, + { + "category": "BorrowerCity", + "offset": 225, + "length": 6 + }, + { + "category": "BorrowerState", + "offset": 242, + "length": 8 + }, + { + "category": "LenderName", + "offset": 271, + "length": 12 + }, + { + "category": "LenderAddress", + "offset": 310, + "length": 20 + }, + { + "category": "LenderCity", + "offset": 340, + "length": 8 + }, + { + "category": "LenderState", + "offset": 359, + "length": 11 + }, + { + "category": "LoanAmountWords", + "offset": 448, + "length": 52 + }, + { + "category": "LoanAmountNumbers", + "offset": 502, + "length": 10 + }, + { + "category": "Interest", + "offset": 588, + "length": 2 + } + ], + "predictedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 200, + "length": 15 + }, + { + "category": "BorrowerCity", + "offset": 225, + "length": 6 + }, + { + "category": "BorrowerState", + "offset": 242, + "length": 8 + }, + { + "category": "LenderName", + "offset": 271, + "length": 12 + }, + { + "category": "LenderAddress", + "offset": 310, + "length": 20 + }, + { + "category": "LenderCity", + "offset": 340, + "length": 8 + }, + { + "category": "LenderState", + "offset": 359, + "length": 11 + }, + { + "category": "LoanAmountWords", + "offset": 448, + "length": 52 + }, + { + "category": "LoanAmountNumbers", + "offset": 502, + "length": 10 + }, + { + "category": "Interest", + "offset": 588, + "length": 2 + } + ], + "regionOffset": 0, + "regionLength": 1780 + } + ] + } + }, + { + "location": "01.txt", + "language": "en-us", + "projectKind": "CustomEntityRecognition", + "customEntityRecognitionResult": { + "entities": [ + { + "expectedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 200, + "length": 13 + }, + { + "category": "BorrowerCity", + "offset": 223, + "length": 9 + }, + { + "category": "BorrowerState", + "offset": 243, + "length": 8 + }, + { + "category": "LenderName", + "offset": 273, + "length": 14 + }, + { + "category": "LenderAddress", + "offset": 314, + "length": 15 + }, + { + "category": "LenderCity", + "offset": 339, + "length": 10 + }, + { + "category": "LenderState", + "offset": 360, + "length": 8 + }, + { + "category": "LoanAmountWords", + "offset": 446, + "length": 66 + }, + { + "category": "LoanAmountNumbers", + "offset": 514, + "length": 11 + }, + { + "category": "Interest", + "offset": 601, + "length": 2 + } + ], + "predictedEntities": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "BorrowerName", + "offset": 160, + "length": 13 + }, + { + "category": "BorrowerAddress", + "offset": 200, + "length": 13 + }, + { + "category": "BorrowerCity", + "offset": 223, + "length": 9 + }, + { + "category": "BorrowerState", + "offset": 243, + "length": 8 + }, + { + "category": "LenderName", + "offset": 273, + "length": 14 + }, + { + "category": "LenderAddress", + "offset": 314, + "length": 15 + }, + { + "category": "LenderCity", + "offset": 339, + "length": 10 + }, + { + "category": "LenderState", + "offset": 360, + "length": 8 + }, + { + "category": "LoanAmountWords", + "offset": 446, + "length": 66 + }, + { + "category": "LoanAmountNumbers", + "offset": 514, + "length": 11 + }, + { + "category": "Interest", + "offset": 601, + "length": 2 + } + ], + "regionOffset": 0, + "regionLength": 1793 + } + ] + } + } + ], + "nextLink": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/models/model2/evaluation/result/?api-version=2023-11-15-preview&top=2147483645&skip={maxpagesize}&maxpagesize={maxpagesize}" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json new file mode 100644 index 000000000000..d177c2118f01 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetModelEvaluationSummary.json @@ -0,0 +1,232 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model2" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectKind": "CustomEntityRecognition", + "customEntityRecognitionEvaluation": { + "confusionMatrix": { + "BorrowerAddress": { + "BorrowerAddress": { + "normalizedValue": 86.206894, + "rawValue": 3.4482758 + }, + "$none": { + "normalizedValue": 13.793103, + "rawValue": 0.55172414 + } + }, + "BorrowerCity": { + "BorrowerCity": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "BorrowerName": { + "BorrowerName": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "BorrowerState": { + "BorrowerState": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Date": { + "Date": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "Interest": { + "Interest": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderAddress": { + "LenderAddress": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderCity": { + "LenderCity": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderName": { + "LenderName": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LenderState": { + "LenderState": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LoanAmountNumbers": { + "LoanAmountNumbers": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "LoanAmountWords": { + "LoanAmountWords": { + "normalizedValue": 100.0, + "rawValue": 4.0 + } + }, + "$none": { + "$none": { + "normalizedValue": 99.81485, + "rawValue": 51.90372 + }, + "BorrowerAddress": { + "normalizedValue": 0.18315019, + "rawValue": 0.0952381 + }, + "Interest": { + "normalizedValue": 0.002005294, + "rawValue": 0.0010427529 + } + } + }, + "entities": { + "Date": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "BorrowerName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "BorrowerAddress": { + "f1": 0.6666666865348816, + "precision": 0.6000000238418579, + "recall": 0.75, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 2, + "falseNegativeCount": 1 + }, + "BorrowerCity": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "BorrowerState": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderName": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderAddress": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderCity": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LenderState": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LoanAmountWords": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "LoanAmountNumbers": { + "f1": 1.0, + "precision": 1.0, + "recall": 1.0, + "truePositiveCount": 4, + "trueNegativeCount": 0, + "falsePositiveCount": 0, + "falseNegativeCount": 0 + }, + "Interest": { + "f1": 0.75, + "precision": 0.75, + "recall": 0.75, + "truePositiveCount": 3, + "trueNegativeCount": 0, + "falsePositiveCount": 1, + "falseNegativeCount": 1 + } + }, + "microF1": 0.94845366, + "microPrecision": 0.93877554, + "microRecall": 0.9583333, + "macroF1": 0.9513889, + "macroPrecision": 0.9458334, + "macroRecall": 0.9583333 + }, + "evaluationOptions": { + "kind": "percentage", + "trainingSplitPercentage": 80, + "testingSplitPercentage": 20 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..a1584f2c2055 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json new file mode 100644 index 000000000000..82ffe6b1da66 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetProjectDeletionStatus.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json new file mode 100644 index 000000000000..39cce4f8ce15 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedLanguages.json @@ -0,0 +1,389 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview" + }, + "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": "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", + "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": "Odia", + "languageCode": "or" + }, + { + "languageName": "Punjabi", + "languageCode": "pa" + }, + { + "languageName": "Polish", + "languageCode": "pl" + }, + { + "languageName": "Pashto", + "languageCode": "ps" + }, + { + "languageName": "Romanian", + "languageCode": "ro" + }, + { + "languageName": "Russian", + "languageCode": "ru" + }, + { + "languageName": "Sanskrit", + "languageCode": "sa" + }, + { + "languageName": "Sindhi", + "languageCode": "sd" + }, + { + "languageName": "Sinhala", + "languageCode": "si" + }, + { + "languageName": "Slovak", + "languageCode": "sk" + }, + { + "languageName": "Slovenian", + "languageCode": "sl" + }, + { + "languageName": "Somali", + "languageCode": "so" + }, + { + "languageName": "Albanian", + "languageCode": "sq" + }, + { + "languageName": "Serbian", + "languageCode": "sr" + }, + { + "languageName": "Sundanese", + "languageCode": "su" + }, + { + "languageName": "Swedish", + "languageCode": "sv" + }, + { + "languageName": "Swahili", + "languageCode": "sw" + }, + { + "languageName": "Tamil", + "languageCode": "ta" + }, + { + "languageName": "Telugu", + "languageCode": "te" + }, + { + "languageName": "Thai", + "languageCode": "th" + }, + { + "languageName": "Filipino", + "languageCode": "tl" + }, + { + "languageName": "Turkish", + "languageCode": "tr" + }, + { + "languageName": "Uyghur", + "languageCode": "ug" + }, + { + "languageName": "Ukrainian", + "languageCode": "uk" + }, + { + "languageName": "Urdu", + "languageCode": "ur" + }, + { + "languageName": "Uzbek", + "languageCode": "uz" + }, + { + "languageName": "Vietnamese", + "languageCode": "vi" + }, + { + "languageName": "Xhosa", + "languageCode": "xh" + }, + { + "languageName": "Yiddish", + "languageCode": "yi" + }, + { + "languageName": "Chinese (Simplified)", + "languageCode": "zh-hans" + }, + { + "languageName": "Chinese (Traditional)", + "languageCode": "zh-hant" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json new file mode 100644 index 000000000000..75bdca0bc7ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedPrebuiltEntities.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "language": "en" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "category": "BodyStructure", + "description": "Body systems, anatomic locations or regions, and body sites", + "examples": "arm, knee, abdomen, nose, liver, head, respiratory system, lymphocytes" + }, + { + "category": "Age", + "description": "All age terms and phrases, including ones for patients, family members, and others", + "examples": "40-year-old, 51 yo, 3 months old, adult, infant, elderly, young, minor, middle-aged" + }, + { + "category": "Gender", + "description": "Terms that disclose the gender of the subject", + "examples": "male, female, woman, gentleman, lady" + }, + { + "category": "Ethnicity", + "description": "Phrases that indicate the ethnicity of the subject", + "examples": "African American, Asian" + }, + { + "category": "ExaminationName", + "description": "Diagnostic procedures and tests, including vital signs and body measurements", + "examples": "MRI, ECG, HIV test, hemoglobin, platelets count, scale systems such as Bristol stool scale" + }, + { + "category": "Date", + "description": "Full date relating to a medical condition, examination, treatment, medication, or administrative event", + "examples": "May 11th" + }, + { + "category": "Direction", + "description": "Directional terms that may relate to a body structure, medical condition, examination, or treatment", + "examples": "left, lateral, upper, posterior" + }, + { + "category": "Frequency", + "description": "how often a medical condition, examination, treatment, or medication occurred, occurs, or should occur", + "examples": "usually" + }, + { + "category": "MeasurementValue", + "description": "The value related to an examination or a medical condition measurement", + "examples": "1, 18" + }, + { + "category": "MeasurementUnit", + "description": "The unit of measurement related to an examination or a medical condition measurement", + "examples": "cm" + }, + { + "category": "RelationalOperator", + "description": "Phrases that express the quantitative relation between an entity and some additional information", + "examples": ">, <=" + }, + { + "category": "Time", + "description": "Temporal terms relating to the beginning and/or length (duration) of a medical condition, examination, treatment, medication, or administrative event", + "examples": "10/92" + }, + { + "category": "Course", + "description": "Description of a change in another entity over time, such as condition progression / a course of treatment or medication", + "examples": "improvement, worsening, resolution, remission, increase in medication dosage" + }, + { + "category": "GeneOrProtein", + "description": "All mentions of names and symbols of human genes as well as chromosomes and parts of chromosomes and proteins", + "examples": "MTRR, F2" + }, + { + "category": "Variant", + "description": "All mentions of gene variations and mutations", + "examples": "c.524C>T, (MTRR):r.1462_1557del96" + }, + { + "category": "Expression", + "description": "Gene expression level", + "examples": "positive for-, negative for-, overexpressed, detected in high/low levels, elevated" + }, + { + "category": "MutationType", + "description": "MTRR, F2", + "examples": "trisomy, germline mutation, loss of function" + }, + { + "category": "AdministrativeEvent", + "description": "Events that relate to the healthcare system but of an administrative/semi-administrative nature", + "examples": "registration, admission, trial, study entry, transfer, discharge, hospitalization, hospital stay" + }, + { + "category": "CareEnvironment", + "description": "registration, admission, trial, study entry, transfer, discharge, hospitalization, hospital stay", + "examples": "emergency room, physician’s office, cardio unit, hospice, hospital" + }, + { + "category": "HealthcareProfession", + "description": "emergency room, physician’s office, cardio unit, hospice, hospital", + "examples": "dentist, pathologist, neurologist, radiologist, pharmacist, nutritionist, physical therapist, chiropractor" + }, + { + "category": "Diagnosis", + "description": "Disease, syndrome, poisoning", + "examples": "breast cancer, Alzheimer’s, HTN, CHF, spinal cord injury" + }, + { + "category": "SymptomOrSign", + "description": "Subjective or objective evidence of disease or other diagnoses", + "examples": "chest pain, headache, dizziness, rash, SOB, abdomen was soft, good bowel sounds, well nourished" + }, + { + "category": "ConditionQualifier", + "description": "Qualitative terms that are used to describe a medical condition", + "examples": "sudden, acute, chronic, longstanding, burning, sharp, severe, mild, a bit, uncontrolled, local, focal, diffuse" + }, + { + "category": "ConditionScale", + "description": "Qualitative terms that characterize the condition by a scale, which is a finite ordered list of values", + "examples": "stage III" + }, + { + "category": "MedicationClass", + "description": "A set of medications that have a similar mechanism of action, a related mode of action, a similar chemical structure, and/or are used to treat the same disease", + "examples": "ACE inhibitor, opioid, antibiotics, pain relievers" + }, + { + "category": "MedicationName", + "description": "Medication mentions, including copyrighted brand names, and non-brand names", + "examples": "Ibuprofen" + }, + { + "category": "Dosage", + "description": "Amount of medication ordered", + "examples": "Infuse Sodium Chloride solution 1000 mL" + }, + { + "category": "MedicationForm", + "description": "The form of the medication", + "examples": "solution, pill, capsule, tablet, patch, gel, paste, foam, spray, drops, cream, syrup" + }, + { + "category": "MedicationRoute", + "description": "The administration method of medication", + "examples": "oral, topical, inhaled" + }, + { + "category": "FamilyRelation", + "description": "Mentions of family relatives of the subject", + "examples": "father, daughter, siblings, parents" + }, + { + "category": "TreatmentName", + "description": "Therapeutic procedures", + "examples": "knee replacement surgery, bone marrow transplant, TAVI, diet" + }, + { + "category": "Allergen", + "description": "an antigen triggering an allergic reaction", + "examples": "cats, peanuts" + }, + { + "category": "Employment", + "description": "Mentions of employment status including specific profession", + "examples": "unemployed, retired, firefighter, student" + }, + { + "category": "LivingStatus", + "description": "Mentions of the housing situation", + "examples": "homeless, living with parents, living alone, living with others" + }, + { + "category": "SubstanceUse", + "description": "Mentions of use of legal or illegal drugs, tobacco or alcohol", + "examples": "smoking, drinking, or heroin" + }, + { + "category": "SubstanceUseAmount", + "description": "Mentions of specific amounts of substance use", + "examples": "a pack (of cigarettes) or a few glasses (of wine)" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json new file mode 100644 index 000000000000..58be02b3393e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSupportedTrainingConfigVersions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectKind": "CustomEntityRecognition" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "trainingConfigVersion": "2022-05-01", + "modelExpirationDate": "2022-10-28" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json new file mode 100644 index 000000000000..fdcd37c966f5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetSwapDeploymentsStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000", + "createdDateTime": "2022-04-18T16:09:50Z", + "lastUpdatedDateTime": "2022-04-18T16:09:58Z", + "expirationDateTime": "2022-04-25T16:09:50Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json new file mode 100644 index 000000000000..73a0b5eb4bf4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetTrainStatus.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "estimatedEndDateTime": "2022-04-18T15:47:58.8190649Z", + "trainingStatus": { + "percentComplete": 3, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "status": "running" + }, + "evaluationStatus": { + "percentComplete": 0, + "status": "notStarted" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:45:48Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "running" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json new file mode 100644 index 000000000000..836a35533fc6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulGetUnassignDeploymentResourcesStatus.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "jobId": "66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000", + "createdDateTime": "2022-04-18T15:52:48Z", + "lastUpdatedDateTime": "2022-04-18T15:53:04Z", + "expirationDateTime": "2022-04-25T15:52:48Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json new file mode 100644 index 000000000000..cf3649a08ae5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulImportProject.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "projectFileVersion": "2022-05-01", + "stringIndexType": "Utf16CodeUnit", + "metadata": { + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "settings": {}, + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + }, + "assets": { + "projectKind": "CustomEntityRecognition", + "entities": [ + { + "category": "Date" + }, + { + "category": "LenderName" + }, + { + "category": "LenderAddress" + } + ], + "documents": [ + { + "location": "01.txt", + "language": "en-us", + "entities": [ + { + "regionOffset": 0, + "regionLength": 1793, + "labels": [ + { + "category": "Date", + "offset": 5, + "length": 9 + }, + { + "category": "LenderName", + "offset": 273, + "length": 14 + }, + { + "category": "LenderAddress", + "offset": 314, + "length": 15 + } + ] + } + ] + }, + { + "location": "02.txt", + "language": "en-us", + "entities": [ + { + "regionOffset": 0, + "regionLength": 1804, + "labels": [ + { + "category": "Date", + "offset": 5, + "length": 10 + }, + { + "category": "LenderName", + "offset": 284, + "length": 10 + }, + { + "category": "LenderAddress", + "offset": 321, + "length": 20 + } + ] + } + ] + } + ] + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/import/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2022-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json new file mode 100644 index 000000000000..674f8a6b2f74 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListAssignedResourceDeployments.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "projectName": "Booking", + "deploymentsMetadata": [ + { + "deploymentName": "staging", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "deploymentExpirationDate": "2023-10-28" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json new file mode 100644 index 000000000000..9a1ee12625be --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeploymentResources.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "azureResourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json new file mode 100644 index 000000000000..4311a814417c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListDeployments.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + }, + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestEus", + "region": "eastus" + } + ] + }, + { + "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", + "assignedResources": [ + { + "resourceId": "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu", + "region": "westeurope" + } + ] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json new file mode 100644 index 000000000000..115080371aff --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListExportedModels.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "exportedModelName": "exported-model1", + "modelId": "model1-20220418T034749-299f45b8114849538c1a750b21b05a94", + "lastTrainedDateTime": "2023-04-18T15:47:49Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + }, + { + "exportedModelName": "exported-model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2023-04-18T17:25:22Z", + "lastExportedModelDateTime": "2023-04-18T16:03:51Z", + "modelExpirationDate": "2023-10-28", + "modelTrainingConfigVersion": "2022-05-01" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json new file mode 100644 index 000000000000..5c78a1f7ded0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListModels.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "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", + "hasSnapshot": true + }, + { + "label": "model2", + "modelId": "model2-20220418T052522-c63bd244dd9e4bf8adec1a7129968c99", + "lastTrainedDateTime": "2022-04-18T17:25:22Z", + "lastTrainingDurationInSeconds": 192, + "modelExpirationDate": "2022-10-28", + "modelTrainingConfigVersion": "2022-05-01", + "hasSnapshot": true + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json new file mode 100644 index 000000000000..3bc919487a88 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListProjects.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "createdDateTime": "2022-04-18T13:53:03Z", + "lastModifiedDateTime": "2022-04-18T13:53:03Z", + "lastTrainedDateTime": "2022-04-18T14:14:28Z", + "lastDeployedDateTime": "2022-04-18T14:49:01Z", + "projectKind": "CustomEntityRecognition", + "storageInputContainerName": "loanagreements", + "projectName": "LoanAgreements", + "multilingual": false, + "description": "This is a sample dataset provided by the Azure Language service team to help users get started with [Custom named entity recognition](https://aka.ms/ct-docs). The provided sample dataset contains 20 loan agreements drawn up between two entities.", + "language": "en" + }, + { + "createdDateTime": "2022-04-18T14:03:12Z", + "lastModifiedDateTime": "2022-04-18T14:03:12Z", + "projectKind": "CustomMultiLabelClassification", + "storageInputContainerName": "loanagreements", + "projectName": "MoviesSummary", + "multilingual": false, + "description": "This is a sample dataset adapted from the CMU Movie Summary public dataset. This was prepared by Microsoft Azure Language Services product team to prepare this dataset to be used as a sample for getting started with Custom text classification. This sample dataset consists of 210 files each of them is a movie summary. Each movie can be classified into one or more of the following classes: \"Mystery\", \"Drama\", \"Thriller\", \"Comedy\", \"Action\".", + "language": "en" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json new file mode 100644 index 000000000000..b67af813151f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulListTrainingJobs.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "result": { + "modelLabel": "model1", + "trainingConfigVersion": "2022-05-01", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:45:06.8190649Z", + "endDateTime": "2022-04-18T15:47:19.2639682Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T15:47:19.2734976Z", + "endDateTime": "2022-04-18T15:47:23.8378892Z", + "status": "succeeded" + } + }, + "jobId": "8ccf2ffe-e758-4d04-a44a-31512918c7e8_637858368000000000", + "createdDateTime": "2022-04-18T15:44:44Z", + "lastUpdatedDateTime": "2022-04-18T15:47:50Z", + "expirationDateTime": "2022-04-25T15:44:44Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:22:39.3663023Z", + "endDateTime": "2022-04-18T17:24:51.9440947Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:24:51.9571747Z", + "endDateTime": "2022-04-18T17:24:58.1427823Z", + "status": "succeeded" + } + }, + "jobId": "9145f93f-6f37-418c-8527-d2ded84cece0_637858368000000000", + "createdDateTime": "2022-04-18T17:22:11Z", + "lastUpdatedDateTime": "2022-04-18T17:25:23Z", + "expirationDateTime": "2022-04-25T17:22:11Z", + "status": "succeeded" + }, + { + "result": { + "modelLabel": "model2", + "trainingConfigVersion": "2022-05-01", + "trainingStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:44:41.388358Z", + "endDateTime": "2022-04-18T17:50:29.5675101Z", + "status": "succeeded" + }, + "evaluationStatus": { + "percentComplete": 100, + "startDateTime": "2022-04-18T17:50:29.5808461Z", + "endDateTime": "2022-04-18T17:50:35.3482185Z", + "status": "succeeded" + } + }, + "jobId": "ee23c900-354d-4b6d-96e1-8197db2bd5f7_637858368000000000", + "createdDateTime": "2022-04-18T17:44:04Z", + "lastUpdatedDateTime": "2022-04-18T17:51:11Z", + "expirationDateTime": "2022-04-25T17:44:04Z", + "status": "succeeded" + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json new file mode 100644 index 000000000000..5a5c8054f28a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulLoadSnapshot.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "trainedModelLabel": "model1" + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/models/model1/load-snapshot/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json new file mode 100644 index 000000000000..1bc18f95bfed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulSwapDeployments.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "firstDeploymentName": "production", + "secondDeploymentName": "staging" + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/deployments/swap/jobs/c36a8775-35b9-4cb5-a8db-665e7d91aafe_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json new file mode 100644 index 000000000000..25f6470ed9b3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulTrainProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "body": { + "modelLabel": "model1", + "trainingConfigVersion": "latest", + "evaluationOptions": { + "kind": "percentage", + "testingSplitPercentage": 20, + "trainingSplitPercentage": 80 + } + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-text/projects/LoanAgreements/train/jobs/4d37982f-fded-4c2c-afe3-15953b5919b6_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json new file mode 100644 index 000000000000..d61b6cc9f7f7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/analyzetext-authoring/SuccessfulUnassignDeploymentResources.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "projectName": "LoanAgreements", + "deploymentName": "production", + "body": { + "assignedResourceIds": [ + "/subscriptions/8ff19748-59ed-4e8a-af4b-7ce285849735/resourceGroups/test-rg/providers/Microsoft.CognitiveServices/accounts/LangTestWeu" + ] + } + }, + "responses": { + "202": { + "headers": { + "operation-location": "{Endpoint}/language/authoring/analyze-conversations/projects/LoanAgreements/resources/unassign/jobs/66fa9a67-a561-42f1-8a13-f3a879b1a324_637858368000000000?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json new file mode 100644 index 000000000000..569a88a1d766 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversations.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "id": "1", + "participantId": "1", + "text": "play In the air tonight from Phil Collins" + } + }, + "parameters": { + "projectName": "{project-name}", + "deploymentName": "{deployment-name}", + "stringIndexType": "TextElement_V8" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "play In the air tonight from Phil Collins", + "prediction": { + "topIntent": "PlayMusic", + "projectKind": "Conversation", + "intents": [ + { + "category": "PlayMusic", + "confidenceScore": 1 + }, + { + "category": "SearchCreativeWork", + "confidenceScore": 0 + }, + { + "category": "AddToPlaylist", + "confidenceScore": 0 + } + ], + "entities": [ + { + "category": "Media.Artist", + "text": "Phil Collins", + "offset": 29, + "length": 12, + "confidenceScore": 1 + } + ] + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json new file mode 100644 index 000000000000..e77a2e689645 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitration.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "participantId": "1", + "id": "1", + "modality": "text", + "language": "en-GB", + "text": "How do I integrate QnA Maker and LUIS?" + } + }, + "parameters": { + "projectName": "{project-name}", + "deploymentName": "{deployment-name}", + "verbose": true, + "isLoggingEnabled": false, + "stringIndexType": "TextElement_V8" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "trains from London", + "prediction": { + "topIntent": "Rail", + "projectKind": "Orchestration", + "intents": { + "Rail": { + "confidenceScore": 1, + "targetProjectKind": "Conversation", + "result": { + "query": "trains from London", + "prediction": { + "topIntent": "Timetable", + "projectKind": "Conversation", + "intents": [ + { + "category": "Timetable", + "confidenceScore": 0.99968535 + }, + { + "category": "Locomotive", + "confidenceScore": 0.000314623 + } + ], + "entities": [] + } + } + }, + "Tree": { + "confidenceScore": 0.2641529, + "targetProjectKind": "QuestionAnswering" + }, + "None": { + "confidenceScore": 0, + "targetProjectKind": "NonLinked" + } + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json new file mode 100644 index 000000000000..a2fbc169030e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsArbitrationDirectTarget.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "body": { + "kind": "Conversation", + "analysisInput": { + "conversationItem": { + "text": "Ports and connectors", + "participantId": "1", + "id": "1" + } + }, + "parameters": { + "projectName": "prj1", + "deploymentName": "dep1", + "directTarget": "qnaProject", + "targetProjectParameters": { + "qnaProject": { + "targetProjectKind": "QuestionAnswering", + "callingOptions": { + "context": { + "previousUserQuery": "Meet Surface Pro 4", + "previousQnaId": 4 + }, + "top": 1, + "question": "App Service overview" + } + } + } + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "ConversationResult", + "result": { + "query": "Ports and connectors", + "prediction": { + "projectKind": "Orchestration", + "topIntent": "qnaTargetApp", + "intents": { + "qnaTargetApp": { + "targetProjectKind": "QuestionAnswering", + "confidenceScore": 1, + "result": { + "answers": [ + { + "questions": [ + "App Service overview" + ], + "answer": "The compute resources you use are determined by the *App Service plan* that you run your apps on.", + "confidenceScore": 0.7384000000000001, + "id": 1, + "source": "https://docs.microsoft.com/en-us/azure/app-service/overview", + "metadata": {}, + "dialog": { + "isContextOnly": false, + "prompts": [] + } + } + ] + } + } + } + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json new file mode 100644 index 000000000000..493b9064df40 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulAnalyzeConversationsJobsCancelRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversations/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json new file mode 100644 index 000000000000..b4f57b71d7ed --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionSubmit.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redacting PII data from transcribed audio", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "domain": "generic", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "Good morning John Doe.", + "itn": "good morning john doe", + "maskedItn": "good morning john doe", + "lexical": "good morning john doe", + "wordLevelTimings": [ + { + "word": "good", + "offset": 390000, + "duration": 2700000 + }, + { + "word": "morning", + "offset": 4500000, + "duration": 920000 + }, + { + "word": "john", + "offset": 590000, + "duration": 2700000 + }, + { + "word": "doe", + "offset": 6300000, + "duration": 920000 + } + ] + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation PII", + "kind": "ConversationalPIITask", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "Person" + ], + "redactionSource": "lexical", + "redactAudioTiming": true + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json new file mode 100644 index 000000000000..b1c597611e38 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIExclusionTaskStatusRequest.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Redacting PII from transcribed audio", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "ConversationalPIIResults", + "taskName": "Conversation PII", + "lastUpdateDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "redactedContent": { + "text": "Good morning *************.", + "itn": "good morning *************", + "maskedItn": "good morning *************", + "lexical": "good morning *************", + "audioTimings": [ + { + "offset": 590000, + "duration": 920000 + } + ] + }, + "entities": [] + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2022-05-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json new file mode 100644 index 000000000000..79ffee910b59 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharSubmit.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redacting PII data from transcribed audio", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "domain": "generic", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "Good morning John Doe.", + "itn": "good morning john doe", + "maskedItn": "good morning john doe", + "lexical": "good morning john doe", + "wordLevelTimings": [ + { + "word": "good", + "offset": 390000, + "duration": 2700000 + }, + { + "word": "morning", + "offset": 4500000, + "duration": 920000 + }, + { + "word": "john", + "offset": 590000, + "duration": 2700000 + }, + { + "word": "doe", + "offset": 6300000, + "duration": 920000 + } + ] + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation PII", + "kind": "ConversationalPIITask", + "parameters": { + "modelVersion": "latest", + "piiCategories": [ + "All" + ], + "redactionCharacter": "-", + "redactionSource": "lexical", + "redactAudioTiming": true + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json new file mode 100644 index 000000000000..b9ee5c46f77c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIIRedactionCharTaskStatusRequest.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Redacting PII from transcribed audio", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "ConversationalPIIResults", + "taskName": "Conversation PII", + "lastUpdateDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "redactedContent": { + "text": "Good morning -------------.", + "itn": "good morning -------------", + "maskedItn": "good morning -------------", + "lexical": "good morning -------------", + "audioTimings": [ + { + "offset": 590000, + "duration": 920000 + } + ] + }, + "entities": [ + { + "category": "Person", + "confidenceScore": 0.91, + "length": 8, + "offset": 13, + "text": "john doe" + } + ] + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2022-05-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json new file mode 100644 index 000000000000..4b9fa1bb5de2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIISubmit.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Redacting PII data from transcribed audio", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "domain": "generic", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "Good morning John Doe.", + "itn": "good morning john doe", + "maskedItn": "good morning john doe", + "lexical": "good morning john doe", + "wordLevelTimings": [ + { + "word": "good", + "offset": 390000, + "duration": 2700000 + }, + { + "word": "morning", + "offset": 4500000, + "duration": 920000 + }, + { + "word": "john", + "offset": 590000, + "duration": 2700000 + }, + { + "word": "doe", + "offset": 6300000, + "duration": 920000 + } + ] + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation PII", + "kind": "ConversationalPIITask", + "parameters": { + "modelVersion": "latest", + "piiCategories": [ + "All" + ], + "redactionSource": "lexical", + "redactAudioTiming": true + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json new file mode 100644 index 000000000000..ec075dec0d60 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationPIITaskStatusRequest.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Redacting PII from transcribed audio", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "ConversationalPIIResults", + "taskName": "Conversation PII", + "lastUpdateDateTime": "2022-01-25T15:01:03Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "redactedContent": { + "text": "Good morning *************.", + "itn": "good morning *************", + "maskedItn": "good morning *************", + "lexical": "good morning *************", + "audioTimings": [ + { + "offset": 590000, + "duration": 920000 + } + ] + }, + "entities": [ + { + "category": "Person", + "confidenceScore": 0.91, + "length": 8, + "offset": 13, + "text": "john doe" + } + ] + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2022-05-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json new file mode 100644 index 000000000000..d8791a0f2a28 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentSubmit.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Sentiment Analysis from a call center conversation", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "conversationItems": [ + { + "participantId": "1", + "id": "1", + "text": "I like the service. I do not like the food", + "lexical": "i like the service i do not like the food", + "itn": "", + "maskedItn": "" + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation Sentiment Analysis", + "kind": "ConversationalSentimentTask", + "parameters": { + "modelVersion": "latest", + "predictionSource": "text" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json new file mode 100644 index 000000000000..a90ed5d6988f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSentimentTaskStatusRequest.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-04-01T15:00:45Z", + "displayName": "Sentiment Analysis from a call center conversation", + "expirationDateTime": "2022-04-01T15:00:45Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2022-04-01T15:00:45Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "ConversationalSentimentResults", + "taskName": "Conversation Sentiment", + "lastUpdateDateTime": "2022-04-01T15:00:45Z", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "conversationItems": [ + { + "id": "1", + "participantId": "agent_1", + "sentiment": "mixed", + "confidenceScores": { + "positive": 0.5, + "neutral": 0.01, + "negative": 0.49 + } + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "2023-11-15-preview" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json new file mode 100644 index 000000000000..034cd9bd6e68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskResult.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "Conversation Summarization Example", + "createdDateTime": "2022-04-01T15:00:45Z", + "expirationDateTime": "2022-04-02T15:00:45Z", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", + "lastUpdatedDateTime": "2022-04-01T15:00:49Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "ConversationalSummarizationResults", + "lastUpdateDateTime": "2022-04-01T15:00:49Z", + "taskName": "Conversation Summarization Task 1", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "summaries": [ + { + "aspect": "chapterTitle", + "text": "Bug Triage", + "contexts": [ + { + "conversationItemId": "2", + "offset": 4, + "length": 39 + } + ] + }, + { + "aspect": "narrative", + "text": "Speaker 3 believes there are 3 remaining bugs.", + "contexts": [ + { + "conversationItemId": "2", + "offset": 4, + "length": 39 + }, + { + "conversationItemId": "3", + "offset": 0, + "length": 7 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + }, + "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json new file mode 100644 index 000000000000..b6ec30204e30 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskStatusRequest.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "Analyze chat", + "createdDateTime": "2022-04-01T15:00:45Z", + "expirationDateTime": "2022-04-02T15:00:45Z", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", + "lastUpdatedDateTime": "2022-04-01T15:00:49Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "ConversationalSummarizationResults", + "lastUpdateDateTime": "2022-04-01T15:00:49Z", + "taskName": "analyze 1", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "20220101meeting", + "summaries": [ + { + "aspect": "issue", + "text": "Customer wants to cancel his subscription. Customer doesn't know how" + }, + { + "aspect": "resolution", + "text": "pii Auto-Fortify. \npii Gamertag.\npii E-mail.\nCanceled customer's subscription" + } + ], + "warnings": [], + "statistics": { + "transactionsCount": 1 + } + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + }, + "nextLink": "/language/analyze-conversation/jobs/3e9e8518-492f-47f9-abd1-9a7468231086?$skip=10&$top=10" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json new file mode 100644 index 000000000000..1924472a9ca0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarizationTaskSubmit.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Conversation Summarization Example", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "conversationItems": [ + { + "participantId": "speaker 1", + "id": "1", + "text": "Let's get started.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 0, + "duration": 20000000 + } + }, + { + "participantId": "speaker 2", + "id": "2", + "text": "OK. How many remaining bugs do we have now?", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 20000000, + "duration": 50000000 + } + }, + { + "participantId": "speaker 3", + "id": "3", + "text": "Only 3.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 50000000, + "duration": 60000000 + } + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Conversation Summarization Task 1", + "kind": "ConversationalSummarizationTask", + "parameters": { + "summaryAspects": [ + "chapterTitle", + "narrative" + ] + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json new file mode 100644 index 000000000000..935120aeb914 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulConversationSummarySubmit.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Analyze conversations from Contoso meeting", + "analysisInput": { + "conversations": [ + { + "id": "20220101meeting", + "language": "en", + "modality": "text", + "domain": "generic", + "conversationItems": [ + { + "participantId": "user", + "role": "customer", + "id": "1", + "text": "Hi!" + }, + { + "participantId": "agent", + "role": "agent", + "id": "2", + "text": "Hello, how can I help you?" + }, + { + "participantId": "user", + "role": "customer", + "id": "3", + "text": "I am having trouble issuing a return of a game on my xbox: call of duty" + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "analyze 1", + "kind": "ConversationalSummarizationTask", + "parameters": { + "modelVersion": "latest", + "summaryAspects": [ + "issue", + "resolution" + ] + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json new file mode 100644 index 000000000000..0a1149def91d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskResult.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "displayName": "Custom Conversation Summarization Example", + "createdDateTime": "2022-04-01T15:00:45Z", + "expirationDateTime": "2022-04-02T15:00:45Z", + "jobId": "3e9e8518-492f-47f9-abd1-9a7468231086", + "lastUpdatedDateTime": "2022-04-01T15:00:49Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "CustomConversationalSummarizationResults", + "lastUpdateDateTime": "2022-04-01T15:00:49Z", + "taskName": "Custom Conversation Summarization Task 1", + "status": "succeeded", + "results": { + "conversations": [ + { + "id": "1", + "summaries": [ + { + "aspect": "narrative", + "text": "Speaker 3 believes there are 3 remaining bugs.", + "contexts": [ + { + "conversationItemId": "2", + "offset": 4, + "length": 39 + }, + { + "conversationItemId": "3", + "offset": 0, + "length": 7 + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "projectName": "my_project", + "deploymentName": "my_deployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json new file mode 100644 index 000000000000..7207d7204a58 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/conversations/SuccessfulCustomConversationSummarizationTaskSubmit.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Custom Conversation Summarization Example", + "analysisInput": { + "conversations": [ + { + "id": "1", + "language": "en", + "modality": "transcript", + "conversationItems": [ + { + "participantId": "speaker 1", + "id": "1", + "text": "Let's get started.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 0, + "duration": 20000000 + } + }, + { + "participantId": "speaker 2", + "id": "2", + "text": "OK. How many remaining bugs do we have now?", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 20000000, + "duration": 50000000 + } + }, + { + "participantId": "speaker 3", + "id": "3", + "text": "Only 3.", + "lexical": "", + "itn": "", + "maskedItn": "", + "conversationItemLevelTiming": { + "offset": 50000000, + "duration": 60000000 + } + } + ] + } + ] + }, + "tasks": [ + { + "taskName": "Custom Conversation Summarization Task 1", + "kind": "CustomConversationalSummarizationTask", + "parameters": { + "summaryAspects": [ + "narrative" + ], + "projectName": "my_project", + "deploymentName": "my_deployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-conversation/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json new file mode 100644 index 000000000000..3377ef38fe70 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryKnowledgebases.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "deploymentName": "production", + "knowledgeBaseQueryOptions": { + "question": "how long it takes to charge surface?", + "top": 3, + "userId": "sd53lsY=", + "confidenceScoreThreshold": 0.2, + "context": { + "previousQnaId": 9, + "previousUserQuery": "Where are QnA Maker quickstarts?" + }, + "rankerType": "Default", + "filters": { + "metadataFilter": { + "metadata": [ + { + "key": "category", + "value": "api" + }, + { + "key": "editorial", + "value": "chitchat" + } + ], + "logicalOperation": "AND" + }, + "sourceFilter": [ + "filename1.pdf", + "https://www.wikipedia.org/microsoft" + ], + "logicalOperation": "AND" + }, + "answerSpanRequest": { + "enable": true, + "confidenceScoreThreshold": 0.2, + "topAnswersWithSpan": 1 + }, + "includeUnstructuredSources": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "answers": [ + { + "questions": [ + "Power and charging" + ], + "answer": "Power and charging**\n\nIt takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.\n\nYou can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface.", + "confidenceScore": 0.65, + "id": 20, + "source": "surface-pro-4-user-guide-EN.pdf", + "metadata": { + "category": "api", + "editorial": "chitchat" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 23, + "displayText": "prompt1" + }, + { + "displayOrder": 2, + "qnaId": 36, + "displayText": "prompt2" + } + ] + }, + "answerSpan": { + "text": "two to four hours", + "confidenceScore": 0.3, + "offset": 33, + "length": 50 + } + }, + { + "questions": [ + "Charge your Surface Pro 4" + ], + "answer": "**Charge your Surface Pro 4**\n\n1. Connect the two parts of the power cord.\n\n2. Connect the power cord securely to the charging port.\n\n3. Plug the power supply into an electrical outlet.", + "confidenceScore": 0.32, + "id": 13, + "source": "surface-pro-4-user-guide-EN.pdf" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryText.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryText.json new file mode 100644 index 000000000000..abc7da637d65 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/SuccessfulQueryText.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "stringIndexType": "TextElements_v8", + "textQueryOptions": { + "question": "how long it takes to charge surface?", + "records": [ + { + "id": "1", + "text": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it." + }, + { + "id": "2", + "text": "You can use the USB port on your Surface Pro 4 power supply to charge other devices, like a phone, while your Surface charges. The USB port on the power supply is only for charging, not for data transfer. If you want to use a USB device, plug it into the USB port on your Surface." + } + ], + "language": "en" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "answers": [ + { + "answer": "Power and charging. It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", + "confidenceScore": 0.93, + "id": "1", + "answerSpan": { + "text": "two to four hours", + "confidenceScore": 0, + "offset": 28, + "length": 45 + }, + "offset": 0, + "length": 224 + }, + { + "answer": "It takes two to four hours to charge the Surface Pro 4 battery fully from an empty state. It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", + "confidenceScore": 0.92, + "id": "1", + "answerSpan": { + "text": "two to four hours", + "confidenceScore": 0, + "offset": 8, + "length": 25 + }, + "offset": 20, + "length": 224 + }, + { + "answer": "It can take longer if you’re using your Surface for power-intensive activities like gaming or video streaming while you’re charging it.", + "confidenceScore": 0.05, + "id": "1", + "answerSpan": null, + "offset": 110, + "length": 244 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json new file mode 100644 index 000000000000..7080b51795ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulCreateProject.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": { + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "multilingualResource": true + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + }, + "201": { + "headers": {}, + "body": { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json new file mode 100644 index 000000000000..13ff7ab5d337 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulDeleteProject.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1" + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/deletion-jobs/job1?api-version=2023-05-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json new file mode 100644 index 000000000000..2253acb57919 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "settings": { + "defaultAnswer": "No good match found for your question in the Knowledgebase." + }, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json new file mode 100644 index 000000000000..ac2516c13a6f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetQnas.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": 1, + "answer": "ans1", + "source": "source1", + "questions": [ + "question 1.1", + "question 1.2" + ], + "metadata": { + "k1": "v1", + "k2": "v2" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 11, + "displayText": "prompt 1.1" + }, + { + "displayOrder": 2, + "qnaId": 21, + "displayText": "prompt 1.2" + } + ] + }, + "lastUpdatedDateTime": "2021-05-01T17:21:14Z" + }, + { + "id": 2, + "answer": "ans2", + "source": "source2", + "questions": [ + "question 2.1", + "question 2.2" + ], + "lastUpdatedDateTime": "2021-05-01T17:21:14Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json new file mode 100644 index 000000000000..de3a9c02d3a2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSources.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "displayName": "source1", + "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", + "sourceKind": "url", + "lastUpdatedDateTime": "2021-05-01T15:13:22Z", + "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" + }, + { + "displayName": "source2", + "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", + "sourceKind": "file", + "contentStructureKind": "unstructured", + "lastUpdatedDateTime": "2021-05-01T15:13:22Z", + "source": "surface-guide.pdf" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json new file mode 100644 index 000000000000..230dffb4e35d --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulGetSynonyms.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json new file mode 100644 index 000000000000..511bbda3d06b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json new file mode 100644 index 000000000000..2bd5968a3f68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "deploymentName": "production", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json new file mode 100644 index 000000000000..20a64ffe030e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded", + "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json new file mode 100644 index 000000000000..18e29c0812fb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json new file mode 100644 index 000000000000..163ac490e10e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectListDeployments.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "deploymentName": "production", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json new file mode 100644 index 000000000000..658efd2d09ec --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "deploymentName": "production" + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/deployments/production/jobs/job1?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json new file mode 100644 index 000000000000..6a37b2b39985 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": { + "exportAssetTypes": [ + "qnas", + "synonyms" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded", + "resultUrl": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1/result?api-version=2023-11-15-preview" + } + }, + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/export/jobs/job1?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json new file mode 100644 index 000000000000..01af3cb13865 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": { + "assets": { + "synonyms": [ + { + "alterations": [ + "wa", + "washington", + "washington state" + ] + }, + { + "alterations": [ + "U.S", + "usa", + "united states of america" + ] + } + ], + "qnas": [ + { + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "id": 1, + "answer": "ans1", + "source": "source1", + "questions": [ + "question 1.1", + "question 1.2" + ], + "metadata": { + "k1": "v1", + "k2": "v2" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 2, + "displayText": "prompt 1.1" + } + ] + } + }, + { + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "id": 2, + "answer": "ans2", + "source": "source2", + "questions": [ + "question 2.1", + "question 2.2" + ] + } + ] + } + } + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/import/jobs/job1?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json new file mode 100644 index 000000000000..3bea60eb2fa0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulProjectsListProjects.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "projectName": "proj1", + "description": "proj1 is a test project.", + "language": "en", + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + }, + { + "projectName": "proj2", + "description": "proj2 is a test project.", + "language": "fr", + "multilingualResource": true, + "createdDateTime": "2021-05-01T15:13:22Z", + "lastModifiedDateTime": "2021-05-01T15:13:22Z", + "lastDeployedDateTime": "2021-05-01T15:13:22Z" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json new file mode 100644 index 000000000000..89e72348bef7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": { + "records": [ + { + "userId": "user1", + "userQuestion": "hi", + "qnaId": 1 + }, + { + "userId": "user1", + "userQuestion": "hello", + "qnaId": 2 + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json new file mode 100644 index 000000000000..339cec0cb4db --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnas.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": [ + { + "op": "add", + "value": { + "id": 3, + "answer": "ans3", + "source": "source1", + "questions": [ + "question 3.1", + "question 3.2" + ], + "metadata": { + "k1": "v1", + "k2": "v2" + }, + "dialog": { + "isContextOnly": false, + "prompts": [ + { + "displayOrder": 1, + "qnaId": 11, + "displayText": "prompt 3.1" + }, + { + "displayOrder": 2, + "qnaId": 21, + "displayText": "prompt 3.2" + } + ] + } + } + }, + { + "op": "replace", + "value": { + "id": 1, + "answer": "ans4", + "source": "source1", + "questions": [ + "question 4.1", + "question 4.2" + ] + } + }, + { + "op": "delete", + "value": { + "id": 2, + "answer": "ans2", + "source": "source1", + "questions": [ + "question 2.1", + "question 2.2" + ] + } + } + ] + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/qnas/jobs/job1?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json new file mode 100644 index 000000000000..18e29c0812fb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json new file mode 100644 index 000000000000..8859c284bfea --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSources.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": [ + { + "op": "add", + "value": { + "displayName": "source3", + "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context", + "sourceKind": "url", + "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context" + } + }, + { + "op": "replace", + "value": { + "displayName": "source1", + "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview", + "sourceKind": "url", + "refresh": true, + "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview" + } + }, + { + "op": "delete", + "value": { + "displayName": "source2", + "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf", + "sourceKind": "file", + "source": "surface-guide.pdf" + } + } + ] + }, + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the analysis job.", + "headers": { + "Operation-Location": "https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json new file mode 100644 index 000000000000..18e29c0812fb --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "jobId": "job1" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "errors": [], + "createdDateTime": "2021-05-01T17:21:14Z", + "expirationDateTime": "2021-05-01T17:21:14Z", + "jobId": "635c2741-15c4-4c2c-9f78-bfd30b6b2a4a", + "lastUpdatedDateTime": "2021-05-01T17:21:14Z", + "status": "succeeded" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json new file mode 100644 index 000000000000..7b4d0db89356 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "Content-Type": "application/json", + "api-version": "2023-11-15-preview", + "projectName": "proj1", + "body": { + "value": [ + { + "alterations": [ + "qnamaker", + "qna maker" + ] + }, + { + "alterations": [ + "botframework", + "bot framework" + ] + } + ] + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json new file mode 100644 index 000000000000..4c0fb9d29f5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfuDynamicClassificationRequest.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "DynamicClassification", + "parameters": { + "categories": [ + "Health", + "Politics", + "Music", + "Sports" + ], + "classificationType": "Multi", + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "The WHO is issuing a warning about Monkey Pox." + }, + { + "id": "2", + "language": "en", + "text": "Mo Salah plays in Liverpool FC in England." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "DynamicClassificationResults", + "results": { + "documents": [ + { + "id": "1", + "classifications": [ + { + "category": "Health", + "confidenceScore": 0.9 + }, + { + "category": "Politics", + "confidenceScore": 0.8 + }, + { + "category": "Music", + "confidenceScore": 0.7 + }, + { + "category": "Sports", + "confidenceScore": 0.6 + } + ], + "warnings": [] + }, + { + "id": "2", + "classifications": [ + { + "category": "Health", + "confidenceScore": 0.9 + }, + { + "category": "Politics", + "confidenceScore": 0.8 + }, + { + "category": "Music", + "confidenceScore": 0.7 + }, + { + "category": "Sports", + "confidenceScore": 0.6 + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-11-15-preview" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json new file mode 100644 index 000000000000..63d34b32fbd2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskResult.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "AbstractiveSummarizationLROResults", + "taskName": "Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", + "contexts": [ + { + "offset": 0, + "length": 1629 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "latest" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json new file mode 100644 index 000000000000..e7b7f64fab39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAbstractiveSummarizationTaskSubmit.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "AbstractiveSummarization", + "taskName": "Document Abstractive Summarization Task 1", + "parameters": { + "sentenceCount": 1 + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json new file mode 100644 index 000000000000..42a5c4dbad61 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsCancelRequest.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json new file mode 100644 index 000000000000..4e05543a20c2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskStatusRequest.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 2, + "failed": 0, + "inProgress": 0, + "total": 2, + "items": [ + { + "kind": "EntityRecognitionLROResults", + "taskName": "Recognize Entities", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "Event", + "type": "Event", + "confidenceScore": 0.61, + "length": 4, + "offset": 18, + "text": "trip", + "tags": [ + { + "name": "Event", + "confidenceScore": 0.61 + } + ] + }, + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.82, + "length": 7, + "offset": 26, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ], + "text": "Seattle" + }, + { + "category": "Temporal", + "type": "DateRange", + "confidenceScore": 0.8, + "length": 9, + "offset": 34, + "text": "last week", + "tags": [ + { + "name": "DateRange", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "Location", + "type": "GPE", + "confidenceScore": 0.52, + "length": 3, + "offset": 14, + "text": "NYC", + "tags": [ + { + "name": "Location", + "confidenceScore": 0.82 + }, + { + "name": "GPE", + "confidenceScore": 0.82 + } + ] + }, + { + "category": "Temporal", + "type": "Date", + "confidenceScore": 0.8, + "length": 8, + "offset": 18, + "text": "tomorrow", + "tags": [ + { + "name": "Date", + "confidenceScore": 0.8 + }, + { + "name": "Temporal", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-04-01" + } + }, + { + "kind": "CustomEntityRecognitionLROResults", + "taskName": "Recognize US Regions", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.85, + "length": 17, + "offset": 45, + "text": "Pacific Northwest" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "category": "USRegion", + "confidenceScore": 0.88, + "length": 10, + "offset": 63, + "text": "East Coast" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json new file mode 100644 index 000000000000..89d5b6f9dbc7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulAnalyzeTextJobsMultipleTaskSubmitRequest.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Extracting Location & US Region", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "I had a wonderful trip to Seattle last week." + }, + { + "id": "2", + "language": "en", + "text": "I'm flying to NYC tomorrow. See you there." + } + ] + }, + "tasks": [ + { + "kind": "EntityRecognition", + "taskName": "Recognize Entities", + "parameters": { + "modelVersion": "latest" + } + }, + { + "kind": "CustomEntityRecognition", + "taskName": "Recognize US Regions", + "parameters": { + "projectName": "MyProject", + "deploymentName": "MyDeployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json new file mode 100644 index 000000000000..8617206ec3c3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskResult.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2020-10-01T15:00:45Z", + "displayName": "Document Custom Abstractive Summarization Task Example", + "expirationDateTime": "2020-10-03T15:01:03Z", + "jobId": "c0f2a446-05d9-48fc-ba8f-3ef4af8d0b18", + "lastUpdatedDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "CustomAbstractiveSummarizationLROResults", + "taskName": "Custom Document Abstractive Summarization Task 1", + "lastUpdateDateTime": "2020-10-01T15:01:03Z", + "status": "succeeded", + "results": { + "documents": [ + { + "summaries": [ + { + "text": "Microsoft have been on a quest to advance AI beyond existing techniques.", + "contexts": [ + { + "offset": 0, + "length": 1629 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "projectName": "my_project", + "deploymentName": "my_deployment" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json new file mode 100644 index 000000000000..604432efc249 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomAbstractiveSummarizationTaskSubmit.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "displayName": "Document Custom Abstractive Summarization Task Example", + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "At Microsoft, we have been on a quest to advance AI beyond existing techniques, by taking a more holistic, human-centric approach to learning and understanding. As Chief Technology Officer of Azure AI Cognitive Services, I have been working with a team of amazing scientists and engineers to turn this quest into a reality. In my role, I enjoy a unique perspective in viewing the relationship among three attributes of human cognition: monolingual text (X), audio or visual sensory signals, (Y) and multilingual (Z). At the intersection of all three, there is magic—what we call XYZ-code as illustrated in Figure 1—a joint representation to create more powerful AI that can speak, hear, see, and understand humans better. We believe XYZ-code will enable us to fulfill our long-term vision: cross-domain transfer learning, spanning modalities and languages. The goal is to have pre-trained models that can jointly learn representations to support a broad range of downstream AI tasks, much in the way humans do today. Over the past five years, we have achieved human performance on benchmarks in conversational speech recognition, machine translation, conversational question answering, machine reading comprehension, and image captioning. These five breakthroughs provided us with strong signals toward our more ambitious aspiration to produce a leap in AI capabilities, achieving multi-sensory and multilingual learning that is closer in line with how humans learn and understand. I believe the joint XYZ-code is a foundational component of this aspiration, if grounded with external knowledge sources in the downstream AI tasks." + } + ] + }, + "tasks": [ + { + "kind": "CustomAbstractiveSummarization", + "taskName": "Custom Document Abstractive Summarization Task 1", + "parameters": { + "projectName": "my_project", + "deploymentName": "my_deployment" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json new file mode 100644 index 000000000000..4f47a7e4d47a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcarePostRequest.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "CustomHealthcare", + "parameters": { + "projectName": "{PROJECT-NAME}", + "deploymentName": "{DEPLOYMENT-NAME}" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-04-01" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json new file mode 100644 index 000000000000..f13c4694225b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomHealthcareTaskStatusRequest.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-07-20T18:43:35Z", + "displayName": "Extracting Custom Health Entities", + "expirationDateTime": "2022-07-21T18:43:35Z", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", + "lastUpdatedDateTime": "2022-07-20T18:43:36Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "CustomHealthcareLROResults", + "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98, + "entityComponentInformation": [ + { + "entityComponentKind": "PrebuiltComponent", + "value": "Dosage.Prebuilt" + }, + { + "entityComponentKind": "ListComponent", + "value": "ListKey" + } + ] + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "entityComponentInformation": [ + { + "entityComponentKind": "ListComponent", + "value": "ListKey" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1, + "entityComponentInformation": [ + { + "entityComponentKind": "LearnedComponent", + "value": "Frequency.Learned" + } + ] + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + } + ], + "relations": [ + { + "confidenceScore": 1, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "projectName": "{PROJECT-NAME}", + "deploymentName": "{DEPLOYMENT-NAME}" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json new file mode 100644 index 000000000000..6b544ecb03c7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskStatusRequest.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "29fe5bb0-83ae-4f86-85d6-775534dcd2d4" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2023-02-05T20:45:15Z", + "displayName": "Custom Sentiment Analysis Job", + "expirationDateTime": "2023-02-06T20:45:15Z", + "jobId": "29fe5bb0-83ae-4f86-85d6-775534dcd2d4", + "lastUpdatedDateTime": "2023-02-05T20:46:05Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "CustomSentimentAnalysisLROResults", + "lastUpdateDateTime": "2023-02-05T20:46:05Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "sentiment": "mixed", + "confidenceScores": { + "positive": 0.5, + "neutral": 0.0, + "negative": 0.5 + }, + "sentences": [ + { + "sentiment": "positive", + "confidenceScores": { + "positive": 1.0, + "neutral": 0.0, + "negative": 0.0 + }, + "offset": 0, + "length": 19, + "text": "The food is great. " + }, + { + "sentiment": "negative", + "confidenceScores": { + "positive": 0.0, + "neutral": 0.0, + "negative": 1.0 + }, + "offset": 19, + "length": 23, + "text": "But the service is bad." + } + ], + "warnings": [] + } + ], + "errors": [], + "projectName": "{PROJECT-NAME}", + "deploymentName": "{DEPLOYMENT-NAME}" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json new file mode 100644 index 000000000000..74fe66f944f4 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulCustomSentimentAnalysisTaskSubmit.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "The food is great. But the service is bad.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "CustomSentimentAnalysis", + "parameters": { + "projectName": "{PROJECT-NAME}", + "deploymentName": "{DEPLOYMENT-NAME}" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityLinkingRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityLinkingRequest.json new file mode 100644 index 000000000000..369571f0f9f9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityLinkingRequest.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityLinking", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Pike place market is my favorite Seattle attraction." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityLinkingResults", + "results": { + "documents": [ + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Bill Gates", + "language": "en", + "matches": [ + { + "confidenceScore": 0.52, + "length": 10, + "offset": 25, + "text": "Bill Gates" + } + ], + "name": "Bill Gates", + "url": "https://en.wikipedia.org/wiki/Bill_Gates" + }, + { + "dataSource": "Wikipedia", + "id": "Paul Allen", + "language": "en", + "matches": [ + { + "confidenceScore": 0.54, + "length": 10, + "offset": 40, + "text": "Paul Allen" + } + ], + "name": "Paul Allen", + "url": "https://en.wikipedia.org/wiki/Paul_Allen" + }, + { + "dataSource": "Wikipedia", + "id": "Microsoft", + "language": "en", + "matches": [ + { + "confidenceScore": 0.49, + "length": 9, + "offset": 0, + "text": "Microsoft" + } + ], + "name": "Microsoft", + "url": "https://en.wikipedia.org/wiki/Microsoft" + } + ], + "id": "1", + "warnings": [] + }, + { + "entities": [ + { + "dataSource": "Wikipedia", + "id": "Pike Place Market", + "language": "en", + "matches": [ + { + "confidenceScore": 0.86, + "length": 17, + "offset": 0, + "text": "Pike place market" + } + ], + "name": "Pike Place Market", + "url": "https://en.wikipedia.org/wiki/Pike_Place_Market" + }, + { + "dataSource": "Wikipedia", + "id": "Seattle", + "language": "en", + "matches": [ + { + "confidenceScore": 0.27, + "length": 7, + "offset": 33, + "text": "Seattle" + } + ], + "name": "Seattle", + "url": "https://en.wikipedia.org/wiki/Seattle" + } + ], + "id": "2", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2020-02-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..0f977c16c052 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionExclusionRequest.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "exclusionList": [ + "Numeric" + ], + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Airport", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json new file mode 100644 index 000000000000..f83f51c5ba94 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInclusionRequest.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inclusionList": [ + "Location" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInferenceOptionsRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInferenceOptionsRequest.json new file mode 100644 index 000000000000..6d8a9642d6e9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionInferenceOptionsRequest.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "inferenceOptions": { + "excludeNormalizedValues": true + } + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ] + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ] + } + ], + "id": "1", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2023-09-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json new file mode 100644 index 000000000000..205f494229b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionOverlapPolicy.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "matchLongest" + } + }, + "analysisInput": { + "documents": [ + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.59, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.59 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json new file mode 100644 index 000000000000..d4bf046440b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulEntityRecognitionRequest.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "EntityRecognition", + "parameters": { + "modelVersion": "latest", + "overlapPolicy": { + "policyKind": "allowOverlap" + } + }, + "analysisInput": { + "documents": [ + { + "id": "2", + "language": "en", + "text": "When I was 5 years old I had $90.00 dollars to my name." + }, + { + "id": "3", + "language": "en", + "text": "When we flew from LAX it seemed like we were moving at 10 meters per second. I was lucky to see Amsterdam, Effile Tower, and the Nile." + }, + { + "id": "4", + "language": "en", + "text": "25th April Meeting was an intresting one. At least we gont to experience the WorldCup" + }, + { + "id": "5", + "language": "en", + "text": "My IP is 127.12.1.1 and my phone number is 5555555555" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "EntityRecognitionResults", + "results": { + "documents": [ + { + "entities": [ + { + "text": "5 years old", + "category": "Numeric", + "type": "Age", + "offset": 11, + "length": 11, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Age", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "AgeMetadata", + "unit": "Year", + "value": 5.0 + } + }, + { + "text": "$90.00", + "category": "Numeric", + "type": "Currency", + "offset": 29, + "length": 14, + "confidenceScore": 0.99, + "tags": [ + { + "name": "Numeric", + "confidenceScore": 0.99 + }, + { + "name": "Currency", + "confidenceScore": 0.99 + } + ], + "metadata": { + "metadataKind": "CurrencyMetadata", + "unit": "Dollar", + "iso4217": "USD", + "value": 90.0 + } + } + ], + "id": "2", + "warnings": [] + }, + { + "entities": [ + { + "text": "LAX", + "category": "Location", + "type": "Structural", + "offset": 18, + "length": 3, + "confidenceScore": 0.72, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.72 + } + ] + }, + { + "text": "10 meters per second", + "category": "Numeric", + "type": "Speed", + "offset": 55, + "length": 20, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Dimension", + "confidenceScore": 0.84 + }, + { + "name": "Numeric", + "confidenceScore": 0.84 + }, + { + "name": "Speed", + "confidenceScore": 0.8 + } + ], + "metadata": { + "metadataKind": "SpeedMetadata", + "unit": "MetersPerSecond", + "value": 10.0 + } + }, + { + "text": "Amsterdam", + "category": "Location", + "type": "City", + "offset": 96, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.84 + }, + { + "name": "GPE", + "confidenceScore": 0.84 + }, + { + "name": "City", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "Eiffel Tower", + "category": "Location", + "type": "Structural", + "offset": 107, + "length": 12, + "confidenceScore": 0.9, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Structural", + "confidenceScore": 0.9 + } + ] + }, + { + "text": "Nile", + "category": "Location", + "type": "Geological", + "offset": 129, + "length": 4, + "confidenceScore": 0.63, + "tags": [ + { + "name": "Location", + "confidenceScore": 0.9 + }, + { + "name": "Geological", + "confidenceScore": 0.63 + } + ] + } + ], + "id": "3", + "warnings": [] + }, + { + "entities": [ + { + "text": "25th April", + "category": "Temporal", + "type": "Date", + "offset": 0, + "length": 10, + "confidenceScore": 0.58, + "tags": [ + { + "name": "Temporal", + "confidenceScore": 0.9 + }, + { + "name": "Date", + "confidenceScore": 0.58 + } + ], + "metadata": { + "metadataKind": "DateMetadata", + "dateValues": [ + { + "timex": "XXXX-04-25", + "value": "2022-04-25" + }, + { + "timex": "XXXX-04-25", + "value": "2023-04-25" + } + ] + } + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "Event", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "25th April Meeting", + "category": "Event", + "type": "CulturalEvent", + "offset": 0, + "length": 18, + "confidenceScore": 0.55, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "CulturalEvent", + "confidenceScore": 0.55 + } + ] + }, + { + "text": "Worldcup", + "category": "Event", + "type": "SportsEvent", + "offset": 0, + "length": 8, + "confidenceScore": 0.51, + "tags": [ + { + "name": "Event", + "confidenceScore": 0.55 + }, + { + "name": "SportsEvent", + "confidenceScore": 0.51 + } + ] + } + ], + "id": "4", + "warnings": [] + }, + { + "entities": [ + { + "text": "127.12.1.1", + "category": "IP", + "type": "IP", + "offset": 9, + "length": 10, + "confidenceScore": 0.8, + "tags": [ + { + "name": "IP", + "confidenceScore": 0.8 + } + ] + }, + { + "text": "5555555555", + "category": "PhoneNumber", + "type": "PhoneNumber", + "offset": 45, + "length": 9, + "confidenceScore": 0.8, + "tags": [ + { + "name": "PhoneNumber", + "confidenceScore": 0.8 + } + ] + } + ], + "id": "5", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json new file mode 100644 index 000000000000..a47c95e733c6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypePostRequest.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest", + "fhirVersion": "4.0.1", + "documentType": "DischargeSummary" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json new file mode 100644 index 000000000000..f0176cff658a --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareDocumentTypeTaskStatusRequest.json @@ -0,0 +1,552 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-09-06T23:47:43Z", + "displayName": "Providing Document Type", + "expirationDateTime": "2022-09-07T23:47:43Z", + "jobId": "15e4a46b-62e2-4386-8d36-9c2a92bb45dd", + "lastUpdatedDateTime": "2022-09-06T23:48:10Z", + "status": "succeeded", + "errors": [], + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-09-06T23:48:10.1762027Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "a", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1.0, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1.0 + } + ], + "relations": [ + { + "confidenceScore": 1.0, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1.0, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [], + "fhirBundle": { + "resourceType": "Bundle", + "id": "6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f", + "meta": { + "profile": [ + "http://hl7.org/fhir/4.0.1/StructureDefinition/Bundle" + ] + }, + "identifier": { + "system": "urn:ietf:rfc:3986", + "value": "urn:uuid:6ee4a7c0-5911-4c4b-bea2-3c2a1fe5c65f" + }, + "type": "document", + "entry": [ + { + "fullUrl": "Composition/5bd33290-b92e-4aa5-becf-535578207946", + "resource": { + "resourceType": "Composition", + "id": "5bd33290-b92e-4aa5-becf-535578207946", + "status": "final", + "type": { + "coding": [ + { + "system": "http://loinc.org", + "code": "18842-5", + "display": "Discharge summary" + } + ], + "text": "Discharge summary" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "date": "2022-09-06", + "author": [ + { + "reference": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "type": "Practitioner", + "display": "Unknown" + } + ], + "title": "Discharge summary", + "section": [ + { + "title": "General", + "code": { + "coding": [ + { + "system": "", + "display": "Unrecognized Section" + } + ], + "text": "General" + }, + "text": { + "status": "additional", + "div": "
\r\n\t\t\t\t\t\t\t

General

\r\n\t\t\t\t\t\t\t

Prescribed 100mg ibuprofen, taken twice daily.

\r\n\t\t\t\t\t
" + }, + "entry": [ + { + "reference": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "type": "List", + "display": "General" + } + ] + } + ] + } + }, + { + "fullUrl": "Practitioner/bba2dee3-2eb3-4973-b4b9-62d498b17046", + "resource": { + "resourceType": "Practitioner", + "id": "bba2dee3-2eb3-4973-b4b9-62d498b17046", + "name": [ + { + "text": "Unknown", + "family": "Unknown" + } + ] + } + }, + { + "fullUrl": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "resource": { + "resourceType": "Patient", + "id": "efcccdf7-87f0-4061-b553-09fc11734594", + "gender": "unknown" + } + }, + { + "fullUrl": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "resource": { + "resourceType": "Encounter", + "id": "76214457-f94c-4ccf-95ef-ab31e7232d63", + "meta": { + "profile": [ + "http://hl7.org/fhir/us/core/StructureDefinition/us-core-encounter" + ] + }, + "status": "finished", + "class": { + "system": "http://terminology.hl7.org/CodeSystem/v3-ActCode", + "display": "unknown" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "period": { + "start": "2022-09-06", + "end": "2022-09-06" + } + } + }, + { + "fullUrl": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "resource": { + "resourceType": "MedicationStatement", + "id": "ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "extension": [ + { + "extension": [ + { + "url": "offset", + "valueInteger": 17 + }, + { + "url": "length", + "valueInteger": 9 + } + ], + "url": "http://hl7.org/fhir/StructureDefinition/derivation-reference" + } + ], + "status": "active", + "medicationCodeableConcept": { + "coding": [ + { + "system": "http://www.nlm.nih.gov/research/umls", + "code": "C0020740", + "display": "ibuprofen" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/aod", + "code": "0000019879" + }, + { + "system": "http://www.whocc.no/atc", + "code": "M01AE01" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/ccpss", + "code": "0046165" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/chv", + "code": "0000006519" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/csp", + "code": "2270-2077" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/drugbank", + "code": "DB01050" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/gs", + "code": "1611" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/lch_nw", + "code": "sh97005926" + }, + { + "system": "http://loinc.org", + "code": "LP16165-0" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/medcin", + "code": "40458" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mmsl", + "code": "d00015" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/msh", + "code": "D007052" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/mthspl", + "code": "WK2XYI10QM" + }, + { + "system": "http://ncimeta.nci.nih.gov", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_ctrp", + "code": "C561" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dcp", + "code": "00803" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_dtp", + "code": "NSC0256857" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_fda", + "code": "WK2XYI10QM" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nci_nci-gloss", + "code": "CDR0000613511" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/nddf", + "code": "002377" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/pdq", + "code": "CDR0000040475" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rcd", + "code": "x02MO" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/rxnorm", + "code": "5640" + }, + { + "system": "http://snomed.info/sct", + "code": "E-7772" + }, + { + "system": "http://snomed.info/sct", + "code": "C-603C0" + }, + { + "system": "http://snomed.info/sct", + "code": "387207008" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/usp", + "code": "m39860" + }, + { + "system": "http://www.nlm.nih.gov/research/umls/uspmg", + "code": "MTHU000060" + }, + { + "system": "http://hl7.org/fhir/ndfrt", + "code": "4017840" + } + ], + "text": "ibuprofen" + }, + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "context": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "dosage": [ + { + "text": "100mg", + "timing": { + "repeat": { + "frequency": 2, + "period": 1, + "periodUnit": "d" + }, + "code": { + "text": "twice daily" + } + }, + "doseAndRate": [ + { + "doseQuantity": { + "value": 100 + } + } + ] + } + ] + } + }, + { + "fullUrl": "List/6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "resource": { + "resourceType": "List", + "id": "6d743a3e-e7a2-4cee-a0b5-64361b6c93ad", + "status": "current", + "mode": "snapshot", + "title": "General", + "subject": { + "reference": "Patient/efcccdf7-87f0-4061-b553-09fc11734594", + "type": "Patient" + }, + "encounter": { + "reference": "Encounter/76214457-f94c-4ccf-95ef-ab31e7232d63", + "type": "Encounter", + "display": "unknown" + }, + "entry": [ + { + "item": { + "reference": "MedicationStatement/ac0264b6-63b7-4cf2-a7c3-f7340788aca7", + "type": "MedicationStatement", + "display": "ibuprofen" + } + } + ] + } + } + ] + } + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcarePostRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcarePostRequest.json new file mode 100644 index 000000000000..91c0164318d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcarePostRequest.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "{Job ID}", + "body": { + "analysisInput": { + "documents": [ + { + "text": "Prescribed 100mg ibuprofen, taken twice daily.", + "id": "1", + "language": "en" + } + ] + }, + "tasks": [ + { + "kind": "Healthcare", + "parameters": { + "modelVersion": "latest" + } + } + ] + } + }, + "responses": { + "202": { + "headers": { + "Operation-Location": "{Endpoint}/language/analyze-text/jobs/{jobId}?api-version=2023-11-15-preview" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json new file mode 100644 index 000000000000..e79504e40b55 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulHealthcareTaskStatusRequest.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "createdDateTime": "2022-07-20T18:43:35Z", + "displayName": "Extracting Location & US Region", + "expirationDateTime": "2022-07-21T18:43:35Z", + "jobId": "1780194a-e9c1-4298-b0d4-fdc59ba818a0", + "lastUpdatedDateTime": "2022-07-20T18:43:36Z", + "status": "succeeded", + "tasks": { + "completed": 1, + "failed": 0, + "inProgress": 0, + "total": 1, + "items": [ + { + "kind": "HealthcareLROResults", + "lastUpdateDateTime": "2022-07-20T18:43:36.7159045Z", + "status": "succeeded", + "results": { + "documents": [ + { + "id": "1", + "entities": [ + { + "offset": 11, + "length": 5, + "text": "100mg", + "category": "Dosage", + "confidenceScore": 0.98 + }, + { + "offset": 17, + "length": 9, + "text": "ibuprofen", + "category": "MedicationName", + "confidenceScore": 1, + "name": "ibuprofen", + "links": [ + { + "dataSource": "UMLS", + "id": "C0020740" + }, + { + "dataSource": "AOD", + "id": "0000019879" + }, + { + "dataSource": "ATC", + "id": "M01AE01" + }, + { + "dataSource": "CCPSS", + "id": "0046165" + }, + { + "dataSource": "CHV", + "id": "0000006519" + }, + { + "dataSource": "CSP", + "id": "2270-2077" + }, + { + "dataSource": "DRUGBANK", + "id": "DB01050" + }, + { + "dataSource": "GS", + "id": "1611" + }, + { + "dataSource": "LCH_NW", + "id": "sh97005926" + }, + { + "dataSource": "LNC", + "id": "LP16165-0" + }, + { + "dataSource": "MEDCIN", + "id": "40458" + }, + { + "dataSource": "MMSL", + "id": "d00015" + }, + { + "dataSource": "MSH", + "id": "D007052" + }, + { + "dataSource": "MTHSPL", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI", + "id": "C561" + }, + { + "dataSource": "NCI_CTRP", + "id": "C561" + }, + { + "dataSource": "NCI_DCP", + "id": "00803" + }, + { + "dataSource": "NCI_DTP", + "id": "NSC0256857" + }, + { + "dataSource": "NCI_FDA", + "id": "WK2XYI10QM" + }, + { + "dataSource": "NCI_NCI-GLOSS", + "id": "CDR0000613511" + }, + { + "dataSource": "NDDF", + "id": "002377" + }, + { + "dataSource": "PDQ", + "id": "CDR0000040475" + }, + { + "dataSource": "RCD", + "id": "x02MO" + }, + { + "dataSource": "RXNORM", + "id": "5640" + }, + { + "dataSource": "SNM", + "id": "E-7772" + }, + { + "dataSource": "SNMI", + "id": "C-603C0" + }, + { + "dataSource": "SNOMEDCT_US", + "id": "387207008" + }, + { + "dataSource": "USP", + "id": "m39860" + }, + { + "dataSource": "USPMG", + "id": "MTHU000060" + }, + { + "dataSource": "VANDF", + "id": "4017840" + } + ] + }, + { + "offset": 34, + "length": 11, + "text": "twice daily", + "category": "Frequency", + "confidenceScore": 1 + } + ], + "relations": [ + { + "confidenceScore": 1, + "relationType": "DosageOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/0", + "role": "Dosage" + }, + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + } + ] + }, + { + "confidenceScore": 1, + "relationType": "FrequencyOfMedication", + "entities": [ + { + "ref": "#/results/documents/0/entities/1", + "role": "Medication" + }, + { + "ref": "#/results/documents/0/entities/2", + "role": "Frequency" + } + ] + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2022-03-01" + } + } + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json new file mode 100644 index 000000000000..33b5bf48d597 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulKeyPhraseExtractionRequest.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "KeyPhraseExtraction", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Microsoft was founded by Bill Gates and Paul Allen." + }, + { + "id": "2", + "language": "en", + "text": "Text Analytics is one of the Azure Cognitive Services." + }, + { + "id": "3", + "language": "en", + "text": "My cat might need to see a veterinarian." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "KeyPhraseExtractionResults", + "results": { + "documents": [ + { + "id": "1", + "keyPhrases": [ + "Bill Gates", + "Paul Allen", + "Microsoft" + ], + "warnings": [] + }, + { + "id": "2", + "keyPhrases": [ + "Azure Cognitive Services", + "Text Analytics" + ], + "warnings": [] + }, + { + "id": "3", + "keyPhrases": [ + "cat", + "veterinarian" + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-06-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json new file mode 100644 index 000000000000..9d5ff464c21c --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulLanguageDetectionRequest.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "LanguageDetection", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "text": "Hello world" + }, + { + "id": "2", + "text": "Bonjour tout le monde" + }, + { + "id": "3", + "text": "Hola mundo" + }, + { + "id": "4", + "text": "Tumhara naam kya hai?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "LanguageDetectionResults", + "results": { + "documents": [ + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "en", + "name": "English" + }, + "id": "1", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "fr", + "name": "French" + }, + "id": "2", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "es", + "name": "Spanish" + }, + "id": "3", + "warnings": [] + }, + { + "detectedLanguage": { + "confidenceScore": 1, + "iso6391Name": "hi", + "name": "Hindi", + "script": "Latin" + }, + "id": "4", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-05" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json new file mode 100644 index 000000000000..8570dfbf6e5f --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionExclusionRequest.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "excludePiiCategories": [ + "USSocialSecurityNumber" + ] + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025" + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68" + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json new file mode 100644 index 000000000000..783adf123d2e --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRedactionRequest.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest", + "redactionCharacter": "-" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is -----------", + "entities": [ + { + "category": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987" + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - --------- - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025" + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is -------------- your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68" + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json new file mode 100644 index 000000000000..a8197963b1f3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulPiiEntityRecognitionRequest.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "PiiEntityRecognition", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "My SSN is 859-98-0987" + }, + { + "id": "2", + "language": "en", + "text": "Your ABA number - 111000025 - is the first 9 digits in the lower left hand corner of your personal check." + }, + { + "id": "3", + "language": "en", + "text": "Is 998.214.865-68 your Brazilian CPF number?" + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "PiiEntityRecognitionResults", + "results": { + "documents": [ + { + "id": "1", + "redactedText": "My SSN is ***********", + "entities": [ + { + "category": "USSocialSecurityNumber", + "confidenceScore": 0.65, + "length": 11, + "offset": 28, + "text": "859-98-0987" + } + ], + "warnings": [] + }, + { + "id": "2", + "redactedText": "Your ABA number - ********* - is the first 9 digits in the lower left hand corner of your personal check.", + "entities": [ + { + "category": "ABARoutingNumber", + "confidenceScore": 0.75, + "length": 9, + "offset": 18, + "text": "111000025" + } + ], + "warnings": [] + }, + { + "id": "3", + "redactedText": "Is ************** your Brazilian CPF number?", + "entities": [ + { + "category": "BRCPFNumber", + "confidenceScore": 0.85, + "length": 14, + "offset": 3, + "text": "998.214.865-68" + } + ], + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-01-15" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json new file mode 100644 index 000000000000..a3f3a27f1152 --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/examples/text/SuccessfulSentimentAnalysisRequest.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "Ocp-Apim-Subscription-Key": "{API key}", + "api-version": "2023-11-15-preview", + "Endpoint": "{Endpoint}", + "body": { + "kind": "SentimentAnalysis", + "parameters": { + "modelVersion": "latest" + }, + "analysisInput": { + "documents": [ + { + "id": "1", + "language": "en", + "text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful." + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "kind": "SentimentAnalysisResults", + "results": { + "documents": [ + { + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "id": "1", + "sentences": [ + { + "targets": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "length": 10, + "offset": 6, + "relations": [ + { + "ref": "#/documents/0/sentences/0/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "atmosphere" + } + ], + "confidenceScores": { + "negative": 0, + "neutral": 0, + "positive": 1 + }, + "length": 17, + "offset": 0, + "assessments": [ + { + "confidenceScores": { + "negative": 0, + "positive": 1 + }, + "isNegated": false, + "length": 5, + "offset": 0, + "sentiment": "positive", + "text": "great" + } + ], + "sentiment": "positive", + "text": "Great atmosphere." + }, + { + "targets": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 11, + "offset": 37, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "restaurants" + }, + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "length": 6, + "offset": 50, + "relations": [ + { + "ref": "#/documents/0/sentences/1/assessments/0", + "relationType": "assessment" + } + ], + "sentiment": "positive", + "text": "hotels" + } + ], + "confidenceScores": { + "negative": 0.01, + "neutral": 0.86, + "positive": 0.13 + }, + "length": 52, + "offset": 18, + "assessments": [ + { + "confidenceScores": { + "negative": 0.01, + "positive": 0.99 + }, + "isNegated": false, + "length": 15, + "offset": 18, + "sentiment": "positive", + "text": "Close to plenty" + } + ], + "sentiment": "neutral", + "text": "Close to plenty of restaurants, hotels, and transit!" + } + ], + "sentiment": "positive", + "warnings": [] + } + ], + "errors": [], + "modelVersion": "2021-10-01" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering-authoring.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering-authoring.json new file mode 100644 index 000000000000..d47e125c691b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering-authoring.json @@ -0,0 +1,1816 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Question Answering - 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/text-analytics/overview.", + "version": "2023-11-15-preview" + }, + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + } + }, + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://cognitiveservices.azure.com/.default" + ] + }, + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/authoring/query-knowledgebases/projects": { + "get": { + "summary": "Gets all projects for a user.", + "operationId": "QuestionAnsweringProjects_ListProjects", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "The metadata of all projects.", + "schema": { + "$ref": "#/definitions/ProjectsMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectsListProjects.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}": { + "get": { + "summary": "Get the requested project metadata.", + "operationId": "QuestionAnsweringProjects_GetProjectDetails", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "The metadata for the specified project.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetProject.json" + } + } + }, + "patch": { + "summary": "Create or update a project.", + "operationId": "QuestionAnsweringProjects_CreateProject", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "description": "Parameters needed to create the project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CreateProjectOptions" + } + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "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, if it doesn't exist.", + "schema": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulCreateProject.json" + } + } + }, + "delete": { + "summary": "Delete the project.", + "operationId": "QuestionAnsweringProjects_DeleteProject", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulDeleteProject.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/query-knowledgebases/projects/deletion-jobs/{jobId}": { + "get": { + "summary": "Gets the status of a Project delete job.", + "operationId": "QuestionAnsweringProjects_GetDeleteStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Project delete job status.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeleteJobStatus.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/:export": { + "post": { + "summary": "Export project metadata and assets.", + "operationId": "QuestionAnsweringProjects_Export", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ImportExportFormatParameter" + }, + { + "$ref": "#/parameters/AssetKindParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Export job status, project metadata, and assets.", + "schema": { + "$ref": "#/definitions/ExportJobState" + } + }, + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitExportJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}": { + "get": { + "summary": "Gets the status of an Export job, once job completes, returns the project metadata, and assets.", + "operationId": "QuestionAnsweringProjects_GetExportStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Export job status, project metadata, and assets.", + "schema": { + "$ref": "#/definitions/ExportJobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectExportJobStatus.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/:import": { + "post": { + "summary": "Import project assets.", + "operationId": "QuestionAnsweringProjects_Import", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Project assets the needs to be imported.", + "in": "body", + "name": "body", + "schema": { + "$ref": "#/definitions/ImportJobOptions" + } + }, + { + "$ref": "#/parameters/ImportExportFormatParameter" + }, + { + "$ref": "#/parameters/AssetKindParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitImportJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}": { + "get": { + "summary": "Gets the status of an Import job.", + "operationId": "QuestionAnsweringProjects_GetImportStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Import job status.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectImportJobStatus.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}": { + "put": { + "summary": "Deploy project to production.", + "operationId": "QuestionAnsweringProjects_DeployProject", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectSubmitDeployJob.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}": { + "get": { + "summary": "Gets the status of a Deploy job.", + "operationId": "QuestionAnsweringProjects_GetDeployStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Deploy job state.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectDeployJobStatus.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/deployments": { + "get": { + "summary": "List all deployments of a project.", + "operationId": "QuestionAnsweringProjects_ListDeployments", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "List of deployments of a project.", + "schema": { + "$ref": "#/definitions/ProjectDeployments" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulProjectListDeployments.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/synonyms": { + "get": { + "summary": "Gets all the synonyms of a project.", + "operationId": "QuestionAnsweringProjects_GetSynonyms", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "All the synonyms of a project.", + "schema": { + "$ref": "#/definitions/SynonymAssets" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetSynonyms.json" + } + } + }, + "put": { + "summary": "Updates all the synonyms of a project.", + "operationId": "QuestionAnsweringProjects_UpdateSynonyms", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "All the synonyms of a project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymAssets" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Synonyms update successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSynonyms.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/sources": { + "get": { + "summary": "Gets all the sources of a project.", + "operationId": "QuestionAnsweringProjects_GetSources", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "All the sources of a project.", + "schema": { + "$ref": "#/definitions/QnaSources" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetSources.json" + } + } + }, + "patch": { + "summary": "Updates the sources of a project.", + "operationId": "QuestionAnsweringProjects_UpdateSources", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Update sources parameters of a project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateSourcesOptions" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSources.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}": { + "get": { + "summary": "Gets the status of update sources job.", + "operationId": "QuestionAnsweringProjects_GetUpdateSourcesStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Update sources job state.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateSourcesJobStatus.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/qnas": { + "get": { + "summary": "Gets all the QnAs of a project.", + "operationId": "QuestionAnsweringProjects_GetQnas", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SourceFilterParameter" + }, + { + "$ref": "common.json#/parameters/TopParameter" + }, + { + "$ref": "common.json#/parameters/SkipParameter" + }, + { + "$ref": "common.json#/parameters/MaxPageSizeParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink", + "itemName": "value" + }, + "responses": { + "200": { + "description": "All the QnAs of a project.", + "schema": { + "$ref": "#/definitions/QnaAssets" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulGetQnas.json" + } + } + }, + "patch": { + "summary": "Updates the QnAs of a project.", + "operationId": "QuestionAnsweringProjects_UpdateQnas", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Update QnAs parameters of a project.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateQnaOptions" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "202": { + "description": "A successful call results with an Operation-Location header used to check the status of the job.", + "headers": { + "Operation-Location": { + "type": "string" + } + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnas.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}": { + "get": { + "summary": "Gets the status of update QnAs job.", + "operationId": "QuestionAnsweringProjects_GetUpdateQnasStatus", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/JobIdParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Update QnAs job state.", + "schema": { + "$ref": "#/definitions/JobState" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateQnasJobStatus.json" + } + } + } + }, + "/authoring/query-knowledgebases/projects/{projectName}/feedback": { + "post": { + "summary": "Update Active Learning feedback.", + "operationId": "QuestionAnsweringProjects_AddFeedback", + "parameters": [ + { + "$ref": "common.json#/parameters/ProjectNamePathParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + }, + { + "description": "Feedback for Active Learning.", + "in": "body", + "name": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ActiveLearningFeedback" + } + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "204": { + "description": "Feedback recorded successfully." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/authoring/SuccessfulUpdateActiveLearningFeedback.json" + } + } + } + } + }, + "definitions": { + "ActiveLearningFeedback": { + "type": "object", + "description": "Feedback for Active Learning.", + "additionalProperties": false, + "properties": { + "records": { + "$ref": "#/definitions/FeedbackRecords" + } + } + }, + "FeedbackRecords": { + "type": "array", + "description": "A list of Feedback Records for Active Learning.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/FeedbackRecord" + } + }, + "FeedbackRecord": { + "type": "object", + "description": "Feedback Record for Active Learning.", + "additionalProperties": false, + "properties": { + "userId": { + "type": "string", + "description": "Unique identifier of the user." + }, + "userQuestion": { + "type": "string", + "description": "User suggested question for the QnA." + }, + "qnaId": { + "type": "integer", + "description": "Unique ID of the QnA.", + "format": "int32" + } + } + }, + "ProjectsMetadata": { + "type": "object", + "description": "Collection of projects metadata and global settings.", + "additionalProperties": false, + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProjectMetadata" + } + }, + "nextLink": { + "type": "string" + } + } + }, + "ProjectMetadata": { + "type": "object", + "description": "Represents the project.", + "additionalProperties": false, + "properties": { + "projectName": { + "type": "string", + "description": "Name of the project." + }, + "description": { + "type": "string", + "description": "Description of the project." + }, + "language": { + "$ref": "common.json#/definitions/Language" + }, + "multilingualResource": { + "type": "boolean", + "description": "Resource enabled for multiple languages across projects or not." + }, + "settings": { + "$ref": "#/definitions/ProjectSettings" + }, + "createdDateTime": { + "type": "string", + "description": "Project creation date-time.", + "format": "date-time" + }, + "lastModifiedDateTime": { + "type": "string", + "description": "Represents the project last modified date-time.", + "format": "date-time" + }, + "lastDeployedDateTime": { + "type": "string", + "description": "Represents the project last deployment date-time.", + "format": "date-time" + } + } + }, + "CreateProjectOptions": { + "type": "object", + "description": "Parameters needed to create the project.", + "additionalProperties": false, + "required": [ + "language" + ], + "properties": { + "description": { + "type": "string", + "description": "Description of the project." + }, + "language": { + "$ref": "common.json#/definitions/Language" + }, + "multilingualResource": { + "type": "boolean", + "description": "Set to true to enable creating knowledgebases in different languages for the same resource." + }, + "settings": { + "$ref": "#/definitions/ProjectSettings" + } + } + }, + "ProjectSettings": { + "type": "object", + "description": "Configurable settings of the Project.", + "additionalProperties": false, + "properties": { + "defaultAnswer": { + "type": "string", + "description": "Default Answer response when no good match is found in the knowledge base." + } + } + }, + "ImportJobOptions": { + "type": "object", + "description": "Project assets the needs to be imported.", + "additionalProperties": false, + "properties": { + "metadata": { + "$ref": "#/definitions/CreateProjectOptions" + }, + "assets": { + "$ref": "#/definitions/Assets" + }, + "fileUri": { + "type": "string", + "description": "Import data File URI." + } + } + }, + "JobMetadata": { + "description": "Represents the job metadata.", + "properties": { + "createdDateTime": { + "format": "date-time", + "type": "string" + }, + "expirationDateTime": { + "format": "date-time", + "type": "string" + }, + "jobId": { + "type": "string" + }, + "lastUpdatedDateTime": { + "format": "date-time", + "type": "string" + }, + "status": { + "$ref": "#/definitions/JobStatus" + } + }, + "required": [ + "jobId", + "lastUpdatedDateTime", + "createdDateTime", + "status" + ], + "type": "object" + }, + "JobStatus": { + "description": "Job Status.", + "enum": [ + "notStarted", + "running", + "succeeded", + "failed", + "cancelled", + "cancelling", + "partiallyCompleted" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "jobStatus" + } + }, + "JobState": { + "description": "Job state represents the job metadata and any errors.", + "allOf": [ + { + "$ref": "#/definitions/JobMetadata" + }, + { + "$ref": "#/definitions/Errors" + } + ] + }, + "Errors": { + "description": "Collection of Error types.", + "type": "object", + "properties": { + "errors": { + "type": "array", + "items": { + "$ref": "common.json#/definitions/Error" + } + } + } + }, + "ExportJobState": { + "description": "Export job status, project metadata, and assets.", + "allOf": [ + { + "$ref": "#/definitions/JobState" + }, + { + "$ref": "#/definitions/ExportJobResultUrl" + } + ] + }, + "ExportJobResultUrl": { + "type": "object", + "description": "URL to download the result of the Export Job.", + "required": [ + "resultUrl" + ], + "properties": { + "resultUrl": { + "type": "string", + "description": "URL to download the result of the Export Job." + } + } + }, + "Assets": { + "type": "object", + "description": "All assets for this project.", + "additionalProperties": false, + "properties": { + "synonyms": { + "$ref": "#/definitions/SynonymAsset" + }, + "qnas": { + "$ref": "#/definitions/ImportQnaAsset" + } + } + }, + "SynonymAssets": { + "type": "object", + "description": "All synonym assets for this project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/SynonymAsset" + }, + "nextLink": { + "type": "string" + } + } + }, + "SynonymAsset": { + "type": "array", + "description": "Collection of synonyms.", + "additionalProperties": false, + "maxLength": 10000, + "items": { + "$ref": "#/definitions/WordAlterations" + } + }, + "WordAlterations": { + "type": "object", + "description": "Collection of word alterations.", + "additionalProperties": false, + "required": [ + "alterations" + ], + "properties": { + "alterations": { + "type": "array", + "description": "Collection of word alterations.", + "maxLength": 20, + "items": { + "type": "string" + } + } + } + }, + "QnaAssets": { + "type": "object", + "description": "All QnA assets for the project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/QnaAsset" + }, + "nextLink": { + "type": "string" + } + } + }, + "ImportQnaAsset": { + "type": "array", + "description": "List of QnA records to import.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/ImportQnaRecord" + } + }, + "QnaAsset": { + "type": "array", + "description": "List of QnA records.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/RetrieveQnaRecord" + } + }, + "QnaRecord": { + "type": "object", + "description": "QnA record.", + "additionalProperties": false, + "properties": { + "id": { + "type": "integer", + "description": "Unique ID for the QnA.", + "format": "int32" + }, + "answer": { + "type": "string", + "description": "Answer text.", + "maxLength": 25000, + "minLength": 1 + }, + "source": { + "type": "string", + "description": "Source from which QnA was indexed e.g. https://docs.microsoft.com/en-us/azure/cognitive-services/QnAMaker/FAQs .", + "maxLength": 300 + }, + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "maxLength": 100, + "minLength": 1, + "items": { + "type": "string" + } + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "description": "Context of a QnA.", + "$ref": "#/definitions/QnaDialog" + }, + "activeLearningSuggestions": { + "type": "array", + "description": "List of Active Learning suggestions for the QnA.", + "items": { + "$ref": "#/definitions/SuggestedQuestionsCluster" + } + } + } + }, + "SuggestedQuestionsCluster": { + "type": "object", + "description": "Active Learning suggested questions cluster details.", + "additionalProperties": false, + "properties": { + "clusterHead": { + "type": "string", + "description": "Question chosen as the head of suggested questions cluster by Active Learning clustering algorithm." + }, + "suggestedQuestions": { + "type": "array", + "description": "List of all suggested questions for the QnA.", + "items": { + "$ref": "#/definitions/SuggestedQuestion" + } + } + } + }, + "SuggestedQuestion": { + "type": "object", + "description": "Question suggested by the Active Learning feature.", + "additionalProperties": false, + "properties": { + "question": { + "type": "string", + "description": "Question suggested by the Active Learning feature." + }, + "userSuggestedCount": { + "type": "integer", + "description": "The number of times the question was suggested explicitly by the user.", + "format": "int32" + }, + "autoSuggestedCount": { + "type": "integer", + "description": "The number of times the question was suggested automatically by the Active Learning algorithm.", + "format": "int32" + } + } + }, + "ImportQnaRecord": { + "description": "Import QnA Record.", + "allOf": [ + { + "$ref": "#/definitions/RetrieveQnaRecord" + }, + { + "$ref": "#/definitions/SourceDisplayNameParameter" + } + ] + }, + "SourceDisplayNameParameter": { + "type": "object", + "properties": { + "sourceDisplayName": { + "description": "Friendly name of the Source.", + "type": "string", + "maxLength": 200, + "minLength": 1 + } + } + }, + "RetrieveQnaRecord": { + "description": "QnA Record with last updated date-time.", + "allOf": [ + { + "$ref": "#/definitions/QnaRecord" + }, + { + "$ref": "#/definitions/LastUpdatedDateTimeParameter" + } + ] + }, + "LastUpdatedDateTimeParameter": { + "type": "object", + "description": "Last updated date-time parameter.", + "properties": { + "lastUpdatedDateTime": { + "type": "string", + "format": "date-time", + "description": "Date-time when the QnA was last updated." + } + } + }, + "QnaDialog": { + "type": "object", + "description": "Dialog associated with QnA Record.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as answer for queries without context; otherwise, ignores context and includes this QnA in answers." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/QnaPrompt" + } + } + } + }, + "QnaPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt. It is used for ordering of the prompts.", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "ID of the QnA corresponding to the prompt.", + "format": "int32" + }, + "qna": { + "description": "QnA record. Either QnAId or QnA record needs to be present in a Prompt.", + "$ref": "#/definitions/QnaRecord" + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "UpdateOperationKind": { + "type": "string", + "description": "Update operation type for assets.", + "enum": [ + "add", + "delete", + "replace" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "updateOperationKind" + } + }, + "UpdateSourcesOptions": { + "type": "array", + "description": "A list of sources to be updated.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/UpdateSourceRecord" + } + }, + "UpdateQnaOptions": { + "type": "array", + "description": "A list of QnAs to be updated.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/UpdateQnaRecord" + } + }, + "UpdateQnaRecord": { + "type": "object", + "description": "QnA record to be updated.", + "additionalProperties": false, + "required": [ + "op", + "value" + ], + "properties": { + "op": { + "type": "string", + "$ref": "#/definitions/UpdateOperationKind" + }, + "value": { + "$ref": "#/definitions/QnaRecord" + } + } + }, + "UpdateSourceRecord": { + "type": "object", + "description": "Source to be updated.", + "additionalProperties": false, + "required": [ + "op", + "value" + ], + "properties": { + "op": { + "type": "string", + "$ref": "#/definitions/UpdateOperationKind" + }, + "value": { + "$ref": "#/definitions/UpdateQnaSourceRecord" + } + } + }, + "QnaSources": { + "type": "object", + "description": "All QnA sources for the project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/QnaSourcesMetadata" + }, + "nextLink": { + "type": "string" + } + } + }, + "QnaSourcesMetadata": { + "type": "array", + "description": "Custom sources from which QnAs were extracted or explicitly added to the project.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/QnaSourceRecord" + } + }, + "QnaSourceRecord": { + "description": "Custom source record with last updated date-time.", + "allOf": [ + { + "$ref": "#/definitions/QnaSourceMetadata" + }, + { + "$ref": "#/definitions/LastUpdatedDateTimeParameter" + } + ] + }, + "UpdateQnaSourceRecord": { + "description": "Update source record.", + "allOf": [ + { + "$ref": "#/definitions/QnaSourceMetadata" + }, + { + "$ref": "#/definitions/RefreshSourceOptions" + } + ] + }, + "RefreshSourceOptions": { + "type": "object", + "description": "Boolean flag used to refresh data from the Source.", + "properties": { + "refresh": { + "type": "boolean", + "description": "Boolean flag used to refresh data from the Source." + } + } + }, + "QnaSourceMetadata": { + "type": "object", + "description": "Input source file or url details.", + "additionalProperties": false, + "required": [ + "sourceUri", + "sourceKind", + "source" + ], + "properties": { + "displayName": { + "type": "string", + "description": "Friendly name of the Source.", + "maxLength": 200, + "minLength": 1 + }, + "source": { + "type": "string", + "description": "Unique source identifier. Name of the file if it's a 'file' source; otherwise, the complete URL if it's a 'url' source." + }, + "sourceUri": { + "type": "string", + "description": "URI location for the file or url.", + "format": "uri" + }, + "sourceKind": { + "type": "string", + "$ref": "#/definitions/QnaSourceKind", + "default": "url" + }, + "contentStructureKind": { + "type": "string", + "$ref": "#/definitions/SourceContentStructureKind", + "default": "Unstructured" + } + } + }, + "QnaSourceKind": { + "type": "string", + "description": "Supported source types.", + "x-ms-enum": { + "name": "sourceKind", + "modelAsString": true + }, + "enum": [ + "file", + "url" + ] + }, + "SourceContentStructureKind": { + "type": "string", + "description": "Content structure type for sources.", + "enum": [ + "unstructured" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "sourceContentStructureKind" + } + }, + "ProjectDeployments": { + "type": "object", + "description": "All deployments of a project.", + "additionalProperties": false, + "properties": { + "value": { + "$ref": "#/definitions/ProjectDeploymentsList" + }, + "nextLink": { + "type": "string" + } + } + }, + "ProjectDeploymentsList": { + "type": "array", + "description": "List of deployments of a project.", + "additionalProperties": false, + "items": { + "$ref": "#/definitions/ProjectDeployment" + } + }, + "ProjectDeployment": { + "type": "object", + "description": "Project deployment details.", + "additionalProperties": false, + "properties": { + "deploymentName": { + "type": "string", + "description": "Name of the deployment." + }, + "lastDeployedDateTime": { + "type": "string", + "description": "Represents the project last deployment date-time.", + "format": "date-time" + } + } + } + }, + "parameters": { + "JobIdParameter": { + "name": "jobId", + "in": "path", + "description": "Job ID.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AssetKindParameter": { + "name": "assetKind", + "type": "string", + "in": "query", + "description": "Kind of the asset of the project.", + "enum": [ + "qnas", + "synonyms" + ], + "x-ms-enum": { + "name": "assetKind", + "modelAsString": true, + "values": [ + { + "value": "qnas" + }, + { + "value": "synonyms" + } + ] + }, + "x-ms-parameter-location": "method" + }, + "ImportExportFormatParameter": { + "name": "format", + "type": "string", + "in": "query", + "description": "Knowledge base Import or Export format.", + "default": "json", + "enum": [ + "json", + "tsv", + "excel" + ], + "x-ms-enum": { + "name": "format", + "modelAsString": true, + "values": [ + { + "value": "json", + "description": "Export or Import QnA assets in JSON format." + }, + { + "value": "tsv", + "description": "Export or Import knowledge base replica including all assets and metadata in Excel format." + }, + { + "value": "excel", + "description": "Export or Import knowledge base replica including all assets and metadata in Tsv format." + } + ] + }, + "x-ms-parameter-location": "method" + }, + "SourceFilterParameter": { + "name": "source", + "in": "query", + "description": "Source of the QnA.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering.json b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering.json new file mode 100644 index 000000000000..71f171880a5b --- /dev/null +++ b/specification/cognitiveservices/data-plane/Language/preview/2023-11-15-preview/questionanswering.json @@ -0,0 +1,601 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft Cognitive Language Service - Question Answering", + "description": "The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview.", + "version": "2023-11-15-preview" + }, + "securityDefinitions": { + "AADToken": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "These are the [Azure Active Directory OAuth2](https://docs.microsoft.com/azure/active-directory/develop/v1-overview) Flows. When paired with [Azure role-based access](https://docs.microsoft.com/azure/role-based-access-control/overview) control it can be used to control access to Azure Maps REST APIs. Azure role-based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built-in role or a custom role composed of one or more permissions to Azure Maps REST APIs.\n\nTo implement scenarios, we recommend viewing [authentication concepts](https://aka.ms/amauth). In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.\n\n#### Notes\n* This security definition **requires** the use of the `x-ms-client-id` header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the [Maps management API](https://aka.ms/amauthdetails).\n* \nThe `Authorization URL` is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations. \n* \nThe Azure role-based access control is configured from the [Azure management plane](https://aka.ms/amrbac) via Azure portal, PowerShell, CLI, Azure SDKs, or REST APIs.\n* \nUsage of the [Azure Maps Web SDK](https://aka.ms/amaadmc) allows for configuration based setup of an application for multiple use cases.\n* Currently, Azure Active Directory [v1.0 or v2.0](https://docs.microsoft.com/azure/active-directory/develop/azure-ad-endpoint-comparison) supports Work, School, and Guests but does not support Personal accounts.", + "scopes": { + "https://cognitiveservices.azure.com/.default": "https://cognitiveservices.azure.com/.default" + } + }, + "apim_key": { + "type": "apiKey", + "description": "A subscription key for a Language service resource.", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "AADToken": [ + "https://cognitiveservices.azure.com/.default" + ] + }, + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/language", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "common.json#/parameters/Endpoint" + } + ] + }, + "paths": { + "/:query-knowledgebases": { + "post": { + "summary": "Answers the specified question using your knowledge base.", + "operationId": "QuestionAnswering_GetAnswers", + "parameters": [ + { + "$ref": "#/parameters/AnswersOptions" + }, + { + "$ref": "common.json#/parameters/ProjectNameQueryParameter" + }, + { + "$ref": "common.json#/parameters/DeploymentNameQueryParameter" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A successful response to get answers from knowledge base.", + "schema": { + "$ref": "#/definitions/AnswersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/SuccessfulQueryKnowledgebases.json" + } + } + } + }, + "/:query-text": { + "post": { + "summary": "Answers the specified question using the provided text in the body.", + "operationId": "QuestionAnswering_GetAnswersFromText", + "parameters": [ + { + "$ref": "#/parameters/AnswersFromTextOptions" + }, + { + "$ref": "common.json#/parameters/ApiVersionParameter" + } + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "A successful response to get answers from input text.", + "schema": { + "$ref": "#/definitions/AnswersFromTextResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "common.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Successful query": { + "$ref": "./examples/questionanswering/SuccessfulQueryText.json" + } + } + } + } + }, + "definitions": { + "AnswersOptions": { + "type": "object", + "description": "Parameters to query a knowledge base.", + "additionalProperties": false, + "properties": { + "qnaId": { + "type": "integer", + "description": "Exact QnA ID to fetch from the knowledge base, this field takes priority over question.", + "format": "int32" + }, + "question": { + "type": "string", + "description": "User question to query against the knowledge base." + }, + "top": { + "type": "integer", + "description": "Max number of answers to be returned for the question.", + "format": "int32" + }, + "userId": { + "type": "string", + "description": "Unique identifier for the user." + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score for answers, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "context": { + "x-ms-client-name": "answerContext", + "description": "Context object with previous QnA's information.", + "$ref": "#/definitions/KnowledgeBaseAnswerContext" + }, + "rankerType": { + "type": "string", + "x-ms-client-name": "rankerKind", + "description": "Type of ranker to be used.", + "x-ms-enum": { + "name": "RankerKind", + "modelAsString": true, + "values": [ + { + "value": "QuestionOnly", + "description": "Question only ranker." + }, + { + "value": "Default", + "description": "Default ranker." + } + ] + }, + "enum": [ + "Default", + "QuestionOnly" + ] + }, + "filters": { + "description": "Filter QnAs based on given metadata list and knowledge base sources.", + "$ref": "#/definitions/QueryFilters" + }, + "answerSpanRequest": { + "x-ms-client-name": "shortAnswerOptions", + "description": "To configure Answer span prediction feature.", + "$ref": "#/definitions/ShortAnswerOptions" + }, + "includeUnstructuredSources": { + "type": "boolean", + "description": "(Optional) Flag to enable Query over Unstructured Sources." + } + } + }, + "ShortAnswerOptions": { + "type": "object", + "description": "To configure Answer span prediction feature.", + "additionalProperties": false, + "required": [ + "enable" + ], + "properties": { + "enable": { + "type": "boolean", + "description": "Enable or disable Answer Span prediction.", + "enum": [ + true + ], + "x-ms-enum": { + "name": "enable", + "modelAsString": false + } + }, + "confidenceScoreThreshold": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidenceThreshold", + "description": "Minimum threshold score required to include an answer span, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "topAnswersWithSpan": { + "type": "integer", + "x-ms-client-name": "top", + "description": "Number of Top answers to be considered for span prediction from 1 to 10.", + "format": "int32", + "maximum": 10, + "minimum": 1 + } + } + }, + "KnowledgeBaseAnswerContext": { + "type": "object", + "description": "Context object with previous QnA's information.", + "additionalProperties": false, + "required": [ + "previousQnaId" + ], + "properties": { + "previousQnaId": { + "type": "integer", + "description": "Previous turn top answer result QnA ID.", + "format": "int32" + }, + "previousUserQuery": { + "type": "string", + "x-ms-client-name": "previousQuestion", + "description": "Previous user query." + } + } + }, + "AnswersResult": { + "type": "object", + "description": "Represents List of Question Answers.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents Answer Result list.", + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswer" + } + } + } + }, + "KnowledgeBaseAnswer": { + "type": "object", + "description": "Represents knowledge base answer.", + "additionalProperties": false, + "properties": { + "questions": { + "type": "array", + "description": "List of questions associated with the answer.", + "items": { + "type": "string" + } + }, + "answer": { + "type": "string", + "description": "Answer text." + }, + "confidenceScore": { + "type": "number", + "format": "double", + "x-ms-client-name": "confidence", + "description": "Answer confidence score, value ranges from 0 to 1.", + "maximum": 1, + "minimum": 0 + }, + "id": { + "type": "integer", + "x-ms-client-name": "qnaId", + "description": "ID of the QnA result.", + "format": "int32" + }, + "source": { + "type": "string", + "description": "Source of QnA result." + }, + "metadata": { + "type": "object", + "description": "Metadata associated with the answer, useful to categorize or filter question answers.", + "additionalProperties": { + "type": "string" + } + }, + "dialog": { + "type": "object", + "$ref": "#/definitions/KnowledgeBaseAnswerDialog" + }, + "answerSpan": { + "type": "object", + "x-ms-client-name": "shortAnswer", + "description": "Answer span object of QnA with respect to user's question.", + "$ref": "#/definitions/AnswerSpan" + } + } + }, + "KnowledgeBaseAnswerDialog": { + "type": "object", + "description": "Dialog associated with Answer.", + "properties": { + "isContextOnly": { + "type": "boolean", + "description": "To mark if a prompt is relevant only with a previous question or not. If true, do not include this QnA as search result for queries without context; otherwise, if false, ignores context and includes this QnA in search result." + }, + "prompts": { + "type": "array", + "description": "List of prompts associated with the answer.", + "maxItems": 20, + "items": { + "$ref": "#/definitions/KnowledgeBaseAnswerPrompt" + } + } + } + }, + "KnowledgeBaseAnswerPrompt": { + "type": "object", + "description": "Prompt for an answer.", + "properties": { + "displayOrder": { + "type": "integer", + "description": "Index of the prompt - used in ordering of the prompts.", + "format": "int32" + }, + "qnaId": { + "type": "integer", + "description": "QnA ID corresponding to the prompt.", + "format": "int32" + }, + "displayText": { + "type": "string", + "description": "Text displayed to represent a follow up question prompt.", + "maxLength": 200 + } + } + }, + "QueryFilters": { + "type": "object", + "description": "filters over knowledge base.", + "additionalProperties": false, + "properties": { + "metadataFilter": { + "type": "object", + "$ref": "#/definitions/MetadataFilter" + }, + "sourceFilter": { + "type": "object", + "$ref": "#/definitions/SourceFilter" + }, + "logicalOperation": { + "type": "string", + "description": "Logical operation used to join metadata filter with source filter.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataFilter": { + "type": "object", + "description": "Find QnAs that are associated with the given list of metadata.", + "additionalProperties": false, + "properties": { + "metadata": { + "type": "array", + "items": { + "$ref": "#/definitions/MetadataRecord" + } + }, + "logicalOperation": { + "type": "string", + "description": "Operation used to join metadata filters.", + "$ref": "#/definitions/LogicalOperationKind", + "default": "AND" + } + } + }, + "MetadataRecord": { + "type": "object", + "description": "Object to provide the key value pair for each metadata.", + "additionalProperties": false, + "required": [ + "key", + "value" + ], + "properties": { + "key": { + "type": "string", + "description": "Metadata Key from Metadata dictionary used in the QnA." + }, + "value": { + "type": "string", + "description": "Metadata Value from Metadata dictionary used in the QnA." + } + } + }, + "LogicalOperationKind": { + "type": "string", + "description": "Set to 'OR' or 'AND' for using corresponding logical operation.", + "x-ms-enum": { + "name": "LogicalOperationKind", + "modelAsString": true + }, + "enum": [ + "AND", + "OR" + ] + }, + "SourceFilter": { + "type": "array", + "description": "Find QnAs that are associated with any of the given list of sources in knowledge base.", + "items": { + "type": "string" + } + }, + "AnswerSpan": { + "type": "object", + "description": "Answer span object of QnA.", + "additionalProperties": false, + "properties": { + "text": { + "type": "string", + "description": "Predicted text of answer span." + }, + "confidenceScore": { + "type": "number", + "x-ms-client-name": "confidence", + "description": "Predicted score of answer span, value ranges from 0 to 1.", + "format": "double", + "maximum": 1, + "minimum": 0 + }, + "offset": { + "type": "integer", + "description": "The answer span offset from the start of answer.", + "format": "int32" + }, + "length": { + "type": "integer", + "description": "The length of the answer span.", + "format": "int32" + } + } + }, + "AnswersFromTextOptions": { + "type": "object", + "description": "The question and text record parameters to answer.", + "required": [ + "question", + "records" + ], + "additionalProperties": false, + "properties": { + "question": { + "type": "string", + "description": "User question to query against the given text records." + }, + "records": { + "type": "array", + "x-ms-client-name": "textDocuments", + "description": "Text records to be searched for given question.", + "items": { + "$ref": "#/definitions/TextDocument" + } + }, + "language": { + "$ref": "common.json#/definitions/Language" + }, + "stringIndexType": { + "$ref": "common.json#/definitions/StringIndexType" + } + } + }, + "AnswersFromTextResult": { + "type": "object", + "description": "Represents the answer results.", + "additionalProperties": false, + "properties": { + "answers": { + "type": "array", + "description": "Represents the answer results.", + "items": { + "$ref": "#/definitions/TextAnswer" + } + } + } + }, + "TextAnswer": { + "type": "object", + "description": "Represents answer result.", + "additionalProperties": false, + "properties": { + "answer": { + "type": "string", + "description": "Answer." + }, + "confidenceScore": { + "type": "number", + "x-ms-client-name": "confidence", + "description": "answer confidence score, value ranges from 0 to 1.", + "format": "double", + "maximum": 1, + "minimum": 0 + }, + "id": { + "type": "string", + "description": "record ID." + }, + "answerSpan": { + "type": "object", + "x-ms-client-name": "shortAnswer", + "description": "Answer span object with respect to user's question.", + "$ref": "#/definitions/AnswerSpan" + }, + "offset": { + "type": "integer", + "description": "The sentence offset from the start of the document.", + "format": "int32" + }, + "length": { + "type": "integer", + "description": "The length of the sentence.", + "format": "int32" + } + } + }, + "TextDocument": { + "type": "object", + "description": "Represent input text record to be queried.", + "additionalProperties": false, + "required": [ + "id", + "text" + ], + "properties": { + "id": { + "type": "string", + "description": "Unique identifier for the text record." + }, + "text": { + "type": "string", + "description": "Text contents of the record." + } + } + } + }, + "parameters": { + "AnswersOptions": { + "name": "knowledgeBaseQueryOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnswersOptions" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + }, + "AnswersFromTextOptions": { + "name": "textQueryOptions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnswersFromTextOptions" + }, + "x-nullable": true, + "description": "Post body of the request.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cognitiveservices/data-plane/Language/readme.md b/specification/cognitiveservices/data-plane/Language/readme.md index 561a46647aa3..2b6eb4e90ba6 100644 --- a/specification/cognitiveservices/data-plane/Language/readme.md +++ b/specification/cognitiveservices/data-plane/Language/readme.md @@ -6,14 +6,12 @@ This is the AutoRest configuration file the Cognitive Services Language SDK. ## Releases -The current preview release of Language is 2022-10-01-preview. +The current preview release of Language is 2023-11-15-preview. -The current stable release of Question Answering is 2021-10-01. - -The current stable release of Conversational Language Understanding and Language is 2022-05-01. +The current stable release of Language is 2023-04-01. ```yaml -tag: release_2023-04-01 +tag: release_2023-11-15-preview add-credentials: true clear-output-folder: true openapi-type: data-plane @@ -24,6 +22,43 @@ directive: where: $.definitions.CurrencyResolution.properties.ISO4217 reason: ISO should be upper case. ``` + +### Release 2023-11-15-preview + +These settings apply only when `--tag=release_2023_11_15_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2023-11-15-preview' +input-file: + - preview/2023-11-15-preview/analyzetext.json + - preview/2023-11-15-preview/analyzetext-authoring.json + - preview/2023-11-15-preview/analyzeconversations.json + - preview/2023-11-15-preview/analyzeconversations-authoring.json + - preview/2023-11-15-preview/questionanswering.json + - preview/2023-11-15-preview/questionanswering-authoring.json +title: + Microsoft Cognitive Language Service +modelerfour: + lenient-model-deduplication: true +``` + +### Release 2023-04-15-preview + +These settings apply only when `--tag=release_2023_04_15_preview` is specified on the command line. + +``` yaml $(tag) == 'release_2023-04-15-preview' +input-file: + - preview/2023-04-15-preview/analyzetext.json + - preview/2023-04-15-preview/analyzetext-authoring.json + - preview/2023-04-15-preview/analyzeconversations.json + - preview/2023-04-15-preview/analyzeconversations-authoring.json + - preview/2023-04-15-preview/questionanswering.json + - preview/2023-04-15-preview/questionanswering-authoring.json +title: + Microsoft Cognitive Language Service +modelerfour: + lenient-model-deduplication: true +``` + ### Release 2023-04-01 These settings apply only when `--tag=release_2023_04_01` is specified on the command line.