Share via

RecognizePiiEntitiesAction interface

  • Reference
Package:
@azure/ai-text-analytics

Options for a Pii entities recognition action.

Extends
TextAnalyticsAction

Properties

categoriesFilter

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

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

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

Inherited Properties

actionName

The preferred name for this action.
modelVersion

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

Property Details

categoriesFilter

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

categoriesFilter?: string[]

Property Value

string[]

disableServiceLogs

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.

disableServiceLogs?: boolean

Property Value

boolean

domainFilter

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.

domainFilter?: PROTECTED_HEALTH_INFORMATION

Property Value

PROTECTED_HEALTH_INFORMATION

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

stringIndexType?: StringIndexType

Property Value

StringIndexType

Inherited Property Details

actionName

The preferred name for this action.

actionName?: string

Property Value

string

Inherited From TextAnalyticsAction.actionName

modelVersion

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

modelVersion?: string

Property Value

string

Inherited From TextAnalyticsAction.modelVersion