RecognizePiiEntitiesAction Class

Package:

com.azure.ai.textanalytics.models

Maven Artifact:

com.azure:azure-ai-textanalytics:5.5.12

• java.lang.Object
• • com.azure.ai.textanalytics.models.RecognizePiiEntitiesAction

public final class RecognizePiiEntitiesAction

Configurations that allow callers to specify details about how to execute a Personally Identifiable Information(PII) entities recognition action in a set of documents.

Constructor Summary

Constructor	Description
RecognizePiiEntitiesAction()	Constructs a RecognizePiiEntitiesAction model.

Method Summary

Modifier and Type	Method and Description
String	getActionName() Get the name of action.
Iterable<PiiEntityCategory>	getCategoriesFilter() Gets the value of categoriesFilter.
PiiEntityDomain	getDomainFilter() Gets the value of domainFilter.
String	getModelVersion() Gets the version of the text analytics model used by this operation.
boolean	isServiceLogsDisabled() Gets the value of service logs disable status.
RecognizePiiEntitiesAction	setActionName(String actionName) Set the custom name for the action.
RecognizePiiEntitiesAction	setCategoriesFilter(PiiEntityCategory[] categoriesFilter) Sets the value of categoriesFilter.
RecognizePiiEntitiesAction	setDomainFilter(PiiEntityDomain domainFilter) Sets the value of domainFilter.
RecognizePiiEntitiesAction	setModelVersion(String modelVersion) Sets the model version.
RecognizePiiEntitiesAction	setServiceLogsDisabled(boolean disableServiceLogs) Sets the value of service logs disable status.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

RecognizePiiEntitiesAction

public RecognizePiiEntitiesAction()

Constructs a RecognizePiiEntitiesAction model.

Method Details

getActionName

public String getActionName()

Get the name of action.

Returns:

the name of action.

getCategoriesFilter

public Iterable<PiiEntityCategory> 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.

getModelVersion

public String getModelVersion()

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

Returns:

The model version.

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.

Returns:

true if service logging of input text is disabled.

setActionName

public RecognizePiiEntitiesAction setActionName(String actionName)

Set the custom name for the action.

Parameters:

actionName - the custom name for the action.

Returns:

The RecognizePiiEntitiesAction object itself.

setCategoriesFilter

public RecognizePiiEntitiesAction 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 RecognizePiiEntitiesAction object itself.

setDomainFilter

public RecognizePiiEntitiesAction 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 PII for more information.

Parameters:

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

Returns:

The RecognizePiiEntitiesAction object itself.

setModelVersion

public RecognizePiiEntitiesAction 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.

Parameters:

modelVersion - The model version.

Returns:

The RecognizePiiEntitiesAction object itself.

setServiceLogsDisabled

public RecognizePiiEntitiesAction setServiceLogsDisabled(boolean disableServiceLogs)

Sets the value of service logs disable status.

Parameters:

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

Returns:

The RecognizePiiEntitiesAction object itself.