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
use std::sync::{
    Arc, Mutex,
    atomic::{AtomicUsize, Ordering},
};

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

use crate::{
    agent::{AgentBuilder, AgentHook, HookContext, OutcomeAction, OutcomeEvent},
    completion::Document,
    test_utils::{MockCompletionModel, MockStreamEvent, MockTurn},
    tool::{Tool, ToolContext, ToolErrorKind, ToolExecutionError},
};
use rig_core::completion::CompletionRequest;
use rig_core::message::ToolChoice;

struct MetadataFailingTool;

#[derive(serde::Serialize, serde::Deserialize)]
struct SnapshotValue {
    value: usize,
}

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

#[derive(serde::Serialize, serde::Deserialize)]
struct SnapshotResult(usize);

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

#[derive(serde::Serialize, serde::Deserialize)]
struct ResultMetadata(String);

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

#[derive(Clone, Default)]
struct SnapshotMutatingTool(Arc<Mutex<Vec<usize>>>);

impl Tool for SnapshotMutatingTool {
    const NAME: &'static str = "snapshot_mutator";
    type Error = rig::tool::ToolExecutionError;
    type Args = serde_json::Value;
    type Output = String;

    fn description(&self) -> String {
        "Mutates its per-dispatch context snapshot".into()
    }

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

    async fn call(
        &self,
        context: &mut ToolContext,
        _args: Self::Args,
    ) -> Result<Self::Output, ToolExecutionError> {
        let initial = context.require::<SnapshotValue>()?.value;
        self.0.lock().expect("observed values").push(initial);
        let updated = initial + 1;
        context.insert(SnapshotValue { value: updated })?;
        context.insert_result(SnapshotResult(updated))?;
        Ok(updated.to_string())
    }
}

#[derive(Clone, Default)]
struct SnapshotResults(Arc<Mutex<Vec<usize>>>);

impl AgentHook for SnapshotResults {
    async fn on_outcome(&self, _ctx: &HookContext, event: OutcomeEvent<'_>) -> OutcomeAction {
        let Some(context) = event.tool_context() else {
            return OutcomeAction::proceed();
        };
        self.0.lock().expect("result values").push(
            context
                .require_result::<SnapshotResult>()
                .expect("per-dispatch result metadata")
                .0,
        );
        OutcomeAction::proceed()
    }
}

impl Tool for MetadataFailingTool {
    const NAME: &'static str = "flaky_tool";
    type Error = rig::tool::ToolExecutionError;
    type Args = serde_json::Value;
    type Output = String;

    fn description(&self) -> String {
        "Fails after attaching result metadata".into()
    }

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

    async fn call(
        &self,
        context: &mut ToolContext,
        _args: Self::Args,
    ) -> Result<Self::Output, ToolExecutionError> {
        context.insert_result(ResultMetadata("shared-result-metadata".to_string()))?;
        Err(ToolExecutionError::timeout("raw timeout failure"))
    }
}

#[derive(Clone, Default)]
struct Results(Arc<Mutex<Vec<(ToolErrorKind, String, String)>>>);

impl AgentHook for Results {
    async fn on_outcome(&self, _ctx: &HookContext, event: OutcomeEvent<'_>) -> OutcomeAction {
        let Some(result) = event.tool_result() else {
            return OutcomeAction::proceed();
        };
        if let Some(error) = result.error() {
            self.0.lock().expect("results").push((
                error.kind(),
                result.output().render(),
                event
                    .tool_context()
                    .expect("tool outcome carries its context")
                    .result::<ResultMetadata>()
                    .expect("tool result metadata decodes")
                    .expect("tool result metadata")
                    .0,
            ));
        }
        OutcomeAction::rewrite_tool_result(&event, "rewritten for model")
    }
}

#[test]
fn agent_exposes_read_only_name_and_description() {
    let named = AgentBuilder::new(MockCompletionModel::text("done"))
        .name("researcher")
        .description("Finds evidence")
        .build();
    assert_eq!(named.name(), Some("researcher"));
    assert_eq!(named.description(), Some("Finds evidence"));

    let unnamed = AgentBuilder::new(MockCompletionModel::text("done")).build();
    assert_eq!(unnamed.name(), None);
    assert_eq!(unnamed.description(), None);
}

