Share via

PiiDetectionSkill Class

Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.8.1

public final class PiiDetectionSkill
extends SearchIndexerSkill

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

Constructor Summary

Constructor Description
PiiDetectionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of PiiDetectionSkill class.

Method Summary

Modifier and Type Method and Description
static PiiDetectionSkill fromJson(JsonReader jsonReader)

Reads an instance of PiiDetectionSkill from the JsonReader.
String getDefaultLanguageCode()

Get the defaultLanguageCode property: A value indicating which language code to use.
String getDomain()

Get the domain property: If specified, will set the PII domain to include only a subset of the entity categories.
String getMask()

Get the mask property: The character used to mask the text if the maskingMode parameter is set to replace.
PiiDetectionSkillMaskingMode getMaskingMode()

Get the maskingMode property: A parameter that provides various ways to mask the personal information detected in the input text.
Double getMinimumPrecision()

Get the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified.
String getModelVersion()

Get the modelVersion property: The version of the model to use when calling the Text Analytics service.
String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.
List<String> getPiiCategories()

Get the piiCategories property: A list of PII entity categories that should be extracted and masked.
PiiDetectionSkill setContext(String context)

Set the context property: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content).
PiiDetectionSkill setDefaultLanguageCode(String defaultLanguageCode)

Set the defaultLanguageCode property: A value indicating which language code to use.
PiiDetectionSkill setDescription(String description)

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
PiiDetectionSkill setDomain(String domain)

Set the domain property: If specified, will set the PII domain to include only a subset of the entity categories.
PiiDetectionSkill setMask(String mask)

Set the mask property: The character used to mask the text if the maskingMode parameter is set to replace.
PiiDetectionSkill setMaskingMode(PiiDetectionSkillMaskingMode maskingMode)

Set the maskingMode property: A parameter that provides various ways to mask the personal information detected in the input text.
PiiDetectionSkill setMinimumPrecision(Double minimumPrecision)

Set the minimumPrecision property: A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified.
PiiDetectionSkill setModelVersion(String modelVersion)

Set the modelVersion property: The version of the model to use when calling the Text Analytics service.
PiiDetectionSkill setName(String name)

Set the name property: The name of the skill which uniquely identifies it within the skillset.
PiiDetectionSkill setPiiCategories(List<String> piiCategories)

Set the piiCategories property: A list of PII entity categories that should be extracted and masked.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from SearchIndexerSkill

fromJson getContext getDescription getInputs getName getOdataType getOutputs setContext setDescription setName toJson

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

PiiDetectionSkill

public PiiDetectionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)

Creates an instance of PiiDetectionSkill class.

Parameters:

inputs - the inputs value to set.
outputs - the outputs value to set.

Method Details

fromJson

public static PiiDetectionSkill fromJson(JsonReader jsonReader)

Reads an instance of PiiDetectionSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of PiiDetectionSkill if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If the deserialized JSON object was missing any required properties.

getDefaultLanguageCode

public String getDefaultLanguageCode()

Get the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.

Returns:

the defaultLanguageCode value.

getDomain

public String getDomain()

Get the domain property: 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:

the domain value.

getMask

public String getMask()

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

Returns:

the mask value.

getMaskingMode

public PiiDetectionSkillMaskingMode getMaskingMode()

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

Returns:

the maskingMode value.

getMinimumPrecision

public Double getMinimumPrecision()

Get the minimumPrecision property: 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.

Returns:

the minimumPrecision value.

getModelVersion

public String getModelVersion()

Get the modelVersion property: 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.

Returns:

the modelVersion value.

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.

Overrides:

PiiDetectionSkill.getOdataType()

Returns:

the odataType value.

getPiiCategories

public List<String> getPiiCategories()

Get the piiCategories property: A list of PII entity categories that should be extracted and masked.

Returns:

the piiCategories value.

setContext

public PiiDetectionSkill setContext(String context)

Set the context property: 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.

Overrides:

PiiDetectionSkill.setContext(String context)

Parameters:

context

setDefaultLanguageCode

public PiiDetectionSkill setDefaultLanguageCode(String defaultLanguageCode)

Set the defaultLanguageCode property: A value indicating which language code to use. Default is `en`.

Parameters:

defaultLanguageCode - the defaultLanguageCode value to set.

Returns:

the PiiDetectionSkill object itself.

setDescription

public PiiDetectionSkill setDescription(String description)

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

Overrides:

PiiDetectionSkill.setDescription(String description)

Parameters:

description

setDomain

public PiiDetectionSkill setDomain(String domain)

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

Parameters:

domain - the domain value to set.

Returns:

the PiiDetectionSkill object itself.

setMask

public PiiDetectionSkill setMask(String mask)

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

Parameters:

mask - the mask value to set.

Returns:

the PiiDetectionSkill object itself.

setMaskingMode

public PiiDetectionSkill setMaskingMode(PiiDetectionSkillMaskingMode maskingMode)

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

Parameters:

maskingMode - the maskingMode value to set.

Returns:

the PiiDetectionSkill object itself.

setMinimumPrecision

public PiiDetectionSkill setMinimumPrecision(Double minimumPrecision)

Set the minimumPrecision property: 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.

Parameters:

minimumPrecision - the minimumPrecision value to set.

Returns:

the PiiDetectionSkill object itself.

setModelVersion

public PiiDetectionSkill setModelVersion(String modelVersion)

Set the modelVersion property: 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.

Parameters:

modelVersion - the modelVersion value to set.

Returns:

the PiiDetectionSkill object itself.

setName

public PiiDetectionSkill setName(String name)

Set the name property: 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 '#'.

Overrides:

PiiDetectionSkill.setName(String name)

Parameters:

name

setPiiCategories

public PiiDetectionSkill setPiiCategories(List<String> piiCategories)

Set the piiCategories property: A list of PII entity categories that should be extracted and masked.

Parameters:

piiCategories - the piiCategories value to set.

Returns:

the PiiDetectionSkill object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

PiiDetectionSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to