Struct ServerMessageVoiceRequest

pub struct ServerMessageVoiceRequest {
    pub phone_number: Option<ClientMessageWorkflowNodeStartedPhoneNumber>,
    pub type: TypeTrue,
    pub timestamp: Option<f64>,
    pub artifact: Option<Artifact>,
    pub assistant: Option<CreateAssistantDto>,
    pub customer: Option<CreateCustomerDto>,
    pub call: Option<Call>,
    pub chat: Option<Chat>,
    pub text: String,
    pub sample_rate: f64,
}

Fields

phone_number: Option<ClientMessageWorkflowNodeStartedPhoneNumber>

type: TypeTrue

This is the type of the message. "voice-request" is sent when using assistant.voice={ \"type\": \"custom-voice\" }. Here is what the request will look like: POST https://{assistant.voice.server.url} Content-Type: application/json { "messsage": { "type": "voice-request", "text": "Hello, world!", "sampleRate": 24000, …other metadata about the call… } } The expected response is 1-channel 16-bit raw PCM audio at the sample rate specified in the request. Here is how the response will be piped to the transport: response.on('data', (chunk: Buffer) => { outputStream.write(chunk); });

timestamp: Option<f64>

This is the timestamp of the message.

artifact: Option<Artifact>

This is a live version of the call.artifact. This matches what is stored on call.artifact after the call.

assistant: Option<CreateAssistantDto>

This is the assistant that the message is associated with.

customer: Option<CreateCustomerDto>

This is the customer that the message is associated with.

call: Option<Call>

This is the call that the message is associated with.

chat: Option<Chat>

This is the chat object.

text: String

This is the text to be synthesized.

sample_rate: f64

This is the sample rate to be synthesized.

Implementations

impl ServerMessageVoiceRequest

pub fn new( type: TypeTrue, text: String, sample_rate: f64, ) -> ServerMessageVoiceRequest

Trait Implementations

impl Clone for ServerMessageVoiceRequest

fn clone(&self) -> ServerMessageVoiceRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ServerMessageVoiceRequest

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

Formats the value using the given formatter.

impl Default for ServerMessageVoiceRequest

fn default() -> ServerMessageVoiceRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ServerMessageVoiceRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ServerMessageVoiceRequest

fn eq(&self, other: &ServerMessageVoiceRequest) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ServerMessageVoiceRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ServerMessageVoiceRequest