Package 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.

Constructor Summary

Constructors

Constructor	Description
DocumentAnalysis()

Method Summary

Modifier and Type	Method	Description
List<ToneCategory>	getToneCategories()	Gets the toneCategories.
List<ToneScore>	getTones()	Gets the tones.
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

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

DocumentAnalysis

public DocumentAnalysis()

Method Details

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 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 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 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