Merge pull request #3336 from redis/DOC-6613

RC/AI: Context Retriever

Author: mich-elle-luna

content/develop/ai/context-engine/agent-memory/_index.md

@@ -8,7 +8,7 @@ categories:
 description: Store agent memory for AI applications in Redis.
 linkTitle: Agent Memory
 hideListLinks: true
-weight: 10
+weight: 20
 bannerText: Redis Agent Memory is currently available in preview. Features and behavior are subject to change.
 bannerChildren: true
 ---

content/develop/ai/context-engine/context-retriever/_index.md

@@ -0,0 +1,41 @@
+---
+Title: Redis Context Retriever
+alwaysopen: false
+categories:
+- docs
+- develop
+- ai
+description: Expose tools to Agents to query your Redis databases. 
+linkTitle: Context Retriever
+hideListLinks: true
+weight: 30
+bannerText: Redis Context Retriever is currently available in preview. Features and behavior are subject to change.
+bannerChildren: true
+---
+
+Redis Context Retriever helps teams expose operational context to AI agents through schema-first retrieval. It models the entities, fields, keys, and relationships that matter to an agent workflow, then presents that context through a governed tool surface the agent can call at runtime. Context Retriever helps an AI Agent understand what business objects exist, how they connect, and which paths are safe to use.
+
+## Overview
+
+Production agents fail not because the model is wrong, but because the context layer breaks. Enterprise data can be fragmented across multiple different databases, and can be disorganized. Teams try to patch this with text-to-SQL, OpenAPI-to-MCP wrappers, or hand-built tools — which works for demos but creates tool zoo sprawl, SQL risk, and agents that can't reliably choose the right path in production. Redis Context Retriever gives teams a governed, schema-first surface agents can traverse safely.
+
+When you set up Redis Context Retriever, you model the objects that matter to your agent workflow and connect the relationships between them. You can do this either through the UI, using the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/), or the `ctxctl` CLI (available when you install the python client). Context Retriever will use those relationships to automatically create and deploy retrieval tools from your entity model.  
+
+When an agent needs context during execution, it calls the MCP tools Context Retriever exposes. Instead of guessing which tool to use, or generating SQL, the agent follows the defined entity paths and gets back structured, live, operational context. 
+
+## Get started with Redis Context Retriever
+
+Get started with Redis Context Retriever on Redis Cloud or join the private preview for Redis Software.
+
+{{< multitabs id="context-retriever-get-started"
+    tab1="Redis Cloud"
+    tab2="Redis Software (private preview)" >}}
+
+{{< embed-md "rc-context-retriever-get-started.md" >}}
+
+-tab-sep-
+
+Contact your Redis representative or [contact sales](https://redis.com/contact-sales/) to join the private preview on Redis Software.
+
+{{< /multitabs >}}
+

content/develop/ai/context-engine/langcache/_index.md

@@ -8,7 +8,7 @@ categories:
 description: Store LLM responses for AI apps in a semantic cache.
 linkTitle: LangCache
 hideListLinks: true
-weight: 30
+weight: 10
 bannerText: LangCache is currently available in preview. Features and behavior are subject to change.
 bannerChildren: true
 aliases:

content/embeds/rc-context-retriever-get-started.md

@@ -0,0 +1,5 @@
+To set up a Redis Context Retriever on Redis Cloud, you need a database on Redis Cloud that already has relevant data. If you use a relational database, use [Redis Data Integration (RDI)]({{< relref "/operate/rc/databases/rdi" >}}) to ingest data into a Redis Cloud database.
+
+When you have a database, [Create a context retriever service]({{< relref "/operate/rc/context-engine/context-retriever/create-service" >}}) for your database on Redis Cloud.
+
+After you set up Context Retriever, you can [view your service]({{< relref "/operate/rc/context-engine/context-retriever/view-service" >}}). See the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/) for more information on how to call your tools.

content/operate/rc/context-engine/context-retriever/_index.md

