Package com.azure.search.documents.indexes.models

Class PiiDetectionSkill

java.lang.Object

com.azure.search.documents.indexes.models.SearchIndexerSkill

com.azure.search.documents.indexes.models.PiiDetectionSkill

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

Constructors

Constructor	Description
PiiDetectionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)	Creates an instance of PiiDetectionSkill class.

Method Summary

Modifier and Type	Method	Description
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	getMaskingCharacter()	Get the maskingCharacter 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.
List<String>	getPiiCategories()	Get the piiCategories property: A list of PII entity categories that should be extracted and masked.
PiiDetectionSkill	setDefaultLanguageCode(String defaultLanguageCode)	Set the defaultLanguageCode property: A value indicating which language code to use.
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	setMaskingCharacter(String maskingCharacter)	Set the maskingCharacter 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	setPiiCategories(List<String> piiCategories)	Set the piiCategories property: A list of PII entity categories that should be extracted and masked.

Methods inherited from class com.azure.search.documents.indexes.models.SearchIndexerSkill

getContext, getDescription, getInputs, getName, getOutputs, setContext, setDescription, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

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 Detail

getDefaultLanguageCode

public String getDefaultLanguageCode()

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

Returns:

the defaultLanguageCode value.

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.

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.

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.

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.

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.

getMaskingCharacter

public String getMaskingCharacter()

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

Returns:

the maskingCharacter value.

setMaskingCharacter

public PiiDetectionSkill setMaskingCharacter(String maskingCharacter)

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

Parameters:

maskingCharacter - the maskingCharacter value to set.

Returns:

the PiiDetectionSkill object itself.

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.

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.

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.

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.

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.

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.