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,3433 @@
|
|
|
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/architecture/network-orchestration/">
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<link rel="prev" href="../robot-execution/">
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<link rel="next" href="../state-management/">
|
|
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>Network Orchestration - 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="#network-orchestration" 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
|
+
Network Orchestration
|
|
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
|
+
<li class="md-tabs__item">
|
|
237
|
+
<a href="../.." class="md-tabs__link">
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
Home
|
|
244
|
+
|
|
245
|
+
</a>
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<li class="md-tabs__item">
|
|
259
|
+
<a href="../../getting-started/" class="md-tabs__link">
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
Getting Started
|
|
266
|
+
|
|
267
|
+
</a>
|
|
268
|
+
</li>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<li class="md-tabs__item md-tabs__item--active">
|
|
283
|
+
<a href="../" 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
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_1" >
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<div class="md-nav__link md-nav__container">
|
|
444
|
+
<a href="../.." class="md-nav__link ">
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
<span class="md-ellipsis">
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
Home
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
</span>
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
</a>
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
<label class="md-nav__link " for="__nav_1" id="__nav_1_label" tabindex="0">
|
|
463
|
+
<span class="md-nav__icon md-icon"></span>
|
|
464
|
+
</label>
|
|
465
|
+
|
|
466
|
+
</div>
|
|
467
|
+
|
|
468
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_1_label" aria-expanded="false">
|
|
469
|
+
<label class="md-nav__title" for="__nav_1">
|
|
470
|
+
<span class="md-nav__icon md-icon"></span>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
Home
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
</label>
|
|
477
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
<li class="md-nav__item">
|
|
488
|
+
<a href="../../concepts/" class="md-nav__link">
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
<span class="md-ellipsis">
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
Concepts
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</span>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
</a>
|
|
504
|
+
</li>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
</ul>
|
|
510
|
+
</nav>
|
|
511
|
+
|
|
512
|
+
</li>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="md-nav__link md-nav__container">
|
|
550
|
+
<a href="../../getting-started/" class="md-nav__link ">
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
<span class="md-ellipsis">
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
Getting Started
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
</span>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
|
|
565
|
+
</a>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
|
|
569
|
+
<span class="md-nav__icon md-icon"></span>
|
|
570
|
+
</label>
|
|
571
|
+
|
|
572
|
+
</div>
|
|
573
|
+
|
|
574
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
|
575
|
+
<label class="md-nav__title" for="__nav_2">
|
|
576
|
+
<span class="md-nav__icon md-icon"></span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
Getting Started
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
</label>
|
|
583
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<li class="md-nav__item">
|
|
594
|
+
<a href="../../getting-started/installation/" class="md-nav__link">
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<span class="md-ellipsis">
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
Installation
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
</span>
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
</a>
|
|
610
|
+
</li>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
<li class="md-nav__item">
|
|
622
|
+
<a href="../../getting-started/quick-start/" class="md-nav__link">
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
<span class="md-ellipsis">
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
Quick Start
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
</span>
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
</a>
|
|
638
|
+
</li>
|
|
639
|
+
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<li class="md-nav__item">
|
|
650
|
+
<a href="../../getting-started/configuration/" class="md-nav__link">
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
<span class="md-ellipsis">
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
Configuration
|
|
658
|
+
|
|
659
|
+
|
|
660
|
+
|
|
661
|
+
</span>
|
|
662
|
+
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
</a>
|
|
666
|
+
</li>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
</ul>
|
|
672
|
+
</nav>
|
|
673
|
+
|
|
674
|
+
</li>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<div class="md-nav__link md-nav__container">
|
|
721
|
+
<a href="../" class="md-nav__link ">
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
<span class="md-ellipsis">
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
Architecture
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
</span>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</a>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="">
|
|
740
|
+
<span class="md-nav__icon md-icon"></span>
|
|
741
|
+
</label>
|
|
742
|
+
|
|
743
|
+
</div>
|
|
744
|
+
|
|
745
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="true">
|
|
746
|
+
<label class="md-nav__title" for="__nav_3">
|
|
747
|
+
<span class="md-nav__icon md-icon"></span>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
Architecture
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
</label>
|
|
754
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
<li class="md-nav__item">
|
|
765
|
+
<a href="../core-concepts/" class="md-nav__link">
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
|
|
769
|
+
<span class="md-ellipsis">
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
Core Concepts
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
</span>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
</a>
|
|
781
|
+
</li>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<li class="md-nav__item">
|
|
793
|
+
<a href="../robot-execution/" class="md-nav__link">
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
<span class="md-ellipsis">
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
Robot Execution
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</span>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
</a>
|
|
809
|
+
</li>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
<li class="md-nav__item md-nav__item--active">
|
|
823
|
+
|
|
824
|
+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
<span class="md-ellipsis">
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
Network Orchestration
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
</span>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
|
|
845
|
+
<span class="md-nav__icon md-icon"></span>
|
|
846
|
+
</label>
|
|
847
|
+
|
|
848
|
+
<a href="./" class="md-nav__link md-nav__link--active">
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
<span class="md-ellipsis">
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
Network Orchestration
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
</span>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
</a>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<label class="md-nav__title" for="__toc">
|
|
877
|
+
<span class="md-nav__icon md-icon"></span>
|
|
878
|
+
On this page
|
|
879
|
+
</label>
|
|
880
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
881
|
+
|
|
882
|
+
<li class="md-nav__item">
|
|
883
|
+
<a href="#network-structure" class="md-nav__link">
|
|
884
|
+
<span class="md-ellipsis">
|
|
885
|
+
|
|
886
|
+
Network Structure
|
|
887
|
+
|
|
888
|
+
</span>
|
|
889
|
+
</a>
|
|
890
|
+
|
|
891
|
+
</li>
|
|
892
|
+
|
|
893
|
+
<li class="md-nav__item">
|
|
894
|
+
<a href="#creating-networks" class="md-nav__link">
|
|
895
|
+
<span class="md-ellipsis">
|
|
896
|
+
|
|
897
|
+
Creating Networks
|
|
898
|
+
|
|
899
|
+
</span>
|
|
900
|
+
</a>
|
|
901
|
+
|
|
902
|
+
</li>
|
|
903
|
+
|
|
904
|
+
<li class="md-nav__item">
|
|
905
|
+
<a href="#task-configuration" class="md-nav__link">
|
|
906
|
+
<span class="md-ellipsis">
|
|
907
|
+
|
|
908
|
+
Task Configuration
|
|
909
|
+
|
|
910
|
+
</span>
|
|
911
|
+
</a>
|
|
912
|
+
|
|
913
|
+
<nav class="md-nav" aria-label="Task Configuration">
|
|
914
|
+
<ul class="md-nav__list">
|
|
915
|
+
|
|
916
|
+
<li class="md-nav__item">
|
|
917
|
+
<a href="#task-parameters" class="md-nav__link">
|
|
918
|
+
<span class="md-ellipsis">
|
|
919
|
+
|
|
920
|
+
Task Parameters
|
|
921
|
+
|
|
922
|
+
</span>
|
|
923
|
+
</a>
|
|
924
|
+
|
|
925
|
+
</li>
|
|
926
|
+
|
|
927
|
+
</ul>
|
|
928
|
+
</nav>
|
|
929
|
+
|
|
930
|
+
</li>
|
|
931
|
+
|
|
932
|
+
<li class="md-nav__item">
|
|
933
|
+
<a href="#execution-model" class="md-nav__link">
|
|
934
|
+
<span class="md-ellipsis">
|
|
935
|
+
|
|
936
|
+
Execution Model
|
|
937
|
+
|
|
938
|
+
</span>
|
|
939
|
+
</a>
|
|
940
|
+
|
|
941
|
+
<nav class="md-nav" aria-label="Execution Model">
|
|
942
|
+
<ul class="md-nav__list">
|
|
943
|
+
|
|
944
|
+
<li class="md-nav__item">
|
|
945
|
+
<a href="#task-dependency-types" class="md-nav__link">
|
|
946
|
+
<span class="md-ellipsis">
|
|
947
|
+
|
|
948
|
+
Task Dependency Types
|
|
949
|
+
|
|
950
|
+
</span>
|
|
951
|
+
</a>
|
|
952
|
+
|
|
953
|
+
</li>
|
|
954
|
+
|
|
955
|
+
</ul>
|
|
956
|
+
</nav>
|
|
957
|
+
|
|
958
|
+
</li>
|
|
959
|
+
|
|
960
|
+
<li class="md-nav__item">
|
|
961
|
+
<a href="#robotcall-interface" class="md-nav__link">
|
|
962
|
+
<span class="md-ellipsis">
|
|
963
|
+
|
|
964
|
+
Robot#call Interface
|
|
965
|
+
|
|
966
|
+
</span>
|
|
967
|
+
</a>
|
|
968
|
+
|
|
969
|
+
<nav class="md-nav" aria-label="Robot#call Interface">
|
|
970
|
+
<ul class="md-nav__list">
|
|
971
|
+
|
|
972
|
+
<li class="md-nav__item">
|
|
973
|
+
<a href="#extract_run_context" class="md-nav__link">
|
|
974
|
+
<span class="md-ellipsis">
|
|
975
|
+
|
|
976
|
+
extract_run_context
|
|
977
|
+
|
|
978
|
+
</span>
|
|
979
|
+
</a>
|
|
980
|
+
|
|
981
|
+
</li>
|
|
982
|
+
|
|
983
|
+
</ul>
|
|
984
|
+
</nav>
|
|
985
|
+
|
|
986
|
+
</li>
|
|
987
|
+
|
|
988
|
+
<li class="md-nav__item">
|
|
989
|
+
<a href="#taskcall-interface" class="md-nav__link">
|
|
990
|
+
<span class="md-ellipsis">
|
|
991
|
+
|
|
992
|
+
Task#call Interface
|
|
993
|
+
|
|
994
|
+
</span>
|
|
995
|
+
</a>
|
|
996
|
+
|
|
997
|
+
</li>
|
|
998
|
+
|
|
999
|
+
<li class="md-nav__item">
|
|
1000
|
+
<a href="#simpleflowresult" class="md-nav__link">
|
|
1001
|
+
<span class="md-ellipsis">
|
|
1002
|
+
|
|
1003
|
+
SimpleFlow::Result
|
|
1004
|
+
|
|
1005
|
+
</span>
|
|
1006
|
+
</a>
|
|
1007
|
+
|
|
1008
|
+
<nav class="md-nav" aria-label="SimpleFlow::Result">
|
|
1009
|
+
<ul class="md-nav__list">
|
|
1010
|
+
|
|
1011
|
+
<li class="md-nav__item">
|
|
1012
|
+
<a href="#result-methods" class="md-nav__link">
|
|
1013
|
+
<span class="md-ellipsis">
|
|
1014
|
+
|
|
1015
|
+
Result Methods
|
|
1016
|
+
|
|
1017
|
+
</span>
|
|
1018
|
+
</a>
|
|
1019
|
+
|
|
1020
|
+
</li>
|
|
1021
|
+
|
|
1022
|
+
<li class="md-nav__item">
|
|
1023
|
+
<a href="#context-structure" class="md-nav__link">
|
|
1024
|
+
<span class="md-ellipsis">
|
|
1025
|
+
|
|
1026
|
+
Context Structure
|
|
1027
|
+
|
|
1028
|
+
</span>
|
|
1029
|
+
</a>
|
|
1030
|
+
|
|
1031
|
+
</li>
|
|
1032
|
+
|
|
1033
|
+
</ul>
|
|
1034
|
+
</nav>
|
|
1035
|
+
|
|
1036
|
+
</li>
|
|
1037
|
+
|
|
1038
|
+
<li class="md-nav__item">
|
|
1039
|
+
<a href="#optional-task-activation" class="md-nav__link">
|
|
1040
|
+
<span class="md-ellipsis">
|
|
1041
|
+
|
|
1042
|
+
Optional Task Activation
|
|
1043
|
+
|
|
1044
|
+
</span>
|
|
1045
|
+
</a>
|
|
1046
|
+
|
|
1047
|
+
<nav class="md-nav" aria-label="Optional Task Activation">
|
|
1048
|
+
<ul class="md-nav__list">
|
|
1049
|
+
|
|
1050
|
+
<li class="md-nav__item">
|
|
1051
|
+
<a href="#classifier-robot-pattern" class="md-nav__link">
|
|
1052
|
+
<span class="md-ellipsis">
|
|
1053
|
+
|
|
1054
|
+
Classifier Robot Pattern
|
|
1055
|
+
|
|
1056
|
+
</span>
|
|
1057
|
+
</a>
|
|
1058
|
+
|
|
1059
|
+
</li>
|
|
1060
|
+
|
|
1061
|
+
</ul>
|
|
1062
|
+
</nav>
|
|
1063
|
+
|
|
1064
|
+
</li>
|
|
1065
|
+
|
|
1066
|
+
<li class="md-nav__item">
|
|
1067
|
+
<a href="#shared-memory" class="md-nav__link">
|
|
1068
|
+
<span class="md-ellipsis">
|
|
1069
|
+
|
|
1070
|
+
Shared Memory
|
|
1071
|
+
|
|
1072
|
+
</span>
|
|
1073
|
+
</a>
|
|
1074
|
+
|
|
1075
|
+
</li>
|
|
1076
|
+
|
|
1077
|
+
<li class="md-nav__item">
|
|
1078
|
+
<a href="#broadcasting" class="md-nav__link">
|
|
1079
|
+
<span class="md-ellipsis">
|
|
1080
|
+
|
|
1081
|
+
Broadcasting
|
|
1082
|
+
|
|
1083
|
+
</span>
|
|
1084
|
+
</a>
|
|
1085
|
+
|
|
1086
|
+
</li>
|
|
1087
|
+
|
|
1088
|
+
<li class="md-nav__item">
|
|
1089
|
+
<a href="#parallel-execution" class="md-nav__link">
|
|
1090
|
+
<span class="md-ellipsis">
|
|
1091
|
+
|
|
1092
|
+
Parallel Execution
|
|
1093
|
+
|
|
1094
|
+
</span>
|
|
1095
|
+
</a>
|
|
1096
|
+
|
|
1097
|
+
<nav class="md-nav" aria-label="Parallel Execution">
|
|
1098
|
+
<ul class="md-nav__list">
|
|
1099
|
+
|
|
1100
|
+
<li class="md-nav__item">
|
|
1101
|
+
<a href="#concurrency-modes" class="md-nav__link">
|
|
1102
|
+
<span class="md-ellipsis">
|
|
1103
|
+
|
|
1104
|
+
Concurrency Modes
|
|
1105
|
+
|
|
1106
|
+
</span>
|
|
1107
|
+
</a>
|
|
1108
|
+
|
|
1109
|
+
</li>
|
|
1110
|
+
|
|
1111
|
+
</ul>
|
|
1112
|
+
</nav>
|
|
1113
|
+
|
|
1114
|
+
</li>
|
|
1115
|
+
|
|
1116
|
+
<li class="md-nav__item">
|
|
1117
|
+
<a href="#data-flow" class="md-nav__link">
|
|
1118
|
+
<span class="md-ellipsis">
|
|
1119
|
+
|
|
1120
|
+
Data Flow
|
|
1121
|
+
|
|
1122
|
+
</span>
|
|
1123
|
+
</a>
|
|
1124
|
+
|
|
1125
|
+
</li>
|
|
1126
|
+
|
|
1127
|
+
<li class="md-nav__item">
|
|
1128
|
+
<a href="#visualization" class="md-nav__link">
|
|
1129
|
+
<span class="md-ellipsis">
|
|
1130
|
+
|
|
1131
|
+
Visualization
|
|
1132
|
+
|
|
1133
|
+
</span>
|
|
1134
|
+
</a>
|
|
1135
|
+
|
|
1136
|
+
</li>
|
|
1137
|
+
|
|
1138
|
+
<li class="md-nav__item">
|
|
1139
|
+
<a href="#network-inspection" class="md-nav__link">
|
|
1140
|
+
<span class="md-ellipsis">
|
|
1141
|
+
|
|
1142
|
+
Network Inspection
|
|
1143
|
+
|
|
1144
|
+
</span>
|
|
1145
|
+
</a>
|
|
1146
|
+
|
|
1147
|
+
</li>
|
|
1148
|
+
|
|
1149
|
+
<li class="md-nav__item">
|
|
1150
|
+
<a href="#next-steps" class="md-nav__link">
|
|
1151
|
+
<span class="md-ellipsis">
|
|
1152
|
+
|
|
1153
|
+
Next Steps
|
|
1154
|
+
|
|
1155
|
+
</span>
|
|
1156
|
+
</a>
|
|
1157
|
+
|
|
1158
|
+
</li>
|
|
1159
|
+
|
|
1160
|
+
</ul>
|
|
1161
|
+
|
|
1162
|
+
</nav>
|
|
1163
|
+
|
|
1164
|
+
</li>
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
|
|
1175
|
+
<li class="md-nav__item">
|
|
1176
|
+
<a href="../state-management/" class="md-nav__link">
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
<span class="md-ellipsis">
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
State Management
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
|
|
1187
|
+
</span>
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
</a>
|
|
1192
|
+
</li>
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
|
|
1202
|
+
|
|
1203
|
+
<li class="md-nav__item">
|
|
1204
|
+
<a href="../message-flow/" class="md-nav__link">
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
<span class="md-ellipsis">
|
|
1209
|
+
|
|
1210
|
+
|
|
1211
|
+
Message Flow
|
|
1212
|
+
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
</span>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
</a>
|
|
1220
|
+
</li>
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
</ul>
|
|
1226
|
+
</nav>
|
|
1227
|
+
|
|
1228
|
+
</li>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
<div class="md-nav__link md-nav__container">
|
|
1274
|
+
<a href="../../guides/" class="md-nav__link ">
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
<span class="md-ellipsis">
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
Guides
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
</span>
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
</a>
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
<label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
|
|
1293
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1294
|
+
</label>
|
|
1295
|
+
|
|
1296
|
+
</div>
|
|
1297
|
+
|
|
1298
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
|
|
1299
|
+
<label class="md-nav__title" for="__nav_4">
|
|
1300
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
Guides
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
</label>
|
|
1307
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
<li class="md-nav__item">
|
|
1318
|
+
<a href="../../guides/building-robots/" class="md-nav__link">
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
<span class="md-ellipsis">
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
Building Robots
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
</span>
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
|
|
1333
|
+
</a>
|
|
1334
|
+
</li>
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
<li class="md-nav__item">
|
|
1346
|
+
<a href="../../guides/creating-networks/" class="md-nav__link">
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
|
|
1350
|
+
<span class="md-ellipsis">
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
Creating Networks
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
</span>
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
</a>
|
|
1362
|
+
</li>
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
<li class="md-nav__item">
|
|
1374
|
+
<a href="../../guides/using-tools/" class="md-nav__link">
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
<span class="md-ellipsis">
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
Using Tools
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
</span>
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
</a>
|
|
1390
|
+
</li>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
<li class="md-nav__item">
|
|
1402
|
+
<a href="../../guides/mcp-integration/" class="md-nav__link">
|
|
1403
|
+
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
<span class="md-ellipsis">
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
MCP Integration
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
</span>
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
</a>
|
|
1418
|
+
</li>
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
<li class="md-nav__item">
|
|
1430
|
+
<a href="../../guides/streaming/" class="md-nav__link">
|
|
1431
|
+
|
|
1432
|
+
|
|
1433
|
+
|
|
1434
|
+
<span class="md-ellipsis">
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
Streaming Responses
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
|
|
1441
|
+
</span>
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
|
|
1445
|
+
</a>
|
|
1446
|
+
</li>
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
<li class="md-nav__item">
|
|
1458
|
+
<a href="../../guides/memory/" class="md-nav__link">
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
<span class="md-ellipsis">
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
Memory System
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
</span>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
</a>
|
|
1474
|
+
</li>
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
<li class="md-nav__item">
|
|
1486
|
+
<a href="../../guides/rails-integration/" class="md-nav__link">
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
<span class="md-ellipsis">
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
Rails Integration
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
</span>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
</a>
|
|
1502
|
+
</li>
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
</ul>
|
|
1508
|
+
</nav>
|
|
1509
|
+
|
|
1510
|
+
</li>
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
|
|
1525
|
+
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1543
|
+
|
|
1544
|
+
|
|
1545
|
+
|
|
1546
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
<div class="md-nav__link md-nav__container">
|
|
1550
|
+
<a href="../../api/" class="md-nav__link ">
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
|
|
1554
|
+
<span class="md-ellipsis">
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
API Reference
|
|
1558
|
+
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
</span>
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
|
|
1565
|
+
</a>
|
|
1566
|
+
|
|
1567
|
+
|
|
1568
|
+
<label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
|
|
1569
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1570
|
+
</label>
|
|
1571
|
+
|
|
1572
|
+
</div>
|
|
1573
|
+
|
|
1574
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
|
|
1575
|
+
<label class="md-nav__title" for="__nav_5">
|
|
1576
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1577
|
+
|
|
1578
|
+
|
|
1579
|
+
API Reference
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
</label>
|
|
1583
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
|
|
1596
|
+
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
|
|
1622
|
+
|
|
1623
|
+
|
|
1624
|
+
<div class="md-nav__link md-nav__container">
|
|
1625
|
+
<a href="../../api/core/" class="md-nav__link ">
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
<span class="md-ellipsis">
|
|
1630
|
+
|
|
1631
|
+
|
|
1632
|
+
Core Classes
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
</span>
|
|
1637
|
+
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
</a>
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
|
|
1644
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1645
|
+
</label>
|
|
1646
|
+
|
|
1647
|
+
</div>
|
|
1648
|
+
|
|
1649
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
|
|
1650
|
+
<label class="md-nav__title" for="__nav_5_2">
|
|
1651
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
Core Classes
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
</label>
|
|
1658
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
<li class="md-nav__item">
|
|
1669
|
+
<a href="../../api/core/robot/" class="md-nav__link">
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
<span class="md-ellipsis">
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
Robot
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
</span>
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
</a>
|
|
1685
|
+
</li>
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
<li class="md-nav__item">
|
|
1697
|
+
<a href="../../api/core/network/" class="md-nav__link">
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
|
|
1701
|
+
<span class="md-ellipsis">
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
Network
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
</span>
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
</a>
|
|
1713
|
+
</li>
|
|
1714
|
+
|
|
1715
|
+
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
<li class="md-nav__item">
|
|
1725
|
+
<a href="../../api/core/state/" class="md-nav__link">
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
|
|
1729
|
+
<span class="md-ellipsis">
|
|
1730
|
+
|
|
1731
|
+
|
|
1732
|
+
State
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
|
|
1736
|
+
</span>
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
</a>
|
|
1741
|
+
</li>
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
<li class="md-nav__item">
|
|
1753
|
+
<a href="../../api/core/tool/" class="md-nav__link">
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
<span class="md-ellipsis">
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
Tool
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
</span>
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
|
|
1768
|
+
</a>
|
|
1769
|
+
</li>
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
<li class="md-nav__item">
|
|
1781
|
+
<a href="../../api/core/memory/" class="md-nav__link">
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
<span class="md-ellipsis">
|
|
1786
|
+
|
|
1787
|
+
|
|
1788
|
+
Memory
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
|
|
1792
|
+
</span>
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
</a>
|
|
1797
|
+
</li>
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
|
|
1801
|
+
|
|
1802
|
+
</ul>
|
|
1803
|
+
</nav>
|
|
1804
|
+
|
|
1805
|
+
</li>
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
|
|
1835
|
+
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
<div class="md-nav__link md-nav__container">
|
|
1846
|
+
<a href="../../api/messages/" class="md-nav__link ">
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
<span class="md-ellipsis">
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
Messages
|
|
1854
|
+
|
|
1855
|
+
|
|
1856
|
+
|
|
1857
|
+
</span>
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
|
|
1861
|
+
</a>
|
|
1862
|
+
|
|
1863
|
+
|
|
1864
|
+
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
|
1865
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1866
|
+
</label>
|
|
1867
|
+
|
|
1868
|
+
</div>
|
|
1869
|
+
|
|
1870
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
|
1871
|
+
<label class="md-nav__title" for="__nav_5_3">
|
|
1872
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
Messages
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
</label>
|
|
1879
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1880
|
+
|
|
1881
|
+
|
|
1882
|
+
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
|
|
1889
|
+
<li class="md-nav__item">
|
|
1890
|
+
<a href="../../api/messages/user-message/" class="md-nav__link">
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
<span class="md-ellipsis">
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
UserMessage
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
</span>
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
</a>
|
|
1906
|
+
</li>
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
|
|
1914
|
+
|
|
1915
|
+
|
|
1916
|
+
|
|
1917
|
+
<li class="md-nav__item">
|
|
1918
|
+
<a href="../../api/messages/text-message/" class="md-nav__link">
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
<span class="md-ellipsis">
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
TextMessage
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
</span>
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
</a>
|
|
1934
|
+
</li>
|
|
1935
|
+
|
|
1936
|
+
|
|
1937
|
+
|
|
1938
|
+
|
|
1939
|
+
|
|
1940
|
+
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
<li class="md-nav__item">
|
|
1946
|
+
<a href="../../api/messages/tool-call-message/" class="md-nav__link">
|
|
1947
|
+
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
<span class="md-ellipsis">
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
ToolCallMessage
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
</span>
|
|
1958
|
+
|
|
1959
|
+
|
|
1960
|
+
|
|
1961
|
+
</a>
|
|
1962
|
+
</li>
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
<li class="md-nav__item">
|
|
1974
|
+
<a href="../../api/messages/tool-result-message/" class="md-nav__link">
|
|
1975
|
+
|
|
1976
|
+
|
|
1977
|
+
|
|
1978
|
+
<span class="md-ellipsis">
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
ToolResultMessage
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
</span>
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
</a>
|
|
1990
|
+
</li>
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
</ul>
|
|
1996
|
+
</nav>
|
|
1997
|
+
|
|
1998
|
+
</li>
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
<div class="md-nav__link md-nav__container">
|
|
2037
|
+
<a href="../../api/mcp/" class="md-nav__link ">
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
<span class="md-ellipsis">
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
MCP
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
|
|
2048
|
+
</span>
|
|
2049
|
+
|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
</a>
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
<label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
|
|
2056
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2057
|
+
</label>
|
|
2058
|
+
|
|
2059
|
+
</div>
|
|
2060
|
+
|
|
2061
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
|
|
2062
|
+
<label class="md-nav__title" for="__nav_5_4">
|
|
2063
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
MCP
|
|
2067
|
+
|
|
2068
|
+
|
|
2069
|
+
</label>
|
|
2070
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
|
|
2079
|
+
|
|
2080
|
+
<li class="md-nav__item">
|
|
2081
|
+
<a href="../../api/mcp/client/" class="md-nav__link">
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
<span class="md-ellipsis">
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
Client
|
|
2089
|
+
|
|
2090
|
+
|
|
2091
|
+
|
|
2092
|
+
</span>
|
|
2093
|
+
|
|
2094
|
+
|
|
2095
|
+
|
|
2096
|
+
</a>
|
|
2097
|
+
</li>
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
2101
|
+
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
|
|
2107
|
+
|
|
2108
|
+
<li class="md-nav__item">
|
|
2109
|
+
<a href="../../api/mcp/server/" class="md-nav__link">
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
<span class="md-ellipsis">
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
Server
|
|
2117
|
+
|
|
2118
|
+
|
|
2119
|
+
|
|
2120
|
+
</span>
|
|
2121
|
+
|
|
2122
|
+
|
|
2123
|
+
|
|
2124
|
+
</a>
|
|
2125
|
+
</li>
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
|
|
2134
|
+
|
|
2135
|
+
|
|
2136
|
+
<li class="md-nav__item">
|
|
2137
|
+
<a href="../../api/mcp/transports/" class="md-nav__link">
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
<span class="md-ellipsis">
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
Transports
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
|
|
2148
|
+
</span>
|
|
2149
|
+
|
|
2150
|
+
|
|
2151
|
+
|
|
2152
|
+
</a>
|
|
2153
|
+
</li>
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
|
|
2158
|
+
</ul>
|
|
2159
|
+
</nav>
|
|
2160
|
+
|
|
2161
|
+
</li>
|
|
2162
|
+
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
|
|
2168
|
+
|
|
2169
|
+
|
|
2170
|
+
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
<div class="md-nav__link md-nav__container">
|
|
2198
|
+
<a href="../../api/streaming/" class="md-nav__link ">
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
|
|
2202
|
+
<span class="md-ellipsis">
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
Streaming
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
|
|
2209
|
+
</span>
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
</a>
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
<label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
|
|
2217
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2218
|
+
</label>
|
|
2219
|
+
|
|
2220
|
+
</div>
|
|
2221
|
+
|
|
2222
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
|
|
2223
|
+
<label class="md-nav__title" for="__nav_5_5">
|
|
2224
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
Streaming
|
|
2228
|
+
|
|
2229
|
+
|
|
2230
|
+
</label>
|
|
2231
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
|
|
2239
|
+
|
|
2240
|
+
|
|
2241
|
+
<li class="md-nav__item">
|
|
2242
|
+
<a href="../../api/streaming/context/" class="md-nav__link">
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
<span class="md-ellipsis">
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
Context
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
|
|
2253
|
+
</span>
|
|
2254
|
+
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
</a>
|
|
2258
|
+
</li>
|
|
2259
|
+
|
|
2260
|
+
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
|
|
2265
|
+
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
|
|
2269
|
+
<li class="md-nav__item">
|
|
2270
|
+
<a href="../../api/streaming/events/" class="md-nav__link">
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
<span class="md-ellipsis">
|
|
2275
|
+
|
|
2276
|
+
|
|
2277
|
+
Events
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
|
|
2281
|
+
</span>
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
</a>
|
|
2286
|
+
</li>
|
|
2287
|
+
|
|
2288
|
+
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
</ul>
|
|
2292
|
+
</nav>
|
|
2293
|
+
|
|
2294
|
+
</li>
|
|
2295
|
+
|
|
2296
|
+
|
|
2297
|
+
|
|
2298
|
+
|
|
2299
|
+
</ul>
|
|
2300
|
+
</nav>
|
|
2301
|
+
|
|
2302
|
+
</li>
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
|
|
2309
|
+
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
|
|
2325
|
+
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
|
|
2331
|
+
|
|
2332
|
+
|
|
2333
|
+
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
<div class="md-nav__link md-nav__container">
|
|
2344
|
+
<a href="../../examples/" class="md-nav__link ">
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
<span class="md-ellipsis">
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
Examples
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
</span>
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
</a>
|
|
2360
|
+
|
|
2361
|
+
|
|
2362
|
+
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
2363
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2364
|
+
</label>
|
|
2365
|
+
|
|
2366
|
+
</div>
|
|
2367
|
+
|
|
2368
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
2369
|
+
<label class="md-nav__title" for="__nav_6">
|
|
2370
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
Examples
|
|
2374
|
+
|
|
2375
|
+
|
|
2376
|
+
</label>
|
|
2377
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
|
|
2387
|
+
<li class="md-nav__item">
|
|
2388
|
+
<a href="../../examples/basic-chat/" class="md-nav__link">
|
|
2389
|
+
|
|
2390
|
+
|
|
2391
|
+
|
|
2392
|
+
<span class="md-ellipsis">
|
|
2393
|
+
|
|
2394
|
+
|
|
2395
|
+
Basic Chat
|
|
2396
|
+
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
</span>
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
|
|
2403
|
+
</a>
|
|
2404
|
+
</li>
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
|
|
2414
|
+
|
|
2415
|
+
<li class="md-nav__item">
|
|
2416
|
+
<a href="../../examples/multi-robot-network/" class="md-nav__link">
|
|
2417
|
+
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
<span class="md-ellipsis">
|
|
2421
|
+
|
|
2422
|
+
|
|
2423
|
+
Multi-Robot Network
|
|
2424
|
+
|
|
2425
|
+
|
|
2426
|
+
|
|
2427
|
+
</span>
|
|
2428
|
+
|
|
2429
|
+
|
|
2430
|
+
|
|
2431
|
+
</a>
|
|
2432
|
+
</li>
|
|
2433
|
+
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
|
|
2441
|
+
|
|
2442
|
+
|
|
2443
|
+
<li class="md-nav__item">
|
|
2444
|
+
<a href="../../examples/tool-usage/" class="md-nav__link">
|
|
2445
|
+
|
|
2446
|
+
|
|
2447
|
+
|
|
2448
|
+
<span class="md-ellipsis">
|
|
2449
|
+
|
|
2450
|
+
|
|
2451
|
+
Tool Usage
|
|
2452
|
+
|
|
2453
|
+
|
|
2454
|
+
|
|
2455
|
+
</span>
|
|
2456
|
+
|
|
2457
|
+
|
|
2458
|
+
|
|
2459
|
+
</a>
|
|
2460
|
+
</li>
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
|
|
2465
|
+
|
|
2466
|
+
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
|
|
2471
|
+
<li class="md-nav__item">
|
|
2472
|
+
<a href="../../examples/mcp-server/" class="md-nav__link">
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
|
|
2476
|
+
<span class="md-ellipsis">
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
MCP Server
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
</span>
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
</a>
|
|
2488
|
+
</li>
|
|
2489
|
+
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
|
|
2499
|
+
<li class="md-nav__item">
|
|
2500
|
+
<a href="../../examples/rails-application/" class="md-nav__link">
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
<span class="md-ellipsis">
|
|
2505
|
+
|
|
2506
|
+
|
|
2507
|
+
Rails Application
|
|
2508
|
+
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
</span>
|
|
2512
|
+
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
</a>
|
|
2516
|
+
</li>
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
|
|
2521
|
+
</ul>
|
|
2522
|
+
</nav>
|
|
2523
|
+
|
|
2524
|
+
</li>
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2528
|
+
</ul>
|
|
2529
|
+
</nav>
|
|
2530
|
+
</div>
|
|
2531
|
+
</div>
|
|
2532
|
+
</div>
|
|
2533
|
+
|
|
2534
|
+
|
|
2535
|
+
|
|
2536
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
2537
|
+
<div class="md-sidebar__scrollwrap">
|
|
2538
|
+
<div class="md-sidebar__inner">
|
|
2539
|
+
|
|
2540
|
+
|
|
2541
|
+
|
|
2542
|
+
|
|
2543
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
2544
|
+
|
|
2545
|
+
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
|
|
2549
|
+
|
|
2550
|
+
<label class="md-nav__title" for="__toc">
|
|
2551
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2552
|
+
On this page
|
|
2553
|
+
</label>
|
|
2554
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
2555
|
+
|
|
2556
|
+
<li class="md-nav__item">
|
|
2557
|
+
<a href="#network-structure" class="md-nav__link">
|
|
2558
|
+
<span class="md-ellipsis">
|
|
2559
|
+
|
|
2560
|
+
Network Structure
|
|
2561
|
+
|
|
2562
|
+
</span>
|
|
2563
|
+
</a>
|
|
2564
|
+
|
|
2565
|
+
</li>
|
|
2566
|
+
|
|
2567
|
+
<li class="md-nav__item">
|
|
2568
|
+
<a href="#creating-networks" class="md-nav__link">
|
|
2569
|
+
<span class="md-ellipsis">
|
|
2570
|
+
|
|
2571
|
+
Creating Networks
|
|
2572
|
+
|
|
2573
|
+
</span>
|
|
2574
|
+
</a>
|
|
2575
|
+
|
|
2576
|
+
</li>
|
|
2577
|
+
|
|
2578
|
+
<li class="md-nav__item">
|
|
2579
|
+
<a href="#task-configuration" class="md-nav__link">
|
|
2580
|
+
<span class="md-ellipsis">
|
|
2581
|
+
|
|
2582
|
+
Task Configuration
|
|
2583
|
+
|
|
2584
|
+
</span>
|
|
2585
|
+
</a>
|
|
2586
|
+
|
|
2587
|
+
<nav class="md-nav" aria-label="Task Configuration">
|
|
2588
|
+
<ul class="md-nav__list">
|
|
2589
|
+
|
|
2590
|
+
<li class="md-nav__item">
|
|
2591
|
+
<a href="#task-parameters" class="md-nav__link">
|
|
2592
|
+
<span class="md-ellipsis">
|
|
2593
|
+
|
|
2594
|
+
Task Parameters
|
|
2595
|
+
|
|
2596
|
+
</span>
|
|
2597
|
+
</a>
|
|
2598
|
+
|
|
2599
|
+
</li>
|
|
2600
|
+
|
|
2601
|
+
</ul>
|
|
2602
|
+
</nav>
|
|
2603
|
+
|
|
2604
|
+
</li>
|
|
2605
|
+
|
|
2606
|
+
<li class="md-nav__item">
|
|
2607
|
+
<a href="#execution-model" class="md-nav__link">
|
|
2608
|
+
<span class="md-ellipsis">
|
|
2609
|
+
|
|
2610
|
+
Execution Model
|
|
2611
|
+
|
|
2612
|
+
</span>
|
|
2613
|
+
</a>
|
|
2614
|
+
|
|
2615
|
+
<nav class="md-nav" aria-label="Execution Model">
|
|
2616
|
+
<ul class="md-nav__list">
|
|
2617
|
+
|
|
2618
|
+
<li class="md-nav__item">
|
|
2619
|
+
<a href="#task-dependency-types" class="md-nav__link">
|
|
2620
|
+
<span class="md-ellipsis">
|
|
2621
|
+
|
|
2622
|
+
Task Dependency Types
|
|
2623
|
+
|
|
2624
|
+
</span>
|
|
2625
|
+
</a>
|
|
2626
|
+
|
|
2627
|
+
</li>
|
|
2628
|
+
|
|
2629
|
+
</ul>
|
|
2630
|
+
</nav>
|
|
2631
|
+
|
|
2632
|
+
</li>
|
|
2633
|
+
|
|
2634
|
+
<li class="md-nav__item">
|
|
2635
|
+
<a href="#robotcall-interface" class="md-nav__link">
|
|
2636
|
+
<span class="md-ellipsis">
|
|
2637
|
+
|
|
2638
|
+
Robot#call Interface
|
|
2639
|
+
|
|
2640
|
+
</span>
|
|
2641
|
+
</a>
|
|
2642
|
+
|
|
2643
|
+
<nav class="md-nav" aria-label="Robot#call Interface">
|
|
2644
|
+
<ul class="md-nav__list">
|
|
2645
|
+
|
|
2646
|
+
<li class="md-nav__item">
|
|
2647
|
+
<a href="#extract_run_context" class="md-nav__link">
|
|
2648
|
+
<span class="md-ellipsis">
|
|
2649
|
+
|
|
2650
|
+
extract_run_context
|
|
2651
|
+
|
|
2652
|
+
</span>
|
|
2653
|
+
</a>
|
|
2654
|
+
|
|
2655
|
+
</li>
|
|
2656
|
+
|
|
2657
|
+
</ul>
|
|
2658
|
+
</nav>
|
|
2659
|
+
|
|
2660
|
+
</li>
|
|
2661
|
+
|
|
2662
|
+
<li class="md-nav__item">
|
|
2663
|
+
<a href="#taskcall-interface" class="md-nav__link">
|
|
2664
|
+
<span class="md-ellipsis">
|
|
2665
|
+
|
|
2666
|
+
Task#call Interface
|
|
2667
|
+
|
|
2668
|
+
</span>
|
|
2669
|
+
</a>
|
|
2670
|
+
|
|
2671
|
+
</li>
|
|
2672
|
+
|
|
2673
|
+
<li class="md-nav__item">
|
|
2674
|
+
<a href="#simpleflowresult" class="md-nav__link">
|
|
2675
|
+
<span class="md-ellipsis">
|
|
2676
|
+
|
|
2677
|
+
SimpleFlow::Result
|
|
2678
|
+
|
|
2679
|
+
</span>
|
|
2680
|
+
</a>
|
|
2681
|
+
|
|
2682
|
+
<nav class="md-nav" aria-label="SimpleFlow::Result">
|
|
2683
|
+
<ul class="md-nav__list">
|
|
2684
|
+
|
|
2685
|
+
<li class="md-nav__item">
|
|
2686
|
+
<a href="#result-methods" class="md-nav__link">
|
|
2687
|
+
<span class="md-ellipsis">
|
|
2688
|
+
|
|
2689
|
+
Result Methods
|
|
2690
|
+
|
|
2691
|
+
</span>
|
|
2692
|
+
</a>
|
|
2693
|
+
|
|
2694
|
+
</li>
|
|
2695
|
+
|
|
2696
|
+
<li class="md-nav__item">
|
|
2697
|
+
<a href="#context-structure" class="md-nav__link">
|
|
2698
|
+
<span class="md-ellipsis">
|
|
2699
|
+
|
|
2700
|
+
Context Structure
|
|
2701
|
+
|
|
2702
|
+
</span>
|
|
2703
|
+
</a>
|
|
2704
|
+
|
|
2705
|
+
</li>
|
|
2706
|
+
|
|
2707
|
+
</ul>
|
|
2708
|
+
</nav>
|
|
2709
|
+
|
|
2710
|
+
</li>
|
|
2711
|
+
|
|
2712
|
+
<li class="md-nav__item">
|
|
2713
|
+
<a href="#optional-task-activation" class="md-nav__link">
|
|
2714
|
+
<span class="md-ellipsis">
|
|
2715
|
+
|
|
2716
|
+
Optional Task Activation
|
|
2717
|
+
|
|
2718
|
+
</span>
|
|
2719
|
+
</a>
|
|
2720
|
+
|
|
2721
|
+
<nav class="md-nav" aria-label="Optional Task Activation">
|
|
2722
|
+
<ul class="md-nav__list">
|
|
2723
|
+
|
|
2724
|
+
<li class="md-nav__item">
|
|
2725
|
+
<a href="#classifier-robot-pattern" class="md-nav__link">
|
|
2726
|
+
<span class="md-ellipsis">
|
|
2727
|
+
|
|
2728
|
+
Classifier Robot Pattern
|
|
2729
|
+
|
|
2730
|
+
</span>
|
|
2731
|
+
</a>
|
|
2732
|
+
|
|
2733
|
+
</li>
|
|
2734
|
+
|
|
2735
|
+
</ul>
|
|
2736
|
+
</nav>
|
|
2737
|
+
|
|
2738
|
+
</li>
|
|
2739
|
+
|
|
2740
|
+
<li class="md-nav__item">
|
|
2741
|
+
<a href="#shared-memory" class="md-nav__link">
|
|
2742
|
+
<span class="md-ellipsis">
|
|
2743
|
+
|
|
2744
|
+
Shared Memory
|
|
2745
|
+
|
|
2746
|
+
</span>
|
|
2747
|
+
</a>
|
|
2748
|
+
|
|
2749
|
+
</li>
|
|
2750
|
+
|
|
2751
|
+
<li class="md-nav__item">
|
|
2752
|
+
<a href="#broadcasting" class="md-nav__link">
|
|
2753
|
+
<span class="md-ellipsis">
|
|
2754
|
+
|
|
2755
|
+
Broadcasting
|
|
2756
|
+
|
|
2757
|
+
</span>
|
|
2758
|
+
</a>
|
|
2759
|
+
|
|
2760
|
+
</li>
|
|
2761
|
+
|
|
2762
|
+
<li class="md-nav__item">
|
|
2763
|
+
<a href="#parallel-execution" class="md-nav__link">
|
|
2764
|
+
<span class="md-ellipsis">
|
|
2765
|
+
|
|
2766
|
+
Parallel Execution
|
|
2767
|
+
|
|
2768
|
+
</span>
|
|
2769
|
+
</a>
|
|
2770
|
+
|
|
2771
|
+
<nav class="md-nav" aria-label="Parallel Execution">
|
|
2772
|
+
<ul class="md-nav__list">
|
|
2773
|
+
|
|
2774
|
+
<li class="md-nav__item">
|
|
2775
|
+
<a href="#concurrency-modes" class="md-nav__link">
|
|
2776
|
+
<span class="md-ellipsis">
|
|
2777
|
+
|
|
2778
|
+
Concurrency Modes
|
|
2779
|
+
|
|
2780
|
+
</span>
|
|
2781
|
+
</a>
|
|
2782
|
+
|
|
2783
|
+
</li>
|
|
2784
|
+
|
|
2785
|
+
</ul>
|
|
2786
|
+
</nav>
|
|
2787
|
+
|
|
2788
|
+
</li>
|
|
2789
|
+
|
|
2790
|
+
<li class="md-nav__item">
|
|
2791
|
+
<a href="#data-flow" class="md-nav__link">
|
|
2792
|
+
<span class="md-ellipsis">
|
|
2793
|
+
|
|
2794
|
+
Data Flow
|
|
2795
|
+
|
|
2796
|
+
</span>
|
|
2797
|
+
</a>
|
|
2798
|
+
|
|
2799
|
+
</li>
|
|
2800
|
+
|
|
2801
|
+
<li class="md-nav__item">
|
|
2802
|
+
<a href="#visualization" class="md-nav__link">
|
|
2803
|
+
<span class="md-ellipsis">
|
|
2804
|
+
|
|
2805
|
+
Visualization
|
|
2806
|
+
|
|
2807
|
+
</span>
|
|
2808
|
+
</a>
|
|
2809
|
+
|
|
2810
|
+
</li>
|
|
2811
|
+
|
|
2812
|
+
<li class="md-nav__item">
|
|
2813
|
+
<a href="#network-inspection" class="md-nav__link">
|
|
2814
|
+
<span class="md-ellipsis">
|
|
2815
|
+
|
|
2816
|
+
Network Inspection
|
|
2817
|
+
|
|
2818
|
+
</span>
|
|
2819
|
+
</a>
|
|
2820
|
+
|
|
2821
|
+
</li>
|
|
2822
|
+
|
|
2823
|
+
<li class="md-nav__item">
|
|
2824
|
+
<a href="#next-steps" class="md-nav__link">
|
|
2825
|
+
<span class="md-ellipsis">
|
|
2826
|
+
|
|
2827
|
+
Next Steps
|
|
2828
|
+
|
|
2829
|
+
</span>
|
|
2830
|
+
</a>
|
|
2831
|
+
|
|
2832
|
+
</li>
|
|
2833
|
+
|
|
2834
|
+
</ul>
|
|
2835
|
+
|
|
2836
|
+
</nav>
|
|
2837
|
+
</div>
|
|
2838
|
+
</div>
|
|
2839
|
+
</div>
|
|
2840
|
+
|
|
2841
|
+
|
|
2842
|
+
|
|
2843
|
+
<div class="md-content" data-md-component="content">
|
|
2844
|
+
|
|
2845
|
+
|
|
2846
|
+
|
|
2847
|
+
|
|
2848
|
+
|
|
2849
|
+
|
|
2850
|
+
|
|
2851
|
+
<article class="md-content__inner md-typeset">
|
|
2852
|
+
|
|
2853
|
+
|
|
2854
|
+
|
|
2855
|
+
|
|
2856
|
+
|
|
2857
|
+
<a href="https://github.com/madbomber/robot_lab/edit/main/docs/architecture/network-orchestration.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
2858
|
+
|
|
2859
|
+
<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>
|
|
2860
|
+
</a>
|
|
2861
|
+
|
|
2862
|
+
|
|
2863
|
+
|
|
2864
|
+
|
|
2865
|
+
|
|
2866
|
+
<a href="https://github.com/madbomber/robot_lab/raw/main/docs/architecture/network-orchestration.md" title="View source of this page" class="md-content__button md-icon">
|
|
2867
|
+
|
|
2868
|
+
<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>
|
|
2869
|
+
</a>
|
|
2870
|
+
|
|
2871
|
+
|
|
2872
|
+
|
|
2873
|
+
<h1 id="network-orchestration">Network Orchestration<a class="headerlink" href="#network-orchestration" title="Permanent link">¶</a></h1>
|
|
2874
|
+
<p>Networks coordinate multiple robots using <a href="https://github.com/MadBomber/simple_flow">SimpleFlow</a> pipelines for DAG-based execution.</p>
|
|
2875
|
+
<h2 id="network-structure">Network Structure<a class="headerlink" href="#network-structure" title="Permanent link">¶</a></h2>
|
|
2876
|
+
<p>A network is a thin wrapper around <code>SimpleFlow::Pipeline</code>:</p>
|
|
2877
|
+
<ul>
|
|
2878
|
+
<li><strong>Pipeline</strong>: DAG-based execution engine</li>
|
|
2879
|
+
<li><strong>Robots</strong>: Named collection of robot instances</li>
|
|
2880
|
+
<li><strong>Tasks</strong>: Wrap robots with per-task configuration and define dependencies</li>
|
|
2881
|
+
<li><strong>Memory</strong>: Shared reactive memory for inter-robot communication</li>
|
|
2882
|
+
</ul>
|
|
2883
|
+
<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="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>
|
|
2884
|
+
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-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>
|
|
2885
|
+
</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="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>
|
|
2886
|
+
</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="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>
|
|
2887
|
+
</span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="k">end</span>
|
|
2888
|
+
</span></code></pre></div>
|
|
2889
|
+
<h2 id="creating-networks">Creating Networks<a class="headerlink" href="#creating-networks" title="Permanent link">¶</a></h2>
|
|
2890
|
+
<p>Networks are created via <code>RobotLab.create_network</code> with a block DSL:</p>
|
|
2891
|
+
<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">analyst</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">"analyst"</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">"Analyze the input."</span><span class="p">)</span>
|
|
2892
|
+
</span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="n">writer</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">"writer"</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">"Write a report."</span><span class="p">)</span>
|
|
2893
|
+
</span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="n">reviewer</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">"reviewer"</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">"Review the report."</span><span class="p">)</span>
|
|
2894
|
+
</span><span id="__span-1-4"><a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
|
|
2895
|
+
</span><span id="__span-1-5"><a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></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">"pipeline"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span>
|
|
2896
|
+
</span><span id="__span-1-6"><a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:analyst</span><span class="p">,</span><span class="w"> </span><span class="n">analyst</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>
|
|
2897
|
+
</span><span id="__span-1-7"><a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:writer</span><span class="p">,</span><span class="w"> </span><span class="n">writer</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="o">[</span><span class="ss">:analyst</span><span class="o">]</span>
|
|
2898
|
+
</span><span id="__span-1-8"><a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:reviewer</span><span class="p">,</span><span class="w"> </span><span class="n">reviewer</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="o">[</span><span class="ss">:writer</span><span class="o">]</span>
|
|
2899
|
+
</span><span id="__span-1-9"><a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="k">end</span>
|
|
2900
|
+
</span><span id="__span-1-10"><a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a>
|
|
2901
|
+
</span><span id="__span-1-11"><a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-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">"Analyze this quarterly data"</span><span class="p">)</span>
|
|
2902
|
+
</span></code></pre></div>
|
|
2903
|
+
<h2 id="task-configuration">Task Configuration<a class="headerlink" href="#task-configuration" title="Permanent link">¶</a></h2>
|
|
2904
|
+
<p>Tasks can have per-task configuration that is deep-merged with network run params:</p>
|
|
2905
|
+
<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">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"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span>
|
|
2906
|
+
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-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>
|
|
2907
|
+
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-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>
|
|
2908
|
+
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-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="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>
|
|
2909
|
+
</span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></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="o">]</span><span class="p">,</span>
|
|
2910
|
+
</span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
2911
|
+
</span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></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>
|
|
2912
|
+
</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></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>
|
|
2913
|
+
</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="w"> </span><span class="ss">mcp</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="n">filesystem_server</span><span class="o">]</span><span class="p">,</span>
|
|
2914
|
+
</span><span id="__span-2-10"><a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a><span class="w"> </span><span class="ss">depends_on</span><span class="p">:</span><span class="w"> </span><span class="ss">:optional</span>
|
|
2915
|
+
</span><span id="__span-2-11"><a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a><span class="k">end</span>
|
|
2916
|
+
</span></code></pre></div>
|
|
2917
|
+
<h3 id="task-parameters">Task Parameters<a class="headerlink" href="#task-parameters" title="Permanent link">¶</a></h3>
|
|
2918
|
+
<table>
|
|
2919
|
+
<thead>
|
|
2920
|
+
<tr>
|
|
2921
|
+
<th>Parameter</th>
|
|
2922
|
+
<th>Type</th>
|
|
2923
|
+
<th>Description</th>
|
|
2924
|
+
</tr>
|
|
2925
|
+
</thead>
|
|
2926
|
+
<tbody>
|
|
2927
|
+
<tr>
|
|
2928
|
+
<td><code>name</code></td>
|
|
2929
|
+
<td>Symbol</td>
|
|
2930
|
+
<td>Task/step name</td>
|
|
2931
|
+
</tr>
|
|
2932
|
+
<tr>
|
|
2933
|
+
<td><code>robot</code></td>
|
|
2934
|
+
<td>Robot</td>
|
|
2935
|
+
<td>The robot instance</td>
|
|
2936
|
+
</tr>
|
|
2937
|
+
<tr>
|
|
2938
|
+
<td><code>context</code></td>
|
|
2939
|
+
<td>Hash</td>
|
|
2940
|
+
<td>Task-specific context (deep-merged with run params)</td>
|
|
2941
|
+
</tr>
|
|
2942
|
+
<tr>
|
|
2943
|
+
<td><code>mcp</code></td>
|
|
2944
|
+
<td>Symbol, Array</td>
|
|
2945
|
+
<td>MCP server config (<code>:none</code>, <code>:inherit</code>, or array)</td>
|
|
2946
|
+
</tr>
|
|
2947
|
+
<tr>
|
|
2948
|
+
<td><code>tools</code></td>
|
|
2949
|
+
<td>Symbol, Array</td>
|
|
2950
|
+
<td>Tools config (<code>:none</code>, <code>:inherit</code>, or array)</td>
|
|
2951
|
+
</tr>
|
|
2952
|
+
<tr>
|
|
2953
|
+
<td><code>memory</code></td>
|
|
2954
|
+
<td>Memory, Hash, nil</td>
|
|
2955
|
+
<td>Task-specific memory</td>
|
|
2956
|
+
</tr>
|
|
2957
|
+
<tr>
|
|
2958
|
+
<td><code>depends_on</code></td>
|
|
2959
|
+
<td>Symbol, Array</td>
|
|
2960
|
+
<td>Dependencies (<code>:none</code>, <code>:optional</code>, or task names)</td>
|
|
2961
|
+
</tr>
|
|
2962
|
+
</tbody>
|
|
2963
|
+
</table>
|
|
2964
|
+
<h2 id="execution-model">Execution Model<a class="headerlink" href="#execution-model" title="Permanent link">¶</a></h2>
|
|
2965
|
+
<pre class="mermaid"><code>stateDiagram-v2
|
|
2966
|
+
[*] --> Start
|
|
2967
|
+
Start --> ExecuteTask: next ready task
|
|
2968
|
+
ExecuteTask --> CheckDependents: task complete
|
|
2969
|
+
CheckDependents --> ExecuteTask: more tasks ready
|
|
2970
|
+
CheckDependents --> Complete: all tasks done
|
|
2971
|
+
ExecuteTask --> Halted: task halts
|
|
2972
|
+
Complete --> [*]
|
|
2973
|
+
Halted --> [*]</code></pre>
|
|
2974
|
+
<h3 id="task-dependency-types">Task Dependency Types<a class="headerlink" href="#task-dependency-types" title="Permanent link">¶</a></h3>
|
|
2975
|
+
<table>
|
|
2976
|
+
<thead>
|
|
2977
|
+
<tr>
|
|
2978
|
+
<th>Type</th>
|
|
2979
|
+
<th>Description</th>
|
|
2980
|
+
</tr>
|
|
2981
|
+
</thead>
|
|
2982
|
+
<tbody>
|
|
2983
|
+
<tr>
|
|
2984
|
+
<td><code>:none</code></td>
|
|
2985
|
+
<td>No dependencies, runs first</td>
|
|
2986
|
+
</tr>
|
|
2987
|
+
<tr>
|
|
2988
|
+
<td><code>[:task1, :task2]</code></td>
|
|
2989
|
+
<td>Waits for listed tasks to complete</td>
|
|
2990
|
+
</tr>
|
|
2991
|
+
<tr>
|
|
2992
|
+
<td><code>:optional</code></td>
|
|
2993
|
+
<td>Only runs when explicitly activated</td>
|
|
2994
|
+
</tr>
|
|
2995
|
+
</tbody>
|
|
2996
|
+
</table>
|
|
2997
|
+
<h2 id="robotcall-interface">Robot#call Interface<a class="headerlink" href="#robotcall-interface" title="Permanent link">¶</a></h2>
|
|
2998
|
+
<p>Each robot implements the SimpleFlow step interface via <code>call(result)</code>:</p>
|
|
2999
|
+
<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"># Inside Robot (simplified)</span>
|
|
3000
|
+
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><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>
|
|
3001
|
+
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="w"> </span><span class="n">run_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>
|
|
3002
|
+
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></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">run_context</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="ss">:message</span><span class="p">)</span>
|
|
3003
|
+
</span><span id="__span-3-5"><a id="__codelineno-3-5" name="__codelineno-3-5" href="#__codelineno-3-5"></a>
|
|
3004
|
+
</span><span id="__span-3-6"><a id="__codelineno-3-6" name="__codelineno-3-6" href="#__codelineno-3-6"></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">run_context</span><span class="p">)</span>
|
|
3005
|
+
</span><span id="__span-3-7"><a id="__codelineno-3-7" name="__codelineno-3-7" href="#__codelineno-3-7"></a>
|
|
3006
|
+
</span><span id="__span-3-8"><a id="__codelineno-3-8" name="__codelineno-3-8" href="#__codelineno-3-8"></a><span class="w"> </span><span class="n">result</span>
|
|
3007
|
+
</span><span id="__span-3-9"><a id="__codelineno-3-9" name="__codelineno-3-9" href="#__codelineno-3-9"></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>
|
|
3008
|
+
</span><span id="__span-3-10"><a id="__codelineno-3-10" name="__codelineno-3-10" href="#__codelineno-3-10"></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>
|
|
3009
|
+
</span><span id="__span-3-11"><a id="__codelineno-3-11" name="__codelineno-3-11" href="#__codelineno-3-11"></a><span class="k">end</span>
|
|
3010
|
+
</span></code></pre></div>
|
|
3011
|
+
<h3 id="extract_run_context">extract_run_context<a class="headerlink" href="#extract_run_context" title="Permanent link">¶</a></h3>
|
|
3012
|
+
<p>The <code>extract_run_context</code> method pulls parameters from the SimpleFlow result:</p>
|
|
3013
|
+
<ul>
|
|
3014
|
+
<li>Extracts <code>:mcp</code>, <code>:tools</code>, <code>:memory</code>, and <code>:network_memory</code> from <code>run_params</code></li>
|
|
3015
|
+
<li>Merges the current result value into the context</li>
|
|
3016
|
+
<li>If the previous result value is a <code>RobotResult</code>, extracts its <code>last_text_content</code> as the message</li>
|
|
3017
|
+
<li>If it is a String, uses it directly as the message</li>
|
|
3018
|
+
<li>If it is a Hash, merges it with the run params</li>
|
|
3019
|
+
</ul>
|
|
3020
|
+
<h2 id="taskcall-interface">Task#call Interface<a class="headerlink" href="#taskcall-interface" title="Permanent link">¶</a></h2>
|
|
3021
|
+
<p>Each <code>Task</code> wraps a robot and enhances the SimpleFlow result before delegation:</p>
|
|
3022
|
+
<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="c1"># Inside Task (simplified)</span>
|
|
3023
|
+
</span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><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>
|
|
3024
|
+
</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="c1"># Deep merge task context with run_params</span>
|
|
3025
|
+
</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="n">run_params</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">deep_merge</span><span class="p">(</span>
|
|
3026
|
+
</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="n">result</span><span class="o">.</span><span class="n">context</span><span class="o">[</span><span class="ss">:run_params</span><span class="o">]</span><span class="w"> </span><span class="o">||</span><span class="w"> </span><span class="p">{},</span>
|
|
3027
|
+
</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="vi">@context</span>
|
|
3028
|
+
</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="p">)</span>
|
|
3029
|
+
</span><span id="__span-4-8"><a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>
|
|
3030
|
+
</span><span id="__span-4-9"><a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a><span class="w"> </span><span class="c1"># Add task-specific config</span>
|
|
3031
|
+
</span><span id="__span-4-10"><a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a><span class="w"> </span><span class="n">run_params</span><span class="o">[</span><span class="ss">:mcp</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@mcp</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="vi">@mcp</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="ss">:none</span>
|
|
3032
|
+
</span><span id="__span-4-11"><a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a><span class="w"> </span><span class="n">run_params</span><span class="o">[</span><span class="ss">:tools</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@tools</span><span class="w"> </span><span class="k">unless</span><span class="w"> </span><span class="vi">@tools</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="ss">:none</span>
|
|
3033
|
+
</span><span id="__span-4-12"><a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a><span class="w"> </span><span class="n">run_params</span><span class="o">[</span><span class="ss">:memory</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@memory</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="vi">@memory</span>
|
|
3034
|
+
</span><span id="__span-4-13"><a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a>
|
|
3035
|
+
</span><span id="__span-4-14"><a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a><span class="w"> </span><span class="n">enhanced_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">with_context</span><span class="p">(</span><span class="ss">:run_params</span><span class="p">,</span><span class="w"> </span><span class="n">run_params</span><span class="p">)</span>
|
|
3036
|
+
</span><span id="__span-4-15"><a id="__codelineno-4-15" name="__codelineno-4-15" href="#__codelineno-4-15"></a><span class="w"> </span><span class="vi">@robot</span><span class="o">.</span><span class="n">call</span><span class="p">(</span><span class="n">enhanced_result</span><span class="p">)</span>
|
|
3037
|
+
</span><span id="__span-4-16"><a id="__codelineno-4-16" name="__codelineno-4-16" href="#__codelineno-4-16"></a><span class="k">end</span>
|
|
3038
|
+
</span></code></pre></div>
|
|
3039
|
+
<h2 id="simpleflowresult">SimpleFlow::Result<a class="headerlink" href="#simpleflowresult" title="Permanent link">¶</a></h2>
|
|
3040
|
+
<p>The result object flows through the pipeline:</p>
|
|
3041
|
+
<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">result</span><span class="o">.</span><span class="n">value</span><span class="w"> </span><span class="c1"># Current task's output (RobotResult)</span>
|
|
3042
|
+
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-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>
|
|
3043
|
+
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-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>
|
|
3044
|
+
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-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>
|
|
3045
|
+
</span></code></pre></div>
|
|
3046
|
+
<h3 id="result-methods">Result Methods<a class="headerlink" href="#result-methods" title="Permanent link">¶</a></h3>
|
|
3047
|
+
<table>
|
|
3048
|
+
<thead>
|
|
3049
|
+
<tr>
|
|
3050
|
+
<th>Method</th>
|
|
3051
|
+
<th>Description</th>
|
|
3052
|
+
</tr>
|
|
3053
|
+
</thead>
|
|
3054
|
+
<tbody>
|
|
3055
|
+
<tr>
|
|
3056
|
+
<td><code>continue(value)</code></td>
|
|
3057
|
+
<td>Continue to next tasks</td>
|
|
3058
|
+
</tr>
|
|
3059
|
+
<tr>
|
|
3060
|
+
<td><code>halt(value)</code></td>
|
|
3061
|
+
<td>Stop pipeline execution</td>
|
|
3062
|
+
</tr>
|
|
3063
|
+
<tr>
|
|
3064
|
+
<td><code>with_context(key, val)</code></td>
|
|
3065
|
+
<td>Add data to context</td>
|
|
3066
|
+
</tr>
|
|
3067
|
+
<tr>
|
|
3068
|
+
<td><code>activate(task_name)</code></td>
|
|
3069
|
+
<td>Enable an optional task</td>
|
|
3070
|
+
</tr>
|
|
3071
|
+
</tbody>
|
|
3072
|
+
</table>
|
|
3073
|
+
<h3 id="context-structure">Context Structure<a class="headerlink" href="#context-structure" title="Permanent link">¶</a></h3>
|
|
3074
|
+
<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="p">{</span>
|
|
3075
|
+
</span><span id="__span-6-2"><a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span><span class="ss">run_params</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s2">"..."</span><span class="p">,</span><span class="w"> </span><span class="ss">customer_id</span><span class="p">:</span><span class="w"> </span><span class="mi">123</span><span class="p">,</span><span class="w"> </span><span class="ss">network_memory</span><span class="p">:</span><span class="w"> </span><span class="n">memory</span><span class="w"> </span><span class="p">},</span>
|
|
3076
|
+
</span><span id="__span-6-3"><a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span><span class="ss">classifier</span><span class="p">:</span><span class="w"> </span><span class="no">RobotResult</span><span class="p">,</span><span class="w"> </span><span class="c1"># Stored by Robot#call</span>
|
|
3077
|
+
</span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span><span class="ss">billing</span><span class="p">:</span><span class="w"> </span><span class="no">RobotResult</span><span class="p">,</span>
|
|
3078
|
+
</span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="w"> </span><span class="c1"># ... other task results</span>
|
|
3079
|
+
</span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="p">}</span>
|
|
3080
|
+
</span></code></pre></div>
|
|
3081
|
+
<h2 id="optional-task-activation">Optional Task Activation<a class="headerlink" href="#optional-task-activation" title="Permanent link">¶</a></h2>
|
|
3082
|
+
<p>Optional tasks (those with <code>depends_on: :optional</code>) do not run automatically. They must be activated by a preceding task using <code>result.activate(:task_name)</code>.</p>
|
|
3083
|
+
<p>This pattern is commonly used with a classifier robot that analyzes the input and routes to the appropriate handler:</p>
|
|
3084
|
+
<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="n">classifier</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>
|
|
3085
|
+
</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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"classifier"</span><span class="p">,</span>
|
|
3086
|
+
</span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"Classify the request. Respond with: BILLING, TECHNICAL, or GENERAL."</span>
|
|
3087
|
+
</span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="p">)</span>
|
|
3088
|
+
</span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a>
|
|
3089
|
+
</span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="n">billing</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">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"Handle billing requests."</span><span class="p">)</span>
|
|
3090
|
+
</span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="n">technical</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">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"Handle technical requests."</span><span class="p">)</span>
|
|
3091
|
+
</span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="n">general</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">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">"Handle general requests."</span><span class="p">)</span>
|
|
3092
|
+
</span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a>
|
|
3093
|
+
</span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></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"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span>
|
|
3094
|
+
</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="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>
|
|
3095
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:billing</span><span class="p">,</span><span class="w"> </span><span class="n">billing</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>
|
|
3096
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:technical</span><span class="p">,</span><span class="w"> </span><span class="n">technical</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>
|
|
3097
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:general</span><span class="p">,</span><span class="w"> </span><span class="n">general</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>
|
|
3098
|
+
</span><span id="__span-7-15"><a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a><span class="k">end</span>
|
|
3099
|
+
</span></code></pre></div>
|
|
3100
|
+
<h3 id="classifier-robot-pattern">Classifier Robot Pattern<a class="headerlink" href="#classifier-robot-pattern" title="Permanent link">¶</a></h3>
|
|
3101
|
+
<p>To activate optional tasks, a robot subclass overrides <code>call</code> to inspect its own output and activate the appropriate downstream task:</p>
|
|
3102
|
+
<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="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>
|
|
3103
|
+
</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="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>
|
|
3104
|
+
</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="n">run_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>
|
|
3105
|
+
</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="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">run_context</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="ss">:message</span><span class="p">)</span>
|
|
3106
|
+
</span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a>
|
|
3107
|
+
</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="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">run_context</span><span class="p">)</span>
|
|
3108
|
+
</span><span id="__span-8-7"><a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a>
|
|
3109
|
+
</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="n">new_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">result</span>
|
|
3110
|
+
</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="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>
|
|
3111
|
+
</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="o">.</span><span class="n">continue</span><span class="p">(</span><span class="n">robot_result</span><span class="p">)</span>
|
|
3112
|
+
</span><span id="__span-8-11"><a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a>
|
|
3113
|
+
</span><span id="__span-8-12"><a id="__codelineno-8-12" name="__codelineno-8-12" href="#__codelineno-8-12"></a><span class="w"> </span><span class="c1"># Analyze output and activate the appropriate optional task</span>
|
|
3114
|
+
</span><span id="__span-8-13"><a id="__codelineno-8-13" name="__codelineno-8-13" href="#__codelineno-8-13"></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">downcase</span>
|
|
3115
|
+
</span><span id="__span-8-14"><a id="__codelineno-8-14" name="__codelineno-8-14" href="#__codelineno-8-14"></a>
|
|
3116
|
+
</span><span id="__span-8-15"><a id="__codelineno-8-15" name="__codelineno-8-15" href="#__codelineno-8-15"></a><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">category</span>
|
|
3117
|
+
</span><span id="__span-8-16"><a id="__codelineno-8-16" name="__codelineno-8-16" href="#__codelineno-8-16"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="sr">/billing/</span>
|
|
3118
|
+
</span><span id="__span-8-17"><a id="__codelineno-8-17" name="__codelineno-8-17" href="#__codelineno-8-17"></a><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>
|
|
3119
|
+
</span><span id="__span-8-18"><a id="__codelineno-8-18" name="__codelineno-8-18" href="#__codelineno-8-18"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="sr">/technical/</span>
|
|
3120
|
+
</span><span id="__span-8-19"><a id="__codelineno-8-19" name="__codelineno-8-19" href="#__codelineno-8-19"></a><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>
|
|
3121
|
+
</span><span id="__span-8-20"><a id="__codelineno-8-20" name="__codelineno-8-20" href="#__codelineno-8-20"></a><span class="w"> </span><span class="k">else</span>
|
|
3122
|
+
</span><span id="__span-8-21"><a id="__codelineno-8-21" name="__codelineno-8-21" href="#__codelineno-8-21"></a><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>
|
|
3123
|
+
</span><span id="__span-8-22"><a id="__codelineno-8-22" name="__codelineno-8-22" href="#__codelineno-8-22"></a><span class="w"> </span><span class="k">end</span>
|
|
3124
|
+
</span><span id="__span-8-23"><a id="__codelineno-8-23" name="__codelineno-8-23" href="#__codelineno-8-23"></a><span class="w"> </span><span class="k">end</span>
|
|
3125
|
+
</span><span id="__span-8-24"><a id="__codelineno-8-24" name="__codelineno-8-24" href="#__codelineno-8-24"></a><span class="k">end</span>
|
|
3126
|
+
</span></code></pre></div>
|
|
3127
|
+
<h2 id="shared-memory">Shared Memory<a class="headerlink" href="#shared-memory" title="Permanent link">¶</a></h2>
|
|
3128
|
+
<p>All robots in a network share the network's memory during execution. The network injects its memory into the run context:</p>
|
|
3129
|
+
<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="c1"># Inside Network#run</span>
|
|
3130
|
+
</span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="k">def</span><span class="w"> </span><span class="nf">run</span><span class="p">(</span><span class="o">**</span><span class="n">run_context</span><span class="p">)</span>
|
|
3131
|
+
</span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w"> </span><span class="n">run_context</span><span class="o">[</span><span class="ss">:network_memory</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="vi">@memory</span>
|
|
3132
|
+
</span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="w"> </span><span class="n">initial_result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">SimpleFlow</span><span class="o">::</span><span class="no">Result</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3133
|
+
</span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="w"> </span><span class="n">run_context</span><span class="p">,</span>
|
|
3134
|
+
</span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></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">run_params</span><span class="p">:</span><span class="w"> </span><span class="n">run_context</span><span class="w"> </span><span class="p">}</span>
|
|
3135
|
+
</span><span id="__span-9-7"><a id="__codelineno-9-7" name="__codelineno-9-7" href="#__codelineno-9-7"></a><span class="w"> </span><span class="p">)</span>
|
|
3136
|
+
</span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="w"> </span><span class="vi">@pipeline</span><span class="o">.</span><span class="n">call_parallel</span><span class="p">(</span><span class="n">initial_result</span><span class="p">)</span>
|
|
3137
|
+
</span><span id="__span-9-9"><a id="__codelineno-9-9" name="__codelineno-9-9" href="#__codelineno-9-9"></a><span class="k">end</span>
|
|
3138
|
+
</span></code></pre></div>
|
|
3139
|
+
<p>Robots use the shared memory for inter-robot communication:</p>
|
|
3140
|
+
<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"># Robot A writes to shared memory</span>
|
|
3141
|
+
</span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:classification</span><span class="p">,</span><span class="w"> </span><span class="s2">"billing"</span><span class="p">)</span>
|
|
3142
|
+
</span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a>
|
|
3143
|
+
</span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="c1"># Robot B reads from shared memory</span>
|
|
3144
|
+
</span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="n">category</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:classification</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>
|
|
3145
|
+
</span></code></pre></div>
|
|
3146
|
+
<p>See <a href="../state-management/">Memory Management</a> for details on reactive features like subscriptions and blocking reads.</p>
|
|
3147
|
+
<h2 id="broadcasting">Broadcasting<a class="headerlink" href="#broadcasting" title="Permanent link">¶</a></h2>
|
|
3148
|
+
<p>Networks support a broadcast channel for network-wide announcements:</p>
|
|
3149
|
+
<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"># Register handlers</span>
|
|
3150
|
+
</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">on_broadcast</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>
|
|
3151
|
+
</span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="n">message</span><span class="o">[</span><span class="ss">:payload</span><span class="o">][</span><span class="ss">:event</span><span class="o">]</span>
|
|
3152
|
+
</span><span id="__span-11-4"><a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="ss">:pause</span>
|
|
3153
|
+
</span><span id="__span-11-5"><a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="w"> </span><span class="n">pause_current_work</span>
|
|
3154
|
+
</span><span id="__span-11-6"><a id="__codelineno-11-6" name="__codelineno-11-6" href="#__codelineno-11-6"></a><span class="w"> </span><span class="k">when</span><span class="w"> </span><span class="ss">:resume</span>
|
|
3155
|
+
</span><span id="__span-11-7"><a id="__codelineno-11-7" name="__codelineno-11-7" href="#__codelineno-11-7"></a><span class="w"> </span><span class="n">resume_work</span>
|
|
3156
|
+
</span><span id="__span-11-8"><a id="__codelineno-11-8" name="__codelineno-11-8" href="#__codelineno-11-8"></a><span class="w"> </span><span class="k">end</span>
|
|
3157
|
+
</span><span id="__span-11-9"><a id="__codelineno-11-9" name="__codelineno-11-9" href="#__codelineno-11-9"></a><span class="k">end</span>
|
|
3158
|
+
</span><span id="__span-11-10"><a id="__codelineno-11-10" name="__codelineno-11-10" href="#__codelineno-11-10"></a>
|
|
3159
|
+
</span><span id="__span-11-11"><a id="__codelineno-11-11" name="__codelineno-11-11" href="#__codelineno-11-11"></a><span class="c1"># Send broadcasts</span>
|
|
3160
|
+
</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">broadcast</span><span class="p">(</span><span class="ss">event</span><span class="p">:</span><span class="w"> </span><span class="ss">:pause</span><span class="p">,</span><span class="w"> </span><span class="ss">reason</span><span class="p">:</span><span class="w"> </span><span class="s2">"rate limit hit"</span><span class="p">)</span>
|
|
3161
|
+
</span><span id="__span-11-13"><a id="__codelineno-11-13" name="__codelineno-11-13" href="#__codelineno-11-13"></a><span class="n">network</span><span class="o">.</span><span class="n">broadcast</span><span class="p">(</span><span class="ss">event</span><span class="p">:</span><span class="w"> </span><span class="ss">:phase_complete</span><span class="p">,</span><span class="w"> </span><span class="ss">phase</span><span class="p">:</span><span class="w"> </span><span class="s2">"analysis"</span><span class="p">)</span>
|
|
3162
|
+
</span></code></pre></div>
|
|
3163
|
+
<p>Broadcasts are dispatched asynchronously and also written to memory at the <code>_network_broadcast</code> key, so robots can subscribe via <code>memory.subscribe(:_network_broadcast)</code>.</p>
|
|
3164
|
+
<h2 id="parallel-execution">Parallel Execution<a class="headerlink" href="#parallel-execution" title="Permanent link">¶</a></h2>
|
|
3165
|
+
<p>Tasks with the same dependencies can run in parallel:</p>
|
|
3166
|
+
<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">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">"analysis"</span><span class="p">,</span><span class="w"> </span><span class="ss">concurrency</span><span class="p">:</span><span class="w"> </span><span class="ss">:threads</span><span class="p">)</span><span class="w"> </span><span class="k">do</span>
|
|
3167
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:fetch</span><span class="p">,</span><span class="w"> </span><span class="n">fetcher</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>
|
|
3168
|
+
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a>
|
|
3169
|
+
</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="c1"># These three run in parallel after :fetch completes</span>
|
|
3170
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="n">sentiment_bot</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="o">[</span><span class="ss">:fetch</span><span class="o">]</span>
|
|
3171
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:entities</span><span class="p">,</span><span class="w"> </span><span class="n">entity_bot</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="o">[</span><span class="ss">:fetch</span><span class="o">]</span>
|
|
3172
|
+
</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="n">task</span><span class="w"> </span><span class="ss">:keywords</span><span class="p">,</span><span class="w"> </span><span class="n">keyword_bot</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="o">[</span><span class="ss">:fetch</span><span class="o">]</span>
|
|
3173
|
+
</span><span id="__span-12-8"><a id="__codelineno-12-8" name="__codelineno-12-8" href="#__codelineno-12-8"></a>
|
|
3174
|
+
</span><span id="__span-12-9"><a id="__codelineno-12-9" name="__codelineno-12-9" href="#__codelineno-12-9"></a><span class="w"> </span><span class="c1"># Waits for all three</span>
|
|
3175
|
+
</span><span id="__span-12-10"><a id="__codelineno-12-10" name="__codelineno-12-10" href="#__codelineno-12-10"></a><span class="w"> </span><span class="n">task</span><span class="w"> </span><span class="ss">:merge</span><span class="p">,</span><span class="w"> </span><span class="n">merger</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="o">[</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="o">]</span>
|
|
3176
|
+
</span><span id="__span-12-11"><a id="__codelineno-12-11" name="__codelineno-12-11" href="#__codelineno-12-11"></a><span class="k">end</span>
|
|
3177
|
+
</span></code></pre></div>
|
|
3178
|
+
<h3 id="concurrency-modes">Concurrency Modes<a class="headerlink" href="#concurrency-modes" title="Permanent link">¶</a></h3>
|
|
3179
|
+
<table>
|
|
3180
|
+
<thead>
|
|
3181
|
+
<tr>
|
|
3182
|
+
<th>Mode</th>
|
|
3183
|
+
<th>Description</th>
|
|
3184
|
+
</tr>
|
|
3185
|
+
</thead>
|
|
3186
|
+
<tbody>
|
|
3187
|
+
<tr>
|
|
3188
|
+
<td><code>:auto</code></td>
|
|
3189
|
+
<td>SimpleFlow chooses best mode</td>
|
|
3190
|
+
</tr>
|
|
3191
|
+
<tr>
|
|
3192
|
+
<td><code>:threads</code></td>
|
|
3193
|
+
<td>Use Ruby threads</td>
|
|
3194
|
+
</tr>
|
|
3195
|
+
<tr>
|
|
3196
|
+
<td><code>:async</code></td>
|
|
3197
|
+
<td>Use async/fiber</td>
|
|
3198
|
+
</tr>
|
|
3199
|
+
</tbody>
|
|
3200
|
+
</table>
|
|
3201
|
+
<h2 id="data-flow">Data Flow<a class="headerlink" href="#data-flow" title="Permanent link">¶</a></h2>
|
|
3202
|
+
<ol>
|
|
3203
|
+
<li><strong>Initial Value</strong>: <code>network.run(**params)</code> creates an initial <code>SimpleFlow::Result</code> with the run context</li>
|
|
3204
|
+
<li><strong>Run Params</strong>: Stored in <code>result.context[:run_params]</code></li>
|
|
3205
|
+
<li><strong>Task Results</strong>: Each task adds its <code>RobotResult</code> to context under its task name</li>
|
|
3206
|
+
<li><strong>Final Value</strong>: Last task's output becomes <code>result.value</code></li>
|
|
3207
|
+
</ol>
|
|
3208
|
+
<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="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>
|
|
3209
|
+
</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="ss">message</span><span class="p">:</span><span class="w"> </span><span class="s2">"Help with billing"</span><span class="p">,</span>
|
|
3210
|
+
</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="ss">customer_id</span><span class="p">:</span><span class="w"> </span><span class="mi">123</span>
|
|
3211
|
+
</span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="p">)</span>
|
|
3212
|
+
</span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a>
|
|
3213
|
+
</span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="n">result</span><span class="o">.</span><span class="n">context</span><span class="o">[</span><span class="ss">:run_params</span><span class="o">]</span><span class="w"> </span><span class="c1">#=> { message: "...", customer_id: 123, network_memory: ... }</span>
|
|
3214
|
+
</span><span id="__span-13-7"><a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="n">result</span><span class="o">.</span><span class="n">context</span><span class="o">[</span><span class="ss">:classifier</span><span class="o">]</span><span class="w"> </span><span class="c1">#=> RobotResult from classifier</span>
|
|
3215
|
+
</span><span id="__span-13-8"><a id="__codelineno-13-8" name="__codelineno-13-8" href="#__codelineno-13-8"></a><span class="n">result</span><span class="o">.</span><span class="n">context</span><span class="o">[</span><span class="ss">:billing</span><span class="o">]</span><span class="w"> </span><span class="c1">#=> RobotResult from billing robot</span>
|
|
3216
|
+
</span><span id="__span-13-9"><a id="__codelineno-13-9" name="__codelineno-13-9" href="#__codelineno-13-9"></a><span class="n">result</span><span class="o">.</span><span class="n">value</span><span class="w"> </span><span class="c1">#=> Final RobotResult</span>
|
|
3217
|
+
</span></code></pre></div>
|
|
3218
|
+
<h2 id="visualization">Visualization<a class="headerlink" href="#visualization" title="Permanent link">¶</a></h2>
|
|
3219
|
+
<p>Networks provide visualization methods via the underlying SimpleFlow pipeline:</p>
|
|
3220
|
+
<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="c1"># ASCII representation</span>
|
|
3221
|
+
</span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="nb">puts</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">visualize</span>
|
|
3222
|
+
</span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a>
|
|
3223
|
+
</span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a><span class="c1"># Mermaid diagram</span>
|
|
3224
|
+
</span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a><span class="nb">puts</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">to_mermaid</span>
|
|
3225
|
+
</span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a>
|
|
3226
|
+
</span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a><span class="c1"># DOT format (Graphviz)</span>
|
|
3227
|
+
</span><span id="__span-14-8"><a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a><span class="nb">puts</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">to_dot</span>
|
|
3228
|
+
</span><span id="__span-14-9"><a id="__codelineno-14-9" name="__codelineno-14-9" href="#__codelineno-14-9"></a>
|
|
3229
|
+
</span><span id="__span-14-10"><a id="__codelineno-14-10" name="__codelineno-14-10" href="#__codelineno-14-10"></a><span class="c1"># Execution plan description</span>
|
|
3230
|
+
</span><span id="__span-14-11"><a id="__codelineno-14-11" name="__codelineno-14-11" href="#__codelineno-14-11"></a><span class="nb">puts</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">execution_plan</span>
|
|
3231
|
+
</span></code></pre></div>
|
|
3232
|
+
<h2 id="network-inspection">Network Inspection<a class="headerlink" href="#network-inspection" title="Permanent link">¶</a></h2>
|
|
3233
|
+
<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="c1"># Get a robot by name</span>
|
|
3234
|
+
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="n">network</span><span class="o">.</span><span class="n">robot</span><span class="p">(</span><span class="ss">:classifier</span><span class="p">)</span><span class="w"> </span><span class="c1">#=> Robot</span>
|
|
3235
|
+
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="n">network</span><span class="o">[</span><span class="ss">:classifier</span><span class="o">]</span><span class="w"> </span><span class="c1">#=> Robot (alias)</span>
|
|
3236
|
+
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a>
|
|
3237
|
+
</span><span id="__span-15-5"><a id="__codelineno-15-5" name="__codelineno-15-5" href="#__codelineno-15-5"></a><span class="c1"># List all robots</span>
|
|
3238
|
+
</span><span id="__span-15-6"><a id="__codelineno-15-6" name="__codelineno-15-6" href="#__codelineno-15-6"></a><span class="n">network</span><span class="o">.</span><span class="n">available_robots</span><span class="w"> </span><span class="c1">#=> [Robot, Robot, ...]</span>
|
|
3239
|
+
</span><span id="__span-15-7"><a id="__codelineno-15-7" name="__codelineno-15-7" href="#__codelineno-15-7"></a>
|
|
3240
|
+
</span><span id="__span-15-8"><a id="__codelineno-15-8" name="__codelineno-15-8" href="#__codelineno-15-8"></a><span class="c1"># Add a robot without a task</span>
|
|
3241
|
+
</span><span id="__span-15-9"><a id="__codelineno-15-9" name="__codelineno-15-9" href="#__codelineno-15-9"></a><span class="n">network</span><span class="o">.</span><span class="n">add_robot</span><span class="p">(</span><span class="n">extra_robot</span><span class="p">)</span>
|
|
3242
|
+
</span><span id="__span-15-10"><a id="__codelineno-15-10" name="__codelineno-15-10" href="#__codelineno-15-10"></a>
|
|
3243
|
+
</span><span id="__span-15-11"><a id="__codelineno-15-11" name="__codelineno-15-11" href="#__codelineno-15-11"></a><span class="c1"># Convert to hash</span>
|
|
3244
|
+
</span><span id="__span-15-12"><a id="__codelineno-15-12" name="__codelineno-15-12" href="#__codelineno-15-12"></a><span class="n">network</span><span class="o">.</span><span class="n">to_h</span>
|
|
3245
|
+
</span><span id="__span-15-13"><a id="__codelineno-15-13" name="__codelineno-15-13" href="#__codelineno-15-13"></a><span class="c1">#=> { name: "support", robots: ["classifier", "billing"], tasks: [...], optional_tasks: [...] }</span>
|
|
3246
|
+
</span></code></pre></div>
|
|
3247
|
+
<h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">¶</a></h2>
|
|
3248
|
+
<ul>
|
|
3249
|
+
<li><a href="../state-management/">Memory Management</a> - Shared memory and reactive features</li>
|
|
3250
|
+
<li><a href="../message-flow/">Message Flow</a> - How messages are processed within robots</li>
|
|
3251
|
+
</ul>
|
|
3252
|
+
|
|
3253
|
+
|
|
3254
|
+
|
|
3255
|
+
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
|
|
3262
|
+
|
|
3263
|
+
|
|
3264
|
+
|
|
3265
|
+
<form class="md-feedback" name="feedback" hidden>
|
|
3266
|
+
<fieldset>
|
|
3267
|
+
<legend class="md-feedback__title">
|
|
3268
|
+
Was this page helpful?
|
|
3269
|
+
</legend>
|
|
3270
|
+
<div class="md-feedback__inner">
|
|
3271
|
+
<div class="md-feedback__list">
|
|
3272
|
+
|
|
3273
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
|
|
3274
|
+
<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>
|
|
3275
|
+
</button>
|
|
3276
|
+
|
|
3277
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
|
|
3278
|
+
<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>
|
|
3279
|
+
</button>
|
|
3280
|
+
|
|
3281
|
+
</div>
|
|
3282
|
+
<div class="md-feedback__note">
|
|
3283
|
+
|
|
3284
|
+
<div data-md-value="1" hidden>
|
|
3285
|
+
|
|
3286
|
+
|
|
3287
|
+
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
|
|
3291
|
+
|
|
3292
|
+
|
|
3293
|
+
|
|
3294
|
+
Thanks for your feedback!
|
|
3295
|
+
</div>
|
|
3296
|
+
|
|
3297
|
+
<div data-md-value="0" hidden>
|
|
3298
|
+
|
|
3299
|
+
|
|
3300
|
+
|
|
3301
|
+
|
|
3302
|
+
|
|
3303
|
+
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
|
|
3307
|
+
Thanks for your feedback! Help us improve by creating an issue.
|
|
3308
|
+
</div>
|
|
3309
|
+
|
|
3310
|
+
</div>
|
|
3311
|
+
</div>
|
|
3312
|
+
</fieldset>
|
|
3313
|
+
</form>
|
|
3314
|
+
|
|
3315
|
+
|
|
3316
|
+
|
|
3317
|
+
</article>
|
|
3318
|
+
</div>
|
|
3319
|
+
|
|
3320
|
+
|
|
3321
|
+
<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>
|
|
3322
|
+
|
|
3323
|
+
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
3324
|
+
</div>
|
|
3325
|
+
|
|
3326
|
+
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
3327
|
+
|
|
3328
|
+
<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>
|
|
3329
|
+
Back to top
|
|
3330
|
+
</button>
|
|
3331
|
+
|
|
3332
|
+
</main>
|
|
3333
|
+
|
|
3334
|
+
<footer class="md-footer">
|
|
3335
|
+
|
|
3336
|
+
|
|
3337
|
+
|
|
3338
|
+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
3339
|
+
|
|
3340
|
+
|
|
3341
|
+
<a href="../robot-execution/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Robot Execution">
|
|
3342
|
+
<div class="md-footer__button md-icon">
|
|
3343
|
+
|
|
3344
|
+
<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>
|
|
3345
|
+
</div>
|
|
3346
|
+
<div class="md-footer__title">
|
|
3347
|
+
<span class="md-footer__direction">
|
|
3348
|
+
Previous
|
|
3349
|
+
</span>
|
|
3350
|
+
<div class="md-ellipsis">
|
|
3351
|
+
Robot Execution
|
|
3352
|
+
</div>
|
|
3353
|
+
</div>
|
|
3354
|
+
</a>
|
|
3355
|
+
|
|
3356
|
+
|
|
3357
|
+
|
|
3358
|
+
<a href="../state-management/" class="md-footer__link md-footer__link--next" aria-label="Next: State Management">
|
|
3359
|
+
<div class="md-footer__title">
|
|
3360
|
+
<span class="md-footer__direction">
|
|
3361
|
+
Next
|
|
3362
|
+
</span>
|
|
3363
|
+
<div class="md-ellipsis">
|
|
3364
|
+
State Management
|
|
3365
|
+
</div>
|
|
3366
|
+
</div>
|
|
3367
|
+
<div class="md-footer__button md-icon">
|
|
3368
|
+
|
|
3369
|
+
<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>
|
|
3370
|
+
</div>
|
|
3371
|
+
</a>
|
|
3372
|
+
|
|
3373
|
+
</nav>
|
|
3374
|
+
|
|
3375
|
+
|
|
3376
|
+
<div class="md-footer-meta md-typeset">
|
|
3377
|
+
<div class="md-footer-meta__inner md-grid">
|
|
3378
|
+
<div class="md-copyright">
|
|
3379
|
+
|
|
3380
|
+
<div class="md-copyright__highlight">
|
|
3381
|
+
Copyright © 2025 Dewayne VanHoozer
|
|
3382
|
+
</div>
|
|
3383
|
+
|
|
3384
|
+
|
|
3385
|
+
Made with
|
|
3386
|
+
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
3387
|
+
Material for MkDocs
|
|
3388
|
+
</a>
|
|
3389
|
+
|
|
3390
|
+
</div>
|
|
3391
|
+
|
|
3392
|
+
|
|
3393
|
+
<div class="md-social">
|
|
3394
|
+
|
|
3395
|
+
|
|
3396
|
+
|
|
3397
|
+
|
|
3398
|
+
|
|
3399
|
+
<a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
|
|
3400
|
+
<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>
|
|
3401
|
+
</a>
|
|
3402
|
+
|
|
3403
|
+
|
|
3404
|
+
|
|
3405
|
+
|
|
3406
|
+
|
|
3407
|
+
<a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
|
|
3408
|
+
<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>
|
|
3409
|
+
</a>
|
|
3410
|
+
|
|
3411
|
+
</div>
|
|
3412
|
+
|
|
3413
|
+
</div>
|
|
3414
|
+
</div>
|
|
3415
|
+
</footer>
|
|
3416
|
+
|
|
3417
|
+
</div>
|
|
3418
|
+
<div class="md-dialog" data-md-component="dialog">
|
|
3419
|
+
<div class="md-dialog__inner md-typeset"></div>
|
|
3420
|
+
</div>
|
|
3421
|
+
|
|
3422
|
+
|
|
3423
|
+
|
|
3424
|
+
|
|
3425
|
+
|
|
3426
|
+
<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>
|
|
3427
|
+
|
|
3428
|
+
|
|
3429
|
+
<script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
3430
|
+
|
|
3431
|
+
|
|
3432
|
+
</body>
|
|
3433
|
+
</html>
|