Struct ToolMessageComplete

pub struct ToolMessageComplete {
    pub contents: Option<Vec<ToolMessageStartContentsInner>>,
    pub type: Type,
    pub role: Option<Role>,
    pub end_call_after_spoken_enabled: Option<bool>,
    pub content: Option<String>,
    pub conditions: Option<Vec<Condition>>,
}

Fields

contents: Option<Vec<ToolMessageStartContentsInner>>

This is an alternative to the content property. It allows to specify variants of the same content, one per language. Usage: - If your assistants are multilingual, you can provide content for each language. - If you don’t provide content for a language, the first item in the array will be automatically translated to the active language at that moment. This will override the content property.

type: Type

This message is triggered when the tool call is complete. This message is triggered immediately without waiting for your server to respond for async tool calls. If this message is not provided, the model will be requested to respond. If this message is provided, only this message will be spoken and the model will not be requested to come up with a response. It’s an exclusive OR.

role: Option<Role>

This is optional and defaults to "assistant". When role=assistant, content is said out loud. When role=system, content is passed to the model in a system message. Example: system: default one assistant: user: assistant: user: assistant: user: assistant: tool called tool: your server response <— system prompt as hint —> model generates response which is spoken This is useful when you want to provide a hint to the model about what to say next.

end_call_after_spoken_enabled: Option<bool>

This is an optional boolean that if true, the call will end after the message is spoken. Default is false. This is ignored if role is set to system. @default false

content: Option<String>

This is the content that the assistant says when this message is triggered.

conditions: Option<Vec<Condition>>

This is an optional array of conditions that the tool call arguments must meet in order for this message to be triggered.

Implementations

impl ToolMessageComplete

pub fn new(type: Type) -> ToolMessageComplete

Trait Implementations

impl Clone for ToolMessageComplete

fn clone(&self) -> ToolMessageComplete

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMessageComplete

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

Formats the value using the given formatter.

impl Default for ToolMessageComplete

fn default() -> ToolMessageComplete

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMessageComplete

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolMessageComplete

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

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 ToolMessageComplete