com.ibm.watson.developer_cloud.tone_analyzer.v3.model

Class SentenceAnalysis

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

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

All Implemented Interfaces:

ObjectModel

public class SentenceAnalysis
extends GenericModel

SentenceAnalysis.

Constructor Summary

Constructors

Constructor and Description
SentenceAnalysis()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Long	getInputFrom() Gets the inputFrom.
java.lang.Long	getInputTo() Gets the inputTo.
java.lang.Long	getSentenceId() Gets the sentenceId.
java.lang.String	getText() Gets the text.
java.util.List<ToneCategory>	getToneCategories() Gets the toneCategories.
java.util.List<ToneScore>	getTones() Gets the tones.
void	setInputFrom(long inputFrom) Sets the inputFrom.
void	setInputTo(long inputTo) Sets the inputTo.
void	setSentenceId(long sentenceId) Sets the sentenceId.
void	setText(java.lang.String text) Sets the text.
void	setToneCategories(java.util.List<ToneCategory> toneCategories) Sets the toneCategories.
void	setTones(java.util.List<ToneScore> tones) Sets the tones.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

SentenceAnalysis

public SentenceAnalysis()

Method Detail

getSentenceId

public java.lang.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 java.lang.String getText()

Gets the text. The text of the input sentence.

Returns:

the text

getTones

public java.util.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 java.util.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 java.lang.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 java.lang.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

setSentenceId

public void setSentenceId(long sentenceId)

Sets the sentenceId.

Parameters:

sentenceId - the new sentenceId

setText

public void setText(java.lang.String text)

Sets the text.

Parameters:

text - the new text

setTones

public void setTones(java.util.List<ToneScore> tones)

Sets the tones.

Parameters:

tones - the new tones

setToneCategories

public void setToneCategories(java.util.List<ToneCategory> toneCategories)

Sets the toneCategories.

Parameters:

toneCategories - the new toneCategories

setInputFrom

public void setInputFrom(long inputFrom)

Sets the inputFrom.

Parameters:

inputFrom - the new inputFrom

setInputTo

public void setInputTo(long inputTo)

Sets the inputTo.

Parameters:

inputTo - the new inputTo