Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AnalyzeSentimentSuccessResult

Package version

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.

Hierarchy

Index

Properties

confidenceScores

confidenceScores: SentimentConfidenceScores

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

Optional error

error: undefined

Discriminant to determine if that this is an error result.

id

id: string

Unique, non-empty document identifier.

sentences

sentences: SentenceSentiment[]

The predicted sentiment for each sentence in the corresponding document.

sentiment

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

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

Generated using TypeDoc