Azure AI Services: Text Analytics
The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be…
AI & machine learning#openapi#cloud
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 Text Analytics API is a suite of natural language processing (NLP) services 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 and language detection. Functionality for analysis of text specific to the healthcare domain and personal information are also available in the API. Further documentation can be found in https://docs.microsoft.com/en-us/azure/cognitive-services/text-analytics/overview
Endpoints 11
- POSTSubmit analysis job
/analyzeSubmit a collection of text documents for analysis. Specify one or more unique tasks to be executed. - GETGet analysis status and results
/analyze/jobs/:jobId?showStats=true&$top=20&$skip=0Get the status of an analysis job. A job may consist of one or more tasks. Once all tasks are completed, the job will transition to the completed state and… - GETGet healthcare analysis job status and results
/entities/health/jobs/:jobId?$top=20&$skip=0&showStats=trueGet details of the healthcare prediction job specified by the jobId. - DELETECancel healthcare prediction job
/entities/health/jobs/:jobIdCancel healthcare prediction job. - POSTSubmit healthcare analysis job
/entities/health/jobs?model-version=string&stringIndexType=TextElement_v8&loggingOptOut=trueStart a healthcare analysis job to recognize healthcare related entities (drugs, conditions, symptoms, etc) and their relations. - POSTNamed Entity Recognition
/entities/recognition/general?model-version=string&showStats=true&loggingOptOut=true&stringIndexType=TextElement_v8The API returns a list of general named entities in a given document. For the list of supported entity types, check <a href="https://aka.ms/taner">Supported… - POSTEntities containing personal information
/entities/recognition/pii?model-version=string&showStats=true&loggingOptOut=true&domain=string&stringIndexType=TextElement_v8&piiCategories=ABARoutingNumberThe API returns a list of entities with personal information (\"SSN\", \"Bank Account\" etc) in the document. For the list of supported entity types, check <a… - POSTLinked entities from a well known knowledge base
/entities/linking?model-version=string&showStats=true&loggingOptOut=true&stringIndexType=TextElement_v8The API returns a list of recognized entities with links to a well known knowledge base. See the <a href="https://aka.ms/talangs">Supported languages in Text… - POSTKey Phrases
/keyPhrases?model-version=string&showStats=true&loggingOptOut=trueThe API returns a list of strings denoting the key phrases in the input text. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics… - POSTDetect Language
/languages?model-version=string&showStats=true&loggingOptOut=trueThe API returns the detected language and a numeric score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true. See… - POSTSentiment
/sentiment?model-version=string&showStats=true&loggingOptOut=true&opinionMining=true&stringIndexType=TextElement_v8The API returns a detailed sentiment analysis for the input text. The analysis is done in multiple levels of granularity, start from the a document level,…
API details
- Authentication
- An API key in the Ocp-Apim-Subscription-Key header
- Operations
- 11 operations on 10 pathsPOST 8GET 2DELETE 1
- Description format
- Swagger 2.0, API version
v3.1 - Links
- OpenAPI document · Support
How to test the Azure AI Services: Text Analytics in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Services: Text Analytics collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Submit analysis job” (POST /analyze), 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: Text Analytics?
The Text Analytics API is a suite of natural language processing (NLP) services built with best-in-class Microsoft machine learning algorithms. The API can be… It is listed under AI & machine learning and has 11 endpoints.
Who publishes the Azure AI Services: Text Analytics?
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: Text Analytics?
With an API key in the Ocp-Apim-Subscription-Key header.
How many endpoints does the Azure AI Services: Text Analytics have?
11 operations on 10 paths (8 POST, 2 GET, 1 DELETE).
Is forking the Azure AI Services: Text Analytics free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.