Enum ToolResultOutput 

#[non_exhaustive]
pub enum ToolResultOutput {
    Text {
        value: String,
        provider_options: Option<BTreeMap<String, Map<String, Value>>>,
    },
    Json {
        value: Value,
        provider_options: Option<BTreeMap<String, Map<String, Value>>>,
    },
    ExecutionDenied {
        reason: Option<String>,
        provider_options: Option<BTreeMap<String, Map<String, Value>>>,
    },
    ErrorText {
        value: String,
        provider_options: Option<BTreeMap<String, Map<String, Value>>>,
    },
    ErrorJson {
        value: Value,
        provider_options: Option<BTreeMap<String, Map<String, Value>>>,
    },
    Content {
        value: Vec<ToolResultContentPart>,
    },
}

The output of a tool call as sent back to the model.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Text

Plain text.

Fields

value: String

The text.

provider_options: Option<BTreeMap<String, Map<String, Value>>>

Provider-specific options.

Json

A JSON value.

Fields

value: Value

The value.

provider_options: Option<BTreeMap<String, Map<String, Value>>>

Provider-specific options.

ExecutionDenied

Execution was denied by the application or user.

Fields

reason: Option<String>

Optional reason.

provider_options: Option<BTreeMap<String, Map<String, Value>>>

Provider-specific options.

ErrorText

The tool failed; the error is plain text.

Fields

value: String

The error text.

provider_options: Option<BTreeMap<String, Map<String, Value>>>

Provider-specific options.

ErrorJson

The tool failed; the error is a JSON value.

Fields

value: Value

The error value.

provider_options: Option<BTreeMap<String, Map<String, Value>>>

Provider-specific options.

Content

Multi-part content (text and files).

Fields

value: Vec<ToolResultContentPart>

The parts.

Implementations

impl ToolResultOutput

pub fn text(value: impl Into<String>) -> ToolResultOutput

Creates a text output.

pub fn json(value: Value) -> ToolResultOutput

Creates a JSON output.

pub fn error_text(value: impl Into<String>) -> ToolResultOutput

Creates an error-text output.

pub fn error_json(value: Value) -> ToolResultOutput

Creates an error-JSON output.

pub fn execution_denied(reason: Option<String>) -> ToolResultOutput

Creates an execution-denied output.

pub fn is_error(&self) -> bool

Returns true for the error variants (error-text, error-json).

Trait Implementations

impl Clone for ToolResultOutput

fn clone(&self) -> ToolResultOutput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolResultOutput

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolResultOutput

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolResultOutput

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolResultOutput

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 ToolResultOutput