Skip to content

Iris docs: Playbooks, Lens, Context Gateway and Agent Mesh examples on the 1.0 SDKs - #4403

Merged
rbs333 merged 2 commits into
iris-ga-docsfrom
docs/iris-examples-1.0
Oct 30, 2026
Merged

rbs333 merged 2 commits into
iris-ga-docsfrom
docs/iris-examples-1.0

Conversation

@rbs333

@rbs333 rbs333 commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

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):

  • Search and lookup results: .matches / .results -> .items
  • List pages: .faqs / .skills / .versions / .proposals -> .items; removed the total line (1.0 lists are {items, nextCursor})
  • minimum_score / minimumScore -> min_score / minScore
  • Proposals: proposal_revision / proposalRevision -> revision, expected_proposal_revision / expectedProposalRevision -> expectedRevision, .status -> .state, entry_type="faq" -> entry_kind="FAQ", action_type="ADD", views INBOX / TRASH
  • Upper-case sort_order="DESC"; proposal and evidence source uses kind, not type
  • agent-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 .mts against @redis-iris/agent-playbook@1.0.0-beta.1: clean. The unmodified files fail with 24 errors.
  • mypy on every Python example against redis-iris main and redis-agent-playbook 1.0.0b1: no missing attributes or keyword arguments. The only output is noise from reused variables and dict-literal inference.
  • Runtime check of the enum and filter inputs: pydantic rejects "desc" and "inbox", and rejects a source without kind.
  • build/agent_playbook_docs cannot run as-is. It points at the old agent-playbook/ path, pins 0.1.0a3 and 0.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: mypy on all Lens examples against redis-agent-lens 1.0.0b1 and redis_iris.lens. Enum values were checked against the generated models and the Lens OpenAPI. Instrumentation set_outcome("completed") stays lower case, which matches TURN_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 checked ContextGateway (from_env, call, tools, client, service) and the TypeScript ContextGateway / ContextGatewayService exports 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(...) and resumable_streams_extension(). The FastAPI SSE names are upstream re-exports that exist.

Not in this PR

  • Playbooks *.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, .proposalRevision and .results[0].
  • Lens limits.md says a source "shows not-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 iterate items instead of matches, results, or resource-specific list fields; list examples drop total logging. Filters and enums use min_score, DESC, proposal revision / expected_revision, state, INBOX / TRASH, entry_kind, action_type, and evidence source.kind. The quickstart page no longer labels the Python SDK and CLI as prereleases.

Lens (read-api.md plus read_api.py / read_api.sh): install pin moves to redis-agent-lens>=1.0.0; session outcome and 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.

rbs333 and others added 2 commits October 30, 2026 16:02
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>
@github-actions

github-actions Bot commented Oct 30, 2026 •

Copy link
Copy Markdown
Contributor

🧠 Redis Memory

Found 5 related items from repository history (5 new this commit):

Memory updated at 59601f4

@rbs333
rbs333 merged commit 690e908 into iris-ga-docs Oct 30, 2026
55 of 56 checks passed
@rbs333
rbs333 deleted the docs/iris-examples-1.0 branch October 30, 2026 20:06
@rbs333 rbs333 mentioned this pull request Oct 30, 2026
3 of 11 tasks
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.

1 participant