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

Author:

German Attanasio Ruiz (germanatt@us.ibm.com)

See Also:

Tone Analyzer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT
static String	HOPS
static String	LIMIT
static String	SCORECARD
static String	TEXT
static String	TRAITS
static String	WORDS

Constructor Summary

Constructors

Constructor and Description
ToneAnalyzer() Instantiates a new Tone Analyzer service with the default url

Method Summary

Modifier and Type	Method and Description
List<SynonymResult>	getSynonyms(Map<String,Object> params) 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

execute, executeWithoutResponse, getApiKey, getDefaultContentType, getDefaultRequestParams, getEndPoint, getGson, getHttpClient, getThreadSafeClient, setApiKey, setEndPoint, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Field Detail

HOPS

public static final String HOPS

See Also:

Constant Field Values

LIMIT

public static final String LIMIT

See Also:

Constant Field Values

CONTEXT

public static final String CONTEXT

See Also:

Constant Field Values

TRAITS

public static final String TRAITS

See Also:

Constant Field Values

WORDS

public static final String WORDS

See Also:

Constant Field Values

TEXT

public static final String TEXT

See Also:

Constant Field Values

SCORECARD

public static final String SCORECARD

See Also:

Constant Field Values

Constructor Detail

ToneAnalyzer

public ToneAnalyzer()

Instantiates a new Tone Analyzer service with the default url

Method Detail

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

getSynonyms

public List<SynonymResult> getSynonyms(Map<String,Object> params)

Starts or continue conversations.

Parameters:

words - (string[]),

traits - (string[], optional),

limit - (long, optional) Limits the number of words to return on each trait. The most heavily correlated (positive and negative) to each trait are returned; approximately limit/2 each of positively correlated words negatively correlated words if there are enough available.

hops - (long, optional): The number of 'hops' to explore for synonyms or related words: 0 indicates words directly related to the input; 1 gives words related to them, and so on. The greater this number, the richer the word set returned (but at the same time, less tightly related to the input).

context - (string[], optional)

index - (long, optional): The position (0-based) in `context` parameter where the requested word appears. This parameter can only be passed when `context` is also present and there is only one word requested (length(`words`)=0), and it makes sense only if `context[index]` is equal to `words[0]`.

params - The map with the parameters described above

Returns:

SynonymResult