@@ -0,0 +1,26 @@
+---
+alwaysopen: false
+categories:
+- docs
+- operate
+- rc
+description: Expose schema-first retrieval tools from your Redis Cloud data to AI agents.
+hideListLinks: true
+linktitle: Context Retriever
+title: Redis Context Retriever on Redis Cloud
+weight: 37
+bannerText: Redis Context Retriever on Redis Cloud is currently available in preview. Features and behavior are subject to change.
+bannerChildren: true
+---
+
+Redis Context Retriever helps teams expose operational context to AI agents through schema-first retrieval. It models the entities, fields, keys, and relationships that matter to an agent workflow, then presents that context through a governed tool surface the agent can call at runtime. Context Retriever helps an AI agent understand what business objects exist, how they connect, and which paths are safe to use.
+
+When you set up Redis Context Retriever, you model the objects that matter to your agent workflow and connect the relationships between them. You can do this through the UI, the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/), or the `ctxctl` CLI (available when you install the Python client). Context Retriever uses those relationships to automatically create and deploy retrieval tools from your entity model.
+
+When an agent needs context during execution, it calls the MCP tools Context Retriever exposes. Instead of guessing which tool to use or generating SQL, the agent follows the defined entity paths and gets back structured, live, operational context.
+
+For more details, see the [Redis Context Retriever overview]({{< relref "/develop/ai/context-engine/context-retriever" >}}).
+
+## Get started with Context Retriever on Redis Cloud
+
+{{< embed-md "rc-context-retriever-get-started.md" >}}

content/operate/rc/context-engine/context-retriever/create-service.md

@@ -0,0 +1,114 @@
+---
+alwaysopen: false
+categories:
+- docs
+- operate
+- rc
+description: Create a Context Retriever service in Redis Cloud to expose schema-first retrieval tools to AI agents.
+hideListLinks: true
+linktitle: Create service
+title: Create a Context Retriever service
+weight: 5
+---
+
+Redis Context Retriever helps teams expose operational context to AI agents through schema-first retrieval. This guide walks you through creating and configuring a Context Retriever service in Redis Cloud.
+
+## Prerequisites and limitations
+
+To create a Redis Context Retriever service, you will need a Redis Cloud database that already has relevant data. If you don't have one, see [Create a database]({{< relref "/operate/rc/databases/create-database" >}}). If your source data lives in a relational database, use [Redis Data Integration (RDI)]({{< relref "/operate/rc/databases/rdi" >}}) to ingest it into a Redis Cloud database first.
+
+{{< note >}}
+Agent Memory does not support the following databases during public preview:
+- [Redis Flex]({{< relref "operate/rc/databases/create-database/create-flex-database">}}) databases
+- [Active-Active]({{< relref "/operate/rc/databases/active-active" >}}) databases
+{{< /note >}}
+
+## Create a Context Retriever service
+
+From the [Redis Cloud console](https://cloud.redis.io/), select **Context Retriever** from the left-hand menu.
+
+If you have not already created a Context Retriever service, you'll see a page with an introduction to Context Retriever. Otherwise, select **New service** to go to the Context Retriever introduction page.
+
+{{<image filename="images/rc/langcache-new-service.png" alt="The New service button." width="150px" >}}
+
+From here, you can either:
+
+- Select **Get started** to follow a step-by-step guide using the `ctxctl` CLI, which is installed with the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/). 
+- Select **Create custom service** to manually configure your own context retriever settings.
+
+For this guide, select **Create custom service**. 
+
+### General settings
+
+The **General settings** section defines basic properties of your service.
+
+{{<image filename="images/rc/context-retriever-general-settings.png" alt="The General settings section." >}}
+
+| Setting name | Description |
+|:-------------|:------------|
+| **Service name** | Enter a name for your Context Retriever service. We recommend you use a name that describes your service's purpose. |
+| **Select database** | Select the Redis Cloud database to use for this service from the list. |
+| **Description** | Enter a description for your context retriever. |
+
+Select **Entities** to continue.
+
+### Define entities
+
+In the **Define Entities** step, you'll define the objects that Context Retriever will use to generate retrieval tools. 
+
+{{<image filename="images/rc/context-retriever-define-entities.png" alt="The Entities section." >}}
+
+Select **Add Entity** to add an entity.
+
+{{<image filename="images/rc/context-retriever-define-entities-table.png" alt="The Entity table with the Entity Name, Key template, and description." >}}
+
+- In the **Entity name** field, enter the name of one of the business objects that is in your database. 
+
+    For example, your database might have a bunch of product information with keys like `product:1` or `product:2`. In this case, the entity name would be "Product".
+
+- In the **Key Template** field, enter the key template for your entity. Use `{id}` to denote where in the key pattern the ID is located.
+
+    For the example above, the key template would be `product:{id}`. 
+
+- You can also enter a description to describe the entity.
+
+- Select the checkmark to confirm the entity.
+
+After you are done adding all of the entities, select **Fields** to continue.
+
+### Configure fields
+
+In the **Configure fields** step, you'll define the fields of each entity and the relationships between them.
+
+From here, you can either:
+
+- Select **Auto-detect fields** to scan your database automatically using a model that will detect the fields for you. 
+
+    You'll need to agree to let the model scan your key names and schemas to automatically populate the fields. 
+
+    {{< note >}}
+If you use Auto-detect fields, make sure that the fields and relationships that the model generates are accurate. 
+    {{< /note >}}
+
+- Select **Manually enter fields** to manually enter the fields yourself.
+
+{{<image filename="images/rc/context-retriever-fields.png" alt="The Configure fields step." >}}
+
+Expand each entry to view the currently defined fields for that entry. Select **Add field** to add a field.
+
+{{<image filename="images/rc/context-retriever-add-field.png" alt="The Add field table." >}}
+
+- Enter the field name in the **Field** cell.
+- Select the **PK** checkbox if the field is a primary key. You must have at least one primary key. 
+- If the field is related to any other defined entities, select it from the **Related Entity** dropdown. This is usually set if the field contains primary keys of another entity. For example, you might have an
+- Select the field's **Type** from the dropdown.
+- In the **Index** cell, select one or more index types to enable searching and filtering on that field.
+- You can also add a description in the **Description** cell.
+
+After you set all fields for all of your entities, select **Create** to create your Context Retriever service.
+
+## Next steps
+
+After your service is created, you can call the MCP tools Context Retriever exposes from your agent. See the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/) for more information on how to call your tools.
+
+You can also [view your service]({{< relref "/operate/rc/context-engine/context-retriever/view-service" >}}).

