Microsoft Azure

Azure AI Services: Analyzetext Authoring

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…

AI & machine learning#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The language service API is a suite of natural language processing (NLP) skills built with best-in-class Microsoft machine learning algorithms. The API can be used to analyze unstructured text for tasks such as sentiment analysis, key phrase extraction, language detection and question answering. Further documentation can be found in https://learn.microsoft.com/en-us/azure/cognitive-services/language-service/overview .

Endpoints 29

  • GETTextAnalysisAuthoringListProjects/authoring/analyze-text/projects?api-version=string&top=0&skip=0&maxpagesize=0Lists the existing projects.
  • GETTextAuthoringProject_GetProject/authoring/analyze-text/projects/:projectName?api-version=stringGets the details of a project.
  • DELETETextAuthoringProject_DeleteProject/authoring/analyze-text/projects/:projectName?api-version=stringDeletes a project.
  • PATCHTextAuthoringProject_CreateProject/authoring/analyze-text/projects/:projectName?api-version=stringThe most basic operation that applies to a resource.
  • POSTTextAuthoringProject_Export/authoring/analyze-text/projects/:projectName/:export?api-version=string&stringIndexType=Utf16CodeUnit&assetKind=string&trainedModelLabel=stringTriggers a job to export a project's data.
  • POSTTextAuthoringProject_Import/authoring/analyze-text/projects/:projectName/:import?api-version=stringTriggers a job to import a project. If a project with the same name already exists, the data of that project is replaced.
  • POSTTextAuthoringProject_Train/authoring/analyze-text/projects/:projectName/:train?api-version=stringTriggers a training job for a project.
  • GETTextAnalysisAuthoringListDeployments/authoring/analyze-text/projects/:projectName/deployments?api-version=string&top=0&skip=0&maxpagesize=0Lists the deployments belonging to a project.
  • GETTextAuthoringDeployment_GetDeployment/authoring/analyze-text/projects/:projectName/deployments/:deploymentName?api-version=stringGets the details of a deployment.
  • PUTTextAuthoringDeployment_DeployProject/authoring/analyze-text/projects/:projectName/deployments/:deploymentName?api-version=stringCreates a new deployment or replaces an existing one.
  • DELETETextAuthoringDeployment_DeleteDeployment/authoring/analyze-text/projects/:projectName/deployments/:deploymentName?api-version=stringDeletes a project deployment.
  • GETTextAuthoringDeployment_GetDeploymentStatus/authoring/analyze-text/projects/:projectName/deployments/:deploymentName/jobs/:jobId?api-version=stringGets the status of an existing deployment job.
  • POSTTextAuthoringProject_SwapDeployments/authoring/analyze-text/projects/:projectName/deployments/:swap?api-version=stringSwaps two existing deployments with each other.
  • GETTextAuthoringProject_GetSwapDeploymentsStatus/authoring/analyze-text/projects/:projectName/deployments/swap/jobs/:jobId?api-version=stringGets the status of an existing swap deployment job.
  • GETTextAuthoringProject_GetExportStatus/authoring/analyze-text/projects/:projectName/export/jobs/:jobId?api-version=stringGets the status of an export job. Once job completes, returns the project metadata, and assets.
  • GETTextAuthoringProject_GetImportStatus/authoring/analyze-text/projects/:projectName/import/jobs/:jobId?api-version=stringGets the status for an import.
  • GETTextAnalysisAuthoringListTrainedModels/authoring/analyze-text/projects/:projectName/models?api-version=string&top=0&skip=0&maxpagesize=0Lists the trained models belonging to a project.
  • GETTextAuthoringTrainedModel_GetTrainedModel/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel?api-version=stringGets the details of a trained model.
  • DELETETextAuthoringTrainedModel_DeleteTrainedModel/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel?api-version=stringDeletes an existing trained model.
  • POSTTextAuthoringTrainedModel_LoadSnapshot/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/:load-snapshot?api-version=stringLong-running operation.
  • GETTextAuthoringTrainedModel_GetModelEvaluationResults/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/evaluation/result?api-version=string&top=0&skip=0&maxpagesize=0&stringIndexType=Utf16CodeUnitGets the detailed results of the evaluation for a trained model. This includes the raw inference results for the data included in the evaluation process.
  • GETTextAuthoringTrainedModel_GetModelEvaluationSummary/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/evaluation/summary-result?api-version=stringGets the evaluation summary of a trained model. The summary includes high level performance measurements of the model e.g., F1, Precision, Recall, etc.
  • GETTextAuthoringTrainedModel_GetLoadSnapshotStatus/authoring/analyze-text/projects/:projectName/models/:trainedModelLabel/load-snapshot/jobs/:jobId?api-version=stringGets the status for loading a snapshot.
  • GETTextAnalysisAuthoringListTrainingJobs/authoring/analyze-text/projects/:projectName/train/jobs?api-version=string&top=0&skip=0&maxpagesize=0Lists the non-expired training jobs created for a project.
  • GETTextAuthoringProject_GetTrainingStatus/authoring/analyze-text/projects/:projectName/train/jobs/:jobId?api-version=stringGets the status for a training job.
  • POSTTextAuthoringProject_CancelTrainingJob/authoring/analyze-text/projects/:projectName/train/jobs/:jobId/:cancel?api-version=stringTriggers a cancellation for a running training job.
  • GETTextAuthoringProject_GetProjectDeletionStatus/authoring/analyze-text/projects/global/deletion-jobs/:jobId?api-version=stringGets the status for a project deletion job.
  • GETTextAnalysisAuthoringGetSupportedLanguages/authoring/analyze-text/projects/global/languages?api-version=string&projectKind=CustomSingleLabelClassification&top=0&skip=0&maxpagesize=0Lists the supported languages.
  • GETTextAnalysisAuthoringListTrainingConfigVersions/authoring/analyze-text/projects/global/training-config-versions?api-version=string&projectKind=CustomSingleLabelClassification&top=0&skip=0&maxpagesize=0Lists the support training config version for a given project type.

API details

Authentication
An API key in the Ocp-Apim-Subscription-Key header
OAuth 2.0 (authorization code flow) with 1 scope
Operations
29 operations on 24 pathsGET 18POST 6DELETE 3PUT 1PATCH 1
Response formats
application/json
Description format
Swagger 2.0, API version 2023-04-01

How to test the Azure AI Services: Analyzetext Authoring in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Services: Analyzetext Authoring collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the Ocp-Apim-Subscription-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “TextAnalysisAuthoringListProjects” (GET /authoring/analyze-text/projects?api-version=string&top=0&skip=0&maxpagesize=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure AI Services: Analyzetext Authoring?

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… It is listed under AI & machine learning and has 29 endpoints.

Who publishes the Azure AI Services: Analyzetext Authoring?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure AI Services: Analyzetext Authoring?

It accepts 2 methods: an API key in the Ocp-Apim-Subscription-Key header; OAuth 2.0 (authorization code flow) with 1 scope.

How many endpoints does the Azure AI Services: Analyzetext Authoring have?

29 operations on 24 paths (18 GET, 6 POST, 3 DELETE, 1 PUT, 1 PATCH).

Is forking the Azure AI Services: Analyzetext Authoring free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.