Enum Prompt 

pub enum Prompt {
    Text(String),
    Audio {
        audio: String,
        transcript: Option<String>,
    },
}

What a component speaks: TTS text (a bare string) or a reference to a pre-rendered audio asset shipped alongside the flow.

JSON schema

{
 "description": "What a component speaks: TTS text (a bare string) or a reference to a pre-rendered audio asset shipped alongside the flow.",
 "oneOf": [
   {
     "title": "Text",
     "type": "string"
   },
   {
     "title": "Audio",
     "type": "object",
     "required": [
       "audio"
     ],
     "properties": {
       "audio": {
         "description": "Audio asset ref. A generated-clip ref is a voice_prompts id matching ^vprompt_[a-z0-9]+$.",
         "type": "string"
       },
       "transcript": {
         "description": "The words this pre-rendered clip speaks — the text it was synthesized from — carried so a viewer can show what a caller hears, and for traces. Advisory only: playback always uses `audio`, never this. Optional and forward-added: absent on older documents and on refs the platform did not generate from text.",
         "type": "string"
       }
     }
   }
 ]
}

Variants

Text(String)

Audio

Fields

audio: String

Audio asset ref. A generated-clip ref is a voice_prompts id matching ^vprompt_[a-z0-9]+$.

transcript: Option<String>

The words this pre-rendered clip speaks — the text it was synthesized from — carried so a viewer can show what a caller hears, and for traces. Advisory only: playback always uses audio, never this. Optional and forward-added: absent on older documents and on refs the platform did not generate from text.

Implementations

impl Prompt

pub fn as_text(&self) -> Option<&str>

The synthesizable text: Some for a bare-string prompt the engine speaks with TTS, None for an audio-asset prompt it plays as a clip. This drives playback branching and the length cap — an audio prompt’s transcript, when present, is not returned here (it is display text, not something to synthesize or bound). For the human-readable words either kind speaks, use Prompt::transcript.

pub fn transcript(&self) -> Option<&str>

The human-readable words this prompt speaks, for display (a “what the caller hears” transcript) and traces — regardless of how it is voiced. A text prompt is its own transcript; an audio prompt carries the text it was synthesized from in transcript, None when the document omits it (older flows, or a ref not generated from text). Unlike as_text, this is never used to decide playback or enforce the length cap.

Trait Implementations

impl Clone for Prompt

fn clone(&self) -> Prompt

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Prompt

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Prompt

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Prompt> for Prompt

fn from(value: &Prompt) -> Self

Converts to this type from the input type.

impl Serialize for Prompt

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.