Prompt

Information about a custom prompt.

Index

error: string

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.

prompt: string

The user-specified text of the prompt.

prompt_id: string

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

speaker_id: string

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

status: string

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.