Struct ToolOutput 

pub struct ToolOutput {
    pub content: String,
    pub display: Option<DisplayOutput>,
    pub artifacts: Vec<Artifact>,
    pub memory_policy: ToolMemoryPolicy,
    pub metadata: BTreeMap<String, Value>,
}

Model-visible output produced by a tool.

Fields

content: String

Text visible to the model through Message::ToolResult.

display: Option<DisplayOutput>

Optional host/UI display output.

artifacts: Vec<Artifact>

Artifact handles produced by the tool.

memory_policy: ToolMemoryPolicy

Memory policy for the model-visible content.

metadata: BTreeMap<String, Value>

Framework/application metadata.

Implementations

impl ToolOutput

pub fn text(content: impl Into<String>) -> ToolOutput

Constructs plain text model-visible output.

pub fn with_display(self, display: DisplayOutput) -> ToolOutput

Sets host/UI display output.

pub fn with_artifacts(self, artifacts: Vec<Artifact>) -> ToolOutput

Sets artifact handles.

pub fn with_memory_policy(self, policy: ToolMemoryPolicy) -> ToolOutput

Sets memory policy.

pub fn with_metadata(self, metadata: BTreeMap<String, Value>) -> ToolOutput

Sets framework/application metadata.

Trait Implementations

impl Clone for ToolOutput

fn clone(&self) -> ToolOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for ToolOutput

fn from(content: &str) -> ToolOutput

Converts to this type from the input type.

impl From<String> for ToolOutput

fn from(content: String) -> ToolOutput

Converts to this type from the input type.

impl From<ToolOutput> for ToolResult

fn from(output: ToolOutput) -> ToolResult

Converts to this type from the input type.

impl PartialEq for ToolOutput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolOutput

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.

impl StructuralPartialEq for ToolOutput