Connectors Reference

Text Analytics

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

 

Status: Production

Tier: Standard

Version: v2.0

 

Actions:

Name

Summary

KeyPhrasesV3 (MultiLanguageInputs input)

Key Phrases (V2)

DetectLanguageV3 (LanguageInputs input)

Detect Language (V2)

DetectSentimentV3 (MultiLanguageInputs input)

Detect Sentiment (V2)

DetectEntitiesV2 (MultiLanguageInputs input)

Detect Entities (V2)

EntitiesRecognitionGeneralV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

Named Entity Recognition (V3.0)

EntitiesLinkingV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

Entity Linking (V3.0)

KeyPhraseV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

Key Phrases (V3.0)

LanguagesV3 ([Optional]string model-version, [Optional]boolean showStats, LanguageBatchInput input)

Detect Language (V3.0)

SentimentV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

Sentiment (V3.0)

KeyPhrases (MultiLanguageInput input)

Key Phrases

DetectLanguage (LanguageInput input, [advanced][Optional]integer numberOfLanguagesToDetect)

Detect Language

DetectSentiment (MultiLanguageInput input)

Detect Sentiment

KeyPhrasesV2 (MultiLanguageInput input)

Key Phrases

DetectLanguageV2 (LanguageInput input)

Detect Language

DetectSentimentV2 (MultiLanguageInput input)

Detect Sentiment

DetectEntities (MultiLanguageInput input)

Entities

TestConnection ()

Test Connection

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

DetectedLanguage

 

DetectedLanguageV2

 

DocumentEntities

 

DocumentError

 

DocumentKeyPhrases

 

DocumentLanguage

 

DocumentLinkedEntities

 

DocumentSentiment

 

DocumentStatistics

 

EntitiesResult

 

EntitiesResults

 

EntitiesResultV3

 

Entity

 

EntityLinkingResult

 

InnerError

 

KeyPhraseResult

 

KeyPhraseResults

 

KeyPhraseResultV3

 

LanguageBatchInput

 

LanguageInput

 

LanguageInputs

 

LanguageInputV2

 

LanguageInputV3

 

LanguageResult

 

LanguageResults

 

LanguageResultV3

 

LinkedEntity

 

Match

 

MultiLanguageBatchInput

 

MultiLanguageInput

 

MultiLanguageInputs

 

MultiLanguageInputV2

 

MultiLanguageInputV3

 

RequestStatistics

 

SentenceSentiment

 

SentimentConfidenceScorePerLabel

 

SentimentResponse

 

SentimentResult

 

SentimentResults

 

TextAnalyticsError

 

TextAnalyticsWarning

 

 

Actions:

KeyPhrasesV3

Summary: Key Phrases (V2)

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

 

Syntax:

