Skip to main content

ToolCall

Struct ToolCall 

Source
pub struct ToolCall {
    pub id: CallId,
    pub function: ToolFunction,
    pub signature: Option<String>,
    pub additional_params: Option<Value>,
}
Expand description

Describes a tool call with an id and function to call, generally produced by a provider.

Fields§

§id: CallId

The call’s one identity: the provider’s id, or one rig issued when the provider sent none.

§function: ToolFunction

Function name and JSON arguments requested by the model.

§signature: Option<String>

Opaque provider signature preserved for replay. Rig does not verify it.

§additional_params: Option<Value>

Additional provider-specific parameters to be sent to the completion model provider

Implementations§

Source§

impl ToolCall

Source

pub fn new(id: CallId, function: ToolFunction) -> ToolCall

A call with id.

Source

pub fn from_wire(wire_id: impl Into<String>, function: ToolFunction) -> ToolCall

A call the provider identified by wire_id; rig issues an id when it is empty.

Source

pub fn from_dual_wire( item_id: impl Into<String>, call_id: impl Into<String>, function: ToolFunction, ) -> ToolCall

The dual-identifier provider boundary (OpenAI Responses): item_id is the output-item handle (fc_…), call_id the correlator (call_…). Rig issues an id when call_id is empty.

Source

pub fn result(&self, content: Vec<ToolResultContent>) -> ToolResult

The result answering this call: its id and name, and content.

Source

pub fn with_signature(self, signature: Option<String>) -> ToolCall

Source

pub fn with_additional_params( self, additional_params: Option<Value>, ) -> ToolCall

Trait Implementations§

Source§

impl Clone for ToolCall

Source§

fn clone(&self) -> ToolCall

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 ToolCall

Source§

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

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

impl<'de> Deserialize<'de> for ToolCall

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ToolCall, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<ToolCall> for Message

Source§

fn from(value: ToolCall) -> Message

Converts to this type from the input type.
Source§

impl From<ToolCall> for Part

Source§

fn from(tool_call: ToolCall) -> Part

Converts to this type from the input type.
Source§

impl From<ToolCall> for FunctionCall

Source§

fn from(tool_call: ToolCall) -> FunctionCall

Converts to this type from the input type.
Source§

impl From<ToolCall> for ToolCall

Source§

fn from(tool_call: ToolCall) -> ToolCall

Converts to this type from the input type.
Source§

impl From<ToolCall> for ToolCall

Source§

fn from(tool_call: ToolCall) -> ToolCall

Converts to this type from the input type.
Source§

impl PartialEq for ToolCall

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ToolCall

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ToolCall

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoToolOutput for T
where T: Serialize + 'static,

Source§

fn into_tool_output(self) -> Result<ToolOutput, ToolExecutionError>

Convert this value without routing structured data through a string.
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WasmCompatSend for T
where T: Send,

Source§

impl<T> WasmCompatSync for T
where T: Sync,

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more