KeyPhraseExtractionSkill Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.8.1

• java.lang.Object
• • com.azure.search.documents.indexes.models.SearchIndexerSkill
  • • com.azure.search.documents.indexes.models.KeyPhraseExtractionSkill

public final class KeyPhraseExtractionSkill
extends SearchIndexerSkill

A skill that uses text analytics for key phrase extraction.

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
static KeyPhraseExtractionSkill	fromJson(JsonReader jsonReader) Reads an instance of KeyPhraseExtractionSkill from the JsonReader.
KeyPhraseExtractionSkillLanguage	getDefaultLanguageCode() Get the defaultLanguageCode property: A value indicating which language code to use.
Integer	getMaxKeyPhraseCount() Get the maxKeyPhraseCount property: A number indicating how many key phrases to return.
String	getModelVersion() Get the modelVersion property: The version of the model to use when calling the Text Analytics service.
String	getOdataType() Get the odataType property: A URI fragment specifying the type of skill.
KeyPhraseExtractionSkill	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).
KeyPhraseExtractionSkill	setDefaultLanguageCode(KeyPhraseExtractionSkillLanguage defaultLanguageCode) Set the defaultLanguageCode property: A value indicating which language code to use.
KeyPhraseExtractionSkill	setDescription(String description) Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
KeyPhraseExtractionSkill	setMaxKeyPhraseCount(Integer maxKeyPhraseCount) Set the maxKeyPhraseCount property: A number indicating how many key phrases to return.
KeyPhraseExtractionSkill	setModelVersion(String modelVersion) Set the modelVersion property: The version of the model to use when calling the Text Analytics service.
KeyPhraseExtractionSkill	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

KeyPhraseExtractionSkill

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

Creates an instance of KeyPhraseExtractionSkill class.

Parameters:

inputs - the inputs value to set.

outputs - the outputs value to set.

Method Details

fromJson

public static KeyPhraseExtractionSkill fromJson(JsonReader jsonReader)

Reads an instance of KeyPhraseExtractionSkill from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

getDefaultLanguageCode

public KeyPhraseExtractionSkillLanguage getDefaultLanguageCode()

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

Returns:

the defaultLanguageCode value.

getMaxKeyPhraseCount

public Integer getMaxKeyPhraseCount()

Get the maxKeyPhraseCount property: A number indicating how many key phrases to return. If absent, all identified key phrases will be returned.

Returns:

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

getOdataType

public String getOdataType()

Get the odataType property: A URI fragment specifying the type of skill.

Overrides:

KeyPhraseExtractionSkill.getOdataType()

Returns:

the odataType value.

setContext

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

KeyPhraseExtractionSkill.setContext(String context)

Parameters:

context

setDefaultLanguageCode

public KeyPhraseExtractionSkill setDefaultLanguageCode(KeyPhraseExtractionSkillLanguage 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 KeyPhraseExtractionSkill object itself.

setDescription

public KeyPhraseExtractionSkill setDescription(String description)

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

Overrides:

KeyPhraseExtractionSkill.setDescription(String description)

Parameters:

description

setMaxKeyPhraseCount

public KeyPhraseExtractionSkill setMaxKeyPhraseCount(Integer maxKeyPhraseCount)

Set the maxKeyPhraseCount property: A number indicating how many key phrases to return. If absent, all identified key phrases will be returned.

Parameters:

maxKeyPhraseCount - the maxKeyPhraseCount value to set.

Returns:

the KeyPhraseExtractionSkill object itself.

setModelVersion

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

setName

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

KeyPhraseExtractionSkill.setName(String name)

Parameters:

name

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

KeyPhraseExtractionSkill.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException