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.
Files changed (242) hide show
  1. checksums.yaml +4 -4
  2. data/.architecture/AGENTS.md +32 -0
  3. data/.architecture/config.yml +8 -0
  4. data/.architecture/members.yml +60 -0
  5. data/.architecture/reviews/feature-free-will.md +490 -0
  6. data/.architecture/reviews/overall-codebase.md +427 -0
  7. data/.claude/settings.local.json +57 -0
  8. data/.codex/config.toml +2 -0
  9. data/.irbrc +2 -2
  10. data/.rubocop.yml +172 -0
  11. data/CHANGELOG.md +72 -0
  12. data/CLAUDE.md +139 -0
  13. data/README.md +91 -95
  14. data/Rakefile +109 -3
  15. data/agent2agent_review.md +192 -0
  16. data/agentf_improvements.md +253 -0
  17. data/agents.md +14 -0
  18. data/docs/examples/index.md +37 -2
  19. data/docs/getting-started/configuration.md +20 -7
  20. data/docs/guides/index.md +16 -16
  21. data/docs/guides/knowledge.md +7 -1
  22. data/docs/guides/observability.md +132 -0
  23. data/docs/index.md +30 -3
  24. data/docs/superpowers/plans/2026-05-06-agentskills.md +1303 -0
  25. data/docs/superpowers/specs/2026-05-06-agentskills-design.md +247 -0
  26. data/examples/.envrc +1 -0
  27. data/examples/01_simple_robot.rb +5 -9
  28. data/examples/02_tools.rb +5 -9
  29. data/examples/03_network.rb +8 -9
  30. data/examples/04_mcp.rb +21 -29
  31. data/examples/05_streaming.rb +12 -18
  32. data/examples/06_prompt_templates.rb +11 -19
  33. data/examples/07_network_memory.rb +16 -31
  34. data/examples/08_llm_config.rb +10 -22
  35. data/examples/09_chaining.rb +16 -27
  36. data/examples/10_memory.rb +12 -28
  37. data/examples/11_network_introspection.rb +15 -29
  38. data/examples/12_message_bus.rb +5 -12
  39. data/examples/13_spawn.rb +5 -10
  40. data/examples/14_rusty_circuit/.envrc +1 -0
  41. data/examples/14_rusty_circuit/comic.rb +2 -0
  42. data/examples/14_rusty_circuit/heckler.rb +1 -1
  43. data/examples/14_rusty_circuit/open_mic.rb +1 -3
  44. data/examples/14_rusty_circuit/scout.rb +2 -0
  45. data/examples/15_memory_network_and_bus/.envrc +1 -0
  46. data/examples/15_memory_network_and_bus/editorial_pipeline.rb +6 -3
  47. data/examples/15_memory_network_and_bus/linux_writer.rb +1 -1
  48. data/examples/15_memory_network_and_bus/output/combined_article.md +6 -6
  49. data/examples/15_memory_network_and_bus/output/final_article.md +6 -8
  50. data/examples/15_memory_network_and_bus/output/linux_draft.md +4 -2
  51. data/examples/15_memory_network_and_bus/output/mac_draft.md +3 -3
  52. data/examples/15_memory_network_and_bus/output/memory.json +6 -6
  53. data/examples/15_memory_network_and_bus/output/revision_1.md +10 -11
  54. data/examples/15_memory_network_and_bus/output/revision_2.md +6 -8
  55. data/examples/15_memory_network_and_bus/output/windows_draft.md +3 -3
  56. data/examples/16_writers_room/.envrc +1 -0
  57. data/examples/16_writers_room/writers_room.rb +2 -4
  58. data/examples/17_skills.rb +8 -17
  59. data/examples/18_rails/Gemfile +1 -0
  60. data/examples/19_token_tracking.rb +9 -15
  61. data/examples/20_circuit_breaker.rb +10 -19
  62. data/examples/21_learning_loop.rb +11 -20
  63. data/examples/22_context_compression.rb +6 -13
  64. data/examples/23_convergence.rb +6 -17
  65. data/examples/24_structured_delegation.rb +11 -15
  66. data/examples/25_history_search.rb +5 -12
  67. data/examples/26_document_store.rb +6 -13
  68. data/examples/27_incident_response/incident_response.rb +4 -5
  69. data/examples/28_mcp_discovery.rb +8 -11
  70. data/examples/29_ractor_tools.rb +4 -9
  71. data/examples/30_ractor_network.rb +10 -19
  72. data/examples/31_launch_assessment.rb +10 -23
  73. data/examples/32_newsletter_reader.rb +188 -0
  74. data/examples/33_stock_generator.rb +80 -0
  75. data/examples/33_stock_predictor.rb +306 -0
  76. data/examples/34_agentskills.rb +72 -0
  77. data/examples/README.md +1 -1
  78. data/examples/common.rb +76 -0
  79. data/examples/ruboruby.md +423 -0
  80. data/examples/temp.md +51 -0
  81. data/lib/robot_lab/agent_skill.rb +63 -0
  82. data/lib/robot_lab/agent_skill_catalog.rb +74 -0
  83. data/lib/robot_lab/ask_user.rb +2 -2
  84. data/lib/robot_lab/bus_poller.rb +12 -5
  85. data/lib/robot_lab/config.rb +1 -12
  86. data/lib/robot_lab/delegation_future.rb +1 -1
  87. data/lib/robot_lab/doom_loop_detector.rb +98 -0
  88. data/lib/robot_lab/history_compressor.rb +4 -10
  89. data/lib/robot_lab/mcp/client.rb +1 -2
  90. data/lib/robot_lab/mcp/connection_poller.rb +3 -3
  91. data/lib/robot_lab/mcp/server.rb +1 -1
  92. data/lib/robot_lab/mcp/server_discovery.rb +0 -2
  93. data/lib/robot_lab/memory.rb +32 -27
  94. data/lib/robot_lab/memory_change.rb +2 -2
  95. data/lib/robot_lab/message.rb +4 -4
  96. data/lib/robot_lab/network.rb +11 -6
  97. data/lib/robot_lab/robot/agent_skill_matching.rb +99 -0
  98. data/lib/robot_lab/robot/bus_messaging.rb +9 -27
  99. data/lib/robot_lab/robot/history_search.rb +4 -1
  100. data/lib/robot_lab/robot/mcp_management.rb +5 -11
  101. data/lib/robot_lab/robot/template_rendering.rb +60 -40
  102. data/lib/robot_lab/robot.rb +323 -206
  103. data/lib/robot_lab/robot_result.rb +6 -5
  104. data/lib/robot_lab/run_config.rb +5 -11
  105. data/lib/robot_lab/script_tool.rb +76 -0
  106. data/lib/robot_lab/state_proxy.rb +7 -5
  107. data/lib/robot_lab/tool.rb +3 -3
  108. data/lib/robot_lab/tool_config.rb +1 -1
  109. data/lib/robot_lab/tool_manifest.rb +5 -7
  110. data/lib/robot_lab/user_message.rb +2 -2
  111. data/lib/robot_lab/version.rb +1 -1
  112. data/lib/robot_lab/waiter.rb +1 -1
  113. data/lib/robot_lab.rb +41 -52
  114. data/logfile +8 -0
  115. data/mkdocs.yml +2 -3
  116. data/robot_concurrency.md +38 -0
  117. data/simple_acp_review.md +298 -0
  118. data/site/404.html +2300 -0
  119. data/site/api/core/index.html +2706 -0
  120. data/site/api/core/memory/index.html +3793 -0
  121. data/site/api/core/network/index.html +3500 -0
  122. data/site/api/core/robot/index.html +4566 -0
  123. data/site/api/core/state/index.html +3390 -0
  124. data/site/api/core/tool/index.html +3843 -0
  125. data/site/api/index.html +2635 -0
  126. data/site/api/mcp/client/index.html +3435 -0
  127. data/site/api/mcp/index.html +2783 -0
  128. data/site/api/mcp/server/index.html +3252 -0
  129. data/site/api/mcp/transports/index.html +3352 -0
  130. data/site/api/messages/index.html +2641 -0
  131. data/site/api/messages/text-message/index.html +3087 -0
  132. data/site/api/messages/tool-call-message/index.html +3159 -0
  133. data/site/api/messages/tool-result-message/index.html +3252 -0
  134. data/site/api/messages/user-message/index.html +3212 -0
  135. data/site/api/streaming/context/index.html +3282 -0
  136. data/site/api/streaming/events/index.html +3347 -0
  137. data/site/api/streaming/index.html +2738 -0
  138. data/site/architecture/core-concepts/index.html +3757 -0
  139. data/site/architecture/index.html +2797 -0
  140. data/site/architecture/message-flow/index.html +3238 -0
  141. data/site/architecture/network-orchestration/index.html +3433 -0
  142. data/site/architecture/robot-execution/index.html +3140 -0
  143. data/site/architecture/state-management/index.html +3498 -0
  144. data/site/assets/css/custom.css +56 -0
  145. data/site/assets/images/favicon.png +0 -0
  146. data/site/assets/images/robot_lab.jpg +0 -0
  147. data/site/assets/javascripts/bundle.79ae519e.min.js +16 -0
  148. data/site/assets/javascripts/bundle.79ae519e.min.js.map +7 -0
  149. data/site/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
  150. data/site/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
  151. data/site/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
  152. data/site/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
  153. data/site/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
  154. data/site/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
  155. data/site/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
  156. data/site/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
  157. data/site/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
  158. data/site/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
  159. data/site/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
  160. data/site/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
  161. data/site/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
  162. data/site/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
  163. data/site/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
  164. data/site/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
  165. data/site/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
  166. data/site/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
  167. data/site/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
  168. data/site/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
  169. data/site/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
  170. data/site/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
  171. data/site/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
  172. data/site/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
  173. data/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
  174. data/site/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
  175. data/site/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
  176. data/site/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
  177. data/site/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
  178. data/site/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
  179. data/site/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
  180. data/site/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
  181. data/site/assets/javascripts/lunr/tinyseg.js +206 -0
  182. data/site/assets/javascripts/lunr/wordcut.js +6708 -0
  183. data/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
  184. data/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
  185. data/site/assets/stylesheets/main.484c7ddc.min.css +1 -0
  186. data/site/assets/stylesheets/main.484c7ddc.min.css.map +1 -0
  187. data/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
  188. data/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
  189. data/site/concepts/index.html +3455 -0
  190. data/site/examples/basic-chat/index.html +2880 -0
  191. data/site/examples/index.html +2907 -0
  192. data/site/examples/mcp-server/index.html +3018 -0
  193. data/site/examples/multi-robot-network/index.html +3131 -0
  194. data/site/examples/rails-application/index.html +3329 -0
  195. data/site/examples/tool-usage/index.html +3085 -0
  196. data/site/getting-started/configuration/index.html +3745 -0
  197. data/site/getting-started/index.html +2572 -0
  198. data/site/getting-started/installation/index.html +2981 -0
  199. data/site/getting-started/quick-start/index.html +2942 -0
  200. data/site/guides/building-robots/index.html +4290 -0
  201. data/site/guides/creating-networks/index.html +3858 -0
  202. data/site/guides/index.html +2586 -0
  203. data/site/guides/mcp-integration/index.html +3581 -0
  204. data/site/guides/memory/index.html +3586 -0
  205. data/site/guides/rails-integration/index.html +4019 -0
  206. data/site/guides/streaming/index.html +3157 -0
  207. data/site/guides/using-tools/index.html +3802 -0
  208. data/site/index.html +2671 -0
  209. data/site/search/search_index.json +1 -0
  210. data/site/sitemap.xml +183 -0
  211. data/site/sitemap.xml.gz +0 -0
  212. data/site/tags.json +1 -0
  213. data/temp.md +6 -0
  214. data/tool_manifest_plan.md +155 -0
  215. metadata +154 -92
  216. data/docs/examples/rails-application.md +0 -419
  217. data/docs/guides/ractor-parallelism.md +0 -364
  218. data/docs/guides/rails-integration.md +0 -681
  219. data/docs/superpowers/plans/2026-04-14-ractor-integration.md +0 -1538
  220. data/docs/superpowers/specs/2026-04-14-ractor-integration-design.md +0 -258
  221. data/lib/generators/robot_lab/install_generator.rb +0 -90
  222. data/lib/generators/robot_lab/job_generator.rb +0 -40
  223. data/lib/generators/robot_lab/robot_generator.rb +0 -55
  224. data/lib/generators/robot_lab/templates/initializer.rb.tt +0 -42
  225. data/lib/generators/robot_lab/templates/job.rb.tt +0 -21
  226. data/lib/generators/robot_lab/templates/migration.rb.tt +0 -32
  227. data/lib/generators/robot_lab/templates/result_model.rb.tt +0 -52
  228. data/lib/generators/robot_lab/templates/robot.rb.tt +0 -31
  229. data/lib/generators/robot_lab/templates/robot_job.rb.tt +0 -18
  230. data/lib/generators/robot_lab/templates/robot_test.rb.tt +0 -34
  231. data/lib/generators/robot_lab/templates/routing_robot.rb.tt +0 -59
  232. data/lib/generators/robot_lab/templates/thread_model.rb.tt +0 -40
  233. data/lib/robot_lab/document_store.rb +0 -155
  234. data/lib/robot_lab/ractor_boundary.rb +0 -42
  235. data/lib/robot_lab/ractor_job.rb +0 -37
  236. data/lib/robot_lab/ractor_memory_proxy.rb +0 -85
  237. data/lib/robot_lab/ractor_network_scheduler.rb +0 -154
  238. data/lib/robot_lab/ractor_worker_pool.rb +0 -117
  239. data/lib/robot_lab/rails_integration/engine.rb +0 -29
  240. data/lib/robot_lab/rails_integration/job.rb +0 -158
  241. data/lib/robot_lab/rails_integration/railtie.rb +0 -51
  242. data/lib/robot_lab/rails_integration/turbo_stream_callbacks.rb +0 -72
