PIIDetectionSkill interface
Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.
- Extends
Properties
| categories | A list of PII entity categories that should be extracted and masked. |
| default |
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'. |
| masking |
The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'. |
| masking |
A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'. |
| minimum |
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. |
| model |
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?: stringProperty 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?: stringProperty Value
string
maskingCharacter
The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'.
maskingCharacter?: stringProperty Value
string
maskingMode
A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'.
maskingMode?: PIIDetectionSkillMaskingModeProperty Value
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?: numberProperty 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?: stringProperty 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?: stringProperty Value
string
Inherited From BaseSearchIndexerSkill.context
description
The description of the skill which describes the inputs, outputs, and usage of the skill.
description?: stringProperty 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
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?: stringProperty 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
Inherited From BaseSearchIndexerSkill.outputs