Skip to main content

ToolInvocation

Struct ToolInvocation 

Source
pub struct ToolInvocation {
    pub actor_id: i32,
    pub input: Option<String>,
    pub result: Option<String>,
    pub step_id: String,
    pub text: Option<String>,
    pub text_html: String,
    pub timestamp: Option<String>,
    pub tool_diff: Option<ToolDiff>,
    pub tool_name: Option<String>,
}
Expand description

A tool.invoke step spliced inline next to its parent assistant turn. Saves the client a second pass over the path’s step graph.

JSON schema
{
 "description": "A `tool.invoke` step spliced inline next to its parent assistant\nturn. Saves the client a second pass over the path's step graph.",
 "type": "object",
 "required": [
   "actor_id",
   "step_id",
   "text_html"
 ],
 "properties": {
   "actor_id": {
     "type": "integer",
     "format": "int32",
     "minimum": 0.0
   },
   "input": {
     "description": "Tool input args from the structural payload (`extra.input`),\nJSON-stringified when not already a string.",
     "type": [
       "string",
       "null"
     ]
   },
   "result": {
     "description": "Tool output from the structural payload (`extra.result`),\nJSON-stringified when not already a string.",
     "type": [
       "string",
       "null"
     ]
   },
   "step_id": {
     "description": "Canonical step ID of the tool.invoke step.",
     "type": "string"
   },
   "text": {
     "type": [
       "string",
       "null"
     ]
   },
   "text_html": {
     "type": "string"
   },
   "timestamp": {
     "type": [
       "string",
       "null"
     ]
   },
   "tool_diff": {
     "oneOf": [
       {
         "type": "null"
       },
       {
         "allOf": [
           {
             "$ref": "#/components/schemas/ToolDiff"
           }
         ]
       }
     ]
   },
   "tool_name": {
     "type": [
       "string",
       "null"
     ]
   }
 }
}

Fields§

§actor_id: i32§input: Option<String>

Tool input args from the structural payload (extra.input), JSON-stringified when not already a string.

§result: Option<String>

Tool output from the structural payload (extra.result), JSON-stringified when not already a string.

§step_id: String

Canonical step ID of the tool.invoke step.

§text: Option<String>§text_html: String§timestamp: Option<String>§tool_diff: Option<ToolDiff>§tool_name: Option<String>

Trait Implementations§

Source§

impl Clone for ToolInvocation

Source§

fn clone(&self) -> ToolInvocation

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 ToolInvocation

Source§

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

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

impl<'de> Deserialize<'de> for ToolInvocation

Source§

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

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

impl Serialize for ToolInvocation

Source§

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

Serialize this value into the given Serde serializer. Read more

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> 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, 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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.
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