docs(memory): add missing links

Ref: #102 Signed-off-by: Tomas Dvorak <toomas2d@gmail.com>
i-am-bee · Oct 19, 2024 · 09b1e2c · 09b1e2c
1 parent 65de51a
commit 09b1e2c
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 30 deletions.
diff --git a/docs/memory.md b/docs/memory.md
@@ -10,7 +10,7 @@ Memory in the context of an agent refers to the system's capability to store, re
 
 ### Capabilities showcase
 
-<!-- embedme examples/memory/unconstrainedMemory.ts -->
+<!-- embedme examples/memory/base.ts -->
 
 ```ts
 import { UnconstrainedMemory } from "bee-agent-framework/memory/unconstrainedMemory";
@@ -22,17 +22,14 @@ const memory = new UnconstrainedMemory();
 await memory.add(
   BaseMessage.of({
     role: "system",
-    text: `You are a helpful and funny assistant.`,
+    text: `You are a helpful assistant.`,
   }),
 );
 
 // Multiple messages
 await memory.addMany([
   BaseMessage.of({ role: "user", text: `What can you do?` }),
-  BaseMessage.of({
-    role: "assistant",
-    text: `Get it? I'm a helpful assistant, I can answer questions, provide information, and even tell jokes!`,
-  }),
+  BaseMessage.of({ role: "assistant", text: `Everything!` }),
 ]);
 
 console.info(memory.isEmpty()); // false
@@ -41,11 +38,7 @@ console.info(memory.asReadOnly()); // returns a NEW read only instance
 memory.reset(); // removes all messages
 ```
 
-_Source: [examples/memory/unconstrainedMemory.ts](/examples/memory/unconstrainedMemory.ts)_
-
-> [!TIP]
->
-> You can create a new read-only memory instance by calling the `asReadOnly` method on the existing one.
+_Source: [examples/memory/base.ts](/examples/memory/base.ts)_
 
 ### Usage with LLMs
 
@@ -129,18 +122,27 @@ The framework provides multiple out-of-the-box memory implementations.
 
 Unlimited in size.
 
+<!-- embedme examples/memory/unconstrainedMemory.ts -->
+
 ```ts
-import { OllamaChatLLM } from "bee-agent-framework/adapters/ollama/chat";
 import { UnconstrainedMemory } from "bee-agent-framework/memory/unconstrainedMemory";
 import { BaseMessage } from "bee-agent-framework/llms/primitives/message";
 
 const memory = new UnconstrainedMemory();
-await memory.add(BaseMessage.of({ role: "user", text: `Give me first 5 prime numbers.` }));
+await memory.add(
+  BaseMessage.of({
+    role: "user",
+    text: `Hello world!`,
+  }),
+);
 
-console.log(memory.isEmpty()); // false
+console.info(memory.isEmpty()); // false
 console.log(memory.messages.length); // 1
+console.log(memory.messages);
 ```
 
+_Source: [examples/memory/unconstrainedMemory.ts](/examples/memory/unconstrainedMemory.ts)_
+
 ### SlidingMemory
 
 Keeps last `k` entries in the memory. The oldest ones are deleted (unless specified otherwise).
@@ -209,6 +211,8 @@ console.log(memory.stats()); // prints statistics
 await memory.sync(); // calculates real token usage for all messages marked as "dirty"
 ```
 
+_Source: [examples/memory/tokenMemory.ts](/examples/memory/tokenMemory.ts)_
+
 ### SummarizeMemory
 
 Only a single summarization of the conversation is preserved. Summarization is updated with every new message.

diff --git a/examples/memory/base.ts b/examples/memory/base.ts
@@ -0,0 +1,23 @@
+import { UnconstrainedMemory } from "bee-agent-framework/memory/unconstrainedMemory";
+import { BaseMessage } from "bee-agent-framework/llms/primitives/message";
+
+const memory = new UnconstrainedMemory();
+
+// Single message
+await memory.add(
+  BaseMessage.of({
+    role: "system",
+    text: `You are a helpful assistant.`,
+  }),
+);
+
+// Multiple messages
+await memory.addMany([
+  BaseMessage.of({ role: "user", text: `What can you do?` }),
+  BaseMessage.of({ role: "assistant", text: `Everything!` }),
+]);
+
+console.info(memory.isEmpty()); // false
+console.info(memory.messages); // prints all saved messages
+console.info(memory.asReadOnly()); // returns a NEW read only instance
+memory.reset(); // removes all messages
diff --git a/examples/memory/unconstrainedMemory.ts b/examples/memory/unconstrainedMemory.ts
@@ -2,25 +2,13 @@ import { UnconstrainedMemory } from "bee-agent-framework/memory/unconstrainedMem
 import { BaseMessage } from "bee-agent-framework/llms/primitives/message";
 
 const memory = new UnconstrainedMemory();
-
-// Single message
 await memory.add(
   BaseMessage.of({
-    role: "system",
-    text: `You are a helpful and funny assistant.`,
+    role: "user",
+    text: `Hello world!`,
   }),
 );
 
-// Multiple messages
-await memory.addMany([
-  BaseMessage.of({ role: "user", text: `What can you do?` }),
-  BaseMessage.of({
-    role: "assistant",
-    text: `Get it? I'm a helpful assistant, I can answer questions, provide information, and even tell jokes!`,
-  }),
-]);
-
 console.info(memory.isEmpty()); // false
-console.info(memory.messages); // prints all saved messages
-console.info(memory.asReadOnly()); // returns a NEW read only instance
-memory.reset(); // removes all messages
+console.log(memory.messages.length); // 1
+console.log(memory.messages);