Struct ToolMessageFailed

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

This message is triggered when the tool call fails. This message is never triggered 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.

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

pub fn new(type: TypeTrue) -> ToolMessageFailed

Trait Implementations

impl Clone for ToolMessageFailed

fn clone(&self) -> ToolMessageFailed

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolMessageFailed

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

Formats the value using the given formatter.

impl Default for ToolMessageFailed

fn default() -> ToolMessageFailed

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMessageFailed

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolMessageFailed

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

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 ToolMessageFailed