AnalyzeSentimentAction Class

  • Reference

Definition

Namespace:
Azure.AI.TextAnalytics
Assembly:
Azure.AI.TextAnalytics.dll
Package:
Azure.AI.TextAnalytics v5.3.0
Source:
AnalyzeSentimentAction.cs

Configurations that allow callers to specify details about how to execute an Analyze Sentiment action in a set of documents. For example, execute opinion mining, set model version, and more.

public class AnalyzeSentimentAction
type AnalyzeSentimentAction = class
Public Class AnalyzeSentimentAction
Inheritance
Object
AnalyzeSentimentAction

Constructors

AnalyzeSentimentAction()

Initializes a new instance of the AnalyzeSentimentAction class which allows callers to specify details about how to execute an Analyze Sentiment action in a set of documents. For example, execute opinion mining, set model version, and more.
AnalyzeSentimentAction(AnalyzeSentimentOptions)

Initializes a new instance of the AnalyzeSentimentAction class based on the values of a AnalyzeSentimentOptions. It sets the ModelVersion, the DisableServiceLogs, and the IncludeOpinionMining properties.

Properties

ActionName

Gets or sets a name for this action. If not provided, the service will generate one.
DisableServiceLogs

The default value of this property is 'false'. This means, the Language service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this property to true, disables input logging and may limit our ability to investigate 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.

IncludeOpinionMining

Whether to mine the opinion of a sentence and conduct more granular analysis around the targets of a product or service (also known as Aspect-Based sentiment analysis). If set to true, the returned Opinions will contain the result of this analysis.
ModelVersion

Gets or sets a value that, if set, indicates the version of the text analytics model that will be used to generate the result. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/language-service/concepts/model-lifecycle#available-versions.

Applies to