Struct ToolApprovalRequest 

pub struct ToolApprovalRequest {
    pub approval_id: ApprovalId,
    pub tool_call_id: ToolCallId,
    pub reason: Option<String>,
    pub is_automatic: bool,
    pub signature: Option<String>,
}

A request for user approval of a tool call, recorded in an assistant message.

Fields

approval_id: ApprovalId

Approval identifier.

tool_call_id: ToolCallId

The tool call awaiting approval.

reason: Option<String>

Why approval is needed.

is_automatic: bool

Whether the request was created automatically (for example by a provider-executed tool) rather than by the tool’s approval policy.

signature: Option<String>

Tamper-detection signature over the request.

Implementations

impl ToolApprovalRequest

pub fn new( approval_id: impl Into<ApprovalId>, tool_call_id: impl Into<ToolCallId>, ) -> Self

Creates a request.

pub fn with_reason(self, reason: impl Into<String>) -> Self

Sets the reason.

pub fn automatic(self) -> Self

Marks the request as automatic.

pub fn with_signature(self, signature: impl Into<String>) -> Self

Sets the signature.

Trait Implementations

impl Clone for ToolApprovalRequest

fn clone(&self) -> ToolApprovalRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolApprovalRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolApprovalRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ToolApprovalRequest

impl From<ToolApprovalRequest> for AssistantPart

fn from(part: ToolApprovalRequest) -> Self

Converts to this type from the input type.

impl PartialEq for ToolApprovalRequest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolApprovalRequest

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 ToolApprovalRequest