Struct ToolMessageStart

pub struct ToolMessageStart {
    pub contents: Option<Vec<ToolMessageStartContentsInner>>,
    pub type: TypeTrue,
    pub blocking: 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: TypeTrue

This message is triggered when the tool call starts. This message is never triggered for async tools. If this message is not provided, one of the default filler messages "Hold on a sec", "One moment", "Just a sec", "Give me a moment" or "This’ll just take a sec" will be used.

blocking: Option<bool>

This is an optional boolean that if true, the tool call will only trigger after the message is spoken. Default is false. @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 ToolMessageStart

pub fn new(type: TypeTrue) -> ToolMessageStart

Trait Implementations

impl Clone for ToolMessageStart

fn clone(&self) -> ToolMessageStart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMessageStart

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

Formats the value using the given formatter.

impl Default for ToolMessageStart

fn default() -> ToolMessageStart

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMessageStart

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolMessageStart

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

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 ToolMessageStart