Package com.azure.ai.textanalytics.models

Class AnalyzeHealthcareEntitiesOptions

java.lang.Object

com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions

com.azure.ai.textanalytics.models.AnalyzeHealthcareEntitiesOptions

public final class AnalyzeHealthcareEntitiesOptions
extends TextAnalyticsRequestOptions

The AnalyzeHealthcareEntitiesOptions model.

Constructor Summary

Constructors

Constructor	Description
AnalyzeHealthcareEntitiesOptions()

Method Summary

Modifier and Type	Method	Description
FhirVersion	getFhirVersion()	Get the fhirVersion property: The FHIR Spec version that the result will use to format the fhirBundle.
boolean	isServiceLogsDisabled()	Gets the value of service logs disable status.
AnalyzeHealthcareEntitiesOptions	setFhirVersion(FhirVersion fhirVersion)	Set the fhirVersion property: The FHIR Spec version that the result will use to format the fhirBundle.
AnalyzeHealthcareEntitiesOptions	setIncludeStatistics(boolean includeStatistics)	Sets the value of includeStatistics.
AnalyzeHealthcareEntitiesOptions	setModelVersion(String modelVersion)	Sets the model version.
AnalyzeHealthcareEntitiesOptions	setServiceLogsDisabled(boolean disableServiceLogs)	Sets the value of service logs disable status.

Methods inherited from class com.azure.ai.textanalytics.models.TextAnalyticsRequestOptions

getModelVersion, isIncludeStatistics

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyzeHealthcareEntitiesOptions

public AnalyzeHealthcareEntitiesOptions()

Method Detail

setModelVersion

public AnalyzeHealthcareEntitiesOptions 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 class TextAnalyticsRequestOptions

Parameters:

modelVersion - The model version.

Returns:

The AnalyzeHealthcareEntitiesOptions object itself.

setIncludeStatistics

public AnalyzeHealthcareEntitiesOptions setIncludeStatistics(boolean includeStatistics)

Sets the value of includeStatistics.

Overrides:

setIncludeStatistics in class TextAnalyticsRequestOptions

Parameters:

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

Returns:

The AnalyzeHealthcareEntitiesOptions object itself.

getFhirVersion

public FhirVersion getFhirVersion()

Get the fhirVersion property: The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.

Returns:

the fhirVersion value.

setFhirVersion

public AnalyzeHealthcareEntitiesOptions setFhirVersion(FhirVersion fhirVersion)

Set the fhirVersion property: The FHIR Spec version that the result will use to format the fhirBundle. For additional information see https://www.hl7.org/fhir/overview.html.

Parameters:

fhirVersion - the fhirVersion value to set.

Returns:

the AnalyzeHealthcareEntitiesOptions object itself.

isServiceLogsDisabled

public boolean isServiceLogsDisabled()

Gets the value of service logs disable status. The default value of this property is 'true'. This means, Text Analytics service won't log your input text. Setting this property to 'false', enables logging your input text for 48 hours, solely to allow for troubleshooting issues.

Overrides:

isServiceLogsDisabled in class TextAnalyticsRequestOptions

Returns:

true if service logging of input text is disabled.

setServiceLogsDisabled

public AnalyzeHealthcareEntitiesOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Overrides:

setServiceLogsDisabled in class TextAnalyticsRequestOptions

Parameters:

disableServiceLogs - The default value of this property is 'true'. This means, Text Analytics service does not log your input text. Setting this property to 'false', enables the service to log your text input for 48 hours, solely to allow for troubleshooting issues.

Returns:

The AnalyzeHealthcareEntitiesOptions object itself.