apcore 0.20.0

Schema-driven module standard for AI-perceivable interfaces
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
129

//! Simple client example — implement the Module trait and execute it directly.

use apcore::context::{Context, Identity};
use apcore::errors::ModuleError;
use apcore::module::Module;
use async_trait::async_trait;
use serde_json::{json, Value};
use std::collections::HashMap;

// ---------------------------------------------------------------------------
// Module definition
// ---------------------------------------------------------------------------

struct AddModule;

#[async_trait]
impl Module for AddModule {
    fn input_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "a": { "type": "integer" },
                "b": { "type": "integer" }
            },
            "required": ["a", "b"]
        })
    }

    fn output_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "result": { "type": "integer" }
            }
        })
    }

    fn description(&self) -> &'static str {
        "Add two integers"
    }

    async fn execute(&self, input: Value, _ctx: &Context<Value>) -> Result<Value, ModuleError> {
        let a = input["a"].as_i64().unwrap_or(0);
        let b = input["b"].as_i64().unwrap_or(0);
        Ok(json!({ "result": a + b }))
    }
}

// ---------------------------------------------------------------------------
// Another module: greet
// ---------------------------------------------------------------------------

struct GreetModule;

#[async_trait]
impl Module for GreetModule {
    fn input_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "name":     { "type": "string" },
                "greeting": { "type": "string" }
            },
            "required": ["name"]
        })
    }

    fn output_schema(&self) -> Value {
        json!({
            "type": "object",
            "properties": {
                "message": { "type": "string" }
            }
        })
    }

    fn description(&self) -> &'static str {
        "Greet a user"
    }

    async fn execute(&self, input: Value, _ctx: &Context<Value>) -> Result<Value, ModuleError> {
        let name = input["name"].as_str().unwrap_or("World");
        let greeting = input["greeting"].as_str().unwrap_or("Hello");
        Ok(json!({ "message": format!("{}, {}!", greeting, name) }))
    }
}

// ---------------------------------------------------------------------------
// Main
// ---------------------------------------------------------------------------

#[tokio::main]
async fn main() {
    // Build a caller identity
    let identity = Identity::new(
        "user-1".to_string(),
        "user".to_string(),
        vec!["user".to_string()],
        HashMap::new(),
    );

    // Create an execution context
    let ctx: Context<Value> = Context::new(identity);

    // Instantiate modules
    let add_module = AddModule;
    let greet_module = GreetModule;

    // Execute math.add
    let result = add_module
        .execute(json!({"a": 10, "b": 5}), &ctx)
        .await
        .unwrap();
    println!("math.add result:  {result}"); // {"result":15}

    // Execute greet
    let result = greet_module
        .execute(json!({"name": "Alice", "greeting": "Hi"}), &ctx)
        .await
        .unwrap();
    println!("greet result:     {result}"); // {"message":"Hi, Alice!"}

    // Default greeting
    let result = greet_module
        .execute(json!({"name": "Bob"}), &ctx)
        .await
        .unwrap();
    println!("greet (default):  {result}"); // {"message":"Hello, Bob!"}
}