Text Analytics

Microsoft Cognitive Services Text Analytics detects language, sentiment and more of the text you provide.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure China regions
Power Automate Standard All Power Automate regions except the following:
     -   China Cloud operated by 21Vianet
Power Apps Standard All Power Apps regions except the following:
     -   China Cloud operated by 21Vianet
Contact
Name Microsoft
URL https://gallery.cortanaanalytics.com/MachineLearningAPI/Text-Analytics-2
Email mlapi@microsoft.com
Connector Metadata
Publisher Microsoft
Website https://azure.microsoft.com/services/cognitive-services/text-analytics/

To use this integration, you will need a Cognitive Service resource in the Azure portal. You will get an endpoint and a key for authenticating your applications. To make a connection, provide the Account key, site URL and select Create connection. For operation costs on your connection, learn more here.

You're now ready to start using this integration.

Creating a connection

To connect your account, you will need the following information:

Name Type Description
Account Key securestring

Cognitive Services Account Key

Site URL string

Root site url (Example: https://westus.api.cognitive.microsoft.com). If not specified, site url will be defaulted to https://westus.api.cognitive.microsoft.com.

Throttling Limits

Name Calls Renewal Period
API calls per connection120060 seconds

Actions

Detect Entities (V2)

Returns a list of known entities and general named entities ("Person", "Location", "Organization" etc) in a given document.

Detect Language

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. A total of 120 languages are supported.

Detect Language (V2)

Returns the detected language and a numeric score between 0 and 1 for each document. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.

Detect Language [DEPRECATED]

This action has been deprecated. Please use Detect Language (V2) instead.

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. A total of 120 languages are supported.

Detect Sentiment

Returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment.

Detect Sentiment (V2)

Returns a numeric score between 0 and 1 for each document. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment.

Detect Sentiment [DEPRECATED]

This action has been deprecated. Please use Detect Sentiment (V2) instead.

Returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. Currently, the following languages are supported: English, Spanish, French, Portuguese.

Entities

Returns a list of known entities and general named entities ("Person", "Location", "Organization" etc) in a given document.

Key Phrases

Returns a list of strings denoting the key talking points in the input text.

Key Phrases (V2)

Returns a list of strings denoting the key talking points in the input text for each document.

Key Phrases [DEPRECATED]

This action has been deprecated. Please use Key Phrases (V2) instead.

Returns a list of strings denoting the key talking points in the input text. Currently, the following languages are supported: English, German, Spanish and Japanese.

Detect Entities (V2)

Returns a list of known entities and general named entities ("Person", "Location", "Organization" etc) in a given document.

Parameters

Name Key Required Type Description
Id
id True string

Unique, non-empty document identifier.

Text
text True string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Detect Language

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. A total of 120 languages are supported.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Returns

Detect Language (V2)

Returns the detected language and a numeric score between 0 and 1 for each document. Scores close to 1 indicate 100% certainty that the identified language is true. A total of 120 languages are supported.

Parameters

Name Key Required Type Description
Id
id True string

Unique, non-empty document identifier.

Text
text True string

The text to analyze.

Returns

Detect Language [DEPRECATED]

This action has been deprecated. Please use Detect Language (V2) instead.

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. A total of 120 languages are supported.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Number of languages
numberOfLanguagesToDetect integer

The number of languages to detect. Set to 1 by default.

Returns

Detect Sentiment

Returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Detect Sentiment (V2)

Returns a numeric score between 0 and 1 for each document. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment.

Parameters

Name Key Required Type Description
Id
id True string

Unique, non-empty document identifier.

Text
text True string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Detect Sentiment [DEPRECATED]

This action has been deprecated. Please use Detect Sentiment (V2) instead.

Returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment. Currently, the following languages are supported: English, Spanish, French, Portuguese.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Entities

Returns a list of known entities and general named entities ("Person", "Location", "Organization" etc) in a given document.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Key Phrases

Returns a list of strings denoting the key talking points in the input text.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Key Phrases (V2)

Returns a list of strings denoting the key talking points in the input text for each document.

Parameters

Name Key Required Type Description
Id
id True string

Unique, non-empty document identifier.

Text
text True string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Key Phrases [DEPRECATED]

This action has been deprecated. Please use Key Phrases (V2) instead.

Returns a list of strings denoting the key talking points in the input text. Currently, the following languages are supported: English, German, Spanish and Japanese.

Parameters

Name Key Required Type Description
Text
text string

The text to analyze.

Language
language string

This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc.,

Returns

Definitions

KeyPhraseResults

Name Path Type Description
documents
documents array of KeyPhraseResult

EntitiesResults

Name Path Type Description
documents
documents array of EntitiesResult

LanguageResults

Name Path Type Description
documents
documents array of LanguageResult

SentimentResults

Name Path Type Description
documents
documents array of SentimentResult

KeyPhraseResult

Name Path Type Description
Key Phrases
keyPhrases array of string

A list of representative words or phrases. The number of key phrases returned is proportional to the number of words in the input document.

Id
id string

The unique document identifier.

EntitiesResult

Name Path Type Description
Entities
entities array of object

A list of disambiguated entities with links to more information on the web (Wikipedia and Bing).

Name
entities.name string

Name of the entity.

Matches
entities.matches array of object

A list of matches for the entity.

items
entities.matches object
Wikipedia Language
entities.wikipediaLanguage string

Wikipedia language of the entity.

Wikipedia Id
entities.wikipediaId string

Wikipedia Id of the entity.

Wikipedia Url
entities.wikipediaUrl string

Wikipedia url of the entity.

Bing Id
entities.bingId string

Bing Id of the entity.

Type
entities.type string

Type of the entity.

Subtype
entities.subType string

Subtype of the entity.

Id
id string

The unique document identifier.

LanguageResult

Name Path Type Description
Id
id string

The unique document identifier.

detectedLanguages
detectedLanguages array of DetectedLanguageV2

A list of extracted languages.

SentimentResult

Name Path Type Description
Score
score double

A decimal number between 0 and 1 denoting the sentiment of the document. A score above 0.7 usually refers to a positive document while a score below 0.3 normally has a negative connotation. Mid values refer to neutral text.

Id
id string

The unique document identifier.

DetectedLanguageV2

Name Path Type Description
Name
name string

The long name of a detected language (e.g. English, French).

Language Code
iso6391Name string

A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).

Score
score double

A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true.