agentsdk 0.11.0

A lean, OpenAI-compatible AI SDK for Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use crate::core::agent::AgentOptions;
use crate::error::AgentSdkError;
use derive_builder::Builder;
use schemars::Schema;
use serde_json::Value;
use std::fmt::{self, Debug, Formatter};
use std::future::Future;
use std::pin::Pin;
use std::sync::Arc;

#[derive(Clone, Debug)]
pub struct ToolContext {
    pub options: Arc<AgentOptions>,
}

pub type ToolOutput = Result<Value, String>;
pub type ToolFuture = Pin<Box<dyn Future<Output = ToolOutput> + Send>>;

type SyncToolFn = dyn Fn(ToolContext, Value) -> ToolOutput + Send + Sync;
type AsyncToolFn = dyn Fn(ToolContext, Value) -> ToolFuture + Send + Sync;

#[derive(Clone)]
pub enum ToolExecute {
    Sync(Arc<SyncToolFn>),
    Async(Arc<AsyncToolFn>),
}

impl Debug for ToolExecute {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            Self::Sync(_) => f.debug_tuple("Sync").finish(),
            Self::Async(_) => f.debug_tuple("Async").finish(),
        }
    }
}

impl ToolExecute {
    pub fn from_sync<F>(f: F) -> Self
    where
        F: Fn(ToolContext, Value) -> ToolOutput + Send + Sync + 'static,
    {
        Self::Sync(Arc::new(f))
    }

    pub fn from_async<F, Fut>(f: F) -> Self
    where
        F: Fn(ToolContext, Value) -> Fut + Send + Sync + 'static,
        Fut: Future<Output = ToolOutput> + Send + 'static,
    {
        Self::Async(Arc::new(move |ctx, val| Box::pin(f(ctx, val))))
    }

    /// Executes the tool with the given context and input.
    ///
    /// # Errors
    /// Returns the tool's error string if execution fails.
    pub async fn call(&self, ctx: ToolContext, input: Value) -> ToolOutput {
        match self {
            Self::Sync(f) => f(ctx, input),
            Self::Async(f) => f(ctx, input).await,
        }
    }
}

#[derive(Debug, Builder, Clone)]
#[builder(pattern = "owned", setter(into))]
pub struct ToolDefinition {
    pub name: String,
    pub description: String,
    pub input_schema: Schema,
}

impl ToolDefinition {
    #[must_use]
    pub fn builder() -> ToolDefinitionBuilder {
        ToolDefinitionBuilder::default()
    }
}

#[derive(Builder, Clone)]
#[builder(pattern = "owned", setter(into), build_fn(error = "AgentSdkError"))]
pub struct Tool {
    pub definition: ToolDefinition,
    pub execute: ToolExecute,
}

impl Debug for Tool {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        f.debug_struct("Tool")
            .field("definition", &self.definition)
            .field("execute", &self.execute)
            .finish()
    }
}

impl Tool {
    #[must_use]
    pub fn builder() -> ToolBuilder {
        ToolBuilder::default()
    }

    #[must_use]
    pub fn name(&self) -> &str {
        &self.definition.name
    }

    #[must_use]
    pub fn description(&self) -> &str {
        &self.definition.description
    }

    #[must_use]
    pub fn input_schema(&self) -> &Schema {
        &self.definition.input_schema
    }

    /// Executes the tool with the given context and input.
    ///
    /// # Errors
    /// Returns `AgentSdkError::ToolCallError` if execution fails.
    #[tracing::instrument(skip(self, ctx, input), fields(tool = %self.definition.name))]
    pub async fn call(&self, ctx: ToolContext, input: Value) -> crate::error::Result<Value> {
        self.execute
            .call(ctx, input)
            .await
            .map_err(AgentSdkError::ToolCallError)
    }
}