PiiEntityRecognitionBatchAction interface

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

Options for a pii entity recognition batch action.

Extends

AnalyzeBatchActionCommon,PiiEntityRecognitionAction

Properties

kind

The kind of the action.

Inherited Properties

actionName

The name of the action.
categoriesFilter

Filters entities to ones only included in the specified array of categories. For a list of possible categories, see <xref:KnownPiiCategory>
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.
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 <xref:PiiDomain>.

See the service documentation for more information.
modelVersion

The version of the model to be used by the action.
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".

Property Details

kind

The kind of the action.

kind: "PiiEntityRecognition"

Property Value

"PiiEntityRecognition"

Inherited Property Details

actionName

The name of the action.

actionName?: string

Property Value

string

Inherited From AnalyzeBatchActionCommon.actionName

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[]

Inherited From PiiEntityRecognitionAction.categoriesFilter

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 PiiEntityRecognitionAction.disableServiceLogs

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 <xref:PiiDomain>.

See the service documentation for more information.

domainFilter?: string

Property Value

string

Inherited From PiiEntityRecognitionAction.domainFilter

modelVersion

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

modelVersion?: string

Property Value

string

Inherited From PiiEntityRecognitionAction.modelVersion

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 From PiiEntityRecognitionAction.stringIndexType