com.ibm.watson.tone_analyzer.v3.model

Class SentenceAnalysis

java.lang.Object

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

com.ibm.watson.tone_analyzer.v3.model.SentenceAnalysis

All Implemented Interfaces:

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

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

The results of the analysis for the individual sentences of the input content.

Constructor Summary

Constructors

Constructor and Description
SentenceAnalysis()

Method Summary

Modifier and Type	Method and Description
Long	getInputFrom() Gets the inputFrom.
Long	getInputTo() Gets the inputTo.
Long	getSentenceId() Gets the sentenceId.
String	getText() Gets the text.
List<ToneCategory>	getToneCategories() Gets the toneCategories.
List<ToneScore>	getTones() Gets the tones.

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

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SentenceAnalysis

public SentenceAnalysis()

Method Detail

getSentenceId

public Long getSentenceId()

Gets the sentenceId.

The unique identifier of a sentence of the input content. The first sentence has ID 0, and the ID of each subsequent sentence is incremented by one.

Returns:

the sentenceId

getText

public String getText()

Gets the text.

The text of the input sentence.

Returns:

the text

getTones

public List<ToneScore> getTones()

Gets the tones.

**`2017-09-21`:** An array of `ToneScore` objects that provides the results of the analysis for each qualifying tone of the sentence. 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. **`2016-05-19`:** Not returned.

Returns:

the tones

getToneCategories

public List<ToneCategory> getToneCategories()

Gets the toneCategories.

**`2017-09-21`:** Not returned. **`2016-05-19`:** An array of `ToneCategory` objects that provides the results of the tone analysis for the sentence. The service returns results only for the tones specified with the `tones` parameter of the request.

Returns:

the toneCategories

getInputFrom

public Long getInputFrom()

Gets the inputFrom.

**`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the first character of the sentence in the overall input content.

Returns:

the inputFrom

getInputTo

public Long getInputTo()

Gets the inputTo.

**`2017-09-21`:** Not returned. **`2016-05-19`:** The offset of the last character of the sentence in the overall input content.

Returns:

the inputTo