com.ibm.watson.developer_cloud.tone_analyzer.v3

Class ToneAnalyzer

java.lang.Object

com.ibm.watson.developer_cloud.service.WatsonService

com.ibm.watson.developer_cloud.tone_analyzer.v3.ToneAnalyzer

public class ToneAnalyzer
extends WatsonService

The IBM Watson 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.

See Also:

Tone Analyzer

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION_DATE_2016_05_19 The Constant VERSION_DATE_2016_05_19.

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

defaultHeaders, MESSAGE_CODE, MESSAGE_ERROR, skipAuthentication, VERSION

Constructor Summary

Constructors

Constructor and Description
ToneAnalyzer(java.lang.String versionDate) Instantiates a new tone analyzer.
ToneAnalyzer(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new tone analyzer with username and password.

Method Summary

Modifier and Type	Method and Description
ServiceCall<UtterancesTone>	getChatTone(ToneChatRequest chatInput) Analyzes the "tone" of a list of utterances in a conversation.
ServiceCall<ToneAnalysis>	getTone(java.lang.String text, ToneOptions options) Analyzes the "tone" of a piece of text.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getToken, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Field Detail

VERSION_DATE_2016_05_19

public static final java.lang.String VERSION_DATE_2016_05_19

The Constant VERSION_DATE_2016_05_19.

See Also:

Constant Field Values

Constructor Detail

ToneAnalyzer

public ToneAnalyzer(java.lang.String versionDate)

Instantiates a new tone analyzer.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

ToneAnalyzer

public ToneAnalyzer(java.lang.String versionDate,
                    java.lang.String username,
                    java.lang.String password)

Instantiates a new tone analyzer with username and password.

Parameters:

versionDate - The version date (yyyy-MM-dd) of the REST API to use. Specifying this value will keep your API calls from failing when the service introduces breaking changes.

username - the username

password - the password

Method Detail

getTone

public ServiceCall<ToneAnalysis> getTone(java.lang.String text,
                                         ToneOptions options)

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

options - The ToneOptions options

Returns:

the ToneAnalysis with the response

getChatTone

public ServiceCall<UtterancesTone> getChatTone(ToneChatRequest chatInput)

Analyzes the "tone" of a list of utterances in a conversation. The text is analyzed from several chat tones, and confidence score is given back for tones which are present in the text

Parameters:

chatInput - The object which has the JSON to analyze

Returns:

the UtterancesTone with the response