@@ -0,0 +1,3157 @@
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/guides/streaming/">
16
+
17
+
18
+ <link rel="prev" href="../mcp-integration/">
19
+
20
+
21
+ <link rel="next" href="../memory/">
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>Streaming Responses - 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="#streaming-responses" 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
+ Streaming Responses
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
+ <li class="md-tabs__item">
281
+ <a href="../../architecture/" class="md-tabs__link">
282
+
283
+
284
+
285
+
286
+
287
+ Architecture
288
+
289
+ </a>
290
+ </li>
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+ <li class="md-tabs__item md-tabs__item--active">
305
+ <a href="../" 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
+ <li class="md-nav__item md-nav__item--nested">
709
+
710
+
711
+
712
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
713
+
714
+
715
+ <div class="md-nav__link md-nav__container">
716
+ <a href="../../architecture/" class="md-nav__link ">
717
+
718
+
719
+
720
+ <span class="md-ellipsis">
721
+
722
+
723
+ Architecture
724
+
725
+
726
+
727
+ </span>
728
+
729
+
730
+
731
+ </a>
732
+
733
+
734
+ <label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
735
+ <span class="md-nav__icon md-icon"></span>
736
+ </label>
737
+
738
+ </div>
739
+
740
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
741
+ <label class="md-nav__title" for="__nav_3">
742
+ <span class="md-nav__icon md-icon"></span>
743
+
744
+
745
+ Architecture
746
+
747
+
748
+ </label>
749
+ <ul class="md-nav__list" data-md-scrollfix>
750
+
751
+
752
+
753
+
754
+
755
+
756
+
757
+
758
+
759
+ <li class="md-nav__item">
760
+ <a href="../../architecture/core-concepts/" class="md-nav__link">
761
+
762
+
763
+
764
+ <span class="md-ellipsis">
765
+
766
+
767
+ Core Concepts
768
+
769
+
770
+
771
+ </span>
772
+
773
+
774
+
775
+ </a>
776
+ </li>
777
+
778
+
779
+
780
+
781
+
782
+
783
+
784
+
785
+
786
+
787
+ <li class="md-nav__item">
788
+ <a href="../../architecture/robot-execution/" class="md-nav__link">
789
+
790
+
791
+
792
+ <span class="md-ellipsis">
793
+
794
+
795
+ Robot Execution
796
+
797
+
798
+
799
+ </span>
800
+
801
+
802
+
803
+ </a>
804
+ </li>
805
+
806
+
807
+
808
+
809
+
810
+
811
+
812
+
813
+
814
+
815
+ <li class="md-nav__item">
816
+ <a href="../../architecture/network-orchestration/" class="md-nav__link">
817
+
818
+
819
+
820
+ <span class="md-ellipsis">
821
+
822
+
823
+ Network Orchestration
824
+
825
+
826
+
827
+ </span>
828
+
829
+
830
+
831
+ </a>
832
+ </li>
833
+
834
+
835
+
836
+
837
+
838
+
839
+
840
+
841
+
842
+
843
+ <li class="md-nav__item">
844
+ <a href="../../architecture/state-management/" class="md-nav__link">
845
+
846
+
847
+
848
+ <span class="md-ellipsis">
849
+
850
+
851
+ State Management
852
+
853
+
854
+
855
+ </span>
856
+
857
+
858
+
859
+ </a>
860
+ </li>
861
+
862
+
863
+
864
+
865
+
866
+
867
+
868
+
869
+
870
+
871
+ <li class="md-nav__item">
872
+ <a href="../../architecture/message-flow/" class="md-nav__link">
873
+
874
+
875
+
876
+ <span class="md-ellipsis">
877
+
878
+
879
+ Message Flow
880
+
881
+
882
+
883
+ </span>
884
+
885
+
886
+
887
+ </a>
888
+ </li>
889
+
890
+
891
+
892
+
893
+ </ul>
894
+ </nav>
895
+
896
+ </li>
897
+
898
+
899
+
900
+
901
+
902
+
903
+
904
+
905
+
906
+
907
+
908
+
909
+
910
+
911
+
912
+
913
+
914
+
915
+
916
+
917
+
918
+
919
+
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+
929
+
930
+
931
+
932
+
933
+
934
+
935
+
936
+
937
+
938
+
939
+ <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
940
+
941
+
942
+
943
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
944
+
945
+
946
+ <div class="md-nav__link md-nav__container">
947
+ <a href="../" class="md-nav__link ">
948
+
949
+
950
+
951
+ <span class="md-ellipsis">
952
+
953
+
954
+ Guides
955
+
956
+
957
+
958
+ </span>
959
+
960
+
961
+
962
+ </a>
963
+
964
+
965
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
966
+ <span class="md-nav__icon md-icon"></span>
967
+ </label>
968
+
969
+ </div>
970
+
971
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
972
+ <label class="md-nav__title" for="__nav_4">
973
+ <span class="md-nav__icon md-icon"></span>
974
+
975
+
976
+ Guides
977
+
978
+
979
+ </label>
980
+ <ul class="md-nav__list" data-md-scrollfix>
981
+
982
+
983
+
984
+
985
+
986
+
987
+
988
+
989
+
990
+ <li class="md-nav__item">
991
+ <a href="../building-robots/" class="md-nav__link">
992
+
993
+
994
+
995
+ <span class="md-ellipsis">
996
+
997
+
998
+ Building Robots
999
+
1000
+
1001
+
1002
+ </span>
1003
+
1004
+
1005
+
1006
+ </a>
1007
+ </li>
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+
1014
+
1015
+
1016
+
1017
+
1018
+ <li class="md-nav__item">
1019
+ <a href="../creating-networks/" class="md-nav__link">
1020
+
1021
+
1022
+
1023
+ <span class="md-ellipsis">
1024
+
1025
+
1026
+ Creating Networks
1027
+
1028
+
1029
+
1030
+ </span>
1031
+
1032
+
1033
+
1034
+ </a>
1035
+ </li>
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+
1042
+
1043
+
1044
+
1045
+
1046
+ <li class="md-nav__item">
1047
+ <a href="../using-tools/" class="md-nav__link">
1048
+
1049
+
1050
+
1051
+ <span class="md-ellipsis">
1052
+
1053
+
1054
+ Using Tools
1055
+
1056
+
1057
+
1058
+ </span>
1059
+
1060
+
1061
+
1062
+ </a>
1063
+ </li>
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+
1070
+
1071
+
1072
+
1073
+
1074
+ <li class="md-nav__item">
1075
+ <a href="../mcp-integration/" class="md-nav__link">
1076
+
1077
+
1078
+
1079
+ <span class="md-ellipsis">
1080
+
1081
+
1082
+ MCP Integration
1083
+
1084
+
1085
+
1086
+ </span>
1087
+
1088
+
1089
+
1090
+ </a>
1091
+ </li>
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+
1098
+
1099
+
1100
+
1101
+
1102
+
1103
+
1104
+ <li class="md-nav__item md-nav__item--active">
1105
+
1106
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+ <label class="md-nav__link md-nav__link--active" for="__toc">
1113
+
1114
+
1115
+
1116
+ <span class="md-ellipsis">
1117
+
1118
+
1119
+ Streaming Responses
1120
+
1121
+
1122
+
1123
+ </span>
1124
+
1125
+
1126
+
1127
+ <span class="md-nav__icon md-icon"></span>
1128
+ </label>
1129
+
1130
+ <a href="./" class="md-nav__link md-nav__link--active">
1131
+
1132
+
1133
+
1134
+ <span class="md-ellipsis">
1135
+
1136
+
1137
+ Streaming Responses
1138
+
1139
+
1140
+
1141
+ </span>
1142
+
1143
+
1144
+
1145
+ </a>
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
1152
+
1153
+
1154
+
1155
+
1156
+
1157
+
1158
+ <label class="md-nav__title" for="__toc">
1159
+ <span class="md-nav__icon md-icon"></span>
1160
+ On this page
1161
+ </label>
1162
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1163
+
1164
+ <li class="md-nav__item">
1165
+ <a href="#streaming-via-callbacks" class="md-nav__link">
1166
+ <span class="md-ellipsis">
1167
+
1168
+ Streaming via Callbacks
1169
+
1170
+ </span>
1171
+ </a>
1172
+
1173
+ </li>
1174
+
1175
+ <li class="md-nav__item">
1176
+ <a href="#available-callbacks" class="md-nav__link">
1177
+ <span class="md-ellipsis">
1178
+
1179
+ Available Callbacks
1180
+
1181
+ </span>
1182
+ </a>
1183
+
1184
+ <nav class="md-nav" aria-label="Available Callbacks">
1185
+ <ul class="md-nav__list">
1186
+
1187
+ <li class="md-nav__item">
1188
+ <a href="#on_new_message" class="md-nav__link">
1189
+ <span class="md-ellipsis">
1190
+
1191
+ on_new_message
1192
+
1193
+ </span>
1194
+ </a>
1195
+
1196
+ </li>
1197
+
1198
+ <li class="md-nav__item">
1199
+ <a href="#on_end_message" class="md-nav__link">
1200
+ <span class="md-ellipsis">
1201
+
1202
+ on_end_message
1203
+
1204
+ </span>
1205
+ </a>
1206
+
1207
+ </li>
1208
+
1209
+ <li class="md-nav__item">
1210
+ <a href="#on_tool_call" class="md-nav__link">
1211
+ <span class="md-ellipsis">
1212
+
1213
+ on_tool_call
1214
+
1215
+ </span>
1216
+ </a>
1217
+
1218
+ </li>
1219
+
1220
+ <li class="md-nav__item">
1221
+ <a href="#on_tool_result" class="md-nav__link">
1222
+ <span class="md-ellipsis">
1223
+
1224
+ on_tool_result
1225
+
1226
+ </span>
1227
+ </a>
1228
+
1229
+ </li>
1230
+
1231
+ </ul>
1232
+ </nav>
1233
+
1234
+ </li>
1235
+
1236
+ <li class="md-nav__item">
1237
+ <a href="#comprehensive-callback-setup" class="md-nav__link">
1238
+ <span class="md-ellipsis">
1239
+
1240
+ Comprehensive Callback Setup
1241
+
1242
+ </span>
1243
+ </a>
1244
+
1245
+ </li>
1246
+
1247
+ <li class="md-nav__item">
1248
+ <a href="#streaming-via-chat-block" class="md-nav__link">
1249
+ <span class="md-ellipsis">
1250
+
1251
+ Streaming via Chat Block
1252
+
1253
+ </span>
1254
+ </a>
1255
+
1256
+ </li>
1257
+
1258
+ <li class="md-nav__item">
1259
+ <a href="#web-integration" class="md-nav__link">
1260
+ <span class="md-ellipsis">
1261
+
1262
+ Web Integration
1263
+
1264
+ </span>
1265
+ </a>
1266
+
1267
+ <nav class="md-nav" aria-label="Web Integration">
1268
+ <ul class="md-nav__list">
1269
+
1270
+ <li class="md-nav__item">
1271
+ <a href="#rails-action-cable" class="md-nav__link">
1272
+ <span class="md-ellipsis">
1273
+
1274
+ Rails Action Cable
1275
+
1276
+ </span>
1277
+ </a>
1278
+
1279
+ </li>
1280
+
1281
+ <li class="md-nav__item">
1282
+ <a href="#server-sent-events" class="md-nav__link">
1283
+ <span class="md-ellipsis">
1284
+
1285
+ Server-Sent Events
1286
+
1287
+ </span>
1288
+ </a>
1289
+
1290
+ </li>
1291
+
1292
+ <li class="md-nav__item">
1293
+ <a href="#websocket" class="md-nav__link">
1294
+ <span class="md-ellipsis">
1295
+
1296
+ WebSocket
1297
+
1298
+ </span>
1299
+ </a>
1300
+
1301
+ </li>
1302
+
1303
+ </ul>
1304
+ </nav>
1305
+
1306
+ </li>
1307
+
1308
+ <li class="md-nav__item">
1309
+ <a href="#progress-tracking" class="md-nav__link">
1310
+ <span class="md-ellipsis">
1311
+
1312
+ Progress Tracking
1313
+
1314
+ </span>
1315
+ </a>
1316
+
1317
+ </li>
1318
+
1319
+ <li class="md-nav__item">
1320
+ <a href="#without-streaming" class="md-nav__link">
1321
+ <span class="md-ellipsis">
1322
+
1323
+ Without Streaming
1324
+
1325
+ </span>
1326
+ </a>
1327
+
1328
+ </li>
1329
+
1330
+ <li class="md-nav__item">
1331
+ <a href="#best-practices" class="md-nav__link">
1332
+ <span class="md-ellipsis">
1333
+
1334
+ Best Practices
1335
+
1336
+ </span>
1337
+ </a>
1338
+
1339
+ <nav class="md-nav" aria-label="Best Practices">
1340
+ <ul class="md-nav__list">
1341
+
1342
+ <li class="md-nav__item">
1343
+ <a href="#1-register-callbacks-before-run" class="md-nav__link">
1344
+ <span class="md-ellipsis">
1345
+
1346
+ 1. Register Callbacks Before Run
1347
+
1348
+ </span>
1349
+ </a>
1350
+
1351
+ </li>
1352
+
1353
+ <li class="md-nav__item">
1354
+ <a href="#2-handle-errors-in-callbacks" class="md-nav__link">
1355
+ <span class="md-ellipsis">
1356
+
1357
+ 2. Handle Errors in Callbacks
1358
+
1359
+ </span>
1360
+ </a>
1361
+
1362
+ </li>
1363
+
1364
+ <li class="md-nav__item">
1365
+ <a href="#3-clean-up-resources" class="md-nav__link">
1366
+ <span class="md-ellipsis">
1367
+
1368
+ 3. Clean Up Resources
1369
+
1370
+ </span>
1371
+ </a>
1372
+
1373
+ </li>
1374
+
1375
+ </ul>
1376
+ </nav>
1377
+
1378
+ </li>
1379
+
1380
+ <li class="md-nav__item">
1381
+ <a href="#next-steps" class="md-nav__link">
1382
+ <span class="md-ellipsis">
1383
+
1384
+ Next Steps
1385
+
1386
+ </span>
1387
+ </a>
1388
+
1389
+ </li>
1390
+
1391
+ </ul>
1392
+
1393
+ </nav>
1394
+
1395
+ </li>
1396
+
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+ <li class="md-nav__item">
1407
+ <a href="../memory/" class="md-nav__link">
1408
+
1409
+
1410
+
1411
+ <span class="md-ellipsis">
1412
+
1413
+
1414
+ Memory System
1415
+
1416
+
1417
+
1418
+ </span>
1419
+
1420
+
1421
+
1422
+ </a>
1423
+ </li>
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+
1433
+
1434
+ <li class="md-nav__item">
1435
+ <a href="../rails-integration/" class="md-nav__link">
1436
+
1437
+
1438
+
1439
+ <span class="md-ellipsis">
1440
+
1441
+
1442
+ Rails Integration
1443
+
1444
+
1445
+
1446
+ </span>
1447
+
1448
+
1449
+
1450
+ </a>
1451
+ </li>
1452
+
1453
+
1454
+
1455
+
1456
+ </ul>
1457
+ </nav>
1458
+
1459
+ </li>
1460
+
1461
+
1462
+
1463
+
1464
+
1465
+
1466
+
1467
+
1468
+
1469
+
1470
+
1471
+
1472
+
1473
+
1474
+
1475
+
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+ <li class="md-nav__item md-nav__item--nested">
1492
+
1493
+
1494
+
1495
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
1496
+
1497
+
1498
+ <div class="md-nav__link md-nav__container">
1499
+ <a href="../../api/" class="md-nav__link ">
1500
+
1501
+
1502
+
1503
+ <span class="md-ellipsis">
1504
+
1505
+
1506
+ API Reference
1507
+
1508
+
1509
+
1510
+ </span>
1511
+
1512
+
1513
+
1514
+ </a>
1515
+
1516
+
1517
+ <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
1518
+ <span class="md-nav__icon md-icon"></span>
1519
+ </label>
1520
+
1521
+ </div>
1522
+
1523
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
1524
+ <label class="md-nav__title" for="__nav_5">
1525
+ <span class="md-nav__icon md-icon"></span>
1526
+
1527
+
1528
+ API Reference
1529
+
1530
+
1531
+ </label>
1532
+ <ul class="md-nav__list" data-md-scrollfix>
1533
+
1534
+
1535
+
1536
+
1537
+
1538
+
1539
+
1540
+
1541
+
1542
+
1543
+
1544
+
1545
+
1546
+
1547
+
1548
+
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+
1565
+
1566
+ <li class="md-nav__item md-nav__item--nested">
1567
+
1568
+
1569
+
1570
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1571
+
1572
+
1573
+ <div class="md-nav__link md-nav__container">
1574
+ <a href="../../api/core/" class="md-nav__link ">
1575
+
1576
+
1577
+
1578
+ <span class="md-ellipsis">
1579
+
1580
+
1581
+ Core Classes
1582
+
1583
+
1584
+
1585
+ </span>
1586
+
1587
+
1588
+
1589
+ </a>
1590
+
1591
+
1592
+ <label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1593
+ <span class="md-nav__icon md-icon"></span>
1594
+ </label>
1595
+
1596
+ </div>
1597
+
1598
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1599
+ <label class="md-nav__title" for="__nav_5_2">
1600
+ <span class="md-nav__icon md-icon"></span>
1601
+
1602
+
1603
+ Core Classes
1604
+
1605
+
1606
+ </label>
1607
+ <ul class="md-nav__list" data-md-scrollfix>
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+
1617
+ <li class="md-nav__item">
1618
+ <a href="../../api/core/robot/" class="md-nav__link">
1619
+
1620
+
1621
+
1622
+ <span class="md-ellipsis">
1623
+
1624
+
1625
+ Robot
1626
+
1627
+
1628
+
1629
+ </span>
1630
+
1631
+
1632
+
1633
+ </a>
1634
+ </li>
1635
+
1636
+
1637
+
1638
+
1639
+
1640
+
1641
+
1642
+
1643
+
1644
+
1645
+ <li class="md-nav__item">
1646
+ <a href="../../api/core/network/" class="md-nav__link">
1647
+
1648
+
1649
+
1650
+ <span class="md-ellipsis">
1651
+
1652
+
1653
+ Network
1654
+
1655
+
1656
+
1657
+ </span>
1658
+
1659
+
1660
+
1661
+ </a>
1662
+ </li>
1663
+
1664
+
1665
+
1666
+
1667
+
1668
+
1669
+
1670
+
1671
+
1672
+
1673
+ <li class="md-nav__item">
1674
+ <a href="../../api/core/state/" class="md-nav__link">
1675
+
1676
+
1677
+
1678
+ <span class="md-ellipsis">
1679
+
1680
+
1681
+ State
1682
+
1683
+
1684
+
1685
+ </span>
1686
+
1687
+
1688
+
1689
+ </a>
1690
+ </li>
1691
+
1692
+
1693
+
1694
+
1695
+
1696
+
1697
+
1698
+
1699
+
1700
+
1701
+ <li class="md-nav__item">
1702
+ <a href="../../api/core/tool/" class="md-nav__link">
1703
+
1704
+
1705
+
1706
+ <span class="md-ellipsis">
1707
+
1708
+
1709
+ Tool
1710
+
1711
+
1712
+
1713
+ </span>
1714
+
1715
+
1716
+
1717
+ </a>
1718
+ </li>
1719
+
1720
+
1721
+
1722
+
1723
+
1724
+
1725
+
1726
+
1727
+
1728
+
1729
+ <li class="md-nav__item">
1730
+ <a href="../../api/core/memory/" class="md-nav__link">
1731
+
1732
+
1733
+
1734
+ <span class="md-ellipsis">
1735
+
1736
+
1737
+ Memory
1738
+
1739
+
1740
+
1741
+ </span>
1742
+
1743
+
1744
+
1745
+ </a>
1746
+ </li>
1747
+
1748
+
1749
+
1750
+
1751
+ </ul>
1752
+ </nav>
1753
+
1754
+ </li>
1755
+
1756
+
1757
+
1758
+
1759
+
1760
+
1761
+
1762
+
1763
+
1764
+
1765
+
1766
+
1767
+
1768
+
1769
+
1770
+
1771
+
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+
1785
+
1786
+
1787
+ <li class="md-nav__item md-nav__item--nested">
1788
+
1789
+
1790
+
1791
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
1792
+
1793
+
1794
+ <div class="md-nav__link md-nav__container">
1795
+ <a href="../../api/messages/" class="md-nav__link ">
1796
+
1797
+
1798
+
1799
+ <span class="md-ellipsis">
1800
+
1801
+
1802
+ Messages
1803
+
1804
+
1805
+
1806
+ </span>
1807
+
1808
+
1809
+
1810
+ </a>
1811
+
1812
+
1813
+ <label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
1814
+ <span class="md-nav__icon md-icon"></span>
1815
+ </label>
1816
+
1817
+ </div>
1818
+
1819
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
1820
+ <label class="md-nav__title" for="__nav_5_3">
1821
+ <span class="md-nav__icon md-icon"></span>
1822
+
1823
+
1824
+ Messages
1825
+
1826
+
1827
+ </label>
1828
+ <ul class="md-nav__list" data-md-scrollfix>
1829
+
1830
+
1831
+
1832
+
1833
+
1834
+
1835
+
1836
+
1837
+
1838
+ <li class="md-nav__item">
1839
+ <a href="../../api/messages/user-message/" class="md-nav__link">
1840
+
1841
+
1842
+
1843
+ <span class="md-ellipsis">
1844
+
1845
+
1846
+ UserMessage
1847
+
1848
+
1849
+
1850
+ </span>
1851
+
1852
+
1853
+
1854
+ </a>
1855
+ </li>
1856
+
1857
+
1858
+
1859
+
1860
+
1861
+
1862
+
1863
+
1864
+
1865
+
1866
+ <li class="md-nav__item">
1867
+ <a href="../../api/messages/text-message/" class="md-nav__link">
1868
+
1869
+
1870
+
1871
+ <span class="md-ellipsis">
1872
+
1873
+
1874
+ TextMessage
1875
+
1876
+
1877
+
1878
+ </span>
1879
+
1880
+
1881
+
1882
+ </a>
1883
+ </li>
1884
+
1885
+
1886
+
1887
+
1888
+
1889
+
1890
+
1891
+
1892
+
1893
+
1894
+ <li class="md-nav__item">
1895
+ <a href="../../api/messages/tool-call-message/" class="md-nav__link">
1896
+
1897
+
1898
+
1899
+ <span class="md-ellipsis">
1900
+
1901
+
1902
+ ToolCallMessage
1903
+
1904
+
1905
+
1906
+ </span>
1907
+
1908
+
1909
+
1910
+ </a>
1911
+ </li>
1912
+
1913
+
1914
+
1915
+
1916
+
1917
+
1918
+
1919
+
1920
+
1921
+
1922
+ <li class="md-nav__item">
1923
+ <a href="../../api/messages/tool-result-message/" class="md-nav__link">
1924
+
1925
+
1926
+
1927
+ <span class="md-ellipsis">
1928
+
1929
+
1930
+ ToolResultMessage
1931
+
1932
+
1933
+
1934
+ </span>
1935
+
1936
+
1937
+
1938
+ </a>
1939
+ </li>
1940
+
1941
+
1942
+
1943
+
1944
+ </ul>
1945
+ </nav>
1946
+
1947
+ </li>
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+
1959
+
1960
+
1961
+
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+
1970
+
1971
+
1972
+
1973
+
1974
+
1975
+
1976
+
1977
+
1978
+ <li class="md-nav__item md-nav__item--nested">
1979
+
1980
+
1981
+
1982
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
1983
+
1984
+
1985
+ <div class="md-nav__link md-nav__container">
1986
+ <a href="../../api/mcp/" class="md-nav__link ">
1987
+
1988
+
1989
+
1990
+ <span class="md-ellipsis">
1991
+
1992
+
1993
+ MCP
1994
+
1995
+
1996
+
1997
+ </span>
1998
+
1999
+
2000
+
2001
+ </a>
2002
+
2003
+
2004
+ <label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
2005
+ <span class="md-nav__icon md-icon"></span>
2006
+ </label>
2007
+
2008
+ </div>
2009
+
2010
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
2011
+ <label class="md-nav__title" for="__nav_5_4">
2012
+ <span class="md-nav__icon md-icon"></span>
2013
+
2014
+
2015
+ MCP
2016
+
2017
+
2018
+ </label>
2019
+ <ul class="md-nav__list" data-md-scrollfix>
2020
+
2021
+
2022
+
2023
+
2024
+
2025
+
2026
+
2027
+
2028
+
2029
+ <li class="md-nav__item">
2030
+ <a href="../../api/mcp/client/" class="md-nav__link">
2031
+
2032
+
2033
+
2034
+ <span class="md-ellipsis">
2035
+
2036
+
2037
+ Client
2038
+
2039
+
2040
+
2041
+ </span>
2042
+
2043
+
2044
+
2045
+ </a>
2046
+ </li>
2047
+
2048
+
2049
+
2050
+
2051
+
2052
+
2053
+
2054
+
2055
+
2056
+
2057
+ <li class="md-nav__item">
2058
+ <a href="../../api/mcp/server/" class="md-nav__link">
2059
+
2060
+
2061
+
2062
+ <span class="md-ellipsis">
2063
+
2064
+
2065
+ Server
2066
+
2067
+
2068
+
2069
+ </span>
2070
+
2071
+
2072
+
2073
+ </a>
2074
+ </li>
2075
+
2076
+
2077
+
2078
+
2079
+
2080
+
2081
+
2082
+
2083
+
2084
+
2085
+ <li class="md-nav__item">
2086
+ <a href="../../api/mcp/transports/" class="md-nav__link">
2087
+
2088
+
2089
+
2090
+ <span class="md-ellipsis">
2091
+
2092
+
2093
+ Transports
2094
+
2095
+
2096
+
2097
+ </span>
2098
+
2099
+
2100
+
2101
+ </a>
2102
+ </li>
2103
+
2104
+
2105
+
2106
+
2107
+ </ul>
2108
+ </nav>
2109
+
2110
+ </li>
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+
2131
+
2132
+
2133
+
2134
+
2135
+
2136
+
2137
+
2138
+
2139
+ <li class="md-nav__item md-nav__item--nested">
2140
+
2141
+
2142
+
2143
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
2144
+
2145
+
2146
+ <div class="md-nav__link md-nav__container">
2147
+ <a href="../../api/streaming/" class="md-nav__link ">
2148
+
2149
+
2150
+
2151
+ <span class="md-ellipsis">
2152
+
2153
+
2154
+ Streaming
2155
+
2156
+
2157
+
2158
+ </span>
2159
+
2160
+
2161
+
2162
+ </a>
2163
+
2164
+
2165
+ <label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
2166
+ <span class="md-nav__icon md-icon"></span>
2167
+ </label>
2168
+
2169
+ </div>
2170
+
2171
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
2172
+ <label class="md-nav__title" for="__nav_5_5">
2173
+ <span class="md-nav__icon md-icon"></span>
2174
+
2175
+
2176
+ Streaming
2177
+
2178
+
2179
+ </label>
2180
+ <ul class="md-nav__list" data-md-scrollfix>
2181
+
2182
+
2183
+
2184
+
2185
+
2186
+
2187
+
2188
+
2189
+
2190
+ <li class="md-nav__item">
2191
+ <a href="../../api/streaming/context/" class="md-nav__link">
2192
+
2193
+
2194
+
2195
+ <span class="md-ellipsis">
2196
+
2197
+
2198
+ Context
2199
+
2200
+
2201
+
2202
+ </span>
2203
+
2204
+
2205
+
2206
+ </a>
2207
+ </li>
2208
+
2209
+
2210
+
2211
+
2212
+
2213
+
2214
+
2215
+
2216
+
2217
+
2218
+ <li class="md-nav__item">
2219
+ <a href="../../api/streaming/events/" class="md-nav__link">
2220
+
2221
+
2222
+
2223
+ <span class="md-ellipsis">
2224
+
2225
+
2226
+ Events
2227
+
2228
+
2229
+
2230
+ </span>
2231
+
2232
+
2233
+
2234
+ </a>
2235
+ </li>
2236
+
2237
+
2238
+
2239
+
2240
+ </ul>
2241
+ </nav>
2242
+
2243
+ </li>
2244
+
2245
+
2246
+
2247
+
2248
+ </ul>
2249
+ </nav>
2250
+
2251
+ </li>
2252
+
2253
+
2254
+
2255
+
2256
+
2257
+
2258
+
2259
+
2260
+
2261
+
2262
+
2263
+
2264
+
2265
+
2266
+
2267
+
2268
+
2269
+
2270
+
2271
+
2272
+
2273
+
2274
+
2275
+
2276
+
2277
+
2278
+
2279
+
2280
+
2281
+
2282
+
2283
+
2284
+
2285
+ <li class="md-nav__item md-nav__item--nested">
2286
+
2287
+
2288
+
2289
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2290
+
2291
+
2292
+ <div class="md-nav__link md-nav__container">
2293
+ <a href="../../examples/" class="md-nav__link ">
2294
+
2295
+
2296
+
2297
+ <span class="md-ellipsis">
2298
+
2299
+
2300
+ Examples
2301
+
2302
+
2303
+
2304
+ </span>
2305
+
2306
+
2307
+
2308
+ </a>
2309
+
2310
+
2311
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
2312
+ <span class="md-nav__icon md-icon"></span>
2313
+ </label>
2314
+
2315
+ </div>
2316
+
2317
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2318
+ <label class="md-nav__title" for="__nav_6">
2319
+ <span class="md-nav__icon md-icon"></span>
2320
+
2321
+
2322
+ Examples
2323
+
2324
+
2325
+ </label>
2326
+ <ul class="md-nav__list" data-md-scrollfix>
2327
+
2328
+
2329
+
2330
+
2331
+
2332
+
2333
+
2334
+
2335
+
2336
+ <li class="md-nav__item">
2337
+ <a href="../../examples/basic-chat/" class="md-nav__link">
2338
+
2339
+
2340
+
2341
+ <span class="md-ellipsis">
2342
+
2343
+
2344
+ Basic Chat
2345
+
2346
+
2347
+
2348
+ </span>
2349
+
2350
+
2351
+
2352
+ </a>
2353
+ </li>
2354
+
2355
+
2356
+
2357
+
2358
+
2359
+
2360
+
2361
+
2362
+
2363
+
2364
+ <li class="md-nav__item">
2365
+ <a href="../../examples/multi-robot-network/" class="md-nav__link">
2366
+
2367
+
2368
+
2369
+ <span class="md-ellipsis">
2370
+
2371
+
2372
+ Multi-Robot Network
2373
+
2374
+
2375
+
2376
+ </span>
2377
+
2378
+
2379
+
2380
+ </a>
2381
+ </li>
2382
+
2383
+
2384
+
2385
+
2386
+
2387
+
2388
+
2389
+
2390
+
2391
+
2392
+ <li class="md-nav__item">
2393
+ <a href="../../examples/tool-usage/" class="md-nav__link">
2394
+
2395
+
2396
+
2397
+ <span class="md-ellipsis">
2398
+
2399
+
2400
+ Tool Usage
2401
+
2402
+
2403
+
2404
+ </span>
2405
+
2406
+
2407
+
2408
+ </a>
2409
+ </li>
2410
+
2411
+
2412
+
2413
+
2414
+
2415
+
2416
+
2417
+
2418
+
2419
+
2420
+ <li class="md-nav__item">
2421
+ <a href="../../examples/mcp-server/" class="md-nav__link">
2422
+
2423
+
2424
+
2425
+ <span class="md-ellipsis">
2426
+
2427
+
2428
+ MCP Server
2429
+
2430
+
2431
+
2432
+ </span>
2433
+
2434
+
2435
+
2436
+ </a>
2437
+ </li>
2438
+
2439
+
2440
+
2441
+
2442
+
2443
+
2444
+
2445
+
2446
+
2447
+
2448
+ <li class="md-nav__item">
2449
+ <a href="../../examples/rails-application/" class="md-nav__link">
2450
+
2451
+
2452
+
2453
+ <span class="md-ellipsis">
2454
+
2455
+
2456
+ Rails Application
2457
+
2458
+
2459
+
2460
+ </span>
2461
+
2462
+
2463
+
2464
+ </a>
2465
+ </li>
2466
+
2467
+
2468
+
2469
+
2470
+ </ul>
2471
+ </nav>
2472
+
2473
+ </li>
2474
+
2475
+
2476
+
2477
+ </ul>
2478
+ </nav>
2479
+ </div>
2480
+ </div>
2481
+ </div>
2482
+
2483
+
2484
+
2485
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2486
+ <div class="md-sidebar__scrollwrap">
2487
+ <div class="md-sidebar__inner">
2488
+
2489
+
2490
+
2491
+
2492
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
2493
+
2494
+
2495
+
2496
+
2497
+
2498
+
2499
+ <label class="md-nav__title" for="__toc">
2500
+ <span class="md-nav__icon md-icon"></span>
2501
+ On this page
2502
+ </label>
2503
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2504
+
2505
+ <li class="md-nav__item">
2506
+ <a href="#streaming-via-callbacks" class="md-nav__link">
2507
+ <span class="md-ellipsis">
2508
+
2509
+ Streaming via Callbacks
2510
+
2511
+ </span>
2512
+ </a>
2513
+
2514
+ </li>
2515
+
2516
+ <li class="md-nav__item">
2517
+ <a href="#available-callbacks" class="md-nav__link">
2518
+ <span class="md-ellipsis">
2519
+
2520
+ Available Callbacks
2521
+
2522
+ </span>
2523
+ </a>
2524
+
2525
+ <nav class="md-nav" aria-label="Available Callbacks">
2526
+ <ul class="md-nav__list">
2527
+
2528
+ <li class="md-nav__item">
2529
+ <a href="#on_new_message" class="md-nav__link">
2530
+ <span class="md-ellipsis">
2531
+
2532
+ on_new_message
2533
+
2534
+ </span>
2535
+ </a>
2536
+
2537
+ </li>
2538
+
2539
+ <li class="md-nav__item">
2540
+ <a href="#on_end_message" class="md-nav__link">
2541
+ <span class="md-ellipsis">
2542
+
2543
+ on_end_message
2544
+
2545
+ </span>
2546
+ </a>
2547
+
2548
+ </li>
2549
+
2550
+ <li class="md-nav__item">
2551
+ <a href="#on_tool_call" class="md-nav__link">
2552
+ <span class="md-ellipsis">
2553
+
2554
+ on_tool_call
2555
+
2556
+ </span>
2557
+ </a>
2558
+
2559
+ </li>
2560
+
2561
+ <li class="md-nav__item">
2562
+ <a href="#on_tool_result" class="md-nav__link">
2563
+ <span class="md-ellipsis">
2564
+
2565
+ on_tool_result
2566
+
2567
+ </span>
2568
+ </a>
2569
+
2570
+ </li>
2571
+
2572
+ </ul>
2573
+ </nav>
2574
+
2575
+ </li>
2576
+
2577
+ <li class="md-nav__item">
2578
+ <a href="#comprehensive-callback-setup" class="md-nav__link">
2579
+ <span class="md-ellipsis">
2580
+
2581
+ Comprehensive Callback Setup
2582
+
2583
+ </span>
2584
+ </a>
2585
+
2586
+ </li>
2587
+
2588
+ <li class="md-nav__item">
2589
+ <a href="#streaming-via-chat-block" class="md-nav__link">
2590
+ <span class="md-ellipsis">
2591
+
2592
+ Streaming via Chat Block
2593
+
2594
+ </span>
2595
+ </a>
2596
+
2597
+ </li>
2598
+
2599
+ <li class="md-nav__item">
2600
+ <a href="#web-integration" class="md-nav__link">
2601
+ <span class="md-ellipsis">
2602
+
2603
+ Web Integration
2604
+
2605
+ </span>
2606
+ </a>
2607
+
2608
+ <nav class="md-nav" aria-label="Web Integration">
2609
+ <ul class="md-nav__list">
2610
+
2611
+ <li class="md-nav__item">
2612
+ <a href="#rails-action-cable" class="md-nav__link">
2613
+ <span class="md-ellipsis">
2614
+
2615
+ Rails Action Cable
2616
+
2617
+ </span>
2618
+ </a>
2619
+
2620
+ </li>
2621
+
2622
+ <li class="md-nav__item">
2623
+ <a href="#server-sent-events" class="md-nav__link">
2624
+ <span class="md-ellipsis">
2625
+
2626
+ Server-Sent Events
2627
+
2628
+ </span>
2629
+ </a>
2630
+
2631
+ </li>
2632
+
2633
+ <li class="md-nav__item">
2634
+ <a href="#websocket" class="md-nav__link">
2635
+ <span class="md-ellipsis">
2636
+
2637
+ WebSocket
2638
+
2639
+ </span>
2640
+ </a>
2641
+
2642
+ </li>
2643
+
2644
+ </ul>
2645
+ </nav>
2646
+
2647
+ </li>
2648
+
2649
+ <li class="md-nav__item">
2650
+ <a href="#progress-tracking" class="md-nav__link">
2651
+ <span class="md-ellipsis">
2652
+
2653
+ Progress Tracking
2654
+
2655
+ </span>
2656
+ </a>
2657
+
2658
+ </li>
2659
+
2660
+ <li class="md-nav__item">
2661
+ <a href="#without-streaming" class="md-nav__link">
2662
+ <span class="md-ellipsis">
2663
+
2664
+ Without Streaming
2665
+
2666
+ </span>
2667
+ </a>
2668
+
2669
+ </li>
2670
+
2671
+ <li class="md-nav__item">
2672
+ <a href="#best-practices" class="md-nav__link">
2673
+ <span class="md-ellipsis">
2674
+
2675
+ Best Practices
2676
+
2677
+ </span>
2678
+ </a>
2679
+
2680
+ <nav class="md-nav" aria-label="Best Practices">
2681
+ <ul class="md-nav__list">
2682
+
2683
+ <li class="md-nav__item">
2684
+ <a href="#1-register-callbacks-before-run" class="md-nav__link">
2685
+ <span class="md-ellipsis">
2686
+
2687
+ 1. Register Callbacks Before Run
2688
+
2689
+ </span>
2690
+ </a>
2691
+
2692
+ </li>
2693
+
2694
+ <li class="md-nav__item">
2695
+ <a href="#2-handle-errors-in-callbacks" class="md-nav__link">
2696
+ <span class="md-ellipsis">
2697
+
2698
+ 2. Handle Errors in Callbacks
2699
+
2700
+ </span>
2701
+ </a>
2702
+
2703
+ </li>
2704
+
2705
+ <li class="md-nav__item">
2706
+ <a href="#3-clean-up-resources" class="md-nav__link">
2707
+ <span class="md-ellipsis">
2708
+
2709
+ 3. Clean Up Resources
2710
+
2711
+ </span>
2712
+ </a>
2713
+
2714
+ </li>
2715
+
2716
+ </ul>
2717
+ </nav>
2718
+
2719
+ </li>
2720
+
2721
+ <li class="md-nav__item">
2722
+ <a href="#next-steps" class="md-nav__link">
2723
+ <span class="md-ellipsis">
2724
+
2725
+ Next Steps
2726
+
2727
+ </span>
2728
+ </a>
2729
+
2730
+ </li>
2731
+
2732
+ </ul>
2733
+
2734
+ </nav>
2735
+ </div>
2736
+ </div>
2737
+ </div>
2738
+
2739
+
2740
+
2741
+ <div class="md-content" data-md-component="content">
2742
+
2743
+
2744
+
2745
+
2746
+
2747
+
2748
+
2749
+ <article class="md-content__inner md-typeset">
2750
+
2751
+
2752
+
2753
+
2754
+
2755
+ <a href="https://github.com/madbomber/robot_lab/edit/main/docs/guides/streaming.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
2756
+
2757
+ <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>
2758
+ </a>
2759
+
2760
+
2761
+
2762
+
2763
+
2764
+ <a href="https://github.com/madbomber/robot_lab/raw/main/docs/guides/streaming.md" title="View source of this page" class="md-content__button md-icon">
2765
+
2766
+ <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>
2767
+ </a>
2768
+
2769
+
2770
+
2771
+ <h1 id="streaming-responses">Streaming Responses<a class="headerlink" href="#streaming-responses" title="Permanent link">&para;</a></h1>
2772
+ <p>Stream LLM responses in real-time for better user experience.</p>
2773
+ <h2 id="streaming-via-callbacks">Streaming via Callbacks<a class="headerlink" href="#streaming-via-callbacks" title="Permanent link">&para;</a></h2>
2774
+ <p>RobotLab robots support streaming through callback methods inherited from RubyLLM::Agent. Register callbacks before calling <code>run</code>:</p>
2775
+ <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">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
2776
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;storyteller&quot;</span><span class="p">,</span>
2777
+ </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="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You are a creative storyteller.&quot;</span>
2778
+ </span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="p">)</span>
2779
+ </span><span id="__span-0-5"><a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a>
2780
+ </span><span id="__span-0-6"><a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="c1"># Register streaming callback</span>
2781
+ </span><span id="__span-0-7"><a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2782
+ </span><span id="__span-0-8"><a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="w"> </span><span class="nb">print</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2783
+ </span><span id="__span-0-9"><a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="k">end</span>
2784
+ </span><span id="__span-0-10"><a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a>
2785
+ </span><span id="__span-0-11"><a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Tell me a story about a brave robot&quot;</span><span class="p">)</span>
2786
+ </span></code></pre></div>
2787
+ <h2 id="available-callbacks">Available Callbacks<a class="headerlink" href="#available-callbacks" title="Permanent link">&para;</a></h2>
2788
+ <h3 id="on_new_message">on_new_message<a class="headerlink" href="#on_new_message" title="Permanent link">&para;</a></h3>
2789
+ <p>Called when the assistant starts generating a new message, with streaming chunks:</p>
2790
+ <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">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2791
+ </span><span id="__span-1-2"><a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w"> </span><span class="nb">print</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2792
+ </span><span id="__span-1-3"><a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="k">end</span>
2793
+ </span></code></pre></div>
2794
+ <h3 id="on_end_message">on_end_message<a class="headerlink" href="#on_end_message" title="Permanent link">&para;</a></h3>
2795
+ <p>Called when the assistant finishes a message:</p>
2796
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_end_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2797
+ </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="nb">puts</span><span class="w"> </span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">--- Response complete ---&quot;</span>
2798
+ </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="nb">puts</span><span class="w"> </span><span class="s2">&quot;Content length: </span><span class="si">#{</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="o">&amp;.</span><span class="n">length</span><span class="si">}</span><span class="s2">&quot;</span>
2799
+ </span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="k">end</span>
2800
+ </span></code></pre></div>
2801
+ <h3 id="on_tool_call">on_tool_call<a class="headerlink" href="#on_tool_call" title="Permanent link">&para;</a></h3>
2802
+ <p>Called when the LLM invokes a tool:</p>
2803
+ <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="n">robot</span><span class="o">.</span><span class="n">on_tool_call</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">tool_call</span><span class="o">|</span>
2804
+ </span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;Calling tool: </span><span class="si">#{</span><span class="n">tool_call</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span>
2805
+ </span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a><span class="k">end</span>
2806
+ </span></code></pre></div>
2807
+ <h3 id="on_tool_result">on_tool_result<a class="headerlink" href="#on_tool_result" title="Permanent link">&para;</a></h3>
2808
+ <p>Called when a tool returns its result:</p>
2809
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-4-1"><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_tool_result</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">tool_call</span><span class="p">,</span><span class="w"> </span><span class="n">result</span><span class="o">|</span>
2810
+ </span><span id="__span-4-2"><a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;Tool </span><span class="si">#{</span><span class="n">tool_call</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2"> returned: </span><span class="si">#{</span><span class="n">result</span><span class="si">}</span><span class="s2">&quot;</span>
2811
+ </span><span id="__span-4-3"><a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="k">end</span>
2812
+ </span></code></pre></div>
2813
+ <h2 id="comprehensive-callback-setup">Comprehensive Callback Setup<a class="headerlink" href="#comprehensive-callback-setup" title="Permanent link">&para;</a></h2>
2814
+ <p>Register all callbacks for full visibility:</p>
2815
+ <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">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
2816
+ </span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;assistant&quot;</span><span class="p">,</span>
2817
+ </span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You are helpful.&quot;</span><span class="p">,</span>
2818
+ </span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span><span class="ss">local_tools</span><span class="p">:</span><span class="w"> </span><span class="o">[</span><span class="no">WeatherTool</span><span class="o">]</span>
2819
+ </span><span id="__span-5-5"><a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="p">)</span>
2820
+ </span><span id="__span-5-6"><a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
2821
+ </span><span id="__span-5-7"><a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2822
+ </span><span id="__span-5-8"><a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a><span class="w"> </span><span class="nb">print</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2823
+ </span><span id="__span-5-9"><a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a><span class="k">end</span>
2824
+ </span><span id="__span-5-10"><a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a>
2825
+ </span><span id="__span-5-11"><a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_end_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">_message</span><span class="o">|</span>
2826
+ </span><span id="__span-5-12"><a id="__codelineno-5-12" name="__codelineno-5-12" href="#__codelineno-5-12"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">--- Done ---&quot;</span>
2827
+ </span><span id="__span-5-13"><a id="__codelineno-5-13" name="__codelineno-5-13" href="#__codelineno-5-13"></a><span class="k">end</span>
2828
+ </span><span id="__span-5-14"><a id="__codelineno-5-14" name="__codelineno-5-14" href="#__codelineno-5-14"></a>
2829
+ </span><span id="__span-5-15"><a id="__codelineno-5-15" name="__codelineno-5-15" href="#__codelineno-5-15"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_tool_call</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">tool_call</span><span class="o">|</span>
2830
+ </span><span id="__span-5-16"><a id="__codelineno-5-16" name="__codelineno-5-16" href="#__codelineno-5-16"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">[Tool] Calling: </span><span class="si">#{</span><span class="n">tool_call</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span>
2831
+ </span><span id="__span-5-17"><a id="__codelineno-5-17" name="__codelineno-5-17" href="#__codelineno-5-17"></a><span class="k">end</span>
2832
+ </span><span id="__span-5-18"><a id="__codelineno-5-18" name="__codelineno-5-18" href="#__codelineno-5-18"></a>
2833
+ </span><span id="__span-5-19"><a id="__codelineno-5-19" name="__codelineno-5-19" href="#__codelineno-5-19"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_tool_result</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">tool_call</span><span class="p">,</span><span class="w"> </span><span class="n">result</span><span class="o">|</span>
2834
+ </span><span id="__span-5-20"><a id="__codelineno-5-20" name="__codelineno-5-20" href="#__codelineno-5-20"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;[Tool] </span><span class="si">#{</span><span class="n">tool_call</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2"> returned: </span><span class="si">#{</span><span class="n">result</span><span class="si">}</span><span class="s2">&quot;</span>
2835
+ </span><span id="__span-5-21"><a id="__codelineno-5-21" name="__codelineno-5-21" href="#__codelineno-5-21"></a><span class="k">end</span>
2836
+ </span><span id="__span-5-22"><a id="__codelineno-5-22" name="__codelineno-5-22" href="#__codelineno-5-22"></a>
2837
+ </span><span id="__span-5-23"><a id="__codelineno-5-23" name="__codelineno-5-23" href="#__codelineno-5-23"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;What&#39;s the weather in Tokyo?&quot;</span><span class="p">)</span>
2838
+ </span></code></pre></div>
2839
+ <h2 id="streaming-via-chat-block">Streaming via Chat Block<a class="headerlink" href="#streaming-via-chat-block" title="Permanent link">&para;</a></h2>
2840
+ <p>For more control, pass a block directly to <code>chat.ask</code> (the underlying RubyLLM method):</p>
2841
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-6-1"><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
2842
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;chat_bot&quot;</span><span class="p">,</span>
2843
+ </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">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You are a helpful assistant.&quot;</span>
2844
+ </span><span id="__span-6-4"><a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="p">)</span>
2845
+ </span><span id="__span-6-5"><a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a>
2846
+ </span><span id="__span-6-6"><a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="c1"># Use the underlying chat directly with a streaming block</span>
2847
+ </span><span id="__span-6-7"><a id="__codelineno-6-7" name="__codelineno-6-7" href="#__codelineno-6-7"></a><span class="n">robot</span><span class="o">.</span><span class="n">chat</span><span class="o">.</span><span class="n">ask</span><span class="p">(</span><span class="s2">&quot;Tell me a story&quot;</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">chunk</span><span class="o">|</span>
2848
+ </span><span id="__span-6-8"><a id="__codelineno-6-8" name="__codelineno-6-8" href="#__codelineno-6-8"></a><span class="w"> </span><span class="nb">print</span><span class="w"> </span><span class="n">chunk</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">chunk</span><span class="o">.</span><span class="n">content</span>
2849
+ </span><span id="__span-6-9"><a id="__codelineno-6-9" name="__codelineno-6-9" href="#__codelineno-6-9"></a><span class="k">end</span>
2850
+ </span></code></pre></div>
2851
+ <p>Note: Using <code>chat.ask</code> directly bypasses Robot's memory resolution and tool hierarchy. Use callbacks with <code>robot.run</code> when you need those features.</p>
2852
+ <h2 id="web-integration">Web Integration<a class="headerlink" href="#web-integration" title="Permanent link">&para;</a></h2>
2853
+ <h3 id="rails-action-cable">Rails Action Cable<a class="headerlink" href="#rails-action-cable" title="Permanent link">&para;</a></h3>
2854
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="k">class</span><span class="w"> </span><span class="nc">ChatChannel</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">ApplicationCable</span><span class="o">::</span><span class="no">Channel</span>
2855
+ </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="k">def</span><span class="w"> </span><span class="nf">receive</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
2856
+ </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="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
2857
+ </span><span id="__span-7-4"><a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;chat_bot&quot;</span><span class="p">,</span>
2858
+ </span><span id="__span-7-5"><a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You are a helpful chat assistant.&quot;</span>
2859
+ </span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="p">)</span>
2860
+ </span><span id="__span-7-7"><a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a>
2861
+ </span><span id="__span-7-8"><a id="__codelineno-7-8" name="__codelineno-7-8" href="#__codelineno-7-8"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2862
+ </span><span id="__span-7-9"><a id="__codelineno-7-9" name="__codelineno-7-9" href="#__codelineno-7-9"></a><span class="w"> </span><span class="n">transmit</span><span class="p">({</span><span class="w"> </span><span class="ss">event</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;text.delta&quot;</span><span class="p">,</span><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="p">})</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2863
+ </span><span id="__span-7-10"><a id="__codelineno-7-10" name="__codelineno-7-10" href="#__codelineno-7-10"></a><span class="w"> </span><span class="k">end</span>
2864
+ </span><span id="__span-7-11"><a id="__codelineno-7-11" name="__codelineno-7-11" href="#__codelineno-7-11"></a>
2865
+ </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">robot</span><span class="o">.</span><span class="n">on_end_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">_message</span><span class="o">|</span>
2866
+ </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">transmit</span><span class="p">({</span><span class="w"> </span><span class="ss">event</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;run.completed&quot;</span><span class="w"> </span><span class="p">})</span>
2867
+ </span><span id="__span-7-14"><a id="__codelineno-7-14" name="__codelineno-7-14" href="#__codelineno-7-14"></a><span class="w"> </span><span class="k">end</span>
2868
+ </span><span id="__span-7-15"><a id="__codelineno-7-15" name="__codelineno-7-15" href="#__codelineno-7-15"></a>
2869
+ </span><span id="__span-7-16"><a id="__codelineno-7-16" name="__codelineno-7-16" href="#__codelineno-7-16"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">data</span><span class="o">[</span><span class="s2">&quot;message&quot;</span><span class="o">]</span><span class="p">)</span>
2870
+ </span><span id="__span-7-17"><a id="__codelineno-7-17" name="__codelineno-7-17" href="#__codelineno-7-17"></a><span class="w"> </span><span class="k">end</span>
2871
+ </span><span id="__span-7-18"><a id="__codelineno-7-18" name="__codelineno-7-18" href="#__codelineno-7-18"></a><span class="k">end</span>
2872
+ </span></code></pre></div>
2873
+ <h3 id="server-sent-events">Server-Sent Events<a class="headerlink" href="#server-sent-events" title="Permanent link">&para;</a></h3>
2874
+ <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">StreamController</span><span class="w"> </span><span class="o">&lt;</span><span class="w"> </span><span class="no">ApplicationController</span>
2875
+ </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="kp">include</span><span class="w"> </span><span class="no">ActionController</span><span class="o">::</span><span class="no">Live</span>
2876
+ </span><span id="__span-8-3"><a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>
2877
+ </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="k">def</span><span class="w"> </span><span class="nf">create</span>
2878
+ </span><span id="__span-8-5"><a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a><span class="w"> </span><span class="n">response</span><span class="o">.</span><span class="n">headers</span><span class="o">[</span><span class="s2">&quot;Content-Type&quot;</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">&quot;text/event-stream&quot;</span>
2879
+ </span><span id="__span-8-6"><a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a>
2880
+ </span><span id="__span-8-7"><a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a><span class="w"> </span><span class="n">robot</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">build</span><span class="p">(</span>
2881
+ </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="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;stream_bot&quot;</span><span class="p">,</span>
2882
+ </span><span id="__span-8-9"><a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a><span class="w"> </span><span class="ss">system_prompt</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;You are helpful.&quot;</span>
2883
+ </span><span id="__span-8-10"><a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a><span class="w"> </span><span class="p">)</span>
2884
+ </span><span id="__span-8-11"><a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a>
2885
+ </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="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2886
+ </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">response</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;data: </span><span class="si">#{</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="si">}</span><span class="se">\n\n</span><span class="s2">&quot;</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2887
+ </span><span id="__span-8-14"><a id="__codelineno-8-14" name="__codelineno-8-14" href="#__codelineno-8-14"></a><span class="w"> </span><span class="k">end</span>
2888
+ </span><span id="__span-8-15"><a id="__codelineno-8-15" name="__codelineno-8-15" href="#__codelineno-8-15"></a>
2889
+ </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="n">robot</span><span class="o">.</span><span class="n">on_end_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">_message</span><span class="o">|</span>
2890
+ </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">response</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">&quot;data: [DONE]</span><span class="se">\n\n</span><span class="s2">&quot;</span><span class="p">)</span>
2891
+ </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">end</span>
2892
+ </span><span id="__span-8-19"><a id="__codelineno-8-19" name="__codelineno-8-19" href="#__codelineno-8-19"></a>
2893
+ </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="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">params</span><span class="o">[</span><span class="ss">:message</span><span class="o">]</span><span class="p">)</span>
2894
+ </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="k">ensure</span>
2895
+ </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="n">response</span><span class="o">.</span><span class="n">stream</span><span class="o">.</span><span class="n">close</span>
2896
+ </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>
2897
+ </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>
2898
+ </span></code></pre></div>
2899
+ <h3 id="websocket">WebSocket<a class="headerlink" href="#websocket" title="Permanent link">&para;</a></h3>
2900
+ <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"># Using Faye WebSocket</span>
2901
+ </span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="n">ws</span><span class="o">.</span><span class="n">on</span><span class="w"> </span><span class="ss">:message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">msg</span><span class="o">|</span>
2902
+ </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">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2903
+ </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">ws</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2904
+ </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="k">end</span>
2905
+ </span><span id="__span-9-6"><a id="__codelineno-9-6" name="__codelineno-9-6" href="#__codelineno-9-6"></a>
2906
+ </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="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">msg</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
2907
+ </span><span id="__span-9-8"><a id="__codelineno-9-8" name="__codelineno-9-8" href="#__codelineno-9-8"></a><span class="k">end</span>
2908
+ </span></code></pre></div>
2909
+ <h2 id="progress-tracking">Progress Tracking<a class="headerlink" href="#progress-tracking" title="Permanent link">&para;</a></h2>
2910
+ <p>Track streaming progress with callbacks:</p>
2911
+ <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="k">class</span><span class="w"> </span><span class="nc">StreamProgress</span>
2912
+ </span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">initialize</span>
2913
+ </span><span id="__span-10-3"><a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="w"> </span><span class="vi">@chars</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span>
2914
+ </span><span id="__span-10-4"><a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="w"> </span><span class="vi">@tools</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span>
2915
+ </span><span id="__span-10-5"><a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a><span class="w"> </span><span class="k">end</span>
2916
+ </span><span id="__span-10-6"><a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a>
2917
+ </span><span id="__span-10-7"><a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="w"> </span><span class="kp">attr_reader</span><span class="w"> </span><span class="ss">:chars</span><span class="p">,</span><span class="w"> </span><span class="ss">:tools</span>
2918
+ </span><span id="__span-10-8"><a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a>
2919
+ </span><span id="__span-10-9"><a id="__codelineno-10-9" name="__codelineno-10-9" href="#__codelineno-10-9"></a><span class="w"> </span><span class="k">def</span><span class="w"> </span><span class="nf">attach</span><span class="p">(</span><span class="n">robot</span><span class="p">)</span>
2920
+ </span><span id="__span-10-10"><a id="__codelineno-10-10" name="__codelineno-10-10" href="#__codelineno-10-10"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2921
+ </span><span id="__span-10-11"><a id="__codelineno-10-11" name="__codelineno-10-11" href="#__codelineno-10-11"></a><span class="w"> </span><span class="vi">@chars</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="o">.</span><span class="n">length</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2922
+ </span><span id="__span-10-12"><a id="__codelineno-10-12" name="__codelineno-10-12" href="#__codelineno-10-12"></a><span class="w"> </span><span class="nb">print</span><span class="w"> </span><span class="s2">&quot;</span><span class="se">\r</span><span class="s2">Received </span><span class="si">#{</span><span class="vi">@chars</span><span class="si">}</span><span class="s2"> characters...&quot;</span>
2923
+ </span><span id="__span-10-13"><a id="__codelineno-10-13" name="__codelineno-10-13" href="#__codelineno-10-13"></a><span class="w"> </span><span class="k">end</span>
2924
+ </span><span id="__span-10-14"><a id="__codelineno-10-14" name="__codelineno-10-14" href="#__codelineno-10-14"></a>
2925
+ </span><span id="__span-10-15"><a id="__codelineno-10-15" name="__codelineno-10-15" href="#__codelineno-10-15"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">on_tool_call</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">tool_call</span><span class="o">|</span>
2926
+ </span><span id="__span-10-16"><a id="__codelineno-10-16" name="__codelineno-10-16" href="#__codelineno-10-16"></a><span class="w"> </span><span class="vi">@tools</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="mi">1</span>
2927
+ </span><span id="__span-10-17"><a id="__codelineno-10-17" name="__codelineno-10-17" href="#__codelineno-10-17"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Tool call #</span><span class="si">#{</span><span class="vi">@tools</span><span class="si">}</span><span class="s2">: </span><span class="si">#{</span><span class="n">tool_call</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&quot;</span>
2928
+ </span><span id="__span-10-18"><a id="__codelineno-10-18" name="__codelineno-10-18" href="#__codelineno-10-18"></a><span class="w"> </span><span class="k">end</span>
2929
+ </span><span id="__span-10-19"><a id="__codelineno-10-19" name="__codelineno-10-19" href="#__codelineno-10-19"></a><span class="w"> </span><span class="k">end</span>
2930
+ </span><span id="__span-10-20"><a id="__codelineno-10-20" name="__codelineno-10-20" href="#__codelineno-10-20"></a><span class="k">end</span>
2931
+ </span><span id="__span-10-21"><a id="__codelineno-10-21" name="__codelineno-10-21" href="#__codelineno-10-21"></a>
2932
+ </span><span id="__span-10-22"><a id="__codelineno-10-22" name="__codelineno-10-22" href="#__codelineno-10-22"></a><span class="n">progress</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">StreamProgress</span><span class="o">.</span><span class="n">new</span>
2933
+ </span><span id="__span-10-23"><a id="__codelineno-10-23" name="__codelineno-10-23" href="#__codelineno-10-23"></a><span class="n">progress</span><span class="o">.</span><span class="n">attach</span><span class="p">(</span><span class="n">robot</span><span class="p">)</span>
2934
+ </span><span id="__span-10-24"><a id="__codelineno-10-24" name="__codelineno-10-24" href="#__codelineno-10-24"></a>
2935
+ </span><span id="__span-10-25"><a id="__codelineno-10-25" name="__codelineno-10-25" href="#__codelineno-10-25"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Process this complex request&quot;</span><span class="p">)</span>
2936
+ </span><span id="__span-10-26"><a id="__codelineno-10-26" name="__codelineno-10-26" href="#__codelineno-10-26"></a><span class="nb">puts</span><span class="w"> </span><span class="s2">&quot;</span><span class="se">\n</span><span class="s2">Total: </span><span class="si">#{</span><span class="n">progress</span><span class="o">.</span><span class="n">chars</span><span class="si">}</span><span class="s2"> chars, </span><span class="si">#{</span><span class="n">progress</span><span class="o">.</span><span class="n">tools</span><span class="si">}</span><span class="s2"> tool calls&quot;</span>
2937
+ </span></code></pre></div>
2938
+ <h2 id="without-streaming">Without Streaming<a class="headerlink" href="#without-streaming" title="Permanent link">&para;</a></h2>
2939
+ <p>When streaming is not needed, simply call <code>run</code> without registering callbacks:</p>
2940
+ <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"># No streaming - returns RobotResult directly</span>
2941
+ </span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Hello!&quot;</span><span class="p">)</span>
2942
+ </span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="nb">puts</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">last_text_content</span>
2943
+ </span></code></pre></div>
2944
+ <h2 id="best-practices">Best Practices<a class="headerlink" href="#best-practices" title="Permanent link">&para;</a></h2>
2945
+ <h3 id="1-register-callbacks-before-run">1. Register Callbacks Before Run<a class="headerlink" href="#1-register-callbacks-before-run" title="Permanent link">&para;</a></h3>
2946
+ <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="c1"># Correct: register first, then run</span>
2947
+ </span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="o">|</span><span class="n">msg</span><span class="o">|</span><span class="w"> </span><span class="nb">print</span><span class="w"> </span><span class="n">msg</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">msg</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="p">}</span>
2948
+ </span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Hello&quot;</span><span class="p">)</span>
2949
+ </span></code></pre></div>
2950
+ <h3 id="2-handle-errors-in-callbacks">2. Handle Errors in Callbacks<a class="headerlink" href="#2-handle-errors-in-callbacks" title="Permanent link">&para;</a></h3>
2951
+ <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">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2952
+ </span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a><span class="w"> </span><span class="k">begin</span>
2953
+ </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="n">broadcast</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2954
+ </span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="w"> </span><span class="k">rescue</span><span class="w"> </span><span class="no">BroadcastError</span><span class="w"> </span><span class="o">=&gt;</span><span class="w"> </span><span class="n">e</span>
2955
+ </span><span id="__span-13-5"><a id="__codelineno-13-5" name="__codelineno-13-5" href="#__codelineno-13-5"></a><span class="w"> </span><span class="c1"># Client disconnected, but continue processing</span>
2956
+ </span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="w"> </span><span class="n">logger</span><span class="o">.</span><span class="n">warn</span><span class="w"> </span><span class="s2">&quot;Broadcast failed: </span><span class="si">#{</span><span class="n">e</span><span class="o">.</span><span class="n">message</span><span class="si">}</span><span class="s2">&quot;</span>
2957
+ </span><span id="__span-13-7"><a id="__codelineno-13-7" name="__codelineno-13-7" href="#__codelineno-13-7"></a><span class="w"> </span><span class="k">end</span>
2958
+ </span><span id="__span-13-8"><a id="__codelineno-13-8" name="__codelineno-13-8" href="#__codelineno-13-8"></a><span class="k">end</span>
2959
+ </span></code></pre></div>
2960
+ <h3 id="3-clean-up-resources">3. Clean Up Resources<a class="headerlink" href="#3-clean-up-resources" title="Permanent link">&para;</a></h3>
2961
+ <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="k">begin</span>
2962
+ </span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">on_new_message</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">message</span><span class="o">|</span>
2963
+ </span><span id="__span-14-3"><a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a><span class="w"> </span><span class="n">stream_to_client</span><span class="p">(</span><span class="n">message</span><span class="o">.</span><span class="n">content</span><span class="p">)</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">message</span><span class="o">.</span><span class="n">content</span>
2964
+ </span><span id="__span-14-4"><a id="__codelineno-14-4" name="__codelineno-14-4" href="#__codelineno-14-4"></a><span class="w"> </span><span class="k">end</span>
2965
+ </span><span id="__span-14-5"><a id="__codelineno-14-5" name="__codelineno-14-5" href="#__codelineno-14-5"></a><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Hello&quot;</span><span class="p">)</span>
2966
+ </span><span id="__span-14-6"><a id="__codelineno-14-6" name="__codelineno-14-6" href="#__codelineno-14-6"></a><span class="k">ensure</span>
2967
+ </span><span id="__span-14-7"><a id="__codelineno-14-7" name="__codelineno-14-7" href="#__codelineno-14-7"></a><span class="w"> </span><span class="n">close_stream_connection</span>
2968
+ </span><span id="__span-14-8"><a id="__codelineno-14-8" name="__codelineno-14-8" href="#__codelineno-14-8"></a><span class="k">end</span>
2969
+ </span></code></pre></div>
2970
+ <h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
2971
+ <ul>
2972
+ <li><a href="../building-robots/">Building Robots</a> - Robot creation</li>
2973
+ <li><a href="../creating-networks/">Creating Networks</a> - Network patterns</li>
2974
+ <li><a href="../../api/streaming/">API Reference: Streaming</a> - Complete API</li>
2975
+ </ul>
2976
+
2977
+
2978
+
2979
+
2980
+
2981
+
2982
+
2983
+
2984
+
2985
+
2986
+
2987
+
2988
+
2989
+ <form class="md-feedback" name="feedback" hidden>
2990
+ <fieldset>
2991
+ <legend class="md-feedback__title">
2992
+ Was this page helpful?
2993
+ </legend>
2994
+ <div class="md-feedback__inner">
2995
+ <div class="md-feedback__list">
2996
+
2997
+ <button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
2998
+ <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>
2999
+ </button>
3000
+
3001
+ <button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
3002
+ <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>
3003
+ </button>
3004
+
3005
+ </div>
3006
+ <div class="md-feedback__note">
3007
+
3008
+ <div data-md-value="1" hidden>
3009
+
3010
+
3011
+
3012
+
3013
+
3014
+
3015
+
3016
+
3017
+
3018
+ Thanks for your feedback!
3019
+ </div>
3020
+
3021
+ <div data-md-value="0" hidden>
3022
+
3023
+
3024
+
3025
+
3026
+
3027
+
3028
+
3029
+
3030
+
3031
+ Thanks for your feedback! Help us improve by creating an issue.
3032
+ </div>
3033
+
3034
+ </div>
3035
+ </div>
3036
+ </fieldset>
3037
+ </form>
3038
+
3039
+
3040
+
3041
+ </article>
3042
+ </div>
3043
+
3044
+
3045
+ <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>
3046
+
3047
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
3048
+ </div>
3049
+
3050
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
3051
+
3052
+ <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>
3053
+ Back to top
3054
+ </button>
3055
+
3056
+ </main>
3057
+
3058
+ <footer class="md-footer">
3059
+
3060
+
3061
+
3062
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
3063
+
3064
+
3065
+ <a href="../mcp-integration/" class="md-footer__link md-footer__link--prev" aria-label="Previous: MCP Integration">
3066
+ <div class="md-footer__button md-icon">
3067
+
3068
+ <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>
3069
+ </div>
3070
+ <div class="md-footer__title">
3071
+ <span class="md-footer__direction">
3072
+ Previous
3073
+ </span>
3074
+ <div class="md-ellipsis">
3075
+ MCP Integration
3076
+ </div>
3077
+ </div>
3078
+ </a>
3079
+
3080
+
3081
+
3082
+ <a href="../memory/" class="md-footer__link md-footer__link--next" aria-label="Next: Memory System">
3083
+ <div class="md-footer__title">
3084
+ <span class="md-footer__direction">
3085
+ Next
3086
+ </span>
3087
+ <div class="md-ellipsis">
3088
+ Memory System
3089
+ </div>
3090
+ </div>
3091
+ <div class="md-footer__button md-icon">
3092
+
3093
+ <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>
3094
+ </div>
3095
+ </a>
3096
+
3097
+ </nav>
3098
+
3099
+
3100
+ <div class="md-footer-meta md-typeset">
3101
+ <div class="md-footer-meta__inner md-grid">
3102
+ <div class="md-copyright">
3103
+
3104
+ <div class="md-copyright__highlight">
3105
+ Copyright &copy; 2025 Dewayne VanHoozer
3106
+ </div>
3107
+
3108
+
3109
+ Made with
3110
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3111
+ Material for MkDocs
3112
+ </a>
3113
+
3114
+ </div>
3115
+
3116
+
3117
+ <div class="md-social">
3118
+
3119
+
3120
+
3121
+
3122
+
3123
+ <a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
3124
+ <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>
3125
+ </a>
3126
+
3127
+
3128
+
3129
+
3130
+
3131
+ <a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
3132
+ <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>
3133
+ </a>
3134
+
3135
+ </div>
3136
+
3137
+ </div>
3138
+ </div>
3139
+ </footer>
3140
+
3141
+ </div>
3142
+ <div class="md-dialog" data-md-component="dialog">
3143
+ <div class="md-dialog__inner md-typeset"></div>
3144
+ </div>
3145
+
3146
+
3147
+
3148
+
3149
+
3150
+ <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>
3151
+
3152
+
3153
+ <script src="../../assets/javascripts/bundle.79ae519e.min.js"></script>
3154
+
3155
+
3156
+ </body>
3157
+ </html>