java.lang.Object
com.ibm.cloud.sdk.core.service.model.GenericModel
com.ibm.watson.text_to_speech.v1.model.Prompt
All Implemented Interfaces:
com.ibm.cloud.sdk.core.service.model.ObjectModel

public class Prompt
extends com.ibm.cloud.sdk.core.service.model.GenericModel
Information about a custom prompt.
  • Constructor Details

    • Prompt

      public Prompt()
  • Method Details

    • getPrompt

      public String getPrompt()
      Gets the prompt.

      The user-specified text of the prompt.

      Returns:
      the prompt
    • getPromptId

      public String getPromptId()
      Gets the promptId.

      The user-specified identifier (name) of the prompt.

      Returns:
      the promptId
    • getStatus

      public String getStatus()
      Gets the status.

      The status of the prompt: * `processing`: The service received the request to add the prompt and is analyzing the validity of the prompt. * `available`: The service successfully validated the prompt, which is now ready for use in a speech synthesis request. * `failed`: The service's validation of the prompt failed. The status of the prompt includes an `error` field that describes the reason for the failure.

      Returns:
      the status
    • getError

      public String getError()
      Gets the error.

      If the status of the prompt is `failed`, an error message that describes the reason for the failure. The field is omitted if no error occurred.

      Returns:
      the error
    • getSpeakerId

      public String getSpeakerId()
      Gets the speakerId.

      The speaker ID (GUID) of the speaker for which the prompt was defined. The field is omitted if no speaker ID was specified.

      Returns:
      the speakerId