PiiEntityRecognitionAction interface

Package:

@azure/ai-language-text

Options for a Pii entity recognition action.

Extends

ActionPrebuilt

Properties

categoriesFilter	Filters entities to ones only included in the specified array of categories. For a list of possible categories, see <xref:KnownPiiCategory>
domainFilter	Filters entities to ones only included in the specified domain (e.g., if set to Phi, only entities in the Protected Healthcare Information domain will be returned). For a list of possible domains, see KnownPiiEntityDomain. See the service documentation for more information.
stringIndexType	Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType. The default is the JavaScript's default which is "Utf16CodeUnit".

Inherited Properties

disableServiceLogs	If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur. Default is false.
modelVersion	The version of the model to be used by the action.

Property Details

categoriesFilter

Filters entities to ones only included in the specified array of categories. For a list of possible categories, see <xref:KnownPiiCategory>

categoriesFilter?: string[]

Property Value

string[]

domainFilter

Filters entities to ones only included in the specified domain (e.g., if set to Phi, only entities in the Protected Healthcare Information domain will be returned). For a list of possible domains, see KnownPiiEntityDomain.

See the service documentation for more information.

domainFilter?: string

Property Value

string

stringIndexType

Specifies the measurement unit used to calculate the offset and length properties. For a list of possible values, see KnownStringIndexType.

The default is the JavaScript's default which is "Utf16CodeUnit".

stringIndexType?: string

Property Value

string

Inherited Property Details

disableServiceLogs

If set to true, you opt-out of having your text input logged for troubleshooting. By default, Cognitive Language Service logs your input text for 48 hours, solely to allow for troubleshooting issues. Setting this parameter to true, disables in logging and may limit our ability to remediate issues that occur.

Default is false.

disableServiceLogs?: boolean

Property Value

boolean

Inherited From ActionPrebuilt.disableServiceLogs

modelVersion

The version of the model to be used by the action.

modelVersion?: string

Property Value

string

Inherited From ActionPrebuilt.modelVersion