Skip to content

RC/AI: Redis Agent Memory#3300

Merged
mich-elle-luna merged 19 commits into
mainfrom
DOC-6447
May 18, 2026
Merged

RC/AI: Redis Agent Memory#3300
mich-elle-luna merged 19 commits into
mainfrom
DOC-6447

Conversation

@cmilesb

@cmilesb cmilesb commented May 11, 2026

Copy link
Copy Markdown
Contributor

Still working on API examples page and service monitoring, but should be updated soon.


Note

Low Risk
Low risk documentation-only change, primarily adding new pages and updating links/aliases; main risk is broken navigation due to the large set of new routes and a likely copy/paste frontmatter title error in agent-memory/api-reference.md.

Overview
Adds a new Context Engine docs section under develop/ai describing LangCache, Agent Memory, Context Retriever, and Data integration, including new getting-started content and a full Agent Memory OpenAPI spec rendered via apireference.

Introduces corresponding Redis Cloud docs under operate/rc/context-engine for LangCache, Agent Memory, and Context Retriever (create/use/view flows, admin key management, embedded setup snippets), and updates existing LangCache docs/changelog/what’s-new links to the new context-engine routes while adding aliases for backward compatibility.

Reviewed by Cursor Bugbot for commit 7e3faa2. Bugbot is set up for automated code reviews on this repo. Configure here.

@cmilesb cmilesb requested a review from a team May 11, 2026 19:48
@cmilesb cmilesb self-assigned this May 11, 2026
@github-actions

github-actions Bot commented May 11, 2026

Copy link
Copy Markdown
Contributor

DOC-6447

@github-actions

github-actions Bot commented May 11, 2026

Copy link
Copy Markdown
Contributor

Staging links:
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/agent-memory/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/agent-memory/api-examples/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/agent-memory/api-reference/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/context-retriever/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/data-integration/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/langcache/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/langcache/api-examples/
https://redis.io/docs/staging/DOC-6447/develop/ai/context-engine/langcache/api-reference/
https://redis.io/docs/staging/DOC-6447/develop/whats-new/
https://redis.io/docs/staging/DOC-6447/operate/rc/accounts/
https://redis.io/docs/staging/DOC-6447/operate/rc/billing-and-payments/
https://redis.io/docs/staging/DOC-6447/operate/rc/changelog/july-2025/
https://redis.io/docs/staging/DOC-6447/operate/rc/cloud-integrations/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/agent-memory/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/agent-memory/create-service/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/agent-memory/use-agent-memory/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/agent-memory/view-service/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/context-retriever/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/context-retriever/create-service/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/context-retriever/view-admin-keys/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/context-retriever/view-service/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/langcache/
https://redis.io/docs/staging/DOC-6447/operate/rc/context-engine/langcache/create-service/

@jit-ci

jit-ci Bot commented May 11, 2026

Copy link
Copy Markdown

🛡️ Jit Security Scan Results

CRITICAL HIGH MEDIUM

✅ No security findings were detected in this PR


Security scan by Jit

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So far, so good. Just a few SG-related nitpicks. I can have a look at other pages as you add them if you wish.

Comment thread content/develop/ai/context-engine/agent-memory/_index.md Outdated
The promotion from short term memory to long-term memory is automatic. When you store a conversation event in session memory, the Agent Memory Server asynchronously extracts important information using the configured extraction strategy (discrete, summary, preferences, or custom). These extracted memories are then stored as long-term memory entries with vector embeddings and metadata.

This process is non-blocking: the extraction and promotion happen in the background via a task worker, so the main agent interaction remains responsive. Users do not need to explicitly trigger promotion; it happens as a natural byproduct of storing conversation events in working memory.
Users can also create long-term memories directly via the API.This is useful for bulk memory creation or for importing knowledge from external sources.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Users can also create long-term memories directly via the API.This is useful for bulk memory creation or for importing knowledge from external sources.
Users can also create long-term memories directly using the API.This is useful for bulk memory creation or for importing knowledge from external sources.

Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated

@mich-elle-luna mich-elle-luna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just a few typos, also I think that the agent-memory-service-key.png seems too large on the page.

Comment thread content/develop/ai/context-engine/agent-memory/_index.md Outdated
Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated
Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated
Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated
Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated
@mich-elle-luna

Copy link
Copy Markdown
Collaborator

thank you, looking great so far!

Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated
Comment thread content/operate/rc/context-engine/agent-memory/create-service.md Outdated
Comment thread content/operate/rc/context-engine/agent-memory/view-service.md Outdated
cmilesb and others added 3 commits May 12, 2026 15:42
Co-authored-by: David Dougherty <david.dougherty@redis.com>
Co-authored-by: mich-elle-luna <153109578+mich-elle-luna@users.noreply.github.com>
Co-authored-by: Cameron Bates <102550101+cmilesb@users.noreply.github.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cmilesb cmilesb requested review from a team, dwdougherty and mich-elle-luna May 12, 2026 21:52
@cmilesb cmilesb marked this pull request as ready for review May 12, 2026 21:52

@dwdougherty dwdougherty left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Latest commit looks good, but the API page links need to be more granular: I think you're still working on that content, right?

@dwdougherty dwdougherty requested a review from a team May 12, 2026 22:16
@cmilesb

cmilesb commented May 13, 2026

Copy link
Copy Markdown
Contributor Author

Latest commit looks good, but the API page links need to be more granular: I think you're still working on that content, right?

I forgot to update the tags 🤦 That's what I get for pushing things at 6PM. Thanks for the catch.

@mich-elle-luna mich-elle-luna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one comment from a reviewer in devrel team

