PIIDetectionSkill interface

Package:

@azure/search-documents

Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.

Extends

BaseSearchIndexerSkill

Properties

categories	A list of PII entity categories that should be extracted and masked.
defaultLanguageCode	A value indicating which language code to use. Default is en.
domain	If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'.
maskingCharacter	The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'.
maskingMode	A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'.
minimumPrecision	A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.
modelVersion	The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.
odatatype	Polymorphic discriminator, which specifies the different types this object can be

Inherited Properties

context	Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.
description	The description of the skill which describes the inputs, outputs, and usage of the skill.
inputs	Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
name	The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.
outputs	The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

Property Details

categories

A list of PII entity categories that should be extracted and masked.

categories?: string[]

Property Value

string[]

defaultLanguageCode

A value indicating which language code to use. Default is en.

defaultLanguageCode?: string

Property Value

string

domain

If specified, will set the PII domain to include only a subset of the entity categories. Possible values include: 'phi', 'none'. Default is 'none'.

domain?: string

Property Value

string

maskingCharacter

The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'.

maskingCharacter?: string

Property Value

string

maskingMode

A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'.

maskingMode?: "none" | "replace"

Property Value

"none" | "replace"

minimumPrecision

A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included.

minimumPrecision?: number

Property Value

number

modelVersion

The version of the model to use when calling the Text Analytics service. It will default to the latest available when not specified. We recommend you do not specify this value unless absolutely necessary.

modelVersion?: string

Property Value

string

odatatype

Polymorphic discriminator, which specifies the different types this object can be

odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill"

Property Value

"#Microsoft.Skills.Text.PIIDetectionSkill"

Inherited Property Details

context

Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document.

context?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.context

description

The description of the skill which describes the inputs, outputs, and usage of the skill.

description?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.description

inputs

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

inputs: InputFieldMappingEntry[]

Property Value

InputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.inputs

name

The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'.

name?: string

Property Value

string

Inherited From BaseSearchIndexerSkill.name

outputs

The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill.

outputs: OutputFieldMappingEntry[]

Property Value

OutputFieldMappingEntry[]

Inherited From BaseSearchIndexerSkill.outputs