AnalyzeSentimentOptions Class

Definition

Namespace:

Azure.AI.TextAnalytics

Assembly:

Azure.AI.TextAnalytics.dll

Package:

Azure.AI.TextAnalytics v5.3.0

Source:

AnalyzeSentimentOptions.cs

Options that allow callers to specify details about how the operation is run. For example, execute opinion mining, set model version, whether to include statistics, and more.

public class AnalyzeSentimentOptions : Azure.AI.TextAnalytics.TextAnalyticsRequestOptions

type AnalyzeSentimentOptions = class
    inherit TextAnalyticsRequestOptions

Public Class AnalyzeSentimentOptions
Inherits TextAnalyticsRequestOptions

Inheritance

Object

TextAnalyticsRequestOptions

AnalyzeSentimentOptions

Constructors

AnalyzeSentimentOptions()

Initializes a new instance of the AnalyzeSentimentOptions class which allows callers to specify details about how the operation is run. For example, execute opinion mining, set model version, whether to include statistics, and more.

Properties

DisableServiceLogs	The default value of this property is false except for methods like AnalyzeHealthcareEntities and RecognizePiiEntities. This means that 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. (Inherited from TextAnalyticsRequestOptions)
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.
IncludeStatistics	Gets or sets a value that, if set to true, indicates that the service should return document and document batch statistics with the results of the operation. Returns data for batch document methods only. (Inherited from TextAnalyticsRequestOptions)
ModelVersion	Gets or sets a value that, if set, indicates the version of the Language service 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. (Inherited from TextAnalyticsRequestOptions)