RecognizePiiEntitiesAction | @azure/ai-text-analytics

Options for a Pii entities recognition action.

Hierarchy

TextAnalyticsAction
- RecognizePiiEntitiesAction

Index

Properties

Optional actionName

actionName: undefined | string

The preferred name for this action.

Optional categoriesFilter

categoriesFilter: PiiCategory[]

Filters entities to ones only included in the specified array of categories

Optional disableServiceLogs

disableServiceLogs: undefined | false | true

If set to false, you opt-in to have your text input logged for troubleshooting. By default, Text Analytics will not log your input text for pii entities recognition. Setting this parameter to false, enables input logging.

Optional domainFilter

domainFilter: PiiEntityDomain

Filters entities to ones only included in the specified domain (e.g., if set to 'PHI', entities in the Protected Healthcare Information domain will only be returned). @see https://aka.ms/tanerpii for more information.

Optional modelVersion

modelVersion: undefined | string

The version of the text analytics model used by this operation on this batch of input documents.

Optional stringIndexType

stringIndexType: StringIndexType

Specifies the measurement unit used to calculate the offset and length properties. Possible units are "TextElements_v8", "UnicodeCodePoint", and "Utf16CodeUnit". The default is the JavaScript's default which is "Utf16CodeUnit".