com.ibm.watson.tone_analyzer.v3.model

Class UtteranceAnalysis

java.lang.Object

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

com.ibm.watson.tone_analyzer.v3.model.UtteranceAnalysis

All Implemented Interfaces:

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

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

The results of the analysis for an utterance of the input content.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	error
protected java.util.List<ToneChatScore>	tones
protected java.lang.Long	utteranceId
protected java.lang.String	utteranceText

Constructor Summary

Constructors

Constructor and Description
UtteranceAnalysis()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getError() Gets the error.
java.util.List<ToneChatScore>	getTones() Gets the tones.
java.lang.Long	getUtteranceId() Gets the utteranceId.
java.lang.String	getUtteranceText() Gets the utteranceText.

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

utteranceId

@SerializedName(value="utterance_id")
protected java.lang.Long utteranceId

utteranceText

@SerializedName(value="utterance_text")
protected java.lang.String utteranceText

tones

protected java.util.List<ToneChatScore> tones

error

protected java.lang.String error

Constructor Detail

UtteranceAnalysis

public UtteranceAnalysis()

Method Detail

getUtteranceId

public java.lang.Long getUtteranceId()

Gets the utteranceId.

The unique identifier of the utterance. The first utterance has ID 0, and the ID of each subsequent utterance is incremented by one.

Returns:

the utteranceId

getUtteranceText

public java.lang.String getUtteranceText()

Gets the utteranceText.

The text of the utterance.

Returns:

the utteranceText

getTones

public java.util.List<ToneChatScore> getTones()

Gets the tones.

An array of `ToneChatScore` objects that provides results for the most prevalent tones of the utterance. The array includes results for any tone whose score is at least 0.5. The array is empty if no tone has a score that meets this threshold.

Returns:

the tones

getError

public java.lang.String getError()

Gets the error.

**`2017-09-21`:** An error message if the utterance contains more than 500 characters. The service does not analyze the utterance. **`2016-05-19`:** Not returned.

Returns:

the error