content/operate/rc/context-engine/context-retriever/view-admin-keys.md

@@ -0,0 +1,62 @@
+---
+alwaysopen: false
+categories:
+- docs
+- operate
+- rc
+description: View and manage Context Retriever admin keys in Redis Cloud.
+hideListLinks: true
+linktitle: View admin keys
+title: View and manage Context Retriever admin keys
+weight: 25
+---
+
+After you have [created your first Context Retriever service]({{< relref "/operate/rc/context-engine/context-retriever/create-service" >}}), you can view and manage your admin keys from the **Admin keys** tab in the **Context Retriever** section of the Redis Cloud console.
+
+A Context Retriever **admin key** authorizes administrative operations against Context Retriever in your Redis Cloud account, such as creating, updating, or deleting services and their entity models. You can use it with the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/) and `cxtctl` CLI to create an Agent key and call your tools.
+
+## Admin keys tab
+
+From the [Redis Cloud console](https://cloud.redis.io/), select **Context Retriever** from the left-hand menu, then select the **Admin keys** tab.
+
+{{<image filename="images/rc/context-retriever-admin-keys-list.png" alt="The Admin keys tab showing the list of admin keys." >}}
+
+This tab shows a list of all admin keys associated with Context Retriever in your account. Here, you can generate a new admin key or remove any keys that are no longer in use. You can generate or remove admin keys at any time.
+
+| Column | Description |
+|:-------|:------------|
+| **Name** | The name you assigned to the admin key when you created it. |
+| **Value** | An abbreviated value of the admin key. |
+| **Created** | The date and time the admin key was generated. |
+
+## Generate a new admin key
+
+To generate a new admin key:
+
+1. Select **New admin key**.
+
+    {{<image filename="images/rc/context-retriever-new-admin-key.png" alt="The New admin key button." width=150px >}}
+
+1. Enter a name for your admin key.
+
+    {{<image filename="images/rc/context-retriever-add-admin-key.png" alt="The Add admin key window." >}}
+
+1. Select **Generate key** to generate your new admin key.
+
+1. The new key will appear in a dialog box. Select **Copy** to copy the key to the clipboard.
+
+    {{<image filename="images/rc/context-retriever-admin-key.png" alt="The Context Retriever admin key window. Use the Copy button to save the admin key to the clipboard." width=80% >}}
+
+    {{<warning>}}
+This is the only time the value of the admin key is available. Save it to a secure location before closing the dialog box.<br/><br/>
+
+If you lose the admin key value, you will need to generate a new admin key.
+    {{</warning>}}
+
+## Delete an admin key
+
+To delete an admin key, select the **Delete admin key** button next to the key you want to remove.
+
+{{<image filename="images/rc/icon-delete-lb.png" width="36px" alt="Delete button." >}}
+
+Deleting an admin key immediately revokes any administrative operations that rely on it. This action cannot be undone.

content/operate/rc/context-engine/context-retriever/view-service.md

@@ -0,0 +1,78 @@
+---
+alwaysopen: false
+categories:
+- docs
+- operate
+- rc
+description: View and manage your Context Retriever service in Redis Cloud.
+hideListLinks: true
+linktitle: View service
+title: View and manage Context Retriever service
+weight: 15
+---
+
+After you have [created your first Context Retriever service]({{< relref "/operate/rc/context-engine/context-retriever/create-service" >}}), selecting **Context Retriever** from the Redis Cloud Console menu will take you to the **Context Retriever Services** page.
+
+This page displays a list of all Context Retriever services associated with your account.
+
+{{<image filename="images/rc/context-retriever-service-list.png" alt="The Context Retriever service in the Context Retriever service list." >}}
+
+Select your Context Retriever service from the list to view the service's details.
+
+## Overview tab
+
+The **Overview** tab lets you view the details of your Context Retriever service. It contains the following sections:
+
+- The **Details** section provides the connection details and general settings for your Context Retriever service.
+- The **Entities** section shows the entities, fields, and relationships that Context Retriever exposes as tools.
+- The **Tools** section shows which tools are available to Agents.
+- The **Actions** section lets you delete your Context Retriever service.
+
+### Details
+
+The **Details** section provides general settings for your Context Retriever service.
+
+{{<image filename="images/rc/context-retriever-view-details.png" alt="The General settings for the Context Retriever service." >}}
+
+| Setting name | Description |
+|:-------------|:------------|
+| **Description** | The description of your Context Retriever service.  |
+| **Created** | The creation date for your service. |
+| **Updated** | The date your service was last updated. |
+
+### Entities
+
+The **Entities** section shows the entities, fields, and relationships that Context Retriever uses to generate retrieval tools.
+
+{{<image filename="images/rc/context-retriever-view-entities.png" alt="The Entities section for the Context Retriever service." >}}
+
+Expand each entity to view its fields, primary keys, related entities, types, and indexes. 
+
+### Tools
+
+The **Tools** section shows the tools that are available to your Agents.
+
+{{<image filename="images/rc/context-retriever-view-tools.png" alt="The Entities section for the Context Retriever service." >}}
+
+You can use your Agents to call your tools. For more information, see the [Context Surfaces Python Client](https://pypi.org/project/context-surfaces/)
+
+### Actions
+
+The **Actions** section lets you delete your Context Retriever service.
+
+{{<image filename="images/rc/context-retriever-view-actions.png" alt="The actions for the Context Retriever service." >}}
+
+#### Delete service
+
+Deleting your Context Retriever service permanently removes the service configuration, its entity model, and the generated tools. It also immediately terminates all API keys associated with the service. Data stored in the underlying Redis Cloud database remains unaffected.
+
+To delete your Context Retriever service:
+
+1. Select **Delete**.
+
+1. A confirmation dialog will appear. Select the checkbox to confirm that you want to delete the service.
+
+1. Select **Delete** again to confirm.
+
+Deleting the Context Retriever service is permanent and cannot be undone.
+