Struct CreateQueryToolDto

pub struct CreateQueryToolDto {
    pub messages: Option<Vec<CreateDtmfToolDtoMessagesInner>>,
    pub type: TypeTrue,
    pub knowledge_bases: Option<Vec<KnowledgeBase>>,
    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. "query" for Query tool.

knowledge_bases: Option<Vec<KnowledgeBase>>

The knowledge bases to query

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 CreateQueryToolDto

pub fn new(type: TypeTrue) -> CreateQueryToolDto

Trait Implementations

impl Clone for CreateQueryToolDto

fn clone(&self) -> CreateQueryToolDto

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateQueryToolDto

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

Formats the value using the given formatter.

impl Default for CreateQueryToolDto

fn default() -> CreateQueryToolDto

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateQueryToolDto

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CreateQueryToolDto

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

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 CreateQueryToolDto