RecognizePiiEntitiesAction Class

Definition

Namespace:

Azure.AI.TextAnalytics

Assembly:

Azure.AI.TextAnalytics.dll

Package:

Azure.AI.TextAnalytics v5.3.0

Source:

RecognizePiiEntitiesAction.cs

Configurations that allow callers to specify details about how to execute a Recognize PII Entities action in a set of documents. For example, set model version, filter the response entities by a given domain filter, and more.

public class RecognizePiiEntitiesAction

type RecognizePiiEntitiesAction = class

Public Class RecognizePiiEntitiesAction

Inheritance

Object

RecognizePiiEntitiesAction

Constructors

RecognizePiiEntitiesAction()	Initializes a new instance of the RecognizePiiEntitiesAction class which allows callers to specify details about how to execute a Recognize PII Entities action in a set of documents. For example, set model version, filter the response entities by a given domain filter, and more.
RecognizePiiEntitiesAction(RecognizePiiEntitiesOptions)	Initializes a new instance of the RecognizePiiEntitiesAction class based on the values of a RecognizePiiEntitiesOptions. It sets the ModelVersion, DisableServiceLogs, DomainFilter, and CategoriesFilter properties.

Properties

ActionName	Gets or sets a name for this action. If not provided, the service will generate one.
CategoriesFilter	Filters the response entities to entities that match the PiiEntityCategory specified.
DisableServiceLogs	The default value of this property is 'true'. This means, the Language 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. 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.
DomainFilter	Filters the response entities to ones only included in the specified domain. For more information see https://aka.ms/azsdk/language/pii.
ModelVersion	Gets or sets a value that, if set, indicates the version of the Language service model that will be used to generate the result. For supported model versions, see operation-specific documentation, for example: https://docs.microsoft.com/azure/cognitive-services/language-service/concepts/model-lifecycle#available-versions.