Enum ToolResult 

pub enum ToolResult {
    Text(String),
    Json(Value),
    Image {
        format: ImageFormat,
        data: Vec<u8>,
    },
    Document {
        format: DocumentFormat,
        data: Vec<u8>,
        name: Option<String>,
    },
}

Result types that tools can return.

Tools can return different content types depending on their purpose. All providers support Text and Json. Image and Document support varies by provider (Bedrock supports all types; future providers may fall back to text descriptions).

Variants

Text(String)

Plain text response

Json(Value)

Structured JSON data - use for complex responses

Image

Image data - supported by Bedrock (Claude, Nova models)

Fields

format: ImageFormat

data: Vec<u8>

Raw image bytes (not base64 encoded)

Document

Document data - supported by Bedrock (Claude, Nova models)

Fields

format: DocumentFormat

data: Vec<u8>

Raw document bytes

name: Option<String>

Optional document name/filename

Implementations

impl ToolResult

pub fn json<T: Serialize>(value: T) -> Result<Self, Error>

Create a JSON result from any serializable type

pub fn text(s: impl Into<String>) -> Self

Create a text result from a string

pub fn image(format: ImageFormat, data: Vec<u8>) -> Self

Create an image result from raw bytes

pub fn document(format: DocumentFormat, data: Vec<u8>) -> Self

Create a document result from raw bytes

pub fn document_with_name( format: DocumentFormat, data: Vec<u8>, name: impl Into<String>, ) -> Self

Create a document result with a filename

pub fn as_text(&self) -> String

Get the text content if this is a Text variant, or convert to string description

pub fn as_str(&self) -> Option<&str>

Get a reference to the text content if this is a Text variant

Trait Implementations

impl Clone for ToolResult

fn clone(&self) -> ToolResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResult

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResult

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for ToolResult

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<String> for ToolResult

Convert strings directly to ToolResult::Text

fn from(s: String) -> Self

Converts to this type from the input type.

impl Serialize for ToolResult

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

where __S: Serializer,

Serialize this value into the given Serde serializer.