robot_lab 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.architecture/AGENTS.md +32 -0
- data/.architecture/config.yml +8 -0
- data/.architecture/members.yml +60 -0
- data/.architecture/reviews/feature-free-will.md +490 -0
- data/.architecture/reviews/overall-codebase.md +427 -0
- data/.claude/settings.local.json +57 -0
- data/.codex/config.toml +2 -0
- data/.irbrc +2 -2
- data/.rubocop.yml +172 -0
- data/CHANGELOG.md +72 -0
- data/CLAUDE.md +139 -0
- data/README.md +91 -95
- data/Rakefile +109 -3
- data/agent2agent_review.md +192 -0
- data/agentf_improvements.md +253 -0
- data/agents.md +14 -0
- data/docs/examples/index.md +37 -2
- data/docs/getting-started/configuration.md +20 -7
- data/docs/guides/index.md +16 -16
- data/docs/guides/knowledge.md +7 -1
- data/docs/guides/observability.md +132 -0
- data/docs/index.md +30 -3
- data/docs/superpowers/plans/2026-05-06-agentskills.md +1303 -0
- data/docs/superpowers/specs/2026-05-06-agentskills-design.md +247 -0
- data/examples/.envrc +1 -0
- data/examples/01_simple_robot.rb +5 -9
- data/examples/02_tools.rb +5 -9
- data/examples/03_network.rb +8 -9
- data/examples/04_mcp.rb +21 -29
- data/examples/05_streaming.rb +12 -18
- data/examples/06_prompt_templates.rb +11 -19
- data/examples/07_network_memory.rb +16 -31
- data/examples/08_llm_config.rb +10 -22
- data/examples/09_chaining.rb +16 -27
- data/examples/10_memory.rb +12 -28
- data/examples/11_network_introspection.rb +15 -29
- data/examples/12_message_bus.rb +5 -12
- data/examples/13_spawn.rb +5 -10
- data/examples/14_rusty_circuit/.envrc +1 -0
- data/examples/14_rusty_circuit/comic.rb +2 -0
- data/examples/14_rusty_circuit/heckler.rb +1 -1
- data/examples/14_rusty_circuit/open_mic.rb +1 -3
- data/examples/14_rusty_circuit/scout.rb +2 -0
- data/examples/15_memory_network_and_bus/.envrc +1 -0
- data/examples/15_memory_network_and_bus/editorial_pipeline.rb +6 -3
- data/examples/15_memory_network_and_bus/linux_writer.rb +1 -1
- data/examples/15_memory_network_and_bus/output/combined_article.md +6 -6
- data/examples/15_memory_network_and_bus/output/final_article.md +6 -8
- data/examples/15_memory_network_and_bus/output/linux_draft.md +4 -2
- data/examples/15_memory_network_and_bus/output/mac_draft.md +3 -3
- data/examples/15_memory_network_and_bus/output/memory.json +6 -6
- data/examples/15_memory_network_and_bus/output/revision_1.md +10 -11
- data/examples/15_memory_network_and_bus/output/revision_2.md +6 -8
- data/examples/15_memory_network_and_bus/output/windows_draft.md +3 -3
- data/examples/16_writers_room/.envrc +1 -0
- data/examples/16_writers_room/writers_room.rb +2 -4
- data/examples/17_skills.rb +8 -17
- data/examples/18_rails/Gemfile +1 -0
- data/examples/19_token_tracking.rb +9 -15
- data/examples/20_circuit_breaker.rb +10 -19
- data/examples/21_learning_loop.rb +11 -20
- data/examples/22_context_compression.rb +6 -13
- data/examples/23_convergence.rb +6 -17
- data/examples/24_structured_delegation.rb +11 -15
- data/examples/25_history_search.rb +5 -12
- data/examples/26_document_store.rb +6 -13
- data/examples/27_incident_response/incident_response.rb +4 -5
- data/examples/28_mcp_discovery.rb +8 -11
- data/examples/29_ractor_tools.rb +4 -9
- data/examples/30_ractor_network.rb +10 -19
- data/examples/31_launch_assessment.rb +10 -23
- data/examples/32_newsletter_reader.rb +188 -0
- data/examples/33_stock_generator.rb +80 -0
- data/examples/33_stock_predictor.rb +306 -0
- data/examples/34_agentskills.rb +72 -0
- data/examples/README.md +1 -1
- data/examples/common.rb +76 -0
- data/examples/ruboruby.md +423 -0
- data/examples/temp.md +51 -0
- data/lib/robot_lab/agent_skill.rb +63 -0
- data/lib/robot_lab/agent_skill_catalog.rb +74 -0
- data/lib/robot_lab/ask_user.rb +2 -2
- data/lib/robot_lab/bus_poller.rb +12 -5
- data/lib/robot_lab/config.rb +1 -12
- data/lib/robot_lab/delegation_future.rb +1 -1
- data/lib/robot_lab/doom_loop_detector.rb +98 -0
- data/lib/robot_lab/history_compressor.rb +4 -10
- data/lib/robot_lab/mcp/client.rb +1 -2
- data/lib/robot_lab/mcp/connection_poller.rb +3 -3
- data/lib/robot_lab/mcp/server.rb +1 -1
- data/lib/robot_lab/mcp/server_discovery.rb +0 -2
- data/lib/robot_lab/memory.rb +32 -27
- data/lib/robot_lab/memory_change.rb +2 -2
- data/lib/robot_lab/message.rb +4 -4
- data/lib/robot_lab/network.rb +11 -6
- data/lib/robot_lab/robot/agent_skill_matching.rb +99 -0
- data/lib/robot_lab/robot/bus_messaging.rb +9 -27
- data/lib/robot_lab/robot/history_search.rb +4 -1
- data/lib/robot_lab/robot/mcp_management.rb +5 -11
- data/lib/robot_lab/robot/template_rendering.rb +60 -40
- data/lib/robot_lab/robot.rb +323 -206
- data/lib/robot_lab/robot_result.rb +6 -5
- data/lib/robot_lab/run_config.rb +5 -11
- data/lib/robot_lab/script_tool.rb +76 -0
- data/lib/robot_lab/state_proxy.rb +7 -5
- data/lib/robot_lab/tool.rb +3 -3
- data/lib/robot_lab/tool_config.rb +1 -1
- data/lib/robot_lab/tool_manifest.rb +5 -7
- data/lib/robot_lab/user_message.rb +2 -2
- data/lib/robot_lab/version.rb +1 -1
- data/lib/robot_lab/waiter.rb +1 -1
- data/lib/robot_lab.rb +41 -52
- data/logfile +8 -0
- data/mkdocs.yml +2 -3
- data/robot_concurrency.md +38 -0
- data/simple_acp_review.md +298 -0
- data/site/404.html +2300 -0
- data/site/api/core/index.html +2706 -0
- data/site/api/core/memory/index.html +3793 -0
- data/site/api/core/network/index.html +3500 -0
- data/site/api/core/robot/index.html +4566 -0
- data/site/api/core/state/index.html +3390 -0
- data/site/api/core/tool/index.html +3843 -0
- data/site/api/index.html +2635 -0
- data/site/api/mcp/client/index.html +3435 -0
- data/site/api/mcp/index.html +2783 -0
- data/site/api/mcp/server/index.html +3252 -0
- data/site/api/mcp/transports/index.html +3352 -0
- data/site/api/messages/index.html +2641 -0
- data/site/api/messages/text-message/index.html +3087 -0
- data/site/api/messages/tool-call-message/index.html +3159 -0
- data/site/api/messages/tool-result-message/index.html +3252 -0
- data/site/api/messages/user-message/index.html +3212 -0
- data/site/api/streaming/context/index.html +3282 -0
- data/site/api/streaming/events/index.html +3347 -0
- data/site/api/streaming/index.html +2738 -0
- data/site/architecture/core-concepts/index.html +3757 -0
- data/site/architecture/index.html +2797 -0
- data/site/architecture/message-flow/index.html +3238 -0
- data/site/architecture/network-orchestration/index.html +3433 -0
- data/site/architecture/robot-execution/index.html +3140 -0
- data/site/architecture/state-management/index.html +3498 -0
- data/site/assets/css/custom.css +56 -0
- data/site/assets/images/favicon.png +0 -0
- data/site/assets/images/robot_lab.jpg +0 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js +16 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js.map +7 -0
- data/site/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
- data/site/assets/javascripts/lunr/tinyseg.js +206 -0
- data/site/assets/javascripts/lunr/wordcut.js +6708 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css +1 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css.map +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
- data/site/concepts/index.html +3455 -0
- data/site/examples/basic-chat/index.html +2880 -0
- data/site/examples/index.html +2907 -0
- data/site/examples/mcp-server/index.html +3018 -0
- data/site/examples/multi-robot-network/index.html +3131 -0
- data/site/examples/rails-application/index.html +3329 -0
- data/site/examples/tool-usage/index.html +3085 -0
- data/site/getting-started/configuration/index.html +3745 -0
- data/site/getting-started/index.html +2572 -0
- data/site/getting-started/installation/index.html +2981 -0
- data/site/getting-started/quick-start/index.html +2942 -0
- data/site/guides/building-robots/index.html +4290 -0
- data/site/guides/creating-networks/index.html +3858 -0
- data/site/guides/index.html +2586 -0
- data/site/guides/mcp-integration/index.html +3581 -0
- data/site/guides/memory/index.html +3586 -0
- data/site/guides/rails-integration/index.html +4019 -0
- data/site/guides/streaming/index.html +3157 -0
- data/site/guides/using-tools/index.html +3802 -0
- data/site/index.html +2671 -0
- data/site/search/search_index.json +1 -0
- data/site/sitemap.xml +183 -0
- data/site/sitemap.xml.gz +0 -0
- data/site/tags.json +1 -0
- data/temp.md +6 -0
- data/tool_manifest_plan.md +155 -0
- metadata +154 -92
- data/docs/examples/rails-application.md +0 -419
- data/docs/guides/ractor-parallelism.md +0 -364
- data/docs/guides/rails-integration.md +0 -681
- data/docs/superpowers/plans/2026-04-14-ractor-integration.md +0 -1538
- data/docs/superpowers/specs/2026-04-14-ractor-integration-design.md +0 -258
- data/lib/generators/robot_lab/install_generator.rb +0 -90
- data/lib/generators/robot_lab/job_generator.rb +0 -40
- data/lib/generators/robot_lab/robot_generator.rb +0 -55
- data/lib/generators/robot_lab/templates/initializer.rb.tt +0 -42
- data/lib/generators/robot_lab/templates/job.rb.tt +0 -21
- data/lib/generators/robot_lab/templates/migration.rb.tt +0 -32
- data/lib/generators/robot_lab/templates/result_model.rb.tt +0 -52
- data/lib/generators/robot_lab/templates/robot.rb.tt +0 -31
- data/lib/generators/robot_lab/templates/robot_job.rb.tt +0 -18
- data/lib/generators/robot_lab/templates/robot_test.rb.tt +0 -34
- data/lib/generators/robot_lab/templates/routing_robot.rb.tt +0 -59
- data/lib/generators/robot_lab/templates/thread_model.rb.tt +0 -40
- data/lib/robot_lab/document_store.rb +0 -155
- data/lib/robot_lab/ractor_boundary.rb +0 -42
- data/lib/robot_lab/ractor_job.rb +0 -37
- data/lib/robot_lab/ractor_memory_proxy.rb +0 -85
- data/lib/robot_lab/ractor_network_scheduler.rb +0 -154
- data/lib/robot_lab/ractor_worker_pool.rb +0 -117
- data/lib/robot_lab/rails_integration/engine.rb +0 -29
- data/lib/robot_lab/rails_integration/job.rb +0 -158
- data/lib/robot_lab/rails_integration/railtie.rb +0 -51
- data/lib/robot_lab/rails_integration/turbo_stream_callbacks.rb +0 -72
|
@@ -0,0 +1,3455 @@
|
|
|
1
|
+
|
|
2
|
+
<!doctype html>
|
|
3
|
+
<html lang="en" class="no-js">
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="utf-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
8
|
+
|
|
9
|
+
<meta name="description" content="Multi-robot LLM workflow orchestration for Ruby">
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
<meta name="author" content="Dewayne VanHoozer">
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
<link rel="canonical" href="https://madbomber.github.io/robot_lab/concepts/">
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<link rel="prev" href="..">
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<link rel="next" href="../getting-started/">
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
<link rel="icon" href="../assets/images/favicon.png">
|
|
28
|
+
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
<title>Concepts - RobotLab</title>
|
|
33
|
+
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
|
|
48
|
+
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
53
|
+
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
54
|
+
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
<link rel="stylesheet" href="../assets/css/custom.css">
|
|
59
|
+
|
|
60
|
+
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
</head>
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber">
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
82
|
+
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
83
|
+
<label class="md-overlay" for="__drawer"></label>
|
|
84
|
+
<div data-md-component="skip">
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
<a href="#core-concepts" class="md-skip">
|
|
88
|
+
Skip to content
|
|
89
|
+
</a>
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
<div data-md-component="announce">
|
|
93
|
+
|
|
94
|
+
</div>
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
|
|
102
|
+
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
103
|
+
<a href=".." title="RobotLab" class="md-header__button md-logo" aria-label="RobotLab" data-md-component="logo">
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
|
|
107
|
+
|
|
108
|
+
</a>
|
|
109
|
+
<label class="md-header__button md-icon" for="__drawer">
|
|
110
|
+
|
|
111
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
|
112
|
+
</label>
|
|
113
|
+
<div class="md-header__title" data-md-component="header-title">
|
|
114
|
+
<div class="md-header__ellipsis">
|
|
115
|
+
<div class="md-header__topic">
|
|
116
|
+
<span class="md-ellipsis">
|
|
117
|
+
RobotLab
|
|
118
|
+
</span>
|
|
119
|
+
</div>
|
|
120
|
+
<div class="md-header__topic" data-md-component="header-topic">
|
|
121
|
+
<span class="md-ellipsis">
|
|
122
|
+
|
|
123
|
+
Concepts
|
|
124
|
+
|
|
125
|
+
</span>
|
|
126
|
+
</div>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<form class="md-header__option" data-md-component="palette">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
|
137
|
+
|
|
138
|
+
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
|
139
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
140
|
+
</label>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
|
147
|
+
|
|
148
|
+
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
|
149
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
|
|
150
|
+
</label>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
</form>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<label class="md-header__button md-icon" for="__search">
|
|
164
|
+
|
|
165
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
166
|
+
</label>
|
|
167
|
+
<div class="md-search" data-md-component="search" role="dialog">
|
|
168
|
+
<label class="md-search__overlay" for="__search"></label>
|
|
169
|
+
<div class="md-search__inner" role="search">
|
|
170
|
+
<form class="md-search__form" name="search">
|
|
171
|
+
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
172
|
+
<label class="md-search__icon md-icon" for="__search">
|
|
173
|
+
|
|
174
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
|
175
|
+
|
|
176
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
177
|
+
</label>
|
|
178
|
+
<nav class="md-search__options" aria-label="Search">
|
|
179
|
+
|
|
180
|
+
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
|
181
|
+
|
|
182
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
|
183
|
+
</a>
|
|
184
|
+
|
|
185
|
+
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
|
186
|
+
|
|
187
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
|
188
|
+
</button>
|
|
189
|
+
</nav>
|
|
190
|
+
|
|
191
|
+
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
|
192
|
+
|
|
193
|
+
</form>
|
|
194
|
+
<div class="md-search__output">
|
|
195
|
+
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
|
196
|
+
<div class="md-search-result" data-md-component="search-result">
|
|
197
|
+
<div class="md-search-result__meta">
|
|
198
|
+
Initializing search
|
|
199
|
+
</div>
|
|
200
|
+
<ol class="md-search-result__list" role="presentation"></ol>
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
</div>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
<div class="md-header__source">
|
|
210
|
+
<a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
|
|
211
|
+
<div class="md-source__icon md-icon">
|
|
212
|
+
|
|
213
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="md-source__repository">
|
|
216
|
+
madbomber/robot_lab
|
|
217
|
+
</div>
|
|
218
|
+
</a>
|
|
219
|
+
</div>
|
|
220
|
+
|
|
221
|
+
</nav>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
|
226
|
+
<div class="md-grid">
|
|
227
|
+
<ul class="md-tabs__list">
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
<li class="md-tabs__item md-tabs__item--active">
|
|
239
|
+
<a href=".." class="md-tabs__link">
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
Home
|
|
246
|
+
|
|
247
|
+
</a>
|
|
248
|
+
</li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<li class="md-tabs__item">
|
|
261
|
+
<a href="../getting-started/" class="md-tabs__link">
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
Getting Started
|
|
268
|
+
|
|
269
|
+
</a>
|
|
270
|
+
</li>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<li class="md-tabs__item">
|
|
283
|
+
<a href="../architecture/" class="md-tabs__link">
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
Architecture
|
|
290
|
+
|
|
291
|
+
</a>
|
|
292
|
+
</li>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
<li class="md-tabs__item">
|
|
305
|
+
<a href="../guides/" class="md-tabs__link">
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
Guides
|
|
312
|
+
|
|
313
|
+
</a>
|
|
314
|
+
</li>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<li class="md-tabs__item">
|
|
327
|
+
<a href="../api/" class="md-tabs__link">
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
API Reference
|
|
334
|
+
|
|
335
|
+
</a>
|
|
336
|
+
</li>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
<li class="md-tabs__item">
|
|
349
|
+
<a href="../examples/" class="md-tabs__link">
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
|
|
355
|
+
Examples
|
|
356
|
+
|
|
357
|
+
</a>
|
|
358
|
+
</li>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</ul>
|
|
364
|
+
</div>
|
|
365
|
+
</nav>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
</header>
|
|
369
|
+
|
|
370
|
+
<div class="md-container" data-md-component="container">
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<main class="md-main" data-md-component="main">
|
|
376
|
+
<div class="md-main__inner md-grid">
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
381
|
+
<div class="md-sidebar__scrollwrap">
|
|
382
|
+
<div class="md-sidebar__inner">
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
|
|
390
|
+
<label class="md-nav__title" for="__drawer">
|
|
391
|
+
<a href=".." title="RobotLab" class="md-nav__button md-logo" aria-label="RobotLab" data-md-component="logo">
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a2 2 0 0 1 2 2c0 .74-.4 1.39-1 1.73V7h1a7 7 0 0 1 7 7h1a1 1 0 0 1 1 1v3a1 1 0 0 1-1 1h-1v1a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2v-1H2a1 1 0 0 1-1-1v-3a1 1 0 0 1 1-1h1a7 7 0 0 1 7-7h1V5.73c-.6-.34-1-.99-1-1.73a2 2 0 0 1 2-2M7.5 13A2.5 2.5 0 0 0 5 15.5 2.5 2.5 0 0 0 7.5 18a2.5 2.5 0 0 0 2.5-2.5A2.5 2.5 0 0 0 7.5 13m9 0a2.5 2.5 0 0 0-2.5 2.5 2.5 2.5 0 0 0 2.5 2.5 2.5 2.5 0 0 0 2.5-2.5 2.5 2.5 0 0 0-2.5-2.5"/></svg>
|
|
395
|
+
|
|
396
|
+
</a>
|
|
397
|
+
RobotLab
|
|
398
|
+
</label>
|
|
399
|
+
|
|
400
|
+
<div class="md-nav__source">
|
|
401
|
+
<a href="https://github.com/madbomber/robot_lab" title="Go to repository" class="md-source" data-md-component="source">
|
|
402
|
+
<div class="md-source__icon md-icon">
|
|
403
|
+
|
|
404
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
405
|
+
</div>
|
|
406
|
+
<div class="md-source__repository">
|
|
407
|
+
madbomber/robot_lab
|
|
408
|
+
</div>
|
|
409
|
+
</a>
|
|
410
|
+
</div>
|
|
411
|
+
|
|
412
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
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
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" checked>
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<div class="md-nav__link md-nav__container">
|
|
449
|
+
<a href=".." class="md-nav__link ">
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
<span class="md-ellipsis">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
Home
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
</span>
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
</a>
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="">
|
|
468
|
+
<span class="md-nav__icon md-icon"></span>
|
|
469
|
+
</label>
|
|
470
|
+
|
|
471
|
+
</div>
|
|
472
|
+
|
|
473
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="true">
|
|
474
|
+
<label class="md-nav__title" for="__nav_1">
|
|
475
|
+
<span class="md-nav__icon md-icon"></span>
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
Home
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
</label>
|
|
482
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
<li class="md-nav__item md-nav__item--active">
|
|
495
|
+
|
|
496
|
+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
<span class="md-ellipsis">
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
Concepts
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
</span>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
<span class="md-nav__icon md-icon"></span>
|
|
518
|
+
</label>
|
|
519
|
+
|
|
520
|
+
<a href="./" class="md-nav__link md-nav__link--active">
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
<span class="md-ellipsis">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
Concepts
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
</span>
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
</a>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
<label class="md-nav__title" for="__toc">
|
|
549
|
+
<span class="md-nav__icon md-icon"></span>
|
|
550
|
+
On this page
|
|
551
|
+
</label>
|
|
552
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
553
|
+
|
|
554
|
+
<li class="md-nav__item">
|
|
555
|
+
<a href="#robot" class="md-nav__link">
|
|
556
|
+
<span class="md-ellipsis">
|
|
557
|
+
|
|
558
|
+
Robot
|
|
559
|
+
|
|
560
|
+
</span>
|
|
561
|
+
</a>
|
|
562
|
+
|
|
563
|
+
</li>
|
|
564
|
+
|
|
565
|
+
<li class="md-nav__item">
|
|
566
|
+
<a href="#configuration" class="md-nav__link">
|
|
567
|
+
<span class="md-ellipsis">
|
|
568
|
+
|
|
569
|
+
Configuration
|
|
570
|
+
|
|
571
|
+
</span>
|
|
572
|
+
</a>
|
|
573
|
+
|
|
574
|
+
</li>
|
|
575
|
+
|
|
576
|
+
<li class="md-nav__item">
|
|
577
|
+
<a href="#network" class="md-nav__link">
|
|
578
|
+
<span class="md-ellipsis">
|
|
579
|
+
|
|
580
|
+
Network
|
|
581
|
+
|
|
582
|
+
</span>
|
|
583
|
+
</a>
|
|
584
|
+
|
|
585
|
+
</li>
|
|
586
|
+
|
|
587
|
+
<li class="md-nav__item">
|
|
588
|
+
<a href="#task" class="md-nav__link">
|
|
589
|
+
<span class="md-ellipsis">
|
|
590
|
+
|
|
591
|
+
Task
|
|
592
|
+
|
|
593
|
+
</span>
|
|
594
|
+
</a>
|
|
595
|
+
|
|
596
|
+
</li>
|
|
597
|
+
|
|
598
|
+
<li class="md-nav__item">
|
|
599
|
+
<a href="#simpleflowresult" class="md-nav__link">
|
|
600
|
+
<span class="md-ellipsis">
|
|
601
|
+
|
|
602
|
+
SimpleFlow::Result
|
|
603
|
+
|
|
604
|
+
</span>
|
|
605
|
+
</a>
|
|
606
|
+
|
|
607
|
+
<nav class="md-nav" aria-label="SimpleFlow::Result">
|
|
608
|
+
<ul class="md-nav__list">
|
|
609
|
+
|
|
610
|
+
<li class="md-nav__item">
|
|
611
|
+
<a href="#result-methods" class="md-nav__link">
|
|
612
|
+
<span class="md-ellipsis">
|
|
613
|
+
|
|
614
|
+
Result Methods
|
|
615
|
+
|
|
616
|
+
</span>
|
|
617
|
+
</a>
|
|
618
|
+
|
|
619
|
+
</li>
|
|
620
|
+
|
|
621
|
+
</ul>
|
|
622
|
+
</nav>
|
|
623
|
+
|
|
624
|
+
</li>
|
|
625
|
+
|
|
626
|
+
<li class="md-nav__item">
|
|
627
|
+
<a href="#tool" class="md-nav__link">
|
|
628
|
+
<span class="md-ellipsis">
|
|
629
|
+
|
|
630
|
+
Tool
|
|
631
|
+
|
|
632
|
+
</span>
|
|
633
|
+
</a>
|
|
634
|
+
|
|
635
|
+
<nav class="md-nav" aria-label="Tool">
|
|
636
|
+
<ul class="md-nav__list">
|
|
637
|
+
|
|
638
|
+
<li class="md-nav__item">
|
|
639
|
+
<a href="#rubyllmtool-subclass-preferred" class="md-nav__link">
|
|
640
|
+
<span class="md-ellipsis">
|
|
641
|
+
|
|
642
|
+
RubyLLM::Tool Subclass (Preferred)
|
|
643
|
+
|
|
644
|
+
</span>
|
|
645
|
+
</a>
|
|
646
|
+
|
|
647
|
+
</li>
|
|
648
|
+
|
|
649
|
+
<li class="md-nav__item">
|
|
650
|
+
<a href="#robotlabtoolcreate-factory" class="md-nav__link">
|
|
651
|
+
<span class="md-ellipsis">
|
|
652
|
+
|
|
653
|
+
RobotLab::Tool.create Factory
|
|
654
|
+
|
|
655
|
+
</span>
|
|
656
|
+
</a>
|
|
657
|
+
|
|
658
|
+
</li>
|
|
659
|
+
|
|
660
|
+
</ul>
|
|
661
|
+
</nav>
|
|
662
|
+
|
|
663
|
+
</li>
|
|
664
|
+
|
|
665
|
+
<li class="md-nav__item">
|
|
666
|
+
<a href="#robotresult" class="md-nav__link">
|
|
667
|
+
<span class="md-ellipsis">
|
|
668
|
+
|
|
669
|
+
RobotResult
|
|
670
|
+
|
|
671
|
+
</span>
|
|
672
|
+
</a>
|
|
673
|
+
|
|
674
|
+
</li>
|
|
675
|
+
|
|
676
|
+
<li class="md-nav__item">
|
|
677
|
+
<a href="#memory" class="md-nav__link">
|
|
678
|
+
<span class="md-ellipsis">
|
|
679
|
+
|
|
680
|
+
Memory
|
|
681
|
+
|
|
682
|
+
</span>
|
|
683
|
+
</a>
|
|
684
|
+
|
|
685
|
+
<nav class="md-nav" aria-label="Memory">
|
|
686
|
+
<ul class="md-nav__list">
|
|
687
|
+
|
|
688
|
+
<li class="md-nav__item">
|
|
689
|
+
<a href="#reserved-memory-keys" class="md-nav__link">
|
|
690
|
+
<span class="md-ellipsis">
|
|
691
|
+
|
|
692
|
+
Reserved Memory Keys
|
|
693
|
+
|
|
694
|
+
</span>
|
|
695
|
+
</a>
|
|
696
|
+
|
|
697
|
+
</li>
|
|
698
|
+
|
|
699
|
+
<li class="md-nav__item">
|
|
700
|
+
<a href="#reactive-memory-in-networks" class="md-nav__link">
|
|
701
|
+
<span class="md-ellipsis">
|
|
702
|
+
|
|
703
|
+
Reactive Memory in Networks
|
|
704
|
+
|
|
705
|
+
</span>
|
|
706
|
+
</a>
|
|
707
|
+
|
|
708
|
+
</li>
|
|
709
|
+
|
|
710
|
+
</ul>
|
|
711
|
+
</nav>
|
|
712
|
+
|
|
713
|
+
</li>
|
|
714
|
+
|
|
715
|
+
<li class="md-nav__item">
|
|
716
|
+
<a href="#mcp-model-context-protocol" class="md-nav__link">
|
|
717
|
+
<span class="md-ellipsis">
|
|
718
|
+
|
|
719
|
+
MCP (Model Context Protocol)
|
|
720
|
+
|
|
721
|
+
</span>
|
|
722
|
+
</a>
|
|
723
|
+
|
|
724
|
+
</li>
|
|
725
|
+
|
|
726
|
+
<li class="md-nav__item">
|
|
727
|
+
<a href="#execution-flow" class="md-nav__link">
|
|
728
|
+
<span class="md-ellipsis">
|
|
729
|
+
|
|
730
|
+
Execution Flow
|
|
731
|
+
|
|
732
|
+
</span>
|
|
733
|
+
</a>
|
|
734
|
+
|
|
735
|
+
</li>
|
|
736
|
+
|
|
737
|
+
<li class="md-nav__item">
|
|
738
|
+
<a href="#conditional-routing-with-classifierrobot" class="md-nav__link">
|
|
739
|
+
<span class="md-ellipsis">
|
|
740
|
+
|
|
741
|
+
Conditional Routing with ClassifierRobot
|
|
742
|
+
|
|
743
|
+
</span>
|
|
744
|
+
</a>
|
|
745
|
+
|
|
746
|
+
</li>
|
|
747
|
+
|
|
748
|
+
<li class="md-nav__item">
|
|
749
|
+
<a href="#message-bus" class="md-nav__link">
|
|
750
|
+
<span class="md-ellipsis">
|
|
751
|
+
|
|
752
|
+
Message Bus
|
|
753
|
+
|
|
754
|
+
</span>
|
|
755
|
+
</a>
|
|
756
|
+
|
|
757
|
+
<nav class="md-nav" aria-label="Message Bus">
|
|
758
|
+
<ul class="md-nav__list">
|
|
759
|
+
|
|
760
|
+
<li class="md-nav__item">
|
|
761
|
+
<a href="#dynamic-spawning" class="md-nav__link">
|
|
762
|
+
<span class="md-ellipsis">
|
|
763
|
+
|
|
764
|
+
Dynamic Spawning
|
|
765
|
+
|
|
766
|
+
</span>
|
|
767
|
+
</a>
|
|
768
|
+
|
|
769
|
+
</li>
|
|
770
|
+
|
|
771
|
+
</ul>
|
|
772
|
+
</nav>
|
|
773
|
+
|
|
774
|
+
</li>
|
|
775
|
+
|
|
776
|
+
<li class="md-nav__item">
|
|
777
|
+
<a href="#templates" class="md-nav__link">
|
|
778
|
+
<span class="md-ellipsis">
|
|
779
|
+
|
|
780
|
+
Templates
|
|
781
|
+
|
|
782
|
+
</span>
|
|
783
|
+
</a>
|
|
784
|
+
|
|
785
|
+
<nav class="md-nav" aria-label="Templates">
|
|
786
|
+
<ul class="md-nav__list">
|
|
787
|
+
|
|
788
|
+
<li class="md-nav__item">
|
|
789
|
+
<a href="#front-matter-keys" class="md-nav__link">
|
|
790
|
+
<span class="md-ellipsis">
|
|
791
|
+
|
|
792
|
+
Front Matter Keys
|
|
793
|
+
|
|
794
|
+
</span>
|
|
795
|
+
</a>
|
|
796
|
+
|
|
797
|
+
</li>
|
|
798
|
+
|
|
799
|
+
</ul>
|
|
800
|
+
</nav>
|
|
801
|
+
|
|
802
|
+
</li>
|
|
803
|
+
|
|
804
|
+
<li class="md-nav__item">
|
|
805
|
+
<a href="#next-steps" class="md-nav__link">
|
|
806
|
+
<span class="md-ellipsis">
|
|
807
|
+
|
|
808
|
+
Next Steps
|
|
809
|
+
|
|
810
|
+
</span>
|
|
811
|
+
</a>
|
|
812
|
+
|
|
813
|
+
</li>
|
|
814
|
+
|
|
815
|
+
</ul>
|
|
816
|
+
|
|
817
|
+
</nav>
|
|
818
|
+
|
|
819
|
+
</li>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
</ul>
|
|
825
|
+
</nav>
|
|
826
|
+
|
|
827
|
+
</li>
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
<div class="md-nav__link md-nav__container">
|
|
865
|
+
<a href="../getting-started/" class="md-nav__link ">
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<span class="md-ellipsis">
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
Getting Started
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
</span>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
</a>
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
|
|
884
|
+
<span class="md-nav__icon md-icon"></span>
|
|
885
|
+
</label>
|
|
886
|
+
|
|
887
|
+
</div>
|
|
888
|
+
|
|
889
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
|
890
|
+
<label class="md-nav__title" for="__nav_2">
|
|
891
|
+
<span class="md-nav__icon md-icon"></span>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
Getting Started
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
</label>
|
|
898
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
<li class="md-nav__item">
|
|
909
|
+
<a href="../getting-started/installation/" class="md-nav__link">
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<span class="md-ellipsis">
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
Installation
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
</span>
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
|
|
924
|
+
</a>
|
|
925
|
+
</li>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
|
|
936
|
+
<li class="md-nav__item">
|
|
937
|
+
<a href="../getting-started/quick-start/" class="md-nav__link">
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
<span class="md-ellipsis">
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
Quick Start
|
|
945
|
+
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
</span>
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
</a>
|
|
953
|
+
</li>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<li class="md-nav__item">
|
|
965
|
+
<a href="../getting-started/configuration/" class="md-nav__link">
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
<span class="md-ellipsis">
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
Configuration
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
</span>
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
</a>
|
|
981
|
+
</li>
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
</ul>
|
|
987
|
+
</nav>
|
|
988
|
+
|
|
989
|
+
</li>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1024
|
+
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
<div class="md-nav__link md-nav__container">
|
|
1031
|
+
<a href="../architecture/" class="md-nav__link ">
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
<span class="md-ellipsis">
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
Architecture
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
|
|
1042
|
+
</span>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
|
|
1046
|
+
</a>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
|
|
1050
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1051
|
+
</label>
|
|
1052
|
+
|
|
1053
|
+
</div>
|
|
1054
|
+
|
|
1055
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
|
|
1056
|
+
<label class="md-nav__title" for="__nav_3">
|
|
1057
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
Architecture
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
</label>
|
|
1064
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
<li class="md-nav__item">
|
|
1075
|
+
<a href="../architecture/core-concepts/" class="md-nav__link">
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
<span class="md-ellipsis">
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
Core Concepts
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
</span>
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
</a>
|
|
1091
|
+
</li>
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
<li class="md-nav__item">
|
|
1103
|
+
<a href="../architecture/robot-execution/" class="md-nav__link">
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<span class="md-ellipsis">
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
Robot Execution
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
</span>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
</a>
|
|
1119
|
+
</li>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
<li class="md-nav__item">
|
|
1131
|
+
<a href="../architecture/network-orchestration/" class="md-nav__link">
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<span class="md-ellipsis">
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
Network Orchestration
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</span>
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
</a>
|
|
1147
|
+
</li>
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<li class="md-nav__item">
|
|
1159
|
+
<a href="../architecture/state-management/" class="md-nav__link">
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
<span class="md-ellipsis">
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
State Management
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
</span>
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
</a>
|
|
1175
|
+
</li>
|
|
1176
|
+
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
<li class="md-nav__item">
|
|
1187
|
+
<a href="../architecture/message-flow/" class="md-nav__link">
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
<span class="md-ellipsis">
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
Message Flow
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
</span>
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
</a>
|
|
1203
|
+
</li>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
</ul>
|
|
1209
|
+
</nav>
|
|
1210
|
+
|
|
1211
|
+
</li>
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
<div class="md-nav__link md-nav__container">
|
|
1257
|
+
<a href="../guides/" class="md-nav__link ">
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
<span class="md-ellipsis">
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
Guides
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
</span>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
</a>
|
|
1273
|
+
|
|
1274
|
+
|
|
1275
|
+
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
1276
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1277
|
+
</label>
|
|
1278
|
+
|
|
1279
|
+
</div>
|
|
1280
|
+
|
|
1281
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
1282
|
+
<label class="md-nav__title" for="__nav_4">
|
|
1283
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
Guides
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
</label>
|
|
1290
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
<li class="md-nav__item">
|
|
1301
|
+
<a href="../guides/building-robots/" class="md-nav__link">
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
<span class="md-ellipsis">
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
Building Robots
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
</span>
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
</a>
|
|
1317
|
+
</li>
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
<li class="md-nav__item">
|
|
1329
|
+
<a href="../guides/creating-networks/" class="md-nav__link">
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
<span class="md-ellipsis">
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
Creating Networks
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
</span>
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
</a>
|
|
1345
|
+
</li>
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
<li class="md-nav__item">
|
|
1357
|
+
<a href="../guides/using-tools/" class="md-nav__link">
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
<span class="md-ellipsis">
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
Using Tools
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
</span>
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
</a>
|
|
1373
|
+
</li>
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
<li class="md-nav__item">
|
|
1385
|
+
<a href="../guides/mcp-integration/" class="md-nav__link">
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
<span class="md-ellipsis">
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
MCP Integration
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
</span>
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
</a>
|
|
1401
|
+
</li>
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
<li class="md-nav__item">
|
|
1413
|
+
<a href="../guides/streaming/" class="md-nav__link">
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
<span class="md-ellipsis">
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
Streaming Responses
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
</span>
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
</a>
|
|
1429
|
+
</li>
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
<li class="md-nav__item">
|
|
1441
|
+
<a href="../guides/memory/" class="md-nav__link">
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
<span class="md-ellipsis">
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
Memory System
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
</span>
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
</a>
|
|
1457
|
+
</li>
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
<li class="md-nav__item">
|
|
1469
|
+
<a href="../guides/rails-integration/" class="md-nav__link">
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
<span class="md-ellipsis">
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
Rails Integration
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
</span>
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
</a>
|
|
1485
|
+
</li>
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
</ul>
|
|
1491
|
+
</nav>
|
|
1492
|
+
|
|
1493
|
+
</li>
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
<div class="md-nav__link md-nav__container">
|
|
1533
|
+
<a href="../api/" class="md-nav__link ">
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
<span class="md-ellipsis">
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
API Reference
|
|
1541
|
+
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
</span>
|
|
1545
|
+
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
</a>
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
|
|
1552
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1553
|
+
</label>
|
|
1554
|
+
|
|
1555
|
+
</div>
|
|
1556
|
+
|
|
1557
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
1558
|
+
<label class="md-nav__title" for="__nav_5">
|
|
1559
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
API Reference
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
</label>
|
|
1566
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1567
|
+
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
<div class="md-nav__link md-nav__container">
|
|
1608
|
+
<a href="../api/core/" class="md-nav__link ">
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
<span class="md-ellipsis">
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
Core Classes
|
|
1616
|
+
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
</span>
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
</a>
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
|
|
1627
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1628
|
+
</label>
|
|
1629
|
+
|
|
1630
|
+
</div>
|
|
1631
|
+
|
|
1632
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
|
|
1633
|
+
<label class="md-nav__title" for="__nav_5_2">
|
|
1634
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
Core Classes
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
</label>
|
|
1641
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
<li class="md-nav__item">
|
|
1652
|
+
<a href="../api/core/robot/" class="md-nav__link">
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
<span class="md-ellipsis">
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
Robot
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
</span>
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
</a>
|
|
1668
|
+
</li>
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
<li class="md-nav__item">
|
|
1680
|
+
<a href="../api/core/network/" class="md-nav__link">
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
<span class="md-ellipsis">
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
Network
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
</span>
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
</a>
|
|
1696
|
+
</li>
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
<li class="md-nav__item">
|
|
1708
|
+
<a href="../api/core/state/" class="md-nav__link">
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
<span class="md-ellipsis">
|
|
1713
|
+
|
|
1714
|
+
|
|
1715
|
+
State
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
</span>
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
</a>
|
|
1724
|
+
</li>
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
<li class="md-nav__item">
|
|
1736
|
+
<a href="../api/core/tool/" class="md-nav__link">
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
<span class="md-ellipsis">
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
Tool
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
</span>
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
</a>
|
|
1752
|
+
</li>
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
<li class="md-nav__item">
|
|
1764
|
+
<a href="../api/core/memory/" class="md-nav__link">
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
<span class="md-ellipsis">
|
|
1769
|
+
|
|
1770
|
+
|
|
1771
|
+
Memory
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
</span>
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
</a>
|
|
1780
|
+
</li>
|
|
1781
|
+
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
</ul>
|
|
1786
|
+
</nav>
|
|
1787
|
+
|
|
1788
|
+
</li>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
<div class="md-nav__link md-nav__container">
|
|
1829
|
+
<a href="../api/messages/" class="md-nav__link ">
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
<span class="md-ellipsis">
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
Messages
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
</span>
|
|
1841
|
+
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
</a>
|
|
1845
|
+
|
|
1846
|
+
|
|
1847
|
+
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
|
1848
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1849
|
+
</label>
|
|
1850
|
+
|
|
1851
|
+
</div>
|
|
1852
|
+
|
|
1853
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
|
1854
|
+
<label class="md-nav__title" for="__nav_5_3">
|
|
1855
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1856
|
+
|
|
1857
|
+
|
|
1858
|
+
Messages
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
</label>
|
|
1862
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1863
|
+
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
|
|
1871
|
+
|
|
1872
|
+
<li class="md-nav__item">
|
|
1873
|
+
<a href="../api/messages/user-message/" class="md-nav__link">
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
<span class="md-ellipsis">
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
UserMessage
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
</span>
|
|
1885
|
+
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
</a>
|
|
1889
|
+
</li>
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
<li class="md-nav__item">
|
|
1901
|
+
<a href="../api/messages/text-message/" class="md-nav__link">
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
<span class="md-ellipsis">
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
TextMessage
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
</span>
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
</a>
|
|
1917
|
+
</li>
|
|
1918
|
+
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
<li class="md-nav__item">
|
|
1929
|
+
<a href="../api/messages/tool-call-message/" class="md-nav__link">
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
<span class="md-ellipsis">
|
|
1934
|
+
|
|
1935
|
+
|
|
1936
|
+
ToolCallMessage
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
</span>
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
|
|
1944
|
+
</a>
|
|
1945
|
+
</li>
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
<li class="md-nav__item">
|
|
1957
|
+
<a href="../api/messages/tool-result-message/" class="md-nav__link">
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
<span class="md-ellipsis">
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
ToolResultMessage
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
</span>
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
</a>
|
|
1973
|
+
</li>
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
</ul>
|
|
1979
|
+
</nav>
|
|
1980
|
+
|
|
1981
|
+
</li>
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
<div class="md-nav__link md-nav__container">
|
|
2020
|
+
<a href="../api/mcp/" class="md-nav__link ">
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
<span class="md-ellipsis">
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
MCP
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
|
|
2031
|
+
</span>
|
|
2032
|
+
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
</a>
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
<label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
|
|
2039
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2040
|
+
</label>
|
|
2041
|
+
|
|
2042
|
+
</div>
|
|
2043
|
+
|
|
2044
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
|
|
2045
|
+
<label class="md-nav__title" for="__nav_5_4">
|
|
2046
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2047
|
+
|
|
2048
|
+
|
|
2049
|
+
MCP
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
</label>
|
|
2053
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
<li class="md-nav__item">
|
|
2064
|
+
<a href="../api/mcp/client/" class="md-nav__link">
|
|
2065
|
+
|
|
2066
|
+
|
|
2067
|
+
|
|
2068
|
+
<span class="md-ellipsis">
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
Client
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
</span>
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
</a>
|
|
2080
|
+
</li>
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
<li class="md-nav__item">
|
|
2092
|
+
<a href="../api/mcp/server/" class="md-nav__link">
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
<span class="md-ellipsis">
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
Server
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
</span>
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
</a>
|
|
2108
|
+
</li>
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
<li class="md-nav__item">
|
|
2120
|
+
<a href="../api/mcp/transports/" class="md-nav__link">
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
<span class="md-ellipsis">
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
Transports
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
</span>
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
</a>
|
|
2136
|
+
</li>
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
</ul>
|
|
2142
|
+
</nav>
|
|
2143
|
+
|
|
2144
|
+
</li>
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
|
|
2178
|
+
|
|
2179
|
+
|
|
2180
|
+
<div class="md-nav__link md-nav__container">
|
|
2181
|
+
<a href="../api/streaming/" class="md-nav__link ">
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
<span class="md-ellipsis">
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
Streaming
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
</span>
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
</a>
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
<label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
|
|
2200
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2201
|
+
</label>
|
|
2202
|
+
|
|
2203
|
+
</div>
|
|
2204
|
+
|
|
2205
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
|
|
2206
|
+
<label class="md-nav__title" for="__nav_5_5">
|
|
2207
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
Streaming
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
</label>
|
|
2214
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2215
|
+
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
|
|
2221
|
+
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
<li class="md-nav__item">
|
|
2225
|
+
<a href="../api/streaming/context/" class="md-nav__link">
|
|
2226
|
+
|
|
2227
|
+
|
|
2228
|
+
|
|
2229
|
+
<span class="md-ellipsis">
|
|
2230
|
+
|
|
2231
|
+
|
|
2232
|
+
Context
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
|
|
2236
|
+
</span>
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
|
|
2240
|
+
</a>
|
|
2241
|
+
</li>
|
|
2242
|
+
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
<li class="md-nav__item">
|
|
2253
|
+
<a href="../api/streaming/events/" class="md-nav__link">
|
|
2254
|
+
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
<span class="md-ellipsis">
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
Events
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
</span>
|
|
2265
|
+
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
</a>
|
|
2269
|
+
</li>
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
</ul>
|
|
2275
|
+
</nav>
|
|
2276
|
+
|
|
2277
|
+
</li>
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
|
|
2282
|
+
</ul>
|
|
2283
|
+
</nav>
|
|
2284
|
+
|
|
2285
|
+
</li>
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2320
|
+
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
<div class="md-nav__link md-nav__container">
|
|
2327
|
+
<a href="../examples/" class="md-nav__link ">
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
<span class="md-ellipsis">
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
Examples
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
</span>
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
</a>
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
2346
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2347
|
+
</label>
|
|
2348
|
+
|
|
2349
|
+
</div>
|
|
2350
|
+
|
|
2351
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
2352
|
+
<label class="md-nav__title" for="__nav_6">
|
|
2353
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
Examples
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
</label>
|
|
2360
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2361
|
+
|
|
2362
|
+
|
|
2363
|
+
|
|
2364
|
+
|
|
2365
|
+
|
|
2366
|
+
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
|
|
2370
|
+
<li class="md-nav__item">
|
|
2371
|
+
<a href="../examples/basic-chat/" class="md-nav__link">
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
|
|
2375
|
+
<span class="md-ellipsis">
|
|
2376
|
+
|
|
2377
|
+
|
|
2378
|
+
Basic Chat
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
</span>
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
</a>
|
|
2387
|
+
</li>
|
|
2388
|
+
|
|
2389
|
+
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
|
|
2393
|
+
|
|
2394
|
+
|
|
2395
|
+
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
<li class="md-nav__item">
|
|
2399
|
+
<a href="../examples/multi-robot-network/" class="md-nav__link">
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
<span class="md-ellipsis">
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
Multi-Robot Network
|
|
2407
|
+
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
</span>
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
</a>
|
|
2415
|
+
</li>
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
<li class="md-nav__item">
|
|
2427
|
+
<a href="../examples/tool-usage/" class="md-nav__link">
|
|
2428
|
+
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
<span class="md-ellipsis">
|
|
2432
|
+
|
|
2433
|
+
|
|
2434
|
+
Tool Usage
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
</span>
|
|
2439
|
+
|
|
2440
|
+
|
|
2441
|
+
|
|
2442
|
+
</a>
|
|
2443
|
+
</li>
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
<li class="md-nav__item">
|
|
2455
|
+
<a href="../examples/mcp-server/" class="md-nav__link">
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
|
|
2459
|
+
<span class="md-ellipsis">
|
|
2460
|
+
|
|
2461
|
+
|
|
2462
|
+
MCP Server
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
</span>
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
</a>
|
|
2471
|
+
</li>
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
<li class="md-nav__item">
|
|
2483
|
+
<a href="../examples/rails-application/" class="md-nav__link">
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
<span class="md-ellipsis">
|
|
2488
|
+
|
|
2489
|
+
|
|
2490
|
+
Rails Application
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
</span>
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
</a>
|
|
2499
|
+
</li>
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
</ul>
|
|
2505
|
+
</nav>
|
|
2506
|
+
|
|
2507
|
+
</li>
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
</ul>
|
|
2512
|
+
</nav>
|
|
2513
|
+
</div>
|
|
2514
|
+
</div>
|
|
2515
|
+
</div>
|
|
2516
|
+
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
2520
|
+
<div class="md-sidebar__scrollwrap">
|
|
2521
|
+
<div class="md-sidebar__inner">
|
|
2522
|
+
|
|
2523
|
+
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
2527
|
+
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
|
|
2532
|
+
|
|
2533
|
+
<label class="md-nav__title" for="__toc">
|
|
2534
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2535
|
+
On this page
|
|
2536
|
+
</label>
|
|
2537
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
2538
|
+
|
|
2539
|
+
<li class="md-nav__item">
|
|
2540
|
+
<a href="#robot" class="md-nav__link">
|
|
2541
|
+
<span class="md-ellipsis">
|
|
2542
|
+
|
|
2543
|
+
Robot
|
|
2544
|
+
|
|
2545
|
+
</span>
|
|
2546
|
+
</a>
|
|
2547
|
+
|
|
2548
|
+
</li>
|
|
2549
|
+
|
|
2550
|
+
<li class="md-nav__item">
|
|
2551
|
+
<a href="#configuration" class="md-nav__link">
|
|
2552
|
+
<span class="md-ellipsis">
|
|
2553
|
+
|
|
2554
|
+
Configuration
|
|
2555
|
+
|
|
2556
|
+
</span>
|
|
2557
|
+
</a>
|
|
2558
|
+
|
|
2559
|
+
</li>
|
|
2560
|
+
|
|
2561
|
+
<li class="md-nav__item">
|
|
2562
|
+
<a href="#network" class="md-nav__link">
|
|
2563
|
+
<span class="md-ellipsis">
|
|
2564
|
+
|
|
2565
|
+
Network
|
|
2566
|
+
|
|
2567
|
+
</span>
|
|
2568
|
+
</a>
|
|
2569
|
+
|
|
2570
|
+
</li>
|
|
2571
|
+
|
|
2572
|
+
<li class="md-nav__item">
|
|
2573
|
+
<a href="#task" class="md-nav__link">
|
|
2574
|
+
<span class="md-ellipsis">
|
|
2575
|
+
|
|
2576
|
+
Task
|
|
2577
|
+
|
|
2578
|
+
</span>
|
|
2579
|
+
</a>
|
|
2580
|
+
|
|
2581
|
+
</li>
|
|
2582
|
+
|
|
2583
|
+
<li class="md-nav__item">
|
|
2584
|
+
<a href="#simpleflowresult" class="md-nav__link">
|
|
2585
|
+
<span class="md-ellipsis">
|
|
2586
|
+
|
|
2587
|
+
SimpleFlow::Result
|
|
2588
|
+
|
|
2589
|
+
</span>
|
|
2590
|
+
</a>
|
|
2591
|
+
|
|
2592
|
+
<nav class="md-nav" aria-label="SimpleFlow::Result">
|
|
2593
|
+
<ul class="md-nav__list">
|
|
2594
|
+
|
|
2595
|
+
<li class="md-nav__item">
|
|
2596
|
+
<a href="#result-methods" class="md-nav__link">
|
|
2597
|
+
<span class="md-ellipsis">
|
|
2598
|
+
|
|
2599
|
+
Result Methods
|
|
2600
|
+
|
|
2601
|
+
</span>
|
|
2602
|
+
</a>
|
|
2603
|
+
|
|
2604
|
+
</li>
|
|
2605
|
+
|
|
2606
|
+
</ul>
|
|
2607
|
+
</nav>
|
|
2608
|
+
|
|
2609
|
+
</li>
|
|
2610
|
+
|
|
2611
|
+
<li class="md-nav__item">
|
|
2612
|
+
<a href="#tool" class="md-nav__link">
|
|
2613
|
+
<span class="md-ellipsis">
|
|
2614
|
+
|
|
2615
|
+
Tool
|
|
2616
|
+
|
|
2617
|
+
</span>
|
|
2618
|
+
</a>
|
|
2619
|
+
|
|
2620
|
+
<nav class="md-nav" aria-label="Tool">
|
|
2621
|
+
<ul class="md-nav__list">
|
|
2622
|
+
|
|
2623
|
+
<li class="md-nav__item">
|
|
2624
|
+
<a href="#rubyllmtool-subclass-preferred" class="md-nav__link">
|
|
2625
|
+
<span class="md-ellipsis">
|
|
2626
|
+
|
|
2627
|
+
RubyLLM::Tool Subclass (Preferred)
|
|
2628
|
+
|
|
2629
|
+
</span>
|
|
2630
|
+
</a>
|
|
2631
|
+
|
|
2632
|
+
</li>
|
|
2633
|
+
|
|
2634
|
+
<li class="md-nav__item">
|
|
2635
|
+
<a href="#robotlabtoolcreate-factory" class="md-nav__link">
|
|
2636
|
+
<span class="md-ellipsis">
|
|
2637
|
+
|
|
2638
|
+
RobotLab::Tool.create Factory
|
|
2639
|
+
|
|
2640
|
+
</span>
|
|
2641
|
+
</a>
|
|
2642
|
+
|
|
2643
|
+
</li>
|
|
2644
|
+
|
|
2645
|
+
</ul>
|
|
2646
|
+
</nav>
|
|
2647
|
+
|
|
2648
|
+
</li>
|
|
2649
|
+
|
|
2650
|
+
<li class="md-nav__item">
|
|
2651
|
+
<a href="#robotresult" class="md-nav__link">
|
|
2652
|
+
<span class="md-ellipsis">
|
|
2653
|
+
|
|
2654
|
+
RobotResult
|
|
2655
|
+
|
|
2656
|
+
</span>
|
|
2657
|
+
</a>
|
|
2658
|
+
|
|
2659
|
+
</li>
|
|
2660
|
+
|
|
2661
|
+
<li class="md-nav__item">
|
|
2662
|
+
<a href="#memory" class="md-nav__link">
|
|
2663
|
+
<span class="md-ellipsis">
|
|
2664
|
+
|
|
2665
|
+
Memory
|
|
2666
|
+
|
|
2667
|
+
</span>
|
|
2668
|
+
</a>
|
|
2669
|
+
|
|
2670
|
+
<nav class="md-nav" aria-label="Memory">
|
|
2671
|
+
<ul class="md-nav__list">
|
|
2672
|
+
|
|
2673
|
+
<li class="md-nav__item">
|
|
2674
|
+
<a href="#reserved-memory-keys" class="md-nav__link">
|
|
2675
|
+
<span class="md-ellipsis">
|
|
2676
|
+
|
|
2677
|
+
Reserved Memory Keys
|
|
2678
|
+
|
|
2679
|
+
</span>
|
|
2680
|
+
</a>
|
|
2681
|
+
|
|
2682
|
+
</li>
|
|
2683
|
+
|
|
2684
|
+
<li class="md-nav__item">
|
|
2685
|
+
<a href="#reactive-memory-in-networks" class="md-nav__link">
|
|
2686
|
+
<span class="md-ellipsis">
|
|
2687
|
+
|
|
2688
|
+
Reactive Memory in Networks
|
|
2689
|
+
|
|
2690
|
+
</span>
|
|
2691
|
+
</a>
|
|
2692
|
+
|
|
2693
|
+
</li>
|
|
2694
|
+
|
|
2695
|
+
</ul>
|
|
2696
|
+
</nav>
|
|
2697
|
+
|
|
2698
|
+
</li>
|
|
2699
|
+
|
|
2700
|
+
<li class="md-nav__item">
|
|
2701
|
+
<a href="#mcp-model-context-protocol" class="md-nav__link">
|
|
2702
|
+
<span class="md-ellipsis">
|
|
2703
|
+
|
|
2704
|
+
MCP (Model Context Protocol)
|
|
2705
|
+
|
|
2706
|
+
</span>
|
|
2707
|
+
</a>
|
|
2708
|
+
|
|
2709
|
+
</li>
|
|
2710
|
+
|
|
2711
|
+
<li class="md-nav__item">
|
|
2712
|
+
<a href="#execution-flow" class="md-nav__link">
|
|
2713
|
+
<span class="md-ellipsis">
|
|
2714
|
+
|
|
2715
|
+
Execution Flow
|
|
2716
|
+
|
|
2717
|
+
</span>
|
|
2718
|
+
</a>
|
|
2719
|
+
|
|
2720
|
+
</li>
|
|
2721
|
+
|
|
2722
|
+
<li class="md-nav__item">
|
|
2723
|
+
<a href="#conditional-routing-with-classifierrobot" class="md-nav__link">
|
|
2724
|
+
<span class="md-ellipsis">
|
|
2725
|
+
|
|
2726
|
+
Conditional Routing with ClassifierRobot
|
|
2727
|
+
|
|
2728
|
+
</span>
|
|
2729
|
+
</a>
|
|
2730
|
+
|
|
2731
|
+
</li>
|
|
2732
|
+
|
|
2733
|
+
<li class="md-nav__item">
|
|
2734
|
+
<a href="#message-bus" class="md-nav__link">
|
|
2735
|
+
<span class="md-ellipsis">
|
|
2736
|
+
|
|
2737
|
+
Message Bus
|
|
2738
|
+
|
|
2739
|
+
</span>
|
|
2740
|
+
</a>
|
|
2741
|
+
|
|
2742
|
+
<nav class="md-nav" aria-label="Message Bus">
|
|
2743
|
+
<ul class="md-nav__list">
|
|
2744
|
+
|
|
2745
|
+
<li class="md-nav__item">
|
|
2746
|
+
<a href="#dynamic-spawning" class="md-nav__link">
|
|
2747
|
+
<span class="md-ellipsis">
|
|
2748
|
+
|
|
2749
|
+
Dynamic Spawning
|
|
2750
|
+
|
|
2751
|
+
</span>
|
|
2752
|
+
</a>
|
|
2753
|
+
|
|
2754
|
+
</li>
|
|
2755
|
+
|
|
2756
|
+
</ul>
|
|
2757
|
+
</nav>
|
|
2758
|
+
|
|
2759
|
+
</li>
|
|
2760
|
+
|
|
2761
|
+
<li class="md-nav__item">
|
|
2762
|
+
<a href="#templates" class="md-nav__link">
|
|
2763
|
+
<span class="md-ellipsis">
|
|
2764
|
+
|
|
2765
|
+
Templates
|
|
2766
|
+
|
|
2767
|
+
</span>
|
|
2768
|
+
</a>
|
|
2769
|
+
|
|
2770
|
+
<nav class="md-nav" aria-label="Templates">
|
|
2771
|
+
<ul class="md-nav__list">
|
|
2772
|
+
|
|
2773
|
+
<li class="md-nav__item">
|
|
2774
|
+
<a href="#front-matter-keys" class="md-nav__link">
|
|
2775
|
+
<span class="md-ellipsis">
|
|
2776
|
+
|
|
2777
|
+
Front Matter Keys
|
|
2778
|
+
|
|
2779
|
+
</span>
|
|
2780
|
+
</a>
|
|
2781
|
+
|
|
2782
|
+
</li>
|
|
2783
|
+
|
|
2784
|
+
</ul>
|
|
2785
|
+
</nav>
|
|
2786
|
+
|
|
2787
|
+
</li>
|
|
2788
|
+
|
|
2789
|
+
<li class="md-nav__item">
|
|
2790
|
+
<a href="#next-steps" class="md-nav__link">
|
|
2791
|
+
<span class="md-ellipsis">
|
|
2792
|
+
|
|
2793
|
+
Next Steps
|
|
2794
|
+
|
|
2795
|
+
</span>
|
|
2796
|
+
</a>
|
|
2797
|
+
|
|
2798
|
+
</li>
|
|
2799
|
+
|
|
2800
|
+
</ul>
|
|
2801
|
+
|
|
2802
|
+
</nav>
|
|
2803
|
+
</div>
|
|
2804
|
+
</div>
|
|
2805
|
+
</div>
|
|
2806
|
+
|
|
2807
|
+
|
|
2808
|
+
|
|
2809
|
+
<div class="md-content" data-md-component="content">
|
|
2810
|
+
|
|
2811
|
+
|
|
2812
|
+
|
|
2813
|
+
|
|
2814
|
+
|
|
2815
|
+
|
|
2816
|
+
|
|
2817
|
+
<article class="md-content__inner md-typeset">
|
|
2818
|
+
|
|
2819
|
+
|
|
2820
|
+
|
|
2821
|
+
|
|
2822
|
+
|
|
2823
|
+
<a href="https://github.com/madbomber/robot_lab/edit/main/docs/concepts.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
2824
|
+
|
|
2825
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
|
|
2826
|
+
</a>
|
|
2827
|
+
|
|
2828
|
+
|
|
2829
|
+
|
|
2830
|
+
|
|
2831
|
+
|
|
2832
|
+
<a href="https://github.com/madbomber/robot_lab/raw/main/docs/concepts.md" title="View source of this page" class="md-content__button md-icon">
|
|
2833
|
+
|
|
2834
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
|
|
2835
|
+
</a>
|
|
2836
|
+
|
|
2837
|
+
|
|
2838
|
+
|
|
2839
|
+
<h1 id="core-concepts">Core Concepts<a class="headerlink" href="#core-concepts" title="Permanent link">¶</a></h1>
|
|
2840
|
+
<p>Understanding the fundamental concepts in RobotLab will help you build effective AI applications.</p>
|
|
2841
|
+
<h2 id="robot">Robot<a class="headerlink" href="#robot" title="Permanent link">¶</a></h2>
|
|
2842
|
+
<p>A <strong>Robot</strong> is an LLM-powered agent that inherits from <code>RubyLLM::Agent</code>. Each robot wraps a persistent chat session created at initialization and provides template-based prompts, tools, memory, and MCP integration. Robots are created using keyword arguments via the <code>RobotLab.build</code> factory method.</p>
|
|
2843
|
+
<p>Each robot has:</p>
|
|
2844
|
+
<ul>
|
|
2845
|
+
<li><strong>Name</strong>: A unique identifier (auto-generated if omitted)</li>
|
|
2846
|
+
<li><strong>Template</strong>: A <code>.md</code> file with YAML front matter managed by prompt_manager, referenced by symbol</li>
|
|
2847
|
+
<li><strong>System Prompt</strong>: Inline instructions (can be used alone or combined with a template)</li>
|
|
2848
|
+
<li><strong>Model</strong>: The LLM model to use (defaults to <code>RobotLab.config.ruby_llm.model</code>)</li>
|
|
2849
|
+
<li><strong>Skills</strong>: Composable template behaviors prepended before the main template</li>
|
|
2850
|
+
<li><strong>Local Tools</strong>: <code>RubyLLM::Tool</code> subclasses or <code>RobotLab::Tool</code> instances (with automatic error handling)</li>
|
|
2851
|
+
<li><strong>Streaming</strong>: Real-time content via stored <code>on_content</code> callback or per-call block</li>
|
|
2852
|
+
<li><strong>Memory</strong>: Persistent key-value store across runs</li>
|
|
2853
|
+
</ul>
|
|
2854
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Robot with template (references prompts/support.md)</span>
|
|
2855
|
+
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
|
|
2856
|
+
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"support_agent"</span><span class="p">,</span>
|
|
2857
|
+
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:support</span><span class="p">,</span>
|
|
2858
|
+
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="w"> </span><span class="ss">context</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">tone</span><span class="p">:</span><span class="w"> </span><span class="s2">"friendly"</span><span class="p">,</span><span class="w"> </span><span class="ss">department</span><span class="p">:</span><span class="w"> </span><span class="s2">"billing"</span><span class="w"> </span><span class="p">},</span>
|
|
2859
|
+
</span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="w"> </span><span class="ss">local_tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">OrderLookup</span><span class="p">,</span><span class="w"> </span><span class="no">RefundProcessor</span><span class="o">]</span><span class="p">,</span>
|
|
2860
|
+
</span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="w"> </span><span class="ss">model</span><span class="p">:</span><span class="w"> </span><span class="s2">"claude-sonnet-4"</span>
|
|
2861
|
+
</span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="p">)</span>
|
|
2862
|
+
</span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a>
|
|
2863
|
+
</span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="c1"># Robot with inline system prompt</span>
|
|
2864
|
+
</span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
|
|
2865
|
+
</span><span id="__span-0-12"><a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"helper"</span><span class="p">,</span>
|
|
2866
|
+
</span><span id="__span-0-13"><a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You are a friendly customer support agent."</span>
|
|
2867
|
+
</span><span id="__span-0-14"><a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="p">)</span>
|
|
2868
|
+
</span><span id="__span-0-15"><a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a>
|
|
2869
|
+
</span><span id="__span-0-16"><a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="c1"># Bare robot configured via chaining</span>
|
|
2870
|
+
</span><span id="__span-0-17"><a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"bot"</span><span class="p">)</span>
|
|
2871
|
+
</span><span id="__span-0-18"><a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="n">robot</span><span class="o">.</span><span class="n">with_instructions</span><span class="p">(</span><span class="s2">"Be concise."</span><span class="p">)</span><span class="o">.</span><span class="n">with_temperature</span><span class="p">(</span><span class="mi">0</span><span class="o">.</span><span class="mi">3</span><span class="p">)</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"Hello"</span><span class="p">)</span>
|
|
2872
|
+
</span></code></pre></div>
|
|
2873
|
+
<p>The primary method is <code>robot.run("message")</code>, which takes a positional string argument and returns a <code>RobotResult</code>:</p>
|
|
2874
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"What is 2 + 2?"</span><span class="p">)</span>
|
|
2875
|
+
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="nb">puts</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">last_text_content</span><span class="w"> </span><span class="c1"># => "4"</span>
|
|
2876
|
+
</span></code></pre></div>
|
|
2877
|
+
<p>Standalone robots persist their conversation history and memory across runs:</p>
|
|
2878
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"My name is Alice."</span><span class="p">)</span>
|
|
2879
|
+
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"What is my name?"</span><span class="p">)</span>
|
|
2880
|
+
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a><span class="nb">puts</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">last_text_content</span><span class="w"> </span><span class="c1"># => "Your name is Alice."</span>
|
|
2881
|
+
</span></code></pre></div>
|
|
2882
|
+
<h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¶</a></h2>
|
|
2883
|
+
<p>RobotLab uses <code>MywayConfig</code> for configuration. There is no <code>RobotLab.configure</code> block. Instead, configuration is loaded automatically from multiple sources in priority order:</p>
|
|
2884
|
+
<ol>
|
|
2885
|
+
<li>Bundled defaults (<code>lib/robot_lab/config/defaults.yml</code>)</li>
|
|
2886
|
+
<li>Environment-specific overrides (development, test, production)</li>
|
|
2887
|
+
<li>XDG user config (<code>~/.config/robot_lab/config.yml</code>)</li>
|
|
2888
|
+
<li>Project config (<code>./config/robot_lab.yml</code>)</li>
|
|
2889
|
+
<li>Environment variables (<code>ROBOT_LAB_*</code> prefix)</li>
|
|
2890
|
+
</ol>
|
|
2891
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="c1"># Access configuration values</span>
|
|
2892
|
+
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="no">RobotLab</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">ruby_llm</span><span class="o">.</span><span class="n">model</span><span class="w"> </span><span class="c1">#=> "claude-sonnet-4"</span>
|
|
2893
|
+
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="no">RobotLab</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">ruby_llm</span><span class="o">.</span><span class="n">request_timeout</span><span class="w"> </span><span class="c1">#=> 120</span>
|
|
2894
|
+
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>
|
|
2895
|
+
</span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a><span class="c1"># Set API keys via environment variables</span>
|
|
2896
|
+
</span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></a><span class="c1"># ROBOT_LAB_RUBY_LLM__ANTHROPIC_API_KEY=sk-ant-...</span>
|
|
2897
|
+
</span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a><span class="c1"># ROBOT_LAB_RUBY_LLM__OPENAI_API_KEY=sk-...</span>
|
|
2898
|
+
</span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a>
|
|
2899
|
+
</span><span id="__span-3-9"><a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></a><span class="c1"># Reload configuration</span>
|
|
2900
|
+
</span><span id="__span-3-10"><a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></a><span class="no">RobotLab</span><span class="o">.</span><span class="n">reload_config!</span>
|
|
2901
|
+
</span></code></pre></div>
|
|
2902
|
+
<h2 id="network">Network<a class="headerlink" href="#network" title="Permanent link">¶</a></h2>
|
|
2903
|
+
<p>A <strong>Network</strong> is a collection of robots orchestrated using <a href="https://github.com/MadBomber/simple_flow">SimpleFlow</a> pipelines. Networks provide:</p>
|
|
2904
|
+
<ul>
|
|
2905
|
+
<li><strong>Task-Based Orchestration</strong>: Define tasks with dependencies and routing</li>
|
|
2906
|
+
<li><strong>Parallel Execution</strong>: Tasks with the same dependencies run concurrently</li>
|
|
2907
|
+
<li><strong>Optional Task Activation</strong>: Dynamic routing based on robot output</li>
|
|
2908
|
+
<li><strong>Per-Task Configuration</strong>: Each task can have its own context, tools, and MCP servers</li>
|
|
2909
|
+
<li><strong>Shared Memory</strong>: All robots in a network share a reactive memory instance</li>
|
|
2910
|
+
</ul>
|
|
2911
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">network</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">create_network</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"customer_service"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span>
|
|
2912
|
+
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:classifier</span><span class="p">,</span><span class="w"> </span><span class="n">classifier_robot</span><span class="p">,</span><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:none</span>
|
|
2913
|
+
</span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:billing</span><span class="p">,</span><span class="w"> </span><span class="n">billing_robot</span><span class="p">,</span>
|
|
2914
|
+
</span><span id="__span-4-4"><a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="ss">context</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">department</span><span class="p">:</span><span class="w"> </span><span class="s2">"billing"</span><span class="w"> </span><span class="p">},</span>
|
|
2915
|
+
</span><span id="__span-4-5"><a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
2916
|
+
</span><span id="__span-4-6"><a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:technical</span><span class="p">,</span><span class="w"> </span><span class="n">technical_robot</span><span class="p">,</span>
|
|
2917
|
+
</span><span id="__span-4-7"><a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a><span class="w"> </span><span class="ss">context</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">department</span><span class="p">:</span><span class="w"> </span><span class="s2">"technical"</span><span class="w"> </span><span class="p">},</span>
|
|
2918
|
+
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
2919
|
+
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="k">end</span>
|
|
2920
|
+
</span><span id="__span-4-10"><a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a>
|
|
2921
|
+
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s2">"I was charged twice for my subscription."</span><span class="p">)</span>
|
|
2922
|
+
</span></code></pre></div>
|
|
2923
|
+
<h2 id="task">Task<a class="headerlink" href="#task" title="Permanent link">¶</a></h2>
|
|
2924
|
+
<p>A <strong>Task</strong> wraps a robot for use in a network pipeline with per-task configuration:</p>
|
|
2925
|
+
<ul>
|
|
2926
|
+
<li><strong>Context</strong>: Task-specific context deep-merged with network run params</li>
|
|
2927
|
+
<li><strong>MCP</strong>: MCP servers available to this task (<code>:none</code>, <code>:inherit</code>, or array)</li>
|
|
2928
|
+
<li><strong>Tools</strong>: Tools available to this task (<code>:none</code>, <code>:inherit</code>, or array)</li>
|
|
2929
|
+
<li><strong>Memory</strong>: Task-specific memory</li>
|
|
2930
|
+
<li><strong>Dependencies</strong>: <code>:none</code>, <code>[:task1, :task2]</code>, or <code>:optional</code></li>
|
|
2931
|
+
</ul>
|
|
2932
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-5-1"><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="n">task</span><span class="w"> </span><span class="ss">:billing</span><span class="p">,</span><span class="w"> </span><span class="n">billing_robot</span><span class="p">,</span>
|
|
2933
|
+
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="ss">context</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">department</span><span class="p">:</span><span class="w"> </span><span class="s2">"billing"</span><span class="p">,</span><span class="w"> </span><span class="ss">escalation_level</span><span class="p">:</span><span class="w"> </span><span class="mi">2</span><span class="w"> </span><span class="p">},</span>
|
|
2934
|
+
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="ss">tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">RefundTool</span><span class="p">,</span><span class="w"> </span><span class="no">InvoiceTool</span><span class="o">]</span><span class="p">,</span>
|
|
2935
|
+
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
2936
|
+
</span></code></pre></div>
|
|
2937
|
+
<h2 id="simpleflowresult">SimpleFlow::Result<a class="headerlink" href="#simpleflowresult" title="Permanent link">¶</a></h2>
|
|
2938
|
+
<p>Networks use <code>SimpleFlow::Result</code> for data flow between tasks:</p>
|
|
2939
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="n">result</span><span class="o">.</span><span class="n">value</span><span class="w"> </span><span class="c1"># Current task's output (RobotResult)</span>
|
|
2940
|
+
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="n">result</span><span class="o">.</span><span class="n">context</span><span class="w"> </span><span class="c1"># Accumulated context from all tasks</span>
|
|
2941
|
+
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="n">result</span><span class="o">.</span><span class="n">halted?</span><span class="w"> </span><span class="c1"># Whether execution stopped early</span>
|
|
2942
|
+
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="n">result</span><span class="o">.</span><span class="n">continued?</span><span class="w"> </span><span class="c1"># Whether execution continues</span>
|
|
2943
|
+
</span></code></pre></div>
|
|
2944
|
+
<h3 id="result-methods">Result Methods<a class="headerlink" href="#result-methods" title="Permanent link">¶</a></h3>
|
|
2945
|
+
<table>
|
|
2946
|
+
<thead>
|
|
2947
|
+
<tr>
|
|
2948
|
+
<th>Method</th>
|
|
2949
|
+
<th>Purpose</th>
|
|
2950
|
+
</tr>
|
|
2951
|
+
</thead>
|
|
2952
|
+
<tbody>
|
|
2953
|
+
<tr>
|
|
2954
|
+
<td><code>continue(value)</code></td>
|
|
2955
|
+
<td>Continue to next tasks</td>
|
|
2956
|
+
</tr>
|
|
2957
|
+
<tr>
|
|
2958
|
+
<td><code>halt(value)</code></td>
|
|
2959
|
+
<td>Stop pipeline execution</td>
|
|
2960
|
+
</tr>
|
|
2961
|
+
<tr>
|
|
2962
|
+
<td><code>with_context(key, val)</code></td>
|
|
2963
|
+
<td>Add data to context</td>
|
|
2964
|
+
</tr>
|
|
2965
|
+
<tr>
|
|
2966
|
+
<td><code>activate(task_name)</code></td>
|
|
2967
|
+
<td>Enable optional task</td>
|
|
2968
|
+
</tr>
|
|
2969
|
+
</tbody>
|
|
2970
|
+
</table>
|
|
2971
|
+
<h2 id="tool">Tool<a class="headerlink" href="#tool" title="Permanent link">¶</a></h2>
|
|
2972
|
+
<p><strong>Tools</strong> give robots the ability to interact with external systems. <code>RobotLab::Tool</code> extends <code>RubyLLM::Tool</code> with graceful error handling — if <code>execute</code> raises a <code>StandardError</code>, the error is caught and returned as a plain-text string (<code>"Error (tool_name): message"</code>) so the LLM can reason about it. Critical tools can opt out with <code>self.raise_on_error = true</code>.</p>
|
|
2973
|
+
<p>There are two patterns for defining tools:</p>
|
|
2974
|
+
<h3 id="rubyllmtool-subclass-preferred">RubyLLM::Tool Subclass (Preferred)<a class="headerlink" href="#rubyllmtool-subclass-preferred" title="Permanent link">¶</a></h3>
|
|
2975
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">Calculator</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RubyLLM</span><span class="o">::</span><span class="no">Tool</span>
|
|
2976
|
+
</span><span id="__span-7-2"><a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="w"> </span><span class="n">description</span><span class="w"> </span><span class="s2">"Performs basic arithmetic operations"</span>
|
|
2977
|
+
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>
|
|
2978
|
+
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:operation</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">"The operation (add, subtract, multiply, divide)"</span>
|
|
2979
|
+
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:a</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"number"</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">"First operand"</span>
|
|
2980
|
+
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="n">param</span><span class="w"> </span><span class="ss">:b</span><span class="p">,</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"number"</span><span class="p">,</span><span class="w"> </span><span class="ss">desc</span><span class="p">:</span><span class="w"> </span><span class="s2">"Second operand"</span>
|
|
2981
|
+
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>
|
|
2982
|
+
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">execute</span><span class="p">(</span><span class="ss">operation</span><span class="p">:,</span><span class="w"> </span><span class="ss">a</span><span class="p">:,</span><span class="w"> </span><span class="ss">b</span><span class="p">:)</span>
|
|
2983
|
+
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">operation</span>
|
|
2984
|
+
</span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="s2">"add"</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">b</span>
|
|
2985
|
+
</span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="s2">"subtract"</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">b</span>
|
|
2986
|
+
</span><span id="__span-7-12"><a id="__codelineno-7-12" name="__codelineno-7-12" href="#__codelineno-7-12"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="s2">"multiply"</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">a</span><span class="w"> </span><span class="o">*</span><span class="w"> </span><span class="n">b</span>
|
|
2987
|
+
</span><span id="__span-7-13"><a id="__codelineno-7-13" name="__codelineno-7-13" href="#__codelineno-7-13"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="s2">"divide"</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">a</span><span class="o">.</span><span class="n">to_f</span><span class="w"> </span><span class="o">/</span><span class="w"> </span><span class="n">b</span>
|
|
2988
|
+
</span><span id="__span-7-14"><a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="s2">"Unknown operation: </span><span class="si">#{</span><span class="n">operation</span><span class="si">}</span><span class="s2">"</span>
|
|
2989
|
+
</span><span id="__span-7-15"><a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a><span class="w"> </span><span class="k">end</span>
|
|
2990
|
+
</span><span id="__span-7-16"><a id="__codelineno-7-16" name="__codelineno-7-16" href="#__codelineno-7-16"></a><span class="w"> </span><span class="k">end</span>
|
|
2991
|
+
</span><span id="__span-7-17"><a id="__codelineno-7-17" name="__codelineno-7-17" href="#__codelineno-7-17"></a><span class="k">end</span>
|
|
2992
|
+
</span><span id="__span-7-18"><a id="__codelineno-7-18" name="__codelineno-7-18" href="#__codelineno-7-18"></a>
|
|
2993
|
+
</span><span id="__span-7-19"><a id="__codelineno-7-19" name="__codelineno-7-19" href="#__codelineno-7-19"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
|
|
2994
|
+
</span><span id="__span-7-20"><a id="__codelineno-7-20" name="__codelineno-7-20" href="#__codelineno-7-20"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"math_bot"</span><span class="p">,</span>
|
|
2995
|
+
</span><span id="__span-7-21"><a id="__codelineno-7-21" name="__codelineno-7-21" href="#__codelineno-7-21"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You can do math."</span><span class="p">,</span>
|
|
2996
|
+
</span><span id="__span-7-22"><a id="__codelineno-7-22" name="__codelineno-7-22" href="#__codelineno-7-22"></a><span class="w"> </span><span class="ss">local_tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">Calculator</span><span class="o">]</span>
|
|
2997
|
+
</span><span id="__span-7-23"><a id="__codelineno-7-23" name="__codelineno-7-23" href="#__codelineno-7-23"></a><span class="p">)</span>
|
|
2998
|
+
</span></code></pre></div>
|
|
2999
|
+
<h3 id="robotlabtoolcreate-factory">RobotLab::Tool.create Factory<a class="headerlink" href="#robotlabtoolcreate-factory" title="Permanent link">¶</a></h3>
|
|
3000
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="n">tool</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Tool</span><span class="o">.</span><span class="n">create</span><span class="p">(</span>
|
|
3001
|
+
</span><span id="__span-8-2"><a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"get_weather"</span><span class="p">,</span>
|
|
3002
|
+
</span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="w"> </span><span class="ss">description</span><span class="p">:</span><span class="w"> </span><span class="s2">"Get current weather for a location"</span><span class="p">,</span>
|
|
3003
|
+
</span><span id="__span-8-4"><a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="w"> </span><span class="ss">parameters</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3004
|
+
</span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"object"</span><span class="p">,</span>
|
|
3005
|
+
</span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a><span class="w"> </span><span class="ss">properties</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
|
|
3006
|
+
</span><span id="__span-8-7"><a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a><span class="w"> </span><span class="ss">location</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"string"</span><span class="p">,</span><span class="w"> </span><span class="ss">description</span><span class="p">:</span><span class="w"> </span><span class="s2">"City name"</span><span class="w"> </span><span class="p">}</span>
|
|
3007
|
+
</span><span id="__span-8-8"><a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a><span class="w"> </span><span class="p">},</span>
|
|
3008
|
+
</span><span id="__span-8-9"><a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a><span class="w"> </span><span class="ss">required</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="s2">"location"</span><span class="o">]</span>
|
|
3009
|
+
</span><span id="__span-8-10"><a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a><span class="w"> </span><span class="p">}</span>
|
|
3010
|
+
</span><span id="__span-8-11"><a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">args</span><span class="o">|</span><span class="w"> </span><span class="no">WeatherService</span><span class="o">.</span><span class="n">current</span><span class="p">(</span><span class="n">args</span><span class="o">[</span><span class="ss">:location</span><span class="o">]</span><span class="p">)</span><span class="w"> </span><span class="p">}</span>
|
|
3011
|
+
</span></code></pre></div>
|
|
3012
|
+
<h2 id="robotresult">RobotResult<a class="headerlink" href="#robotresult" title="Permanent link">¶</a></h2>
|
|
3013
|
+
<p><code>RobotResult</code> captures the output of a single <code>robot.run(...)</code> call:</p>
|
|
3014
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"Hello!"</span><span class="p">)</span>
|
|
3015
|
+
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>
|
|
3016
|
+
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="n">result</span><span class="o">.</span><span class="n">last_text_content</span><span class="w"> </span><span class="c1"># => "Hi there!" (String or nil)</span>
|
|
3017
|
+
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="n">result</span><span class="o">.</span><span class="n">output</span><span class="w"> </span><span class="c1"># => [TextMessage, ...] array of output messages</span>
|
|
3018
|
+
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="n">result</span><span class="o">.</span><span class="n">tool_calls</span><span class="w"> </span><span class="c1"># => [] array of tool call results</span>
|
|
3019
|
+
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a><span class="n">result</span><span class="o">.</span><span class="n">robot_name</span><span class="w"> </span><span class="c1"># => "assistant"</span>
|
|
3020
|
+
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="n">result</span><span class="o">.</span><span class="n">stop_reason</span><span class="w"> </span><span class="c1"># => "end_turn" or nil</span>
|
|
3021
|
+
</span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="n">result</span><span class="o">.</span><span class="n">has_tool_calls?</span><span class="w"> </span><span class="c1"># => false</span>
|
|
3022
|
+
</span><span id="__span-9-9"><a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="n">result</span><span class="o">.</span><span class="n">checksum</span><span class="w"> </span><span class="c1"># => "a1b2c3d4..." (for dedup)</span>
|
|
3023
|
+
</span></code></pre></div>
|
|
3024
|
+
<h2 id="memory">Memory<a class="headerlink" href="#memory" title="Permanent link">¶</a></h2>
|
|
3025
|
+
<p><strong>Memory</strong> is a reactive key-value store that provides persistent storage across robot executions. Standalone robots use their own inherent memory; robots in a network share the network's memory.</p>
|
|
3026
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-10-1"><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="c1"># Standalone robot with inherent memory</span>
|
|
3027
|
+
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"assistant"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You are helpful."</span><span class="p">)</span>
|
|
3028
|
+
</span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"My name is Alice"</span><span class="p">)</span>
|
|
3029
|
+
</span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"What's my name?"</span><span class="p">)</span><span class="w"> </span><span class="c1"># Memory persists across runs</span>
|
|
3030
|
+
</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a>
|
|
3031
|
+
</span><span id="__span-10-6"><a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="c1"># Access robot's memory directly</span>
|
|
3032
|
+
</span><span id="__span-10-7"><a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">[</span><span class="ss">:user_id</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">123</span>
|
|
3033
|
+
</span><span id="__span-10-8"><a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">[</span><span class="ss">:category</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"billing"</span>
|
|
3034
|
+
</span><span id="__span-10-9"><a id="__codelineno-10-9" name="__codelineno-10-9" href="#__codelineno-10-9"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">category</span><span class="w"> </span><span class="c1"># => "billing" (method-style access)</span>
|
|
3035
|
+
</span><span id="__span-10-10"><a id="__codelineno-10-10" name="__codelineno-10-10" href="#__codelineno-10-10"></a>
|
|
3036
|
+
</span><span id="__span-10-11"><a id="__codelineno-10-11" name="__codelineno-10-11" href="#__codelineno-10-11"></a><span class="c1"># Runtime memory injection</span>
|
|
3037
|
+
</span><span id="__span-10-12"><a id="__codelineno-10-12" name="__codelineno-10-12" href="#__codelineno-10-12"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"Help me"</span><span class="p">,</span><span class="w"> </span><span class="ss">memory</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">session_id</span><span class="p">:</span><span class="w"> </span><span class="s2">"abc123"</span><span class="w"> </span><span class="p">})</span>
|
|
3038
|
+
</span><span id="__span-10-13"><a id="__codelineno-10-13" name="__codelineno-10-13" href="#__codelineno-10-13"></a>
|
|
3039
|
+
</span><span id="__span-10-14"><a id="__codelineno-10-14" name="__codelineno-10-14" href="#__codelineno-10-14"></a><span class="c1"># Reset memory</span>
|
|
3040
|
+
</span><span id="__span-10-15"><a id="__codelineno-10-15" name="__codelineno-10-15" href="#__codelineno-10-15"></a><span class="n">robot</span><span class="o">.</span><span class="n">reset_memory</span>
|
|
3041
|
+
</span></code></pre></div>
|
|
3042
|
+
<h3 id="reserved-memory-keys">Reserved Memory Keys<a class="headerlink" href="#reserved-memory-keys" title="Permanent link">¶</a></h3>
|
|
3043
|
+
<table>
|
|
3044
|
+
<thead>
|
|
3045
|
+
<tr>
|
|
3046
|
+
<th>Key</th>
|
|
3047
|
+
<th>Purpose</th>
|
|
3048
|
+
</tr>
|
|
3049
|
+
</thead>
|
|
3050
|
+
<tbody>
|
|
3051
|
+
<tr>
|
|
3052
|
+
<td><code>:data</code></td>
|
|
3053
|
+
<td>Runtime data (StateProxy for method-style access)</td>
|
|
3054
|
+
</tr>
|
|
3055
|
+
<tr>
|
|
3056
|
+
<td><code>:results</code></td>
|
|
3057
|
+
<td>Accumulated robot results</td>
|
|
3058
|
+
</tr>
|
|
3059
|
+
<tr>
|
|
3060
|
+
<td><code>:messages</code></td>
|
|
3061
|
+
<td>Conversation history</td>
|
|
3062
|
+
</tr>
|
|
3063
|
+
<tr>
|
|
3064
|
+
<td><code>:session_id</code></td>
|
|
3065
|
+
<td>Session identifier for history persistence</td>
|
|
3066
|
+
</tr>
|
|
3067
|
+
<tr>
|
|
3068
|
+
<td><code>:cache</code></td>
|
|
3069
|
+
<td>Semantic cache instance (RubyLLM::SemanticCache)</td>
|
|
3070
|
+
</tr>
|
|
3071
|
+
</tbody>
|
|
3072
|
+
</table>
|
|
3073
|
+
<h3 id="reactive-memory-in-networks">Reactive Memory in Networks<a class="headerlink" href="#reactive-memory-in-networks" title="Permanent link">¶</a></h3>
|
|
3074
|
+
<p>In a network, shared memory supports pub/sub semantics for inter-robot communication:</p>
|
|
3075
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-11-1"><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="c1"># Robot A writes to shared memory</span>
|
|
3076
|
+
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">score</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="o">.</span><span class="mi">8</span><span class="w"> </span><span class="p">})</span>
|
|
3077
|
+
</span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>
|
|
3078
|
+
</span><span id="__span-11-4"><a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="c1"># Robot B reads (blocking until available)</span>
|
|
3079
|
+
</span><span id="__span-11-5"><a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">)</span>
|
|
3080
|
+
</span><span id="__span-11-6"><a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">)</span><span class="w"> </span><span class="c1"># timeout in seconds</span>
|
|
3081
|
+
</span><span id="__span-11-7"><a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a>
|
|
3082
|
+
</span><span id="__span-11-8"><a id="__codelineno-11-8" name="__codelineno-11-8" href="#__codelineno-11-8"></a><span class="c1"># Multiple keys</span>
|
|
3083
|
+
</span><span id="__span-11-9"><a id="__codelineno-11-9" name="__codelineno-11-9" href="#__codelineno-11-9"></a><span class="n">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="ss">:entities</span><span class="p">,</span><span class="w"> </span><span class="ss">:keywords</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="mi">60</span><span class="p">)</span>
|
|
3084
|
+
</span><span id="__span-11-10"><a id="__codelineno-11-10" name="__codelineno-11-10" href="#__codelineno-11-10"></a>
|
|
3085
|
+
</span><span id="__span-11-11"><a id="__codelineno-11-11" name="__codelineno-11-11" href="#__codelineno-11-11"></a><span class="c1"># Subscribe to changes</span>
|
|
3086
|
+
</span><span id="__span-11-12"><a id="__codelineno-11-12" name="__codelineno-11-12" href="#__codelineno-11-12"></a><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="ss">:status</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">change</span><span class="o">|</span>
|
|
3087
|
+
</span><span id="__span-11-13"><a id="__codelineno-11-13" name="__codelineno-11-13" href="#__codelineno-11-13"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"</span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2"> changed by </span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">writer</span><span class="si">}</span><span class="s2">: </span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">value</span><span class="si">}</span><span class="s2">"</span>
|
|
3088
|
+
</span><span id="__span-11-14"><a id="__codelineno-11-14" name="__codelineno-11-14" href="#__codelineno-11-14"></a><span class="k">end</span>
|
|
3089
|
+
</span></code></pre></div>
|
|
3090
|
+
<h2 id="mcp-model-context-protocol">MCP (Model Context Protocol)<a class="headerlink" href="#mcp-model-context-protocol" title="Permanent link">¶</a></h2>
|
|
3091
|
+
<p><strong>MCP</strong> allows robots to connect to external tool servers:</p>
|
|
3092
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
|
|
3093
|
+
</span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"developer"</span><span class="p">,</span>
|
|
3094
|
+
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You are a developer assistant."</span><span class="p">,</span>
|
|
3095
|
+
</span><span id="__span-12-4"><a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="w"> </span><span class="ss">mcp</span><span class="p">:</span><span class="w"> </span><span class="o">[</span>
|
|
3096
|
+
</span><span id="__span-12-5"><a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"filesystem"</span><span class="p">,</span><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"stdio"</span><span class="p">,</span><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">"mcp-server-filesystem"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">},</span>
|
|
3097
|
+
</span><span id="__span-12-6"><a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"github"</span><span class="p">,</span><span class="w"> </span><span class="ss">transport</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">"stdio"</span><span class="p">,</span><span class="w"> </span><span class="ss">command</span><span class="p">:</span><span class="w"> </span><span class="s2">"mcp-server-github"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
|
|
3098
|
+
</span><span id="__span-12-7"><a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a><span class="w"> </span><span class="o">]</span>
|
|
3099
|
+
</span><span id="__span-12-8"><a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a><span class="p">)</span>
|
|
3100
|
+
</span></code></pre></div>
|
|
3101
|
+
<p>MCP configuration follows a hierarchical resolution: <code>runtime > robot > network > global config</code>. Values can be <code>:none</code>, <code>:inherit</code>, or explicit arrays.</p>
|
|
3102
|
+
<h2 id="execution-flow">Execution Flow<a class="headerlink" href="#execution-flow" title="Permanent link">¶</a></h2>
|
|
3103
|
+
<pre class="mermaid"><code>sequenceDiagram
|
|
3104
|
+
participant User
|
|
3105
|
+
participant Network
|
|
3106
|
+
participant Pipeline
|
|
3107
|
+
participant Task
|
|
3108
|
+
participant Robot
|
|
3109
|
+
participant LLM
|
|
3110
|
+
participant Tool
|
|
3111
|
+
|
|
3112
|
+
User->>Network: run(message: "...", **context)
|
|
3113
|
+
Network->>Pipeline: call_parallel(initial_result)
|
|
3114
|
+
Pipeline->>Task: call(result)
|
|
3115
|
+
Task->>Robot: call(enhanced_result)
|
|
3116
|
+
Robot->>Robot: extract_run_context(result)
|
|
3117
|
+
Robot->>LLM: ask(message)
|
|
3118
|
+
|
|
3119
|
+
alt Tool Call
|
|
3120
|
+
LLM-->>Robot: tool_call
|
|
3121
|
+
Robot->>Tool: execute(params)
|
|
3122
|
+
Tool-->>Robot: result
|
|
3123
|
+
Robot->>LLM: continue with result
|
|
3124
|
+
end
|
|
3125
|
+
|
|
3126
|
+
LLM-->>Robot: response
|
|
3127
|
+
Robot-->>Task: RobotResult
|
|
3128
|
+
Task-->>Pipeline: result.continue(robot_result)
|
|
3129
|
+
|
|
3130
|
+
alt Optional Task Activated
|
|
3131
|
+
Pipeline->>Task: call activated task
|
|
3132
|
+
end
|
|
3133
|
+
|
|
3134
|
+
Pipeline-->>Network: final result
|
|
3135
|
+
Network-->>User: SimpleFlow::Result</code></pre>
|
|
3136
|
+
<h2 id="conditional-routing-with-classifierrobot">Conditional Routing with ClassifierRobot<a class="headerlink" href="#conditional-routing-with-classifierrobot" title="Permanent link">¶</a></h2>
|
|
3137
|
+
<p>Use a custom Robot subclass to implement intelligent routing. Override <code>call(result)</code> to inspect the LLM output and activate optional tasks:</p>
|
|
3138
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">ClassifierRobot</span><span class="w"> </span><span class="o"><</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">::</span><span class="no">Robot</span>
|
|
3139
|
+
</span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">call</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
|
|
3140
|
+
</span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="w"> </span><span class="c1"># Extract context and message from the pipeline result</span>
|
|
3141
|
+
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="w"> </span><span class="n">context</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">extract_run_context</span><span class="p">(</span><span class="n">result</span><span class="p">)</span>
|
|
3142
|
+
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="w"> </span><span class="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">context</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="ss">:message</span><span class="p">)</span>
|
|
3143
|
+
</span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a>
|
|
3144
|
+
</span><span id="__span-13-7"><a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="w"> </span><span class="c1"># Run the robot to classify the input</span>
|
|
3145
|
+
</span><span id="__span-13-8"><a id="__codelineno-13-8" name="__codelineno-13-8" href="#__codelineno-13-8"></a><span class="w"> </span><span class="n">robot_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">run</span><span class="p">(</span><span class="n">message</span><span class="p">,</span><span class="w"> </span><span class="o">**</span><span class="n">context</span><span class="p">)</span>
|
|
3146
|
+
</span><span id="__span-13-9"><a id="__codelineno-13-9" name="__codelineno-13-9" href="#__codelineno-13-9"></a>
|
|
3147
|
+
</span><span id="__span-13-10"><a id="__codelineno-13-10" name="__codelineno-13-10" href="#__codelineno-13-10"></a><span class="w"> </span><span class="n">new_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">result</span>
|
|
3148
|
+
</span><span id="__span-13-11"><a id="__codelineno-13-11" name="__codelineno-13-11" href="#__codelineno-13-11"></a><span class="w"> </span><span class="o">.</span><span class="n">with_context</span><span class="p">(</span><span class="vi">@name</span><span class="o">.</span><span class="n">to_sym</span><span class="p">,</span><span class="w"> </span><span class="n">robot_result</span><span class="p">)</span>
|
|
3149
|
+
</span><span id="__span-13-12"><a id="__codelineno-13-12" name="__codelineno-13-12" href="#__codelineno-13-12"></a><span class="w"> </span><span class="o">.</span><span class="n">continue</span><span class="p">(</span><span class="n">robot_result</span><span class="p">)</span>
|
|
3150
|
+
</span><span id="__span-13-13"><a id="__codelineno-13-13" name="__codelineno-13-13" href="#__codelineno-13-13"></a>
|
|
3151
|
+
</span><span id="__span-13-14"><a id="__codelineno-13-14" name="__codelineno-13-14" href="#__codelineno-13-14"></a><span class="w"> </span><span class="c1"># Activate the appropriate specialist based on classification</span>
|
|
3152
|
+
</span><span id="__span-13-15"><a id="__codelineno-13-15" name="__codelineno-13-15" href="#__codelineno-13-15"></a><span class="w"> </span><span class="n">category</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot_result</span><span class="o">.</span><span class="n">last_text_content</span><span class="o">.</span><span class="n">to_s</span><span class="o">.</span><span class="n">strip</span><span class="o">.</span><span class="n">downcase</span>
|
|
3153
|
+
</span><span id="__span-13-16"><a id="__codelineno-13-16" name="__codelineno-13-16" href="#__codelineno-13-16"></a><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">category</span>
|
|
3154
|
+
</span><span id="__span-13-17"><a id="__codelineno-13-17" name="__codelineno-13-17" href="#__codelineno-13-17"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="sr">/billing/</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">new_result</span><span class="o">.</span><span class="n">activate</span><span class="p">(</span><span class="ss">:billing</span><span class="p">)</span>
|
|
3155
|
+
</span><span id="__span-13-18"><a id="__codelineno-13-18" name="__codelineno-13-18" href="#__codelineno-13-18"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="sr">/technical/</span><span class="w"> </span><span class="k">then</span><span class="w"> </span><span class="n">new_result</span><span class="o">.</span><span class="n">activate</span><span class="p">(</span><span class="ss">:technical</span><span class="p">)</span>
|
|
3156
|
+
</span><span id="__span-13-19"><a id="__codelineno-13-19" name="__codelineno-13-19" href="#__codelineno-13-19"></a><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="n">new_result</span><span class="o">.</span><span class="n">activate</span><span class="p">(</span><span class="ss">:general</span><span class="p">)</span>
|
|
3157
|
+
</span><span id="__span-13-20"><a id="__codelineno-13-20" name="__codelineno-13-20" href="#__codelineno-13-20"></a><span class="w"> </span><span class="k">end</span>
|
|
3158
|
+
</span><span id="__span-13-21"><a id="__codelineno-13-21" name="__codelineno-13-21" href="#__codelineno-13-21"></a><span class="w"> </span><span class="k">end</span>
|
|
3159
|
+
</span><span id="__span-13-22"><a id="__codelineno-13-22" name="__codelineno-13-22" href="#__codelineno-13-22"></a><span class="k">end</span>
|
|
3160
|
+
</span><span id="__span-13-23"><a id="__codelineno-13-23" name="__codelineno-13-23" href="#__codelineno-13-23"></a>
|
|
3161
|
+
</span><span id="__span-13-24"><a id="__codelineno-13-24" name="__codelineno-13-24" href="#__codelineno-13-24"></a><span class="c1"># Build the classifier (uses a .md template with YAML front matter)</span>
|
|
3162
|
+
</span><span id="__span-13-25"><a id="__codelineno-13-25" name="__codelineno-13-25" href="#__codelineno-13-25"></a><span class="n">classifier</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">ClassifierRobot</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3163
|
+
</span><span id="__span-13-26"><a id="__codelineno-13-26" name="__codelineno-13-26" href="#__codelineno-13-26"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"classifier"</span><span class="p">,</span>
|
|
3164
|
+
</span><span id="__span-13-27"><a id="__codelineno-13-27" name="__codelineno-13-27" href="#__codelineno-13-27"></a><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:classifier</span><span class="p">,</span>
|
|
3165
|
+
</span><span id="__span-13-28"><a id="__codelineno-13-28" name="__codelineno-13-28" href="#__codelineno-13-28"></a><span class="w"> </span><span class="ss">model</span><span class="p">:</span><span class="w"> </span><span class="s2">"claude-sonnet-4"</span>
|
|
3166
|
+
</span><span id="__span-13-29"><a id="__codelineno-13-29" name="__codelineno-13-29" href="#__codelineno-13-29"></a><span class="p">)</span>
|
|
3167
|
+
</span><span id="__span-13-30"><a id="__codelineno-13-30" name="__codelineno-13-30" href="#__codelineno-13-30"></a>
|
|
3168
|
+
</span><span id="__span-13-31"><a id="__codelineno-13-31" name="__codelineno-13-31" href="#__codelineno-13-31"></a><span class="c1"># Build specialist robots</span>
|
|
3169
|
+
</span><span id="__span-13-32"><a id="__codelineno-13-32" name="__codelineno-13-32" href="#__codelineno-13-32"></a><span class="n">billing_robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"billing"</span><span class="p">,</span><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:billing</span><span class="p">)</span>
|
|
3170
|
+
</span><span id="__span-13-33"><a id="__codelineno-13-33" name="__codelineno-13-33" href="#__codelineno-13-33"></a><span class="n">technical_robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"technical"</span><span class="p">,</span><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:technical</span><span class="p">)</span>
|
|
3171
|
+
</span><span id="__span-13-34"><a id="__codelineno-13-34" name="__codelineno-13-34" href="#__codelineno-13-34"></a><span class="n">general_robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"general"</span><span class="p">,</span><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:general</span><span class="p">)</span>
|
|
3172
|
+
</span><span id="__span-13-35"><a id="__codelineno-13-35" name="__codelineno-13-35" href="#__codelineno-13-35"></a>
|
|
3173
|
+
</span><span id="__span-13-36"><a id="__codelineno-13-36" name="__codelineno-13-36" href="#__codelineno-13-36"></a><span class="c1"># Create network with optional task routing</span>
|
|
3174
|
+
</span><span id="__span-13-37"><a id="__codelineno-13-37" name="__codelineno-13-37" href="#__codelineno-13-37"></a><span class="n">network</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">create_network</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"support_network"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span>
|
|
3175
|
+
</span><span id="__span-13-38"><a id="__codelineno-13-38" name="__codelineno-13-38" href="#__codelineno-13-38"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:classifier</span><span class="p">,</span><span class="w"> </span><span class="n">classifier</span><span class="p">,</span><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:none</span>
|
|
3176
|
+
</span><span id="__span-13-39"><a id="__codelineno-13-39" name="__codelineno-13-39" href="#__codelineno-13-39"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:billing</span><span class="p">,</span><span class="w"> </span><span class="n">billing_robot</span><span class="p">,</span><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
3177
|
+
</span><span id="__span-13-40"><a id="__codelineno-13-40" name="__codelineno-13-40" href="#__codelineno-13-40"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:technical</span><span class="p">,</span><span class="w"> </span><span class="n">technical_robot</span><span class="p">,</span><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
3178
|
+
</span><span id="__span-13-41"><a id="__codelineno-13-41" name="__codelineno-13-41" href="#__codelineno-13-41"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:general</span><span class="p">,</span><span class="w"> </span><span class="n">general_robot</span><span class="p">,</span><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
3179
|
+
</span><span id="__span-13-42"><a id="__codelineno-13-42" name="__codelineno-13-42" href="#__codelineno-13-42"></a><span class="k">end</span>
|
|
3180
|
+
</span><span id="__span-13-43"><a id="__codelineno-13-43" name="__codelineno-13-43" href="#__codelineno-13-43"></a>
|
|
3181
|
+
</span><span id="__span-13-44"><a id="__codelineno-13-44" name="__codelineno-13-44" href="#__codelineno-13-44"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s2">"I was charged twice for my subscription."</span><span class="p">)</span>
|
|
3182
|
+
</span><span id="__span-13-45"><a id="__codelineno-13-45" name="__codelineno-13-45" href="#__codelineno-13-45"></a><span class="nb">puts</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">last_text_content</span>
|
|
3183
|
+
</span></code></pre></div>
|
|
3184
|
+
<h2 id="message-bus">Message Bus<a class="headerlink" href="#message-bus" title="Permanent link">¶</a></h2>
|
|
3185
|
+
<p>The <strong>Message Bus</strong> enables bidirectional, cyclic communication between robots via <code>typed_bus</code>. While Networks enforce DAG-based execution, the bus supports negotiation loops, convergence patterns, and multi-turn dialogues.</p>
|
|
3186
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="n">bus</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">TypedBus</span><span class="o">::</span><span class="no">MessageBus</span><span class="o">.</span><span class="n">new</span>
|
|
3187
|
+
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>
|
|
3188
|
+
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a><span class="n">bob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"bob"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You tell jokes."</span><span class="p">,</span><span class="w"> </span><span class="ss">bus</span><span class="p">:</span><span class="w"> </span><span class="n">bus</span><span class="p">)</span>
|
|
3189
|
+
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a><span class="n">alice</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"alice"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You evaluate jokes."</span><span class="p">,</span><span class="w"> </span><span class="ss">bus</span><span class="p">:</span><span class="w"> </span><span class="n">bus</span><span class="p">)</span>
|
|
3190
|
+
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a>
|
|
3191
|
+
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a><span class="c1"># Register handlers</span>
|
|
3192
|
+
</span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a><span class="n">bob</span><span class="o">.</span><span class="n">on_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
|
|
3193
|
+
</span><span id="__span-14-8"><a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a><span class="w"> </span><span class="n">joke</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bob</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">to_s</span><span class="p">)</span><span class="o">.</span><span class="n">last_text_content</span>
|
|
3194
|
+
</span><span id="__span-14-9"><a id="__codelineno-14-9" name="__codelineno-14-9" href="#__codelineno-14-9"></a><span class="w"> </span><span class="n">bob</span><span class="o">.</span><span class="n">send_reply</span><span class="p">(</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">from</span><span class="o">.</span><span class="n">to_sym</span><span class="p">,</span><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="n">joke</span><span class="p">,</span><span class="w"> </span><span class="ss">in_reply_to</span><span class="p">:</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">key</span><span class="p">)</span>
|
|
3195
|
+
</span><span id="__span-14-10"><a id="__codelineno-14-10" name="__codelineno-14-10" href="#__codelineno-14-10"></a><span class="k">end</span>
|
|
3196
|
+
</span><span id="__span-14-11"><a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a>
|
|
3197
|
+
</span><span id="__span-14-12"><a id="__codelineno-14-12" name="__codelineno-14-12" href="#__codelineno-14-12"></a><span class="n">alice</span><span class="o">.</span><span class="n">on_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
|
|
3198
|
+
</span><span id="__span-14-13"><a id="__codelineno-14-13" name="__codelineno-14-13" href="#__codelineno-14-13"></a><span class="w"> </span><span class="n">verdict</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">alice</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"Is this funny? </span><span class="si">#{</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">last_text_content</span>
|
|
3199
|
+
</span><span id="__span-14-14"><a id="__codelineno-14-14" name="__codelineno-14-14" href="#__codelineno-14-14"></a><span class="w"> </span><span class="c1"># Send another request if not satisfied</span>
|
|
3200
|
+
</span><span id="__span-14-15"><a id="__codelineno-14-15" name="__codelineno-14-15" href="#__codelineno-14-15"></a><span class="w"> </span><span class="n">alice</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="ss">:bob</span><span class="p">,</span><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="s2">"Try again."</span><span class="p">)</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="n">verdict</span><span class="o">.</span><span class="n">start_with?</span><span class="p">(</span><span class="s2">"FUNNY"</span><span class="p">)</span>
|
|
3201
|
+
</span><span id="__span-14-16"><a id="__codelineno-14-16" name="__codelineno-14-16" href="#__codelineno-14-16"></a><span class="k">end</span>
|
|
3202
|
+
</span><span id="__span-14-17"><a id="__codelineno-14-17" name="__codelineno-14-17" href="#__codelineno-14-17"></a>
|
|
3203
|
+
</span><span id="__span-14-18"><a id="__codelineno-14-18" name="__codelineno-14-18" href="#__codelineno-14-18"></a><span class="c1"># Start the conversation</span>
|
|
3204
|
+
</span><span id="__span-14-19"><a id="__codelineno-14-19" name="__codelineno-14-19" href="#__codelineno-14-19"></a><span class="n">alice</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="ss">:bob</span><span class="p">,</span><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="s2">"Tell me a robot joke."</span><span class="p">)</span>
|
|
3205
|
+
</span></code></pre></div>
|
|
3206
|
+
<p>Key features:</p>
|
|
3207
|
+
<ul>
|
|
3208
|
+
<li><strong>Typed channels</strong> — only <code>RobotMessage</code> objects accepted per channel</li>
|
|
3209
|
+
<li><strong>Auto-ACK</strong> — 1-arg <code>on_message</code> blocks auto-acknowledge; 2-arg blocks give manual control</li>
|
|
3210
|
+
<li><strong>Reply correlation</strong> — <code>send_reply(to:, content:, in_reply_to:)</code> tracks threads via <code>in_reply_to</code></li>
|
|
3211
|
+
<li><strong>Independent of Network</strong> — bus works without a Network pipeline</li>
|
|
3212
|
+
</ul>
|
|
3213
|
+
<h3 id="dynamic-spawning">Dynamic Spawning<a class="headerlink" href="#dynamic-spawning" title="Permanent link">¶</a></h3>
|
|
3214
|
+
<p>Robots can create new robots at runtime using <code>spawn</code>. The bus is created lazily:</p>
|
|
3215
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="n">dispatcher</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"dispatcher"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You delegate work."</span><span class="p">)</span>
|
|
3216
|
+
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>
|
|
3217
|
+
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="c1"># spawn creates a child on the same bus (bus created automatically)</span>
|
|
3218
|
+
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="n">helper</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">dispatcher</span><span class="o">.</span><span class="n">spawn</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"helper"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"You answer questions."</span><span class="p">)</span>
|
|
3219
|
+
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="n">answer</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">helper</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"What is 2+2?"</span><span class="p">)</span><span class="o">.</span><span class="n">last_text_content</span>
|
|
3220
|
+
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="n">helper</span><span class="o">.</span><span class="n">send_message</span><span class="p">(</span><span class="ss">to</span><span class="p">:</span><span class="w"> </span><span class="ss">:dispatcher</span><span class="p">,</span><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="n">answer</span><span class="p">)</span>
|
|
3221
|
+
</span></code></pre></div>
|
|
3222
|
+
<p>Robots can also join a bus after creation with <code>with_bus</code>:</p>
|
|
3223
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="n">bot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"latecomer"</span><span class="p">,</span><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"Hello."</span><span class="p">)</span>
|
|
3224
|
+
</span><span id="__span-16-2"><a id="__codelineno-16-2" name="__codelineno-16-2" href="#__codelineno-16-2"></a><span class="n">bot</span><span class="o">.</span><span class="n">with_bus</span><span class="p">(</span><span class="n">existing_bus</span><span class="p">)</span>
|
|
3225
|
+
</span></code></pre></div>
|
|
3226
|
+
<p>Multiple robots with the same name enable fan-out — messages sent to that name are delivered to all subscribers.</p>
|
|
3227
|
+
<h2 id="templates">Templates<a class="headerlink" href="#templates" title="Permanent link">¶</a></h2>
|
|
3228
|
+
<p>Templates are <code>.md</code> files with YAML front matter, managed by the prompt_manager gem. They live in the configured template path (default: <code>./prompts/</code> or <code>app/prompts/</code> in Rails).</p>
|
|
3229
|
+
<div class="language-markdown highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>---
|
|
3230
|
+
</span><span id="__span-17-2"><a id="__codelineno-17-2" name="__codelineno-17-2" href="#__codelineno-17-2"></a>description: Customer support classifier
|
|
3231
|
+
</span><span id="__span-17-3"><a id="__codelineno-17-3" name="__codelineno-17-3" href="#__codelineno-17-3"></a>model: claude-sonnet-4
|
|
3232
|
+
</span><span id="__span-17-4"><a id="__codelineno-17-4" name="__codelineno-17-4" href="#__codelineno-17-4"></a><span class="gu">temperature: 0.3</span>
|
|
3233
|
+
</span><span id="__span-17-5"><a id="__codelineno-17-5" name="__codelineno-17-5" href="#__codelineno-17-5"></a><span class="gu">---</span>
|
|
3234
|
+
</span><span id="__span-17-6"><a id="__codelineno-17-6" name="__codelineno-17-6" href="#__codelineno-17-6"></a>You are a request classifier. Analyze the user's request and classify it
|
|
3235
|
+
</span><span id="__span-17-7"><a id="__codelineno-17-7" name="__codelineno-17-7" href="#__codelineno-17-7"></a>as either "billing", "technical", or "general".
|
|
3236
|
+
</span><span id="__span-17-8"><a id="__codelineno-17-8" name="__codelineno-17-8" href="#__codelineno-17-8"></a>
|
|
3237
|
+
</span><span id="__span-17-9"><a id="__codelineno-17-9" name="__codelineno-17-9" href="#__codelineno-17-9"></a>Respond with ONLY the category name, nothing else.
|
|
3238
|
+
</span></code></pre></div>
|
|
3239
|
+
<p>Reference templates by symbol when building robots:</p>
|
|
3240
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
|
|
3241
|
+
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"classifier"</span><span class="p">,</span>
|
|
3242
|
+
</span><span id="__span-18-3"><a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="w"> </span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:classifier</span><span class="p">,</span><span class="w"> </span><span class="c1"># loads prompts/classifier.md</span>
|
|
3243
|
+
</span><span id="__span-18-4"><a id="__codelineno-18-4" name="__codelineno-18-4" href="#__codelineno-18-4"></a><span class="w"> </span><span class="ss">context</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">tone</span><span class="p">:</span><span class="w"> </span><span class="s2">"professional"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="c1"># variables passed to the template</span>
|
|
3244
|
+
</span><span id="__span-18-5"><a id="__codelineno-18-5" name="__codelineno-18-5" href="#__codelineno-18-5"></a><span class="p">)</span>
|
|
3245
|
+
</span></code></pre></div>
|
|
3246
|
+
<h3 id="front-matter-keys">Front Matter Keys<a class="headerlink" href="#front-matter-keys" title="Permanent link">¶</a></h3>
|
|
3247
|
+
<p>Templates support two categories of front matter keys:</p>
|
|
3248
|
+
<p><strong>LLM Config:</strong> <code>model</code>, <code>temperature</code>, <code>top_p</code>, <code>top_k</code>, <code>max_tokens</code>, <code>presence_penalty</code>, <code>frequency_penalty</code>, <code>stop</code> — applied to the robot's chat configuration.</p>
|
|
3249
|
+
<p><strong>Robot Extras:</strong> <code>robot_name</code>, <code>description</code>, <code>tools</code>, <code>mcp</code>, <code>skills</code> — applied to the robot's identity and capabilities. These make templates self-contained: reading the <code>.md</code> file tells you everything about the robot.</p>
|
|
3250
|
+
<div class="language-markdown highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>---
|
|
3251
|
+
</span><span id="__span-19-2"><a id="__codelineno-19-2" name="__codelineno-19-2" href="#__codelineno-19-2"></a>description: GitHub assistant with MCP tool access
|
|
3252
|
+
</span><span id="__span-19-3"><a id="__codelineno-19-3" name="__codelineno-19-3" href="#__codelineno-19-3"></a>robot_name: github_bot
|
|
3253
|
+
</span><span id="__span-19-4"><a id="__codelineno-19-4" name="__codelineno-19-4" href="#__codelineno-19-4"></a>tools:
|
|
3254
|
+
</span><span id="__span-19-5"><a id="__codelineno-19-5" name="__codelineno-19-5" href="#__codelineno-19-5"></a><span class="w"> </span><span class="k">-</span><span class="w"> </span>CodeSearchTool
|
|
3255
|
+
</span><span id="__span-19-6"><a id="__codelineno-19-6" name="__codelineno-19-6" href="#__codelineno-19-6"></a>mcp:
|
|
3256
|
+
</span><span id="__span-19-7"><a id="__codelineno-19-7" name="__codelineno-19-7" href="#__codelineno-19-7"></a><span class="w"> </span><span class="k">-</span><span class="w"> </span>name: github
|
|
3257
|
+
</span><span id="__span-19-8"><a id="__codelineno-19-8" name="__codelineno-19-8" href="#__codelineno-19-8"></a> transport: stdio
|
|
3258
|
+
</span><span id="__span-19-9"><a id="__codelineno-19-9" name="__codelineno-19-9" href="#__codelineno-19-9"></a> command: npx
|
|
3259
|
+
</span><span id="__span-19-10"><a id="__codelineno-19-10" name="__codelineno-19-10" href="#__codelineno-19-10"></a> args: ["-y", "@modelcontextprotocol/server-github"]
|
|
3260
|
+
</span><span id="__span-19-11"><a id="__codelineno-19-11" name="__codelineno-19-11" href="#__codelineno-19-11"></a><span class="gu">model: claude-sonnet-4</span>
|
|
3261
|
+
</span><span id="__span-19-12"><a id="__codelineno-19-12" name="__codelineno-19-12" href="#__codelineno-19-12"></a><span class="gu">---</span>
|
|
3262
|
+
</span><span id="__span-19-13"><a id="__codelineno-19-13" name="__codelineno-19-13" href="#__codelineno-19-13"></a>You are a GitHub assistant. Use available tools to help with repository tasks.
|
|
3263
|
+
</span></code></pre></div>
|
|
3264
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="c1"># Template provides everything — minimal constructor</span>
|
|
3265
|
+
</span><span id="__span-20-2"><a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span><span class="ss">template</span><span class="p">:</span><span class="w"> </span><span class="ss">:github_assistant</span><span class="p">)</span>
|
|
3266
|
+
</span></code></pre></div>
|
|
3267
|
+
<p>Constructor-provided values (<code>local_tools:</code>, <code>mcp:</code>, <code>name:</code>, <code>description:</code>) always take precedence over front matter values.</p>
|
|
3268
|
+
<h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">¶</a></h2>
|
|
3269
|
+
<ul>
|
|
3270
|
+
<li><a href="../getting-started/quick-start/">Quick Start Guide</a> - Build your first robot</li>
|
|
3271
|
+
<li><a href="../guides/building-robots/">Building Robots</a> - Detailed robot creation guide</li>
|
|
3272
|
+
<li><a href="../guides/creating-networks/">Creating Networks</a> - Network orchestration patterns</li>
|
|
3273
|
+
</ul>
|
|
3274
|
+
|
|
3275
|
+
|
|
3276
|
+
|
|
3277
|
+
|
|
3278
|
+
|
|
3279
|
+
|
|
3280
|
+
|
|
3281
|
+
|
|
3282
|
+
|
|
3283
|
+
|
|
3284
|
+
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
<form class="md-feedback" name="feedback" hidden>
|
|
3288
|
+
<fieldset>
|
|
3289
|
+
<legend class="md-feedback__title">
|
|
3290
|
+
Was this page helpful?
|
|
3291
|
+
</legend>
|
|
3292
|
+
<div class="md-feedback__inner">
|
|
3293
|
+
<div class="md-feedback__list">
|
|
3294
|
+
|
|
3295
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
|
|
3296
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m7 0c0 .8-.7 1.5-1.5 1.5S14 10.3 14 9.5 14.7 8 15.5 8s1.5.7 1.5 1.5m-5 7.73c-1.75 0-3.29-.73-4.19-1.81L9.23 14c.45.72 1.52 1.23 2.77 1.23s2.32-.51 2.77-1.23l1.42 1.42c-.9 1.08-2.44 1.81-4.19 1.81"/></svg>
|
|
3297
|
+
</button>
|
|
3298
|
+
|
|
3299
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
|
|
3300
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 12a8 8 0 0 0-8-8 8 8 0 0 0-8 8 8 8 0 0 0 8 8 8 8 0 0 0 8-8m2 0a10 10 0 0 1-10 10A10 10 0 0 1 2 12 10 10 0 0 1 12 2a10 10 0 0 1 10 10m-6.5-4c.8 0 1.5.7 1.5 1.5s-.7 1.5-1.5 1.5-1.5-.7-1.5-1.5.7-1.5 1.5-1.5M10 9.5c0 .8-.7 1.5-1.5 1.5S7 10.3 7 9.5 7.7 8 8.5 8s1.5.7 1.5 1.5m2 4.5c1.75 0 3.29.72 4.19 1.81l-1.42 1.42C14.32 16.5 13.25 16 12 16s-2.32.5-2.77 1.23l-1.42-1.42C8.71 14.72 10.25 14 12 14"/></svg>
|
|
3301
|
+
</button>
|
|
3302
|
+
|
|
3303
|
+
</div>
|
|
3304
|
+
<div class="md-feedback__note">
|
|
3305
|
+
|
|
3306
|
+
<div data-md-value="1" hidden>
|
|
3307
|
+
|
|
3308
|
+
|
|
3309
|
+
|
|
3310
|
+
|
|
3311
|
+
|
|
3312
|
+
|
|
3313
|
+
|
|
3314
|
+
|
|
3315
|
+
|
|
3316
|
+
Thanks for your feedback!
|
|
3317
|
+
</div>
|
|
3318
|
+
|
|
3319
|
+
<div data-md-value="0" hidden>
|
|
3320
|
+
|
|
3321
|
+
|
|
3322
|
+
|
|
3323
|
+
|
|
3324
|
+
|
|
3325
|
+
|
|
3326
|
+
|
|
3327
|
+
|
|
3328
|
+
|
|
3329
|
+
Thanks for your feedback! Help us improve by creating an issue.
|
|
3330
|
+
</div>
|
|
3331
|
+
|
|
3332
|
+
</div>
|
|
3333
|
+
</div>
|
|
3334
|
+
</fieldset>
|
|
3335
|
+
</form>
|
|
3336
|
+
|
|
3337
|
+
|
|
3338
|
+
|
|
3339
|
+
</article>
|
|
3340
|
+
</div>
|
|
3341
|
+
|
|
3342
|
+
|
|
3343
|
+
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
|
|
3344
|
+
|
|
3345
|
+
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
3346
|
+
</div>
|
|
3347
|
+
|
|
3348
|
+
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
3349
|
+
|
|
3350
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
|
3351
|
+
Back to top
|
|
3352
|
+
</button>
|
|
3353
|
+
|
|
3354
|
+
</main>
|
|
3355
|
+
|
|
3356
|
+
<footer class="md-footer">
|
|
3357
|
+
|
|
3358
|
+
|
|
3359
|
+
|
|
3360
|
+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
3361
|
+
|
|
3362
|
+
|
|
3363
|
+
<a href=".." class="md-footer__link md-footer__link--prev" aria-label="Previous: Overview">
|
|
3364
|
+
<div class="md-footer__button md-icon">
|
|
3365
|
+
|
|
3366
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
|
3367
|
+
</div>
|
|
3368
|
+
<div class="md-footer__title">
|
|
3369
|
+
<span class="md-footer__direction">
|
|
3370
|
+
Previous
|
|
3371
|
+
</span>
|
|
3372
|
+
<div class="md-ellipsis">
|
|
3373
|
+
Overview
|
|
3374
|
+
</div>
|
|
3375
|
+
</div>
|
|
3376
|
+
</a>
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
|
|
3380
|
+
<a href="../getting-started/" class="md-footer__link md-footer__link--next" aria-label="Next: Getting Started">
|
|
3381
|
+
<div class="md-footer__title">
|
|
3382
|
+
<span class="md-footer__direction">
|
|
3383
|
+
Next
|
|
3384
|
+
</span>
|
|
3385
|
+
<div class="md-ellipsis">
|
|
3386
|
+
Getting Started
|
|
3387
|
+
</div>
|
|
3388
|
+
</div>
|
|
3389
|
+
<div class="md-footer__button md-icon">
|
|
3390
|
+
|
|
3391
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
|
3392
|
+
</div>
|
|
3393
|
+
</a>
|
|
3394
|
+
|
|
3395
|
+
</nav>
|
|
3396
|
+
|
|
3397
|
+
|
|
3398
|
+
<div class="md-footer-meta md-typeset">
|
|
3399
|
+
<div class="md-footer-meta__inner md-grid">
|
|
3400
|
+
<div class="md-copyright">
|
|
3401
|
+
|
|
3402
|
+
<div class="md-copyright__highlight">
|
|
3403
|
+
Copyright © 2025 Dewayne VanHoozer
|
|
3404
|
+
</div>
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
Made with
|
|
3408
|
+
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
3409
|
+
Material for MkDocs
|
|
3410
|
+
</a>
|
|
3411
|
+
|
|
3412
|
+
</div>
|
|
3413
|
+
|
|
3414
|
+
|
|
3415
|
+
<div class="md-social">
|
|
3416
|
+
|
|
3417
|
+
|
|
3418
|
+
|
|
3419
|
+
|
|
3420
|
+
|
|
3421
|
+
<a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
|
|
3422
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
|
3423
|
+
</a>
|
|
3424
|
+
|
|
3425
|
+
|
|
3426
|
+
|
|
3427
|
+
|
|
3428
|
+
|
|
3429
|
+
<a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
|
|
3430
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M116.7 33.8c4.5-6.1 11.7-9.8 19.3-9.8h240c7.6 0 14.8 3.6 19.3 9.8l112 152c6.8 9.2 6.1 21.9-1.5 30.4l-232 256c-4.5 5-11 7.9-17.8 7.9s-13.2-2.9-17.8-7.9l-232-256c-7.7-8.5-8.3-21.2-1.5-30.4zm38.5 39.8c-3.3 2.5-4.2 7-2.1 10.5l57.4 95.7L63.3 192c-4.1.3-7.3 3.8-7.3 8s3.2 7.6 7.3 8l192 16h1.3l192-16c4.1-.3 7.3-3.8 7.3-8s-3.2-7.6-7.3-8l-147.2-12.3 57.4-95.6c2.1-3.5 1.2-8.1-2.1-10.5s-7.9-2-10.7 1l-90 97.6-90.1-97.6c-2.8-3-7.4-3.4-10.7-1"/></svg>
|
|
3431
|
+
</a>
|
|
3432
|
+
|
|
3433
|
+
</div>
|
|
3434
|
+
|
|
3435
|
+
</div>
|
|
3436
|
+
</div>
|
|
3437
|
+
</footer>
|
|
3438
|
+
|
|
3439
|
+
</div>
|
|
3440
|
+
<div class="md-dialog" data-md-component="dialog">
|
|
3441
|
+
<div class="md-dialog__inner md-typeset"></div>
|
|
3442
|
+
</div>
|
|
3443
|
+
|
|
3444
|
+
|
|
3445
|
+
|
|
3446
|
+
|
|
3447
|
+
|
|
3448
|
+
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.path", "navigation.indexes", "navigation.top", "navigation.footer", "toc.follow", "search.suggest", "search.highlight", "search.share", "header.autohide", "content.code.copy", "content.code.annotate", "content.tabs.link", "content.tooltips", "content.action.edit", "content.action.view"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
|
3449
|
+
|
|
3450
|
+
|
|
3451
|
+
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
3452
|
+
|
|
3453
|
+
|
|
3454
|
+
</body>
|
|
3455
|
+
</html>
|