orchestral-runtime 0.2.0

Thread Runtime with concurrency, interruption, scheduling, LLM planners, actions, and API for Orchestral
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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
use std::collections::{HashMap, HashSet};

use serde_json::Value;

use super::materialize::parse_path_segments;
use super::types::{
    AgentCaptureMode, AgentDecision, AgentMode, AgentOutputCandidate, AgentOutputRule,
    AgentPathSegment, AgentStepParams,
};

pub(super) fn parse_output_rules(
    step_id: &str,
    output_rules: Option<&Value>,
    output_sources_legacy: Option<&Value>,
    output_keys: &[String],
) -> Result<HashMap<String, AgentOutputRule>, String> {
    let mut out = HashMap::new();
    if let Some(value) = output_rules {
        let parsed = parse_output_rules_object(step_id, "output_rules", value, output_keys)?;
        out.extend(parsed);
    }

    if let Some(value) = output_sources_legacy {
        let parsed = parse_legacy_output_sources(step_id, value, output_keys)?;
        for (key, rule) in parsed {
            out.entry(key).or_insert(rule);
        }
    }

    Ok(out)
}

fn parse_output_rules_object(
    step_id: &str,
    field_name: &str,
    value: &Value,
    output_keys: &[String],
) -> Result<HashMap<String, AgentOutputRule>, String> {
    let Some(obj) = value.as_object() else {
        return Err(format!(
            "invalid agent params in step '{}': {} must be an object",
            step_id, field_name
        ));
    };

    let allowed = output_keys
        .iter()
        .map(String::as_str)
        .collect::<HashSet<_>>();
    let mut out = HashMap::with_capacity(obj.len());
    for (key, raw_rule) in obj {
        if !allowed.contains(key.as_str()) {
            return Err(format!(
                "invalid agent params in step '{}': {} key '{}' is not declared in output_keys",
                step_id, field_name, key
            ));
        }
        let rule = parse_output_rule_entry(step_id, key, raw_rule)?;
        out.insert(key.clone(), rule);
    }
    Ok(out)
}

fn parse_output_rule_entry(
    step_id: &str,
    output_key: &str,
    value: &Value,
) -> Result<AgentOutputRule, String> {
    let Some(obj) = value.as_object() else {
        return Err(format!(
            "invalid agent params in step '{}': output_rules.{} must be an object",
            step_id, output_key
        ));
    };

    let mut candidates = Vec::new();
    let required_action =
        parse_required_action_entry(step_id, &format!("output_rules.{}", output_key), obj)?;
    if let Some(slot) = parse_rule_slot(step_id, output_key, obj.get("slot"))? {
        let path = parse_rule_path(
            step_id,
            output_key,
            obj.get("path").or_else(|| obj.get("field")),
        )?;
        candidates.push(AgentOutputCandidate {
            slot,
            path,
            required_action: None,
        });
    }

    if let Some(raw_candidates) = obj.get("candidates") {
        let arr = raw_candidates.as_array().ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': output_rules.{}.candidates must be an array",
                step_id, output_key
            )
        })?;
        for raw_candidate in arr {
            candidates.push(parse_output_candidate_entry(
                step_id,
                output_key,
                raw_candidate,
            )?);
        }
    }

    let template = obj
        .get("template")
        .map(|v| {
            v.as_str()
                .map(str::trim)
                .filter(|s| !s.is_empty())
                .map(str::to_string)
                .ok_or_else(|| {
                    format!(
                        "invalid agent params in step '{}': output_rules.{}.template must be a non-empty string",
                        step_id, output_key
                    )
                })
        })
        .transpose()?;

    let fallback_aliases = obj
        .get("fallback_aliases")
        .map(|v| {
            v.as_array()
                .ok_or_else(|| {
                    format!(
                        "invalid agent params in step '{}': output_rules.{}.fallback_aliases must be an array",
                        step_id, output_key
                    )
                })?
                .iter()
                .map(|item| {
                    item.as_str()
                        .map(str::trim)
                        .filter(|s| !s.is_empty())
                        .map(str::to_string)
                        .ok_or_else(|| {
                            format!(
                                "invalid agent params in step '{}': output_rules.{}.fallback_aliases must contain non-empty strings",
                                step_id, output_key
                            )
                        })
                })
                .collect::<Result<Vec<_>, _>>()
        })
        .transpose()?
        .unwrap_or_default();

    if candidates.is_empty() && template.is_none() && fallback_aliases.is_empty() {
        return Err(format!(
            "invalid agent params in step '{}': output_rules.{} must provide slot/candidates/template/fallback_aliases",
            step_id, output_key
        ));
    }

    Ok(AgentOutputRule {
        candidates,
        template,
        fallback_aliases,
        required_action,
    })
}

