rig-agent 0.43.0

Rig's classic agent runtime.
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
use std::time::Duration;

use futures::StreamExt;
use serde_json::json;

use super::*;
use crate::bus::Bus;
use rig_core::{
    completion::{CompletionRequest, Message},
    driver::{Exchange, Local, Model, Opened, Opening, Step, Transport},
    effect::{EffectFamily, HandlerKey, family},
    embeddings::{Embedding, EmbeddingResponse},
    error::ErrorKind,
    memory::InMemoryConversationMemory,
    message::AssistantContent,
    serve::adapters::{MemoryAdapter, ModelAdapter, ToolAdapter},
    test_utils::{MockCompletionModel, MockStreamEvent, MockTurn},
    tool::{Tool, ToolExecutionError},
    wire::Capabilities,
};

async fn within<T>(future: impl Future<Output = T>) -> T {
    tokio::time::timeout(Duration::from_secs(5), future)
        .await
        .expect("a dispatch never hangs")
}

struct Double;

#[derive(serde::Deserialize)]
struct DoubleArgs {
    x: i64,
}

impl Tool for Double {
    const NAME: &'static str = "double";
    type Args = DoubleArgs;
    type Output = i64;
    type Error = ToolExecutionError;

    fn description(&self) -> String {
        "doubles".into()
    }

    fn parameters(&self) -> serde_json::Value {
        json!({"type": "object"})
    }

    async fn call(&self, _context: &mut ToolContext, args: DoubleArgs) -> Result<i64, Self::Error> {
        Ok(args.x * 2)
    }
}

/// A two-dimension embedding runtime: each text embeds to its length and
/// 1.0.
#[derive(Clone)]
struct Tiny;

impl Tiny {
    fn model() -> Model<Local<rig_core::operation::Embedding>, Tiny> {
        Model::new(
            Local::new("tiny").with_capabilities(Capabilities::embedding(8, 2)),
            Tiny,
        )
    }
}

impl Transport<Local<rig_core::operation::Embedding>> for Tiny {
    fn send(
        &self,
        texts: Vec<String>,
        _exchange: Exchange,
    ) -> Opening<Step<rig_core::operation::Embedding>> {
        let response = EmbeddingResponse {
            provider: "tiny".into(),
            ..EmbeddingResponse::new(
                texts
                    .into_iter()
                    .map(|document| Embedding {
                        vec: vec![document.len() as f64, 1.0],
                        document,
                    })
                    .collect(),
            )
        };
        Opening::ready(Opened::new(futures::stream::iter([Ok(Step::End(
            response,
        ))])))
    }
}

fn request() -> CompletionRequest {
    CompletionRequest {
        model: None,
        chat_history: vec![Message::user("hi")],
        documents: vec![],
        tools: vec![],
        temperature: None,
        max_tokens: None,
        tool_choice: None,
        additional_params: None,
        output_schema: None,
        record_telemetry_content: false,
    }
}

fn bus() -> (
    Dispatcher,
    crate::bus::Registrar,
    tokio::task::JoinHandle<()>,
) {
    let (dispatcher, registrar, mut driver) = Bus::channel();
    driver
        .register(
            "model",
            ModelAdapter::new(
                "mock",
                MockCompletionModel::from_turns([MockTurn::text("unary"), MockTurn::text("again")]),
            ),
        )
        .expect("register");
    driver
        .register(
            "streamer",
            ModelAdapter::new(
                "mock-stream",
                MockCompletionModel::from_stream_turns([vec![
                    MockStreamEvent::text("str"),
                    MockStreamEvent::text("eamed"),
                    MockStreamEvent::final_response_with_total_tokens(4),
                ]]),
            ),
        )
        .expect("register");
    driver
        .register("double", ToolAdapter::new(Double))
        .expect("register");
    driver
        .register(
            "memory",
            MemoryAdapter::new(InMemoryConversationMemory::new()),
        )
        .expect("register");
    driver
        .register("embed", ModelAdapter::new("tiny", Tiny::model()))
        .expect("register");
    (dispatcher, registrar, tokio::spawn(driver))
}

#[tokio::test]
async fn binding_checks_the_family_typed_at_bind_time() {
    let (dispatcher, _registrar, _task) = bus();
    let model: ModelHandle = dispatcher
        .handle(&HandlerKey::from("model"))
        .expect("model");
    assert_eq!(model.descriptor().family.family(), EffectFamily::Completion);
    assert_eq!(model.label().as_str(), "mock");

    let report = dispatcher
        .handle::<family::Completion>(&HandlerKey::from("double"))
        .expect_err("a tool key is not a model");
    assert_eq!(report.kind, ErrorKind::HandlerUnavailable);
    assert!(
        report.message.contains("tool_call family"),
        "{}",
        report.message
    );

    let report = dispatcher
        .handle::<family::Tool>(&HandlerKey::from("nope"))
        .expect_err("unknown");
    assert_eq!(report.kind, ErrorKind::HandlerUnavailable);
    assert!(report.message.contains("`nope`"));
}

