Package version:

Interface PIIDetectionSkill

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

interface PIIDetectionSkill {
    categories?: string[];
    context?: string;
    defaultLanguageCode?: string;
    description?: string;
    domain?: string;
    inputs: InputFieldMappingEntry[];
    maskingCharacter?: string;
    maskingMode?: "none" | "replace";
    minimumPrecision?: number;
    modelVersion?: string;
    name?: string;
    odatatype: "#Microsoft.Skills.Text.PIIDetectionSkill";
    outputs: OutputFieldMappingEntry[];
}

Hierarchy (view full)

Properties

categories?: string[]

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

context?: string

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.

defaultLanguageCode?: string

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

description?: string

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

domain?: string

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

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

maskingCharacter?: string

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

maskingMode?: "none" | "replace"

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

minimumPrecision?: number

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?: string

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.

name?: string

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 '#'.

odatatype

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

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.