Repository navigation
Iris docs: Playbooks, Lens, Context Gateway and Agent Mesh examples on the 1.0 SDKs - #4403
Conversation
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>
🧠 Redis MemoryFound 5 related items from repository history (5 new this commit):
Memory updated at 59601f4 |
GA consistency pass for the Iris code examples, against the 1.0 SDK APIs (verified with the installed 1.0 betas, which have the same API).
Agent Playbooks
Python (
local_examples/iris/playbooks/**/*.py) and TypeScript (**/*.mts):.matches/.results->.items.faqs/.skills/.versions/.proposals->.items; removed thetotalline (1.0 lists are{items, nextCursor})minimum_score/minimumScore->min_score/minScoreproposal_revision/proposalRevision->revision,expected_proposal_revision/expectedProposalRevision->expectedRevision,.status->.state,entry_type="faq"->entry_kind="FAQ",action_type="ADD", viewsINBOX/TRASHsort_order="DESC"; proposal and evidencesourceuseskind, nottypeagent-playbooks/quickstart.md: removed "are prereleases"The page prose already used the 1.0 names. Step markers and step names did not change.
Verification:
npx tsc --noEmit(NodeNext, ES2022, strict) on every Playbooks.mtsagainst@redis-iris/agent-playbook@1.0.0-beta.1: clean. The unmodified files fail with 24 errors.mypyon every Python example againstredis-irismain andredis-agent-playbook1.0.0b1: no missing attributes or keyword arguments. The only output is noise from reused variables and dict-literal inference."desc"and"inbox", and rejects a source withoutkind.build/agent_playbook_docscannot run as-is. It points at the oldagent-playbook/path, pins0.1.0a3and0.1.0-alpha.3, and its fixture serves pre-1.0 shapes (matches,proposalRevision, lower-case states). It needs its own refresh.Lens
read_api.py/read_api.sh:outcome=["failed"]->["FAILED"]read-api.md:redis-agent-lens>=1.0.0; enum values in upper case (UNSET,ENTERED_PROMPT,FETCHED_NOT_USED,INVOKED_EMPTY,NOT_INSTRUMENTED,AVAILABLE,EXPIRED,NOT_CAPTURED,RECORDS,AGGREGATE)Verification:
mypyon all Lens examples againstredis-agent-lens1.0.0b1 andredis_iris.lens. Enum values were checked against the generated models and the Lens OpenAPI. Instrumentationset_outcome("completed")stays lower case, which matchesTURN_OUTCOMES.Context Gateway
No changes. There are no Context Gateway example files under
local_examples/; the pages refer to sets that don't exist yet. All its pages belong to #4358. I checkedContextGateway(from_env,call,tools,client,service) and the TypeScriptContextGateway/ContextGatewayServiceexports against 1.0.Agent Mesh
No changes. The inline A2A snippets match
redis_iris.agent_mesh.a2a:RedisTaskStore(..., takeover=),event_stream(),request_handler(),heartbeat(),create_resumable_rest_routes(...)andresumable_streams_extension(). The FastAPI SSE names are upstream re-exports that exist.Not in this PR
*.cli.sh(CLI tab) is still pre-1.0. For example, it uses--minimum-score, but the CLI flag is--min-score. It also reads.matches,.proposalRevisionand.results[0].limits.mdsays a source "showsnot-instrumented". It may refer to the UI label, so I left it.🤖 Generated with Claude Code
Note
Low Risk
Documentation and sample code only; no application or service logic changes.
Overview
Updates Iris Agent Playbooks and Lens docs and embedded examples for the 1.0 SDK contract so copy-pasted code matches GA types and enums.
Playbooks (Python and TypeScript under
local_examples/iris/playbooks/): paginated and search responses now iterateitemsinstead ofmatches,results, or resource-specific list fields; list examples droptotallogging. Filters and enums usemin_score,DESC, proposalrevision/expected_revision,state,INBOX/TRASH,entry_kind,action_type, and evidencesource.kind. The quickstart page no longer labels the Python SDK and CLI as prereleases.Lens (
read-api.mdplusread_api.py/read_api.sh): install pin moves toredis-agent-lens>=1.0.0; sessionoutcomeand documented manifest, availability, and gateway values use uppercase enums (e.g.FAILED,ENTERED_PROMPT,AVAILABLE).Context Gateway, Agent Mesh, and Playbooks CLI (
.cli.sh) examples are unchanged in this PR.Reviewed by Cursor Bugbot for commit 59601f4. Bugbot is set up for automated code reviews on this repo. Configure here.