com.azure.search.documents.indexes.models

Class KeyPhraseExtractionSkill

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

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
KeyPhraseExtractionSkill	setDefaultLanguageCode(KeyPhraseExtractionSkillLanguage defaultLanguageCode) Set the defaultLanguageCode property: A value indicating which language code to use.
KeyPhraseExtractionSkill	setMaxKeyPhraseCount(Integer maxKeyPhraseCount) Set the maxKeyPhraseCount property: A number indicating how many key phrases to return.

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

KeyPhraseExtractionSkill

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

Constructor of KeyPhraseExtractionSkill.

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 that can be consumed as an input by another skill.

Method Detail

getDefaultLanguageCode

public KeyPhraseExtractionSkillLanguage getDefaultLanguageCode()

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

Returns:

the defaultLanguageCode value.

setDefaultLanguageCode

public KeyPhraseExtractionSkill setDefaultLanguageCode(KeyPhraseExtractionSkillLanguage defaultLanguageCode)

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

Parameters:

defaultLanguageCode - the defaultLanguageCode value to set.

Returns:

the KeyPhraseExtractionSkill object itself.

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.

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.