com.ibm.watson.developer_cloud.tone_analyzer.v1

Class ToneAnalyzer

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.tone_analyzer.v1.ToneAnalyzer

public class ToneAnalyzer
extends WatsonService

The IBM Watson The Tone Analyzer service uses linguistic analysis to detect emotional tones, social propensities, and writing styles in written communication. Then it offers suggestions to help the writer improve their intended language tones.

Version:

v1

See Also:

Tone Analyzer

Field Summary

Fields inherited from class com.ibm.watson.developer_cloud.service.WatsonService

VERSION

Constructor Summary

Constructors

Constructor and Description
ToneAnalyzer() Instantiates a new Tone Analyzer service.

Method Summary

Modifier and Type	Method and Description
List<Scorecard>	getScorecards() Returns the Scorecards.
List<SynonymResult>	getSynonyms(SynonymOptions options) Starts or continue conversations.
Tone	getTone(String text) Analyzes the "tone" of a piece of text using the default scorecard.
Tone	getTone(String text, Scorecard scorecard) Analyzes the "tone" of a piece of text.

Methods inherited from class com.ibm.watson.developer_cloud.service.WatsonService

configureHttpClient, execute, executeRequest, executeWithoutResponse, getApiKey, getEndPoint, getName, getToken, setApiKey, setAuthentication, setDefaultHeaders, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ToneAnalyzer

public ToneAnalyzer()

Instantiates a new Tone Analyzer service.

Method Detail

getSynonyms

public List<SynonymResult> getSynonyms(SynonymOptions options)

Starts or continue conversations.

Parameters:

options - the request options

Returns:

SynonymResult

getTone

public Tone getTone(String text)

Analyzes the "tone" of a piece of text using the default scorecard. The message is analyzed from several tones (social tone, emotional tone, writing tone), and for each of them various traits are derived (such as conscientiousness, agreeableness, openness).

Parameters:

text - The text to analyze

Returns:

the Tone with the response

getTone

public Tone getTone(String text,
                    Scorecard scorecard)

Analyzes the "tone" of a piece of text. The message is analyzed from several tones (social tone, emotional tone, writing tone), and for each of them various traits are derived (such as conscientiousness, agreeableness, openness).

Parameters:

text - The text to analyze

scorecard - Name of the scorecard used to compute the tone. (business messages by default)

Returns:

the Tone with the response

getScorecards

public List<Scorecard> getScorecards()

Returns the Scorecards.

Returns:

the list of scorecard