RecognizePiiEntitiesAction Class

RecognizePiiEntitiesAction encapsulates the parameters for starting a long-running PII Entities Recognition operation.

If you just want to recognize pii entities in a list of documents, and not perform multiple long running actions on the input of documents, call method recognize_pii_entities instead of interfacing with this model.

Inheritance

azure.ai.textanalytics._models.DictMixin

RecognizePiiEntitiesAction

Constructor

RecognizePiiEntitiesAction(**kwargs)

Parameters

model_version

str

The model version to use for the analysis.

domain_filter

str

An optional string to set the PII domain to include only a subset of the PII entity categories. Possible values include 'phi' or None.

categories_filter

list[PiiEntityCategory]

Instead of filtering over all PII entity categories, you can pass in a list of the specific PII entity categories you want to filter out. For example, if you only want to filter out U.S. social security numbers in a document, you can pass in [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] for this kwarg.

string_index_type

str

Specifies the method used to interpret string offsets. UnicodeCodePoint, the Python encoding, is the default. To override the Python default, you can also pass in Utf16CodePoint or TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets

disable_service_logs

bool

Defaults to true, meaning that Text Analytics will not log your input text on the service side for troubleshooting. If set to False, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.

Variables

model_version

str

The model version to use for the analysis.

domain_filter

str

An optional string to set the PII domain to include only a subset of the PII entity categories. Possible values include 'phi' or None.

categories_filter

list[PiiEntityCategory]

Instead of filtering over all PII entity categories, you can pass in a list of the specific PII entity categories you want to filter out. For example, if you only want to filter out U.S. social security numbers in a document, you can pass in [PiiEntityCategory.US_SOCIAL_SECURITY_NUMBER] for this kwarg.

string_index_type

str

Specifies the method used to interpret string offsets. UnicodeCodePoint, the Python encoding, is the default. To override the Python default, you can also pass in Utf16CodePoint or TextElement_v8`. For additional information see https://aka.ms/text-analytics-offsets

disable_service_logs

bool

Defaults to true, meaning that Text Analytics will not log your input text on the service side for troubleshooting. If set to False, Text Analytics logs your input text for 48 hours, solely to allow for troubleshooting issues in providing you with the Text Analytics natural language processing functions. Please see Cognitive Services Compliance and Privacy notes at https://aka.ms/cs-compliance for additional details, and Microsoft Responsible AI principles at https://www.microsoft.com/ai/responsible-ai.