Struct FunctionTool

pub struct FunctionTool {
    pub messages: Option<Vec<CreateDtmfToolDtoMessagesInner>>,
    pub type: TypeTrue,
    pub async: Option<bool>,
    pub server: Option<Server>,
    pub id: String,
    pub org_id: String,
    pub created_at: String,
    pub updated_at: String,
    pub function: Option<OpenAiFunction>,
}

Fields

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: TypeTrue

The type of tool. "function" for Function tool.

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).

server: Option<Server>

This is the server where a tool-calls webhook will be sent. Notes: - Webhook is sent to this server when a tool call is made. - Webhook contains the call, assistant, and phone number objects. - Webhook contains the variables set on the assistant. - Webhook is sent to the first available URL in this order: {{tool.server.url}}, {{assistant.server.url}}, {{phoneNumber.server.url}}, {{org.server.url}}. - Webhook expects a response with tool call result.

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<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.

Implementations

impl FunctionTool

pub fn new( type: TypeTrue, id: String, org_id: String, created_at: String, updated_at: String, ) -> FunctionTool

Trait Implementations

impl Clone for FunctionTool

fn clone(&self) -> FunctionTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionTool

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

Formats the value using the given formatter.

impl Default for FunctionTool

fn default() -> FunctionTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionTool

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

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 FunctionTool