Struct ToolReturnPart 

pub struct ToolReturnPart {
    pub tool_call_id: String,
    pub name: String,
    pub content: Value,
    pub is_error: bool,
    pub metadata: Metadata,
    pub app_value: Option<Value>,
    pub user_content: Option<Value>,
    pub private_metadata: Metadata,
}

Tool return content.

Fields

tool_call_id: String

Related call identifier.

name: String

Tool name.

content: Value

Tool content sent back to the model.

is_error: bool

Tool result status.

metadata: Metadata

Tool return metadata for approval, deferral, and runtime orchestration.

app_value: Option<Value>

Application-facing return value when it differs from model-visible content.

user_content: Option<Value>

User-facing content for UI display and host rendering.

private_metadata: Metadata

Private host metadata kept separate from provider request mapping.

Implementations

impl ToolReturnPart

pub fn new( tool_call_id: impl Into<String>, name: impl Into<String>, content: Value, ) -> Self

Build a tool return part with model-visible content.

pub const fn with_error(self, is_error: bool) -> Self

Mark this tool return as an error.

pub fn with_metadata(self, metadata: Metadata) -> Self

Attach public runtime metadata.

pub fn with_app_value(self, app_value: Value) -> Self

Attach application-facing return value.

pub fn with_user_content(self, user_content: Value) -> Self

Attach user-facing content.

pub fn with_private_metadata(self, private_metadata: Metadata) -> Self

Attach private host metadata.

Trait Implementations

impl Clone for ToolReturnPart

fn clone(&self) -> ToolReturnPart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolReturnPart

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolReturnPart

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolReturnPart

impl PartialEq for ToolReturnPart

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolReturnPart

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 ToolReturnPart