Struct ToolCallResult

pub struct ToolCallResult {
    pub message: Option<ToolCallResultMessage>,
    pub name: String,
    pub tool_call_id: String,
    pub result: Option<String>,
    pub error: Option<String>,
    pub metadata: Option<Value>,
}

Fields

message: Option<ToolCallResultMessage>

name: String

This is the name of the function the model called.

tool_call_id: String

This is the unique identifier for the tool call.

result: Option<String>

This is the result if the tool call was successful. This is added to the conversation history. Further, if this is returned, assistant will speak: 1. the message, if it exists and is of type request-complete 2. a request-complete message from tool.messages, if it exists 3. a response generated by the model, if neither exist

error: Option<String>

This is the error if the tool call was not successful. This is added to the conversation history. Further, if this is returned, assistant will speak: 1. the message, if it exists and is of type request-failed 2. a request-failed message from tool.messages, if it exists 3. a response generated by the model, if neither exist

metadata: Option<Value>

This is optional metadata for the tool call result to be sent to the client.

Implementations

impl ToolCallResult

pub fn new(name: String, tool_call_id: String) -> ToolCallResult

Trait Implementations

impl Clone for ToolCallResult

fn clone(&self) -> ToolCallResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolCallResult

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

Formats the value using the given formatter.

impl Default for ToolCallResult

fn default() -> ToolCallResult

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolCallResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolCallResult

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

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 ToolCallResult