#[tokio::test]
async fn runner_applies_per_run_request_overrides() {
    let model = MockCompletionModel::text("done");
    AgentBuilder::new(model.clone())
        .preamble("baseline preamble")
        .context("baseline document")
        .temperature(0.1)
        .max_tokens(10)
        .additional_params(json!({"baseline": true}))
        .build()
        .prompt("go")
        .preamble("run preamble")
        .document(Document {
            id: "run-one".into(),
            text: "first run document".into(),
            additional_props: Default::default(),
        })
        .documents([Document {
            id: "run-two".into(),
            text: "second run document".into(),
            additional_props: Default::default(),
        }])
        .temperature(0.7)
        .max_tokens(42)
        .replace_additional_params(json!({"override": true}))
        .tool_choice(ToolChoice::None)
        .run()
        .await
        .expect("runner request should succeed");

    let requests = model.requests();
    let request = requests.first().expect("one request");
    assert!(request.chat_history.iter().any(
        |message| matches!(message, crate::completion::Message::System { content } if content == "run preamble")
    ));
    assert!(
        request
            .documents
            .iter()
            .any(|document| document.text == "baseline document")
    );
    assert!(
        request
            .documents
            .iter()
            .any(|document| document.id == "run-one")
    );
    assert!(
        request
            .documents
            .iter()
            .any(|document| document.id == "run-two")
    );
    assert_eq!(request.temperature, Some(0.7));
    assert_eq!(request.max_tokens, Some(42));
    assert_eq!(request.additional_params, Some(json!({"override": true})));
    assert_eq!(request.tool_choice, Some(ToolChoice::None));
}

#[tokio::test]
async fn runner_can_merge_additional_params_into_the_baseline() {
    let model = MockCompletionModel::text("done");
    AgentBuilder::new(model.clone())
        .additional_params(json!({"baseline": true, "winner": "baseline"}))
        .build()
        .prompt("go")
        .merge_additional_params(
            json!({"override": true, "winner": "runner"})
                .as_object()
                .expect("object")
                .clone(),
        )
        .run()
        .await
        .expect("runner request should succeed");

    assert_eq!(
        model
            .requests()
            .first()
            .expect("one request")
            .additional_params,
        Some(json!({"baseline": true, "override": true, "winner": "runner"}))
    );
}

#[tokio::test]
async fn runner_can_replace_additional_params_wholesale() {
    let model = MockCompletionModel::text("done");
    AgentBuilder::new(model.clone())
        .additional_params(json!({"baseline": true}))
        .build()
        .prompt("go")
        .replace_additional_params(json!({"replacement": true}))
        .run()
        .await
        .expect("runner request should succeed");

    let requests = model.requests();
    let request = requests.first().expect("one request");
    assert_eq!(
        request.additional_params,
        Some(json!({"replacement": true}))
    );
}

#[tokio::test]
async fn runner_can_clear_configured_request_defaults() {
    let model = MockCompletionModel::text("done");
    AgentBuilder::new(model.clone())
        .preamble("baseline")
        .temperature(0.1)
        .max_tokens(10)
        .additional_params(json!({"baseline": true}))
        .tool_choice(ToolChoice::Required)
        .build()
        .prompt("go")
        .without_preamble()
        .without_temperature()
        .without_max_tokens()
        .without_additional_params()
        .without_tool_choice()
        .run()
        .await
        .expect("runner request should succeed");

    let requests = model.requests();
    let request = requests.first().expect("one request");
    assert!(
        !request
            .chat_history
            .iter()
            .any(|message| matches!(message, crate::completion::Message::System { .. }))
    );
    assert_eq!(request.temperature, None);
    assert_eq!(request.max_tokens, None);
    assert_eq!(request.additional_params, None);
    assert_eq!(request.tool_choice, None);
}

