[DOC] Add agentic memory retention policy documentation - #12825
[DOC] Add agentic memory retention policy documentation#12825AirFunnyB wants to merge 11 commits into
Conversation
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
822850a to
1222bbc
Compare
Signed-off-by: Erfan Ballew <ballewer@amazon.com>
1222bbc to
cb5e079
Compare
kolchfa-aws
added
release-notes
- Fix interval guidance: retention_job_interval_hours is set in opensearch.yml at initial setup (runtime change planned for a future release) - Fix 403 attribution: container APIs gate retention_policy, memory update API gates pinned - Fix working memory scope: working_memory_ttl_days applies to session-less containers, orphan_ttl_days to session-enabled containers - Remove unsupported per-type null example; clarify OR/dedup in Example 4 - Update recommended starting values and memory-types overview Signed-off-by: Erfan Ballew <ballewer@amazon.com>
| - `working_memory_ttl_days` ages out working memory in session-less containers. It is off by default. | ||
| - `orphan_ttl_days` sweeps working memory whose parent session no longer exists. |
There was a problem hiding this comment.
Suggest mention the full setting path, for example plugins.ml_commons.memory.working_memory_ttl_days
| - `working_memory_ttl_days` ages out working memory in session-less containers. It is off by default. | ||
| - `orphan_ttl_days` sweeps working memory whose parent session no longer exists. |
There was a problem hiding this comment.
Is there any default for orphan_ttl_days?
nathaliellenaa
left a comment
nathaliellenaa
left a comment
There was a problem hiding this comment.
LGTM on the technical side
- Add experimental-feature .warning notice (mingshl review comment) - Use full plugins.ml_commons.memory.* paths on first mention of working_memory_ttl_days and orphan_ttl_days (nathaliellenaa review) Signed-off-by: Erfan Ballew <ballewer@amazon.com>
- Retention policy retention_days/max_count truncate decimals to whole numbers (89.5 becomes 89) - Cluster default settings reject decimal values Signed-off-by: Erfan Ballew <ballewer@amazon.com>
|
|
||
| ## Cluster-level settings for administrators | ||
|
|
||
| Cluster administrators can configure retention behavior using dynamic cluster settings. All settings use the prefix `plugins.ml_commons.memory.` and can be updated at runtime without a restart, with one exception: `retention_job_interval_hours` is configured in `opensearch.yml` during initial setup and is applied once, when the retention job is first scheduled. The ability to change it on a running cluster is planned for a future release. |
There was a problem hiding this comment.
@AirFunnyB This seems not entirely true. Looking at the setting, it's declared as dynamic. Does the retention_job_interval_hours setting need to be configured in opensearch.yml or can users configure it via the Cluster Settings API?
There was a problem hiding this comment.
It's declared dynamic so the Cluster Settings API won't reject an update, but in this release that update isn't actually applied to the running retention job — the interval only takes effect when the job is first scheduled at cluster startup. So opensearch.yml at initial cluster setup is the only way to reliably set it today. Wiring a runtime change through to the live job is planned for a future release.
kolchfa-aws
added
Doc review
Long-term and history retention rules only act on stored memory, which requires llm_id + strategies + embedding. Show a fully-configured container in the quick-start example and note the assumption on the other create examples. Signed-off-by: Erfan Ballew <ballewer@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
kolchfa-aws
left a comment
kolchfa-aws
left a comment
There was a problem hiding this comment.
Thank you, @AirFunnyB! Doc review complete. Please review the rewritten version and verify that everything looks good, and we'll be ready to merge the PR.
Signed-off-by: kolchfa-aws <105444904+kolchfa-aws@users.noreply.github.com>
4 participants
Description
Adds a new documentation page for the agentic memory retention policy feature in ML Commons, covering retention policy structure, per-memory-type rules (
retention_days/max_count), pinning, the background retention job, cluster settings, and troubleshooting.New page:
_ml-commons-plugin/agentic-memory-retention.md(parent: Memory and context, nav_order 30).Issues Resolved
Closes #12854
Version
Introduced 3.8
Checklist