robot_lab 0.1.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.architecture/AGENTS.md +32 -0
- data/.architecture/config.yml +8 -0
- data/.architecture/members.yml +60 -0
- data/.architecture/reviews/feature-free-will.md +490 -0
- data/.architecture/reviews/overall-codebase.md +427 -0
- data/.claude/settings.local.json +57 -0
- data/.codex/config.toml +2 -0
- data/.irbrc +2 -2
- data/.rubocop.yml +172 -0
- data/CHANGELOG.md +72 -0
- data/CLAUDE.md +139 -0
- data/README.md +91 -95
- data/Rakefile +109 -3
- data/agent2agent_review.md +192 -0
- data/agentf_improvements.md +253 -0
- data/agents.md +14 -0
- data/docs/examples/index.md +37 -2
- data/docs/getting-started/configuration.md +20 -7
- data/docs/guides/index.md +16 -16
- data/docs/guides/knowledge.md +7 -1
- data/docs/guides/observability.md +132 -0
- data/docs/index.md +30 -3
- data/docs/superpowers/plans/2026-05-06-agentskills.md +1303 -0
- data/docs/superpowers/specs/2026-05-06-agentskills-design.md +247 -0
- data/examples/.envrc +1 -0
- data/examples/01_simple_robot.rb +5 -9
- data/examples/02_tools.rb +5 -9
- data/examples/03_network.rb +8 -9
- data/examples/04_mcp.rb +21 -29
- data/examples/05_streaming.rb +12 -18
- data/examples/06_prompt_templates.rb +11 -19
- data/examples/07_network_memory.rb +16 -31
- data/examples/08_llm_config.rb +10 -22
- data/examples/09_chaining.rb +16 -27
- data/examples/10_memory.rb +12 -28
- data/examples/11_network_introspection.rb +15 -29
- data/examples/12_message_bus.rb +5 -12
- data/examples/13_spawn.rb +5 -10
- data/examples/14_rusty_circuit/.envrc +1 -0
- data/examples/14_rusty_circuit/comic.rb +2 -0
- data/examples/14_rusty_circuit/heckler.rb +1 -1
- data/examples/14_rusty_circuit/open_mic.rb +1 -3
- data/examples/14_rusty_circuit/scout.rb +2 -0
- data/examples/15_memory_network_and_bus/.envrc +1 -0
- data/examples/15_memory_network_and_bus/editorial_pipeline.rb +6 -3
- data/examples/15_memory_network_and_bus/linux_writer.rb +1 -1
- data/examples/15_memory_network_and_bus/output/combined_article.md +6 -6
- data/examples/15_memory_network_and_bus/output/final_article.md +6 -8
- data/examples/15_memory_network_and_bus/output/linux_draft.md +4 -2
- data/examples/15_memory_network_and_bus/output/mac_draft.md +3 -3
- data/examples/15_memory_network_and_bus/output/memory.json +6 -6
- data/examples/15_memory_network_and_bus/output/revision_1.md +10 -11
- data/examples/15_memory_network_and_bus/output/revision_2.md +6 -8
- data/examples/15_memory_network_and_bus/output/windows_draft.md +3 -3
- data/examples/16_writers_room/.envrc +1 -0
- data/examples/16_writers_room/writers_room.rb +2 -4
- data/examples/17_skills.rb +8 -17
- data/examples/18_rails/Gemfile +1 -0
- data/examples/19_token_tracking.rb +9 -15
- data/examples/20_circuit_breaker.rb +10 -19
- data/examples/21_learning_loop.rb +11 -20
- data/examples/22_context_compression.rb +6 -13
- data/examples/23_convergence.rb +6 -17
- data/examples/24_structured_delegation.rb +11 -15
- data/examples/25_history_search.rb +5 -12
- data/examples/26_document_store.rb +6 -13
- data/examples/27_incident_response/incident_response.rb +4 -5
- data/examples/28_mcp_discovery.rb +8 -11
- data/examples/29_ractor_tools.rb +4 -9
- data/examples/30_ractor_network.rb +10 -19
- data/examples/31_launch_assessment.rb +10 -23
- data/examples/32_newsletter_reader.rb +188 -0
- data/examples/33_stock_generator.rb +80 -0
- data/examples/33_stock_predictor.rb +306 -0
- data/examples/34_agentskills.rb +72 -0
- data/examples/README.md +1 -1
- data/examples/common.rb +76 -0
- data/examples/ruboruby.md +423 -0
- data/examples/temp.md +51 -0
- data/lib/robot_lab/agent_skill.rb +63 -0
- data/lib/robot_lab/agent_skill_catalog.rb +74 -0
- data/lib/robot_lab/ask_user.rb +2 -2
- data/lib/robot_lab/bus_poller.rb +12 -5
- data/lib/robot_lab/config.rb +1 -12
- data/lib/robot_lab/delegation_future.rb +1 -1
- data/lib/robot_lab/doom_loop_detector.rb +98 -0
- data/lib/robot_lab/history_compressor.rb +4 -10
- data/lib/robot_lab/mcp/client.rb +1 -2
- data/lib/robot_lab/mcp/connection_poller.rb +3 -3
- data/lib/robot_lab/mcp/server.rb +1 -1
- data/lib/robot_lab/mcp/server_discovery.rb +0 -2
- data/lib/robot_lab/memory.rb +32 -27
- data/lib/robot_lab/memory_change.rb +2 -2
- data/lib/robot_lab/message.rb +4 -4
- data/lib/robot_lab/network.rb +11 -6
- data/lib/robot_lab/robot/agent_skill_matching.rb +99 -0
- data/lib/robot_lab/robot/bus_messaging.rb +9 -27
- data/lib/robot_lab/robot/history_search.rb +4 -1
- data/lib/robot_lab/robot/mcp_management.rb +5 -11
- data/lib/robot_lab/robot/template_rendering.rb +60 -40
- data/lib/robot_lab/robot.rb +323 -206
- data/lib/robot_lab/robot_result.rb +6 -5
- data/lib/robot_lab/run_config.rb +5 -11
- data/lib/robot_lab/script_tool.rb +76 -0
- data/lib/robot_lab/state_proxy.rb +7 -5
- data/lib/robot_lab/tool.rb +3 -3
- data/lib/robot_lab/tool_config.rb +1 -1
- data/lib/robot_lab/tool_manifest.rb +5 -7
- data/lib/robot_lab/user_message.rb +2 -2
- data/lib/robot_lab/version.rb +1 -1
- data/lib/robot_lab/waiter.rb +1 -1
- data/lib/robot_lab.rb +41 -52
- data/logfile +8 -0
- data/mkdocs.yml +2 -3
- data/robot_concurrency.md +38 -0
- data/simple_acp_review.md +298 -0
- data/site/404.html +2300 -0
- data/site/api/core/index.html +2706 -0
- data/site/api/core/memory/index.html +3793 -0
- data/site/api/core/network/index.html +3500 -0
- data/site/api/core/robot/index.html +4566 -0
- data/site/api/core/state/index.html +3390 -0
- data/site/api/core/tool/index.html +3843 -0
- data/site/api/index.html +2635 -0
- data/site/api/mcp/client/index.html +3435 -0
- data/site/api/mcp/index.html +2783 -0
- data/site/api/mcp/server/index.html +3252 -0
- data/site/api/mcp/transports/index.html +3352 -0
- data/site/api/messages/index.html +2641 -0
- data/site/api/messages/text-message/index.html +3087 -0
- data/site/api/messages/tool-call-message/index.html +3159 -0
- data/site/api/messages/tool-result-message/index.html +3252 -0
- data/site/api/messages/user-message/index.html +3212 -0
- data/site/api/streaming/context/index.html +3282 -0
- data/site/api/streaming/events/index.html +3347 -0
- data/site/api/streaming/index.html +2738 -0
- data/site/architecture/core-concepts/index.html +3757 -0
- data/site/architecture/index.html +2797 -0
- data/site/architecture/message-flow/index.html +3238 -0
- data/site/architecture/network-orchestration/index.html +3433 -0
- data/site/architecture/robot-execution/index.html +3140 -0
- data/site/architecture/state-management/index.html +3498 -0
- data/site/assets/css/custom.css +56 -0
- data/site/assets/images/favicon.png +0 -0
- data/site/assets/images/robot_lab.jpg +0 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js +16 -0
- data/site/assets/javascripts/bundle.79ae519e.min.js.map +7 -0
- data/site/assets/javascripts/lunr/min/lunr.ar.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.da.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.de.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.du.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.el.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.es.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fi.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.fr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.he.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.hu.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.hy.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.it.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ja.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.jp.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.kn.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.ko.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.multi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.nl.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.no.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.pt.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ro.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ru.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.sa.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.sv.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.ta.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.te.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.th.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.tr.min.js +18 -0
- data/site/assets/javascripts/lunr/min/lunr.vi.min.js +1 -0
- data/site/assets/javascripts/lunr/min/lunr.zh.min.js +1 -0
- data/site/assets/javascripts/lunr/tinyseg.js +206 -0
- data/site/assets/javascripts/lunr/wordcut.js +6708 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js +42 -0
- data/site/assets/javascripts/workers/search.2c215733.min.js.map +7 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css +1 -0
- data/site/assets/stylesheets/main.484c7ddc.min.css.map +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css +1 -0
- data/site/assets/stylesheets/palette.ab4e12ef.min.css.map +1 -0
- data/site/concepts/index.html +3455 -0
- data/site/examples/basic-chat/index.html +2880 -0
- data/site/examples/index.html +2907 -0
- data/site/examples/mcp-server/index.html +3018 -0
- data/site/examples/multi-robot-network/index.html +3131 -0
- data/site/examples/rails-application/index.html +3329 -0
- data/site/examples/tool-usage/index.html +3085 -0
- data/site/getting-started/configuration/index.html +3745 -0
- data/site/getting-started/index.html +2572 -0
- data/site/getting-started/installation/index.html +2981 -0
- data/site/getting-started/quick-start/index.html +2942 -0
- data/site/guides/building-robots/index.html +4290 -0
- data/site/guides/creating-networks/index.html +3858 -0
- data/site/guides/index.html +2586 -0
- data/site/guides/mcp-integration/index.html +3581 -0
- data/site/guides/memory/index.html +3586 -0
- data/site/guides/rails-integration/index.html +4019 -0
- data/site/guides/streaming/index.html +3157 -0
- data/site/guides/using-tools/index.html +3802 -0
- data/site/index.html +2671 -0
- data/site/search/search_index.json +1 -0
- data/site/sitemap.xml +183 -0
- data/site/sitemap.xml.gz +0 -0
- data/site/tags.json +1 -0
- data/temp.md +6 -0
- data/tool_manifest_plan.md +155 -0
- metadata +154 -92
- data/docs/examples/rails-application.md +0 -419
- data/docs/guides/ractor-parallelism.md +0 -364
- data/docs/guides/rails-integration.md +0 -681
- data/docs/superpowers/plans/2026-04-14-ractor-integration.md +0 -1538
- data/docs/superpowers/specs/2026-04-14-ractor-integration-design.md +0 -258
- data/lib/generators/robot_lab/install_generator.rb +0 -90
- data/lib/generators/robot_lab/job_generator.rb +0 -40
- data/lib/generators/robot_lab/robot_generator.rb +0 -55
- data/lib/generators/robot_lab/templates/initializer.rb.tt +0 -42
- data/lib/generators/robot_lab/templates/job.rb.tt +0 -21
- data/lib/generators/robot_lab/templates/migration.rb.tt +0 -32
- data/lib/generators/robot_lab/templates/result_model.rb.tt +0 -52
- data/lib/generators/robot_lab/templates/robot.rb.tt +0 -31
- data/lib/generators/robot_lab/templates/robot_job.rb.tt +0 -18
- data/lib/generators/robot_lab/templates/robot_test.rb.tt +0 -34
- data/lib/generators/robot_lab/templates/routing_robot.rb.tt +0 -59
- data/lib/generators/robot_lab/templates/thread_model.rb.tt +0 -40
- data/lib/robot_lab/document_store.rb +0 -155
- data/lib/robot_lab/ractor_boundary.rb +0 -42
- data/lib/robot_lab/ractor_job.rb +0 -37
- data/lib/robot_lab/ractor_memory_proxy.rb +0 -85
- data/lib/robot_lab/ractor_network_scheduler.rb +0 -154
- data/lib/robot_lab/ractor_worker_pool.rb +0 -117
- data/lib/robot_lab/rails_integration/engine.rb +0 -29
- data/lib/robot_lab/rails_integration/job.rb +0 -158
- data/lib/robot_lab/rails_integration/railtie.rb +0 -51
- data/lib/robot_lab/rails_integration/turbo_stream_callbacks.rb +0 -72
|
@@ -0,0 +1,3793 @@
|
|
|
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/core/memory/">
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<link rel="prev" href="../tool/">
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
<link rel="next" href="../../messages/">
|
|
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>Memory - 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="#memory" 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
|
+
Memory
|
|
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
|
+
|
|
1291
|
+
|
|
1292
|
+
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
|
|
1296
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_2" checked>
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
<div class="md-nav__link md-nav__container">
|
|
1300
|
+
<a href="../" class="md-nav__link ">
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
<span class="md-ellipsis">
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
Core Classes
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
</span>
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
</a>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<label class="md-nav__link " for="__nav_5_2" id="__nav_5_2_label" tabindex="0">
|
|
1319
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1320
|
+
</label>
|
|
1321
|
+
|
|
1322
|
+
</div>
|
|
1323
|
+
|
|
1324
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_2_label" aria-expanded="true">
|
|
1325
|
+
<label class="md-nav__title" for="__nav_5_2">
|
|
1326
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
Core Classes
|
|
1330
|
+
|
|
1331
|
+
|
|
1332
|
+
</label>
|
|
1333
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
<li class="md-nav__item">
|
|
1344
|
+
<a href="../robot/" class="md-nav__link">
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
<span class="md-ellipsis">
|
|
1349
|
+
|
|
1350
|
+
|
|
1351
|
+
Robot
|
|
1352
|
+
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
</span>
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
</a>
|
|
1360
|
+
</li>
|
|
1361
|
+
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
<li class="md-nav__item">
|
|
1372
|
+
<a href="../network/" class="md-nav__link">
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
|
|
1376
|
+
<span class="md-ellipsis">
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
Network
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
</span>
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
</a>
|
|
1388
|
+
</li>
|
|
1389
|
+
|
|
1390
|
+
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
<li class="md-nav__item">
|
|
1400
|
+
<a href="../state/" class="md-nav__link">
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
<span class="md-ellipsis">
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
State
|
|
1408
|
+
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
</span>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
</a>
|
|
1416
|
+
</li>
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
<li class="md-nav__item">
|
|
1428
|
+
<a href="../tool/" class="md-nav__link">
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<span class="md-ellipsis">
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
Tool
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
</span>
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
</a>
|
|
1444
|
+
</li>
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
<li class="md-nav__item md-nav__item--active">
|
|
1458
|
+
|
|
1459
|
+
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
|
|
1460
|
+
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
|
|
1469
|
+
<span class="md-ellipsis">
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
Memory
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
</span>
|
|
1477
|
+
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1481
|
+
</label>
|
|
1482
|
+
|
|
1483
|
+
<a href="./" class="md-nav__link md-nav__link--active">
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
<span class="md-ellipsis">
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
Memory
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
</span>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
</a>
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<label class="md-nav__title" for="__toc">
|
|
1512
|
+
<span class="md-nav__icon md-icon"></span>
|
|
1513
|
+
On this page
|
|
1514
|
+
</label>
|
|
1515
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
1516
|
+
|
|
1517
|
+
<li class="md-nav__item">
|
|
1518
|
+
<a href="#class-robotlabmemory" class="md-nav__link">
|
|
1519
|
+
<span class="md-ellipsis">
|
|
1520
|
+
|
|
1521
|
+
Class: RobotLab::Memory
|
|
1522
|
+
|
|
1523
|
+
</span>
|
|
1524
|
+
</a>
|
|
1525
|
+
|
|
1526
|
+
</li>
|
|
1527
|
+
|
|
1528
|
+
<li class="md-nav__item">
|
|
1529
|
+
<a href="#constants" class="md-nav__link">
|
|
1530
|
+
<span class="md-ellipsis">
|
|
1531
|
+
|
|
1532
|
+
Constants
|
|
1533
|
+
|
|
1534
|
+
</span>
|
|
1535
|
+
</a>
|
|
1536
|
+
|
|
1537
|
+
<nav class="md-nav" aria-label="Constants">
|
|
1538
|
+
<ul class="md-nav__list">
|
|
1539
|
+
|
|
1540
|
+
<li class="md-nav__item">
|
|
1541
|
+
<a href="#reserved_keys" class="md-nav__link">
|
|
1542
|
+
<span class="md-ellipsis">
|
|
1543
|
+
|
|
1544
|
+
RESERVED_KEYS
|
|
1545
|
+
|
|
1546
|
+
</span>
|
|
1547
|
+
</a>
|
|
1548
|
+
|
|
1549
|
+
</li>
|
|
1550
|
+
|
|
1551
|
+
</ul>
|
|
1552
|
+
</nav>
|
|
1553
|
+
|
|
1554
|
+
</li>
|
|
1555
|
+
|
|
1556
|
+
<li class="md-nav__item">
|
|
1557
|
+
<a href="#constructor" class="md-nav__link">
|
|
1558
|
+
<span class="md-ellipsis">
|
|
1559
|
+
|
|
1560
|
+
Constructor
|
|
1561
|
+
|
|
1562
|
+
</span>
|
|
1563
|
+
</a>
|
|
1564
|
+
|
|
1565
|
+
</li>
|
|
1566
|
+
|
|
1567
|
+
<li class="md-nav__item">
|
|
1568
|
+
<a href="#factory-method" class="md-nav__link">
|
|
1569
|
+
<span class="md-ellipsis">
|
|
1570
|
+
|
|
1571
|
+
Factory Method
|
|
1572
|
+
|
|
1573
|
+
</span>
|
|
1574
|
+
</a>
|
|
1575
|
+
|
|
1576
|
+
</li>
|
|
1577
|
+
|
|
1578
|
+
<li class="md-nav__item">
|
|
1579
|
+
<a href="#methods" class="md-nav__link">
|
|
1580
|
+
<span class="md-ellipsis">
|
|
1581
|
+
|
|
1582
|
+
Methods
|
|
1583
|
+
|
|
1584
|
+
</span>
|
|
1585
|
+
</a>
|
|
1586
|
+
|
|
1587
|
+
<nav class="md-nav" aria-label="Methods">
|
|
1588
|
+
<ul class="md-nav__list">
|
|
1589
|
+
|
|
1590
|
+
<li class="md-nav__item">
|
|
1591
|
+
<a href="#set" class="md-nav__link">
|
|
1592
|
+
<span class="md-ellipsis">
|
|
1593
|
+
|
|
1594
|
+
set
|
|
1595
|
+
|
|
1596
|
+
</span>
|
|
1597
|
+
</a>
|
|
1598
|
+
|
|
1599
|
+
</li>
|
|
1600
|
+
|
|
1601
|
+
<li class="md-nav__item">
|
|
1602
|
+
<a href="#get" class="md-nav__link">
|
|
1603
|
+
<span class="md-ellipsis">
|
|
1604
|
+
|
|
1605
|
+
get
|
|
1606
|
+
|
|
1607
|
+
</span>
|
|
1608
|
+
</a>
|
|
1609
|
+
|
|
1610
|
+
</li>
|
|
1611
|
+
|
|
1612
|
+
<li class="md-nav__item">
|
|
1613
|
+
<a href="#key" class="md-nav__link">
|
|
1614
|
+
<span class="md-ellipsis">
|
|
1615
|
+
|
|
1616
|
+
key?
|
|
1617
|
+
|
|
1618
|
+
</span>
|
|
1619
|
+
</a>
|
|
1620
|
+
|
|
1621
|
+
</li>
|
|
1622
|
+
|
|
1623
|
+
<li class="md-nav__item">
|
|
1624
|
+
<a href="#delete" class="md-nav__link">
|
|
1625
|
+
<span class="md-ellipsis">
|
|
1626
|
+
|
|
1627
|
+
delete
|
|
1628
|
+
|
|
1629
|
+
</span>
|
|
1630
|
+
</a>
|
|
1631
|
+
|
|
1632
|
+
</li>
|
|
1633
|
+
|
|
1634
|
+
<li class="md-nav__item">
|
|
1635
|
+
<a href="#keys" class="md-nav__link">
|
|
1636
|
+
<span class="md-ellipsis">
|
|
1637
|
+
|
|
1638
|
+
keys
|
|
1639
|
+
|
|
1640
|
+
</span>
|
|
1641
|
+
</a>
|
|
1642
|
+
|
|
1643
|
+
</li>
|
|
1644
|
+
|
|
1645
|
+
<li class="md-nav__item">
|
|
1646
|
+
<a href="#clear" class="md-nav__link">
|
|
1647
|
+
<span class="md-ellipsis">
|
|
1648
|
+
|
|
1649
|
+
clear
|
|
1650
|
+
|
|
1651
|
+
</span>
|
|
1652
|
+
</a>
|
|
1653
|
+
|
|
1654
|
+
</li>
|
|
1655
|
+
|
|
1656
|
+
<li class="md-nav__item">
|
|
1657
|
+
<a href="#reset" class="md-nav__link">
|
|
1658
|
+
<span class="md-ellipsis">
|
|
1659
|
+
|
|
1660
|
+
reset
|
|
1661
|
+
|
|
1662
|
+
</span>
|
|
1663
|
+
</a>
|
|
1664
|
+
|
|
1665
|
+
</li>
|
|
1666
|
+
|
|
1667
|
+
<li class="md-nav__item">
|
|
1668
|
+
<a href="#subscribe" class="md-nav__link">
|
|
1669
|
+
<span class="md-ellipsis">
|
|
1670
|
+
|
|
1671
|
+
subscribe
|
|
1672
|
+
|
|
1673
|
+
</span>
|
|
1674
|
+
</a>
|
|
1675
|
+
|
|
1676
|
+
</li>
|
|
1677
|
+
|
|
1678
|
+
<li class="md-nav__item">
|
|
1679
|
+
<a href="#subscribe_pattern" class="md-nav__link">
|
|
1680
|
+
<span class="md-ellipsis">
|
|
1681
|
+
|
|
1682
|
+
subscribe_pattern
|
|
1683
|
+
|
|
1684
|
+
</span>
|
|
1685
|
+
</a>
|
|
1686
|
+
|
|
1687
|
+
</li>
|
|
1688
|
+
|
|
1689
|
+
<li class="md-nav__item">
|
|
1690
|
+
<a href="#unsubscribe" class="md-nav__link">
|
|
1691
|
+
<span class="md-ellipsis">
|
|
1692
|
+
|
|
1693
|
+
unsubscribe
|
|
1694
|
+
|
|
1695
|
+
</span>
|
|
1696
|
+
</a>
|
|
1697
|
+
|
|
1698
|
+
</li>
|
|
1699
|
+
|
|
1700
|
+
<li class="md-nav__item">
|
|
1701
|
+
<a href="#merge" class="md-nav__link">
|
|
1702
|
+
<span class="md-ellipsis">
|
|
1703
|
+
|
|
1704
|
+
merge!
|
|
1705
|
+
|
|
1706
|
+
</span>
|
|
1707
|
+
</a>
|
|
1708
|
+
|
|
1709
|
+
</li>
|
|
1710
|
+
|
|
1711
|
+
</ul>
|
|
1712
|
+
</nav>
|
|
1713
|
+
|
|
1714
|
+
</li>
|
|
1715
|
+
|
|
1716
|
+
<li class="md-nav__item">
|
|
1717
|
+
<a href="#reserved-key-accessors" class="md-nav__link">
|
|
1718
|
+
<span class="md-ellipsis">
|
|
1719
|
+
|
|
1720
|
+
Reserved Key Accessors
|
|
1721
|
+
|
|
1722
|
+
</span>
|
|
1723
|
+
</a>
|
|
1724
|
+
|
|
1725
|
+
<nav class="md-nav" aria-label="Reserved Key Accessors">
|
|
1726
|
+
<ul class="md-nav__list">
|
|
1727
|
+
|
|
1728
|
+
<li class="md-nav__item">
|
|
1729
|
+
<a href="#data" class="md-nav__link">
|
|
1730
|
+
<span class="md-ellipsis">
|
|
1731
|
+
|
|
1732
|
+
data
|
|
1733
|
+
|
|
1734
|
+
</span>
|
|
1735
|
+
</a>
|
|
1736
|
+
|
|
1737
|
+
</li>
|
|
1738
|
+
|
|
1739
|
+
<li class="md-nav__item">
|
|
1740
|
+
<a href="#results" class="md-nav__link">
|
|
1741
|
+
<span class="md-ellipsis">
|
|
1742
|
+
|
|
1743
|
+
results
|
|
1744
|
+
|
|
1745
|
+
</span>
|
|
1746
|
+
</a>
|
|
1747
|
+
|
|
1748
|
+
</li>
|
|
1749
|
+
|
|
1750
|
+
<li class="md-nav__item">
|
|
1751
|
+
<a href="#messages" class="md-nav__link">
|
|
1752
|
+
<span class="md-ellipsis">
|
|
1753
|
+
|
|
1754
|
+
messages
|
|
1755
|
+
|
|
1756
|
+
</span>
|
|
1757
|
+
</a>
|
|
1758
|
+
|
|
1759
|
+
</li>
|
|
1760
|
+
|
|
1761
|
+
<li class="md-nav__item">
|
|
1762
|
+
<a href="#session_id" class="md-nav__link">
|
|
1763
|
+
<span class="md-ellipsis">
|
|
1764
|
+
|
|
1765
|
+
session_id
|
|
1766
|
+
|
|
1767
|
+
</span>
|
|
1768
|
+
</a>
|
|
1769
|
+
|
|
1770
|
+
</li>
|
|
1771
|
+
|
|
1772
|
+
<li class="md-nav__item">
|
|
1773
|
+
<a href="#cache" class="md-nav__link">
|
|
1774
|
+
<span class="md-ellipsis">
|
|
1775
|
+
|
|
1776
|
+
cache
|
|
1777
|
+
|
|
1778
|
+
</span>
|
|
1779
|
+
</a>
|
|
1780
|
+
|
|
1781
|
+
</li>
|
|
1782
|
+
|
|
1783
|
+
</ul>
|
|
1784
|
+
</nav>
|
|
1785
|
+
|
|
1786
|
+
</li>
|
|
1787
|
+
|
|
1788
|
+
<li class="md-nav__item">
|
|
1789
|
+
<a href="#serialization" class="md-nav__link">
|
|
1790
|
+
<span class="md-ellipsis">
|
|
1791
|
+
|
|
1792
|
+
Serialization
|
|
1793
|
+
|
|
1794
|
+
</span>
|
|
1795
|
+
</a>
|
|
1796
|
+
|
|
1797
|
+
<nav class="md-nav" aria-label="Serialization">
|
|
1798
|
+
<ul class="md-nav__list">
|
|
1799
|
+
|
|
1800
|
+
<li class="md-nav__item">
|
|
1801
|
+
<a href="#to_h" class="md-nav__link">
|
|
1802
|
+
<span class="md-ellipsis">
|
|
1803
|
+
|
|
1804
|
+
to_h
|
|
1805
|
+
|
|
1806
|
+
</span>
|
|
1807
|
+
</a>
|
|
1808
|
+
|
|
1809
|
+
</li>
|
|
1810
|
+
|
|
1811
|
+
<li class="md-nav__item">
|
|
1812
|
+
<a href="#to_json" class="md-nav__link">
|
|
1813
|
+
<span class="md-ellipsis">
|
|
1814
|
+
|
|
1815
|
+
to_json
|
|
1816
|
+
|
|
1817
|
+
</span>
|
|
1818
|
+
</a>
|
|
1819
|
+
|
|
1820
|
+
</li>
|
|
1821
|
+
|
|
1822
|
+
<li class="md-nav__item">
|
|
1823
|
+
<a href="#from_hash" class="md-nav__link">
|
|
1824
|
+
<span class="md-ellipsis">
|
|
1825
|
+
|
|
1826
|
+
from_hash
|
|
1827
|
+
|
|
1828
|
+
</span>
|
|
1829
|
+
</a>
|
|
1830
|
+
|
|
1831
|
+
</li>
|
|
1832
|
+
|
|
1833
|
+
<li class="md-nav__item">
|
|
1834
|
+
<a href="#clone" class="md-nav__link">
|
|
1835
|
+
<span class="md-ellipsis">
|
|
1836
|
+
|
|
1837
|
+
clone
|
|
1838
|
+
|
|
1839
|
+
</span>
|
|
1840
|
+
</a>
|
|
1841
|
+
|
|
1842
|
+
</li>
|
|
1843
|
+
|
|
1844
|
+
</ul>
|
|
1845
|
+
</nav>
|
|
1846
|
+
|
|
1847
|
+
</li>
|
|
1848
|
+
|
|
1849
|
+
<li class="md-nav__item">
|
|
1850
|
+
<a href="#examples" class="md-nav__link">
|
|
1851
|
+
<span class="md-ellipsis">
|
|
1852
|
+
|
|
1853
|
+
Examples
|
|
1854
|
+
|
|
1855
|
+
</span>
|
|
1856
|
+
</a>
|
|
1857
|
+
|
|
1858
|
+
<nav class="md-nav" aria-label="Examples">
|
|
1859
|
+
<ul class="md-nav__list">
|
|
1860
|
+
|
|
1861
|
+
<li class="md-nav__item">
|
|
1862
|
+
<a href="#basic-usage" class="md-nav__link">
|
|
1863
|
+
<span class="md-ellipsis">
|
|
1864
|
+
|
|
1865
|
+
Basic Usage
|
|
1866
|
+
|
|
1867
|
+
</span>
|
|
1868
|
+
</a>
|
|
1869
|
+
|
|
1870
|
+
</li>
|
|
1871
|
+
|
|
1872
|
+
<li class="md-nav__item">
|
|
1873
|
+
<a href="#bracket-access" class="md-nav__link">
|
|
1874
|
+
<span class="md-ellipsis">
|
|
1875
|
+
|
|
1876
|
+
Bracket Access
|
|
1877
|
+
|
|
1878
|
+
</span>
|
|
1879
|
+
</a>
|
|
1880
|
+
|
|
1881
|
+
</li>
|
|
1882
|
+
|
|
1883
|
+
<li class="md-nav__item">
|
|
1884
|
+
<a href="#storing-objects" class="md-nav__link">
|
|
1885
|
+
<span class="md-ellipsis">
|
|
1886
|
+
|
|
1887
|
+
Storing Objects
|
|
1888
|
+
|
|
1889
|
+
</span>
|
|
1890
|
+
</a>
|
|
1891
|
+
|
|
1892
|
+
</li>
|
|
1893
|
+
|
|
1894
|
+
<li class="md-nav__item">
|
|
1895
|
+
<a href="#blocking-reads-network-parallel-execution" class="md-nav__link">
|
|
1896
|
+
<span class="md-ellipsis">
|
|
1897
|
+
|
|
1898
|
+
Blocking Reads (Network Parallel Execution)
|
|
1899
|
+
|
|
1900
|
+
</span>
|
|
1901
|
+
</a>
|
|
1902
|
+
|
|
1903
|
+
</li>
|
|
1904
|
+
|
|
1905
|
+
<li class="md-nav__item">
|
|
1906
|
+
<a href="#reactive-subscriptions" class="md-nav__link">
|
|
1907
|
+
<span class="md-ellipsis">
|
|
1908
|
+
|
|
1909
|
+
Reactive Subscriptions
|
|
1910
|
+
|
|
1911
|
+
</span>
|
|
1912
|
+
</a>
|
|
1913
|
+
|
|
1914
|
+
</li>
|
|
1915
|
+
|
|
1916
|
+
<li class="md-nav__item">
|
|
1917
|
+
<a href="#cross-robot-communication-via-network-memory" class="md-nav__link">
|
|
1918
|
+
<span class="md-ellipsis">
|
|
1919
|
+
|
|
1920
|
+
Cross-Robot Communication via Network Memory
|
|
1921
|
+
|
|
1922
|
+
</span>
|
|
1923
|
+
</a>
|
|
1924
|
+
|
|
1925
|
+
</li>
|
|
1926
|
+
|
|
1927
|
+
<li class="md-nav__item">
|
|
1928
|
+
<a href="#data-proxy" class="md-nav__link">
|
|
1929
|
+
<span class="md-ellipsis">
|
|
1930
|
+
|
|
1931
|
+
Data Proxy
|
|
1932
|
+
|
|
1933
|
+
</span>
|
|
1934
|
+
</a>
|
|
1935
|
+
|
|
1936
|
+
</li>
|
|
1937
|
+
|
|
1938
|
+
<li class="md-nav__item">
|
|
1939
|
+
<a href="#serialization_1" class="md-nav__link">
|
|
1940
|
+
<span class="md-ellipsis">
|
|
1941
|
+
|
|
1942
|
+
Serialization
|
|
1943
|
+
|
|
1944
|
+
</span>
|
|
1945
|
+
</a>
|
|
1946
|
+
|
|
1947
|
+
</li>
|
|
1948
|
+
|
|
1949
|
+
</ul>
|
|
1950
|
+
</nav>
|
|
1951
|
+
|
|
1952
|
+
</li>
|
|
1953
|
+
|
|
1954
|
+
<li class="md-nav__item">
|
|
1955
|
+
<a href="#see-also" class="md-nav__link">
|
|
1956
|
+
<span class="md-ellipsis">
|
|
1957
|
+
|
|
1958
|
+
See Also
|
|
1959
|
+
|
|
1960
|
+
</span>
|
|
1961
|
+
</a>
|
|
1962
|
+
|
|
1963
|
+
</li>
|
|
1964
|
+
|
|
1965
|
+
</ul>
|
|
1966
|
+
|
|
1967
|
+
</nav>
|
|
1968
|
+
|
|
1969
|
+
</li>
|
|
1970
|
+
|
|
1971
|
+
|
|
1972
|
+
|
|
1973
|
+
|
|
1974
|
+
</ul>
|
|
1975
|
+
</nav>
|
|
1976
|
+
|
|
1977
|
+
</li>
|
|
1978
|
+
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
|
|
1984
|
+
|
|
1985
|
+
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
|
|
1995
|
+
|
|
1996
|
+
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
|
|
2007
|
+
|
|
2008
|
+
|
|
2009
|
+
|
|
2010
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2011
|
+
|
|
2012
|
+
|
|
2013
|
+
|
|
2014
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_3" >
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
<div class="md-nav__link md-nav__container">
|
|
2018
|
+
<a href="../../messages/" class="md-nav__link ">
|
|
2019
|
+
|
|
2020
|
+
|
|
2021
|
+
|
|
2022
|
+
<span class="md-ellipsis">
|
|
2023
|
+
|
|
2024
|
+
|
|
2025
|
+
Messages
|
|
2026
|
+
|
|
2027
|
+
|
|
2028
|
+
|
|
2029
|
+
</span>
|
|
2030
|
+
|
|
2031
|
+
|
|
2032
|
+
|
|
2033
|
+
</a>
|
|
2034
|
+
|
|
2035
|
+
|
|
2036
|
+
<label class="md-nav__link " for="__nav_5_3" id="__nav_5_3_label" tabindex="0">
|
|
2037
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2038
|
+
</label>
|
|
2039
|
+
|
|
2040
|
+
</div>
|
|
2041
|
+
|
|
2042
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_3_label" aria-expanded="false">
|
|
2043
|
+
<label class="md-nav__title" for="__nav_5_3">
|
|
2044
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2045
|
+
|
|
2046
|
+
|
|
2047
|
+
Messages
|
|
2048
|
+
|
|
2049
|
+
|
|
2050
|
+
</label>
|
|
2051
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2052
|
+
|
|
2053
|
+
|
|
2054
|
+
|
|
2055
|
+
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
<li class="md-nav__item">
|
|
2062
|
+
<a href="../../messages/user-message/" class="md-nav__link">
|
|
2063
|
+
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
<span class="md-ellipsis">
|
|
2067
|
+
|
|
2068
|
+
|
|
2069
|
+
UserMessage
|
|
2070
|
+
|
|
2071
|
+
|
|
2072
|
+
|
|
2073
|
+
</span>
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
</a>
|
|
2078
|
+
</li>
|
|
2079
|
+
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
|
|
2083
|
+
|
|
2084
|
+
|
|
2085
|
+
|
|
2086
|
+
|
|
2087
|
+
|
|
2088
|
+
|
|
2089
|
+
<li class="md-nav__item">
|
|
2090
|
+
<a href="../../messages/text-message/" class="md-nav__link">
|
|
2091
|
+
|
|
2092
|
+
|
|
2093
|
+
|
|
2094
|
+
<span class="md-ellipsis">
|
|
2095
|
+
|
|
2096
|
+
|
|
2097
|
+
TextMessage
|
|
2098
|
+
|
|
2099
|
+
|
|
2100
|
+
|
|
2101
|
+
</span>
|
|
2102
|
+
|
|
2103
|
+
|
|
2104
|
+
|
|
2105
|
+
</a>
|
|
2106
|
+
</li>
|
|
2107
|
+
|
|
2108
|
+
|
|
2109
|
+
|
|
2110
|
+
|
|
2111
|
+
|
|
2112
|
+
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
|
|
2117
|
+
<li class="md-nav__item">
|
|
2118
|
+
<a href="../../messages/tool-call-message/" class="md-nav__link">
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
<span class="md-ellipsis">
|
|
2123
|
+
|
|
2124
|
+
|
|
2125
|
+
ToolCallMessage
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
|
|
2129
|
+
</span>
|
|
2130
|
+
|
|
2131
|
+
|
|
2132
|
+
|
|
2133
|
+
</a>
|
|
2134
|
+
</li>
|
|
2135
|
+
|
|
2136
|
+
|
|
2137
|
+
|
|
2138
|
+
|
|
2139
|
+
|
|
2140
|
+
|
|
2141
|
+
|
|
2142
|
+
|
|
2143
|
+
|
|
2144
|
+
|
|
2145
|
+
<li class="md-nav__item">
|
|
2146
|
+
<a href="../../messages/tool-result-message/" class="md-nav__link">
|
|
2147
|
+
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
<span class="md-ellipsis">
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
ToolResultMessage
|
|
2154
|
+
|
|
2155
|
+
|
|
2156
|
+
|
|
2157
|
+
</span>
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
|
|
2161
|
+
</a>
|
|
2162
|
+
</li>
|
|
2163
|
+
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
|
|
2167
|
+
</ul>
|
|
2168
|
+
</nav>
|
|
2169
|
+
|
|
2170
|
+
</li>
|
|
2171
|
+
|
|
2172
|
+
|
|
2173
|
+
|
|
2174
|
+
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
|
|
2178
|
+
|
|
2179
|
+
|
|
2180
|
+
|
|
2181
|
+
|
|
2182
|
+
|
|
2183
|
+
|
|
2184
|
+
|
|
2185
|
+
|
|
2186
|
+
|
|
2187
|
+
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
|
|
2193
|
+
|
|
2194
|
+
|
|
2195
|
+
|
|
2196
|
+
|
|
2197
|
+
|
|
2198
|
+
|
|
2199
|
+
|
|
2200
|
+
|
|
2201
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2202
|
+
|
|
2203
|
+
|
|
2204
|
+
|
|
2205
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_4" >
|
|
2206
|
+
|
|
2207
|
+
|
|
2208
|
+
<div class="md-nav__link md-nav__container">
|
|
2209
|
+
<a href="../../mcp/" class="md-nav__link ">
|
|
2210
|
+
|
|
2211
|
+
|
|
2212
|
+
|
|
2213
|
+
<span class="md-ellipsis">
|
|
2214
|
+
|
|
2215
|
+
|
|
2216
|
+
MCP
|
|
2217
|
+
|
|
2218
|
+
|
|
2219
|
+
|
|
2220
|
+
</span>
|
|
2221
|
+
|
|
2222
|
+
|
|
2223
|
+
|
|
2224
|
+
</a>
|
|
2225
|
+
|
|
2226
|
+
|
|
2227
|
+
<label class="md-nav__link " for="__nav_5_4" id="__nav_5_4_label" tabindex="0">
|
|
2228
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2229
|
+
</label>
|
|
2230
|
+
|
|
2231
|
+
</div>
|
|
2232
|
+
|
|
2233
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_4_label" aria-expanded="false">
|
|
2234
|
+
<label class="md-nav__title" for="__nav_5_4">
|
|
2235
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2236
|
+
|
|
2237
|
+
|
|
2238
|
+
MCP
|
|
2239
|
+
|
|
2240
|
+
|
|
2241
|
+
</label>
|
|
2242
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2243
|
+
|
|
2244
|
+
|
|
2245
|
+
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
|
|
2249
|
+
|
|
2250
|
+
|
|
2251
|
+
|
|
2252
|
+
<li class="md-nav__item">
|
|
2253
|
+
<a href="../../mcp/client/" class="md-nav__link">
|
|
2254
|
+
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
<span class="md-ellipsis">
|
|
2258
|
+
|
|
2259
|
+
|
|
2260
|
+
Client
|
|
2261
|
+
|
|
2262
|
+
|
|
2263
|
+
|
|
2264
|
+
</span>
|
|
2265
|
+
|
|
2266
|
+
|
|
2267
|
+
|
|
2268
|
+
</a>
|
|
2269
|
+
</li>
|
|
2270
|
+
|
|
2271
|
+
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
|
|
2276
|
+
|
|
2277
|
+
|
|
2278
|
+
|
|
2279
|
+
|
|
2280
|
+
<li class="md-nav__item">
|
|
2281
|
+
<a href="../../mcp/server/" class="md-nav__link">
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
<span class="md-ellipsis">
|
|
2286
|
+
|
|
2287
|
+
|
|
2288
|
+
Server
|
|
2289
|
+
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
</span>
|
|
2293
|
+
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
</a>
|
|
2297
|
+
</li>
|
|
2298
|
+
|
|
2299
|
+
|
|
2300
|
+
|
|
2301
|
+
|
|
2302
|
+
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
|
|
2306
|
+
|
|
2307
|
+
|
|
2308
|
+
<li class="md-nav__item">
|
|
2309
|
+
<a href="../../mcp/transports/" class="md-nav__link">
|
|
2310
|
+
|
|
2311
|
+
|
|
2312
|
+
|
|
2313
|
+
<span class="md-ellipsis">
|
|
2314
|
+
|
|
2315
|
+
|
|
2316
|
+
Transports
|
|
2317
|
+
|
|
2318
|
+
|
|
2319
|
+
|
|
2320
|
+
</span>
|
|
2321
|
+
|
|
2322
|
+
|
|
2323
|
+
|
|
2324
|
+
</a>
|
|
2325
|
+
</li>
|
|
2326
|
+
|
|
2327
|
+
|
|
2328
|
+
|
|
2329
|
+
|
|
2330
|
+
</ul>
|
|
2331
|
+
</nav>
|
|
2332
|
+
|
|
2333
|
+
</li>
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
|
|
2337
|
+
|
|
2338
|
+
|
|
2339
|
+
|
|
2340
|
+
|
|
2341
|
+
|
|
2342
|
+
|
|
2343
|
+
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
|
|
2348
|
+
|
|
2349
|
+
|
|
2350
|
+
|
|
2351
|
+
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
|
|
2359
|
+
|
|
2360
|
+
|
|
2361
|
+
|
|
2362
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2363
|
+
|
|
2364
|
+
|
|
2365
|
+
|
|
2366
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_5" >
|
|
2367
|
+
|
|
2368
|
+
|
|
2369
|
+
<div class="md-nav__link md-nav__container">
|
|
2370
|
+
<a href="../../streaming/" class="md-nav__link ">
|
|
2371
|
+
|
|
2372
|
+
|
|
2373
|
+
|
|
2374
|
+
<span class="md-ellipsis">
|
|
2375
|
+
|
|
2376
|
+
|
|
2377
|
+
Streaming
|
|
2378
|
+
|
|
2379
|
+
|
|
2380
|
+
|
|
2381
|
+
</span>
|
|
2382
|
+
|
|
2383
|
+
|
|
2384
|
+
|
|
2385
|
+
</a>
|
|
2386
|
+
|
|
2387
|
+
|
|
2388
|
+
<label class="md-nav__link " for="__nav_5_5" id="__nav_5_5_label" tabindex="0">
|
|
2389
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2390
|
+
</label>
|
|
2391
|
+
|
|
2392
|
+
</div>
|
|
2393
|
+
|
|
2394
|
+
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_5_5_label" aria-expanded="false">
|
|
2395
|
+
<label class="md-nav__title" for="__nav_5_5">
|
|
2396
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2397
|
+
|
|
2398
|
+
|
|
2399
|
+
Streaming
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
</label>
|
|
2403
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2404
|
+
|
|
2405
|
+
|
|
2406
|
+
|
|
2407
|
+
|
|
2408
|
+
|
|
2409
|
+
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
<li class="md-nav__item">
|
|
2414
|
+
<a href="../../streaming/context/" class="md-nav__link">
|
|
2415
|
+
|
|
2416
|
+
|
|
2417
|
+
|
|
2418
|
+
<span class="md-ellipsis">
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
Context
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
|
|
2425
|
+
</span>
|
|
2426
|
+
|
|
2427
|
+
|
|
2428
|
+
|
|
2429
|
+
</a>
|
|
2430
|
+
</li>
|
|
2431
|
+
|
|
2432
|
+
|
|
2433
|
+
|
|
2434
|
+
|
|
2435
|
+
|
|
2436
|
+
|
|
2437
|
+
|
|
2438
|
+
|
|
2439
|
+
|
|
2440
|
+
|
|
2441
|
+
<li class="md-nav__item">
|
|
2442
|
+
<a href="../../streaming/events/" class="md-nav__link">
|
|
2443
|
+
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
<span class="md-ellipsis">
|
|
2447
|
+
|
|
2448
|
+
|
|
2449
|
+
Events
|
|
2450
|
+
|
|
2451
|
+
|
|
2452
|
+
|
|
2453
|
+
</span>
|
|
2454
|
+
|
|
2455
|
+
|
|
2456
|
+
|
|
2457
|
+
</a>
|
|
2458
|
+
</li>
|
|
2459
|
+
|
|
2460
|
+
|
|
2461
|
+
|
|
2462
|
+
|
|
2463
|
+
</ul>
|
|
2464
|
+
</nav>
|
|
2465
|
+
|
|
2466
|
+
</li>
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
|
|
2470
|
+
|
|
2471
|
+
</ul>
|
|
2472
|
+
</nav>
|
|
2473
|
+
|
|
2474
|
+
</li>
|
|
2475
|
+
|
|
2476
|
+
|
|
2477
|
+
|
|
2478
|
+
|
|
2479
|
+
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
|
|
2487
|
+
|
|
2488
|
+
|
|
2489
|
+
|
|
2490
|
+
|
|
2491
|
+
|
|
2492
|
+
|
|
2493
|
+
|
|
2494
|
+
|
|
2495
|
+
|
|
2496
|
+
|
|
2497
|
+
|
|
2498
|
+
|
|
2499
|
+
|
|
2500
|
+
|
|
2501
|
+
|
|
2502
|
+
|
|
2503
|
+
|
|
2504
|
+
|
|
2505
|
+
|
|
2506
|
+
|
|
2507
|
+
|
|
2508
|
+
<li class="md-nav__item md-nav__item--nested">
|
|
2509
|
+
|
|
2510
|
+
|
|
2511
|
+
|
|
2512
|
+
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_6" >
|
|
2513
|
+
|
|
2514
|
+
|
|
2515
|
+
<div class="md-nav__link md-nav__container">
|
|
2516
|
+
<a href="../../../examples/" class="md-nav__link ">
|
|
2517
|
+
|
|
2518
|
+
|
|
2519
|
+
|
|
2520
|
+
<span class="md-ellipsis">
|
|
2521
|
+
|
|
2522
|
+
|
|
2523
|
+
Examples
|
|
2524
|
+
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
</span>
|
|
2528
|
+
|
|
2529
|
+
|
|
2530
|
+
|
|
2531
|
+
</a>
|
|
2532
|
+
|
|
2533
|
+
|
|
2534
|
+
<label class="md-nav__link " for="__nav_6" id="__nav_6_label" tabindex="0">
|
|
2535
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2536
|
+
</label>
|
|
2537
|
+
|
|
2538
|
+
</div>
|
|
2539
|
+
|
|
2540
|
+
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
|
|
2541
|
+
<label class="md-nav__title" for="__nav_6">
|
|
2542
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2543
|
+
|
|
2544
|
+
|
|
2545
|
+
Examples
|
|
2546
|
+
|
|
2547
|
+
|
|
2548
|
+
</label>
|
|
2549
|
+
<ul class="md-nav__list" data-md-scrollfix>
|
|
2550
|
+
|
|
2551
|
+
|
|
2552
|
+
|
|
2553
|
+
|
|
2554
|
+
|
|
2555
|
+
|
|
2556
|
+
|
|
2557
|
+
|
|
2558
|
+
|
|
2559
|
+
<li class="md-nav__item">
|
|
2560
|
+
<a href="../../../examples/basic-chat/" class="md-nav__link">
|
|
2561
|
+
|
|
2562
|
+
|
|
2563
|
+
|
|
2564
|
+
<span class="md-ellipsis">
|
|
2565
|
+
|
|
2566
|
+
|
|
2567
|
+
Basic Chat
|
|
2568
|
+
|
|
2569
|
+
|
|
2570
|
+
|
|
2571
|
+
</span>
|
|
2572
|
+
|
|
2573
|
+
|
|
2574
|
+
|
|
2575
|
+
</a>
|
|
2576
|
+
</li>
|
|
2577
|
+
|
|
2578
|
+
|
|
2579
|
+
|
|
2580
|
+
|
|
2581
|
+
|
|
2582
|
+
|
|
2583
|
+
|
|
2584
|
+
|
|
2585
|
+
|
|
2586
|
+
|
|
2587
|
+
<li class="md-nav__item">
|
|
2588
|
+
<a href="../../../examples/multi-robot-network/" class="md-nav__link">
|
|
2589
|
+
|
|
2590
|
+
|
|
2591
|
+
|
|
2592
|
+
<span class="md-ellipsis">
|
|
2593
|
+
|
|
2594
|
+
|
|
2595
|
+
Multi-Robot Network
|
|
2596
|
+
|
|
2597
|
+
|
|
2598
|
+
|
|
2599
|
+
</span>
|
|
2600
|
+
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
</a>
|
|
2604
|
+
</li>
|
|
2605
|
+
|
|
2606
|
+
|
|
2607
|
+
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
|
|
2611
|
+
|
|
2612
|
+
|
|
2613
|
+
|
|
2614
|
+
|
|
2615
|
+
<li class="md-nav__item">
|
|
2616
|
+
<a href="../../../examples/tool-usage/" class="md-nav__link">
|
|
2617
|
+
|
|
2618
|
+
|
|
2619
|
+
|
|
2620
|
+
<span class="md-ellipsis">
|
|
2621
|
+
|
|
2622
|
+
|
|
2623
|
+
Tool Usage
|
|
2624
|
+
|
|
2625
|
+
|
|
2626
|
+
|
|
2627
|
+
</span>
|
|
2628
|
+
|
|
2629
|
+
|
|
2630
|
+
|
|
2631
|
+
</a>
|
|
2632
|
+
</li>
|
|
2633
|
+
|
|
2634
|
+
|
|
2635
|
+
|
|
2636
|
+
|
|
2637
|
+
|
|
2638
|
+
|
|
2639
|
+
|
|
2640
|
+
|
|
2641
|
+
|
|
2642
|
+
|
|
2643
|
+
<li class="md-nav__item">
|
|
2644
|
+
<a href="../../../examples/mcp-server/" class="md-nav__link">
|
|
2645
|
+
|
|
2646
|
+
|
|
2647
|
+
|
|
2648
|
+
<span class="md-ellipsis">
|
|
2649
|
+
|
|
2650
|
+
|
|
2651
|
+
MCP Server
|
|
2652
|
+
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
</span>
|
|
2656
|
+
|
|
2657
|
+
|
|
2658
|
+
|
|
2659
|
+
</a>
|
|
2660
|
+
</li>
|
|
2661
|
+
|
|
2662
|
+
|
|
2663
|
+
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
|
|
2667
|
+
|
|
2668
|
+
|
|
2669
|
+
|
|
2670
|
+
|
|
2671
|
+
<li class="md-nav__item">
|
|
2672
|
+
<a href="../../../examples/rails-application/" class="md-nav__link">
|
|
2673
|
+
|
|
2674
|
+
|
|
2675
|
+
|
|
2676
|
+
<span class="md-ellipsis">
|
|
2677
|
+
|
|
2678
|
+
|
|
2679
|
+
Rails Application
|
|
2680
|
+
|
|
2681
|
+
|
|
2682
|
+
|
|
2683
|
+
</span>
|
|
2684
|
+
|
|
2685
|
+
|
|
2686
|
+
|
|
2687
|
+
</a>
|
|
2688
|
+
</li>
|
|
2689
|
+
|
|
2690
|
+
|
|
2691
|
+
|
|
2692
|
+
|
|
2693
|
+
</ul>
|
|
2694
|
+
</nav>
|
|
2695
|
+
|
|
2696
|
+
</li>
|
|
2697
|
+
|
|
2698
|
+
|
|
2699
|
+
|
|
2700
|
+
</ul>
|
|
2701
|
+
</nav>
|
|
2702
|
+
</div>
|
|
2703
|
+
</div>
|
|
2704
|
+
</div>
|
|
2705
|
+
|
|
2706
|
+
|
|
2707
|
+
|
|
2708
|
+
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
2709
|
+
<div class="md-sidebar__scrollwrap">
|
|
2710
|
+
<div class="md-sidebar__inner">
|
|
2711
|
+
|
|
2712
|
+
|
|
2713
|
+
|
|
2714
|
+
|
|
2715
|
+
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
|
2716
|
+
|
|
2717
|
+
|
|
2718
|
+
|
|
2719
|
+
|
|
2720
|
+
|
|
2721
|
+
|
|
2722
|
+
<label class="md-nav__title" for="__toc">
|
|
2723
|
+
<span class="md-nav__icon md-icon"></span>
|
|
2724
|
+
On this page
|
|
2725
|
+
</label>
|
|
2726
|
+
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
2727
|
+
|
|
2728
|
+
<li class="md-nav__item">
|
|
2729
|
+
<a href="#class-robotlabmemory" class="md-nav__link">
|
|
2730
|
+
<span class="md-ellipsis">
|
|
2731
|
+
|
|
2732
|
+
Class: RobotLab::Memory
|
|
2733
|
+
|
|
2734
|
+
</span>
|
|
2735
|
+
</a>
|
|
2736
|
+
|
|
2737
|
+
</li>
|
|
2738
|
+
|
|
2739
|
+
<li class="md-nav__item">
|
|
2740
|
+
<a href="#constants" class="md-nav__link">
|
|
2741
|
+
<span class="md-ellipsis">
|
|
2742
|
+
|
|
2743
|
+
Constants
|
|
2744
|
+
|
|
2745
|
+
</span>
|
|
2746
|
+
</a>
|
|
2747
|
+
|
|
2748
|
+
<nav class="md-nav" aria-label="Constants">
|
|
2749
|
+
<ul class="md-nav__list">
|
|
2750
|
+
|
|
2751
|
+
<li class="md-nav__item">
|
|
2752
|
+
<a href="#reserved_keys" class="md-nav__link">
|
|
2753
|
+
<span class="md-ellipsis">
|
|
2754
|
+
|
|
2755
|
+
RESERVED_KEYS
|
|
2756
|
+
|
|
2757
|
+
</span>
|
|
2758
|
+
</a>
|
|
2759
|
+
|
|
2760
|
+
</li>
|
|
2761
|
+
|
|
2762
|
+
</ul>
|
|
2763
|
+
</nav>
|
|
2764
|
+
|
|
2765
|
+
</li>
|
|
2766
|
+
|
|
2767
|
+
<li class="md-nav__item">
|
|
2768
|
+
<a href="#constructor" class="md-nav__link">
|
|
2769
|
+
<span class="md-ellipsis">
|
|
2770
|
+
|
|
2771
|
+
Constructor
|
|
2772
|
+
|
|
2773
|
+
</span>
|
|
2774
|
+
</a>
|
|
2775
|
+
|
|
2776
|
+
</li>
|
|
2777
|
+
|
|
2778
|
+
<li class="md-nav__item">
|
|
2779
|
+
<a href="#factory-method" class="md-nav__link">
|
|
2780
|
+
<span class="md-ellipsis">
|
|
2781
|
+
|
|
2782
|
+
Factory Method
|
|
2783
|
+
|
|
2784
|
+
</span>
|
|
2785
|
+
</a>
|
|
2786
|
+
|
|
2787
|
+
</li>
|
|
2788
|
+
|
|
2789
|
+
<li class="md-nav__item">
|
|
2790
|
+
<a href="#methods" class="md-nav__link">
|
|
2791
|
+
<span class="md-ellipsis">
|
|
2792
|
+
|
|
2793
|
+
Methods
|
|
2794
|
+
|
|
2795
|
+
</span>
|
|
2796
|
+
</a>
|
|
2797
|
+
|
|
2798
|
+
<nav class="md-nav" aria-label="Methods">
|
|
2799
|
+
<ul class="md-nav__list">
|
|
2800
|
+
|
|
2801
|
+
<li class="md-nav__item">
|
|
2802
|
+
<a href="#set" class="md-nav__link">
|
|
2803
|
+
<span class="md-ellipsis">
|
|
2804
|
+
|
|
2805
|
+
set
|
|
2806
|
+
|
|
2807
|
+
</span>
|
|
2808
|
+
</a>
|
|
2809
|
+
|
|
2810
|
+
</li>
|
|
2811
|
+
|
|
2812
|
+
<li class="md-nav__item">
|
|
2813
|
+
<a href="#get" class="md-nav__link">
|
|
2814
|
+
<span class="md-ellipsis">
|
|
2815
|
+
|
|
2816
|
+
get
|
|
2817
|
+
|
|
2818
|
+
</span>
|
|
2819
|
+
</a>
|
|
2820
|
+
|
|
2821
|
+
</li>
|
|
2822
|
+
|
|
2823
|
+
<li class="md-nav__item">
|
|
2824
|
+
<a href="#key" class="md-nav__link">
|
|
2825
|
+
<span class="md-ellipsis">
|
|
2826
|
+
|
|
2827
|
+
key?
|
|
2828
|
+
|
|
2829
|
+
</span>
|
|
2830
|
+
</a>
|
|
2831
|
+
|
|
2832
|
+
</li>
|
|
2833
|
+
|
|
2834
|
+
<li class="md-nav__item">
|
|
2835
|
+
<a href="#delete" class="md-nav__link">
|
|
2836
|
+
<span class="md-ellipsis">
|
|
2837
|
+
|
|
2838
|
+
delete
|
|
2839
|
+
|
|
2840
|
+
</span>
|
|
2841
|
+
</a>
|
|
2842
|
+
|
|
2843
|
+
</li>
|
|
2844
|
+
|
|
2845
|
+
<li class="md-nav__item">
|
|
2846
|
+
<a href="#keys" class="md-nav__link">
|
|
2847
|
+
<span class="md-ellipsis">
|
|
2848
|
+
|
|
2849
|
+
keys
|
|
2850
|
+
|
|
2851
|
+
</span>
|
|
2852
|
+
</a>
|
|
2853
|
+
|
|
2854
|
+
</li>
|
|
2855
|
+
|
|
2856
|
+
<li class="md-nav__item">
|
|
2857
|
+
<a href="#clear" class="md-nav__link">
|
|
2858
|
+
<span class="md-ellipsis">
|
|
2859
|
+
|
|
2860
|
+
clear
|
|
2861
|
+
|
|
2862
|
+
</span>
|
|
2863
|
+
</a>
|
|
2864
|
+
|
|
2865
|
+
</li>
|
|
2866
|
+
|
|
2867
|
+
<li class="md-nav__item">
|
|
2868
|
+
<a href="#reset" class="md-nav__link">
|
|
2869
|
+
<span class="md-ellipsis">
|
|
2870
|
+
|
|
2871
|
+
reset
|
|
2872
|
+
|
|
2873
|
+
</span>
|
|
2874
|
+
</a>
|
|
2875
|
+
|
|
2876
|
+
</li>
|
|
2877
|
+
|
|
2878
|
+
<li class="md-nav__item">
|
|
2879
|
+
<a href="#subscribe" class="md-nav__link">
|
|
2880
|
+
<span class="md-ellipsis">
|
|
2881
|
+
|
|
2882
|
+
subscribe
|
|
2883
|
+
|
|
2884
|
+
</span>
|
|
2885
|
+
</a>
|
|
2886
|
+
|
|
2887
|
+
</li>
|
|
2888
|
+
|
|
2889
|
+
<li class="md-nav__item">
|
|
2890
|
+
<a href="#subscribe_pattern" class="md-nav__link">
|
|
2891
|
+
<span class="md-ellipsis">
|
|
2892
|
+
|
|
2893
|
+
subscribe_pattern
|
|
2894
|
+
|
|
2895
|
+
</span>
|
|
2896
|
+
</a>
|
|
2897
|
+
|
|
2898
|
+
</li>
|
|
2899
|
+
|
|
2900
|
+
<li class="md-nav__item">
|
|
2901
|
+
<a href="#unsubscribe" class="md-nav__link">
|
|
2902
|
+
<span class="md-ellipsis">
|
|
2903
|
+
|
|
2904
|
+
unsubscribe
|
|
2905
|
+
|
|
2906
|
+
</span>
|
|
2907
|
+
</a>
|
|
2908
|
+
|
|
2909
|
+
</li>
|
|
2910
|
+
|
|
2911
|
+
<li class="md-nav__item">
|
|
2912
|
+
<a href="#merge" class="md-nav__link">
|
|
2913
|
+
<span class="md-ellipsis">
|
|
2914
|
+
|
|
2915
|
+
merge!
|
|
2916
|
+
|
|
2917
|
+
</span>
|
|
2918
|
+
</a>
|
|
2919
|
+
|
|
2920
|
+
</li>
|
|
2921
|
+
|
|
2922
|
+
</ul>
|
|
2923
|
+
</nav>
|
|
2924
|
+
|
|
2925
|
+
</li>
|
|
2926
|
+
|
|
2927
|
+
<li class="md-nav__item">
|
|
2928
|
+
<a href="#reserved-key-accessors" class="md-nav__link">
|
|
2929
|
+
<span class="md-ellipsis">
|
|
2930
|
+
|
|
2931
|
+
Reserved Key Accessors
|
|
2932
|
+
|
|
2933
|
+
</span>
|
|
2934
|
+
</a>
|
|
2935
|
+
|
|
2936
|
+
<nav class="md-nav" aria-label="Reserved Key Accessors">
|
|
2937
|
+
<ul class="md-nav__list">
|
|
2938
|
+
|
|
2939
|
+
<li class="md-nav__item">
|
|
2940
|
+
<a href="#data" class="md-nav__link">
|
|
2941
|
+
<span class="md-ellipsis">
|
|
2942
|
+
|
|
2943
|
+
data
|
|
2944
|
+
|
|
2945
|
+
</span>
|
|
2946
|
+
</a>
|
|
2947
|
+
|
|
2948
|
+
</li>
|
|
2949
|
+
|
|
2950
|
+
<li class="md-nav__item">
|
|
2951
|
+
<a href="#results" class="md-nav__link">
|
|
2952
|
+
<span class="md-ellipsis">
|
|
2953
|
+
|
|
2954
|
+
results
|
|
2955
|
+
|
|
2956
|
+
</span>
|
|
2957
|
+
</a>
|
|
2958
|
+
|
|
2959
|
+
</li>
|
|
2960
|
+
|
|
2961
|
+
<li class="md-nav__item">
|
|
2962
|
+
<a href="#messages" class="md-nav__link">
|
|
2963
|
+
<span class="md-ellipsis">
|
|
2964
|
+
|
|
2965
|
+
messages
|
|
2966
|
+
|
|
2967
|
+
</span>
|
|
2968
|
+
</a>
|
|
2969
|
+
|
|
2970
|
+
</li>
|
|
2971
|
+
|
|
2972
|
+
<li class="md-nav__item">
|
|
2973
|
+
<a href="#session_id" class="md-nav__link">
|
|
2974
|
+
<span class="md-ellipsis">
|
|
2975
|
+
|
|
2976
|
+
session_id
|
|
2977
|
+
|
|
2978
|
+
</span>
|
|
2979
|
+
</a>
|
|
2980
|
+
|
|
2981
|
+
</li>
|
|
2982
|
+
|
|
2983
|
+
<li class="md-nav__item">
|
|
2984
|
+
<a href="#cache" class="md-nav__link">
|
|
2985
|
+
<span class="md-ellipsis">
|
|
2986
|
+
|
|
2987
|
+
cache
|
|
2988
|
+
|
|
2989
|
+
</span>
|
|
2990
|
+
</a>
|
|
2991
|
+
|
|
2992
|
+
</li>
|
|
2993
|
+
|
|
2994
|
+
</ul>
|
|
2995
|
+
</nav>
|
|
2996
|
+
|
|
2997
|
+
</li>
|
|
2998
|
+
|
|
2999
|
+
<li class="md-nav__item">
|
|
3000
|
+
<a href="#serialization" class="md-nav__link">
|
|
3001
|
+
<span class="md-ellipsis">
|
|
3002
|
+
|
|
3003
|
+
Serialization
|
|
3004
|
+
|
|
3005
|
+
</span>
|
|
3006
|
+
</a>
|
|
3007
|
+
|
|
3008
|
+
<nav class="md-nav" aria-label="Serialization">
|
|
3009
|
+
<ul class="md-nav__list">
|
|
3010
|
+
|
|
3011
|
+
<li class="md-nav__item">
|
|
3012
|
+
<a href="#to_h" class="md-nav__link">
|
|
3013
|
+
<span class="md-ellipsis">
|
|
3014
|
+
|
|
3015
|
+
to_h
|
|
3016
|
+
|
|
3017
|
+
</span>
|
|
3018
|
+
</a>
|
|
3019
|
+
|
|
3020
|
+
</li>
|
|
3021
|
+
|
|
3022
|
+
<li class="md-nav__item">
|
|
3023
|
+
<a href="#to_json" class="md-nav__link">
|
|
3024
|
+
<span class="md-ellipsis">
|
|
3025
|
+
|
|
3026
|
+
to_json
|
|
3027
|
+
|
|
3028
|
+
</span>
|
|
3029
|
+
</a>
|
|
3030
|
+
|
|
3031
|
+
</li>
|
|
3032
|
+
|
|
3033
|
+
<li class="md-nav__item">
|
|
3034
|
+
<a href="#from_hash" class="md-nav__link">
|
|
3035
|
+
<span class="md-ellipsis">
|
|
3036
|
+
|
|
3037
|
+
from_hash
|
|
3038
|
+
|
|
3039
|
+
</span>
|
|
3040
|
+
</a>
|
|
3041
|
+
|
|
3042
|
+
</li>
|
|
3043
|
+
|
|
3044
|
+
<li class="md-nav__item">
|
|
3045
|
+
<a href="#clone" class="md-nav__link">
|
|
3046
|
+
<span class="md-ellipsis">
|
|
3047
|
+
|
|
3048
|
+
clone
|
|
3049
|
+
|
|
3050
|
+
</span>
|
|
3051
|
+
</a>
|
|
3052
|
+
|
|
3053
|
+
</li>
|
|
3054
|
+
|
|
3055
|
+
</ul>
|
|
3056
|
+
</nav>
|
|
3057
|
+
|
|
3058
|
+
</li>
|
|
3059
|
+
|
|
3060
|
+
<li class="md-nav__item">
|
|
3061
|
+
<a href="#examples" class="md-nav__link">
|
|
3062
|
+
<span class="md-ellipsis">
|
|
3063
|
+
|
|
3064
|
+
Examples
|
|
3065
|
+
|
|
3066
|
+
</span>
|
|
3067
|
+
</a>
|
|
3068
|
+
|
|
3069
|
+
<nav class="md-nav" aria-label="Examples">
|
|
3070
|
+
<ul class="md-nav__list">
|
|
3071
|
+
|
|
3072
|
+
<li class="md-nav__item">
|
|
3073
|
+
<a href="#basic-usage" class="md-nav__link">
|
|
3074
|
+
<span class="md-ellipsis">
|
|
3075
|
+
|
|
3076
|
+
Basic Usage
|
|
3077
|
+
|
|
3078
|
+
</span>
|
|
3079
|
+
</a>
|
|
3080
|
+
|
|
3081
|
+
</li>
|
|
3082
|
+
|
|
3083
|
+
<li class="md-nav__item">
|
|
3084
|
+
<a href="#bracket-access" class="md-nav__link">
|
|
3085
|
+
<span class="md-ellipsis">
|
|
3086
|
+
|
|
3087
|
+
Bracket Access
|
|
3088
|
+
|
|
3089
|
+
</span>
|
|
3090
|
+
</a>
|
|
3091
|
+
|
|
3092
|
+
</li>
|
|
3093
|
+
|
|
3094
|
+
<li class="md-nav__item">
|
|
3095
|
+
<a href="#storing-objects" class="md-nav__link">
|
|
3096
|
+
<span class="md-ellipsis">
|
|
3097
|
+
|
|
3098
|
+
Storing Objects
|
|
3099
|
+
|
|
3100
|
+
</span>
|
|
3101
|
+
</a>
|
|
3102
|
+
|
|
3103
|
+
</li>
|
|
3104
|
+
|
|
3105
|
+
<li class="md-nav__item">
|
|
3106
|
+
<a href="#blocking-reads-network-parallel-execution" class="md-nav__link">
|
|
3107
|
+
<span class="md-ellipsis">
|
|
3108
|
+
|
|
3109
|
+
Blocking Reads (Network Parallel Execution)
|
|
3110
|
+
|
|
3111
|
+
</span>
|
|
3112
|
+
</a>
|
|
3113
|
+
|
|
3114
|
+
</li>
|
|
3115
|
+
|
|
3116
|
+
<li class="md-nav__item">
|
|
3117
|
+
<a href="#reactive-subscriptions" class="md-nav__link">
|
|
3118
|
+
<span class="md-ellipsis">
|
|
3119
|
+
|
|
3120
|
+
Reactive Subscriptions
|
|
3121
|
+
|
|
3122
|
+
</span>
|
|
3123
|
+
</a>
|
|
3124
|
+
|
|
3125
|
+
</li>
|
|
3126
|
+
|
|
3127
|
+
<li class="md-nav__item">
|
|
3128
|
+
<a href="#cross-robot-communication-via-network-memory" class="md-nav__link">
|
|
3129
|
+
<span class="md-ellipsis">
|
|
3130
|
+
|
|
3131
|
+
Cross-Robot Communication via Network Memory
|
|
3132
|
+
|
|
3133
|
+
</span>
|
|
3134
|
+
</a>
|
|
3135
|
+
|
|
3136
|
+
</li>
|
|
3137
|
+
|
|
3138
|
+
<li class="md-nav__item">
|
|
3139
|
+
<a href="#data-proxy" class="md-nav__link">
|
|
3140
|
+
<span class="md-ellipsis">
|
|
3141
|
+
|
|
3142
|
+
Data Proxy
|
|
3143
|
+
|
|
3144
|
+
</span>
|
|
3145
|
+
</a>
|
|
3146
|
+
|
|
3147
|
+
</li>
|
|
3148
|
+
|
|
3149
|
+
<li class="md-nav__item">
|
|
3150
|
+
<a href="#serialization_1" class="md-nav__link">
|
|
3151
|
+
<span class="md-ellipsis">
|
|
3152
|
+
|
|
3153
|
+
Serialization
|
|
3154
|
+
|
|
3155
|
+
</span>
|
|
3156
|
+
</a>
|
|
3157
|
+
|
|
3158
|
+
</li>
|
|
3159
|
+
|
|
3160
|
+
</ul>
|
|
3161
|
+
</nav>
|
|
3162
|
+
|
|
3163
|
+
</li>
|
|
3164
|
+
|
|
3165
|
+
<li class="md-nav__item">
|
|
3166
|
+
<a href="#see-also" class="md-nav__link">
|
|
3167
|
+
<span class="md-ellipsis">
|
|
3168
|
+
|
|
3169
|
+
See Also
|
|
3170
|
+
|
|
3171
|
+
</span>
|
|
3172
|
+
</a>
|
|
3173
|
+
|
|
3174
|
+
</li>
|
|
3175
|
+
|
|
3176
|
+
</ul>
|
|
3177
|
+
|
|
3178
|
+
</nav>
|
|
3179
|
+
</div>
|
|
3180
|
+
</div>
|
|
3181
|
+
</div>
|
|
3182
|
+
|
|
3183
|
+
|
|
3184
|
+
|
|
3185
|
+
<div class="md-content" data-md-component="content">
|
|
3186
|
+
|
|
3187
|
+
|
|
3188
|
+
|
|
3189
|
+
|
|
3190
|
+
|
|
3191
|
+
|
|
3192
|
+
<nav class="md-path" aria-label="Navigation" >
|
|
3193
|
+
<ol class="md-path__list">
|
|
3194
|
+
|
|
3195
|
+
|
|
3196
|
+
|
|
3197
|
+
|
|
3198
|
+
|
|
3199
|
+
|
|
3200
|
+
|
|
3201
|
+
<li class="md-path__item">
|
|
3202
|
+
<a href="../../" class="md-path__link">
|
|
3203
|
+
|
|
3204
|
+
<span class="md-ellipsis">
|
|
3205
|
+
API Reference
|
|
3206
|
+
</span>
|
|
3207
|
+
|
|
3208
|
+
</a>
|
|
3209
|
+
</li>
|
|
3210
|
+
|
|
3211
|
+
|
|
3212
|
+
|
|
3213
|
+
|
|
3214
|
+
|
|
3215
|
+
|
|
3216
|
+
|
|
3217
|
+
|
|
3218
|
+
|
|
3219
|
+
<li class="md-path__item">
|
|
3220
|
+
<a href="../" class="md-path__link">
|
|
3221
|
+
|
|
3222
|
+
<span class="md-ellipsis">
|
|
3223
|
+
Core Classes
|
|
3224
|
+
</span>
|
|
3225
|
+
|
|
3226
|
+
</a>
|
|
3227
|
+
</li>
|
|
3228
|
+
|
|
3229
|
+
|
|
3230
|
+
|
|
3231
|
+
|
|
3232
|
+
</ol>
|
|
3233
|
+
</nav>
|
|
3234
|
+
|
|
3235
|
+
|
|
3236
|
+
<article class="md-content__inner md-typeset">
|
|
3237
|
+
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
|
|
3241
|
+
|
|
3242
|
+
<a href="https://github.com/madbomber/robot_lab/edit/main/docs/api/core/memory.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
|
3243
|
+
|
|
3244
|
+
<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>
|
|
3245
|
+
</a>
|
|
3246
|
+
|
|
3247
|
+
|
|
3248
|
+
|
|
3249
|
+
|
|
3250
|
+
|
|
3251
|
+
<a href="https://github.com/madbomber/robot_lab/raw/main/docs/api/core/memory.md" title="View source of this page" class="md-content__button md-icon">
|
|
3252
|
+
|
|
3253
|
+
<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>
|
|
3254
|
+
</a>
|
|
3255
|
+
|
|
3256
|
+
|
|
3257
|
+
|
|
3258
|
+
<h1 id="memory">Memory<a class="headerlink" href="#memory" title="Permanent link">¶</a></h1>
|
|
3259
|
+
<p>Reactive key-value store for sharing data between robots.</p>
|
|
3260
|
+
<h2 id="class-robotlabmemory">Class: <code>RobotLab::Memory</code><a class="headerlink" href="#class-robotlabmemory" title="Permanent link">¶</a></h2>
|
|
3261
|
+
<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">memory</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">memory</span>
|
|
3262
|
+
</span><span id="__span-0-2"><a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>
|
|
3263
|
+
</span><span id="__span-0-3"><a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:key</span><span class="p">,</span><span class="w"> </span><span class="s2">"value"</span><span class="p">)</span>
|
|
3264
|
+
</span><span id="__span-0-4"><a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="n">value</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:key</span><span class="p">)</span>
|
|
3265
|
+
</span></code></pre></div>
|
|
3266
|
+
<h2 id="constants">Constants<a class="headerlink" href="#constants" title="Permanent link">¶</a></h2>
|
|
3267
|
+
<h3 id="reserved_keys">RESERVED_KEYS<a class="headerlink" href="#reserved_keys" title="Permanent link">¶</a></h3>
|
|
3268
|
+
<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">Memory</span><span class="o">::</span><span class="no">RESERVED_KEYS</span><span class="w"> </span><span class="c1"># => [:data, :results, :messages, :session_id, :cache]</span>
|
|
3269
|
+
</span></code></pre></div>
|
|
3270
|
+
<p>Reserved keys with special accessors and behavior.</p>
|
|
3271
|
+
<h2 id="constructor">Constructor<a class="headerlink" href="#constructor" title="Permanent link">¶</a></h2>
|
|
3272
|
+
<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">memory</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Memory</span><span class="o">.</span><span class="n">new</span><span class="p">(</span>
|
|
3273
|
+
</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="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p">{},</span>
|
|
3274
|
+
</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="ss">results</span><span class="p">:</span><span class="w"> </span><span class="o">[]</span><span class="p">,</span>
|
|
3275
|
+
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a><span class="w"> </span><span class="ss">messages</span><span class="p">:</span><span class="w"> </span><span class="o">[]</span><span class="p">,</span>
|
|
3276
|
+
</span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a><span class="w"> </span><span class="ss">session_id</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span><span class="p">,</span>
|
|
3277
|
+
</span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a><span class="w"> </span><span class="ss">backend</span><span class="p">:</span><span class="w"> </span><span class="ss">:auto</span><span class="p">,</span>
|
|
3278
|
+
</span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a><span class="w"> </span><span class="ss">enable_cache</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">,</span>
|
|
3279
|
+
</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a><span class="w"> </span><span class="ss">network_name</span><span class="p">:</span><span class="w"> </span><span class="kp">nil</span>
|
|
3280
|
+
</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a><span class="p">)</span>
|
|
3281
|
+
</span></code></pre></div>
|
|
3282
|
+
<p><strong>Parameters:</strong></p>
|
|
3283
|
+
<table>
|
|
3284
|
+
<thead>
|
|
3285
|
+
<tr>
|
|
3286
|
+
<th>Name</th>
|
|
3287
|
+
<th>Type</th>
|
|
3288
|
+
<th>Default</th>
|
|
3289
|
+
<th>Description</th>
|
|
3290
|
+
</tr>
|
|
3291
|
+
</thead>
|
|
3292
|
+
<tbody>
|
|
3293
|
+
<tr>
|
|
3294
|
+
<td><code>data</code></td>
|
|
3295
|
+
<td><code>Hash</code></td>
|
|
3296
|
+
<td><code>{}</code></td>
|
|
3297
|
+
<td>Initial runtime data</td>
|
|
3298
|
+
</tr>
|
|
3299
|
+
<tr>
|
|
3300
|
+
<td><code>results</code></td>
|
|
3301
|
+
<td><code>Array</code></td>
|
|
3302
|
+
<td><code>[]</code></td>
|
|
3303
|
+
<td>Pre-loaded robot results</td>
|
|
3304
|
+
</tr>
|
|
3305
|
+
<tr>
|
|
3306
|
+
<td><code>messages</code></td>
|
|
3307
|
+
<td><code>Array</code></td>
|
|
3308
|
+
<td><code>[]</code></td>
|
|
3309
|
+
<td>Pre-loaded conversation messages</td>
|
|
3310
|
+
</tr>
|
|
3311
|
+
<tr>
|
|
3312
|
+
<td><code>session_id</code></td>
|
|
3313
|
+
<td><code>String, nil</code></td>
|
|
3314
|
+
<td><code>nil</code></td>
|
|
3315
|
+
<td>Session identifier</td>
|
|
3316
|
+
</tr>
|
|
3317
|
+
<tr>
|
|
3318
|
+
<td><code>backend</code></td>
|
|
3319
|
+
<td><code>Symbol</code></td>
|
|
3320
|
+
<td><code>:auto</code></td>
|
|
3321
|
+
<td>Storage backend (<code>:auto</code>, <code>:redis</code>, <code>:hash</code>)</td>
|
|
3322
|
+
</tr>
|
|
3323
|
+
<tr>
|
|
3324
|
+
<td><code>enable_cache</code></td>
|
|
3325
|
+
<td><code>Boolean</code></td>
|
|
3326
|
+
<td><code>true</code></td>
|
|
3327
|
+
<td>Whether to enable semantic caching</td>
|
|
3328
|
+
</tr>
|
|
3329
|
+
<tr>
|
|
3330
|
+
<td><code>network_name</code></td>
|
|
3331
|
+
<td><code>String, nil</code></td>
|
|
3332
|
+
<td><code>nil</code></td>
|
|
3333
|
+
<td>Network this memory belongs to</td>
|
|
3334
|
+
</tr>
|
|
3335
|
+
</tbody>
|
|
3336
|
+
</table>
|
|
3337
|
+
<h2 id="factory-method">Factory Method<a class="headerlink" href="#factory-method" title="Permanent link">¶</a></h2>
|
|
3338
|
+
<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">memory</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">create_memory</span><span class="p">(</span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">user_id</span><span class="p">:</span><span class="w"> </span><span class="mi">123</span><span class="w"> </span><span class="p">})</span>
|
|
3339
|
+
</span></code></pre></div>
|
|
3340
|
+
<h2 id="methods">Methods<a class="headerlink" href="#methods" title="Permanent link">¶</a></h2>
|
|
3341
|
+
<h3 id="set">set<a class="headerlink" href="#set" title="Permanent link">¶</a></h3>
|
|
3342
|
+
<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">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:key</span><span class="p">,</span><span class="w"> </span><span class="n">value</span><span class="p">)</span>
|
|
3343
|
+
</span></code></pre></div>
|
|
3344
|
+
<p>Store a value and notify subscribers asynchronously.</p>
|
|
3345
|
+
<p><strong>Parameters:</strong></p>
|
|
3346
|
+
<table>
|
|
3347
|
+
<thead>
|
|
3348
|
+
<tr>
|
|
3349
|
+
<th>Name</th>
|
|
3350
|
+
<th>Type</th>
|
|
3351
|
+
<th>Description</th>
|
|
3352
|
+
</tr>
|
|
3353
|
+
</thead>
|
|
3354
|
+
<tbody>
|
|
3355
|
+
<tr>
|
|
3356
|
+
<td><code>key</code></td>
|
|
3357
|
+
<td><code>Symbol</code>, <code>String</code></td>
|
|
3358
|
+
<td>Storage key</td>
|
|
3359
|
+
</tr>
|
|
3360
|
+
<tr>
|
|
3361
|
+
<td><code>value</code></td>
|
|
3362
|
+
<td><code>Object</code></td>
|
|
3363
|
+
<td>Value to store</td>
|
|
3364
|
+
</tr>
|
|
3365
|
+
</tbody>
|
|
3366
|
+
</table>
|
|
3367
|
+
<h3 id="get">get<a class="headerlink" href="#get" title="Permanent link">¶</a></h3>
|
|
3368
|
+
<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">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:key</span><span class="p">)</span><span class="w"> </span><span class="c1"># => value or nil</span>
|
|
3369
|
+
</span><span id="__span-5-2"><a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:key</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">)</span><span class="w"> </span><span class="c1"># Block until available</span>
|
|
3370
|
+
</span><span id="__span-5-3"><a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:key</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">)</span><span class="w"> </span><span class="c1"># Block up to 30 seconds</span>
|
|
3371
|
+
</span><span id="__span-5-4"><a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:a</span><span class="p">,</span><span class="w"> </span><span class="ss">:b</span><span class="p">,</span><span class="w"> </span><span class="ss">:c</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="mi">60</span><span class="p">)</span><span class="w"> </span><span class="c1"># Multiple keys, returns Hash</span>
|
|
3372
|
+
</span></code></pre></div>
|
|
3373
|
+
<p>Retrieve one or more values, optionally waiting until they exist.</p>
|
|
3374
|
+
<p><strong>Parameters:</strong></p>
|
|
3375
|
+
<table>
|
|
3376
|
+
<thead>
|
|
3377
|
+
<tr>
|
|
3378
|
+
<th>Name</th>
|
|
3379
|
+
<th>Type</th>
|
|
3380
|
+
<th>Description</th>
|
|
3381
|
+
</tr>
|
|
3382
|
+
</thead>
|
|
3383
|
+
<tbody>
|
|
3384
|
+
<tr>
|
|
3385
|
+
<td><code>keys</code></td>
|
|
3386
|
+
<td><code>Symbol</code>, <code>String</code></td>
|
|
3387
|
+
<td>One or more keys to retrieve</td>
|
|
3388
|
+
</tr>
|
|
3389
|
+
<tr>
|
|
3390
|
+
<td><code>wait</code></td>
|
|
3391
|
+
<td><code>Boolean</code>, <code>Numeric</code></td>
|
|
3392
|
+
<td><code>false</code>: immediate, <code>true</code>: block, <code>Numeric</code>: timeout</td>
|
|
3393
|
+
</tr>
|
|
3394
|
+
</tbody>
|
|
3395
|
+
</table>
|
|
3396
|
+
<p><strong>Returns:</strong> Single value for one key, <code>Hash</code> for multiple keys.</p>
|
|
3397
|
+
<p><strong>Raises:</strong> <code>AwaitTimeout</code> if timeout expires.</p>
|
|
3398
|
+
<h3 id="key">key?<a class="headerlink" href="#key" title="Permanent link">¶</a></h3>
|
|
3399
|
+
<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">memory</span><span class="o">.</span><span class="n">key?</span><span class="p">(</span><span class="ss">:key</span><span class="p">)</span><span class="w"> </span><span class="c1"># => Boolean</span>
|
|
3400
|
+
</span></code></pre></div>
|
|
3401
|
+
<p>Check if key exists. Aliases: <code>has_key?</code>, <code>include?</code>.</p>
|
|
3402
|
+
<h3 id="delete">delete<a class="headerlink" href="#delete" title="Permanent link">¶</a></h3>
|
|
3403
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-7-1"><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="ss">:key</span><span class="p">)</span><span class="w"> </span><span class="c1"># => deleted value</span>
|
|
3404
|
+
</span></code></pre></div>
|
|
3405
|
+
<p>Remove a key. Cannot delete reserved keys.</p>
|
|
3406
|
+
<h3 id="keys">keys<a class="headerlink" href="#keys" title="Permanent link">¶</a></h3>
|
|
3407
|
+
<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">memory</span><span class="o">.</span><span class="n">keys</span><span class="w"> </span><span class="c1"># => Array<Symbol></span>
|
|
3408
|
+
</span></code></pre></div>
|
|
3409
|
+
<p>Get all non-reserved keys.</p>
|
|
3410
|
+
<h3 id="clear">clear<a class="headerlink" href="#clear" title="Permanent link">¶</a></h3>
|
|
3411
|
+
<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">memory</span><span class="o">.</span><span class="n">clear</span>
|
|
3412
|
+
</span></code></pre></div>
|
|
3413
|
+
<p>Clear all non-reserved keys.</p>
|
|
3414
|
+
<h3 id="reset">reset<a class="headerlink" href="#reset" title="Permanent link">¶</a></h3>
|
|
3415
|
+
<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">memory</span><span class="o">.</span><span class="n">reset</span>
|
|
3416
|
+
</span></code></pre></div>
|
|
3417
|
+
<p>Reset memory to initial state (clears everything including reserved keys, preserves cache).</p>
|
|
3418
|
+
<h3 id="subscribe">subscribe<a class="headerlink" href="#subscribe" title="Permanent link">¶</a></h3>
|
|
3419
|
+
<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">sub_id</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">subscribe</span><span class="p">(</span><span class="ss">:key1</span><span class="p">,</span><span class="w"> </span><span class="ss">:key2</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">change</span><span class="o">|</span>
|
|
3420
|
+
</span><span id="__span-11-2"><a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"</span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2"> changed: </span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">value</span><span class="si">}</span><span class="s2">"</span>
|
|
3421
|
+
</span><span id="__span-11-3"><a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a><span class="k">end</span>
|
|
3422
|
+
</span></code></pre></div>
|
|
3423
|
+
<p>Subscribe to changes on one or more keys. Callback receives a <code>MemoryChange</code> object.</p>
|
|
3424
|
+
<p><strong>MemoryChange attributes:</strong></p>
|
|
3425
|
+
<table>
|
|
3426
|
+
<thead>
|
|
3427
|
+
<tr>
|
|
3428
|
+
<th>Attribute</th>
|
|
3429
|
+
<th>Type</th>
|
|
3430
|
+
<th>Description</th>
|
|
3431
|
+
</tr>
|
|
3432
|
+
</thead>
|
|
3433
|
+
<tbody>
|
|
3434
|
+
<tr>
|
|
3435
|
+
<td><code>key</code></td>
|
|
3436
|
+
<td><code>Symbol</code></td>
|
|
3437
|
+
<td>The changed key</td>
|
|
3438
|
+
</tr>
|
|
3439
|
+
<tr>
|
|
3440
|
+
<td><code>value</code></td>
|
|
3441
|
+
<td><code>Object</code></td>
|
|
3442
|
+
<td>New value</td>
|
|
3443
|
+
</tr>
|
|
3444
|
+
<tr>
|
|
3445
|
+
<td><code>previous</code></td>
|
|
3446
|
+
<td><code>Object</code></td>
|
|
3447
|
+
<td>Previous value</td>
|
|
3448
|
+
</tr>
|
|
3449
|
+
<tr>
|
|
3450
|
+
<td><code>writer</code></td>
|
|
3451
|
+
<td><code>String, nil</code></td>
|
|
3452
|
+
<td>Name of robot that wrote</td>
|
|
3453
|
+
</tr>
|
|
3454
|
+
<tr>
|
|
3455
|
+
<td><code>network_name</code></td>
|
|
3456
|
+
<td><code>String, nil</code></td>
|
|
3457
|
+
<td>Network name</td>
|
|
3458
|
+
</tr>
|
|
3459
|
+
<tr>
|
|
3460
|
+
<td><code>timestamp</code></td>
|
|
3461
|
+
<td><code>Time</code></td>
|
|
3462
|
+
<td>When the change occurred</td>
|
|
3463
|
+
</tr>
|
|
3464
|
+
<tr>
|
|
3465
|
+
<td><code>created?</code></td>
|
|
3466
|
+
<td><code>Boolean</code></td>
|
|
3467
|
+
<td>Previous was nil</td>
|
|
3468
|
+
</tr>
|
|
3469
|
+
<tr>
|
|
3470
|
+
<td><code>updated?</code></td>
|
|
3471
|
+
<td><code>Boolean</code></td>
|
|
3472
|
+
<td>Previous was not nil</td>
|
|
3473
|
+
</tr>
|
|
3474
|
+
<tr>
|
|
3475
|
+
<td><code>deleted?</code></td>
|
|
3476
|
+
<td><code>Boolean</code></td>
|
|
3477
|
+
<td>New value is nil</td>
|
|
3478
|
+
</tr>
|
|
3479
|
+
</tbody>
|
|
3480
|
+
</table>
|
|
3481
|
+
<h3 id="subscribe_pattern">subscribe_pattern<a class="headerlink" href="#subscribe_pattern" title="Permanent link">¶</a></h3>
|
|
3482
|
+
<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">sub_id</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">subscribe_pattern</span><span class="p">(</span><span class="s2">"analysis:*"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">change</span><span class="o">|</span>
|
|
3483
|
+
</span><span id="__span-12-2"><a id="__codelineno-12-2" name="__codelineno-12-2" href="#__codelineno-12-2"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"Analysis key </span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2"> updated"</span>
|
|
3484
|
+
</span><span id="__span-12-3"><a id="__codelineno-12-3" name="__codelineno-12-3" href="#__codelineno-12-3"></a><span class="k">end</span>
|
|
3485
|
+
</span></code></pre></div>
|
|
3486
|
+
<p>Subscribe to keys matching a glob pattern (<code>*</code> and <code>?</code> supported).</p>
|
|
3487
|
+
<h3 id="unsubscribe">unsubscribe<a class="headerlink" href="#unsubscribe" title="Permanent link">¶</a></h3>
|
|
3488
|
+
<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">memory</span><span class="o">.</span><span class="n">unsubscribe</span><span class="p">(</span><span class="n">sub_id</span><span class="p">)</span><span class="w"> </span><span class="c1"># => Boolean</span>
|
|
3489
|
+
</span></code></pre></div>
|
|
3490
|
+
<p>Remove a subscription by its ID.</p>
|
|
3491
|
+
<h3 id="merge">merge!<a class="headerlink" href="#merge" title="Permanent link">¶</a></h3>
|
|
3492
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-14-1"><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">merge!</span><span class="p">(</span><span class="ss">key1</span><span class="p">:</span><span class="w"> </span><span class="s2">"value1"</span><span class="p">,</span><span class="w"> </span><span class="ss">key2</span><span class="p">:</span><span class="w"> </span><span class="s2">"value2"</span><span class="p">)</span>
|
|
3493
|
+
</span></code></pre></div>
|
|
3494
|
+
<p>Merge multiple key-value pairs into memory.</p>
|
|
3495
|
+
<h2 id="reserved-key-accessors">Reserved Key Accessors<a class="headerlink" href="#reserved-key-accessors" title="Permanent link">¶</a></h2>
|
|
3496
|
+
<h3 id="data">data<a class="headerlink" href="#data" title="Permanent link">¶</a></h3>
|
|
3497
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-15-1"><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="w"> </span><span class="c1"># => StateProxy</span>
|
|
3498
|
+
</span><span id="__span-15-2"><a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">[</span><span class="ss">:user_id</span><span class="o">]</span><span class="w"> </span><span class="c1"># Hash access</span>
|
|
3499
|
+
</span><span id="__span-15-3"><a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">user_id</span><span class="w"> </span><span class="c1"># Method access</span>
|
|
3500
|
+
</span><span id="__span-15-4"><a id="__codelineno-15-4" name="__codelineno-15-4" href="#__codelineno-15-4"></a><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">[</span><span class="ss">:status</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"active"</span>
|
|
3501
|
+
</span></code></pre></div>
|
|
3502
|
+
<p>Runtime data accessed through <code>StateProxy</code> for method-style access.</p>
|
|
3503
|
+
<h3 id="results">results<a class="headerlink" href="#results" title="Permanent link">¶</a></h3>
|
|
3504
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-16-1"><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">results</span><span class="w"> </span><span class="c1"># => Array<RobotResult></span>
|
|
3505
|
+
</span></code></pre></div>
|
|
3506
|
+
<p>Accumulated robot results (returns a copy).</p>
|
|
3507
|
+
<h3 id="messages">messages<a class="headerlink" href="#messages" title="Permanent link">¶</a></h3>
|
|
3508
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-17-1"><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">messages</span><span class="w"> </span><span class="c1"># => Array<Message></span>
|
|
3509
|
+
</span></code></pre></div>
|
|
3510
|
+
<p>Conversation messages (returns a copy).</p>
|
|
3511
|
+
<h3 id="session_id">session_id<a class="headerlink" href="#session_id" title="Permanent link">¶</a></h3>
|
|
3512
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-18-1"><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">session_id</span><span class="w"> </span><span class="c1"># => String | nil</span>
|
|
3513
|
+
</span><span id="__span-18-2"><a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="n">memory</span><span class="o">.</span><span class="n">session_id</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s2">"abc"</span><span class="w"> </span><span class="c1"># Set session identifier</span>
|
|
3514
|
+
</span></code></pre></div>
|
|
3515
|
+
<h3 id="cache">cache<a class="headerlink" href="#cache" title="Permanent link">¶</a></h3>
|
|
3516
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-19-1"><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">cache</span><span class="w"> </span><span class="c1"># => RubyLLM::SemanticCache</span>
|
|
3517
|
+
</span></code></pre></div>
|
|
3518
|
+
<p>Semantic cache module (read-only after initialization).</p>
|
|
3519
|
+
<h2 id="serialization">Serialization<a class="headerlink" href="#serialization" title="Permanent link">¶</a></h2>
|
|
3520
|
+
<h3 id="to_h">to_h<a class="headerlink" href="#to_h" title="Permanent link">¶</a></h3>
|
|
3521
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-20-1"><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">to_h</span>
|
|
3522
|
+
</span><span id="__span-20-2"><a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a><span class="c1"># => { data: {...}, results: [...], messages: [...], session_id: "...", custom: {...} }</span>
|
|
3523
|
+
</span></code></pre></div>
|
|
3524
|
+
<h3 id="to_json">to_json<a class="headerlink" href="#to_json" title="Permanent link">¶</a></h3>
|
|
3525
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-21-1"><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="n">memory</span><span class="o">.</span><span class="n">to_json</span><span class="w"> </span><span class="c1"># => String</span>
|
|
3526
|
+
</span></code></pre></div>
|
|
3527
|
+
<h3 id="from_hash">from_hash<a class="headerlink" href="#from_hash" title="Permanent link">¶</a></h3>
|
|
3528
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-22-1"><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a><span class="n">memory</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Memory</span><span class="o">.</span><span class="n">from_hash</span><span class="p">(</span><span class="nb">hash</span><span class="p">)</span>
|
|
3529
|
+
</span></code></pre></div>
|
|
3530
|
+
<p>Reconstruct memory from a hash.</p>
|
|
3531
|
+
<h3 id="clone">clone<a class="headerlink" href="#clone" title="Permanent link">¶</a></h3>
|
|
3532
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-23-1"><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="n">new_memory</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">clone</span>
|
|
3533
|
+
</span></code></pre></div>
|
|
3534
|
+
<p>Deep copy with fresh subscriptions (cache and network_name preserved).</p>
|
|
3535
|
+
<h2 id="examples">Examples<a class="headerlink" href="#examples" title="Permanent link">¶</a></h2>
|
|
3536
|
+
<h3 id="basic-usage">Basic Usage<a class="headerlink" href="#basic-usage" title="Permanent link">¶</a></h3>
|
|
3537
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-24-1"><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:user_name</span><span class="p">,</span><span class="w"> </span><span class="s2">"Alice"</span><span class="p">)</span>
|
|
3538
|
+
</span><span id="__span-24-2"><a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:order_count</span><span class="p">,</span><span class="w"> </span><span class="mi">5</span><span class="p">)</span>
|
|
3539
|
+
</span><span id="__span-24-3"><a id="__codelineno-24-3" name="__codelineno-24-3" href="#__codelineno-24-3"></a>
|
|
3540
|
+
</span><span id="__span-24-4"><a id="__codelineno-24-4" name="__codelineno-24-4" href="#__codelineno-24-4"></a><span class="nb">name</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">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:user_name</span><span class="p">)</span><span class="w"> </span><span class="c1"># => "Alice"</span>
|
|
3541
|
+
</span><span id="__span-24-5"><a id="__codelineno-24-5" name="__codelineno-24-5" href="#__codelineno-24-5"></a><span class="n">count</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">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:order_count</span><span class="p">)</span><span class="w"> </span><span class="c1"># => 5</span>
|
|
3542
|
+
</span></code></pre></div>
|
|
3543
|
+
<h3 id="bracket-access">Bracket Access<a class="headerlink" href="#bracket-access" title="Permanent link">¶</a></h3>
|
|
3544
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-25-1"><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">[</span><span class="ss">:user_id</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">123</span>
|
|
3545
|
+
</span><span id="__span-25-2"><a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">[</span><span class="ss">:user_id</span><span class="o">]</span><span class="w"> </span><span class="c1"># => 123</span>
|
|
3546
|
+
</span></code></pre></div>
|
|
3547
|
+
<h3 id="storing-objects">Storing Objects<a class="headerlink" href="#storing-objects" title="Permanent link">¶</a></h3>
|
|
3548
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-26-1"><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="n">robot</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:user</span><span class="p">,</span><span class="w"> </span><span class="p">{</span>
|
|
3549
|
+
</span><span id="__span-26-2"><a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="w"> </span><span class="nb">id</span><span class="p">:</span><span class="w"> </span><span class="mi">123</span><span class="p">,</span>
|
|
3550
|
+
</span><span id="__span-26-3"><a id="__codelineno-26-3" name="__codelineno-26-3" href="#__codelineno-26-3"></a><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"Alice"</span><span class="p">,</span>
|
|
3551
|
+
</span><span id="__span-26-4"><a id="__codelineno-26-4" name="__codelineno-26-4" href="#__codelineno-26-4"></a><span class="w"> </span><span class="ss">plan</span><span class="p">:</span><span class="w"> </span><span class="s2">"pro"</span>
|
|
3552
|
+
</span><span id="__span-26-5"><a id="__codelineno-26-5" name="__codelineno-26-5" href="#__codelineno-26-5"></a><span class="p">})</span>
|
|
3553
|
+
</span><span id="__span-26-6"><a id="__codelineno-26-6" name="__codelineno-26-6" href="#__codelineno-26-6"></a>
|
|
3554
|
+
</span><span id="__span-26-7"><a id="__codelineno-26-7" name="__codelineno-26-7" href="#__codelineno-26-7"></a><span class="n">user</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">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:user</span><span class="p">)</span>
|
|
3555
|
+
</span><span id="__span-26-8"><a id="__codelineno-26-8" name="__codelineno-26-8" href="#__codelineno-26-8"></a><span class="n">user</span><span class="o">[</span><span class="ss">:plan</span><span class="o">]</span><span class="w"> </span><span class="c1"># => "pro"</span>
|
|
3556
|
+
</span></code></pre></div>
|
|
3557
|
+
<h3 id="blocking-reads-network-parallel-execution">Blocking Reads (Network Parallel Execution)<a class="headerlink" href="#blocking-reads-network-parallel-execution" title="Permanent link">¶</a></h3>
|
|
3558
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-27-1"><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="c1"># In robot A (writer)</span>
|
|
3559
|
+
</span><span id="__span-27-2"><a id="__codelineno-27-2" name="__codelineno-27-2" href="#__codelineno-27-2"></a><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">score</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="o">.</span><span class="mi">8</span><span class="p">,</span><span class="w"> </span><span class="ss">confidence</span><span class="p">:</span><span class="w"> </span><span class="mi">0</span><span class="o">.</span><span class="mi">95</span><span class="w"> </span><span class="p">})</span>
|
|
3560
|
+
</span><span id="__span-27-3"><a id="__codelineno-27-3" name="__codelineno-27-3" href="#__codelineno-27-3"></a>
|
|
3561
|
+
</span><span id="__span-27-4"><a id="__codelineno-27-4" name="__codelineno-27-4" href="#__codelineno-27-4"></a><span class="c1"># In robot B (reader, may run concurrently)</span>
|
|
3562
|
+
</span><span id="__span-27-5"><a id="__codelineno-27-5" name="__codelineno-27-5" href="#__codelineno-27-5"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="kp">true</span><span class="p">)</span><span class="w"> </span><span class="c1"># Block indefinitely</span>
|
|
3563
|
+
</span><span id="__span-27-6"><a id="__codelineno-27-6" name="__codelineno-27-6" href="#__codelineno-27-6"></a><span class="n">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="mi">30</span><span class="p">)</span><span class="w"> </span><span class="c1"># Block up to 30s</span>
|
|
3564
|
+
</span><span id="__span-27-7"><a id="__codelineno-27-7" name="__codelineno-27-7" href="#__codelineno-27-7"></a>
|
|
3565
|
+
</span><span id="__span-27-8"><a id="__codelineno-27-8" name="__codelineno-27-8" href="#__codelineno-27-8"></a><span class="c1"># Multiple keys with timeout</span>
|
|
3566
|
+
</span><span id="__span-27-9"><a id="__codelineno-27-9" name="__codelineno-27-9" href="#__codelineno-27-9"></a><span class="n">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:sentiment</span><span class="p">,</span><span class="w"> </span><span class="ss">:entities</span><span class="p">,</span><span class="w"> </span><span class="ss">:keywords</span><span class="p">,</span><span class="w"> </span><span class="ss">wait</span><span class="p">:</span><span class="w"> </span><span class="mi">60</span><span class="p">)</span>
|
|
3567
|
+
</span><span id="__span-27-10"><a id="__codelineno-27-10" name="__codelineno-27-10" href="#__codelineno-27-10"></a><span class="c1"># => { sentiment: {...}, entities: [...], keywords: [...] }</span>
|
|
3568
|
+
</span></code></pre></div>
|
|
3569
|
+
<h3 id="reactive-subscriptions">Reactive Subscriptions<a class="headerlink" href="#reactive-subscriptions" title="Permanent link">¶</a></h3>
|
|
3570
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-28-1"><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="c1"># Subscribe to a key</span>
|
|
3571
|
+
</span><span id="__span-28-2"><a id="__codelineno-28-2" name="__codelineno-28-2" href="#__codelineno-28-2"></a><span class="n">memory</span><span class="o">.</span><span class="n">subscribe</span><span class="p">(</span><span class="ss">:raw_data</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">change</span><span class="o">|</span>
|
|
3572
|
+
</span><span id="__span-28-3"><a id="__codelineno-28-3" name="__codelineno-28-3" href="#__codelineno-28-3"></a><span class="w"> </span><span class="n">enriched</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">enrich</span><span class="p">(</span><span class="n">change</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
|
|
3573
|
+
</span><span id="__span-28-4"><a id="__codelineno-28-4" name="__codelineno-28-4" href="#__codelineno-28-4"></a><span class="w"> </span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:enriched</span><span class="p">,</span><span class="w"> </span><span class="n">enriched</span><span class="p">)</span>
|
|
3574
|
+
</span><span id="__span-28-5"><a id="__codelineno-28-5" name="__codelineno-28-5" href="#__codelineno-28-5"></a><span class="k">end</span>
|
|
3575
|
+
</span><span id="__span-28-6"><a id="__codelineno-28-6" name="__codelineno-28-6" href="#__codelineno-28-6"></a>
|
|
3576
|
+
</span><span id="__span-28-7"><a id="__codelineno-28-7" name="__codelineno-28-7" href="#__codelineno-28-7"></a><span class="c1"># Subscribe with pattern</span>
|
|
3577
|
+
</span><span id="__span-28-8"><a id="__codelineno-28-8" name="__codelineno-28-8" href="#__codelineno-28-8"></a><span class="n">memory</span><span class="o">.</span><span class="n">subscribe_pattern</span><span class="p">(</span><span class="s2">"user:*"</span><span class="p">)</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="o">|</span><span class="n">change</span><span class="o">|</span>
|
|
3578
|
+
</span><span id="__span-28-9"><a id="__codelineno-28-9" name="__codelineno-28-9" href="#__codelineno-28-9"></a><span class="w"> </span><span class="nb">puts</span><span class="w"> </span><span class="s2">"User key </span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">key</span><span class="si">}</span><span class="s2"> updated by </span><span class="si">#{</span><span class="n">change</span><span class="o">.</span><span class="n">writer</span><span class="si">}</span><span class="s2">"</span>
|
|
3579
|
+
</span><span id="__span-28-10"><a id="__codelineno-28-10" name="__codelineno-28-10" href="#__codelineno-28-10"></a><span class="k">end</span>
|
|
3580
|
+
</span></code></pre></div>
|
|
3581
|
+
<h3 id="cross-robot-communication-via-network-memory">Cross-Robot Communication via Network Memory<a class="headerlink" href="#cross-robot-communication-via-network-memory" title="Permanent link">¶</a></h3>
|
|
3582
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-29-1"><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a><span class="c1"># In classifier robot</span>
|
|
3583
|
+
</span><span id="__span-29-2"><a id="__codelineno-29-2" name="__codelineno-29-2" href="#__codelineno-29-2"></a><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:intent</span><span class="p">,</span><span class="w"> </span><span class="s2">"billing"</span><span class="p">)</span>
|
|
3584
|
+
</span><span id="__span-29-3"><a id="__codelineno-29-3" name="__codelineno-29-3" href="#__codelineno-29-3"></a><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="ss">:entities</span><span class="p">,</span><span class="w"> </span><span class="o">[</span><span class="s2">"order"</span><span class="p">,</span><span class="w"> </span><span class="s2">"refund"</span><span class="o">]</span><span class="p">)</span>
|
|
3585
|
+
</span><span id="__span-29-4"><a id="__codelineno-29-4" name="__codelineno-29-4" href="#__codelineno-29-4"></a>
|
|
3586
|
+
</span><span id="__span-29-5"><a id="__codelineno-29-5" name="__codelineno-29-5" href="#__codelineno-29-5"></a><span class="c1"># In handler robot</span>
|
|
3587
|
+
</span><span id="__span-29-6"><a id="__codelineno-29-6" name="__codelineno-29-6" href="#__codelineno-29-6"></a><span class="n">intent</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:intent</span><span class="p">)</span>
|
|
3588
|
+
</span><span id="__span-29-7"><a id="__codelineno-29-7" name="__codelineno-29-7" href="#__codelineno-29-7"></a><span class="n">entities</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">network</span><span class="o">.</span><span class="n">memory</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="ss">:entities</span><span class="p">)</span>
|
|
3589
|
+
</span></code></pre></div>
|
|
3590
|
+
<h3 id="data-proxy">Data Proxy<a class="headerlink" href="#data-proxy" title="Permanent link">¶</a></h3>
|
|
3591
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-30-1"><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="n">memory</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">RobotLab</span><span class="o">.</span><span class="n">create_memory</span><span class="p">(</span>
|
|
3592
|
+
</span><span id="__span-30-2"><a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a><span class="w"> </span><span class="ss">data</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="ss">user</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nb">name</span><span class="p">:</span><span class="w"> </span><span class="s2">"Alice"</span><span class="p">,</span><span class="w"> </span><span class="ss">plan</span><span class="p">:</span><span class="w"> </span><span class="s2">"pro"</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="p">}</span>
|
|
3593
|
+
</span><span id="__span-30-3"><a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a><span class="p">)</span>
|
|
3594
|
+
</span><span id="__span-30-4"><a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a>
|
|
3595
|
+
</span><span id="__span-30-5"><a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">[</span><span class="ss">:user</span><span class="o">][</span><span class="ss">:name</span><span class="o">]</span><span class="w"> </span><span class="c1"># => "Alice"</span>
|
|
3596
|
+
</span><span id="__span-30-6"><a id="__codelineno-30-6" name="__codelineno-30-6" href="#__codelineno-30-6"></a><span class="n">memory</span><span class="o">.</span><span class="n">data</span><span class="o">.</span><span class="n">to_h</span><span class="w"> </span><span class="c1"># => { user: { name: "Alice", plan: "pro" } }</span>
|
|
3597
|
+
</span></code></pre></div>
|
|
3598
|
+
<h3 id="serialization_1">Serialization<a class="headerlink" href="#serialization_1" title="Permanent link">¶</a></h3>
|
|
3599
|
+
<div class="language-ruby highlight"><pre><span></span><code><span id="__span-31-1"><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="c1"># Save memory</span>
|
|
3600
|
+
</span><span id="__span-31-2"><a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="n">json</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">to_json</span>
|
|
3601
|
+
</span><span id="__span-31-3"><a id="__codelineno-31-3" name="__codelineno-31-3" href="#__codelineno-31-3"></a><span class="no">File</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="s2">"memory.json"</span><span class="p">,</span><span class="w"> </span><span class="n">json</span><span class="p">)</span>
|
|
3602
|
+
</span><span id="__span-31-4"><a id="__codelineno-31-4" name="__codelineno-31-4" href="#__codelineno-31-4"></a>
|
|
3603
|
+
</span><span id="__span-31-5"><a id="__codelineno-31-5" name="__codelineno-31-5" href="#__codelineno-31-5"></a><span class="c1"># Restore memory</span>
|
|
3604
|
+
</span><span id="__span-31-6"><a id="__codelineno-31-6" name="__codelineno-31-6" href="#__codelineno-31-6"></a><span class="n">data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">JSON</span><span class="o">.</span><span class="n">parse</span><span class="p">(</span><span class="no">File</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="s2">"memory.json"</span><span class="p">))</span>
|
|
3605
|
+
</span><span id="__span-31-7"><a id="__codelineno-31-7" name="__codelineno-31-7" href="#__codelineno-31-7"></a><span class="n">memory</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="no">Memory</span><span class="o">.</span><span class="n">from_hash</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
|
|
3606
|
+
</span></code></pre></div>
|
|
3607
|
+
<h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">¶</a></h2>
|
|
3608
|
+
<ul>
|
|
3609
|
+
<li><a href="../../../guides/memory/">Memory Guide</a></li>
|
|
3610
|
+
<li><a href="../../../architecture/state-management/">State Management Architecture</a></li>
|
|
3611
|
+
</ul>
|
|
3612
|
+
|
|
3613
|
+
|
|
3614
|
+
|
|
3615
|
+
|
|
3616
|
+
|
|
3617
|
+
|
|
3618
|
+
|
|
3619
|
+
|
|
3620
|
+
|
|
3621
|
+
|
|
3622
|
+
|
|
3623
|
+
|
|
3624
|
+
|
|
3625
|
+
<form class="md-feedback" name="feedback" hidden>
|
|
3626
|
+
<fieldset>
|
|
3627
|
+
<legend class="md-feedback__title">
|
|
3628
|
+
Was this page helpful?
|
|
3629
|
+
</legend>
|
|
3630
|
+
<div class="md-feedback__inner">
|
|
3631
|
+
<div class="md-feedback__list">
|
|
3632
|
+
|
|
3633
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page was helpful" data-md-value="1">
|
|
3634
|
+
<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>
|
|
3635
|
+
</button>
|
|
3636
|
+
|
|
3637
|
+
<button class="md-feedback__icon md-icon" type="submit" title="This page could be improved" data-md-value="0">
|
|
3638
|
+
<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>
|
|
3639
|
+
</button>
|
|
3640
|
+
|
|
3641
|
+
</div>
|
|
3642
|
+
<div class="md-feedback__note">
|
|
3643
|
+
|
|
3644
|
+
<div data-md-value="1" hidden>
|
|
3645
|
+
|
|
3646
|
+
|
|
3647
|
+
|
|
3648
|
+
|
|
3649
|
+
|
|
3650
|
+
|
|
3651
|
+
|
|
3652
|
+
|
|
3653
|
+
|
|
3654
|
+
Thanks for your feedback!
|
|
3655
|
+
</div>
|
|
3656
|
+
|
|
3657
|
+
<div data-md-value="0" hidden>
|
|
3658
|
+
|
|
3659
|
+
|
|
3660
|
+
|
|
3661
|
+
|
|
3662
|
+
|
|
3663
|
+
|
|
3664
|
+
|
|
3665
|
+
|
|
3666
|
+
|
|
3667
|
+
Thanks for your feedback! Help us improve by creating an issue.
|
|
3668
|
+
</div>
|
|
3669
|
+
|
|
3670
|
+
</div>
|
|
3671
|
+
</div>
|
|
3672
|
+
</fieldset>
|
|
3673
|
+
</form>
|
|
3674
|
+
|
|
3675
|
+
|
|
3676
|
+
|
|
3677
|
+
</article>
|
|
3678
|
+
</div>
|
|
3679
|
+
|
|
3680
|
+
|
|
3681
|
+
<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>
|
|
3682
|
+
|
|
3683
|
+
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
|
3684
|
+
</div>
|
|
3685
|
+
|
|
3686
|
+
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
|
3687
|
+
|
|
3688
|
+
<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>
|
|
3689
|
+
Back to top
|
|
3690
|
+
</button>
|
|
3691
|
+
|
|
3692
|
+
</main>
|
|
3693
|
+
|
|
3694
|
+
<footer class="md-footer">
|
|
3695
|
+
|
|
3696
|
+
|
|
3697
|
+
|
|
3698
|
+
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
3699
|
+
|
|
3700
|
+
|
|
3701
|
+
<a href="../tool/" class="md-footer__link md-footer__link--prev" aria-label="Previous: Tool">
|
|
3702
|
+
<div class="md-footer__button md-icon">
|
|
3703
|
+
|
|
3704
|
+
<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>
|
|
3705
|
+
</div>
|
|
3706
|
+
<div class="md-footer__title">
|
|
3707
|
+
<span class="md-footer__direction">
|
|
3708
|
+
Previous
|
|
3709
|
+
</span>
|
|
3710
|
+
<div class="md-ellipsis">
|
|
3711
|
+
Tool
|
|
3712
|
+
</div>
|
|
3713
|
+
</div>
|
|
3714
|
+
</a>
|
|
3715
|
+
|
|
3716
|
+
|
|
3717
|
+
|
|
3718
|
+
<a href="../../messages/" class="md-footer__link md-footer__link--next" aria-label="Next: Messages">
|
|
3719
|
+
<div class="md-footer__title">
|
|
3720
|
+
<span class="md-footer__direction">
|
|
3721
|
+
Next
|
|
3722
|
+
</span>
|
|
3723
|
+
<div class="md-ellipsis">
|
|
3724
|
+
Messages
|
|
3725
|
+
</div>
|
|
3726
|
+
</div>
|
|
3727
|
+
<div class="md-footer__button md-icon">
|
|
3728
|
+
|
|
3729
|
+
<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>
|
|
3730
|
+
</div>
|
|
3731
|
+
</a>
|
|
3732
|
+
|
|
3733
|
+
</nav>
|
|
3734
|
+
|
|
3735
|
+
|
|
3736
|
+
<div class="md-footer-meta md-typeset">
|
|
3737
|
+
<div class="md-footer-meta__inner md-grid">
|
|
3738
|
+
<div class="md-copyright">
|
|
3739
|
+
|
|
3740
|
+
<div class="md-copyright__highlight">
|
|
3741
|
+
Copyright © 2025 Dewayne VanHoozer
|
|
3742
|
+
</div>
|
|
3743
|
+
|
|
3744
|
+
|
|
3745
|
+
Made with
|
|
3746
|
+
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
|
3747
|
+
Material for MkDocs
|
|
3748
|
+
</a>
|
|
3749
|
+
|
|
3750
|
+
</div>
|
|
3751
|
+
|
|
3752
|
+
|
|
3753
|
+
<div class="md-social">
|
|
3754
|
+
|
|
3755
|
+
|
|
3756
|
+
|
|
3757
|
+
|
|
3758
|
+
|
|
3759
|
+
<a href="https://github.com/madbomber/robot_lab" target="_blank" rel="noopener" title="RobotLab on GitHub" class="md-social__link">
|
|
3760
|
+
<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>
|
|
3761
|
+
</a>
|
|
3762
|
+
|
|
3763
|
+
|
|
3764
|
+
|
|
3765
|
+
|
|
3766
|
+
|
|
3767
|
+
<a href="https://rubygems.org/gems/robot_lab" target="_blank" rel="noopener" title="RobotLab on RubyGems" class="md-social__link">
|
|
3768
|
+
<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>
|
|
3769
|
+
</a>
|
|
3770
|
+
|
|
3771
|
+
</div>
|
|
3772
|
+
|
|
3773
|
+
</div>
|
|
3774
|
+
</div>
|
|
3775
|
+
</footer>
|
|
3776
|
+
|
|
3777
|
+
</div>
|
|
3778
|
+
<div class="md-dialog" data-md-component="dialog">
|
|
3779
|
+
<div class="md-dialog__inner md-typeset"></div>
|
|
3780
|
+
</div>
|
|
3781
|
+
|
|
3782
|
+
|
|
3783
|
+
|
|
3784
|
+
|
|
3785
|
+
|
|
3786
|
+
<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>
|
|
3787
|
+
|
|
3788
|
+
|
|
3789
|
+
<script src="../../../assets/javascripts/bundle.79ae519e.min.js"></script>
|
|
3790
|
+
|
|
3791
|
+
|
|
3792
|
+
</body>
|
|
3793
|
+
</html>
|