Package com.ibm.watson.text_to_speech.v1.model

Class PromptMetadata

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.watson.text_to_speech.v1.model.PromptMetadata

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class PromptMetadata
extends com.ibm.cloud.sdk.core.service.model.GenericModel

Information about the prompt that is to be added to a custom model. The following example of a `PromptMetadata` object includes both the required prompt text and an optional speaker model ID:

`{ "prompt_text": "Thank you and good-bye!", "speaker_id": "823068b2-ed4e-11ea-b6e0-7b6456aa95cc" }`.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PromptMetadata.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
PromptMetadata.Builder	newBuilder()	New builder.
String	promptText()	Gets the promptText.
String	speakerId()	Gets the speakerId.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Details

newBuilder

public PromptMetadata.Builder newBuilder()

New builder.

Returns:

a PromptMetadata builder

promptText

public String promptText()

Gets the promptText.

The required written text of the spoken prompt. The length of a prompt's text is limited to a few sentences. Speaking one or two sentences of text is the recommended limit. A prompt cannot contain more than 1000 characters of text. Escape any XML control characters (double quotes, single quotes, ampersands, angle brackets, and slashes) that appear in the text of the prompt.

Returns:

the promptText

speakerId

public String speakerId()

Gets the speakerId.

The optional speaker ID (GUID) of a previously defined speaker model that is to be associated with the prompt.

Returns:

the speakerId