Share via

EntityRecognitionSkill Class

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

public final class EntityRecognitionSkill
extends SearchIndexerSkill

Text analytics entity recognition.

Constructor Summary

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

Deprecated

Creates an instance of EntityRecognitionSkill class.
EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, EntityRecognitionSkillVersion version)

Creates an instance of EntityRecognitionSkill class.

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.
String getModelVersion()

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

Gets the version of the EntityRecognitionSkill.
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 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).
EntityRecognitionSkill setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode)

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

Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
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 setModelVersion(String modelVersion)

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

Set the name property: The name of the skill which uniquely identifies it within the skillset.
EntityRecognitionSkill setTypelessEntitiesIncluded(Boolean includeTypelessEntities)

Set the includeTypelessEntities property: Determines whether or not to include entities which are well known but don't conform to a pre-defined type.
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

EntityRecognitionSkill

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

Deprecated

Creates an instance of EntityRecognitionSkill class.

The instance of SentimentSkill uses V1, to set the specific version of the skill use EntityRecognitionSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, EntityRecognitionSkillVersion version).

Parameters:

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

EntityRecognitionSkill

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

Creates an instance of EntityRecognitionSkill class.

Parameters:

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

Method Details

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.

getCategories

public List<EntityCategory> getCategories()

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

Returns:

the categories value.

getDefaultLanguageCode

public EntityRecognitionSkillLanguage getDefaultLanguageCode()

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

Returns:

the defaultLanguageCode 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.

getSkillVersion

public EntityRecognitionSkillVersion getSkillVersion()

Gets the version of the EntityRecognitionSkill.

Returns:

The version of the EntityRecognitionSkill.

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.

setContext

public EntityRecognitionSkill 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:

EntityRecognitionSkill.setContext(String context)

Parameters:

context

setDefaultLanguageCode

public EntityRecognitionSkill setDefaultLanguageCode(EntityRecognitionSkillLanguage 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 EntityRecognitionSkill object itself.

setDescription

public EntityRecognitionSkill setDescription(String description)

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

Overrides:

EntityRecognitionSkill.setDescription(String description)

Parameters:

description

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.

setModelVersion

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

setName

public EntityRecognitionSkill 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:

EntityRecognitionSkill.setName(String name)

Parameters:

name

setTypelessEntitiesIncluded

public EntityRecognitionSkill setTypelessEntitiesIncluded(Boolean includeTypelessEntities)

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:

includeTypelessEntities - the includeTypelessEntities value to set.

Returns:

the EntityRecognitionSkill object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EntityRecognitionSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to