Skip to content

redis-developer/getting-started-with-redis-iris

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Getting Started with Redis Iris

A hands-on tutorial for Redis Iris, the context and memory platform that gives AI agents live, accurate, and navigable access to enterprise data.

This repo walks you through three of the core Iris tools using a sample healthcare dataset and a set of Jupyter notebooks:

Tool What you'll do
LangCache Semantically cache and reuse LLM responses to cut cost and latency.
Agent Memory Store short-term session state and long-term durable memory.
Context Retriever Model business entities and auto-generate MCP tools agents can call.

Note: View the full step-by-step tutorial for detailed instructions for this repo. This README is the quick reference for getting set up.

Prerequisites

Setup

  1. Clone the repo

    git clone https://github.com/redis-developer/getting-started-with-redis-iris.git
    cd getting-started-with-redis-iris
  2. Create your environment file

    cp .env.example .env

    Fill in the values as you create each Iris service in the Redis Cloud console (see step-by-step tutorial for where to find each one):

    LANGCACHE_ENDPOINT=
    LANGCACHE_ID=
    LANGCACHE_KEY=
    
    AGENT_MEMORY_ENDPOINT=
    AGENT_MEMORY_STORE_ID=
    AGENT_MEMORY_KEY=
    
    CONTEXT_RETRIEVER_AGENT_KEY=
  3. Set up a Python environment and install Jupyter

    python -m venv .venv
    source .venv/bin/activate
    pip install --upgrade pip
    pip install jupyter

    Each notebook installs its own dependencies (langcache, redis-agent-memory, redis-context-retriever, python-dotenv) in its first cell.

  4. Create a Redis Cloud database and load the sample healthcare dataset (data.redis) via Redis Insight. See the Context Retriever section of the tutorial for details.

Notebooks

Launch Jupyter and open a notebook from the jupyter/ directory:

jupyter notebook
Notebook Covers
jupyter/langcache.ipynb Saving and semantically searching cached LLM responses.
jupyter/agent-memory.ipynb Adding session events and long-term memories, then retrieving them.
jupyter/context-retriever.ipynb Listing and calling the MCP tools generated from your entities.

Each tool also has its own setup and cleanup steps in the Redis Cloud console — follow the matching section in the full tutorial.

Repository layout

.
├── cli-instructions.md  # Context Retriever CLI (ctxctl) reference
├── data.redis           # Sample healthcare dataset (load via Redis Insight)
├── jupyter/             # The three walkthrough notebooks
└── .env.example         # Template for service credentials

Sample dataset for Redis Context Retriever

This tutorial uses a hospital management dataset with five entities — Patient, Doctor, Appointment, Treatment, and Bill — which map to Redis keys like treatment:{id} and appointment:{id}.

Context Retriever turns these into MCP tools such as get_doctor_by_id, filter_appointment_by_patient_id, search_treatment_by_text, and find_treatment_by_cost_range.

References

About

Getting started with Redis Iris, a real-time context engine designed for AI.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors