Struct InvocableRequest 

pub struct InvocableRequest {
    pub input: Value,
    pub session_id: Option<SessionId>,
    pub turn_id: Option<TurnId>,
    pub metadata: MetadataMap,
}

A request to execute an Invocable capability.

Created by the agentkit loop when the model emits a tool-call that targets a registered invocable. The input field contains the arguments the model provided, validated against the capability’s InvocableSpec::input_schema.

Fields

input: Value

The JSON input arguments provided by the model.

session_id: Option<SessionId>

The session in which this invocation occurs, if available.

turn_id: Option<TurnId>

The turn within the session, if available.

metadata: MetadataMap

Arbitrary key-value metadata attached to this request.

Implementations

impl InvocableRequest

pub fn new(input: Value) -> Self

Builds an invocable request with no session or turn ids.

pub fn with_session(self, session_id: impl Into<SessionId>) -> Self

Sets the session id.

pub fn with_turn(self, turn_id: impl Into<TurnId>) -> Self

Sets the turn id.

pub fn with_metadata(self, metadata: MetadataMap) -> Self

Replaces the request metadata.

Trait Implementations

impl Clone for InvocableRequest

fn clone(&self) -> InvocableRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InvocableRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InvocableRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for InvocableRequest

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

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 InvocableRequest