com.azure.search.documents.indexes.models

Class EntityRecognitionSkill

java.lang.Object

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

com.azure.search.documents.indexes.models.EntityRecognitionSkill

public final class EntityRecognitionSkill
extends SearchIndexerSkill

Text analytics entity recognition.

Constructor Summary

Constructors

Constructor and Description
EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs) Constructor of SearchIndexerSkill.

Method Summary

Modifier and Type	Method and Description
Boolean	areTypelessEntitiesIncluded() Get the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type.
List<EntityCategory>	getCategories() Get the categories property: A list of entity categories that should be extracted.
EntityRecognitionSkillLanguage	getDefaultLanguageCode() Get the defaultLanguageCode property: A value indicating which language code to use.
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.
EntityRecognitionSkill	setCategories(EntityCategory... categories) Set the categories property: A list of entity categories that should be extracted.
EntityRecognitionSkill	setCategories(List<EntityCategory> categories) Set the categories property: A list of entity categories that should be extracted.
EntityRecognitionSkill	setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode) Set the defaultLanguageCode property: A value indicating which language code to use.
EntityRecognitionSkill	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.
EntityRecognitionSkill	setTypelessEntitiesIncluded(Boolean typelessEntitiesIncluded) Set the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type.

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

EntityRecognitionSkill

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

Constructor of SearchIndexerSkill.

Parameters:

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

outputs - The output of a skill is either a field in a search index, or a value

Method Detail

getCategories

public List<EntityCategory> getCategories()

Get the categories property: A list of entity categories that should be extracted.

Returns:

the categories value.

setCategories

public EntityRecognitionSkill setCategories(EntityCategory... categories)

Set the categories property: A list of entity categories that should be extracted.

Parameters:

categories - the categories value to set.

Returns:

the EntityRecognitionSkill object itself.

setCategories

public EntityRecognitionSkill setCategories(List<EntityCategory> categories)

Set the categories property: A list of entity categories that should be extracted.

Parameters:

categories - the categories value to set.

Returns:

the EntityRecognitionSkill object itself.

getDefaultLanguageCode

public EntityRecognitionSkillLanguage getDefaultLanguageCode()

Get the defaultLanguageCode property: A value indicating which language code to use. Default is en. Possible values include: 'ar', 'cs', 'zh-Hans', 'zh-Hant', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'no', 'pl', 'pt-PT', 'pt-BR', 'ru', 'es', 'sv', 'tr'.

Returns:

the defaultLanguageCode value.

setDefaultLanguageCode

public EntityRecognitionSkill setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode)

Set the defaultLanguageCode property: A value indicating which language code to use. Default is en. Possible values include: 'ar', 'cs', 'zh-Hans', 'zh-Hant', 'da', 'nl', 'en', 'fi', 'fr', 'de', 'el', 'hu', 'it', 'ja', 'ko', 'no', 'pl', 'pt-PT', 'pt-BR', 'ru', 'es', 'sv', 'tr'.

Parameters:

defaultLanguageCode - the defaultLanguageCode value to set.

Returns:

the EntityRecognitionSkill object itself.

areTypelessEntitiesIncluded

public Boolean areTypelessEntitiesIncluded()

Get the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.

Returns:

the includeTypelessEntities value.

setTypelessEntitiesIncluded

public EntityRecognitionSkill setTypelessEntitiesIncluded(Boolean typelessEntitiesIncluded)

Set the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced.

Parameters:

typelessEntitiesIncluded - the includeTypelessEntities value to set.

Returns:

the EntityRecognitionSkill 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 EntityRecognitionSkill 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 EntityRecognitionSkill object itself.