com.ibm.watson.tone_analyzer.v3.model

Class ToneAnalysis

java.lang.Object

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

com.ibm.watson.tone_analyzer.v3.model.ToneAnalysis

All Implemented Interfaces:

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

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

The tone analysis results for the input from the general-purpose endpoint.

Field Summary

Fields

Modifier and Type	Field and Description
protected DocumentAnalysis	documentTone
protected java.util.List<SentenceAnalysis>	sentencesTone

Constructor Summary

Constructors

Constructor and Description
ToneAnalysis()

Method Summary

Methods

Modifier and Type	Method and Description
DocumentAnalysis	getDocumentTone() Gets the documentTone.
java.util.List<SentenceAnalysis>	getSentencesTone() Gets the sentencesTone.

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

documentTone

@SerializedName(value="document_tone")
protected DocumentAnalysis documentTone

sentencesTone

@SerializedName(value="sentences_tone")
protected java.util.List<SentenceAnalysis> sentencesTone

Constructor Detail

ToneAnalysis

public ToneAnalysis()

Method Detail

getDocumentTone

public DocumentAnalysis getDocumentTone()

Gets the documentTone.

The results of the analysis for the full input content.

Returns:

the documentTone

getSentencesTone

public java.util.List<SentenceAnalysis> getSentencesTone()

Gets the sentencesTone.

An array of `SentenceAnalysis` objects that provides the results of the analysis for the individual sentences of the input content. The service returns results only for the first 100 sentences of the input. The field is omitted if the `sentences` parameter of the request is set to `false`.

Returns:

the sentencesTone