AnalyzeSentimentOptions Class

Package:
com.azure.ai.textanalytics.models
Maven Artifact:
com.azure:azure-ai-textanalytics:5.5.12

public final class AnalyzeSentimentOptions
extends TextAnalyticsRequestOptions

The AnalyzeSentimentOptions model.

Constructor Summary

Constructor Description
AnalyzeSentimentOptions()

Constructs a AnalyzeSentimentOptions model.

Method Summary

Modifier and Type Method and Description
boolean isIncludeOpinionMining()

Gets the value of includeOpinionMining.
AnalyzeSentimentOptions setIncludeOpinionMining(boolean includeOpinionMining)

Sets the value of includeOpinionMining.
AnalyzeSentimentOptions setIncludeStatistics(boolean includeStatistics)

Sets the value of includeStatistics.
AnalyzeSentimentOptions setModelVersion(String modelVersion)

Sets the model version.
AnalyzeSentimentOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Methods inherited from TextAnalyticsRequestOptions

getModelVersion isIncludeStatistics isServiceLogsDisabled setIncludeStatistics setModelVersion setServiceLogsDisabled

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

AnalyzeSentimentOptions

public AnalyzeSentimentOptions()

Constructs a AnalyzeSentimentOptions model.

Method Details

isIncludeOpinionMining

public boolean isIncludeOpinionMining()

Gets the value of includeOpinionMining. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get a opinions 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 of includeOpinionMining. The boolean indicator to include opinion mining data in the returned result. If this flag is specified, you'll get a opinions 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.

setIncludeStatistics

public AnalyzeSentimentOptions setIncludeStatistics(boolean includeStatistics)

Sets the value of includeStatistics. 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:

AnalyzeSentimentOptions.setIncludeStatistics(boolean includeStatistics)

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.

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:

AnalyzeSentimentOptions.setModelVersion(String modelVersion)

Parameters:

modelVersion - The model version.

Returns:

The AnalyzeSentimentOptions object itself.

setServiceLogsDisabled

public AnalyzeSentimentOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Overrides:

AnalyzeSentimentOptions.setServiceLogsDisabled(boolean disableServiceLogs)

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.

Applies to