Refactor Redis Agent Memory documentation and add SDK quickstarts - #3745
Open
raphaeldelio wants to merge 14 commits into
Open
Refactor Redis Agent Memory documentation and add SDK quickstarts#3745raphaeldelio wants to merge 14 commits into
raphaeldelio wants to merge 14 commits into
Conversation
…ist of available features
…ngine/use-agent-memory.md with more precise terminology
…se-agent-memory.md - curl command now returns HTTP status code - fixed URL to AddSessionEvent documentation
- Adding jq to curl commands to prettify API response - Creating two long term memories to showcase semantic search more effectively - Fixing broken endpoints
raphaeldelio
marked this pull request as ready for review
August 6, 2026 08:59
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using high effort and found 1 potential issue.
Reviewed by Cursor Bugbot for commit 1cbb67b. Configure here.
| Follow the [Redis Cloud setup guide]({{< relref "/operate/iris/agent-memory/create-service" >}}) to create a Redis Agent Memory service. Then use the [REST API quickstart]({{< relref "/develop/ai/context-engine/agent-memory/rest-api-quickstart" >}}) to make your first session-memory and long-term-memory requests. | ||
|
|
||
| After you set up Agent Memory, you can [view and manage your service]({{< relref "/operate/rc/context-engine/agent-memory/view-service" >}}). | ||
| After you set up Redis Agent Memory, you can [view and manage your service]({{< relref "/operate/iris/agent-memory/view-service" >}}). |
There was a problem hiding this comment.
Orphaned agent memory get-started embed
Low Severity
rc-agent-memory-get-started.md was updated to point at the new Iris and REST quickstart URLs, but nothing in the repository references it after the Agent Memory landing page removed the multitabs embed that consumed it.
Reviewed by Cursor Bugbot for commit 1cbb67b. Configure here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.


Summary
This PR restructures the Redis Agent Memory documentation around two reader goals:
Documentation structure
The primary developer documentation lives under:
Develop with Redis → Redis for AI and search → Redis Iris context engine → Redis Agent Memory
Redis Iris is now treated as a separate product from Redis Cloud. Its operational documentation lives under:
Redis Products → Redis Iris context engine
This product section contains Redis Agent Memory, Redis Context Retriever, and LangCache. The pages explain how to create and manage these services on Redis Cloud. Self-managed Redis Agent Memory documentation remains under the Redis Agent Memory product section.
Previous Redis Cloud context-engine URLs redirect to the new Redis Iris locations.
Redis Agent Memory landing page
The landing page now provides:
The previous open-source Redis Agent Memory option was removed because there is no supported open-source Redis Agent Memory product.
Developer guide
The Developer guide provides:
sessionId,actorId,ownerId, and memory IDs.trip_preferenceexample.The client-library guides for implementing memory directly with Redis were removed. The Developer guide now focuses on using Redis Agent Memory.
SDKs are listed before the REST API throughout the Redis Agent Memory landing page, Developer guide, references, and sidebar navigation.
Quickstarts
This PR adds three quickstarts that follow the same travel planning journey:
redis-agent-memory.@redis-iris/agent-memory.curl.Each quickstart guides the reader through:
trip_preferencecustom memory type.The steps explain what each feature does, what output to expect, and which background processes may require a short wait. Production notes distinguish the short extraction cadence and summarization thresholds used for the exercises from values suitable for an application workload.
Redis Iris service configuration
The create and manage service documentation now covers:
Shared setup instructions keep these values consistent across all three quickstarts.
Consolidation
The standalone API examples page was removed. Its useful material is now covered by the REST API quickstart and the Developer guide.
The older Redis Cloud REST quickstart was also removed in favor of the shared developer quickstart. Existing links now point to the new location, and an alias preserves the previous URL.
Redis Cloud prerequisites and service creation instructions were moved into shared embeds to reduce duplicated content.
Redis Iris product documentation
The Redis Iris operational hierarchy is now:
The self-managed Redis Agent Memory documentation moved from Develop with Redis to Redis Products → Redis Iris context engine → Redis Agent Memory → Self-managed.
Aliases preserve the previous Redis Cloud and self-managed URLs. The Redis Products page template was updated to support the additional navigation depth.
Naming and technical corrections
References were normalized to Redis Agent Memory across the AI, Redis Iris context engine, Google ADK, Redis Cloud, and self-managed documentation.
The description of automatic extraction now reflects the current product behavior. Redis Agent Memory processes session events asynchronously and stores relevant information as long-term memory without requiring applications to trigger the process.
This PR also corrects the Redis Context Retriever name in its limitations section and updates the AWS Marketplace listing to its current title.
Note
Low Risk
Documentation-only changes with redirects/aliases; no application code or runtime behavior is modified.
Overview
This PR restructures Redis Agent Memory documentation for integration vs. operations and standardizes naming to Redis Agent Memory across AI, Iris, ADK, and self-managed pages.
Develop path: The landing page is rewritten around capabilities, a two-tier memory model, and a travel-planning example; the open-source deployment option is removed. The developer guide is expanded into a full integration reference (workflow, clients, identifiers, session/long-term memory, summarization, custom types, sensitive-data exclusions). Three parallel quickstarts (Python, TypeScript, REST) replace the standalone API examples page and the old Redis Cloud REST quickstart; shared embeds dedupe prerequisites and service-creation steps.
Operate path: Redis Iris context engine operational docs move from
/operate/rc/context-engineto/operate/iris, with aliases on moved pages. Self-managed Agent Memory docs relocate from develop to Redis Products → Iris → Agent Memory. Create/view service pages gain sensitive-data exclusions; links across LangCache and Context Retriever point at the new Iris URLs.Other: OpenAPI description text is tweaked; Google ADK integration docs use the Redis Agent Memory Server naming consistently.
Reviewed by Cursor Bugbot for commit 1cbb67b. Bugbot is set up for automated code reviews on this repo. Configure here.