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

Class EntityLinkingSkill

java.lang.Object

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

com.azure.search.documents.indexes.models.EntityLinkingSkill

public final class EntityLinkingSkill
extends SearchIndexerSkill

Using the Text Analytics API, extracts linked entities from text.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	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.
EntityLinkingSkill	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).
EntityLinkingSkill	setDefaultLanguageCode(String defaultLanguageCode)	Set the defaultLanguageCode property: A value indicating which language code to use.
EntityLinkingSkill	setDescription(String description)	Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
EntityLinkingSkill	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.
EntityLinkingSkill	setModelVersion(String modelVersion)	Set the modelVersion property: The version of the model to use when calling the Text Analytics service.
EntityLinkingSkill	setName(String name)	Set the name property: The name of the skill which uniquely identifies it within the skillset.

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

getContext, getDescription, getInputs, getName, getOutputs

Methods inherited from class java.lang.Object

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

Constructor Details

EntityLinkingSkill

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

Creates an instance of EntityLinkingSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

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 EntityLinkingSkill 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 EntityLinkingSkill 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 EntityLinkingSkill 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 EntityLinkingSkill 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 EntityLinkingSkill 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 EntityLinkingSkill object itself.

setName

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

setName in class SearchIndexerSkill

Parameters:

name - the name value to set.

Returns:

the SearchIndexerSkill object itself.

setDescription

public EntityLinkingSkill setDescription(String description)

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

Overrides:

setDescription in class SearchIndexerSkill

Parameters:

description - the description value to set.

Returns:

the SearchIndexerSkill object itself.

setContext

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

setContext in class SearchIndexerSkill

Parameters:

context - the context value to set.

Returns:

the SearchIndexerSkill object itself.