{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Authoring API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Authoring", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects" }, "docs": "Lists the existing projects." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName" }, "docs": "Gets the details of a project." }, { "info": { "name": "Microsoft Azure Patch Authoring Analyze Conversations Projects Projectname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName" }, "docs": "Creates a new project or updates an existing one." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName" }, "docs": "Deletes a project." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :authorize Copy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/:authorize-copy" }, "docs": "Generates a copy project operation authorization to the current target Azure resource." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :copy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/:copy" }, "docs": "Copies an existing project to another Azure resource." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/:export", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the exported project file to use." }, { "name": "stringIndexType", "value": "", "type": "query", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." }, { "name": "assetKind", "value": "", "type": "query", "description": "Kind of asset to export." }, { "name": "trainedModelLabel", "value": "", "type": "query", "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy." } ] }, "docs": "Triggers a job to export a project's data." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/:import", "params": [ { "name": "format", "value": "", "type": "query", "description": "The format of the exported project file to use." } ] }, "docs": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname :train", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/:train" }, "docs": "Triggers a training job for a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Copy Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/copy/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing copy project job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments" }, "docs": "Lists the deployments belonging to a project." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Deployments :swap", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:swap" }, "docs": "Swaps two existing deployments with each other." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:deploymentName" }, "docs": "Gets the details of a deployment." }, { "info": { "name": "Microsoft Azure Put Authoring Analyze Conversations Projects Projectname Deployments Deploymentname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:deploymentName" }, "docs": "Creates a new deployment or replaces an existing one." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname Deployments Deploymentname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:deploymentName" }, "docs": "Deletes a project deployment." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Deployments Deploymentname :delete From Resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:deploymentName/:delete-from-resources" }, "docs": "Deletes a project deployment from the specified assigned resources." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname Delete From Resources Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:deploymentName/delete-from-resources/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing delete deployment from specific resources job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Deploymentname Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/:deploymentName/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing deployment job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Deployments Swap Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/deployments/swap/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing swap deployment job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Export Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/export/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an export job. Once job completes, returns the project metadata, and assets." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Import Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/import/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for an import." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models" }, "docs": "Lists the trained models belonging to a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Gets the details of a trained model." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Deletes an existing trained model." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel :evaluate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel/:evaluate", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Triggers evaluation operation on a trained model." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel :load Snapshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel/:load-snapshot", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Restores the snapshot of this trained model to be the current working directory of the project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluate Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel/evaluate/jobs/:jobId", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." }, { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for an evaluation job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluation Result", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel/evaluation/result", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." }, { "name": "stringIndexType", "value": "", "type": "query", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Evaluation Summary Result", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel/evaluation/summary-result", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Models Trainedmodellabel Load Snapshot Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/models/:trainedModelLabel/load-snapshot/jobs/:jobId", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." }, { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for loading a snapshot." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/resources" }, "docs": "Lists the deployments resources assigned to the project." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Resources :assign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/resources/:assign" }, "docs": "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" }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Resources :unassign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/resources/:unassign" }, "docs": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources Assign Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/resources/assign/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing assign deployment resources job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Resources Unassign Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/resources/unassign/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing unassign deployment resources job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Train Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/train/jobs" }, "docs": "Lists the non-expired training jobs created for a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Projectname Train Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/train/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for a training job." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Conversations Projects Projectname Train Jobs Jobid :cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/:projectName/train/jobs/:jobId/:cancel", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Triggers a cancellation for a running training job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Global Deletion Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/global/deletion-jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for a project deletion job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Global Deployments Resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/global/deployments/resources" }, "docs": "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." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Global Languages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/global/languages", "params": [ { "name": "projectKind", "value": "", "type": "query", "description": "The project kind." } ] }, "docs": "Lists the supported languages for the given project type." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Global Prebuilt Entities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/global/prebuilt-entities", "params": [ { "name": "language", "value": "", "type": "query", "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." }, { "name": "multilingual", "value": "", "type": "query", "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored." } ] }, "docs": "Lists the supported prebuilt entities that can be used while creating composed entities." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Conversations Projects Global Training Config Versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-conversations/projects/global/training-config-versions", "params": [ { "name": "projectKind", "value": "", "type": "query", "description": "The project kind." } ] }, "docs": "Lists the support training config version for a given project type." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects" }, "docs": "Lists the existing projects." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName" }, "docs": "Gets the details of a project." }, { "info": { "name": "Microsoft Azure Patch Authoring Analyze Text Projects Projectname", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName" }, "docs": "Creates a new project or updates an existing one." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Text Projects Projectname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName" }, "docs": "Deletes a project." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname :authorize Copy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/:authorize-copy" }, "docs": "Generates a copy project operation authorization to the current target Azure resource." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname :copy", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/:copy" }, "docs": "Copies an existing project to another Azure resource." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname :export", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/:export", "params": [ { "name": "stringIndexType", "value": "", "type": "query", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." }, { "name": "assetKind", "value": "", "type": "query", "description": "Kind of asset to export." }, { "name": "trainedModelLabel", "value": "", "type": "query", "description": "Trained model label to export. If the trainedModelLabel is null, the default behavior is to export the current working copy." } ] }, "docs": "Triggers a job to export a project's data." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname :import", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/:import", "headers": [ { "name": "format", "value": "" } ] }, "docs": "Triggers a job to import a project. If a project with the same name already exists, the data of that project is replaced." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname :train", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/:train" }, "docs": "Triggers a training job for a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Copy Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/copy/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing copy project job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments" }, "docs": "Lists the deployments belonging to a project." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments :swap", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:swap" }, "docs": "Swaps two existing deployments with each other." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:deploymentName" }, "docs": "Gets the details of a deployment." }, { "info": { "name": "Microsoft Azure Put Authoring Analyze Text Projects Projectname Deployments Deploymentname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:deploymentName" }, "docs": "Creates a new deployment or replaces an existing one." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Text Projects Projectname Deployments Deploymentname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:deploymentName" }, "docs": "Deletes a project deployment." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Deployments Deploymentname :delete From Resources", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:deploymentName/:delete-from-resources" }, "docs": "Deletes a project deployment from the specified assigned resources." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Delete From Resources Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:deploymentName/delete-from-resources/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing delete deployment from specific resources job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Deploymentname Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/:deploymentName/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing deployment job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Deployments Swap Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/deployments/swap/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing swap deployment job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Export Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/export/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an export job. Once job completes, returns the project metadata, and assets." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/exported-models" }, "docs": "Lists the exported models belonging to a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/exported-models/:exportedModelName", "params": [ { "name": "exportedModelName", "value": "", "type": "path", "description": "The exported model name." } ] }, "docs": "Gets the details of an exported model." }, { "info": { "name": "Microsoft Azure Put Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/exported-models/:exportedModelName", "params": [ { "name": "exportedModelName", "value": "", "type": "path", "description": "The exported model name." } ] }, "docs": "Creates a new exported model or replaces an existing one." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/exported-models/:exportedModelName", "params": [ { "name": "exportedModelName", "value": "", "type": "path", "description": "The exported model name." } ] }, "docs": "Deletes an existing exported model." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/exported-models/:exportedModelName/jobs/:jobId", "params": [ { "name": "exportedModelName", "value": "", "type": "path", "description": "The exported model name." }, { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for an existing job to create or update an exported model." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Exported Models Exportedmodelname Manifest", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/exported-models/:exportedModelName/manifest", "params": [ { "name": "exportedModelName", "value": "", "type": "path", "description": "The exported model name." } ] }, "docs": "Gets the details and URL needed to download the exported model." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Import Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/import/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for an import." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Models", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models" }, "docs": "Lists the trained models belonging to a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Gets the details of a trained model." }, { "info": { "name": "Microsoft Azure Delete Authoring Analyze Text Projects Projectname Models Trainedmodellabel", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Deletes an existing trained model." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Models Trainedmodellabel :evaluate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/:evaluate", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Triggers evaluation operation on a trained model." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Models Trainedmodellabel :load Snapshot", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/:load-snapshot", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Restores the snapshot of this trained model to be the current working directory of the project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluate Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/evaluate/jobs/:jobId", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." }, { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for an evaluation job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Result", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/evaluation/result", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." }, { "name": "stringIndexType", "value": "", "type": "query", "description": "Specifies the method used to interpret string offsets. For additional information see https://aka.ms/text-analytics-offsets." } ] }, "docs": "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." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Evaluation Summary Result", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/evaluation/summary-result", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." } ] }, "docs": "Gets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Models Trainedmodellabel Load Snapshot Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/load-snapshot/jobs/:jobId", "params": [ { "name": "trainedModelLabel", "value": "", "type": "path", "description": "The trained model label." }, { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for loading a snapshot." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/resources" }, "docs": "Lists the deployments resources assigned to the project." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Resources :assign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/resources/:assign" }, "docs": "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" }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Resources :unassign", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/resources/:unassign" }, "docs": "Unassign resources from a project. This disallows deploying new deployments to these resources, and deletes existing deployments assigned to them." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources Assign Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/resources/assign/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing assign deployment resources job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Resources Unassign Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/resources/unassign/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status of an existing unassign deployment resources job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/train/jobs" }, "docs": "Lists the non-expired training jobs created for a project." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Projectname Train Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/train/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for a training job." }, { "info": { "name": "Microsoft Azure Post Authoring Analyze Text Projects Projectname Train Jobs Jobid :cancel", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/analyze-text/projects/:projectName/train/jobs/:jobId/:cancel", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Triggers a cancellation for a running training job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Global Deletion Jobs Jobid", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/global/deletion-jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job ID." } ] }, "docs": "Gets the status for a project deletion job." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Global Deployments Resources", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/global/deployments/resources" }, "docs": "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." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Global Languages", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/global/languages", "params": [ { "name": "projectKind", "value": "", "type": "query", "description": "The project kind, default value is CustomSingleLabelClassification." } ] }, "docs": "Lists the supported languages." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Global Prebuilt Entities", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/global/prebuilt-entities", "params": [ { "name": "projectKind", "value": "", "type": "query", "description": "The project kind, default value is CustomSingleLabelClassification." }, { "name": "language", "value": "", "type": "query", "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." }, { "name": "multilingual", "value": "", "type": "query", "description": "Whether to get the support prebuilt entities for multilingual or monolingual projects. If true, the language parameter is ignored." } ] }, "docs": "Lists the supported prebuilt entities that can be used while creating composed entities." }, { "info": { "name": "Microsoft Azure Get Authoring Analyze Text Projects Global Training Config Versions", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/analyze-text/projects/global/training-config-versions", "params": [ { "name": "projectKind", "value": "", "type": "query", "description": "The project kind." } ] }, "docs": "Lists the support training config version for a given project type." }, { "info": { "name": "Microsoft Azure Gets All Projects For A User", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Get The Requested Project Metadata", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Create Or Update A Project", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Delete The Project", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Status Of A Project Delete Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/deletion-jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Export Project Metadata And Assets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/:export", "params": [ { "name": "format", "value": "", "type": "query", "description": "Knowledge base Import or Export format." }, { "name": "assetKind", "value": "", "type": "query", "description": "Kind of the asset of the project." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Status Of An Export Job, Once Job Completes, Returns The Project Metadata, And Assets", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/export/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Import Project Assets", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/:import", "params": [ { "name": "format", "value": "", "type": "query", "description": "Knowledge base Import or Export format." }, { "name": "assetKind", "value": "", "type": "query", "description": "Kind of the asset of the project." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Status Of An Import Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/import/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Deploy Project To Production", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/deployments/:deploymentName" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Status Of A Deploy Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/deployments/:deploymentName/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure List All Deployments Of A Project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/deployments" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets All The Synonyms Of A Project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/synonyms" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Updates All The Synonyms Of A Project", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/synonyms" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets All The Sources Of A Project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/sources" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Updates The Sources Of A Project", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/sources" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Status Of Update Sources Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/sources/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets All The Qnas Of A Project", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/qnas", "params": [ { "name": "source", "value": "", "type": "query", "description": "Source of the QnA." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Updates The Qnas Of A Project", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/qnas" }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets The Status Of Update Qnas Job", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/qnas/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "Job ID." } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Update Active Learning Feedback", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/authoring/query-knowledgebases/projects/:projectName/feedback" }, "docs": "Needs a more full description created." } ] } ], "bundled": true }