Package com.azure.search.documents.indexes.models

Class SentimentSkill

java.lang.Object

com.azure.search.documents.indexes.models.SearchIndexerSkill

com.azure.search.documents.indexes.models.SentimentSkill

All Implemented Interfaces:

com.azure.json.JsonSerializable<SearchIndexerSkill>

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)	Deprecated. Use SentimentSkill(List, List, SentimentSkillVersion) as SentimentSkillVersion.V1 is deprecated.
SentimentSkill(List<InputFieldMappingEntry> inputs, List<OutputFieldMappingEntry> outputs, SentimentSkillVersion version)	Creates an instance of SentimentSkill class.

Method Summary

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 the SentimentSkill.
Boolean	isOpinionMiningIncluded()	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	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).
SentimentSkill	setDefaultLanguageCode(SentimentSkillLanguage defaultLanguageCode)	Set the defaultLanguageCode property: A value indicating which language code to use.
SentimentSkill	setDescription(String description)	Set the description property: The description of the skill which describes the inputs, outputs, and usage of the skill.
SentimentSkill	setModelVersion(String modelVersion)	Set the modelVersion property: The version of the model to use when calling the Text Analytics service.
SentimentSkill	setName(String name)	Set the name property: The name of the skill which uniquely identifies it within the skillset.
SentimentSkill	setOpinionMiningIncluded(Boolean opinionMiningIncluded)	Set the opinionMiningIncluded 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.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class com.azure.search.documents.indexes.models.SearchIndexerSkill

fromJson, getContext, getDescription, getInputs, getName, getOdataType, getOutputs

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.azure.json.JsonSerializable

toJson, toJson, toJsonBytes, toJsonString

Constructor Details

SentimentSkill

@Deprecated
public SentimentSkill(List<InputFieldMappingEntry> inputs,
 List<OutputFieldMappingEntry> outputs)

Deprecated.

Use SentimentSkill(List, List, SentimentSkillVersion) as SentimentSkillVersion.V1 is deprecated. See skill deprecation for more information.

Creates an instance of SentimentSkill class.

The instance of SentimentSkill uses SentimentSkillVersion.V1, to set the specific version of the skill use SentimentSkill(List, List, SentimentSkillVersion).

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.

Throws:

NullPointerException - If version is null.

Method Details

getSkillVersion

public SentimentSkillVersion getSkillVersion()

Gets the version of the SentimentSkill.

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.

isOpinionMiningIncluded

public Boolean isOpinionMiningIncluded()

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.

setOpinionMiningIncluded

public SentimentSkill setOpinionMiningIncluded(Boolean opinionMiningIncluded)

Set the opinionMiningIncluded 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:

opinionMiningIncluded - the opinionMiningIncluded value to set.

Returns:

the SentimentSkill object itself.

Throws:

IllegalArgumentException - If opinionMiningIncluded is supplied when getSkillVersion() is SentimentSkillVersion.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 - If modelVersion is supplied when getSkillVersion() is SentimentSkillVersion.V1.

setName

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

setName in class SearchIndexerSkill

Parameters:

name - the name value to set.

Returns:

the SearchIndexerSkill object itself.

setDescription

public SentimentSkill setDescription(String description)

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

Overrides:

setDescription in class SearchIndexerSkill

Parameters:

description - the description value to set.

Returns:

the SearchIndexerSkill object itself.

setContext

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

setContext in class SearchIndexerSkill

Parameters:

context - the context value to set.

Returns:

the SearchIndexerSkill object itself.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Description copied from class: SearchIndexerSkill

Specified by:

toJson in interface com.azure.json.JsonSerializable<SearchIndexerSkill>

Overrides:

toJson in class SearchIndexerSkill

Throws:

IOException