Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Memory examples and docs improvements #1688

Merged
merged 25 commits into from
Feb 4, 2025
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
rename getMessages to query
  • Loading branch information
tyler barnes authored and tyler barnes committed Feb 4, 2025
commit 1a9c63d2867fc0e7e5bf1db94437f77f13b0997d
4 changes: 1 addition & 3 deletions docs/src/pages/docs/reference/memory/Memory.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,4 @@ const memory = new Memory({
### Related

- [createThread](/docs/reference/memory/createThread.mdx)
- [getMessages](/docs/reference/memory/getMessages.mdx)
- [addMessage](/docs/reference/memory/addMessage.mdx)
- [rememberMessages](/docs/reference/memory/rememberMessages.mdx)
- [query](/docs/reference/memory/query.mdx)
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# getMessages
# query

Retrieves messages from a specific thread, with support for pagination and filtering options.

Expand All @@ -10,15 +10,15 @@ import { Memory } from "@mastra/memory";
const memory = new Memory({ /* config */ });

// Get last 50 messages
const { messages, uiMessages } = await memory.getMessages({
const { messages, uiMessages } = await memory.query({
threadId: "thread-123",
selectBy: {
last: 50
}
});

// Get messages with context around specific messages
const { messages: contextMessages } = await memory.getMessages({
const { messages: contextMessages } = await memory.query({
threadId: "thread-123",
selectBy: {
include: [
Expand All @@ -36,7 +36,7 @@ const { messages: contextMessages } = await memory.getMessages({
});

// Semantic search in messages
const { messages: searchResults } = await memory.getMessages({
const { messages: searchResults } = await memory.query({
threadId: "thread-123",
selectBy: {
vectorSearchString: "What was discussed about deployment?"
Expand Down Expand Up @@ -142,12 +142,11 @@ const { messages: searchResults } = await memory.getMessages({

## Additional Notes

The `getMessages` function returns two different message formats:
The `query` function returns two different message formats:
- `messages`: Core message format used internally
- `uiMessages`: Formatted messages suitable for UI display, including proper threading of tool calls and results

### Related

- [Memory](/docs/reference/memory/Memory.mdx)
- [addMessage](/docs/reference/memory/addMessage.mdx)
- [rememberMessages](/docs/reference/memory/rememberMessages.mdx)