Share via

AnalyzeSentimentSuccessResult interface

  • Reference
Package:
@azure/ai-text-analytics

The result of the analyze sentiment operation on a single document, containing the predicted sentiment for each sentence as well as for the full document.

Extends
TextAnalyticsSuccessResult

Properties

confidenceScores

Document level sentiment confidence scores between 0 and 1 for each sentiment class.
sentences

The predicted sentiment for each sentence in the corresponding document.
sentiment

Predicted sentiment for document. Possible values include: 'positive', 'neutral', 'negative', 'mixed'

Inherited Properties

error

Discriminant to determine if that this is an error result.
id

Unique, non-empty document identifier.
statistics

Statistics about the input document and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.
warnings

An array of warning data corresponding to this document.

If no warnings were returned, this array will be empty.

Property Details

confidenceScores

Document level sentiment confidence scores between 0 and 1 for each sentiment class.

confidenceScores: SentimentConfidenceScores

Property Value

SentimentConfidenceScores

sentences

The predicted sentiment for each sentence in the corresponding document.

sentences: SentenceSentiment[]

Property Value

SentenceSentiment[]

sentiment

Predicted sentiment for document. Possible values include: 'positive', 'neutral', 'negative', 'mixed'

sentiment: DocumentSentimentLabel

Property Value

DocumentSentimentLabel

Inherited Property Details

error

Discriminant to determine if that this is an error result.

error?: undefined

Property Value

undefined

Inherited From TextAnalyticsSuccessResult.error

id

Unique, non-empty document identifier.

id: string

Property Value

string

Inherited From TextAnalyticsSuccessResult.id

statistics

Statistics about the input document and how it was processed by the service. This property will have a value when includeStatistics is set to true in the client call.

statistics?: TextDocumentStatistics

Property Value

TextDocumentStatistics

Inherited From TextAnalyticsSuccessResult.statistics

warnings

An array of warning data corresponding to this document.

If no warnings were returned, this array will be empty.

warnings: TextAnalyticsWarning[]

Property Value

TextAnalyticsWarning[]

Inherited From TextAnalyticsSuccessResult.warnings