SearchModelFactory.PiiDetectionSkill Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.
public static Azure.Search.Documents.Indexes.Models.PiiDetectionSkill PiiDetectionSkill(string name = default, string description = default, string context = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> inputs = default, System.Collections.Generic.IEnumerable<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> outputs = default, string defaultLanguageCode = default, double? minPrecision = default, Azure.Search.Documents.Indexes.Models.PiiDetectionSkillMaskingMode? maskingMode = default, string mask = default, string modelVersion = default, System.Collections.Generic.IEnumerable<string> piiCategories = default, string domain = default);static member PiiDetectionSkill : string * string * string * seq<Azure.Search.Documents.Indexes.Models.InputFieldMappingEntry> * seq<Azure.Search.Documents.Indexes.Models.OutputFieldMappingEntry> * string * Nullable<double> * Nullable<Azure.Search.Documents.Indexes.Models.PiiDetectionSkillMaskingMode> * string * string * seq<string> * string -> Azure.Search.Documents.Indexes.Models.PiiDetectionSkillPublic Shared Function PiiDetectionSkill (Optional name As String = Nothing, Optional description As String = Nothing, Optional context As String = Nothing, Optional inputs As IEnumerable(Of InputFieldMappingEntry) = Nothing, Optional outputs As IEnumerable(Of OutputFieldMappingEntry) = Nothing, Optional defaultLanguageCode As String = Nothing, Optional minPrecision As Nullable(Of Double) = Nothing, Optional maskingMode As Nullable(Of PiiDetectionSkillMaskingMode) = Nothing, Optional mask As String = Nothing, Optional modelVersion As String = Nothing, Optional piiCategories As IEnumerable(Of String) = Nothing, Optional domain As String = Nothing) As PiiDetectionSkillParameters
- 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 '#'.
- description
- String
The description of the skill which describes the inputs, outputs, and usage of the skill.
- 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.
- inputs
- IEnumerable<InputFieldMappingEntry>
Inputs of the skills could be a column in the source data set, or the output of an upstream skill.
- outputs
- IEnumerable<OutputFieldMappingEntry>
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.
- defaultLanguageCode
- String
A value indicating which language code to use. Default is en.
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.
- maskingMode
- Nullable<PiiDetectionSkillMaskingMode>
A parameter that provides various ways to mask the personal information detected in the input text. Default is 'none'.
- mask
- String
The character used to mask the text if the maskingMode parameter is set to replace. Default is '*'.
- 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.
- piiCategories
- IEnumerable<String>
A list of PII entity categories that should be extracted and masked.
- 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'.
Returns
A new PiiDetectionSkill instance for mocking.
