PiiEntityRecognitionBatchAction | @azure/ai-text-analytics

Options for a pii entity recognition batch action.

Hierarchy

AnalyzeBatchActionCommon
ActionCommon & { modelVersion?: undefined | string } & { categoriesFilter?: PiiEntityCategory[]; domainFilter?: PiiEntityDomain; stringIndexType?: StringIndexType }
- PiiEntityRecognitionBatchAction

Index

Properties

Optional actionName

actionName: undefined | string

The name of the action.

Optional categoriesFilter

categoriesFilter: PiiEntityCategory[]

Filters entities to ones only included in the specified array of categories. For a list of possible categories, see {@link KnownPiiCategory}

Optional disableServiceLogs

disableServiceLogs: undefined | false | true

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.

Optional domainFilter

domainFilter: PiiEntityDomain

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 {@link PiiDomain}.

See the service documentation for more information.

kind

kind: "PiiEntityRecognition"

The kind of the action.

Optional modelVersion

modelVersion: undefined | string

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

Optional stringIndexType

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