ToneParams | ibm-watson

Parameters for the tone operation.

Hierarchy

ToneParams

Index

Properties

Optional acceptLanguage

acceptLanguage: AcceptLanguage | string

The desired language of the response. For two-character arguments, regional variants are treated as their parent language; for example, en-US is interpreted as en. You can use different languages for Content-Language and Accept-Language.

Optional contentLanguage

contentLanguage: ContentLanguage | string

The language of the input text for the request: English or French. Regional variants are treated as their parent language; for example, en-US is interpreted as en. The input content must match the specified language. Do not submit content that contains both languages. You can use different languages for Content-Language and Accept-Language.

2017-09-21: Accepts en or fr.
2016-05-19: Accepts only en.

Optional contentType

contentType: ContentType | string

The type of the input. A character encoding can be specified by including a charset parameter. For example, 'text/plain;charset=utf-8'.

Optional headers

headers: OutgoingHttpHeaders

Optional sentences

sentences: boolean

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.

toneInput

toneInput: ToneInput | string

JSON, plain text, or HTML input that contains the content to be analyzed. For JSON input, provide an object of type ToneInput.

Optional tones

tones: Tones[] | string[]

2017-09-21:* Deprecated. The service continues to accept the parameter for backward-compatibility, but the parameter no longer affects the response.

2016-05-19: 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 valid values. Omit the parameter to request results for all three tones.