Struct TextEditorTool

pub struct TextEditorTool {
    pub messages: Option<Vec<CreateDtmfToolDtoMessagesInner>>,
    pub type: TypeTrue,
    pub sub_type: SubTypeTrue,
    pub server: Option<Server>,
    pub id: String,
    pub org_id: String,
    pub created_at: String,
    pub updated_at: String,
    pub function: Option<OpenAiFunction>,
    pub name: NameTrue,
}

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. "textEditor" for Text Editor tool.

sub_type: SubTypeTrue

The sub type of tool.

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.

name: NameTrue

The name of the tool, fixed to ‘str_replace_editor’

Implementations

impl TextEditorTool

pub fn new( type: TypeTrue, sub_type: SubTypeTrue, id: String, org_id: String, created_at: String, updated_at: String, name: NameTrue, ) -> TextEditorTool

Trait Implementations

impl Clone for TextEditorTool

fn clone(&self) -> TextEditorTool

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TextEditorTool

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

Formats the value using the given formatter.

impl Default for TextEditorTool

fn default() -> TextEditorTool

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextEditorTool

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TextEditorTool

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

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 TextEditorTool