Enum ToolInteractionResponse 

pub enum ToolInteractionResponse {
    Submit {
        id: ToolInteractionId,
        content: Value,
    },
    Decline {
        id: ToolInteractionId,
        reason: Option<String>,
    },
    Cancel {
        id: ToolInteractionId,
        reason: Option<String>,
    },
}

Caller response to a pending tool interaction.

Variants

Submit

Supplies caller input and resumes execution.

Fields

id: ToolInteractionId

Id of the interaction being resolved.

content: Value

Submitted text or form value.

Decline

Declines to provide the requested input.

Fields

id: ToolInteractionId

Id of the interaction being resolved.

reason: Option<String>

Optional caller-safe explanation.

Cancel

Cancels the pending interaction and invocation.

Fields

id: ToolInteractionId

Id of the interaction being resolved.

reason: Option<String>

Optional caller-safe cancellation reason.

Implementations

impl ToolInteractionResponse

pub fn submit(id: ToolInteractionId, content: Value) -> Self

Creates a submitted interaction response.

Examples

use tools_kit::interaction::{ToolInteractionId, ToolInteractionResponse};
let id = ToolInteractionId::new();
let response = ToolInteractionResponse::submit(id.clone(), serde_json::json!("Chicago"));
assert_eq!(response.interaction_id(), &id);

pub fn decline(id: ToolInteractionId, reason: Option<String>) -> Self

Creates a declined interaction response.

Examples

use tools_kit::interaction::{ToolInteractionId, ToolInteractionResponse};
let id = ToolInteractionId::new();
let response = ToolInteractionResponse::decline(id.clone(), Some("not available".into()));
assert_eq!(response.interaction_id(), &id);

pub fn cancel(id: ToolInteractionId, reason: Option<String>) -> Self

Creates a cancelled interaction response.

Examples

use tools_kit::interaction::{ToolInteractionId, ToolInteractionResponse};
let id = ToolInteractionId::new();
let response = ToolInteractionResponse::cancel(id.clone(), None);
assert_eq!(response.interaction_id(), &id);

pub fn interaction_id(&self) -> &ToolInteractionId

Borrows the id of the interaction being resolved.

Examples

use tools_kit::interaction::{ToolInteractionId, ToolInteractionResponse};
let id = ToolInteractionId::new();
let response = ToolInteractionResponse::submit(id.clone(), serde_json::json!({"approved":true}));
assert_eq!(response.interaction_id(), &id);

Trait Implementations

impl Clone for ToolInteractionResponse

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ToolInteractionResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ToolInteractionResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ToolInteractionResponse

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ToolInteractionResponse

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 ToolInteractionResponse