Package com.azure.ai.textanalytics.models

Class RecognizePiiEntitiesAction

java.lang.Object
com.azure.ai.textanalytics.models.RecognizePiiEntitiesAction
public final class RecognizePiiEntitiesAction extends Object
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 Details

    • RecognizePiiEntitiesAction

      public RecognizePiiEntitiesAction()

  • Method Details

    • getActionName

      public String getActionName()
      Get the name of action.
      Returns:
      the name of action.

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

    • getModelVersion

      public String getModelVersion()
      Gets the version of the text analytics model used by this operation.
      Returns:
      The model version.

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

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

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

    • 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 https://aka.ms/tanerpii for more information.
      Returns:
      The value of domainFilter.

    • 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 https://aka.ms/tanerpii for more information.
      Parameters:
      domainFilter - It filters the response entities to ones only included in the specified domain.
      Returns:
      The RecognizePiiEntitiesAction object itself.

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

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