com.ibm.watson.developer_cloud.tone_analyzer.v3.model

Class ToneOptions

java.lang.Object

com.ibm.watson.developer_cloud.service.model.GenericModel

com.ibm.watson.developer_cloud.tone_analyzer.v3.model.ToneOptions

All Implemented Interfaces:

ObjectModel

public class ToneOptions
extends GenericModel

The tone options.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ToneOptions.Builder Builder.
static interface	ToneOptions.ContentType The type of the input: application/json, text/plain, or text/html.
static interface	ToneOptions.Tone

Method Summary

Modifier and Type	Method and Description
java.lang.String	body() Gets the body.
java.lang.String	contentType() Gets the contentType.
ToneOptions.Builder	newBuilder() New builder.
java.lang.Boolean	sentences() Gets the sentences.
ToneInput	toneInput() Gets the toneInput.
java.util.List<java.lang.String>	tones() Gets the tones.

Methods inherited from class com.ibm.watson.developer_cloud.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public ToneOptions.Builder newBuilder()

New builder.

Returns:

a ToneOptions builder

toneInput

public ToneInput toneInput()

Gets the toneInput. JSON, plain text, or HTML input that contains the content to be analyzed. For JSON input, provide an object of type `ToneInput`. Submit a maximum of 128 KB of content. Sentences with fewer than three words cannot be analyzed.

Returns:

the toneInput

body

public java.lang.String body()

Gets the body. JSON, plain text, or HTML input that contains the content to be analyzed. For JSON input, provide an object of type `ToneInput`. Submit a maximum of 128 KB of content. Sentences with fewer than three words cannot be analyzed.

Returns:

the body

contentType

public java.lang.String contentType()

Gets the contentType. The type of the input: application/json, text/plain, or text/html. A character encoding can be specified by including a `charset` parameter. For example, 'text/plain;charset=utf-8'.

Returns:

the contentType

tones

public java.util.List<java.lang.String> tones()

Gets the tones. A comma-separated list of tones for which the service is to return its analysis of the input; the indicated tones apply both to the full document and to individual sentences of the document. You can specify one or more of the following values: `emotion`, `language`, and `social`. Omit the parameter to request results for all three tones.

Returns:

the tones

sentences

public java.lang.Boolean sentences()

Gets the sentences. Indicates whether the service is to return an analysis of each individual sentence in addition to its analysis of the full document. If `true` (the default), the service returns results for each sentence. The service returns results only for the first 100 sentences of the input.

Returns:

the sentences