Class SentimentSkill
- java.lang.Object
-
- com.azure.search.documents.indexes.models.SearchIndexerSkill
-
- com.azure.search.documents.indexes.models.SentimentSkill
-
public final class SentimentSkill extends SearchIndexerSkill
Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.
-
-
Constructor Summary
Constructors Constructor Description SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
Creates an instance of SentimentSkill class.SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)
Creates an instance of SentimentSkill class.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SentimentSkillLanguage
getDefaultLanguageCode()
Get the defaultLanguageCode property: A value indicating which language code to use.String
getModelVersion()
Get the modelVersion property: The version of the model to use when calling the Text Analytics service.SentimentSkillVersion
getSkillVersion()
Gets the version of theSentimentSkill
.Boolean
isIncludeOpinionMining()
Get the includeOpinionMining property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text.SentimentSkill
setDefaultLanguageCode(SentimentSkillLanguage defaultLanguageCode)
Set the defaultLanguageCode property: A value indicating which language code to use.SentimentSkill
setIncludeOpinionMining(Boolean includeOpinionMining)
Set the includeOpinionMining property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text.SentimentSkill
setModelVersion(String modelVersion)
Set the modelVersion property: The version of the model to use when calling the Text Analytics service.-
Methods inherited from class com.azure.search.documents.indexes.models.SearchIndexerSkill
getContext, getDescription, getInputs, getName, getOutputs, setContext, setDescription, setName
-
-
-
-
Constructor Detail
-
SentimentSkill
public SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs)
Creates an instance of SentimentSkill class.- Parameters:
inputs
- the inputs value to set.outputs
- the outputs value to set.
-
SentimentSkill
public SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)
Creates an instance of SentimentSkill class.- Parameters:
inputs
- the inputs value to set.outputs
- the outputs value to set.version
- the SentimentSkillVersion value to set.
-
-
Method Detail
-
getSkillVersion
public SentimentSkillVersion getSkillVersion()
Gets the version of theSentimentSkill
.- Returns:
- The version of the
SentimentSkill
.
-
getDefaultLanguageCode
public SentimentSkillLanguage getDefaultLanguageCode()
Get the defaultLanguageCode property: A value indicating which language code to use. Default is en.- Returns:
- the defaultLanguageCode value.
-
setDefaultLanguageCode
public SentimentSkill setDefaultLanguageCode(SentimentSkillLanguage 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 SentimentSkill object itself.
-
isIncludeOpinionMining
public Boolean isIncludeOpinionMining()
Get the includeOpinionMining property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false.- Returns:
- the includeOpinionMining value.
-
setIncludeOpinionMining
public SentimentSkill setIncludeOpinionMining(Boolean includeOpinionMining)
Set the includeOpinionMining property: If set to true, the skill output will include information from Text Analytics for opinion mining, namely targets (nouns or verbs) and their associated assessment (adjective) in the text. Default is false.- Parameters:
includeOpinionMining
- the includeOpinionMining value to set.- Returns:
- the SentimentSkill object itself.
- Throws:
IllegalArgumentException
- IfincludeOpinionMining
is supplied whengetSkillVersion()
isSentimentSkillVersion.V1
.
-
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 SentimentSkill 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 SentimentSkill object itself.
- Throws:
IllegalArgumentException
- IfmodelVersion
is supplied whengetSkillVersion()
isSentimentSkillVersion.V1
.
-
-