AnalyzeSentimentAction Class

AnalyzeSentimentAction encapsulates the parameters for starting a long-running Sentiment Analysis operation.

If you just want to analyze sentiment in a list of documents, and not perform multiple long running actions on the input of documents, call method analyze_sentiment instead of interfacing with this model.

Inheritance

azure.ai.textanalytics._models.DictMixin

AnalyzeSentimentAction

Constructor

AnalyzeSentimentAction(**kwargs)

Parameters

model_version

str

The model version to use for the analysis.

show_opinion_mining

bool

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 mined_opinions containing the result of this analysis.

string_index_type

str

Specifies the method used to interpret string offsets. UnicodeCodePoint, the Python encoding, is the default. To override the Python default, you can also pass in Utf16CodePoint or TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets

disable_service_logs

bool

If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

Variables

model_version

str

The model version to use for the analysis.

show_opinion_mining

bool

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 mined_opinions containing the result of this analysis.

string_index_type

str

Specifies the method used to interpret string offsets. UnicodeCodePoint, the Python encoding, is the default. To override the Python default, you can also pass in Utf16CodePoint or TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets

disable_service_logs

bool

If set to true, you opt-out of having your text input logged on the service side for troubleshooting. By default, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Setting this parameter to true, disables input logging and may limit our ability to remediate issues that occur. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.