TextAnalytics.KeyPhrasesV3 (MultiLanguageInputs input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInputs

 

 

True

 

Returns:

          Type:KeyPhraseResults

 

DetectLanguageV3

Summary: Detect Language (V2)

Description: 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.

 

Syntax:

TextAnalytics.DetectLanguageV3 (LanguageInputs input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

LanguageInputs

 

 

True

 

Returns:

          Type:LanguageResults

 

DetectSentimentV3

Summary: Detect Sentiment (V2)

Description: 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.

 

Syntax:

TextAnalytics.DetectSentimentV3 (MultiLanguageInputs input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInputs

 

 

True

 

Returns:

          Type:SentimentResults

 

DetectEntitiesV2

Summary: Detect Entities (V2)

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

 

Syntax:

TextAnalytics.DetectEntitiesV2 (MultiLanguageInputs input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInputs

 

 

True

 

Returns:

          Type:EntitiesResults

 

EntitiesRecognitionGeneralV3

Summary: Named Entity Recognition (V3.0)

Description: The 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 Entity Types in Text Analytics API</a>. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.

 

Syntax:

TextAnalytics.EntitiesRecognitionGeneralV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

model-version

string

(Model Version)

(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

False

showStats

boolean

(Show Statistics)

(Optional) if set to true, response will contain input and document level statistics.

False

input

MultiLanguageBatchInput

 

Contains a set of input documents to be analyzed by the service.

True

 

Returns:

          Type:EntitiesResultV3

 

EntitiesLinkingV3

Summary: Entity Linking (V3.0)

Description: The 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 Analytics API</a> for the list of enabled languages.

 

Syntax:

TextAnalytics.EntitiesLinkingV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

model-version

string

(Model Version)

(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

False

showStats

boolean

(Show Statistics)

(Optional) if set to true, response will contain input and document level statistics.

False

input

MultiLanguageBatchInput

 

Contains a set of input documents to be analyzed by the service.

True

 

Returns:

          Type:EntityLinkingResult

 

KeyPhraseV3

Summary: Key Phrases (V3.0)

Description: The 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 API</a> for the list of enabled languages.

 

Syntax:

TextAnalytics.KeyPhraseV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

model-version

string

(Model Version)

(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

False

showStats

boolean

(Show Statistics)

(Optional) if set to true, response will contain input and document level statistics.

False

input

MultiLanguageBatchInput

 

Contains a set of input documents to be analyzed by the service.

True

 

Returns:

          Type:KeyPhraseResultV3

 

LanguagesV3

Summary: Detect Language (V3.0)

Description: The 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 the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.

 

Syntax:

TextAnalytics.LanguagesV3 ([Optional]string model-version, [Optional]boolean showStats, LanguageBatchInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

model-version

string

(Model Version)

(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

False

showStats

boolean

(Show Statistics)

(Optional) if set to true, response will contain input and document level statistics.

False

input

LanguageBatchInput

 

 

True

 

Returns:

          Type:LanguageResultV3

 

SentimentV3

Summary: Sentiment (V3.0)

Description: The API returns a sentiment prediction, as well as sentiment scores for each sentiment class (Positive, Negative, and Neutral) for the document and each sentence within it. See the <a href="https://aka.ms/talangs">Supported languages in Text Analytics API</a> for the list of enabled languages.

 

Syntax:

TextAnalytics.SentimentV3 ([Optional]string model-version, [Optional]boolean showStats, MultiLanguageBatchInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

model-version

string

(Model Version)

(Optional) This value indicates which model will be used for scoring. If a model-version is not specified, the API should default to the latest, non-preview version.

False

showStats

boolean

(Show Statistics)

(Optional) if set to true, response will contain input and document level statistics.

False

input

MultiLanguageBatchInput

 

Contains a set of input documents to be analyzed by the service.

True

 

Returns:

          Type:SentimentResponse

 

KeyPhrases

Summary: Key Phrases

Description: 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.

 

Syntax:

TextAnalytics.KeyPhrases (MultiLanguageInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInput

 

 

True

 

Returns:

          Type:KeyPhraseResult

 

DetectLanguage

Summary: Detect Language

Description: 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.

 

Syntax:

TextAnalytics.DetectLanguage (LanguageInput input, [advanced][Optional]integer numberOfLanguagesToDetect)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

LanguageInput

 

 

True

numberOfLanguagesToDetect

integer(int32)

(Number of languages)

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

False

 

Returns:

          Type:LanguageResult

 

DetectSentiment

Summary: Detect Sentiment

Description: 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.

 

Syntax:

TextAnalytics.DetectSentiment (MultiLanguageInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInput

 

 

True

 

Returns:

          Type:SentimentResult

 

KeyPhrasesV2

Summary: Key Phrases

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

 

Syntax:

TextAnalytics.KeyPhrasesV2 (MultiLanguageInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInput

 

 

True

 

Returns:

          Type:KeyPhraseResult

 

DetectLanguageV2

Summary: Detect Language

Description: 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.

 

Syntax:

TextAnalytics.DetectLanguageV2 (LanguageInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

LanguageInput

 

 

True

 

Returns:

          Type:LanguageResult

 

DetectSentimentV2

Summary: Detect Sentiment

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

 

Syntax:

TextAnalytics.DetectSentimentV2 (MultiLanguageInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInput

 

 

True

 

Returns:

          Type:SentimentResult

 

DetectEntities

Summary: Entities

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

 

Syntax:

TextAnalytics.DetectEntities (MultiLanguageInput input)

 

Parameters:

Name

Type

Summary

Required

Related Action

input

MultiLanguageInput

 

 

True

 

Returns:

          Type:EntitiesResult

 

TestConnection

Summary: Test Connection

Description: Tests the connection

 

Syntax:

TextAnalytics.TestConnection ()

 

Returns:

 


 

DetectedLanguage

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

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

iso6391Name

string

 

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

confidenceScore

number(double)

 

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


 

DetectedLanguageV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

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

iso6391Name

string

Language Code

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

score

number(double)

Score

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


 

DocumentEntities

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique, non-empty document identifier.

entities

array of (Entity)

 

Recognized entities in the document.

warnings

array of (TextAnalyticsWarning)

 

Warnings encountered while processing document.

statistics

DocumentStatistics

 

if showStats=true was specified in the request this field will contain information about the document payload.


 

DocumentError

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Document Id.

error

TextAnalyticsError

 

 


 

DocumentKeyPhrases

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique, non-empty document identifier.

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.

warnings

array of (TextAnalyticsWarning)

 

Warnings encountered while processing document.

statistics

DocumentStatistics

 

if showStats=true was specified in the request this field will contain information about the document payload.


 

DocumentLanguage

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique, non-empty document identifier.

detectedLanguage

DetectedLanguage

 

 

warnings

array of (TextAnalyticsWarning)

 

Warnings encountered while processing document.

statistics

DocumentStatistics

 

if showStats=true was specified in the request this field will contain information about the document payload.


 

DocumentLinkedEntities

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique, non-empty document identifier.

entities

array of (LinkedEntity)

 

Recognized well-known entities in the document.

warnings

array of (TextAnalyticsWarning)

 

Warnings encountered while processing document.

statistics

DocumentStatistics

 

if showStats=true was specified in the request this field will contain information about the document payload.


 

DocumentSentiment

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique, non-empty document identifier.

sentiment

string

 

Predicted sentiment for document (Negative, Neutral, Positive, or Mixed).  Values: [positive, neutral, negative, mixed]

statistics

DocumentStatistics

 

if showStats=true was specified in the request this field will contain information about the document payload.

confidenceScores

SentimentConfidenceScorePerLabel

 

Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.

sentences

array of (SentenceSentiment)

 

Sentence level sentiment analysis.

warnings

array of (TextAnalyticsWarning)

 

Warnings encountered while processing document.


 

DocumentStatistics

Summary:

Description: if showStats=true was specified in the request this field will contain information about the document payload.

 

          Properties:

Name

Type

Summary

charactersCount

integer(int32)

 

Number of text elements recognized in the document.

transactionsCount

integer(int32)

 

Number of transactions for the document.


 

EntitiesResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

entities

array of (EntitiesItem)

Entities

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

id

string

Id

The unique document identifier.

 

EntitiesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

Name

Name of the entity.

matches

array of (MatchesItem)

Matches

A list of matches for the entity.

wikipediaLanguage

string

Wikipedia Language

Wikipedia language of the entity.

wikipediaId

string

Wikipedia Id

Wikipedia Id of the entity.

wikipediaUrl

string

Wikipedia Url

Wikipedia url of the entity.

bingId

string

Bing Id

Bing Id of the entity.

type

string

Type

Type of the entity.

subType

string

Subtype

Subtype of the entity.

 

MatchesItem

Summary:

Description:

 

          Properties:

Name

Type

Summary

 


 

EntitiesResults

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (EntitiesResult)

 

 


 

EntitiesResultV3

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (DocumentEntities)

 

Response by document

errors

array of (DocumentError)

 

Errors by document id.

statistics

RequestStatistics

 

if showStats=true was specified in the request this field will contain information about the request payload.

modelVersion

string

 

This field indicates which model is used for scoring.


 

Entity

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

Entity text as appears in the request.

category

string

 

Entity type, such as Person/Location/Org/SSN etc

subcategory

string

 

Entity sub type, such as Age/Year/TimeRange etc

offset

integer(int32)

 

Start position (in Unicode characters) for the entity text.

length

integer(int32)

 

Length (in Unicode characters) for the entity text.

confidenceScore

number(double)

 

Confidence score between 0 and 1 of the extracted entity.


 

EntityLinkingResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (DocumentLinkedEntities)

 

Response by document

errors

array of (DocumentError)

 

Errors by document id.

statistics

RequestStatistics

 

if showStats=true was specified in the request this field will contain information about the request payload.

modelVersion

string

 

This field indicates which model is used for scoring.


 

InnerError

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

Error code.  Values: [invalidParameterValue, invalidRequestBodyFormat, emptyRequest, missingInputRecords, invalidDocument, modelVersionIncorrect, invalidDocumentBatch, unsupportedLanguageCode, invalidCountryHint]

message

string

 

Error message.

details

Details

 

Error details.

target

string

 

Error target.

innererror

InnerError

 

 

 

Details

Summary:

Description: Error details.

 

          Properties:

Name

Type

Summary

 


 

KeyPhraseResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

keyPhrases

array of (string)

Key Phrases

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

string

Id

The unique document identifier.


 

KeyPhraseResults

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (KeyPhraseResult)

 

 


 

KeyPhraseResultV3

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (DocumentKeyPhrases)

 

Response by document

errors

array of (DocumentError)

 

Errors by document id.

statistics

RequestStatistics

 

if showStats=true was specified in the request this field will contain information about the request payload.

modelVersion

string

 

This field indicates which model is used for scoring.


 

LanguageBatchInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (LanguageInputV3)

 

 


 

LanguageInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Text

The text to analyze.


 

LanguageInputs

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (LanguageInputV2)

 

 


 

LanguageInputV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique, non-empty document identifier.

text

string

Text

The text to analyze.


 

LanguageInputV3

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

 

Unique, non-empty document identifier.

text

string

 

 

countryHint

string

 

 


 

LanguageResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

The unique document identifier.

detectedLanguages

array of (DetectedLanguageV2)

 

A list of extracted languages.


 

LanguageResults

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (LanguageResult)

 

 


 

LanguageResultV3

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (DocumentLanguage)

 

Response by document

errors

array of (DocumentError)

 

Errors by document id.

statistics

RequestStatistics

 

if showStats=true was specified in the request this field will contain information about the request payload.

modelVersion

string

 

This field indicates which model is used for scoring.


 

LinkedEntity

Summary:

Description:

 

          Properties:

Name

Type

Summary

name

string

 

Entity Linking formal name.

matches

array of (Match)

 

List of instances this entity appears in the text.

language

string

 

Language used in the data source.

id

string

 

Unique identifier of the recognized entity from the data source.

url

string

 

URL for the entity's page from the data source.

dataSource

string

 

Data source used to extract entity linking, such as Wiki/Bing etc.


 

Match

Summary:

Description:

 

          Properties:

Name

Type

Summary

confidenceScore

number(double)

 

If a well-known item is recognized, a decimal number denoting the confidence level between 0 and 1 will be returned.

text

string

 

Entity text as appears in the request.

offset

integer(int32)

 

Start position (in Unicode characters) for the entity match text.

length

integer(int32)

 

Length (in Unicode characters) for the entity match text.


 

MultiLanguageBatchInput

Summary:

Description: Contains a set of input documents to be analyzed by the service.

 

          Properties:

Name

Type

Summary

documents

array of (MultiLanguageInputV3)

 

The set of documents to process as part of this batch.


 

MultiLanguageInput

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

Text

The text to analyze.

language

string

Language

This is the 2 letter ISO 639-1 representation of a language.             For example, use "en" for English; "es" for Spanish etc.,  Values: [da, de, en, es, fi, fr, it, ja, nl, no, pl, pt, ru, sv]


 

MultiLanguageInputs

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (MultiLanguageInputV2)

 

 


 

MultiLanguageInputV2

Summary:

Description:

 

          Properties:

Name

Type

Summary

id

string

Id

Unique, non-empty document identifier.

text

string

Text

The text to analyze.

language

string

Language

This is the 2 letter ISO 639-1 representation of a language.             For example, use "en" for English; "es" for Spanish etc.,  Values: [da, de, en, es, fi, fr, it, ja, nl, no, pl, pt, ru, sv]


 

MultiLanguageInputV3

Summary:

Description: Contains an input document to be analyzed by the service.

 

          Properties:

Name

Type

Summary

id

string

 

A unique, non-empty document identifier.

text

string

 

The input text to process.

language

string

 

(Optional) This is the 2 letter ISO 639-1 representation of a language. For example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as default.


 

RequestStatistics

Summary:

Description: if showStats=true was specified in the request this field will contain information about the request payload.

 

          Properties:

Name

Type

Summary

documentsCount

integer(int32)

 

Number of documents submitted in the request.

validDocumentsCount

integer(int32)

 

Number of valid documents. This excludes empty, over-size limit or non-supported languages documents.

erroneousDocumentsCount

integer(int32)

 

Number of invalid documents. This includes empty, over-size limit or non-supported languages documents.

transactionsCount

integer(int64)

 

Number of transactions for the request.


 

SentenceSentiment

Summary:

Description:

 

          Properties:

Name

Type

Summary

text

string

 

The sentence text.

sentiment

string

 

The predicted Sentiment for the sentence.  Values: [positive, neutral, negative]

confidenceScores

SentimentConfidenceScorePerLabel

 

Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.

offset

integer(int32)

 

The sentence offset from the start of the document.

length

integer(int32)

 

The length of the sentence by Unicode standard.


 

SentimentConfidenceScorePerLabel

Summary:

Description: Represents the confidence scores between 0 and 1 across all sentiment classes: positive, neutral, negative.

 

          Properties:

Name

Type

Summary

positive

number(double)

 

 

neutral

number(double)

 

 

negative

number(double)

 

 


 

SentimentResponse

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (DocumentSentiment)

 

Sentiment analysis per document.

errors

array of (DocumentError)

 

Errors by document id.

statistics

RequestStatistics

 

if showStats=true was specified in the request this field will contain information about the request payload.

modelVersion

string

 

This field indicates which model is used for scoring.


 

SentimentResult

Summary:

Description:

 

          Properties:

Name

Type

Summary

score

number(double)

Score

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

string

Id

The unique document identifier.


 

SentimentResults

Summary:

Description:

 

          Properties:

Name

Type

Summary

documents

array of (SentimentResult)

 

 


 

TextAnalyticsError

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

Error code.  Values: [invalidRequest, invalidArgument, internalServerError, serviceUnavailable]

message

string

 

Error message.

target

string

 

Error target.

innererror

InnerError

 

 

details

array of (TextAnalyticsError)

 

Details about specific errors that led to this reported error.


 

TextAnalyticsWarning

Summary:

Description:

 

          Properties:

Name

Type

Summary

code

string

 

Error code.  Values: [LongWordsInDocument, DocumentTruncated]

message

string

 

Warning message.

targetRef

string

 

A JSON pointer reference indicating the target object.