com.ibm.watson.tone_analyzer.v3.model

Class ToneScore

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.tone_analyzer.v3.model.ToneScore

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class ToneScore
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The score for a tone from the input content.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Double	score
protected java.lang.String	toneId
protected java.lang.String	toneName

Constructor Summary

Constructors

Constructor and Description
ToneScore()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Double	getScore() Gets the score.
java.lang.String	getToneId() Gets the toneId.
java.lang.String	getToneName() Gets the toneName.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

score

protected java.lang.Double score

toneId

@SerializedName(value="tone_id")
protected java.lang.String toneId

toneName

@SerializedName(value="tone_name")
protected java.lang.String toneName

Constructor Detail

ToneScore

public ToneScore()

Method Detail

getScore

public java.lang.Double getScore()

Gets the score.

The score for the tone. * **`2017-09-21`:** The score that is returned lies in the range of 0.5 to 1. A score greater than 0.75 indicates a high likelihood that the tone is perceived in the content. * **`2016-05-19`:** The score that is returned lies in the range of 0 to 1. A score less than 0.5 indicates that the tone is unlikely to be perceived in the content; a score greater than 0.75 indicates a high likelihood that the tone is perceived.

Returns:

the score

getToneId

public java.lang.String getToneId()

Gets the toneId.

The unique, non-localized identifier of the tone. * **`2017-09-21`:** The service can return results for the following tone IDs: `anger`, `fear`, `joy`, and `sadness` (emotional tones); `analytical`, `confident`, and `tentative` (language tones). The service returns results only for tones whose scores meet a minimum threshold of 0.5. * **`2016-05-19`:** The service can return results for the following tone IDs of the different categories: for the `emotion` category: `anger`, `disgust`, `fear`, `joy`, and `sadness`; for the `language` category: `analytical`, `confident`, and `tentative`; for the `social` category: `openness_big5`, `conscientiousness_big5`, `extraversion_big5`, `agreeableness_big5`, and `emotional_range_big5`. The service returns scores for all tones of a category, regardless of their values.

Returns:

the toneId

getToneName

public java.lang.String getToneName()

Gets the toneName.

The user-visible, localized name of the tone.

Returns:

the toneName