EntityRecognitionSkillV3 Class

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

public final class EntityRecognitionSkillV3
extends SearchIndexerSkill

Using the Text Analytics API, extracts entities of different types from text.

Constructor Summary

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

Creates an instance of EntityRecognitionSkillV3 class.

Method Summary

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

Reads an instance of EntityRecognitionSkillV3 from the JsonReader.
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 API.
String getOdataType()

Get the odataType property: The discriminator for derived types.
EntityRecognitionSkillV3 setCategories(EntityCategory[] categories)

Set the categories property: A list of entity categories that should be extracted.
EntityRecognitionSkillV3 setCategories(List<EntityCategory> categories)

Set the categories property: A list of entity categories that should be extracted.
EntityRecognitionSkillV3 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).
EntityRecognitionSkillV3 setDefaultLanguageCode(EntityRecognitionSkillLanguage defaultLanguageCode)

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

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

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

Set the name property: The name of the skill which uniquely identifies it within the skillset.
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

EntityRecognitionSkillV3

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

Creates an instance of EntityRecognitionSkillV3 class.

Parameters:

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

Method Details

fromJson

public static EntityRecognitionSkillV3 fromJson(JsonReader jsonReader)

Reads an instance of EntityRecognitionSkillV3 from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of EntityRecognitionSkillV3 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.

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 API. 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: The discriminator for derived types.

Overrides:

EntityRecognitionSkillV3.getOdataType()

Returns:

the odataType value.

setCategories

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

setCategories

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

setContext

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

EntityRecognitionSkillV3.setContext(String context)

Parameters:

context

setDefaultLanguageCode

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

setDescription

public EntityRecognitionSkillV3 setDescription(String description)

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

Overrides:

EntityRecognitionSkillV3.setDescription(String description)

Parameters:

description

setMinimumPrecision

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

setModelVersion

public EntityRecognitionSkillV3 setModelVersion(String modelVersion)

Set the modelVersion property: The version of the model to use when calling the Text Analytics API. 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 EntityRecognitionSkillV3 object itself.

setName

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

EntityRecognitionSkillV3.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

EntityRecognitionSkillV3.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to