Skip to main content

OpenAiToolResult

Struct OpenAiToolResult 

Source
pub struct OpenAiToolResult {
    pub call_id: String,
    pub name: String,
    pub status: Symbol,
    pub output: Expr,
}
Expand description

The outcome of an OpenAiToolCall: a status symbol and result payload.

Fields§

§call_id: String

Id of the originating OpenAiToolCall.

§name: String

OpenAI tool name that produced this result.

§status: Symbol

Outcome status, e.g. ok, invalid-arguments, or unknown-tool.

§output: Expr

Result payload expression (the call output or an error message).

Implementations§

Source§

impl OpenAiToolResult

Source

pub fn success(call: &OpenAiToolCall, output: Expr) -> Self

Builds a successful (ok) result carrying output for call.

Source

pub fn invalid_arguments( call: &OpenAiToolCall, message: impl Into<String>, ) -> Self

Builds an invalid-arguments failure result for call.

Source

pub fn capability_denied( call: &OpenAiToolCall, message: impl Into<String>, ) -> Self

Builds a capability-denied failure result for call.

Source

pub fn unknown_tool(call: &OpenAiToolCall) -> Self

Builds an unknown-tool failure result for call.

Source

pub fn to_expr(&self) -> Expr

Renders this tool result as a SIM expression map.

Source

pub fn message_text(&self) -> String

Returns a human-readable one-line summary of this result.

Trait Implementations§

Source§

impl Clone for OpenAiToolResult

Source§

fn clone(&self) -> OpenAiToolResult

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenAiToolResult

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for OpenAiToolResult

Source§

fn eq(&self, other: &OpenAiToolResult) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for OpenAiToolResult

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.