Compartir a través de

AnalyzeSentimentAction interface

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

Options for an analyze sentiment action.

Extends
TextAnalyticsAction

Properties

disableServiceLogs

If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur.
includeOpinionMining

Whether to mine the opinions of a sentence and conduct more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, the returned SentenceSentiment objects will have property opinions containing the result of this analysis. More information about the feature can be found here: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis?tabs=version-3-1#opinion-mining
stringIndexType

Specifies the measurement unit used to calculate the offset and length properties. Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". The default is the JavaScript's default which is "Utf16CodeUnit".

Inherited Properties

actionName

The preferred name for this action.
modelVersion

The version of the text analytics model used by this operation on this batch of input documents.

Property Details

disableServiceLogs

If set to true, you opt-out of having your text input logged for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur.

disableServiceLogs?: boolean

Property Value

boolean

includeOpinionMining

Whether to mine the opinions of a sentence and conduct more granular analysis around the aspects of a product or service (also known as aspect-based sentiment analysis). If set to true, the returned SentenceSentiment objects will have property opinions containing the result of this analysis. More information about the feature can be found here: https://docs.microsoft.com/azure/cognitive-services/text-analytics/how-tos/text-analytics-how-to-sentiment-analysis?tabs=version-3-1#opinion-mining

includeOpinionMining?: boolean

Property Value

boolean

stringIndexType

Specifies the measurement unit used to calculate the offset and length properties. Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". The default is the JavaScript's default which is "Utf16CodeUnit".

stringIndexType?: StringIndexType

Property Value

StringIndexType

Inherited Property Details

actionName

The preferred name for this action.

actionName?: string

Property Value

string

Inherited From TextAnalyticsAction.actionName

modelVersion

The version of the text analytics model used by this operation on this batch of input documents.

modelVersion?: string

Property Value

string

Inherited From TextAnalyticsAction.modelVersion