Struct ToolCall 

pub struct ToolCall {
    pub id: ToolCallId,
    pub kind: ToolCallKind,
    pub function: FunctionCall,
    pub encrypted_value: Option<String>,
    pub metadata: Option<JsonObject>,
}

One tool invocation requested by the assistant.

Fields

id: ToolCallId

Correlates this call with its TOOL_CALL_* events and result message.

kind: ToolCallKind

Always ToolCallKind::Function.

function: FunctionCall

The function and its arguments.

encrypted_value: Option<String>

Opaque provider payload for zero-data-retention reasoning modes.

metadata: Option<JsonObject>

Extra information, open by key. A tool call is not a message, so it carries its own rather than folding into the assistant message that owns it: several calls can share one parent, and merging them all into it would make the result depend on their relative order. Absent or an object — a JSON null is rejected. See crate::metadata.

Implementations

impl ToolCall

pub fn new( id: impl Into<ToolCallId>, name: impl Into<String>, arguments: impl Into<String>, ) -> Self

Builds a function tool call.

Trait Implementations

impl Clone for ToolCall

fn clone(&self) -> ToolCall

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for ToolCall

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

impl Debug for ToolCall

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

Formats the value using the given formatter.

impl Default for ToolCall

fn default() -> ToolCall

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolCall

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolCall

impl JsonSchema for ToolCall

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 ToolCall

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

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 ToolCall

impl ToSchema for ToolCall

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.