fn parse_output_candidate_entry(
    step_id: &str,
    output_key: &str,
    value: &Value,
) -> Result<AgentOutputCandidate, String> {
    let Some(obj) = value.as_object() else {
        return Err(format!(
            "invalid agent params in step '{}': output_rules.{}.candidates[] must be an object",
            step_id, output_key
        ));
    };
    let slot = parse_rule_slot(step_id, output_key, obj.get("slot"))?.ok_or_else(|| {
        format!(
            "invalid agent params in step '{}': output_rules.{}.candidates[].slot is required",
            step_id, output_key
        )
    })?;
    let path = parse_rule_path(step_id, output_key, obj.get("path"))?;
    let required_action = parse_required_action_entry(
        step_id,
        &format!("output_rules.{}.candidates[]", output_key),
        obj,
    )?;
    if slot == "outputs" && required_action.is_some() {
        return Err(format!(
            "invalid agent params in step '{}': output_rules.{}.candidates[].requires.action cannot target slot 'outputs'",
            step_id, output_key
        ));
    }
    Ok(AgentOutputCandidate {
        slot,
        path,
        required_action,
    })
}

fn parse_rule_slot(
    step_id: &str,
    output_key: &str,
    value: Option<&Value>,
) -> Result<Option<String>, String> {
    let Some(value) = value else {
        return Ok(None);
    };
    let slot = value
        .as_str()
        .map(str::trim)
        .filter(|v| !v.is_empty())
        .ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': output_rules.{}.slot must be a non-empty string",
                step_id, output_key
            )
        })?;
    Ok(Some(slot.to_string()))
}

fn parse_rule_path(
    step_id: &str,
    output_key: &str,
    value: Option<&Value>,
) -> Result<Vec<AgentPathSegment>, String> {
    let Some(value) = value else {
        return Ok(Vec::new());
    };
    let raw = value.as_str().map(str::trim).ok_or_else(|| {
        format!(
            "invalid agent params in step '{}': output_rules.{}.path must be a string",
            step_id, output_key
        )
    })?;
    if raw.is_empty() {
        return Ok(Vec::new());
    }
    parse_path_segments(raw).ok_or_else(|| {
        format!(
            "invalid agent params in step '{}': output_rules.{}.path has invalid syntax",
            step_id, output_key
        )
    })
}

fn parse_required_action_entry(
    step_id: &str,
    scope: &str,
    obj: &serde_json::Map<String, Value>,
) -> Result<Option<String>, String> {
    let direct = obj.get("requires_action");
    let structured = obj.get("requires");
    if direct.is_some() && structured.is_some() {
        return Err(format!(
            "invalid agent params in step '{}': {} cannot include both requires and requires_action",
            step_id, scope
        ));
    }

    if let Some(value) = direct {
        let action = value
            .as_str()
            .map(str::trim)
            .filter(|s| !s.is_empty())
            .ok_or_else(|| {
                format!(
                    "invalid agent params in step '{}': {}.requires_action must be a non-empty string",
                    step_id, scope
                )
            })?;
        return Ok(Some(action.to_string()));
    }

    let Some(value) = structured else {
        return Ok(None);
    };
    let requires = value.as_object().ok_or_else(|| {
        format!(
            "invalid agent params in step '{}': {}.requires must be an object",
            step_id, scope
        )
    })?;
    let action = requires.get("action").ok_or_else(|| {
        format!(
            "invalid agent params in step '{}': {}.requires.action is required",
            step_id, scope
        )
    })?;
    let action = action
        .as_str()
        .map(str::trim)
        .filter(|s| !s.is_empty())
        .ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': {}.requires.action must be a non-empty string",
                step_id, scope
            )
        })?;
    Ok(Some(action.to_string()))
}

fn parse_legacy_output_sources(
    step_id: &str,
    value: &Value,
    output_keys: &[String],
) -> Result<HashMap<String, AgentOutputRule>, String> {
    parse_output_rules_object(step_id, "output_sources", value, output_keys)
}

fn parse_optional_slot_name(scope: &str, value: Option<&Value>) -> Result<Option<String>, String> {
    let Some(value) = value else {
        return Ok(None);
    };
    let name = value
        .as_str()
        .map(str::trim)
        .filter(|v| !v.is_empty())
        .ok_or_else(|| format!("{}: save_as must be a non-empty string", scope))?;
    Ok(Some(name.to_string()))
}

