Text Analytics (Preview)

Text Analytics (Preview)

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

To use this integration, you will need access to a Cognitive Services Text Analytics Account or API Key. To make a connection, provide the account or API key and select Create connection. When using the connection, the operations you do will count towards the quota set on your Cognitive Services key. When that quota is exceeded you may see errors in the connector, or your Cognitive Services account may be charged for additional requests, depending how your account is configured.

You're now ready to start using this integration.

Throttling Limits

Name Calls Renewal Period
API calls per connection 1200 60 seconds

Creating a connection

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

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'.

Actions

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.

Optional Parameters

Text
string
The text to analyze.
Number of languages
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. Currently, the following languages are supported: English, Spanish, French, Portuguese.

Optional Parameters

Text
string
The text to analyze.
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. Currently, the following languages are supported: English, German, Spanish and Japanese.

Optional Parameters

Text
string
The text to analyze.
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

KeyPhraseResult

Id
string
The unique document identifier.
Key Phrases
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.

LanguageResult

Id
string
The unique document identifier.
detectedLanguages
array of DetectedLanguageV2
A list of extracted languages.

DetectedLanguageV2

Language Code
string
A two letter representation of the detected language according to the ISO 639-1 standard (e.g. en, fr).
Name
string
The long name of a detected language (e.g. English, French).
Score
double
A confidence score between 0 and 1. Scores close to 1 indicate 100% certainty that the identified language is true.

SentimentResult

Request ID
string
The unique document identifier.
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.