Microsoft Azure Cognitive Language Service Text Analysis Authoring is a powerful tool that allows users to analyze and process text data in a variety of ways. With features such as sentiment analysis, entity recognition, key phrase extraction, and language detection, users can gain valuable insights from large amounts of textual information.
swagger: '2.0'
info:
title: Microsoft Azure Microsoft Cognitive Language Service - Text Analysis Authoring
version: 2022-05-15-preview
description: >-
The language service API is a suite of natural language processing (NLP)
skills built with best-in-class Microsoft machine learning algorithms. The
API can be used to analyze unstructured text for tasks such as sentiment
analysis, key phrase extraction, language detection and question answering.
Further documentation can be found in <a
href="https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview">https://docs.microsoft.com/en-us/azure/cognitive-services/language-service/overview</a>.
securityDefinitions:
apim_key:
type: apiKey
description: A subscription key for a Language service resource.
name: Ocp-Apim-Subscription-Key
in: header
security:
- apim_key: []
x-ms-parameterized-host:
hostTemplate: '{Endpoint}/language'
useSchemePrefix: false
parameters:
- $ref: common.json#/parameters/Endpoint
paths:
/authoring/analyze-text/projects:
get:
description: Lists the existing projects.
operationId: 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}/: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
- $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: 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}/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}/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}/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}/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}/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/languages:
get:
description: Lists the supported languages.
operationId: microsoftAzureTextanalysisauthoringGetsupportedlanguages
produces:
- application/json
parameters:
- $ref: common.json#/parameters/TopParameter
- $ref: common.json#/parameters/SkipParameter
- $ref: common.json#/parameters/MaxPageSizeParameter
- $ref: common.json#/parameters/ApiVersionParameter
responses:
'200':
description: The list of supported languages.
schema:
$ref: '#/definitions/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/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
# --- truncated at 32 KB (79 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-azure/refs/heads/main/openapi/microsoft-cognitive-language-service-text-analysis-authoring-openapi-original.yml