fn parse_optional_capture_mode(
    scope: &str,
    value: Option<&Value>,
) -> Result<Option<AgentCaptureMode>, String> {
    let Some(value) = value else {
        return Ok(None);
    };
    let mode = value
        .as_str()
        .map(str::trim)
        .filter(|v| !v.is_empty())
        .ok_or_else(|| format!("{}: capture must be a non-empty string", scope))?;
    match mode.to_ascii_lowercase().as_str() {
        "json_stdout" => Ok(Some(AgentCaptureMode::JsonStdout)),
        other => Err(format!("{}: unsupported capture mode '{}'", scope, other)),
    }
}

pub(super) fn parse_agent_params(step_id: &str, params: &Value) -> Result<AgentStepParams, String> {
    let Some(obj) = params.as_object() else {
        return Err(format!(
            "invalid agent params in step '{}': params must be an object",
            step_id
        ));
    };

    let mode = match obj.get("mode").and_then(|v| v.as_str()) {
        None | Some("explore") => AgentMode::Explore,
        Some("leaf") => AgentMode::Leaf,
        Some(other) => {
            return Err(format!(
                "invalid agent params in step '{}': unsupported mode '{}'",
                step_id, other
            ));
        }
    };

    let goal = obj
        .get("goal")
        .and_then(|v| v.as_str())
        .map(str::trim)
        .filter(|v| !v.is_empty())
        .ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': goal is required",
                step_id
            )
        })?
        .to_string();

    let allowed_actions = obj
        .get("allowed_actions")
        .and_then(|v| v.as_array())
        .ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': allowed_actions must be a non-empty array",
                step_id
            )
        })?
        .iter()
        .filter_map(|v| v.as_str().map(str::trim))
        .filter(|v| !v.is_empty())
        .map(str::to_string)
        .collect::<HashSet<_>>();
    if allowed_actions.is_empty() {
        return Err(format!(
            "invalid agent params in step '{}': allowed_actions must be a non-empty array",
            step_id
        ));
    }
    if mode == AgentMode::Leaf && allowed_actions.iter().any(|action| action != "json_stdout") {
        return Err(format!(
            "invalid agent params in step '{}': leaf mode only supports allowed_actions=['json_stdout']",
            step_id
        ));
    }

    let max_iterations = obj
        .get("max_iterations")
        .and_then(|v| v.as_u64())
        .ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': max_iterations is required",
                step_id
            )
        })?;
    if !(1..=10).contains(&max_iterations) {
        return Err(format!(
            "invalid agent params in step '{}': max_iterations must be in [1,10]",
            step_id
        ));
    }
    if mode == AgentMode::Leaf && !(1..=3).contains(&max_iterations) {
        return Err(format!(
            "invalid agent params in step '{}': leaf mode max_iterations must be in [1,3]",
            step_id
        ));
    }

    let output_keys = obj
        .get("output_keys")
        .and_then(|v| v.as_array())
        .ok_or_else(|| {
            format!(
                "invalid agent params in step '{}': output_keys must be a non-empty array",
                step_id
            )
        })?
        .iter()
        .filter_map(|v| v.as_str().map(str::trim))
        .filter(|v| !v.is_empty())
        .map(str::to_string)
        .collect::<Vec<_>>();
    if output_keys.is_empty() {
        return Err(format!(
            "invalid agent params in step '{}': output_keys must be a non-empty array",
            step_id
        ));
    }

    let result_slot = obj
        .get("result_slot")
        .and_then(|v| v.as_str())
        .map(str::trim)
        .filter(|v| !v.is_empty())
        .map(str::to_string);
    if mode == AgentMode::Leaf && result_slot.is_none() {
        return Err(format!(
            "invalid agent params in step '{}': leaf mode requires result_slot",
            step_id
        ));
    }

    let output_rules = parse_output_rules(
        step_id,
        obj.get("output_rules"),
        obj.get("output_sources"),
        &output_keys,
    )?;

    let bound_inputs = obj
        .iter()
        .filter_map(|(key, value)| {
            if matches!(
                key.as_str(),
                "mode"
                    | "result_slot"
                    | "result_hint"
                    | "leaf_hint"
                    | "leaf_schema"
                    | "goal"
                    | "allowed_actions"
                    | "max_iterations"
                    | "output_keys"
                    | "output_rules"
                    | "output_sources"
            ) {
                None
            } else {
                Some((key.clone(), value.clone()))
            }
        })
        .collect::<HashMap<_, _>>();

    Ok(AgentStepParams {
        mode,
        goal,
        allowed_actions,
        max_iterations,
        output_keys,
        output_rules,
        result_slot,
        bound_inputs,
    })
}