When you call the API, you need to pass the Agent Memory API key in the `Authorization` header as a Bearer token and the store ID as the `storeId` path parameter.

For example:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question from devrel team was if you plan to include a drop-down menu to show programming-language examples, in addition to REST API calls? Just like we have with LangCache? In case of RAM, the Python SDK client?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's possible to have that, but I haven't had time and I figured I would prioritize getting something out rather than getting something perfect out. I can add that after release (or after I have something for context retriever).

### Add session event

Use [`POST /v1/stores/{storeId}/session-memory`]({{< relref "/develop/ai/context-engine/agent-memory/api-reference#tag/session-memory/operation/AddSessionEvent" >}}) to add an event to a session in short-term memory. If a session doesn't exist yet, it will be created.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something Ricardo noticed: It uses cache_id instead of store_id. And the REST API example does the same.

curl -s -X GET "https://$HOST/v1/caches/$CACHE_ID/session-memory/"
-H "accept: application/json"
-H "Authorization: Bearer $API_KEY"

It may be worth double-checking with the API Spec from Agent Memory.

Comment thread content/develop/ai/context-engine/agent-memory/api-examples.md Outdated
Comment thread content/develop/ai/context-engine/agent-memory/api-examples.md Outdated
cmilesb and others added 5 commits May 13, 2026 15:50
- Add Data Integration as a fourth Context Engine service on the index page
- Create develop/ai/context-engine/data-integration/ overview page with
  get started tabs for Redis Cloud and Redis Enterprise
- Remove em dashes and rewrite both pages in Google developer style

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Fix 8 inconsistencies between the hand-written documentation and the
Agent Memory OpenAPI spec (MemoryDataPlaneServer):

api-examples.md:
- Fix curl path: /v1/caches/ -> /v1/stores/ (wrong path segment)
- Fix Store ID description typo ("Store ID ID of your cache")
- Fix AddSessionEvent endpoint: /session-memory -> /session-memory/events
- Fix createdAt format: Unix ms -> ISO 8601 date-time (per MOD-15623)
- Fix duplicate namespace row in filter table (second should be topics)
- Add missing memoryType filter to the table
- Fix createdAt filter data type: integer -> string (ISO 8601)

create-service.md:
- Fix Long-term TTL description (was copy-pasted from database selector)

Verified against the Smithy-generated OpenAPI spec from langcache main
(commit fd8b6c2b).

Co-authored-by: Cursor <cursoragent@cursor.com>
…s-consistency

fix: align Agent Memory docs with current API spec
@CLAassistant

CLAassistant commented May 15, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@mich-elle-luna mich-elle-luna left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

- **Session memory** (also known as **Short-term memory** or **Working memory**) maintains the current conversation state, session history, and session-specific metadata. You can set a custom time-to-live (TTL) for session memory to control how long session data is retained.
- **Long-term memory** stores information extracted from past sessions, including user preferences, learned patterns, and other relevant data.

The promotion from short term memory to long-term memory is automatic. When you store a conversation event in session memory, the Agent Memory Server asynchronously extracts important information using the configured extraction strategy (discrete, summary, preferences, or custom). These extracted memories are then stored as long-term memory entries with vector embeddings and metadata.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the configured extraction strategy (discrete, summary, preferences, or custom) -> Note here that currently we only support a single extraction strategy that we call instruct internally, but I am thinking we don't even want to specify any strategy names in the docs. Best to confirm with @Jenverse

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The promotion from short term memory to long-term memory is automatic. When you store a conversation event in session memory, the Agent Memory Server asynchronously extracts important information using the configured extraction strategy (discrete, summary, preferences, or custom). These extracted memories are then stored as long-term memory entries with vector embeddings and metadata.
The promotion from short term memory to long-term memory is automatic. When you store a conversation event in session memory, the Agent Memory Server asynchronously extracts important information. These extracted memories are then stored as long-term memory entries with vector embeddings and metadata.


-tab-sep-

The open-source version of Redis Agent Memory is [available on GitHub](https://github.com/redis/agent-memory-server). See [Redis Agent Memory server](https://redis.github.io/agent-memory-server/) for comprehensive docs, quick start guides, and API references.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This OSS version of Redis Agent Memory has several differences with the cloud one, and its API is different, so I would double-check again with @Jenverse if we want to promote it here.


Use the [Agent Memory API]({{< relref "/develop/ai/context-engine/agent-memory/api-reference" >}}) from your client app to store and retrieve agent memory information.

You can use any standard REST client or library to access the API. If your app is written in Python, you can also use the [Agent Memory Software Development Kit](https://pypi.org/project/redis-agent-memory/) (SDK) to access the API.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit - we also have an SDK for Javascript/typescript: https://www.npmjs.com/package/@redis-iris/agent-memory?activeTab=readme


| Setting name |Description|
|:----------------------|:----------|
| **Short-term TTL** | Defines the time-to-live (TTL) of your agent's **short-term memory** (also known as **session memory**). You can define this TTL in seconds, minutes, hours, or days. Default: 1 hour |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit - we've changed the default to 1 Day at Jen's request (1 hours is also in the screenshot).

@mich-elle-luna mich-elle-luna merged commit dfc79b5 into main May 18, 2026
62 checks passed
@mich-elle-luna mich-elle-luna deleted the DOC-6447 branch May 18, 2026 12:44
EliShteinman added a commit to EliShteinman/docs that referenced this pull request May 19, 2026
RC/AI: Redis Agent Memory — adds Context Engine section (Agent Memory, Context Retriever, Data Integration) and renames LangCache under it.

Upstream merge commit: dfc79b5
Includes sub-PRs: redis#3336 (DOC-6613), redis#3332 (api-docs-consistency)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants