Skip to main content

Redis Iris

One package for every Iris product: an opinionated Python API per product, and the iris CLI to set them all up.

CI Python 3.11+ Status: Alpha License: Apache 2.0

Install · Documentation · Releases · Contributing

Install

Requires Python 3.11+. uv is the recommended installer.

uv add redis-iris            # library, in your project
uv tool install redis-iris   # iris CLI, isolated
iris --help
pipx or pip
pipx install redis-iris
python -m pip install redis-iris   # inside an active virtual environment

uv projects with the fastapi-sse extra. uv takes a pre-release only when your own project names it, and the extra pins fastapi-redis-sdk to a pre-release, so uv add fails with hint: pre-releases weren't enabled. Restate the pin in your pyproject.toml:

[tool.uv]
constraint-dependencies = [
    "fastapi-redis-sdk==0.10.0b1",
]

For a LangGraph agent, install redis-iris[langgraph]; Configuration lists the extras, the per-product keys and the compatibility table.

From a source checkout, uv tool install --force . installs or replaces the iris tool, and python -m redis_iris runs the CLI wherever the package is installed.

Alpha releases may change commands and output contracts. Pin a version in automation and check the release notes before upgrading.

A2A integrations (beta)

Agent Mesh is in beta. Features and behavior are subject to change.

The optional a2a integration provides RedisTaskStore and RedisTaskEventStream for hosting A2A agents across API replicas, a producer heartbeat, and HTTP+JSON streaming routes that resume from Last-Event-ID. It requires Redis 8.6.2+ with JSON. They live under redis_iris.agent_mesh.a2a and accept application-owned async Redis clients. See host an A2A agent.

The stack

Iris is a suite of products. Use one, or all of them.

Product What your agent gets Instead of
Agent Memory Ordered session history, summarized automatically. Durable memories extracted in the background, typed to your domain and steered away from sensitive data. Recall across sessions, scoped to one customer plus shared team knowledge. Erase a customer in one call. an in-process store, a hand-built extraction chain, regex scrubbing
Agent Playbooks Answers only from published, versioned FAQs and Skills, scored. Rollback and withdrawal. Proposes an FAQ for human review when nothing covers the question. a vector store of unreviewed policy docs
Context Gateway One MCP endpoint and one agent key for every MCP server and Context Surface. Per-tool cache, and compression: large results as handles the agent pages through. a config entry and a secret per MCP server in every agent
Intent Router The user's prompt matched to one of the intents you defined, with its score and the dispatch target you attached. a prompt classifier you tune by hand, or an LLM call per routing decision
Lens One trace per turn: which memories and documents entered the prompt, tokens, cost. guessing why the agent said that

User guides

Your agent... Guide Product
forgets customers between sessions Remember customers Agent Memory
quotes policy nobody approved Answer from approved policy Agent Playbooks
needs to resume FastAPI events after a disconnect Add resumable SSE to FastAPI Agent Mesh (beta)
needs a project to start from on Redis Cloud Sample support app Agent Memory, Agent Playbooks
needs to be configured Configuration all
needs an Agent Memory service created Set up Agent Memory Agent Memory
needs a Playbook and an agent key created Set up Agent Playbooks Agent Playbooks
has policy content to author and publish Agent Playbooks CLI Agent Playbooks
needs a Context Gateway to reach its tools Context Gateway CLI Context Gateway
needs to route a prompt to an intent Intent Router CLI Intent Router
needs to list, revoke or rotate agent keys Identity CLI Every product

Integrate with an existing agent

Built your stack with a popular orchestration tool? A skill lets your coding agent do the wiring. Paste this into your coding agent:

Install the Redis Iris skills from github.com/redis/redis-iris, then use add-redis-iris to add Redis Iris to this agent.

Or install them yourself with npx skills add redis/redis-iris. They live in skills/.

I want my agent to... Skill
figure out what it needs add-redis-iris
remember customers add-agent-memory
quote approved policy only add-agent-playbooks
reach every MCP tool through one endpoint add-context-gateway
route a message to the right intent add-intent-router
show one trace per turn in Lens add-lens

The CLI

iris <product> <command> creates services, mints keys, and manages content. Shared options go before the product name.

