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 and language tones in written text. The service can analyze tone at both the document and sentence levels. You can use the service to understand how your written communications are perceived and then to improve the tone of your communications. Businesses can use the service to learn the tone of their customers' communications and to respond to each customer appropriately, or to understand and improve their customer conversations. **Note:** Request logging is disabled for the Tone Analyzer service. The service neither logs nor retains data from requests and responses, regardless of whether the `X-Watson-Learning-Opt-Out` request header is set.

See Also:

Tone Analyzer

Field Summary

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 `ToneAnalyzer`.
ToneAnalyzer(java.lang.String versionDate, IamOptions iamOptions) Instantiates a new `ToneAnalyzer` with IAM.
ToneAnalyzer(java.lang.String versionDate, java.lang.String username, java.lang.String password) Instantiates a new `ToneAnalyzer` with username and password.

Method Summary

Methods

Modifier and Type	Method and Description
ServiceCall<ToneAnalysis>	tone(ToneOptions toneOptions) Analyze general tone.
ServiceCall<UtteranceAnalyses>	toneChat(ToneChatOptions toneChatOptions) Analyze customer engagement tone.

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

configureHttpClient, createServiceCall, getApiKey, getEndPoint, getName, getPassword, getToken, getUsername, isTokenManagerSet, processServiceCall, setApiKey, setAuthentication, setDefaultHeaders, setDefaultHeaders, setEndPoint, setIamCredentials, setSkipAuthentication, setUsernameAndPassword, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ToneAnalyzer

public ToneAnalyzer(java.lang.String versionDate)

Instantiates a new `ToneAnalyzer`.

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

ToneAnalyzer

public ToneAnalyzer(java.lang.String versionDate,
            IamOptions iamOptions)

Instantiates a new `ToneAnalyzer` with IAM. Note that if the access token is specified in the iamOptions, you accept responsibility for managing the access token yourself. You must set a new access token before this one expires or after receiving a 401 error from the service. Failing to do so will result in authentication errors after this token expires.

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.

iamOptions - the options for authenticating through IAM

Method Detail

tone

public ServiceCall<ToneAnalysis> tone(ToneOptions toneOptions)

Analyze general tone. Use the general purpose endpoint to analyze the tone of your input content. The service analyzes the content for emotional and language tones. The method always analyzes the tone of the full document; by default, it also analyzes the tone of each individual sentence of the content. You can submit no more than 128 KB of total input content and no more than 1000 individual sentences in JSON, plain text, or HTML format. The service analyzes the first 1000 sentences for document-level analysis and only the first 100 sentences for sentence-level analysis. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8; per the HTTP specification, the default encoding for plain text and HTML is ISO-8859-1 (effectively, the ASCII character set). When specifying a content type of plain text or HTML, include the `charset` parameter to indicate the character encoding of the input text; for example: `Content-Type: text/plain;charset=utf-8`. For `text/html`, the service removes HTML tags and analyzes only the textual content.

Parameters:

toneOptions - the ToneOptions containing the options for the call

Returns:

a ServiceCall with a response type of ToneAnalysis

toneChat

public ServiceCall<UtteranceAnalyses> toneChat(ToneChatOptions toneChatOptions)

Analyze customer engagement tone. Use the customer engagement endpoint to analyze the tone of customer service and customer support conversations. For each utterance of a conversation, the method reports the most prevalent subset of the following seven tones: sad, frustrated, satisfied, excited, polite, impolite, and sympathetic. If you submit more than 50 utterances, the service returns a warning for the overall content and analyzes only the first 50 utterances. If you submit a single utterance that contains more than 500 characters, the service returns an error for that utterance and does not analyze the utterance. The request fails if all utterances have more than 500 characters. Per the JSON specification, the default character encoding for JSON content is effectively always UTF-8.

Parameters:

toneChatOptions - the ToneChatOptions containing the options for the call

Returns:

a ServiceCall with a response type of UtteranceAnalyses