Struct TransferCallTool

pub struct TransferCallTool {
    pub async: Option<bool>,
    pub messages: Option<Vec<CreateDtmfToolDtoMessagesInner>>,
    pub type: Type,
    pub destinations: Option<Vec<CreateTransferCallToolDtoDestinationsInner>>,
    pub id: String,
    pub org_id: String,
    pub created_at: String,
    pub updated_at: String,
    pub function: Option<Box<OpenAiFunction>>,
    pub server: Option<Box<Server>>,
}

Fields

async: Option<bool>

This determines if the tool is async. If async, the assistant will move forward without waiting for your server to respond. This is useful if you just want to trigger something on your server. If sync, the assistant will wait for your server to respond. This is useful if want assistant to respond with the result from your server. Defaults to synchronous (false).

messages: Option<Vec<CreateDtmfToolDtoMessagesInner>>

These are the messages that will be spoken to the user as the tool is running. For some tools, this is auto-filled based on special fields like tool.destinations. For others like the function tool, these can be custom configured.

type: Type

destinations: Option<Vec<CreateTransferCallToolDtoDestinationsInner>>

These are the destinations that the call can be transferred to. If no destinations are provided, server.url will be used to get the transfer destination once the tool is called.

id: String

This is the unique identifier for the tool.

org_id: String

This is the unique identifier for the organization that this tool belongs to.

created_at: String

This is the ISO 8601 date-time string of when the tool was created.

updated_at: String

This is the ISO 8601 date-time string of when the tool was last updated.

function: Option<Box<OpenAiFunction>>

This is the function definition of the tool. For endCall, transferCall, and dtmf tools, this is auto-filled based on tool-specific fields like tool.destinations. But, even in those cases, you can provide a custom function definition for advanced use cases. An example of an advanced use case is if you want to customize the message that’s spoken for endCall tool. You can specify a function where it returns an argument "reason". Then, in messages array, you can have many "request-complete" messages. One of these messages will be triggered if the messages[].conditions matches the "reason" argument.

server: Option<Box<Server>>

This is the server that will be hit when this tool is requested by the model. All requests will be sent with the call object among other things. You can find more details in the Server URL documentation. This overrides the serverUrl set on the org and the phoneNumber. Order of precedence: highest tool.server.url, then assistant.serverUrl, then phoneNumber.serverUrl, then org.serverUrl.

Implementations

impl TransferCallTool

pub fn new( type: Type, id: String, org_id: String, created_at: String, updated_at: String, ) -> TransferCallTool

Trait Implementations

impl Clone for TransferCallTool

fn clone(&self) -> TransferCallTool

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransferCallTool

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

Formats the value using the given formatter.

impl Default for TransferCallTool

fn default() -> TransferCallTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransferCallTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TransferCallTool

fn eq(&self, other: &TransferCallTool) -> 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 TransferCallTool

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 TransferCallTool