Repository navigation
Redis Iris GA docs - #4400
Draft
rbs333 wants to merge 171 commits into
Draft
Redis Iris GA docs#4400rbs333 wants to merge 171 commits into
rbs333 wants to merge 171 commits into
Conversation
…nto one TCE page
The Python and TypeScript agent-memory quickstarts were near-duplicate prose
with only the code fences differing. Merged them into one page
(sdk-quickstart.md) using the clients-example tabbed system, with two new
pseudo-client keys ("Agent Memory (Python)"/"Agent Memory (TypeScript)")
instead of reusing the real Python/Node.js client keys, so the tabs don't
misattribute to redis-py/node-redis.
Two build-script gaps surfaced adding the TypeScript source file:
build/local_examples.py's EXTENSION_TO_LANGUAGE had no .ts entry at all, and
build/components/example.py's PREFIXES dict had no 'typescript' comment style
either — no .ts file has ever existed under local_examples/ before this.
Both needed fixing together or the .ts source silently fails (first as an
"unknown extension" skip, then as a None-content crash further down the
pipeline once the language is recognized but has no comment prefix).
Modeled the footer-hiding on langcache_sdk's page, but its show_footer="false"
parameter turned out to be dead code — clients-example.html only ever checks
footer="hide" (confirmed back to the commit that introduced it). langcache's
live page is therefore not hiding what it thinks it's hiding. Used the
parameter that actually works here; did not fix langcache's page (out of
scope for this ticket).
The tab's visible title is literally the config.toml client key string (only
"Node.js"/"ioredis" get a hardcoded display-name override), so the new keys
had to be chosen to read well as tab labels directly, not as short internal
IDs.
Each clients-example step had to become a fully self-contained snippet
(imports + client construction repeated per step) rather than the "keep
editing one growing file" narrative the original two pages used, because the
shortcode slices only the exact STEP_START/STEP_END range with nothing
prepended.
Learned: .ts support needs EXTENSION_TO_LANGUAGE and PREFIXES kept in sync; langcache_sdk's show_footer param is dead code
Constraint: a clients-example tab's display name is its config.toml key verbatim (no Node.js/ioredis-style override exists for new keys)
Rejected: show_footer="false" | dead parameter in clients-example.html, only footer="hide" is read
Directive: don't add another .ts-based local example without confirming EXTENSION_TO_LANGUAGE (build/local_examples.py) and PREFIXES (build/components/example.py) both still list it
Gaps: agent_memory_sdk.py/.ts are hand-written, not harness-verified — no confirmed access to a running Agent Memory backend
Ticket: DOC-7121
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…espaces-custom-types
…sion-listing # Conflicts: # content/develop/ai/context-engine/agent-memory/_index.md
…ces-custom-types # Conflicts: # content/develop/ai/context-engine/agent-memory/_index.md # content/develop/ai/context-engine/agent-memory/developer-guide.md # content/develop/ai/context-engine/agent-memory/rest-api-quickstart.md # content/develop/ai/context-engine/agent-memory/sdk-quickstart.md
…ces-custom-types # Conflicts: # content/develop/ai/context-engine/agent-memory/_index.md # content/develop/ai/context-engine/agent-memory/interactive-demo.md # content/develop/ai/context-engine/agent-memory/overview.md
…sh-a2a-handoff # Conflicts: # content/develop/ai/context-engine/agent-mesh/a2a-sdk.md
docs(agent-mesh): document A2A task hand-off between processes
|
|
Contributor
🧠 Redis MemoryFound 8 related items from repository history:
Memory updated at 3f343bd |
Contributor
The cloud-ui console changed after the setup docs were drafted on 2026-10-27. Update the Agent Memory, Agent Playbooks, Context Gateway, and Lens pages to match it: - Agent Memory: the creation dialog, the Connect step and banner, all five service tabs, and the 128-character name limit. Remove the service-terms step and the screenshots of the old create flow. - Agent Playbooks: the Configuration tab, the Connect step and button in place of Manage API keys, the FAQ and Skill dialogs, the preview token budget switch, and Remove extraction job in the Danger zone. - Context Gateway: the Configuration and Upstreams tabs, a single Connect dialog, the 128- and 32-character limits, the bearer token and header buttons, the Surface database list, and Danger zone deletion with a confirmation checkbox. - Lens: label it Beta to match the console, write out the API key steps, add Delete Lens, and limit the credential prompt to self-managed Lens. Update the Lens AGENTS.md term rule to match. - Remove the public preview banner from the Redis Cloud Agent Memory page that the console links to. Open questions for the product team are marked with TODO comments where they apply. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
- Versions: treat the release as 1.0.0. Pin redis-iris and redis-agent-lens at >=1.0.0, drop the npm @beta tags, and drop the "prerelease" note from the Agent Playbooks quickstart. - Agent Playbooks CLI examples on redis-iris 1.0: faqs|skills|proposals show (not get), --min-score, search results in items, and the proposal revision field. - Finish the agent-playbook -> agent-playbooks rename outside content/: the iris-demo shortcode and request-flow script links, the Playbooks docs check workflow and its build tooling, and the pages' diagram references (the files keep their agent-playbook-*.svg names). - Remove the "Documentation review draft." banners from Agent Playbooks and Intent Router. Only Lens and Agent Mesh carry a banner (beta). - Interactive demo: Lens is beta, and the description names the services the tour shows. Link Context Gateway in its table. - SDK and CLI setup: document the Agent Memory database_id profile key. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Resolve conflicts with the iris-ga-docs changes: - operate/iris/_index.md: keep the GA intro and the Agent Playbooks, Context Gateway, and Lens tiles; add the Intent Router tile. - agent-playbooks/_index.md: keep the link to the Redis Cloud create page, using the renamed agent-playbooks quickstart path. - Lens banners and AGENTS.md: take the iris-ga-docs "currently in beta" wording, which matches Agent Mesh, and use it on the operate Lens banner too. - lens/quickstart.md: take the single Iris host prerequisites, which settle the read-endpoint TODO. Also repoint the operate Agent Playbooks pages' links from the old develop agent-playbook path to agent-playbooks. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Update Python and TypeScript snippets to the redis-agent-memory and @redis-iris/agent-memory 1.0 APIs: cursor pagination (items/next_cursor), list_sessions/listSessions, namespace_id/namespaceId in place of namespace references, query for search text, uppercase enum values, positional addSessionEvent(sessionId, body), viewId/view_id, and destination_namespace_id for routing rules. Fix the long-term memory link in the developer guide. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Python and TypeScript examples use the 1.0 response shapes and enums: search and list results in `items`, `min_score`/`minScore`, proposal `revision`/`expectedRevision` and `state`, `entry_kind`/`entryKind`, upper-case enum values (INBOX, TRASH, DESC, ADD, FAQ), source `kind`, and no `total` on list pages. Drop the prerelease note from the quickstart. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The read API's outcome filter and enum values are upper case in 1.0 (FAILED, UNSET, ENTERED_PROMPT, AVAILABLE, RECORDS). Require redis-agent-lens 1.0.0. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Iris docs: GA consistency pass on the 1.0 release and CLI
Iris docs: Agent Memory SDK snippets on the 1.0 SDKs
Iris docs: Playbooks, Lens, Context Gateway and Agent Mesh examples on the 1.0 SDKs
This was referenced Oct 30, 2026
Add Redis Cloud setup docs for the Iris GA services
MOD-20222: Align Gateway docs with the merged GA contract
MOD-20222: Align Context Gateway docs with the GA contract
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.
Redis Iris GA docs
This merges
iris-ga-docsintomain: the developer and operator docs for Redis Iris at GA. It's a draft until the open PRs below land and the pre-GA checklist is done.What's in it
The Iris docs now tell one developer story, across the products and the unified
redis-irisSDK and CLI (1.0.0):redis-irison Redis Cloud and self-managed. Every product's pages are aligned with the SDK and CLI, and Context Retriever is removed./iris/{data/,}v1/...paths,items/nextCursorlists, upper-case enums, typed IDs).There are 276 files, and they merge cleanly with
main. Most of the diff is runnable examples underlocal_examples/iris/and screenshots understatic/images/ai/context-engine/.build/agent_playbook_docs/is the tooling that builds and checks the Agent Playbooks examples.Still to land
Before GA
A consistency pass over this branch found the items below. Version policy: the docs name the versions we'll ship (1.0.0:
>=1.0.0pins, npm installs with no dist-tag, no "prerelease" notes), not the betas in flight.show,--min-score,items,revision), theagent-playbook→agent-playbooksrename outsidecontent/(shortcode, request-flow script, Playbooks docs check, diagram paths), the review-draft banners, the interactive demo, anddatabase_idin SDK and CLI setup.cursor/items,namespace_id,query, upper-case enums), and the brokenagent-memory/memorieslink.items,min_score,revision,state, upper-case enums). All 14 Playbooks.mtsfiles passtsc./v1/gatewayspaths,displayName, lowercase enums,--cascade, the@alphainstall, the "prereleases" note, and the obsolete0.1.0a5TODO./v1/storespaths, search"text",sessionIdin the event body, theredis-agent-lens>=0.1.0a4pin, andOutcome: completed(nowCOMPLETED).agent-playbooks/. Both still add pages under the oldagent-playbook/folder.build/agent_playbook_docs. Its test server and pins are still pre-1.0, so the Playbooks example tests can't run.<!-- TODO -->comments (35). Six Lens TODOs wait on Add Redis Cloud setup docs for the Iris GA services #4360's operator pages. The self-managed Context Gateway and Agent Memory ones need release facts (chart versions, image tags, Kubernetes and Redis versions, sizing) and product answers (the self-manageddatabase.databaseId, 404 versus 501 for Cloud-only calls on-prem).With #4401, #4402 and #4403 merged, a Hugo build of this branch (with
build/local_examples.py) passes with no Iris warnings. Everyiris …command in these docs resolves against the redis-iris CLI, except the Context Gateway--cascadeleft for #4358.Review notes
redis-iris1.0.0 and the 1.0.0 product SDKs. They were checked against the 1.0 betas, which have the same API.🤖 Generated with Claude Code