iris agent-memory service create --from service.yaml --write-env .env
iris agent-memory service key <store-id> --actions read --name inspector --write .env.inspector
iris agent-memory memories search "how does this customer want answers" --owner cust-1042 --prompt
iris agent-playbooks extraction bind <store-id> --idle-seconds 60 --enable   # FAQ proposals from sessions
iris agent-playbooks faqs validate ./faqs            # offline
iris agent-playbooks faqs sync ./faqs --publish changed
iris --json --no-input agent-playbooks faqs plan ./faqs   # unattended, one JSON value on stdout
iris --profile production agent-playbooks health
iris --json context-gateway service list            # Context Gateway control plane
iris intent-router service create --name support --provider openai --model text-embedding-3-small \
  --dimensions 1536 --write-env .env
iris identity keys list --product intent            # agent keys, for every product

Settings resolve from command options, environment variables, the selected TOML profile, shared TOML settings, then defaults. API keys belong in environment variables. Exit codes are 0 for success, 1 for operational failures, and 2 for invalid input or configuration. Help, version, completion, and local validation work without credentials or a network connection.

Guides: Set up Agent Memory, Set up Agent Playbooks, Agent Playbooks CLI, Context Gateway CLI, Intent Router CLI, Identity CLI, Configuration, example TOML.

Upgrading to Agent Playbooks

The product is now Agent Playbooks; a Playbook is one instance. This follows the core SDK. Old environment variables and the old TOML table are still read as fallbacks, so existing .env files and TOML keep working; the CLI writes only the new names. iris agent-playbook stops with a pointer to the new group, and the Python names have no aliases.

Before Now
iris agent-playbook iris agent-playbooks
IRIS_AGENT_PLAYBOOK_ID IRIS_AGENT_PLAYBOOKS_PLAYBOOK_ID
IRIS_AGENT_PLAYBOOK_* (URL, API_KEY, CONTENT_API_KEY, SERVICE_URL, ...) IRIS_AGENT_PLAYBOOKS_*
TOML [agent_playbook], [profiles.<name>.agent_playbook] [agent_playbooks], [profiles.<name>.agent_playbooks]
redis_iris.agent_playbook, AgentPlaybook, AgentPlaybookSettings redis_iris.agent_playbooks, AgentPlaybooks, AgentPlaybooksSettings
IrisSettings.agent_playbook, Iris.agent_playbook() IrisSettings.agent_playbooks, Iris.agent_playbooks()

A new variable wins over its old name; set it empty to ignore the old one. The old TOML table is read only when the new one is absent.

Documentation

Read the docs in docs/, or render the site locally with task docs:serve.

Resource Start here to...
Core reference Every redis_iris class and setting
User guides One problem, one fix, per product
Skills Wire a product into an existing agent with a coding agent
llms.txt task docs:build writes site/llms.txt; hand that one file to a coding agent
Release notes Check changes before upgrading

Contributing

Bug reports, documentation improvements, and new integrations are welcome. Open an issue or read the contributor guide.

task install
task check   # formatting, lint, types, offline tests, package build

Maintainers: releases are described in the contributor guide.

License

Apache License 2.0.

Metadata

Release files for redis-iris 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for redis-iris 1.0.0
File Size Uploaded Provenance Actions
redis_iris-1.0.0.tar.gz 1.2 MB Without provenance Details for redis_iris-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for redis-iris 1.0.0
File Interpreter ABI Platform Actions
redis_iris-1.0.0-py3-none-any.whl Python 3 none any Details for redis_iris-1.0.0-py3-none-any.whl

Total release size: 1.6 MB

Release files / redis_iris-1.0.0.tar.gz

Download URL redis_iris-1.0.0.tar.gz
Size 1.2 MB
Tags Source
SHA-256 checksum
How to use checksums
4adf9df5f8b724cdb943ae3adc1a523443684d5cd5e3e1c2b3848dd8c9454b73
BLAKE2b-256 checksum
How to use checksums
20a0dc1bd0726c9b321b158a16db7fd509caedc02db8d30e3585158eb4bfef79
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / redis_iris-1.0.0-py3-none-any.whl

Download URL redis_iris-1.0.0-py3-none-any.whl
Size 411.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
b2da3e335f473a0436d6e01eee7df11c9bf4c269027b35aa37fb84fe97817764
BLAKE2b-256 checksum
How to use checksums
b26ea54a180160a3a7bd9ba92a41544eb9bbf824649545a92510d36e9cb526d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.16

Security for redis-iris 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page