PiiDetectionSkill Class

  • Reference

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v11.6.0
Package:
Azure.Search.Documents v11.7.0-beta.1
Source:
PiiDetectionSkill.cs
Source:
PiiDetectionSkill.cs

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

public class PiiDetectionSkill : Azure.Search.Documents.Indexes.Models.SearchIndexerSkill
type PiiDetectionSkill = class
    inherit SearchIndexerSkill
Public Class PiiDetectionSkill
Inherits SearchIndexerSkill
Inheritance
Object
SearchIndexerSkill
PiiDetectionSkill

Constructors

PiiDetectionSkill(IEnumerable<InputFieldMappingEntry>, IEnumerable<OutputFieldMappingEntry>)

Initializes a new instance of PiiDetectionSkill.

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.

(Inherited from SearchIndexerSkill)
DefaultLanguageCode

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

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

(Inherited from SearchIndexerSkill)
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'.
Inputs

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

(Inherited from SearchIndexerSkill)
Mask

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

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.
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 prefaced with the character "#" in debug sessions and error messages.

(Inherited from SearchIndexerSkill)
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.

(Inherited from SearchIndexerSkill)
PiiCategories

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

Applies to