Struct ToolUIPart 

pub struct ToolUIPart {

    pub part_type: String,
    pub tool_call_id: String,
    pub tool_name: Option<String>,
    pub title: Option<String>,
    pub provider_executed: Option<bool>,
    pub state: ToolState,
    pub input: Option<Value>,
    pub output: Option<Value>,
    pub error_text: Option<String>,
    pub call_provider_metadata: Option<Value>,
    pub raw_input: Option<Value>,
    pub preliminary: Option<bool>,
    pub approval: Option<ToolApproval>,
}

Tool invocation part.

Fields

part_type: String

Part type. Must be dynamic-tool or tool-*.

tool_call_id: String

Tool call identifier.

tool_name: Option<String>

Tool name (required for dynamic-tool).

title: Option<String>

Optional display title.

provider_executed: Option<bool>

Whether the provider executed this tool directly.

state: ToolState

Tool execution state.

input: Option<Value>

Tool input payload.

output: Option<Value>

Tool output payload.

error_text: Option<String>

Tool error text.

call_provider_metadata: Option<Value>

Provider metadata associated with the tool input call.

raw_input: Option<Value>

Raw input when parsing fails (AI SDK compatibility for output-error).

preliminary: Option<bool>

Marks provisional tool outputs.

approval: Option<ToolApproval>

Optional approval state payload.

Implementations

impl ToolUIPart

pub fn static_tool( tool_name: impl Into<String>, tool_call_id: impl Into<String>, state: ToolState, ) -> Self

Create a static tool part (type = tool-{name}).

pub fn dynamic_tool( tool_name: impl Into<String>, tool_call_id: impl Into<String>, state: ToolState, ) -> Self

Create a dynamic tool part (type = dynamic-tool).

Trait Implementations

impl Clone for ToolUIPart

fn clone(&self) -> ToolUIPart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolUIPart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolUIPart

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolUIPart

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

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 ToolUIPart