swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector Authoring API schemes: - https tags: - name: Authoring paths: /authoring/analyze-conversations/projects: get: description: Lists the existing projects. operationId: microsoftAzureConversationalanalysisauthoringListprojects 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects tags: - Authoring /authoring/analyze-conversations/projects/{projectName}: patch: description: Creates a new project or updates an existing one. operationId: microsoftAzureConversationalanalysisauthoringCreateproject 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 summary: Microsoft Azure Patch Authoring Analyze Conversations Projects Projectname tags: - Authoring get: description: Gets the details of a project. operationId: microsoftAzureConversationalanalysisauthoringGetproject 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname tags: - Authoring delete: description: Deletes a project. operationId: microsoftAzureConversationalanalysisauthoringDeleteproject 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 summary: Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/:authorize-copy: post: description: Generates a copy project operation authorization to the current target Azure resource. operationId: microsoftAzureConversationalanalysisauthoringCopyprojectauthorization 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :authorize Copy tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/:copy: post: description: Copies an existing project to another Azure resource. operationId: microsoftAzureConversationalanalysisauthoringCopyproject 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :copy tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/:export: post: description: Triggers a job to export a project's data. operationId: microsoftAzureConversationalanalysisauthoringExport 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :export tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringImport 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :import tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/:train: post: description: Triggers a training job for a project. operationId: microsoftAzureConversationalanalysisauthoringTrain 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :train tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/copy/jobs/{jobId}: get: description: Gets the status of an existing copy project job. operationId: microsoftAzureConversationalanalysisauthoringGetcopyprojectstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Copy Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/deployments: get: description: Lists the deployments belonging to a project. operationId: microsoftAzureConversationalanalysisauthoringListdeployments 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/deployments/:swap: post: description: Swaps two existing deployments with each other. operationId: microsoftAzureConversationalanalysisauthoringSwapdeployments 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Deployments :swap tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}: get: description: Gets the details of a deployment. operationId: microsoftAzureConversationalanalysisauthoringGetdeployment 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname tags: - Authoring put: description: Creates a new deployment or replaces an existing one. operationId: microsoftAzureConversationalanalysisauthoringDeployproject 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 summary: Microsoft Azure Put Authoring Analyze Conversations Projects Projectname Deployments Deploymentname tags: - Authoring delete: description: Deletes a project deployment. operationId: microsoftAzureConversationalanalysisauthoringDeletedeployment 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 summary: Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname Deployments Deploymentname tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources: post: description: Deletes a project deployment from the specified assigned resources. operationId: microsoftAzureConversationalanalysisauthoringDeletedeploymentfromresources 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Deployments Deploymentname :delete From Resources tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringGetdeploymentdeletefromresourcesstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname Delete From Resources Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}: get: description: Gets the status of an existing deployment job. operationId: microsoftAzureConversationalanalysisauthoringGetdeploymentstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/deployments/swap/jobs/{jobId}: get: description: Gets the status of an existing swap deployment job. operationId: microsoftAzureConversationalanalysisauthoringGetswapdeploymentsstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Swap Jobs Jobid tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringGetexportstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Export Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/import/jobs/{jobId}: get: description: Gets the status for an import. operationId: microsoftAzureConversationalanalysisauthoringGetimportstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Import Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/models: get: description: Lists the trained models belonging to a project. operationId: microsoftAzureConversationalanalysisauthoringListtrainedmodels 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}: get: description: Gets the details of a trained model. operationId: microsoftAzureConversationalanalysisauthoringGettrainedmodel 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel tags: - Authoring delete: description: Deletes an existing trained model. operationId: microsoftAzureConversationalanalysisauthoringDeletetrainedmodel 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 summary: Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/:evaluate: post: description: Triggers evaluation operation on a trained model. operationId: microsoftAzureConversationalanalysisauthoringEvaluatemodel 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel :evaluate tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringLoadsnapshot 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel :load Snapshot tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}: get: description: Gets the status for an evaluation job. operationId: microsoftAzureConversationalanalysisauthoringGetevaluationstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluate Jobs Jobid tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringGetmodelevaluationresults 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluation Result tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringGetmodelevaluationsummary 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluation Summary Result tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}: get: description: Gets the status for loading a snapshot. operationId: microsoftAzureConversationalanalysisauthoringGetloadsnapshotstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Load Snapshot Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/resources: get: description: Lists the deployments resources assigned to the project. operationId: microsoftAzureConversationalanalysisauthoringListdeploymentresources 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringAssigndeploymentresources 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Resources :assign tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringUnassigndeploymentresources 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Resources :unassign tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/resources/assign/jobs/{jobId}: get: description: Gets the status of an existing assign deployment resources job. operationId: microsoftAzureConversationalanalysisauthoringGetassigndeploymentresourcesstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources Assign Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/resources/unassign/jobs/{jobId}: get: description: Gets the status of an existing unassign deployment resources job. operationId: microsoftAzureConversationalanalysisauthoringGetunassigndeploymentresourcesstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources Unassign Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/train/jobs: get: description: Lists the non-expired training jobs created for a project. operationId: microsoftAzureConversationalanalysisauthoringListtrainingjobs 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Train Jobs tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}: get: description: Gets the status for a training job. operationId: microsoftAzureConversationalanalysisauthoringGettrainingstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Train Jobs Jobid tags: - Authoring /authoring/analyze-conversations/projects/{projectName}/train/jobs/{jobId}/:cancel: post: description: Triggers a cancellation for a running training job. operationId: microsoftAzureConversationalanalysisauthoringCanceltrainingjob 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 summary: Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Train Jobs Jobid :cancel tags: - Authoring /authoring/analyze-conversations/projects/global/deletion-jobs/{jobId}: get: description: Gets the status for a project deletion job. operationId: microsoftAzureConversationalanalysisauthoringGetprojectdeletionstatus 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Global Deletion Jobs Jobid tags: - Authoring /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: microsoftAzureConversationalanalysisauthoringListassignedresourcedeployments 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Global Deployments Resources tags: - Authoring /authoring/analyze-conversations/projects/global/languages: get: description: Lists the supported languages for the given project type. operationId: microsoftAzureConversationalanalysisauthoringGetsupportedlanguages 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Global Languages tags: - Authoring /authoring/analyze-conversations/projects/global/prebuilt-entities: get: description: Lists the supported prebuilt entities that can be used while creating composed entities. operationId: microsoftAzureConversationalanalysisauthoringGetsupportedprebuiltentities 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Global Prebuilt Entities tags: - Authoring /authoring/analyze-conversations/projects/global/training-config-versions: get: description: Lists the support training config version for a given project type. operationId: microsoftAzureConversationalanalysisauthoringListtrainingconfigversions 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 summary: Microsoft Azure Get Authoring Analyze Conversations Projects Global Training Config Versions tags: - Authoring /authoring/analyze-text/projects: get: description: Lists the existing projects. operationId: microsoftAzureTextanalysisauthoringListprojects 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 summary: Microsoft Azure Get Authoring Analyze Text Projects tags: - Authoring /authoring/analyze-text/projects/{projectName}: patch: description: Creates a new project or updates an existing one. operationId: microsoftAzureTextanalysisauthoringCreateproject 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 summary: Microsoft Azure Patch Authoring Analyze Text Projects Projectname tags: - Authoring get: description: Gets the details of a project. operationId: microsoftAzureTextanalysisauthoringGetproject 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname tags: - Authoring delete: description: Deletes a project. operationId: microsoftAzureTextanalysisauthoringDeleteproject 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 summary: Microsoft Azure Delete Authoring Analyze Text Projects Projectname tags: - Authoring /authoring/analyze-text/projects/{projectName}/:authorize-copy: post: description: Generates a copy project operation authorization to the current target Azure resource. operationId: microsoftAzureTextanalysisauthoringCopyprojectauthorization 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :authorize Copy tags: - Authoring /authoring/analyze-text/projects/{projectName}/:copy: post: description: Copies an existing project to another Azure resource. operationId: microsoftAzureTextanalysisauthoringCopyproject 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :copy tags: - Authoring /authoring/analyze-text/projects/{projectName}/:export: post: description: Triggers a job to export a project's data. operationId: microsoftAzureTextanalysisauthoringExport 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :export tags: - Authoring /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: microsoftAzureTextanalysisauthoringImport 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :import tags: - Authoring /authoring/analyze-text/projects/{projectName}/:train: post: description: Triggers a training job for a project. operationId: microsoftAzureTextanalysisauthoringTrain 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname :train tags: - Authoring /authoring/analyze-text/projects/{projectName}/copy/jobs/{jobId}: get: description: Gets the status of an existing copy project job. operationId: microsoftAzureTextanalysisauthoringGetcopyprojectstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Copy Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/deployments: get: description: Lists the deployments belonging to a project. operationId: microsoftAzureTextanalysisauthoringListdeployments 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments tags: - Authoring /authoring/analyze-text/projects/{projectName}/deployments/:swap: post: description: Swaps two existing deployments with each other. operationId: microsoftAzureTextanalysisauthoringSwapdeployments 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments :swap tags: - Authoring /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}: get: description: Gets the details of a deployment. operationId: microsoftAzureTextanalysisauthoringGetdeployment 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname tags: - Authoring put: description: Creates a new deployment or replaces an existing one. operationId: microsoftAzureTextanalysisauthoringDeployproject 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 summary: Microsoft Azure Put Authoring Analyze Text Projects Projectname Deployments Deploymentname tags: - Authoring delete: description: Deletes a project deployment. operationId: microsoftAzureTextanalysisauthoringDeletedeployment 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 summary: Microsoft Azure Delete Authoring Analyze Text Projects Projectname Deployments Deploymentname tags: - Authoring /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/:delete-from-resources: post: description: Deletes a project deployment from the specified assigned resources. operationId: microsoftAzureTextanalysisauthoringDeletedeploymentfromresources 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments Deploymentname :delete From Resources tags: - Authoring /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: microsoftAzureTextanalysisauthoringGetdeploymentdeletefromresourcesstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Delete From Resources Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}: get: description: Gets the status of an existing deployment job. operationId: microsoftAzureTextanalysisauthoringGetdeploymentstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/deployments/swap/jobs/{jobId}: get: description: Gets the status of an existing swap deployment job. operationId: microsoftAzureTextanalysisauthoringGetswapdeploymentsstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Swap Jobs Jobid tags: - Authoring /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: microsoftAzureTextanalysisauthoringGetexportstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Export Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/exported-models: get: description: Lists the exported models belonging to a project. operationId: microsoftAzureTextanalysisauthoringListexportedmodels 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models tags: - Authoring /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}: get: description: Gets the details of an exported model. operationId: microsoftAzureTextanalysisauthoringGetexportedmodel 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname tags: - Authoring delete: description: Deletes an existing exported model. operationId: microsoftAzureTextanalysisauthoringDeleteexportedmodel 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 summary: Microsoft Azure Delete Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname tags: - Authoring put: description: Creates a new exported model or replaces an existing one. operationId: microsoftAzureTextanalysisauthoringCreateorupdateexportedmodel 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 summary: Microsoft Azure Put Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname tags: - Authoring /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: microsoftAzureTextanalysisauthoringGetexportedmodeljobstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/exported-models/{exportedModelName}/manifest: get: description: Gets the details and URL needed to download the exported model. operationId: microsoftAzureTextanalysisauthoringGetexportedmodelmanifest 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname Manifest tags: - Authoring /authoring/analyze-text/projects/{projectName}/import/jobs/{jobId}: get: description: Gets the status for an import. operationId: microsoftAzureTextanalysisauthoringGetimportstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Import Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/models: get: description: Lists the trained models belonging to a project. operationId: microsoftAzureTextanalysisauthoringListtrainedmodels 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models tags: - Authoring /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}: get: description: Gets the details of a trained model. operationId: microsoftAzureTextanalysisauthoringGettrainedmodel 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel tags: - Authoring delete: description: Deletes an existing trained model. operationId: microsoftAzureTextanalysisauthoringDeletetrainedmodel 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 summary: Microsoft Azure Delete Authoring Analyze Text Projects Projectname Models Trainedmodellabel tags: - Authoring /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/:evaluate: post: description: Triggers evaluation operation on a trained model. operationId: microsoftAzureTextanalysisauthoringEvaluatemodel 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Models Trainedmodellabel :evaluate tags: - Authoring /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: microsoftAzureTextanalysisauthoringLoadsnapshot 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Models Trainedmodellabel :load Snapshot tags: - Authoring /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/evaluate/jobs/{jobId}: get: description: Gets the status for an evaluation job. operationId: microsoftAzureTextanalysisauthoringGetevaluationstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluate Jobs Jobid tags: - Authoring /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: microsoftAzureTextanalysisauthoringGetmodelevaluationresults 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Result tags: - Authoring /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: microsoftAzureTextanalysisauthoringGetmodelevaluationsummary 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Summary Result tags: - Authoring /authoring/analyze-text/projects/{projectName}/models/{trainedModelLabel}/load-snapshot/jobs/{jobId}: get: description: Gets the status for loading a snapshot. operationId: microsoftAzureTextanalysisauthoringGetloadsnapshotstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Load Snapshot Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/resources: get: description: Lists the deployments resources assigned to the project. operationId: microsoftAzureTextanalysisauthoringListdeploymentresources 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources tags: - Authoring /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: microsoftAzureTextanalysisauthoringAssigndeploymentresources 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Resources :assign tags: - Authoring /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: microsoftAzureTextanalysisauthoringUnassigndeploymentresources 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Resources :unassign tags: - Authoring /authoring/analyze-text/projects/{projectName}/resources/assign/jobs/{jobId}: get: description: Gets the status of an existing assign deployment resources job. operationId: microsoftAzureTextanalysisauthoringGetassigndeploymentresourcesstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources Assign Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/resources/unassign/jobs/{jobId}: get: description: Gets the status of an existing unassign deployment resources job. operationId: microsoftAzureTextanalysisauthoringGetunassigndeploymentresourcesstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources Unassign Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/train/jobs: get: description: Lists the non-expired training jobs created for a project. operationId: microsoftAzureTextanalysisauthoringListtrainingjobs 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs tags: - Authoring /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}: get: description: Gets the status for a training job. operationId: microsoftAzureTextanalysisauthoringGettrainingstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs Jobid tags: - Authoring /authoring/analyze-text/projects/{projectName}/train/jobs/{jobId}/:cancel: post: description: Triggers a cancellation for a running training job. operationId: microsoftAzureTextanalysisauthoringCanceltrainingjob 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 summary: Microsoft Azure Post Authoring Analyze Text Projects Projectname Train Jobs Jobid :cancel tags: - Authoring /authoring/analyze-text/projects/global/deletion-jobs/{jobId}: get: description: Gets the status for a project deletion job. operationId: microsoftAzureTextanalysisauthoringGetprojectdeletionstatus 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Global Deletion Jobs Jobid tags: - Authoring /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: microsoftAzureTextanalysisauthoringListassignedresourcedeployments 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Global Deployments Resources tags: - Authoring /authoring/analyze-text/projects/global/languages: get: description: Lists the supported languages. operationId: microsoftAzureTextanalysisauthoringGetsupportedlanguages 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Global Languages tags: - Authoring /authoring/analyze-text/projects/global/prebuilt-entities: get: description: Lists the supported prebuilt entities that can be used while creating composed entities. operationId: microsoftAzureTextanalysisauthoringGetsupportedprebuiltentities 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Global Prebuilt Entities tags: - Authoring /authoring/analyze-text/projects/global/training-config-versions: get: description: Lists the support training config version for a given project type. operationId: microsoftAzureTextanalysisauthoringListtrainingconfigversions 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 summary: Microsoft Azure Get Authoring Analyze Text Projects Global Training Config Versions tags: - Authoring /authoring/query-knowledgebases/projects: get: summary: Microsoft Azure Gets All Projects For A User operationId: microsoftAzureQuestionansweringprojectsListprojects 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}: get: summary: Microsoft Azure Get The Requested Project Metadata operationId: microsoftAzureQuestionansweringprojectsGetprojectdetails 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 description: Needs a more full description created. tags: - Authoring patch: summary: Microsoft Azure Create Or Update A Project operationId: microsoftAzureQuestionansweringprojectsCreateproject 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 description: Needs a more full description created. tags: - Authoring delete: summary: Microsoft Azure Delete The Project operationId: microsoftAzureQuestionansweringprojectsDeleteproject 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/deletion-jobs/{jobId}: get: summary: Microsoft Azure Gets The Status Of A Project Delete Job operationId: microsoftAzureQuestionansweringprojectsGetdeletestatus 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/:export: post: summary: Microsoft Azure Export Project Metadata And Assets operationId: microsoftAzureQuestionansweringprojectsExport 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/export/jobs/{jobId}: get: summary: Microsoft Azure Gets The Status Of An Export Job, Once Job Completes, Returns The Project Metadata, And Assets operationId: microsoftAzureQuestionansweringprojectsGetexportstatus 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/:import: post: summary: Microsoft Azure Import Project Assets operationId: microsoftAzureQuestionansweringprojectsImport 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/import/jobs/{jobId}: get: summary: Microsoft Azure Gets The Status Of An Import Job operationId: microsoftAzureQuestionansweringprojectsGetimportstatus 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}: put: summary: Microsoft Azure Deploy Project To Production operationId: microsoftAzureQuestionansweringprojectsDeployproject 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/deployments/{deploymentName}/jobs/{jobId}: get: summary: Microsoft Azure Gets The Status Of A Deploy Job operationId: microsoftAzureQuestionansweringprojectsGetdeploystatus 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/deployments: get: summary: Microsoft Azure List All Deployments Of A Project operationId: microsoftAzureQuestionansweringprojectsListdeployments 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/synonyms: get: summary: Microsoft Azure Gets All The Synonyms Of A Project operationId: microsoftAzureQuestionansweringprojectsGetsynonyms 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 description: Needs a more full description created. tags: - Authoring put: summary: Microsoft Azure Updates All The Synonyms Of A Project operationId: microsoftAzureQuestionansweringprojectsUpdatesynonyms 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/sources: get: summary: Microsoft Azure Gets All The Sources Of A Project operationId: microsoftAzureQuestionansweringprojectsGetsources 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 description: Needs a more full description created. tags: - Authoring patch: summary: Microsoft Azure Updates The Sources Of A Project operationId: microsoftAzureQuestionansweringprojectsUpdatesources 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/sources/jobs/{jobId}: get: summary: Microsoft Azure Gets The Status Of Update Sources Job operationId: microsoftAzureQuestionansweringprojectsGetupdatesourcesstatus 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/qnas: get: summary: Microsoft Azure Gets All The Qnas Of A Project operationId: microsoftAzureQuestionansweringprojectsGetqnas 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 description: Needs a more full description created. tags: - Authoring patch: summary: Microsoft Azure Updates The Qnas Of A Project operationId: microsoftAzureQuestionansweringprojectsUpdateqnas 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/qnas/jobs/{jobId}: get: summary: Microsoft Azure Gets The Status Of Update Qnas Job operationId: microsoftAzureQuestionansweringprojectsGetupdateqnasstatus 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 description: Needs a more full description created. tags: - Authoring /authoring/query-knowledgebases/projects/{projectName}/feedback: post: summary: Microsoft Azure Update Active Learning Feedback operationId: microsoftAzureQuestionansweringprojectsAddfeedback 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 description: Needs a more full description created. tags: - Authoring definitions: 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 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 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 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 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 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 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 TextAnalysisAuthoringCopyProjectJobState: description: Represents the state of a copy job. type: object allOf: - $ref: '#/definitions/TextAnalysisAuthoringJobState' x-ms-client-name: CopyProjectJobState 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 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 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 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 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 QnaSourceRecord: description: Custom source record with last updated date-time. allOf: - $ref: '#/definitions/QnaSourceMetadata' - $ref: '#/definitions/LastUpdatedDateTimeParameter' 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 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 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 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 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 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 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 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' 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 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 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 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 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 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 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 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 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 JobStatus: description: Job Status. enum: - notStarted - running - succeeded - failed - cancelled - cancelling - partiallyCompleted type: string x-ms-enum: modelAsString: true name: jobStatus TextAnalysisAuthoringJobStatus: enum: - notStarted - running - succeeded - failed - cancelled - cancelling - partiallyCompleted type: string x-ms-enum: name: JobStatus modelAsString: true x-ms-client-name: JobStatus 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 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 ConversationalAnalysisAuthoringProjectDeletionJobState: description: Represents the state of a project deletion job. type: object allOf: - $ref: '#/definitions/ConversationalAnalysisAuthoringJobState' x-ms-client-name: ProjectDeletionJobState 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 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 ConversationalAnalysisAuthoringLoadSnapshotJobState: description: Represents the state of loading a snapshot job. type: object allOf: - $ref: '#/definitions/ConversationalAnalysisAuthoringJobState' x-ms-client-name: LoadSnapshotJobState 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. 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 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 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 QnaAssets: type: object description: All QnA assets for the project. additionalProperties: false properties: value: $ref: '#/definitions/QnaAsset' nextLink: type: string 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 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 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 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 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 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 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 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 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 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 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 ConversationalAnalysisAuthoringImportProjectJobState: description: Represents the state of an import job. type: object allOf: - $ref: '#/definitions/ConversationalAnalysisAuthoringJobState' x-ms-client-name: ImportProjectJobState 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 QnaSources: type: object description: All QnA sources for the project. additionalProperties: false properties: value: $ref: '#/definitions/QnaSourcesMetadata' nextLink: type: string SynonymAsset: type: array description: Collection of synonyms. additionalProperties: false maxLength: 10000 items: $ref: '#/definitions/WordAlterations' 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 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 UpdateSourcesOptions: type: array description: A list of sources to be updated. additionalProperties: false items: $ref: '#/definitions/UpdateSourceRecord' 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. SynonymAssets: type: object description: All synonym assets for this project. additionalProperties: false properties: value: $ref: '#/definitions/SynonymAsset' nextLink: type: string 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 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' 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 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 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 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 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 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' ConversationalAnalysisAuthoringConfusionMatrixRow: type: object additionalProperties: $ref: '#/definitions/ConversationalAnalysisAuthoringConfusionMatrixCell' x-ms-client-name: ConfusionMatrixRow RetrieveQnaRecord: description: QnA Record with last updated date-time. allOf: - $ref: '#/definitions/QnaRecord' - $ref: '#/definitions/LastUpdatedDateTimeParameter' 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 ConversationalAnalysisAuthoringCopyProjectJobState: description: Represents the state of a copy job. type: object allOf: - $ref: '#/definitions/ConversationalAnalysisAuthoringJobState' x-ms-client-name: CopyProjectJobState 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. 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 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 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 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 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 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 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 ActiveLearningFeedback: type: object description: Feedback for Active Learning. additionalProperties: false properties: records: $ref: '#/definitions/FeedbackRecords' 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 TextAnalysisAuthoringDeploymentResourcesJobState: description: Represents the state of a deployment resources job. type: object allOf: - $ref: '#/definitions/TextAnalysisAuthoringJobState' x-ms-client-name: DeploymentResourcesJobState 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 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 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 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 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 FeedbackRecords: type: array description: A list of Feedback Records for Active Learning. additionalProperties: false items: $ref: '#/definitions/FeedbackRecord' 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 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 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 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 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 ConversationalAnalysisAuthoringJobStatus: enum: - notStarted - running - succeeded - failed - cancelled - cancelling - partiallyCompleted type: string x-ms-enum: name: JobStatus modelAsString: true x-ms-client-name: JobStatus 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 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 ImportQnaRecord: description: Import QnA Record. allOf: - $ref: '#/definitions/RetrieveQnaRecord' - $ref: '#/definitions/SourceDisplayNameParameter' 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 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 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' 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' Assets: type: object description: All assets for this project. additionalProperties: false properties: synonyms: $ref: '#/definitions/SynonymAsset' qnas: $ref: '#/definitions/ImportQnaAsset' 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 UpdateQnaSourceRecord: description: Update source record. allOf: - $ref: '#/definitions/QnaSourceMetadata' - $ref: '#/definitions/RefreshSourceOptions' 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 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 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 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 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 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 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 SourceContentStructureKind: type: string description: Content structure type for sources. enum: - unstructured x-ms-enum: modelAsString: true name: sourceContentStructureKind 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 Errors: description: Collection of Error types. type: object properties: errors: type: array items: $ref: common.json#/definitions/Error 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. 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 UpdateOperationKind: type: string description: Update operation type for assets. enum: - add - delete - replace x-ms-enum: modelAsString: true name: updateOperationKind 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 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 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 ConversationalAnalysisAuthoringConfusionMatrix: type: object additionalProperties: $ref: '#/definitions/ConversationalAnalysisAuthoringConfusionMatrixRow' x-ms-client-name: ConfusionMatrix 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 JobState: description: Job state represents the job metadata and any errors. allOf: - $ref: '#/definitions/JobMetadata' - $ref: '#/definitions/Errors' 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 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 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 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 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 TextAnalysisAuthoringImportProjectJobState: description: Represents the state of an import job. type: object allOf: - $ref: '#/definitions/TextAnalysisAuthoringJobState' x-ms-client-name: ImportProjectJobState 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 SourceDisplayNameParameter: type: object properties: sourceDisplayName: description: Friendly name of the Source. type: string maxLength: 200 minLength: 1 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 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 ProjectDeployments: type: object description: All deployments of a project. additionalProperties: false properties: value: $ref: '#/definitions/ProjectDeploymentsList' nextLink: type: string 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 ConversationalAnalysisAuthoringDeploymentResourcesJobState: description: Represents the state of a deployment resources job. type: object allOf: - $ref: '#/definitions/ConversationalAnalysisAuthoringJobState' x-ms-client-name: DeploymentResourcesJobState TextAnalysisAuthoringProjectDeletionJobState: description: Represents the state of a project deletion job. type: object allOf: - $ref: '#/definitions/TextAnalysisAuthoringJobState' x-ms-client-name: ProjectDeletionJobState 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 ExportJobState: description: Export job status, project metadata, and assets. allOf: - $ref: '#/definitions/JobState' - $ref: '#/definitions/ExportJobResultUrl' 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 QnaSourcesMetadata: type: array description: Custom sources from which QnAs were extracted or explicitly added to the project. additionalProperties: false items: $ref: '#/definitions/QnaSourceRecord' 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 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 ImportQnaAsset: type: array description: List of QnA records to import. additionalProperties: false items: $ref: '#/definitions/ImportQnaRecord' 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 ConversationalAnalysisAuthoringDeploymentJobState: description: Represents the state of a deployment job. type: object allOf: - $ref: '#/definitions/ConversationalAnalysisAuthoringJobState' x-ms-client-name: DeploymentJobState TextAnalysisAuthoringDeploymentJobState: description: Represents the state of a deployment job. type: object allOf: - $ref: '#/definitions/TextAnalysisAuthoringJobState' x-ms-client-name: DeploymentJobState 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. 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 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 TextAnalysisAuthoringLoadSnapshotJobState: description: Represents the state of loading a snapshot job. type: object allOf: - $ref: '#/definitions/TextAnalysisAuthoringJobState' x-ms-client-name: LoadSnapshotJobState UpdateSourceRecord: type: object description: Source to be updated. additionalProperties: false required: - op - value properties: op: type: string $ref: '#/definitions/UpdateOperationKind' value: $ref: '#/definitions/UpdateQnaSourceRecord' 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 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 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 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 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 QnaAsset: type: array description: List of QnA records. additionalProperties: false items: $ref: '#/definitions/RetrieveQnaRecord' 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 QnaSourceKind: type: string description: Supported source types. x-ms-enum: name: sourceKind modelAsString: true enum: - file - url 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 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 ProjectDeploymentsList: type: array description: List of deployments of a project. additionalProperties: false items: $ref: '#/definitions/ProjectDeployment' UpdateQnaOptions: type: array description: A list of QnAs to be updated. additionalProperties: false items: $ref: '#/definitions/UpdateQnaRecord' 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 parameters: 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 SourceFilterParameter: name: source in: query description: Source of the QnA. 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 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 TextAnalysisAuthoringExportedModelNamePathParameter: in: path name: exportedModelName description: The exported model name. 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 TextAnalysisAuthoringJobIdPathParameter: in: path name: jobId description: The job ID. required: true type: string x-ms-parameter-location: method ConversationalAnalysisAuthoringJobIdPathParameter: in: path name: jobId description: The job ID. required: true type: string 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 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 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 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 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 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 x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'