mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-10 07:27:57 -05:00
37443a7b77
* improvement(kb): improve chunkers, respect user-specified chunk configurations, added tests * ack PR commnets * updated docs * cleanup
105 lines
3.3 KiB
Plaintext
105 lines
3.3 KiB
Plaintext
---
|
|
title: Memory
|
|
description: Add memory store
|
|
---
|
|
|
|
import { BlockInfoCard } from "@/components/ui/block-info-card"
|
|
|
|
<BlockInfoCard
|
|
type="memory"
|
|
color="#F64F9E"
|
|
/>
|
|
|
|
## Usage Instructions
|
|
|
|
Integrate Memory into the workflow. Can add, get a memory, get all memories, and delete memories.
|
|
|
|
|
|
|
|
## Tools
|
|
|
|
### `memory_add`
|
|
|
|
Add a new memory to the database or append to existing memory with the same ID.
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `conversationId` | string | No | Conversation identifier \(e.g., user-123, session-abc\). If a memory with this conversationId already exists, the new message will be appended to it. |
|
|
| `id` | string | No | Legacy parameter for conversation identifier. Use conversationId instead. Provided for backwards compatibility. |
|
|
| `role` | string | Yes | Role for agent memory \(user, assistant, or system\) |
|
|
| `content` | string | Yes | Content for agent memory |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `success` | boolean | Whether the memory was added successfully |
|
|
| `memories` | array | Array of memory objects including the new or updated memory |
|
|
| `error` | string | Error message if operation failed |
|
|
|
|
### `memory_get`
|
|
|
|
Retrieve memory by conversationId. Returns matching memories.
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `conversationId` | string | No | Conversation identifier \(e.g., user-123, session-abc\). Returns memories for this conversation. |
|
|
| `id` | string | No | Legacy parameter for conversation identifier. Use conversationId instead. Provided for backwards compatibility. |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `success` | boolean | Whether the memory was retrieved successfully |
|
|
| `memories` | array | Array of memory objects with conversationId and data fields |
|
|
| `message` | string | Success or error message |
|
|
| `error` | string | Error message if operation failed |
|
|
|
|
### `memory_get_all`
|
|
|
|
Retrieve all memories from the database
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `success` | boolean | Whether all memories were retrieved successfully |
|
|
| `memories` | array | Array of all memory objects with key, conversationId, and data fields |
|
|
| `message` | string | Success or error message |
|
|
| `error` | string | Error message if operation failed |
|
|
|
|
### `memory_delete`
|
|
|
|
Delete memories by conversationId.
|
|
|
|
#### Input
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| --------- | ---- | -------- | ----------- |
|
|
| `conversationId` | string | No | Conversation identifier \(e.g., user-123, session-abc\). Deletes all memories for this conversation. |
|
|
| `id` | string | No | Legacy parameter for conversation identifier. Use conversationId instead. Provided for backwards compatibility. |
|
|
|
|
#### Output
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ---- | ----------- |
|
|
| `success` | boolean | Whether the memory was deleted successfully |
|
|
| `message` | string | Success or error message |
|
|
| `error` | string | Error message if operation failed |
|
|
|
|
|
|
|
|
## Notes
|
|
|
|
- Category: `blocks`
|
|
- Type: `memory`
|