#[tokio::test]
async fn concurrent_model_handles_preserve_explicit_observation_contexts() {
    use rig_core::observe::{AdapterContext, ObservationLog, Subject};
    use std::sync::Arc;

    for streamed in [false, true] {
        let provider = if streamed {
            MockCompletionModel::from_stream_turns((0..2).map(|_| {
                vec![
                    MockStreamEvent::text("same"),
                    MockStreamEvent::final_response_with_total_tokens(1),
                ]
            }))
        } else {
            MockCompletionModel::from_turns((0..2).map(|_| MockTurn::text("same")))
        };
        let (dispatcher, _registrar, mut driver) = Bus::channel();
        driver
            .register("model", ModelAdapter::new("mock", provider.clone()))
            .unwrap();
        let task = tokio::spawn(driver);
        let handle: ModelHandle = dispatcher.handle(&HandlerKey::from("model")).unwrap();
        let sink = Arc::new(ObservationLog::default());
        let contexts: Vec<_> = ["operation/a", "operation/b"]
            .into_iter()
            .map(|operation| {
                AdapterContext::new(sink.clone(), Subject::scoped("direct"), operation)
            })
            .collect();
        if streamed {
            let consume = |context| {
                let mut stream = handle.stream_observed(request(), context);
                async move {
                    while let Some(event) = within(stream.next()).await {
                        event.unwrap();
                    }
                    assert_eq!(
                        stream.finish().await.expect("a terminal record").choice,
                        vec![AssistantContent::text("same")]
                    );
                }
            };
            tokio::join!(consume(contexts[0].clone()), consume(contexts[1].clone()));
        } else {
            let (a, b) = tokio::join!(
                within(handle.call_observed(request(), contexts[0].clone())),
                within(handle.call_observed(request(), contexts[1].clone()))
            );
            assert_eq!(a.unwrap().choice, vec![AssistantContent::text("same")]);
            assert_eq!(b.unwrap().choice, vec![AssistantContent::text("same")]);
        }
        let received = provider.contexts();
        let mut operations: Vec<_> = received
            .iter()
            .map(|request| request.as_ref().unwrap().operation())
            .collect();
        operations.sort_unstable();
        assert_eq!(operations, ["operation/a", "operation/b"]);
        task.abort();
    }
}

#[tokio::test]
async fn model_handle_completes_and_streams() {
    let (dispatcher, _registrar, _task) = bus();
    let model: ModelHandle = dispatcher
        .handle(&HandlerKey::from("model"))
        .expect("model");
    let response = within(model.call(request())).await.expect("completed");
    assert_eq!(response.choice, vec![AssistantContent::text("unary")]);
    assert_eq!(model.capabilities(), ProviderCapabilities::default());

    let streamer: ModelHandle = dispatcher
        .handle(&HandlerKey::from("streamer"))
        .expect("model");
    let mut stream = streamer.stream(request());
    let mut text = String::new();
    while let Some(event) = within(stream.next()).await {
        if let rig_core::streaming::Item::Event(rig_core::streaming::StreamEvent::Text {
            text: piece,
            ..
        }) = event.expect("event")
        {
            text.push_str(&piece);
        }
    }
    assert_eq!(text, "streamed");
    let finished = stream.finish().await.expect("a terminal record");
    assert_eq!(finished.choice, vec![AssistantContent::text("streamed")]);
    assert_eq!(finished.usage.total_tokens, Some(4));
}

#[tokio::test]
async fn handle_descriptor_follows_a_runtime_replacement() {
    let (dispatcher, registrar, _task) = bus();
    let model: ModelHandle = dispatcher
        .handle(&HandlerKey::from("model"))
        .expect("model");
    registrar
        .register(
            "model",
            ModelAdapter::new(
                "swapped",
                MockCompletionModel::from_turns([MockTurn::text("swapped")]),
            ),
        )
        .expect("register");
    assert_eq!(
        model.label().as_str(),
        "swapped",
        "re-read, not the snapshot"
    );
    let response = within(model.call(request())).await.expect("completed");
    assert_eq!(response.choice, vec![AssistantContent::text("swapped")]);
}

