Metadata-Version: 2.4
Name: redis-iris
Version: 1.0.1
Summary: One package for every Iris product: an opinionated Python SDK per product, and the iris CLI to set them all up
Author: Redis
License-Expression: Apache-2.0
License-File: LICENSE
Keywords: agent-memory,agents,ai,cli,iris,mcp,redis,sdk
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=3.11
Requires-Dist: click<9,>=8.1.8
Requires-Dist: httpx2<3,>=2.10.0
Requires-Dist: httpx<1,>=0.28.1
Requires-Dist: opentelemetry-api<2,>=1.38
Requires-Dist: opentelemetry-exporter-otlp-proto-common<2,>=1.38
Requires-Dist: opentelemetry-sdk<2,>=1.38
Requires-Dist: platformdirs<5,>=4.3.6
Requires-Dist: pyyaml<7,>=6.0.2
Requires-Dist: redis-agent-memory==1.0.0
Requires-Dist: redis-agent-playbook==1.0.0
Requires-Dist: redis-context-gateway==1.0.0
Requires-Dist: redis-intent-router==1.0.0
Provides-Extra: a2a
Requires-Dist: a2a-sdk[http-server]<1.3,>=1.2.3; extra == 'a2a'
Requires-Dist: redis<9,>=8.0.1; extra == 'a2a'
Provides-Extra: fastapi-sse
Requires-Dist: fastapi-redis-sdk==0.10.0b1; extra == 'fastapi-sse'
Requires-Dist: redis<9,>=8.0.1; extra == 'fastapi-sse'
Provides-Extra: langgraph
Requires-Dist: langchain-core<2,>=1.0; extra == 'langgraph'
Requires-Dist: langgraph<2,>=1.0; extra == 'langgraph'
Provides-Extra: llm-tracing
Requires-Dist: opentelemetry-instrumentation-anthropic<1,>=0.62; extra == 'llm-tracing'
Requires-Dist: opentelemetry-instrumentation-bedrock<1,>=0.62; extra == 'llm-tracing'
Requires-Dist: opentelemetry-instrumentation-langchain<1,>=0.62; extra == 'llm-tracing'
Requires-Dist: opentelemetry-instrumentation-openai<1,>=0.62; extra == 'llm-tracing'
Requires-Dist: opentelemetry-instrumentation-threading<1,>=0.41b0; extra == 'llm-tracing'
Requires-Dist: wrapt<3,>=1.14; extra == 'llm-tracing'
Description-Content-Type: text/markdown

<div align="center">

# Redis Iris

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

[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-blue)](https://www.python.org/downloads/)
![License: Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue)

</div>

## Install

Requires **Python 3.11+**. [uv](https://docs.astral.sh/uv/getting-started/installation/) is the
recommended installer.

```bash
uv add redis-iris            # library, in your project
uv tool install redis-iris   # iris CLI, isolated
iris --help
```

<details>
<summary>pipx or pip</summary>

```bash
pipx install redis-iris
python -m pip install redis-iris   # inside an active virtual environment
```

</details>

**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`:

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

For a LangGraph agent, install `redis-iris[langgraph]`.

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.

## 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 |

## The CLI

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

```bash
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.


## 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.

## License

Apache License 2.0.
