Share via

RecognizePiiEntitiesOptions Class

  • Reference
Package:
com.azure.ai.textanalytics.models
Maven Artifact:
com.azure:azure-ai-textanalytics:5.4.5

public final class RecognizePiiEntitiesOptions
extends TextAnalyticsRequestOptions

The RecognizePiiEntitiesOptions model.

Constructor Summary

Constructor Description
RecognizePiiEntitiesOptions()

Constructs a RecognizePiiEntitiesOptions model.

Method Summary

Modifier and Type Method and Description
Iterable<PiiEntityCategory> getCategoriesFilter()

Gets the value of categoriesFilter.
PiiEntityDomain getDomainFilter()

Gets the value of domainFilter.
boolean isServiceLogsDisabled()

Gets the value of service logs disable status.
RecognizePiiEntitiesOptions setCategoriesFilter(PiiEntityCategory[] categoriesFilter)

Sets the value of categoriesFilter.
RecognizePiiEntitiesOptions setDomainFilter(PiiEntityDomain domainFilter)

Sets the value of domainFilter.
RecognizePiiEntitiesOptions setIncludeStatistics(boolean includeStatistics)

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

Sets the model version.
RecognizePiiEntitiesOptions 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

RecognizePiiEntitiesOptions

public RecognizePiiEntitiesOptions()

Constructs a RecognizePiiEntitiesOptions model.

Method Details

getCategoriesFilter

public Iterable getCategoriesFilter()

Gets the value of categoriesFilter. It filters the response entities to ones only included in the specified categories.

Returns:

The value of categoriesFilter.

getDomainFilter

public PiiEntityDomain getDomainFilter()

Gets the value of domainFilter. It filters the response entities to ones only included in the specified domain. I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. See PII for more information.

Returns:

The value of domainFilter.

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:

RecognizePiiEntitiesOptions.isServiceLogsDisabled()

Returns:

true if service logging of input text is disabled.

setCategoriesFilter

public RecognizePiiEntitiesOptions setCategoriesFilter(PiiEntityCategory[] categoriesFilter)

Sets the value of categoriesFilter. It filters the response entities to ones only included in the specified categories.

Parameters:

categoriesFilter - It filters the response entities to ones only included in the specified categories.

Returns:

The RecognizePiiEntitiesOptions object itself.

setDomainFilter

public RecognizePiiEntitiesOptions setDomainFilter(PiiEntityDomain domainFilter)

Sets the value of domainFilter. It filters the response entities to ones only included in the specified domain. I.e., if set to 'PHI', will only return entities in the Protected Healthcare Information domain. See Named Entity Recognition for more information.

Parameters:

domainFilter - It filters the response entities to ones only included in the specified domain.

Returns:

The RecognizePiiEntitiesOptions object itself.

setIncludeStatistics

public RecognizePiiEntitiesOptions 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:

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

setModelVersion

public RecognizePiiEntitiesOptions 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:

RecognizePiiEntitiesOptions.setModelVersion(String modelVersion)

Parameters:

modelVersion - The model version.

Returns:

The RecognizePiiEntitiesOptions object itself.

setServiceLogsDisabled

public RecognizePiiEntitiesOptions setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Overrides:

RecognizePiiEntitiesOptions.setServiceLogsDisabled(boolean disableServiceLogs)

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

Applies to