Struct ToolMessage 

pub struct ToolMessage {
    pub id: MessageId,
    pub content: String,
    pub tool_call_id: ToolCallId,
    pub error: Option<String>,
    pub encrypted_value: Option<String>,
    pub subagent_run_id: Option<SubagentRunId>,
    pub metadata: Option<JsonObject>,
}

The result of a tool call, fed back to the model.

Fields

id: MessageId

Message id.

content: String

The result, already rendered to a string.

tool_call_id: ToolCallId

The call this result answers.

error: Option<String>

Set when the tool failed; content then holds whatever partial output there was.

encrypted_value: Option<String>

Opaque provider payload for zero-data-retention modes.

subagent_run_id: Option<SubagentRunId>

The subagent that executed the call; absent means the parent agent. Attributed independently of the call it answers — see ToolCallResultEvent. A JSON null is rejected.

metadata: Option<JsonObject>

Extra information, open by key. Absent or an object — a JSON null is rejected. See crate::metadata.

Trait Implementations

impl Clone for ToolMessage

fn clone(&self) -> ToolMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ToolMessage

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for ToolMessage

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

Formats the value using the given formatter.

impl Default for ToolMessage

fn default() -> ToolMessage

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolMessage

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolMessage

impl From<ToolMessage> for Message

fn from(value: ToolMessage) -> Self

Converts to this type from the input type.

impl JsonSchema for ToolMessage

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ToolMessage

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

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 ToolMessage

impl ToSchema for ToolMessage

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference [utoipa::openapi::schema::Schema]s for this type.