#[tokio::test]
async fn direct_completion_model_requests_are_intentionally_hook_free() {
    #[derive(Clone)]
    struct CountCompletionCalls(Arc<AtomicUsize>);

    impl AgentHook for CountCompletionCalls {
        async fn on_completion_call(
            &self,
            _ctx: &HookContext,
            _event: crate::agent::CompletionCallEvent<'_>,
        ) -> crate::agent::CompletionCallAction {
            self.0.fetch_add(1, Ordering::SeqCst);
            crate::agent::CompletionCallAction::Continue
        }
    }

    let model = MockCompletionModel::text("raw response");
    let calls = Arc::new(AtomicUsize::new(0));
    let _agent = AgentBuilder::new(model.clone())
        .add_hook(CountCompletionCalls(calls.clone()))
        .build();

    model
        .call(CompletionRequest::new("raw request"))
        .await
        .expect("direct model request should succeed");

    assert_eq!(calls.load(Ordering::SeqCst), 0);
    assert_eq!(model.request_count(), 1);
}

#[tokio::test]
async fn blocking_and_streaming_preserve_raw_failure_while_rewriting_presentation() {
    let blocking = Results::default();
    let blocking_model = MockCompletionModel::from_turns([
        MockTurn::tool_call("tc1", "flaky_tool", json!({})),
        MockTurn::text("done"),
    ]);
    AgentBuilder::new(blocking_model.clone())
        .tool(MetadataFailingTool)
        .add_hook(blocking.clone())
        .build()
        .prompt("go")
        .max_turns(3)
        .run()
        .await
        .expect("blocking run");

    let streaming = Results::default();
    let streaming_model = MockCompletionModel::from_stream_turns([
        vec![
            MockStreamEvent::tool_call_name_delta("tc1", "flaky_tool"),
            MockStreamEvent::tool_call_arguments_delta("tc1", "{}"),
            MockStreamEvent::tool_call("tc1", "flaky_tool", json!({})),
            MockStreamEvent::final_response_with_total_tokens(0),
        ],
        vec![
            MockStreamEvent::text("done"),
            MockStreamEvent::final_response_with_total_tokens(0),
        ],
    ]);
    let mut stream = AgentBuilder::new(streaming_model.clone())
        .tool(MetadataFailingTool)
        .add_hook(streaming.clone())
        .build()
        .prompt("go")
        .max_turns(3)
        .stream();
    while let Some(item) = stream.next().await {
        item.expect("stream item");
    }

    assert_eq!(*blocking.0.lock().unwrap(), *streaming.0.lock().unwrap());
    assert_eq!(
        *blocking.0.lock().unwrap(),
        vec![(
            ToolErrorKind::Timeout,
            "raw timeout failure".into(),
            "shared-result-metadata".into()
        )]
    );

    let blocking_history = serde_json::to_value(
        &blocking_model
            .requests()
            .get(1)
            .expect("second blocking request")
            .chat_history,
    )
    .unwrap();
    let streaming_history = serde_json::to_value(
        &streaming_model
            .requests()
            .get(1)
            .expect("second streaming request")
            .chat_history,
    )
    .unwrap();
    assert_eq!(blocking_history, streaming_history);
    let history = blocking_history.to_string();
    assert!(history.contains("rewritten for model"));
    assert!(!history.contains("raw timeout failure"));
}

#[tokio::test]
async fn agent_dispatch_snapshot_isolates_tool_mutations() {
    let mut context = ToolContext::new();
    context.insert(SnapshotValue { value: 0 }).unwrap();
    let tool = SnapshotMutatingTool::default();
    let results = SnapshotResults::default();

    AgentBuilder::new(MockCompletionModel::from_turns([
        MockTurn::tool_call("tc1", SnapshotMutatingTool::NAME, json!({})),
        MockTurn::tool_call("tc2", SnapshotMutatingTool::NAME, json!({})),
        MockTurn::text("done"),
    ]))
    .tool(tool.clone())
    .add_hook(results.clone())
    .build()
    .prompt("go")
    .tool_context(context)
    .max_turns(4)
    .run()
    .await
    .expect("agent run");

    assert_eq!(*tool.0.lock().expect("observed values"), vec![0, 0]);
    assert_eq!(*results.0.lock().expect("result values"), vec![1, 1]);
}