Package com.azure.ai.textanalytics.models

Class TextAnalyticsRequestOptions

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions

Direct Known Subclasses:

AnalyzeHealthcareEntitiesOptions, AnalyzeSentimentOptions, RecognizePiiEntitiesOptions

public class TextAnalyticsRequestOptions
extends Object

The TextAnalyticsRequestOptions model.

Constructor Summary

Constructors

Constructor	Description
TextAnalyticsRequestOptions()

Method Summary

Modifier and Type	Method	Description
String	getModelVersion()	Gets the version of the text analytics model used by this operation.
boolean	isIncludeStatistics()	Get the value of includeStatistics.
boolean	isServiceLogsDisabled()	Gets the value of service logs disable status.
TextAnalyticsRequestOptions	setIncludeStatistics(boolean includeStatistics)	Set the value of includeStatistics.
TextAnalyticsRequestOptions	setModelVersion(String modelVersion)	Set the model version.
TextAnalyticsRequestOptions	setServiceLogsDisabled(boolean disableServiceLogs)	Sets the value of service logs disable status.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextAnalyticsRequestOptions

public TextAnalyticsRequestOptions()

Method Detail

getModelVersion

public String getModelVersion()

Gets the version of the text analytics model used by this operation.

Returns:

The model version.

setModelVersion

public TextAnalyticsRequestOptions setModelVersion(String modelVersion)

Set 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.

Parameters:

modelVersion - The model version.

Returns:

The TextAnalyticsRequestOptions object itself.

isIncludeStatistics

public boolean isIncludeStatistics()

Get the value of includeStatistics.

Returns:

The value of includeStatistics.

setIncludeStatistics

public TextAnalyticsRequestOptions setIncludeStatistics(boolean includeStatistics)

Set 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.

Parameters:

includeStatistics - If a boolean value was specified in the request this field will contain information about the document payload.

Returns:

the TextAnalyticsRequestOptions object itself.

isServiceLogsDisabled

public boolean isServiceLogsDisabled()

Gets the value of service logs disable status. The default value of this property is 'false', except at AnalyzeHealthcareEntitiesOptions and RecognizePiiEntitiesOptions. 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:

true if service logging of input text is disabled.

setServiceLogsDisabled

public TextAnalyticsRequestOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

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 TextAnalyticsRequestOptions object itself.