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,3087 @@
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/api/messages/text-message/">
16
+
17
+
18
+ <link rel="prev" href="../user-message/">
19
+
20
+
21
+ <link rel="next" href="../tool-call-message/">
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>TextMessage - 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="#textmessage" 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
+ TextMessage
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
+ <li class="md-tabs__item">
303
+ <a href="../../../guides/" class="md-tabs__link">
304
+
305
+
306
+
307
+
308
+
309
+ Guides
310
+
311
+ </a>
312
+ </li>
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+ <li class="md-tabs__item md-tabs__item--active">
327
+ <a href="../../" 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
+ <li class="md-nav__item md-nav__item--nested">
935
+
936
+
937
+
938
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
939
+
940
+
941
+ <div class="md-nav__link md-nav__container">
942
+ <a href="../../../guides/" class="md-nav__link ">
943
+
944
+
945
+
946
+ <span class="md-ellipsis">
947
+
948
+
949
+ Guides
950
+
951
+
952
+
953
+ </span>
954
+
955
+
956
+
957
+ </a>
958
+
959
+
960
+ <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
961
+ <span class="md-nav__icon md-icon"></span>
962
+ </label>
963
+
964
+ </div>
965
+
966
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
967
+ <label class="md-nav__title" for="__nav_4">
968
+ <span class="md-nav__icon md-icon"></span>
969
+
970
+
971
+ Guides
972
+
973
+
974
+ </label>
975
+ <ul class="md-nav__list" data-md-scrollfix>
976
+
977
+
978
+
979
+
980
+
981
+
982
+
983
+
984
+
985
+ <li class="md-nav__item">
986
+ <a href="../../../guides/building-robots/" class="md-nav__link">
987
+
988
+
989
+
990
+ <span class="md-ellipsis">
991
+
992
+
993
+ Building Robots
994
+
995
+
996
+
997
+ </span>
998
+
999
+
1000
+
1001
+ </a>
1002
+ </li>
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+
1009
+
1010
+
1011
+
1012
+
1013
+ <li class="md-nav__item">
1014
+ <a href="../../../guides/creating-networks/" class="md-nav__link">
1015
+
1016
+
1017
+
1018
+ <span class="md-ellipsis">
1019
+
1020
+
1021
+ Creating Networks
1022
+
1023
+
1024
+
1025
+ </span>
1026
+
1027
+
1028
+
1029
+ </a>
1030
+ </li>
1031
+
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+
1040
+
1041
+ <li class="md-nav__item">
1042
+ <a href="../../../guides/using-tools/" class="md-nav__link">
1043
+
1044
+
1045
+
1046
+ <span class="md-ellipsis">
1047
+
1048
+
1049
+ Using Tools
1050
+
1051
+
1052
+
1053
+ </span>
1054
+
1055
+
1056
+
1057
+ </a>
1058
+ </li>
1059
+
1060
+
1061
+
1062
+
1063
+
1064
+
1065
+
1066
+
1067
+
1068
+
1069
+ <li class="md-nav__item">
1070
+ <a href="../../../guides/mcp-integration/" class="md-nav__link">
1071
+
1072
+
1073
+
1074
+ <span class="md-ellipsis">
1075
+
1076
+
1077
+ MCP Integration
1078
+
1079
+
1080
+
1081
+ </span>
1082
+
1083
+
1084
+
1085
+ </a>
1086
+ </li>
1087
+
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+
1095
+
1096
+
1097
+ <li class="md-nav__item">
1098
+ <a href="../../../guides/streaming/" class="md-nav__link">
1099
+
1100
+
1101
+
1102
+ <span class="md-ellipsis">
1103
+
1104
+
1105
+ Streaming Responses
1106
+
1107
+
1108
+
1109
+ </span>
1110
+
1111
+
1112
+
1113
+ </a>
1114
+ </li>
1115
+
1116
+
1117
+
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+
1124
+
1125
+ <li class="md-nav__item">
1126
+ <a href="../../../guides/memory/" class="md-nav__link">
1127
+
1128
+
1129
+
1130
+ <span class="md-ellipsis">
1131
+
1132
+
1133
+ Memory System
1134
+
1135
+
1136
+
1137
+ </span>
1138
+
1139
+
1140
+
1141
+ </a>
1142
+ </li>
1143
+
1144
+
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+ <li class="md-nav__item">
1154
+ <a href="../../../guides/rails-integration/" class="md-nav__link">
1155
+
1156
+
1157
+
1158
+ <span class="md-ellipsis">
1159
+
1160
+
1161
+ Rails Integration
1162
+
1163
+
1164
+
1165
+ </span>
1166
+
1167
+
1168
+
1169
+ </a>
1170
+ </li>
1171
+
1172
+
1173
+
1174
+
1175
+ </ul>
1176
+ </nav>
1177
+
1178
+ </li>
1179
+
1180
+
1181
+
1182
+
1183
+
1184
+
1185
+
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+
1192
+
1193
+
1194
+
1195
+
1196
+
1197
+
1198
+
1199
+
1200
+
1201
+
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+
1214
+
1215
+ <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
1216
+
1217
+
1218
+
1219
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
1220
+
1221
+
1222
+ <div class="md-nav__link md-nav__container">
1223
+ <a href="../../" class="md-nav__link ">
1224
+
1225
+
1226
+
1227
+ <span class="md-ellipsis">
1228
+
1229
+
1230
+ API Reference
1231
+
1232
+
1233
+
1234
+ </span>
1235
+
1236
+
1237
+
1238
+ </a>
1239
+
1240
+
1241
+ <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
1242
+ <span class="md-nav__icon md-icon"></span>
1243
+ </label>
1244
+
1245
+ </div>
1246
+
1247
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
1248
+ <label class="md-nav__title" for="__nav_5">
1249
+ <span class="md-nav__icon md-icon"></span>
1250
+
1251
+
1252
+ API Reference
1253
+
1254
+
1255
+ </label>
1256
+ <ul class="md-nav__list" data-md-scrollfix>
1257
+
1258
+
1259
+
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+
1266
+
1267
+
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+
1280
+
1281
+
1282
+
1283
+
1284
+
1285
+
1286
+
1287
+
1288
+
1289
+
1290
+ <li class="md-nav__item md-nav__item--nested">
1291
+
1292
+
1293
+
1294
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" >
1295
+
1296
+
1297
+ <div class="md-nav__link md-nav__container">
1298
+ <a href="../../core/" class="md-nav__link ">
1299
+
1300
+
1301
+
1302
+ <span class="md-ellipsis">
1303
+
1304
+
1305
+ Core Classes
1306
+
1307
+
1308
+
1309
+ </span>
1310
+
1311
+
1312
+
1313
+ </a>
1314
+
1315
+
1316
+ <label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
1317
+ <span class="md-nav__icon md-icon"></span>
1318
+ </label>
1319
+
1320
+ </div>
1321
+
1322
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="false">
1323
+ <label class="md-nav__title" for="__nav_5_2">
1324
+ <span class="md-nav__icon md-icon"></span>
1325
+
1326
+
1327
+ Core Classes
1328
+
1329
+
1330
+ </label>
1331
+ <ul class="md-nav__list" data-md-scrollfix>
1332
+
1333
+
1334
+
1335
+
1336
+
1337
+
1338
+
1339
+
1340
+
1341
+ <li class="md-nav__item">
1342
+ <a href="../../core/robot/" class="md-nav__link">
1343
+
1344
+
1345
+
1346
+ <span class="md-ellipsis">
1347
+
1348
+
1349
+ Robot
1350
+
1351
+
1352
+
1353
+ </span>
1354
+
1355
+
1356
+
1357
+ </a>
1358
+ </li>
1359
+
1360
+
1361
+
1362
+
1363
+
1364
+
1365
+
1366
+
1367
+
1368
+
1369
+ <li class="md-nav__item">
1370
+ <a href="../../core/network/" class="md-nav__link">
1371
+
1372
+
1373
+
1374
+ <span class="md-ellipsis">
1375
+
1376
+
1377
+ Network
1378
+
1379
+
1380
+
1381
+ </span>
1382
+
1383
+
1384
+
1385
+ </a>
1386
+ </li>
1387
+
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+
1394
+
1395
+
1396
+
1397
+ <li class="md-nav__item">
1398
+ <a href="../../core/state/" class="md-nav__link">
1399
+
1400
+
1401
+
1402
+ <span class="md-ellipsis">
1403
+
1404
+
1405
+ State
1406
+
1407
+
1408
+
1409
+ </span>
1410
+
1411
+
1412
+
1413
+ </a>
1414
+ </li>
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+ <li class="md-nav__item">
1426
+ <a href="../../core/tool/" class="md-nav__link">
1427
+
1428
+
1429
+
1430
+ <span class="md-ellipsis">
1431
+
1432
+
1433
+ Tool
1434
+
1435
+
1436
+
1437
+ </span>
1438
+
1439
+
1440
+
1441
+ </a>
1442
+ </li>
1443
+
1444
+
1445
+
1446
+
1447
+
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+ <li class="md-nav__item">
1454
+ <a href="../../core/memory/" class="md-nav__link">
1455
+
1456
+
1457
+
1458
+ <span class="md-ellipsis">
1459
+
1460
+
1461
+ Memory
1462
+
1463
+
1464
+
1465
+ </span>
1466
+
1467
+
1468
+
1469
+ </a>
1470
+ </li>
1471
+
1472
+
1473
+
1474
+
1475
+ </ul>
1476
+ </nav>
1477
+
1478
+ </li>
1479
+
1480
+
1481
+
1482
+
1483
+
1484
+
1485
+
1486
+
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+
1493
+
1494
+
1495
+
1496
+
1497
+
1498
+
1499
+
1500
+
1501
+
1502
+
1503
+
1504
+
1505
+
1506
+
1507
+
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
1514
+
1515
+
1516
+
1517
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" checked>
1518
+
1519
+
1520
+ <div class="md-nav__link md-nav__container">
1521
+ <a href="../" class="md-nav__link ">
1522
+
1523
+
1524
+
1525
+ <span class="md-ellipsis">
1526
+
1527
+
1528
+ Messages
1529
+
1530
+
1531
+
1532
+ </span>
1533
+
1534
+
1535
+
1536
+ </a>
1537
+
1538
+
1539
+ <label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
1540
+ <span class="md-nav__icon md-icon"></span>
1541
+ </label>
1542
+
1543
+ </div>
1544
+
1545
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="true">
1546
+ <label class="md-nav__title" for="__nav_5_3">
1547
+ <span class="md-nav__icon md-icon"></span>
1548
+
1549
+
1550
+ Messages
1551
+
1552
+
1553
+ </label>
1554
+ <ul class="md-nav__list" data-md-scrollfix>
1555
+
1556
+
1557
+
1558
+
1559
+
1560
+
1561
+
1562
+
1563
+
1564
+ <li class="md-nav__item">
1565
+ <a href="../user-message/" class="md-nav__link">
1566
+
1567
+
1568
+
1569
+ <span class="md-ellipsis">
1570
+
1571
+
1572
+ UserMessage
1573
+
1574
+
1575
+
1576
+ </span>
1577
+
1578
+
1579
+
1580
+ </a>
1581
+ </li>
1582
+
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+
1589
+
1590
+
1591
+
1592
+
1593
+
1594
+ <li class="md-nav__item md-nav__item--active">
1595
+
1596
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
1597
+
1598
+
1599
+
1600
+
1601
+
1602
+ <label class="md-nav__link md-nav__link--active" for="__toc">
1603
+
1604
+
1605
+
1606
+ <span class="md-ellipsis">
1607
+
1608
+
1609
+ TextMessage
1610
+
1611
+
1612
+
1613
+ </span>
1614
+
1615
+
1616
+
1617
+ <span class="md-nav__icon md-icon"></span>
1618
+ </label>
1619
+
1620
+ <a href="./" class="md-nav__link md-nav__link--active">
1621
+
1622
+
1623
+
1624
+ <span class="md-ellipsis">
1625
+
1626
+
1627
+ TextMessage
1628
+
1629
+
1630
+
1631
+ </span>
1632
+
1633
+
1634
+
1635
+ </a>
1636
+
1637
+
1638
+
1639
+
1640
+
1641
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
1642
+
1643
+
1644
+
1645
+
1646
+
1647
+
1648
+ <label class="md-nav__title" for="__toc">
1649
+ <span class="md-nav__icon md-icon"></span>
1650
+ On this page
1651
+ </label>
1652
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
1653
+
1654
+ <li class="md-nav__item">
1655
+ <a href="#class-robotlabtextmessage" class="md-nav__link">
1656
+ <span class="md-ellipsis">
1657
+
1658
+ Class: RobotLab::TextMessage
1659
+
1660
+ </span>
1661
+ </a>
1662
+
1663
+ </li>
1664
+
1665
+ <li class="md-nav__item">
1666
+ <a href="#constructor" class="md-nav__link">
1667
+ <span class="md-ellipsis">
1668
+
1669
+ Constructor
1670
+
1671
+ </span>
1672
+ </a>
1673
+
1674
+ </li>
1675
+
1676
+ <li class="md-nav__item">
1677
+ <a href="#attributes" class="md-nav__link">
1678
+ <span class="md-ellipsis">
1679
+
1680
+ Attributes
1681
+
1682
+ </span>
1683
+ </a>
1684
+
1685
+ <nav class="md-nav" aria-label="Attributes">
1686
+ <ul class="md-nav__list">
1687
+
1688
+ <li class="md-nav__item">
1689
+ <a href="#content" class="md-nav__link">
1690
+ <span class="md-ellipsis">
1691
+
1692
+ content
1693
+
1694
+ </span>
1695
+ </a>
1696
+
1697
+ </li>
1698
+
1699
+ <li class="md-nav__item">
1700
+ <a href="#role" class="md-nav__link">
1701
+ <span class="md-ellipsis">
1702
+
1703
+ role
1704
+
1705
+ </span>
1706
+ </a>
1707
+
1708
+ </li>
1709
+
1710
+ <li class="md-nav__item">
1711
+ <a href="#type" class="md-nav__link">
1712
+ <span class="md-ellipsis">
1713
+
1714
+ type
1715
+
1716
+ </span>
1717
+ </a>
1718
+
1719
+ </li>
1720
+
1721
+ <li class="md-nav__item">
1722
+ <a href="#stop_reason" class="md-nav__link">
1723
+ <span class="md-ellipsis">
1724
+
1725
+ stop_reason
1726
+
1727
+ </span>
1728
+ </a>
1729
+
1730
+ </li>
1731
+
1732
+ </ul>
1733
+ </nav>
1734
+
1735
+ </li>
1736
+
1737
+ <li class="md-nav__item">
1738
+ <a href="#methods" class="md-nav__link">
1739
+ <span class="md-ellipsis">
1740
+
1741
+ Methods
1742
+
1743
+ </span>
1744
+ </a>
1745
+
1746
+ <nav class="md-nav" aria-label="Methods">
1747
+ <ul class="md-nav__list">
1748
+
1749
+ <li class="md-nav__item">
1750
+ <a href="#to_h" class="md-nav__link">
1751
+ <span class="md-ellipsis">
1752
+
1753
+ to_h
1754
+
1755
+ </span>
1756
+ </a>
1757
+
1758
+ </li>
1759
+
1760
+ <li class="md-nav__item">
1761
+ <a href="#to_json" class="md-nav__link">
1762
+ <span class="md-ellipsis">
1763
+
1764
+ to_json
1765
+
1766
+ </span>
1767
+ </a>
1768
+
1769
+ </li>
1770
+
1771
+ <li class="md-nav__item">
1772
+ <a href="#predicates" class="md-nav__link">
1773
+ <span class="md-ellipsis">
1774
+
1775
+ Predicates
1776
+
1777
+ </span>
1778
+ </a>
1779
+
1780
+ </li>
1781
+
1782
+ </ul>
1783
+ </nav>
1784
+
1785
+ </li>
1786
+
1787
+ <li class="md-nav__item">
1788
+ <a href="#examples" class="md-nav__link">
1789
+ <span class="md-ellipsis">
1790
+
1791
+ Examples
1792
+
1793
+ </span>
1794
+ </a>
1795
+
1796
+ <nav class="md-nav" aria-label="Examples">
1797
+ <ul class="md-nav__list">
1798
+
1799
+ <li class="md-nav__item">
1800
+ <a href="#system-message" class="md-nav__link">
1801
+ <span class="md-ellipsis">
1802
+
1803
+ System Message
1804
+
1805
+ </span>
1806
+ </a>
1807
+
1808
+ </li>
1809
+
1810
+ <li class="md-nav__item">
1811
+ <a href="#user-message" class="md-nav__link">
1812
+ <span class="md-ellipsis">
1813
+
1814
+ User Message
1815
+
1816
+ </span>
1817
+ </a>
1818
+
1819
+ </li>
1820
+
1821
+ <li class="md-nav__item">
1822
+ <a href="#assistant-response" class="md-nav__link">
1823
+ <span class="md-ellipsis">
1824
+
1825
+ Assistant Response
1826
+
1827
+ </span>
1828
+ </a>
1829
+
1830
+ </li>
1831
+
1832
+ <li class="md-nav__item">
1833
+ <a href="#in-robot-results" class="md-nav__link">
1834
+ <span class="md-ellipsis">
1835
+
1836
+ In Robot Results
1837
+
1838
+ </span>
1839
+ </a>
1840
+
1841
+ </li>
1842
+
1843
+ <li class="md-nav__item">
1844
+ <a href="#filtering-text-content" class="md-nav__link">
1845
+ <span class="md-ellipsis">
1846
+
1847
+ Filtering Text Content
1848
+
1849
+ </span>
1850
+ </a>
1851
+
1852
+ </li>
1853
+
1854
+ </ul>
1855
+ </nav>
1856
+
1857
+ </li>
1858
+
1859
+ <li class="md-nav__item">
1860
+ <a href="#see-also" class="md-nav__link">
1861
+ <span class="md-ellipsis">
1862
+
1863
+ See Also
1864
+
1865
+ </span>
1866
+ </a>
1867
+
1868
+ </li>
1869
+
1870
+ </ul>
1871
+
1872
+ </nav>
1873
+
1874
+ </li>
1875
+
1876
+
1877
+
1878
+
1879
+
1880
+
1881
+
1882
+
1883
+
1884
+
1885
+ <li class="md-nav__item">
1886
+ <a href="../tool-call-message/" class="md-nav__link">
1887
+
1888
+
1889
+
1890
+ <span class="md-ellipsis">
1891
+
1892
+
1893
+ ToolCallMessage
1894
+
1895
+
1896
+
1897
+ </span>
1898
+
1899
+
1900
+
1901
+ </a>
1902
+ </li>
1903
+
1904
+
1905
+
1906
+
1907
+
1908
+
1909
+
1910
+
1911
+
1912
+
1913
+ <li class="md-nav__item">
1914
+ <a href="../tool-result-message/" class="md-nav__link">
1915
+
1916
+
1917
+
1918
+ <span class="md-ellipsis">
1919
+
1920
+
1921
+ ToolResultMessage
1922
+
1923
+
1924
+
1925
+ </span>
1926
+
1927
+
1928
+
1929
+ </a>
1930
+ </li>
1931
+
1932
+
1933
+
1934
+
1935
+ </ul>
1936
+ </nav>
1937
+
1938
+ </li>
1939
+
1940
+
1941
+
1942
+
1943
+
1944
+
1945
+
1946
+
1947
+
1948
+
1949
+
1950
+
1951
+
1952
+
1953
+
1954
+
1955
+
1956
+
1957
+
1958
+
1959
+
1960
+
1961
+
1962
+
1963
+
1964
+
1965
+
1966
+
1967
+
1968
+
1969
+ <li class="md-nav__item md-nav__item--nested">
1970
+
1971
+
1972
+
1973
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
1974
+
1975
+
1976
+ <div class="md-nav__link md-nav__container">
1977
+ <a href="../../mcp/" class="md-nav__link ">
1978
+
1979
+
1980
+
1981
+ <span class="md-ellipsis">
1982
+
1983
+
1984
+ MCP
1985
+
1986
+
1987
+
1988
+ </span>
1989
+
1990
+
1991
+
1992
+ </a>
1993
+
1994
+
1995
+ <label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
1996
+ <span class="md-nav__icon md-icon"></span>
1997
+ </label>
1998
+
1999
+ </div>
2000
+
2001
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
2002
+ <label class="md-nav__title" for="__nav_5_4">
2003
+ <span class="md-nav__icon md-icon"></span>
2004
+
2005
+
2006
+ MCP
2007
+
2008
+
2009
+ </label>
2010
+ <ul class="md-nav__list" data-md-scrollfix>
2011
+
2012
+
2013
+
2014
+
2015
+
2016
+
2017
+
2018
+
2019
+
2020
+ <li class="md-nav__item">
2021
+ <a href="../../mcp/client/" class="md-nav__link">
2022
+
2023
+
2024
+
2025
+ <span class="md-ellipsis">
2026
+
2027
+
2028
+ Client
2029
+
2030
+
2031
+
2032
+ </span>
2033
+
2034
+
2035
+
2036
+ </a>
2037
+ </li>
2038
+
2039
+
2040
+
2041
+
2042
+
2043
+
2044
+
2045
+
2046
+
2047
+
2048
+ <li class="md-nav__item">
2049
+ <a href="../../mcp/server/" class="md-nav__link">
2050
+
2051
+
2052
+
2053
+ <span class="md-ellipsis">
2054
+
2055
+
2056
+ Server
2057
+
2058
+
2059
+
2060
+ </span>
2061
+
2062
+
2063
+
2064
+ </a>
2065
+ </li>
2066
+
2067
+
2068
+
2069
+
2070
+
2071
+
2072
+
2073
+
2074
+
2075
+
2076
+ <li class="md-nav__item">
2077
+ <a href="../../mcp/transports/" class="md-nav__link">
2078
+
2079
+
2080
+
2081
+ <span class="md-ellipsis">
2082
+
2083
+
2084
+ Transports
2085
+
2086
+
2087
+
2088
+ </span>
2089
+
2090
+
2091
+
2092
+ </a>
2093
+ </li>
2094
+
2095
+
2096
+
2097
+
2098
+ </ul>
2099
+ </nav>
2100
+
2101
+ </li>
2102
+
2103
+
2104
+
2105
+
2106
+
2107
+
2108
+
2109
+
2110
+
2111
+
2112
+
2113
+
2114
+
2115
+
2116
+
2117
+
2118
+
2119
+
2120
+
2121
+
2122
+
2123
+
2124
+
2125
+
2126
+
2127
+
2128
+
2129
+
2130
+ <li class="md-nav__item md-nav__item--nested">
2131
+
2132
+
2133
+
2134
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
2135
+
2136
+
2137
+ <div class="md-nav__link md-nav__container">
2138
+ <a href="../../streaming/" class="md-nav__link ">
2139
+
2140
+
2141
+
2142
+ <span class="md-ellipsis">
2143
+
2144
+
2145
+ Streaming
2146
+
2147
+
2148
+
2149
+ </span>
2150
+
2151
+
2152
+
2153
+ </a>
2154
+
2155
+
2156
+ <label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
2157
+ <span class="md-nav__icon md-icon"></span>
2158
+ </label>
2159
+
2160
+ </div>
2161
+
2162
+ <nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
2163
+ <label class="md-nav__title" for="__nav_5_5">
2164
+ <span class="md-nav__icon md-icon"></span>
2165
+
2166
+
2167
+ Streaming
2168
+
2169
+
2170
+ </label>
2171
+ <ul class="md-nav__list" data-md-scrollfix>
2172
+
2173
+
2174
+
2175
+
2176
+
2177
+
2178
+
2179
+
2180
+
2181
+ <li class="md-nav__item">
2182
+ <a href="../../streaming/context/" class="md-nav__link">
2183
+
2184
+
2185
+
2186
+ <span class="md-ellipsis">
2187
+
2188
+
2189
+ Context
2190
+
2191
+
2192
+
2193
+ </span>
2194
+
2195
+
2196
+
2197
+ </a>
2198
+ </li>
2199
+
2200
+
2201
+
2202
+
2203
+
2204
+
2205
+
2206
+
2207
+
2208
+
2209
+ <li class="md-nav__item">
2210
+ <a href="../../streaming/events/" class="md-nav__link">
2211
+
2212
+
2213
+
2214
+ <span class="md-ellipsis">
2215
+
2216
+
2217
+ Events
2218
+
2219
+
2220
+
2221
+ </span>
2222
+
2223
+
2224
+
2225
+ </a>
2226
+ </li>
2227
+
2228
+
2229
+
2230
+
2231
+ </ul>
2232
+ </nav>
2233
+
2234
+ </li>
2235
+
2236
+
2237
+
2238
+
2239
+ </ul>
2240
+ </nav>
2241
+
2242
+ </li>
2243
+
2244
+
2245
+
2246
+
2247
+
2248
+
2249
+
2250
+
2251
+
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
+ <li class="md-nav__item md-nav__item--nested">
2277
+
2278
+
2279
+
2280
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
2281
+
2282
+
2283
+ <div class="md-nav__link md-nav__container">
2284
+ <a href="../../../examples/" class="md-nav__link ">
2285
+
2286
+
2287
+
2288
+ <span class="md-ellipsis">
2289
+
2290
+
2291
+ Examples
2292
+
2293
+
2294
+
2295
+ </span>
2296
+
2297
+
2298
+
2299
+ </a>
2300
+
2301
+
2302
+ <label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
2303
+ <span class="md-nav__icon md-icon"></span>
2304
+ </label>
2305
+
2306
+ </div>
2307
+
2308
+ <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
2309
+ <label class="md-nav__title" for="__nav_6">
2310
+ <span class="md-nav__icon md-icon"></span>
2311
+
2312
+
2313
+ Examples
2314
+
2315
+
2316
+ </label>
2317
+ <ul class="md-nav__list" data-md-scrollfix>
2318
+
2319
+
2320
+
2321
+
2322
+
2323
+
2324
+
2325
+
2326
+
2327
+ <li class="md-nav__item">
2328
+ <a href="../../../examples/basic-chat/" class="md-nav__link">
2329
+
2330
+
2331
+
2332
+ <span class="md-ellipsis">
2333
+
2334
+
2335
+ Basic Chat
2336
+
2337
+
2338
+
2339
+ </span>
2340
+
2341
+
2342
+
2343
+ </a>
2344
+ </li>
2345
+
2346
+
2347
+
2348
+
2349
+
2350
+
2351
+
2352
+
2353
+
2354
+
2355
+ <li class="md-nav__item">
2356
+ <a href="../../../examples/multi-robot-network/" class="md-nav__link">
2357
+
2358
+
2359
+
2360
+ <span class="md-ellipsis">
2361
+
2362
+
2363
+ Multi-Robot Network
2364
+
2365
+
2366
+
2367
+ </span>
2368
+
2369
+
2370
+
2371
+ </a>
2372
+ </li>
2373
+
2374
+
2375
+
2376
+
2377
+
2378
+
2379
+
2380
+
2381
+
2382
+
2383
+ <li class="md-nav__item">
2384
+ <a href="../../../examples/tool-usage/" class="md-nav__link">
2385
+
2386
+
2387
+
2388
+ <span class="md-ellipsis">
2389
+
2390
+
2391
+ Tool Usage
2392
+
2393
+
2394
+
2395
+ </span>
2396
+
2397
+
2398
+
2399
+ </a>
2400
+ </li>
2401
+
2402
+
2403
+
2404
+
2405
+
2406
+
2407
+
2408
+
2409
+
2410
+
2411
+ <li class="md-nav__item">
2412
+ <a href="../../../examples/mcp-server/" class="md-nav__link">
2413
+
2414
+
2415
+
2416
+ <span class="md-ellipsis">
2417
+
2418
+
2419
+ MCP Server
2420
+
2421
+
2422
+
2423
+ </span>
2424
+
2425
+
2426
+
2427
+ </a>
2428
+ </li>
2429
+
2430
+
2431
+
2432
+
2433
+
2434
+
2435
+
2436
+
2437
+
2438
+
2439
+ <li class="md-nav__item">
2440
+ <a href="../../../examples/rails-application/" class="md-nav__link">
2441
+
2442
+
2443
+
2444
+ <span class="md-ellipsis">
2445
+
2446
+
2447
+ Rails Application
2448
+
2449
+
2450
+
2451
+ </span>
2452
+
2453
+
2454
+
2455
+ </a>
2456
+ </li>
2457
+
2458
+
2459
+
2460
+
2461
+ </ul>
2462
+ </nav>
2463
+
2464
+ </li>
2465
+
2466
+
2467
+
2468
+ </ul>
2469
+ </nav>
2470
+ </div>
2471
+ </div>
2472
+ </div>
2473
+
2474
+
2475
+
2476
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
2477
+ <div class="md-sidebar__scrollwrap">
2478
+ <div class="md-sidebar__inner">
2479
+
2480
+
2481
+
2482
+
2483
+ <nav class="md-nav md-nav--secondary" aria-label="On this page">
2484
+
2485
+
2486
+
2487
+
2488
+
2489
+
2490
+ <label class="md-nav__title" for="__toc">
2491
+ <span class="md-nav__icon md-icon"></span>
2492
+ On this page
2493
+ </label>
2494
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
2495
+
2496
+ <li class="md-nav__item">
2497
+ <a href="#class-robotlabtextmessage" class="md-nav__link">
2498
+ <span class="md-ellipsis">
2499
+
2500
+ Class: RobotLab::TextMessage
2501
+
2502
+ </span>
2503
+ </a>
2504
+
2505
+ </li>
2506
+
2507
+ <li class="md-nav__item">
2508
+ <a href="#constructor" class="md-nav__link">
2509
+ <span class="md-ellipsis">
2510
+
2511
+ Constructor
2512
+
2513
+ </span>
2514
+ </a>
2515
+
2516
+ </li>
2517
+
2518
+ <li class="md-nav__item">
2519
+ <a href="#attributes" class="md-nav__link">
2520
+ <span class="md-ellipsis">
2521
+
2522
+ Attributes
2523
+
2524
+ </span>
2525
+ </a>
2526
+
2527
+ <nav class="md-nav" aria-label="Attributes">
2528
+ <ul class="md-nav__list">
2529
+
2530
+ <li class="md-nav__item">
2531
+ <a href="#content" class="md-nav__link">
2532
+ <span class="md-ellipsis">
2533
+
2534
+ content
2535
+
2536
+ </span>
2537
+ </a>
2538
+
2539
+ </li>
2540
+
2541
+ <li class="md-nav__item">
2542
+ <a href="#role" class="md-nav__link">
2543
+ <span class="md-ellipsis">
2544
+
2545
+ role
2546
+
2547
+ </span>
2548
+ </a>
2549
+
2550
+ </li>
2551
+
2552
+ <li class="md-nav__item">
2553
+ <a href="#type" class="md-nav__link">
2554
+ <span class="md-ellipsis">
2555
+
2556
+ type
2557
+
2558
+ </span>
2559
+ </a>
2560
+
2561
+ </li>
2562
+
2563
+ <li class="md-nav__item">
2564
+ <a href="#stop_reason" class="md-nav__link">
2565
+ <span class="md-ellipsis">
2566
+
2567
+ stop_reason
2568
+
2569
+ </span>
2570
+ </a>
2571
+
2572
+ </li>
2573
+
2574
+ </ul>
2575
+ </nav>
2576
+
2577
+ </li>
2578
+
2579
+ <li class="md-nav__item">
2580
+ <a href="#methods" class="md-nav__link">
2581
+ <span class="md-ellipsis">
2582
+
2583
+ Methods
2584
+
2585
+ </span>
2586
+ </a>
2587
+
2588
+ <nav class="md-nav" aria-label="Methods">
2589
+ <ul class="md-nav__list">
2590
+
2591
+ <li class="md-nav__item">
2592
+ <a href="#to_h" class="md-nav__link">
2593
+ <span class="md-ellipsis">
2594
+
2595
+ to_h
2596
+
2597
+ </span>
2598
+ </a>
2599
+
2600
+ </li>
2601
+
2602
+ <li class="md-nav__item">
2603
+ <a href="#to_json" class="md-nav__link">
2604
+ <span class="md-ellipsis">
2605
+
2606
+ to_json
2607
+
2608
+ </span>
2609
+ </a>
2610
+
2611
+ </li>
2612
+
2613
+ <li class="md-nav__item">
2614
+ <a href="#predicates" class="md-nav__link">
2615
+ <span class="md-ellipsis">
2616
+
2617
+ Predicates
2618
+
2619
+ </span>
2620
+ </a>
2621
+
2622
+ </li>
2623
+
2624
+ </ul>
2625
+ </nav>
2626
+
2627
+ </li>
2628
+
2629
+ <li class="md-nav__item">
2630
+ <a href="#examples" class="md-nav__link">
2631
+ <span class="md-ellipsis">
2632
+
2633
+ Examples
2634
+
2635
+ </span>
2636
+ </a>
2637
+
2638
+ <nav class="md-nav" aria-label="Examples">
2639
+ <ul class="md-nav__list">
2640
+
2641
+ <li class="md-nav__item">
2642
+ <a href="#system-message" class="md-nav__link">
2643
+ <span class="md-ellipsis">
2644
+
2645
+ System Message
2646
+
2647
+ </span>
2648
+ </a>
2649
+
2650
+ </li>
2651
+
2652
+ <li class="md-nav__item">
2653
+ <a href="#user-message" class="md-nav__link">
2654
+ <span class="md-ellipsis">
2655
+
2656
+ User Message
2657
+
2658
+ </span>
2659
+ </a>
2660
+
2661
+ </li>
2662
+
2663
+ <li class="md-nav__item">
2664
+ <a href="#assistant-response" class="md-nav__link">
2665
+ <span class="md-ellipsis">
2666
+
2667
+ Assistant Response
2668
+
2669
+ </span>
2670
+ </a>
2671
+
2672
+ </li>
2673
+
2674
+ <li class="md-nav__item">
2675
+ <a href="#in-robot-results" class="md-nav__link">
2676
+ <span class="md-ellipsis">
2677
+
2678
+ In Robot Results
2679
+
2680
+ </span>
2681
+ </a>
2682
+
2683
+ </li>
2684
+
2685
+ <li class="md-nav__item">
2686
+ <a href="#filtering-text-content" class="md-nav__link">
2687
+ <span class="md-ellipsis">
2688
+
2689
+ Filtering Text Content
2690
+
2691
+ </span>
2692
+ </a>
2693
+
2694
+ </li>
2695
+
2696
+ </ul>
2697
+ </nav>
2698
+
2699
+ </li>
2700
+
2701
+ <li class="md-nav__item">
2702
+ <a href="#see-also" class="md-nav__link">
2703
+ <span class="md-ellipsis">
2704
+
2705
+ See Also
2706
+
2707
+ </span>
2708
+ </a>
2709
+
2710
+ </li>
2711
+
2712
+ </ul>
2713
+
2714
+ </nav>
2715
+ </div>
2716
+ </div>
2717
+ </div>
2718
+
2719
+
2720
+
2721
+ <div class="md-content" data-md-component="content">
2722
+
2723
+
2724
+
2725
+
2726
+
2727
+
2728
+ <nav class="md-path" aria-label="Navigation" >
2729
+ <ol class="md-path__list">
2730
+
2731
+
2732
+
2733
+
2734
+
2735
+
2736
+
2737
+ <li class="md-path__item">
2738
+ <a href="../../" class="md-path__link">
2739
+
2740
+ <span class="md-ellipsis">
2741
+ API Reference
2742
+ </span>
2743
+
2744
+ </a>
2745
+ </li>
2746
+
2747
+
2748
+
2749
+
2750
+
2751
+
2752
+
2753
+
2754
+
2755
+ <li class="md-path__item">
2756
+ <a href="../" class="md-path__link">
2757
+
2758
+ <span class="md-ellipsis">
2759
+ Messages
2760
+ </span>
2761
+
2762
+ </a>
2763
+ </li>
2764
+
2765
+
2766
+
2767
+
2768
+ </ol>
2769
+ </nav>
2770
+
2771
+
2772
+ <article class="md-content__inner md-typeset">
2773
+
2774
+
2775
+
2776
+
2777
+
2778
+ <a href="https://github.com/madbomber/robot_lab/edit/main/docs/api/messages/text-message.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
2779
+
2780
+ <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>
2781
+ </a>
2782
+
2783
+
2784
+
2785
+
2786
+
2787
+ <a href="https://github.com/madbomber/robot_lab/raw/main/docs/api/messages/text-message.md" title="View source of this page" class="md-content__button md-icon">
2788
+
2789
+ <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>
2790
+ </a>
2791
+
2792
+
2793
+
2794
+ <h1 id="textmessage">TextMessage<a class="headerlink" href="#textmessage" title="Permanent link">&para;</a></h1>
2795
+ <p>Text message from system, user, or assistant.</p>
2796
+ <h2 id="class-robotlabtextmessage">Class: <code>RobotLab::TextMessage</code><a class="headerlink" href="#class-robotlabtextmessage" title="Permanent link">&para;</a></h2>
2797
+ <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">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">TextMessage</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">role</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;assistant&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="s2">&quot;Hello! How can I help you today?&quot;</span><span class="p">)</span>
2798
+ </span></code></pre></div>
2799
+ <h2 id="constructor">Constructor<a class="headerlink" href="#constructor" title="Permanent link">&para;</a></h2>
2800
+ <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="no">TextMessage</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">role</span><span class="p">:,</span><span class="w"> </span><span class="ss">content</span><span class="p">:,</span><span class="w"> </span><span class="ss">stop_reason</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">)</span>
2801
+ </span></code></pre></div>
2802
+ <p><strong>Parameters:</strong></p>
2803
+ <table>
2804
+ <thead>
2805
+ <tr>
2806
+ <th>Name</th>
2807
+ <th>Type</th>
2808
+ <th>Description</th>
2809
+ </tr>
2810
+ </thead>
2811
+ <tbody>
2812
+ <tr>
2813
+ <td><code>role</code></td>
2814
+ <td><code>String</code></td>
2815
+ <td>Message role ("system", "user", or "assistant")</td>
2816
+ </tr>
2817
+ <tr>
2818
+ <td><code>content</code></td>
2819
+ <td><code>String</code></td>
2820
+ <td>The text content</td>
2821
+ </tr>
2822
+ <tr>
2823
+ <td><code>stop_reason</code></td>
2824
+ <td><code>String</code>, <code>nil</code></td>
2825
+ <td>Stop reason ("stop" or "tool")</td>
2826
+ </tr>
2827
+ </tbody>
2828
+ </table>
2829
+ <h2 id="attributes">Attributes<a class="headerlink" href="#attributes" title="Permanent link">&para;</a></h2>
2830
+ <h3 id="content">content<a class="headerlink" href="#content" title="Permanent link">&para;</a></h3>
2831
+ <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">message</span><span class="o">.</span><span class="n">content</span><span class="w"> </span><span class="c1"># =&gt; String</span>
2832
+ </span></code></pre></div>
2833
+ <p>The text content.</p>
2834
+ <h3 id="role">role<a class="headerlink" href="#role" title="Permanent link">&para;</a></h3>
2835
+ <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">message</span><span class="o">.</span><span class="n">role</span><span class="w"> </span><span class="c1"># =&gt; &quot;assistant&quot;</span>
2836
+ </span></code></pre></div>
2837
+ <p>Returns a String: <code>"system"</code>, <code>"user"</code>, or <code>"assistant"</code>.</p>
2838
+ <h3 id="type">type<a class="headerlink" href="#type" title="Permanent link">&para;</a></h3>
2839
+ <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">message</span><span class="o">.</span><span class="n">type</span><span class="w"> </span><span class="c1"># =&gt; &quot;text&quot;</span>
2840
+ </span></code></pre></div>
2841
+ <p>Always returns <code>"text"</code>.</p>
2842
+ <h3 id="stop_reason">stop_reason<a class="headerlink" href="#stop_reason" title="Permanent link">&para;</a></h3>
2843
+ <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">message</span><span class="o">.</span><span class="n">stop_reason</span><span class="w"> </span><span class="c1"># =&gt; &quot;stop&quot; or nil</span>
2844
+ </span></code></pre></div>
2845
+ <p>The stop reason, if any.</p>
2846
+ <h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">&para;</a></h2>
2847
+ <h3 id="to_h">to_h<a class="headerlink" href="#to_h" title="Permanent link">&para;</a></h3>
2848
+ <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">message</span><span class="o">.</span><span class="n">to_h</span><span class="w"> </span><span class="c1"># =&gt; Hash</span>
2849
+ </span></code></pre></div>
2850
+ <p>Hash representation.</p>
2851
+ <p><strong>Returns:</strong></p>
2852
+ <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="p">{</span>
2853
+ </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="ss">type</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;text&quot;</span><span class="p">,</span>
2854
+ </span><span id="__span-7-3"><a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="ss">role</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;assistant&quot;</span><span class="p">,</span>
2855
+ </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="ss">content</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Hello! How can I help you today?&quot;</span><span class="p">,</span>
2856
+ </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">stop_reason</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;stop&quot;</span>
2857
+ </span><span id="__span-7-6"><a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="p">}</span>
2858
+ </span></code></pre></div>
2859
+ <h3 id="to_json">to_json<a class="headerlink" href="#to_json" title="Permanent link">&para;</a></h3>
2860
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-8-1"><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="n">message</span><span class="o">.</span><span class="n">to_json</span><span class="w"> </span><span class="c1"># =&gt; String</span>
2861
+ </span></code></pre></div>
2862
+ <p>JSON representation.</p>
2863
+ <h3 id="predicates">Predicates<a class="headerlink" href="#predicates" title="Permanent link">&para;</a></h3>
2864
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-9-1"><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="n">message</span><span class="o">.</span><span class="n">text?</span><span class="w"> </span><span class="c1"># =&gt; true</span>
2865
+ </span><span id="__span-9-2"><a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="n">message</span><span class="o">.</span><span class="n">tool_call?</span><span class="w"> </span><span class="c1"># =&gt; false</span>
2866
+ </span><span id="__span-9-3"><a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="n">message</span><span class="o">.</span><span class="n">assistant?</span><span class="w"> </span><span class="c1"># =&gt; true (if role is &quot;assistant&quot;)</span>
2867
+ </span><span id="__span-9-4"><a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="n">message</span><span class="o">.</span><span class="n">user?</span><span class="w"> </span><span class="c1"># =&gt; false</span>
2868
+ </span><span id="__span-9-5"><a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="n">message</span><span class="o">.</span><span class="n">stopped?</span><span class="w"> </span><span class="c1"># =&gt; true (if stop_reason is &quot;stop&quot;)</span>
2869
+ </span></code></pre></div>
2870
+ <h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">&para;</a></h2>
2871
+ <h3 id="system-message">System Message<a class="headerlink" href="#system-message" title="Permanent link">&para;</a></h3>
2872
+ <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="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">TextMessage</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">role</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;system&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="s2">&quot;You are a helpful assistant&quot;</span><span class="p">)</span>
2873
+ </span><span id="__span-10-2"><a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="n">message</span><span class="o">.</span><span class="n">system?</span><span class="w"> </span><span class="c1"># =&gt; true</span>
2874
+ </span></code></pre></div>
2875
+ <h3 id="user-message">User Message<a class="headerlink" href="#user-message" title="Permanent link">&para;</a></h3>
2876
+ <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="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">TextMessage</span><span class="o">.</span><span class="n">new</span><span class="p">(</span><span class="ss">role</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;user&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="s2">&quot;What&#39;s the weather?&quot;</span><span class="p">)</span>
2877
+ </span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="n">message</span><span class="o">.</span><span class="n">user?</span><span class="w"> </span><span class="c1"># =&gt; true</span>
2878
+ </span></code></pre></div>
2879
+ <h3 id="assistant-response">Assistant Response<a class="headerlink" href="#assistant-response" title="Permanent link">&para;</a></h3>
2880
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-12-1"><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a><span class="n">message</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">TextMessage</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
2881
+ </span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span><span class="ss">role</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;assistant&quot;</span><span class="p">,</span>
2882
+ </span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="w"> </span><span class="ss">content</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;Your order has shipped!&quot;</span><span class="p">,</span>
2883
+ </span><span id="__span-12-4"><a id="__codelineno-12-4" name="__codelineno-12-4" href="#__codelineno-12-4"></a><span class="w"> </span><span class="ss">stop_reason</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;stop&quot;</span>
2884
+ </span><span id="__span-12-5"><a id="__codelineno-12-5" name="__codelineno-12-5" href="#__codelineno-12-5"></a><span class="p">)</span>
2885
+ </span><span id="__span-12-6"><a id="__codelineno-12-6" name="__codelineno-12-6" href="#__codelineno-12-6"></a><span class="n">message</span><span class="o">.</span><span class="n">assistant?</span><span class="w"> </span><span class="c1"># =&gt; true</span>
2886
+ </span><span id="__span-12-7"><a id="__codelineno-12-7" name="__codelineno-12-7" href="#__codelineno-12-7"></a><span class="n">message</span><span class="o">.</span><span class="n">stopped?</span><span class="w"> </span><span class="c1"># =&gt; true</span>
2887
+ </span></code></pre></div>
2888
+ <h3 id="in-robot-results">In Robot Results<a class="headerlink" href="#in-robot-results" title="Permanent link">&para;</a></h3>
2889
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-13-1"><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">robot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">&quot;Tell me a joke&quot;</span><span class="p">)</span>
2890
+ </span><span id="__span-13-2"><a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>
2891
+ </span><span id="__span-13-3"><a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="c1"># The result is a TextMessage when the assistant replies with text</span>
2892
+ </span><span id="__span-13-4"><a id="__codelineno-13-4" name="__codelineno-13-4" href="#__codelineno-13-4"></a><span class="k">if</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">text?</span>
2893
+ </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="nb">puts</span><span class="w"> </span><span class="n">result</span><span class="o">.</span><span class="n">content</span>
2894
+ </span><span id="__span-13-6"><a id="__codelineno-13-6" name="__codelineno-13-6" href="#__codelineno-13-6"></a><span class="k">end</span>
2895
+ </span></code></pre></div>
2896
+ <h3 id="filtering-text-content">Filtering Text Content<a class="headerlink" href="#filtering-text-content" title="Permanent link">&para;</a></h3>
2897
+ <div class="language-ruby highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="c1"># Get only text messages from memory</span>
2898
+ </span><span id="__span-14-2"><a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a><span class="n">text_messages</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">memory</span><span class="o">.</span><span class="n">messages</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:text?</span><span class="p">)</span><span class="o">.</span><span class="n">map</span><span class="p">(</span><span class="o">&amp;</span><span class="ss">:content</span><span class="p">)</span>
2899
+ </span></code></pre></div>
2900
+ <h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
2901
+ <ul>
2902
+ <li><a href="../user-message/">UserMessage</a></li>
2903
+ <li><a href="../tool-call-message/">ToolCallMessage</a></li>
2904
+ <li><a href="../../core/robot/">Robot</a></li>
2905
+ </ul>
2906
+
2907
+
2908
+
2909
+
2910
+
2911
+
2912
+
2913
+
2914
+
2915
+
2916
+
2917
+
2918
+
2919
+ <form class="md-feedback" name="feedback" hidden>
2920
+ <fieldset>
2921
+ <legend class="md-feedback__title">
2922
+ Was this page helpful?
2923
+ </legend>
2924
+ <div class="md-feedback__inner">
2925
+ <div class="md-feedback__list">
2926
+
2927
+ <button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
2928
+ <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>
2929
+ </button>
2930
+
2931
+ <button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
2932
+ <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>
2933
+ </button>
2934
+
2935
+ </div>
2936
+ <div class="md-feedback__note">
2937
+
2938
+ <div data-md-value="1" hidden>
2939
+
2940
+
2941
+
2942
+
2943
+
2944
+
2945
+
2946
+
2947
+
2948
+ Thanks for your feedback!
2949
+ </div>
2950
+
2951
+ <div data-md-value="0" hidden>
2952
+
2953
+
2954
+
2955
+
2956
+
2957
+
2958
+
2959
+
2960
+
2961
+ Thanks for your feedback! Help us improve by creating an issue.
2962
+ </div>
2963
+
2964
+ </div>
2965
+ </div>
2966
+ </fieldset>
2967
+ </form>
2968
+
2969
+
2970
+
2971
+ </article>
2972
+ </div>
2973
+
2974
+
2975
+ <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>
2976
+
2977
+ <script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
2978
+ </div>
2979
+
2980
+ <button type="button" class="md-top md-icon" data-md-component="top" hidden>
2981
+
2982
+ <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>
2983
+ Back to top
2984
+ </button>
2985
+
2986
+ </main>
2987
+
2988
+ <footer class="md-footer">
2989
+
2990
+
2991
+
2992
+ <nav class="md-footer__inner md-grid" aria-label="Footer" >
2993
+
2994
+
2995
+ <a href="../user-message/" class="md-footer__link md-footer__link--prev" aria-label="Previous: UserMessage">
2996
+ <div class="md-footer__button md-icon">
2997
+
2998
+ <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>
2999
+ </div>
3000
+ <div class="md-footer__title">
3001
+ <span class="md-footer__direction">
3002
+ Previous
3003
+ </span>
3004
+ <div class="md-ellipsis">
3005
+ UserMessage
3006
+ </div>
3007
+ </div>
3008
+ </a>
3009
+
3010
+
3011
+
3012
+ <a href="../tool-call-message/" class="md-footer__link md-footer__link--next" aria-label="Next: ToolCallMessage">
3013
+ <div class="md-footer__title">
3014
+ <span class="md-footer__direction">
3015
+ Next
3016
+ </span>
3017
+ <div class="md-ellipsis">
3018
+ ToolCallMessage
3019
+ </div>
3020
+ </div>
3021
+ <div class="md-footer__button md-icon">
3022
+
3023
+ <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>
3024
+ </div>
3025
+ </a>
3026
+
3027
+ </nav>
3028
+
3029
+
3030
+ <div class="md-footer-meta md-typeset">
3031
+ <div class="md-footer-meta__inner md-grid">
3032
+ <div class="md-copyright">
3033
+
3034
+ <div class="md-copyright__highlight">
3035
+ Copyright &copy; 2025 Dewayne VanHoozer
3036
+ </div>
3037
+
3038
+
3039
+ Made with
3040
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
3041
+ Material for MkDocs
3042
+ </a>
3043
+
3044
+ </div>
3045
+
3046
+
3047
+ <div class="md-social">
3048
+
3049
+
3050
+
3051
+
3052
+
3053
+ <a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
3054
+ <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>
3055
+ </a>
3056
+
3057
+
3058
+
3059
+
3060
+
3061
+ <a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
3062
+ <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>
3063
+ </a>
3064
+
3065
+ </div>
3066
+
3067
+ </div>
3068
+ </div>
3069
+ </footer>
3070
+
3071
+ </div>
3072
+ <div class="md-dialog" data-md-component="dialog">
3073
+ <div class="md-dialog__inner md-typeset"></div>
3074
+ </div>
3075
+
3076
+
3077
+
3078
+
3079
+
3080
+ <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>
3081
+
3082
+
3083
+ <script src="../../../assets/javascripts/bundle.79ae519e.min.js"></script>
3084
+
3085
+
3086
+ </body>
3087
+ </html>