com.ibm.watson.tone_analyzer.v3.model

Class DocumentAnalysis

java.lang.Object

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

com.ibm.watson.tone_analyzer.v3.model.DocumentAnalysis

All Implemented Interfaces:

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

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

The results of the analysis for the full input content.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<ToneCategory>	toneCategories
protected java.util.List<ToneScore>	tones
protected java.lang.String	warning

Constructor Summary

Constructors

Constructor and Description
DocumentAnalysis()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ToneCategory>	getToneCategories() Gets the toneCategories.
java.util.List<ToneScore>	getTones() Gets the tones.
java.lang.String	getWarning() Gets the warning.

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

tones

protected java.util.List<ToneScore> tones

toneCategories

@SerializedName(value="tone_categories")
protected java.util.List<ToneCategory> toneCategories

warning

protected java.lang.String warning

Constructor Detail

DocumentAnalysis

public DocumentAnalysis()

Method Detail

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 document. 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 full document of the input content. The service returns results only for the tones specified with the `tones` parameter of the request.

Returns:

the toneCategories

getWarning

public java.lang.String getWarning()

Gets the warning.

**`2017-09-21`:** A warning message if the overall content exceeds 128 KB or contains more than 1000 sentences. The service analyzes only the first 1000 sentences for document-level analysis and the first 100 sentences for sentence-level analysis. **`2016-05-19`:** Not returned.

Returns:

the warning