Skip to content
Open
Changes from all commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ memory:
personalize: true
messageWindowSize: 5
agent:
enabled: true
provider: 'openAI'
model: 'gpt-4'
instructions: 'You are a helpful assistant that remembers user preferences and context.'
Expand All @@ -27,6 +28,22 @@ memory:
max_tokens: 1000
```

<Callout type="info">
As of [PR #12886](https://github.com/danny-avila/LibreChat/pull/12886), the memory
**agent** must set `enabled: true` for automatic memory extraction to run.
If the flag is omitted, LibreChat logs a startup warning and skips automatic
extraction. Manual memory operations (create, edit, delete, reference)
continue to work regardless of the flag.

The warning looks like:

```text
[memory] Agent config detected without explicit `enabled: true`.
Automatic memory extraction is now opt-in.
Add `memory.agent.enabled: true` to keep automatic extraction on.
```
</Callout>

## disabled

<OptionTable
Expand Down Expand Up @@ -193,6 +210,7 @@ When you have a pre-configured agent, you can reference it by its ID:
```yaml filename="memory / agent (by ID)"
memory:
agent:
enabled: true
id: 'memory-agent-001'
```

Expand All @@ -203,6 +221,7 @@ For more control, you can define a complete agent configuration:
```yaml filename="memory / agent (custom)"
memory:
agent:
enabled: true
provider: 'openAI'
model: 'gpt-4'
instructions: 'You are a memory assistant that helps maintain conversation context and user preferences.'
Expand All @@ -216,6 +235,21 @@ memory:

When using custom agent configuration, the following fields are available:

**enabled** (required for automatic extraction)

<OptionTable
options={[
[
'enabled',
'Boolean',
'Explicitly enables the automatic memory-extraction agent. As of [PR #12886](https://github.com/danny-avila/LibreChat/pull/12886), an `agent` block without `enabled: true` logs a warning at startup and does not run automatic extraction. Manual memory operations remain available.',
'enabled: true',
],
]}
/>

**Default:** `false` (opt-in).

**provider** (required)

<OptionTable
Expand Down Expand Up @@ -284,6 +318,7 @@ memory:
personalize: true
messageWindowSize: 8
agent:
enabled: true
provider: 'openAI'
model: 'gpt-4'
instructions: |
Expand Down Expand Up @@ -330,6 +365,7 @@ memory:
personalize: true
messageWindowSize: 10
agent:
enabled: true
provider: 'Custom Memory Endpoint'
model: 'gpt-4o-mini'
```
Expand All @@ -345,5 +381,6 @@ memory:
- Valid keys provide granular control over what information can be stored
- Custom `instructions` replace default memory handling instructions and should be used with `validKeys`
- Agent configuration allows customization of memory processing behavior
- Automatic memory extraction is opt-in: `memory.agent.enabled: true` is required (see [PR #12886](https://github.com/danny-avila/LibreChat/pull/12886)). Manual memory operations remain available even without an enabled agent
- When disabled, all memory features are turned off regardless of other settings
- The message window size affects how much recent context is considered for memory updates