Struct FunctionExecutionResult 

#[non_exhaustive]
pub struct FunctionExecutionResult {
    pub name: String,
    pub call_id: String,
    pub args: Value,
    pub result: Value,
    pub duration: Duration,
}

Result of executing a function locally.

This represents the output from a function that was executed by the library during automatic function calling. It contains the function name, the call ID (used to match with the original request), the arguments that were passed, and the result value.

Example

println!("Function {} called with: {}", result.name, result.args);
println!("  Returned: {}", result.result);
println!("  Call ID: {}, Duration: {:?}", result.call_id, result.duration);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

Name of the function that was called

call_id: String

The call_id from the FunctionCall this result responds to

args: Value

The arguments passed to the function

result: Value

The result returned by the function

duration: Duration

How long the function took to execute

Implementations

impl FunctionExecutionResult

pub fn new( name: impl Into<String>, call_id: impl Into<String>, args: Value, result: Value, duration: Duration, ) -> Self

Creates a new function execution result.

pub fn is_error(&self) -> bool

Returns true if this execution resulted in an error.

Errors occur when:

• The function was not found in the registry or tool service
• The function execution failed (panicked or returned an error)

Example

let result = client.interaction()
    .with_text("What's the weather?")
    .create_with_auto_functions()
    .await?;

for execution in &result.executions {
    if execution.is_error() {
        eprintln!("Function {} failed: {:?}", execution.name, execution.result);
    }
}

pub fn is_success(&self) -> bool

Returns true if this execution succeeded (no error).

pub fn error_message(&self) -> Option<&str>

Returns the error message if this execution failed, None otherwise.

Trait Implementations

impl Clone for FunctionExecutionResult

fn clone(&self) -> FunctionExecutionResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionExecutionResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FunctionExecutionResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FunctionExecutionResult

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

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 FunctionExecutionResult