Class SentimentSkill
java.lang.Object
com.azure.search.documents.indexes.models.SearchIndexerSkill
com.azure.search.documents.indexes.models.SentimentSkill
Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.
-
Constructor Summary
ConstructorDescriptionSentimentSkill
(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
Modifier and TypeMethodDescriptionGet the defaultLanguageCode property: A value indicating which language code to use.Get the modelVersion property: The version of the model to use when calling the Text Analytics service.Gets the version of theSentimentSkill
.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.setDefaultLanguageCode
(SentimentSkillLanguage defaultLanguageCode) Set the defaultLanguageCode property: A value indicating which language code to use.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.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 Details
-
SentimentSkill
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 Details
-
getSkillVersion
Gets the version of theSentimentSkill
.- Returns:
- The version of the
SentimentSkill
.
-
getDefaultLanguageCode
Get the defaultLanguageCode property: A value indicating which language code to use. Default is en.- Returns:
- the defaultLanguageCode value.
-
setDefaultLanguageCode
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
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
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
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
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
.
-