Class AnalyzeSentimentOptions
- java.lang.Object
-
- com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
-
- com.azure.ai.textanalytics.models.AnalyzeSentimentOptions
-
public final class AnalyzeSentimentOptions extends TextAnalyticsRequestOptions
TheAnalyzeSentimentOptions
model.
-
-
Constructor Summary
Constructors Constructor Description AnalyzeSentimentOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isIncludeOpinionMining()
Gets the value ofincludeOpinionMining
.AnalyzeSentimentOptions
setIncludeOpinionMining(boolean includeOpinionMining)
Sets the value ofincludeOpinionMining
.AnalyzeSentimentOptions
setIncludeStatistics(boolean includeStatistics)
Sets the value ofincludeStatistics
.AnalyzeSentimentOptions
setModelVersion(String modelVersion)
Sets the model version.AnalyzeSentimentOptions
setServiceLogsDisabled(boolean disableServiceLogs)
Sets the value of service logs disable status.-
Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions
getModelVersion, isIncludeStatistics, isServiceLogsDisabled
-
-
-
-
Method Detail
-
setModelVersion
public AnalyzeSentimentOptions setModelVersion(String modelVersion)
Sets the model version. This value indicates which model will be used for scoring, e.g. "latest", "2019-10-01". If a model-version is not specified, the API will default to the latest, non-preview version.- Overrides:
setModelVersion
in classTextAnalyticsRequestOptions
- Parameters:
modelVersion
- The model version.- Returns:
- The
AnalyzeSentimentOptions
object itself.
-
setIncludeStatistics
public AnalyzeSentimentOptions setIncludeStatistics(boolean includeStatistics)
Sets the value ofincludeStatistics
. The default value is false by default. If set to true, indicates that the service should return document and document batch statistics with the results of the operation.- Overrides:
setIncludeStatistics
in classTextAnalyticsRequestOptions
- Parameters:
includeStatistics
- If a boolean value was specified in the request this field will contain information about the document payload.- Returns:
- The
AnalyzeSentimentOptions
object itself.
-
setServiceLogsDisabled
public AnalyzeSentimentOptions setServiceLogsDisabled(boolean disableServiceLogs)
Sets the value of service logs disable status.- Overrides:
setServiceLogsDisabled
in classTextAnalyticsRequestOptions
- Parameters:
disableServiceLogs
- The default value of this property is 'false', except for methods like 'beginAnalyzeHealthcareEntities' and 'recognizePiiEntities'. This means, Text Analytics 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.- Returns:
- The
AnalyzeSentimentOptions
object itself.
-
isIncludeOpinionMining
public boolean isIncludeOpinionMining()
Gets the value ofincludeOpinionMining
. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get aopinions
property on SentenceSentiment. It is provided by service v3.1 and later.- Returns:
- The value of
includeOpinionMining
.
-
setIncludeOpinionMining
public AnalyzeSentimentOptions setIncludeOpinionMining(boolean includeOpinionMining)
Sets the value ofincludeOpinionMining
. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get aopinions
property on SentenceSentiment. It is provided by service v3.1 and later.- Parameters:
includeOpinionMining
- The boolean indicator to include opinion mining data in the returned result.- Returns:
- The AnalyzeSentimentOptions object itself.
-
-