Skip to content

Commit 56a10a2

Browse files
committed
Add agentic memory cluster setting
- Add plugins.ml_commons.agentic_memory_enabled setting to cluster-settings.md - Enables/disables agentic memory functionality for AI agents - Includes session, working, long-term memory, and memory history features Signed-off-by: Dhrubo Saha <[email protected]>
1 parent e82965d commit 56a10a2

File tree

6 files changed

+53
-22
lines changed

6 files changed

+53
-22
lines changed

_ml-commons-plugin/api/agentic-memory-apis/get-memory-by-type.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ GET /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/history/eMxnTp
9999
"conversation": "true"
100100
},
101101
"namespace": {
102-
"agent_id": "soap-user"
102+
"agent_id": "chat-agent"
103103
},
104104
"namespace_size": 1,
105105
"created_time": 1760052801773,
@@ -135,7 +135,7 @@ GET /_plugins/_ml/memory_containers/HudqiJkB1SltqOcZusVU/memories/history/eMxnTp
135135
"memory": "A comprehensive security investigation was performed across multiple data sources including 55 OpenSearch indices, 50 CloudTrail events, 22 VPC Flow logs, 38 WAF events, 74 CloudWatch log groups, active CloudWatch alarms, and OpenSearch cluster security configuration."
136136
},
137137
"namespace": {
138-
"agent_id": "soap-user"
138+
"agent_id": "chat-agent"
139139
},
140140
"namespace_size": 1,
141141
"tags": {

_ml-commons-plugin/api/agentic-memory-apis/search-memories-by-type.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 54
77
---
88

99
# Search memories by type
10-
**Introduced 3.2**
10+
**Introduced 3.3**
1111
{: .label .label-purple }
1212

1313
Use this API to search for memories of a specific type within a memory container. This unified API supports searching session, working, long-term, and history memory data.
@@ -27,14 +27,7 @@ GET /_plugins/_ml/memory_containers/<memory_container_id>/memories/<type>/_searc
2727

2828
## Request fields
2929

30-
The request body supports standard OpenSearch query DSL. Common fields include:
31-
32-
| Field | Data type | Description |
33-
| :--- | :--- | :--- |
34-
| `query` | Object | The search query using OpenSearch query DSL. Optional. |
35-
| `sort` | Array | Sort criteria for the results. Optional. |
36-
| `size` | Integer | Maximum number of results to return. Optional. |
37-
| `from` | Integer | Starting index for pagination. Optional. |
30+
The request body supports standard OpenSearch query DSL.
3831

3932
## Example requests
4033

_ml-commons-plugin/api/agentic-memory-apis/search-memory-container.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 25
77
---
88

99
# Search memory containers
10-
**Introduced 3.2**
10+
**Introduced 3.3**
1111
{: .label .label-purple }
1212

1313
Use this API to search for memory containers using OpenSearch query DSL.
@@ -21,14 +21,7 @@ POST /_plugins/_ml/memory_containers/_search
2121

2222
## Request fields
2323

24-
The request body supports standard OpenSearch query DSL. Common fields include:
25-
26-
| Field | Data type | Description |
27-
| :--- | :--- | :--- |
28-
| `query` | Object | The search query using OpenSearch query DSL. Optional. |
29-
| `sort` | Array | Sort criteria for the results. Optional. |
30-
| `size` | Integer | Maximum number of results to return. Optional. |
31-
| `from` | Integer | Starting index for pagination. Optional. |
24+
The request body supports standard OpenSearch query DSL.
3225

3326
## Example request
3427

_ml-commons-plugin/api/agentic-memory-apis/update-memory-by-type.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 52
77
---
88

99
# Update memory by type and ID
10-
**Introduced 3.2**
10+
**Introduced 3.3**
1111
{: .label .label-purple }
1212

1313
Use this API to update a specific memory by its type and ID. This unified API supports updating session, working, and long-term memory data. History memory does not support updates.

_ml-commons-plugin/api/agentic-memory-apis/update-memory-container.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ nav_order: 15
77
---
88

99
# Update memory container
10-
**Introduced 3.2**
10+
**Introduced 3.3**
1111
{: .label .label-purple }
1212

1313
Use this API to update an existing memory container's properties such as name and description.

_ml-commons-plugin/cluster-settings.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -494,6 +494,51 @@ plugins.ml_commons.memory_feature_enabled: true
494494
- Default value: `true`
495495
- Valid values: `false`, `true`
496496

497+
## Enable agentic memory
498+
499+
When set to `true`, this setting enables agentic memory functionality, which provides advanced memory management for AI agents including session memory, working memory, long-term memory, and memory history with namespace-based organization.
500+
501+
### Setting
502+
503+
```yaml
504+
plugins.ml_commons.agentic_memory_enabled: true
505+
```
506+
507+
### Values
508+
509+
- Default value: `true`
510+
- Valid values: `false`, `true`
511+
512+
## Set maximum memory containers per user
513+
514+
Controls the maximum number of memory containers that can be created per user. When set to `0`, no memory containers can be created.
515+
516+
### Setting
517+
518+
```yaml
519+
plugins.ml_commons.max_memory_containers_per_user: 100
520+
```
521+
522+
### Values
523+
524+
- Default value: `100`
525+
- Value range: [0, 10,000]
526+
527+
## Set maximum memories per container
528+
529+
Controls the maximum number of memories that can be stored in a single memory container. When set to `0`, no memories can be added to any container.
530+
531+
### Setting
532+
533+
```yaml
534+
plugins.ml_commons.max_memories_per_container: 10000
535+
```
536+
537+
### Values
538+
539+
- Default value: `10,000`
540+
- Value range: [0, 1,000,000]
541+
497542

498543
## Enable RAG pipeline
499544

0 commit comments

Comments
 (0)