#[tokio::test]
async fn tool_memory_index_and_embed_handles_call_their_families() {
    let (dispatcher, _registrar, _task) = bus();
    let tool: ToolHandle = dispatcher
        .handle(&HandlerKey::from("double"))
        .expect("tool");
    assert_eq!(tool.name(), "double");
    let crate::bus::ToolAnswer { result, .. } =
        within(tool.call("double", r#"{"x": 21}"#, ToolContext::new()))
            .await
            .expect("called");
    assert_eq!(result.output().as_json(), Some(&json!(42)));

    let memory: MemoryHandle = dispatcher
        .handle(&HandlerKey::from("memory"))
        .expect("memory");
    let conversation = ConversationId::from("c");
    within(memory.append(conversation.clone(), vec![Message::user("x")]))
        .await
        .expect("appended");
    let loaded = within(memory.load(conversation.clone()))
        .await
        .expect("loaded");
    assert_eq!(loaded.len(), 1);
    within(memory.clear(conversation.clone()))
        .await
        .expect("cleared");
    assert!(
        within(memory.load(conversation))
            .await
            .expect("loaded")
            .is_empty()
    );

    let embed: EmbedHandle = dispatcher
        .handle(&HandlerKey::from("embed"))
        .expect("embed");
    assert_eq!(embed.ndims(), Some(2));
    assert_eq!(embed.max_documents(), Some(8));
    assert_eq!(embed.modality(), Some(EmbedModality::Text));
    let embedding = within(embed.embed_text("abc")).await.expect("embedded");
    assert_eq!(embedding.vec, vec![3.0, 1.0]);
    let report = within(embed.embed_images(vec![vec![1]]))
        .await
        .expect_err("text handler");
    assert_eq!(report.kind, ErrorKind::HandlerUnavailable);
}

#[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
struct Session(String);

impl rig_core::tool::ContextValue for Session {
    const KEY: &'static str = "test.session";
}

#[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
struct Stale;

impl rig_core::tool::ContextValue for Stale {
    const KEY: &'static str = "test.stale";
}

/// A tool-family handler that is not a tool adapter and publishes nothing;
/// it records what the dispatch's own `ToolContext` scope held.
struct Silent {
    /// `(session seen, stale result metadata seen)` on the dispatch scope.
    seen: std::sync::Arc<std::sync::Mutex<Option<(bool, bool)>>>,
}

impl rig_core::serve::Serve for Silent {
    type Family = family::Tool;

    fn descriptor(&self) -> rig_core::effect::HandlerDescriptor {
        rig_core::effect::HandlerDescriptor {
            key: rig_core::effect::tool_key("silent"),
            family: rig_core::effect::FamilyDescriptor::Tool {
                name: "silent".into(),
                description: "answers without publishing".into(),
                parameters: json!({"type": "object"}),
                embedding: None,
            },
            layers: Vec::new(),
        }
    }

    async fn serve(
        &self,
        _kind: rig_core::effect::EffectKind,
        dispatch: rig_core::serve::Dispatch,
    ) -> rig_core::serve::Reply {
        let scope = dispatch.scope::<ToolContext>();
        *self.seen.lock().expect("seen") = scope.map(|context| {
            (
                context.get::<Session>().ok().flatten().is_some(),
                context.result::<Stale>().ok().flatten().is_some(),
            )
        });
        rig_core::serve::Reply::Outcome(Ok(rig_core::effect::Outcome::ToolResult {
            result: rig_core::tool::ToolResult::success(rig_core::tool::ToolOutput::text("silent")),
        }))
    }
}

/// The tool runs on a dispatch snapshot — the caller's inbound values, none
/// of its stale result metadata — whether or not the handler is a tool
/// adapter; and the answer's context is that snapshot when the handler
/// published nothing: never an empty context, never stale metadata.
#[tokio::test]
async fn a_tool_answer_keeps_inbound_values_when_the_handler_publishes_nothing() {
    let (dispatcher, _registrar, mut driver) = Bus::channel();
    let seen = std::sync::Arc::new(std::sync::Mutex::new(None));
    driver
        .register("silent", Silent { seen: seen.clone() })
        .expect("register");
    let task = tokio::spawn(driver);

    let tool: ToolHandle = dispatcher
        .handle(&HandlerKey::from("silent"))
        .expect("tool");
    let mut context = ToolContext::new();
    context.insert(Session("s-1".into())).expect("inbound");
    context.insert_result(Stale).expect("stale result metadata");
    let answer = within(tool.call("silent", "{}", context))
        .await
        .expect("called");
    assert_eq!(answer.result.output().as_text(), Some("silent"));
    assert_eq!(
        *seen.lock().expect("seen"),
        Some((true, false)),
        "the handler's scope holds the inbound snapshot, not the caller's result metadata"
    );
    assert_eq!(
        answer.context.get::<Session>().expect("decodes"),
        Some(Session("s-1".into()))
    );
    assert_eq!(answer.context.result::<Stale>().expect("decodes"), None);

    drop((tool, dispatcher));
    within(task).await.expect("driver ends");
}

#[tokio::test]
async fn handles_fail_closed_when_the_driver_is_gone() {
    let (dispatcher, _registrar, mut driver) = Bus::channel();
    driver
        .register("double", ToolAdapter::new(Double))
        .expect("register");
    let tool: ToolHandle = dispatcher
        .handle(&HandlerKey::from("double"))
        .expect("tool");
    drop(driver);
    assert!(tool.is_closed());
    let report = within(tool.call("double", "{}", ToolContext::new()))
        .await
        .expect_err("closed");
    assert_eq!(report.kind, ErrorKind::BusClosed);
}