pub(super) fn parse_tool_call_decision(name: &str, args: Value) -> Result<AgentDecision, String> {
    match name {
        "execute_action" => {
            let action = args
                .get("action")
                .and_then(|v| v.as_str())
                .map(str::trim)
                .filter(|v| !v.is_empty())
                .ok_or_else(|| "execute_action: missing 'action' field".to_string())?
                .to_string();
            let params = args
                .get("params")
                .cloned()
                .unwrap_or(Value::Object(Default::default()));
            let save_as = parse_optional_slot_name("execute_action", args.get("save_as"))?;
            let capture = parse_optional_capture_mode("execute_action", args.get("capture"))?;
            Ok(AgentDecision::Action {
                name: action,
                params,
                save_as,
                capture,
            })
        }
        "finish" => Ok(AgentDecision::Finish),
        "return_final" => {
            let exports = args
                .get("exports")
                .and_then(|v| v.as_object())
                .ok_or_else(|| "return_final: missing object field 'exports'".to_string())?
                .iter()
                .map(|(k, v)| (k.clone(), v.clone()))
                .collect::<HashMap<_, _>>();
            Ok(AgentDecision::Final { exports })
        }
        other => Err(format!("unknown tool: '{}'", other)),
    }
}

pub(super) fn parse_agent_decision(json: &str) -> Result<AgentDecision, String> {
    let value: Value = serde_json::from_str(json).map_err(|e| format!("invalid json: {}", e))?;
    let Some(obj) = value.as_object() else {
        return Err("decision must be a JSON object".to_string());
    };

    let decision_type = obj
        .get("type")
        .and_then(|v| v.as_str())
        .map(|v| v.to_ascii_lowercase())
        .ok_or_else(|| "missing decision field 'type'".to_string())?;
    match decision_type.as_str() {
        "action" => {
            let name = obj
                .get("action")
                .and_then(|v| v.as_str())
                .map(str::trim)
                .filter(|v| !v.is_empty())
                .ok_or_else(|| "action decision missing 'action'".to_string())?
                .to_string();
            let params = obj
                .get("params")
                .cloned()
                .unwrap_or(Value::Object(Default::default()));
            let save_as = parse_optional_slot_name("action", obj.get("save_as"))?;
            let capture = parse_optional_capture_mode("action", obj.get("capture"))?;
            Ok(AgentDecision::Action {
                name,
                params,
                save_as,
                capture,
            })
        }
        "finish" => Ok(AgentDecision::Finish),
        "final" => {
            let exports = obj
                .get("exports")
                .and_then(|v| v.as_object())
                .ok_or_else(|| "final decision missing object field 'exports'".to_string())?
                .iter()
                .map(|(k, v)| (k.clone(), v.clone()))
                .collect::<HashMap<_, _>>();
            Ok(AgentDecision::Final { exports })
        }
        other => Err(format!("unsupported decision type '{}'", other)),
    }
}

pub(super) fn extract_json(text: &str) -> Option<String> {
    let chars: Vec<char> = text.chars().collect();
    let mut start = None;
    let mut depth = 0_u32;
    let mut in_string = false;
    let mut escaped = false;
    for (idx, ch) in chars.iter().enumerate() {
        if in_string {
            if escaped {
                escaped = false;
            } else if *ch == '\\' {
                escaped = true;
            } else if *ch == '"' {
                in_string = false;
            }
            continue;
        }
        if *ch == '"' {
            in_string = true;
            continue;
        }
        if *ch == '{' {
            if start.is_none() {
                start = Some(idx);
            }
            depth = depth.saturating_add(1);
        } else if *ch == '}' {
            if depth == 0 {
                continue;
            }
            depth -= 1;
            if depth == 0 {
                if let Some(start_idx) = start {
                    let candidate: String = chars[start_idx..=idx].iter().collect();
                    if serde_json::from_str::<Value>(&candidate).is_ok() {
                        return Some(candidate);
                    }
                }
                start = None;
            }
        }
    }
    None
}

pub(super) fn normalize_agent_action_params(action_name: &str, params: Value) -> Value {
    if action_name != "json_stdout" {
        return params;
    }
    let Some(obj) = params.as_object() else {
        return serde_json::json!({ "payload": params });
    };
    if obj.contains_key("payload") {
        return Value::Object(obj.clone());
    }
    serde_json::json!({ "payload": Value::Object(obj.clone()) })
}