From 8da8ce7a87626b4ced128fc1b945b9353eb85fe6 Mon Sep 17 00:00:00 2001 From: mich-elle-luna Date: Thu, 24 Sep 2026 15:23:34 -0700 Subject: [PATCH 1/5] Add Context Retriever quickstart CLI walkthrough covering install, admin-key creation, entity modeling, surface/agent-key creation, and calling a generated tool with ctxctl. Notes the Redis Cloud vs. self-managed sign-in split and links out to the install guide for the self-managed path. Co-Authored-By: Claude Sonnet 5 --- .../context-retriever/_index.md | 2 +- .../context-retriever/quickstart.md | 149 ++++++++++++++++++ 2 files changed, 150 insertions(+), 1 deletion(-) create mode 100644 content/develop/ai/context-engine/context-retriever/quickstart.md diff --git a/content/develop/ai/context-engine/context-retriever/_index.md b/content/develop/ai/context-engine/context-retriever/_index.md index 095fcb1085..daa42fccb5 100644 --- a/content/develop/ai/context-engine/context-retriever/_index.md +++ b/content/develop/ai/context-engine/context-retriever/_index.md @@ -69,7 +69,7 @@ pip install redis-context-retriever Use the `ctxctl` CLI, the Python client, or the Redis Cloud UI to model your entities and relationships. Context Retriever uses that model to automatically generate retrieval tools that agents call at runtime through its MCP interface — agents never access your database directly. -See the [Redis Cloud setup guide](/content/operate/iris/context-retriever/create-service.md) to create your first Context Retriever service. +See the [Redis Cloud setup guide](/content/operate/iris/context-retriever/create-service.md) to create your first Context Retriever service, or follow the [quickstart](/content/develop/ai/context-engine/context-retriever/quickstart.md) for a full CLI walkthrough: model entities, generate tools, and call one as an agent would. 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. diff --git a/content/develop/ai/context-engine/context-retriever/quickstart.md b/content/develop/ai/context-engine/context-retriever/quickstart.md new file mode 100644 index 0000000000..9c6e15e3b3 --- /dev/null +++ b/content/develop/ai/context-engine/context-retriever/quickstart.md @@ -0,0 +1,149 @@ +--- +alwaysopen: false +categories: +- docs +- develop +- ai +description: Model a data source, generate MCP tools, and call them from an agent using the ctxctl CLI. +hideListLinks: true +linktitle: Quickstart +title: Redis Context Retriever quickstart +weight: 10 +bannerText: Redis Context Retriever is currently available in preview. Features and behavior are subject to change. +--- + +Use this quickstart to model a Redis data source as a context surface, generate the retrieval tools Context Retriever exposes, and call one of those tools as an agent would. You will install the Python client, create an admin key, define entities in a model file, create a surface from that file, create an agent key scoped to it, then list and call the generated tools. + +This quickstart uses Redis Cloud. If you're running Context Retriever self-managed, see [Install Context Retriever]({{< relref "/develop/ai/context-engine/context-retriever/install" >}}) instead; every step after sign-in and admin-key creation is the same either way. + +## Before you begin + +To complete this quickstart, you need: + +* A Redis Cloud account. +* A Redis Cloud database that already contains some data, with a predictable key pattern (for example, `customer:1`, `customer:2`). If you don't have one, see [Create a database]({{< relref "/operate/rc/databases/create-database" >}}). +* Python 3.11 or later and `pip`. + +## Install the Python client + +The Python client includes the `ctxctl` CLI, which you use to model data, manage keys, and call the tools Context Retriever generates. + +```bash +pip install redis-context-retriever +``` + +## Sign in and create an admin key + +Start a session against your Redis Cloud account: + +```bash +ctxctl auth login -u +``` + +Create an admin key. An admin key authorizes operations such as creating surfaces and agent keys. + +```bash +ctxctl --output json admin create --name "quickstart-admin" +``` + +Save the returned key. Export it so later commands can use it: + +```bash +export CTX_ADMIN_KEY='' +``` + +This quickstart uses a Redis Cloud account for sign-in and admin-key creation. If you're running Context Retriever self-managed instead, see [Install Context Retriever]({{< relref "/develop/ai/context-engine/context-retriever/install" >}}) to bootstrap your first admin key. Every other step in this quickstart applies to both. + +## Define your data model + +Context Retriever generates tools from a data model, not from CLI flags entered one field at a time. Define your entities in a Python file. + +Create `models.py`: + +```python +from context_surfaces.context_model import ContextField, ContextModel + +class Customer(ContextModel): + __redis_key_template__ = "customer:{id}" + + id: str = ContextField(description="Unique customer ID", is_key_component=True) + name: str = ContextField(description="Customer name", index="text") + email: str = ContextField(description="Customer email address", index="tag") +``` + +## Create a surface + +Create a context surface from your model file, pointing it at your Redis Cloud database: + +```bash +ctxctl --output json surface create \ + --name "quickstart-surface" \ + --description "Quickstart context surface" \ + --models ./models.py \ + --redis-addr : \ + --redis-password '' \ + --admin-key "$CTX_ADMIN_KEY" +``` + +Save the returned surface ID: + +```bash +export CTX_SURFACE_ID='' +``` + +Confirm the surface was created: + +```bash +ctxctl surface describe "$CTX_SURFACE_ID" --admin-key "$CTX_ADMIN_KEY" +``` + +## Create an agent key + +An agent key authorizes an agent to call the tools generated for a surface. Create one scoped to the surface you just created: + +```bash +ctxctl --output json agent create \ + --surface-id "$CTX_SURFACE_ID" \ + --name "quickstart-agent" \ + --admin-key "$CTX_ADMIN_KEY" +``` + +Save the returned key: + +```bash +export CTX_AGENT_KEY='' +``` + +## List the generated tools + +As the admin, confirm which tools Context Retriever generated from your model: + +```bash +ctxctl tools list --agent-key "$CTX_AGENT_KEY" +``` + +The list includes tools such as a search tool and a get-by-ID tool for each entity you defined. + +## Call a tool + +Call a generated tool directly, using the agent key instead of the admin key: + +```bash +ctxctl tools call search_customer_by_text --agent-key "$CTX_AGENT_KEY" --args '{"query": "jane", "limit": 5}' +``` + +> [!NOTE] +> **What to expect:** A JSON result containing any customers whose indexed text fields match `jane`, up to 5 results. The agent never sends a database query directly. It calls a tool that Context Retriever generated from your model. + +## Clean up + +Delete the surface you created, which also revokes its agent keys: + +```bash +ctxctl surface delete "$CTX_SURFACE_ID" --admin-key "$CTX_ADMIN_KEY" --confirm +``` + +## Next steps + +* [Create a Context Retriever service in Redis Cloud]({{< relref "/operate/iris/context-retriever/create-service" >}}) using the console instead of the CLI. +* [Manage admin keys]({{< relref "/operate/iris/context-retriever/view-admin-keys" >}}). From b762217d1d2173edf8156d1fbf910e0e1f0465c8 Mon Sep 17 00:00:00 2001 From: mich-elle-luna Date: Thu, 24 Sep 2026 15:25:27 -0700 Subject: [PATCH 2/5] Cross-link Context Retriever quickstart and concepts pages Now that concepts.md is back on main post-rebase, link it from the quickstart's Next steps, and point concepts.md's Next steps at the quickstart instead of the bare PyPI link. Co-Authored-By: Claude Sonnet 5 --- content/develop/ai/context-engine/context-retriever/concepts.md | 2 +- .../develop/ai/context-engine/context-retriever/quickstart.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/content/develop/ai/context-engine/context-retriever/concepts.md b/content/develop/ai/context-engine/context-retriever/concepts.md index 051aaf9fc7..726583e67c 100644 --- a/content/develop/ai/context-engine/context-retriever/concepts.md +++ b/content/develop/ai/context-engine/context-retriever/concepts.md @@ -78,5 +78,5 @@ See the [AI agent context engine FAQ](https://redis.io/blog/faq-real-time-contex - [Create a Context Retriever service]({{< relref "/operate/iris/context-retriever/create-service" >}}) on Redis Cloud. - [Install Context Retriever]({{< relref "/develop/ai/context-engine/context-retriever/install" >}}) on your own Kubernetes infrastructure. -- Model your entities with the [Python client and `ctxctl` CLI](https://pypi.org/project/redis-context-retriever/). +- Follow the [quickstart]({{< relref "/develop/ai/context-engine/context-retriever/quickstart" >}}) to model entities, generate tools, and call one with the `ctxctl` CLI. - [Manage agent keys and access tags]({{< relref "/operate/iris/context-retriever/view-admin-keys" >}}) to control what each agent can reach. diff --git a/content/develop/ai/context-engine/context-retriever/quickstart.md b/content/develop/ai/context-engine/context-retriever/quickstart.md index 9c6e15e3b3..49672cd6e2 100644 --- a/content/develop/ai/context-engine/context-retriever/quickstart.md +++ b/content/develop/ai/context-engine/context-retriever/quickstart.md @@ -145,5 +145,6 @@ ctxctl surface delete "$CTX_SURFACE_ID" --admin-key "$CTX_ADMIN_KEY" --confirm ## Next steps +* Read [Context Retriever concepts]({{< relref "/develop/ai/context-engine/context-retriever/concepts" >}}) to understand tools, providers, and access tags. * [Create a Context Retriever service in Redis Cloud]({{< relref "/operate/iris/context-retriever/create-service" >}}) using the console instead of the CLI. * [Manage admin keys]({{< relref "/operate/iris/context-retriever/view-admin-keys" >}}). From 5c9c1bf2845d8a28b5039fb63b601ab7877f8ea9 Mon Sep 17 00:00:00 2001 From: mich-elle-luna Date: Thu, 24 Sep 2026 16:52:02 -0700 Subject: [PATCH 3/5] Move Context Retriever self-managed guide under operate/iris Relocate the self-managed install guide from develop/ai/context-engine/context-retriever/install/ to operate/iris/context-retriever/self-managed/, matching the directory convention LangCache and Agent Memory already use. Update frontmatter to match operate/iris siblings, add a redirect alias for the old path, update every internal link that pointed at it, and add the missing self-managed cross-link on the operate/iris/context-retriever index page for parity with its siblings. Co-Authored-By: Claude Sonnet 5 --- .../ai/context-engine/context-retriever/_index.md | 2 +- .../ai/context-engine/context-retriever/concepts.md | 2 +- .../ai/context-engine/context-retriever/quickstart.md | 4 ++-- content/operate/iris/context-retriever/_index.md | 2 ++ .../iris/context-retriever/self-managed}/_index.md | 10 ++++++---- 5 files changed, 12 insertions(+), 8 deletions(-) rename content/{develop/ai/context-engine/context-retriever/install => operate/iris/context-retriever/self-managed}/_index.md (98%) diff --git a/content/develop/ai/context-engine/context-retriever/_index.md b/content/develop/ai/context-engine/context-retriever/_index.md index daa42fccb5..6a9bb21f95 100644 --- a/content/develop/ai/context-engine/context-retriever/_index.md +++ b/content/develop/ai/context-engine/context-retriever/_index.md @@ -93,7 +93,7 @@ Get started with Redis Context Retriever on Redis Cloud or join the private prev -tab-sep- -Redis Context Retriever is available for self-managed deployment on Kubernetes as a private preview. See [Install Context Retriever](/content/develop/ai/context-engine/context-retriever/install/_index.md). +Redis Context Retriever is available for self-managed deployment on Kubernetes as a private preview. See [Install Context Retriever](/content/operate/iris/context-retriever/self-managed/_index.md). You need a license key to deploy — [contact Redis](https://redis.io/contact/) to request access. diff --git a/content/develop/ai/context-engine/context-retriever/concepts.md b/content/develop/ai/context-engine/context-retriever/concepts.md index 726583e67c..7e178258a8 100644 --- a/content/develop/ai/context-engine/context-retriever/concepts.md +++ b/content/develop/ai/context-engine/context-retriever/concepts.md @@ -77,6 +77,6 @@ See the [AI agent context engine FAQ](https://redis.io/blog/faq-real-time-contex ## Next steps - [Create a Context Retriever service]({{< relref "/operate/iris/context-retriever/create-service" >}}) on Redis Cloud. -- [Install Context Retriever]({{< relref "/develop/ai/context-engine/context-retriever/install" >}}) on your own Kubernetes infrastructure. +- [Install Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}) on your own Kubernetes infrastructure. - Follow the [quickstart]({{< relref "/develop/ai/context-engine/context-retriever/quickstart" >}}) to model entities, generate tools, and call one with the `ctxctl` CLI. - [Manage agent keys and access tags]({{< relref "/operate/iris/context-retriever/view-admin-keys" >}}) to control what each agent can reach. diff --git a/content/develop/ai/context-engine/context-retriever/quickstart.md b/content/develop/ai/context-engine/context-retriever/quickstart.md index 49672cd6e2..6e6e477177 100644 --- a/content/develop/ai/context-engine/context-retriever/quickstart.md +++ b/content/develop/ai/context-engine/context-retriever/quickstart.md @@ -14,7 +14,7 @@ bannerText: Redis Context Retriever is currently available in preview. Features Use this quickstart to model a Redis data source as a context surface, generate the retrieval tools Context Retriever exposes, and call one of those tools as an agent would. You will install the Python client, create an admin key, define entities in a model file, create a surface from that file, create an agent key scoped to it, then list and call the generated tools. -This quickstart uses Redis Cloud. If you're running Context Retriever self-managed, see [Install Context Retriever]({{< relref "/develop/ai/context-engine/context-retriever/install" >}}) instead; every step after sign-in and admin-key creation is the same either way. +This quickstart uses Redis Cloud. If you're running Context Retriever self-managed, see [Install Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}) instead; every step after sign-in and admin-key creation is the same either way. ## Before you begin @@ -52,7 +52,7 @@ Save the returned key. Export it so later commands can use it: export CTX_ADMIN_KEY='' ``` -This quickstart uses a Redis Cloud account for sign-in and admin-key creation. If you're running Context Retriever self-managed instead, see [Install Context Retriever]({{< relref "/develop/ai/context-engine/context-retriever/install" >}}) to bootstrap your first admin key. Every other step in this quickstart applies to both. +This quickstart uses a Redis Cloud account for sign-in and admin-key creation. If you're running Context Retriever self-managed instead, see [Install Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}) to bootstrap your first admin key. Every other step in this quickstart applies to both. ## Define your data model diff --git a/content/operate/iris/context-retriever/_index.md b/content/operate/iris/context-retriever/_index.md index fcf4fc1635..38c7a16ce4 100644 --- a/content/operate/iris/context-retriever/_index.md +++ b/content/operate/iris/context-retriever/_index.md @@ -21,6 +21,8 @@ When an agent needs context during execution, it calls the MCP tools Context Ret For more details, see the [Redis Context Retriever overview]({{< relref "/develop/ai/context-engine/context-retriever" >}}). +To deploy Context Retriever on your own Kubernetes infrastructure instead of Redis Cloud, see [self-managed Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}). + ## Get started with Context Retriever on Redis Cloud {{< embed-md "rc-context-retriever-get-started.md" >}} diff --git a/content/develop/ai/context-engine/context-retriever/install/_index.md b/content/operate/iris/context-retriever/self-managed/_index.md similarity index 98% rename from content/develop/ai/context-engine/context-retriever/install/_index.md rename to content/operate/iris/context-retriever/self-managed/_index.md index efeb838903..2609466662 100644 --- a/content/develop/ai/context-engine/context-retriever/install/_index.md +++ b/content/operate/iris/context-retriever/self-managed/_index.md @@ -1,16 +1,18 @@ --- -Title: Install Context Retriever +Title: Self-managed Context Retriever alwaysopen: false categories: - docs -- develop -- ai +- operate +- iris description: Install and run Redis Context Retriever on a self-managed Kubernetes cluster using Helm. -linkTitle: Install Context Retriever +linkTitle: Self-managed weight: 40 hideListLinks: true bannerText: Redis Context Retriever self-managed is currently in private preview and subject to change. A license key is required to deploy — contact your Redis representative or [contact sales](https://redis.io/contact/). bannerChildren: true +aliases: +- /develop/ai/context-engine/context-retriever/install/ --- Context Retriever is distributed as container images on Docker Hub plus a Helm chart shipped in the Redis Enterprise Helm repository. Installation pulls the images from Docker Hub (or your own mirror) and deploys the chart against a Redis database you provide. From b7ec64f605326a2ac29665f8f9d77c22c1679e82 Mon Sep 17 00:00:00 2001 From: mich-elle-luna <153109578+mich-elle-luna@users.noreply.github.com> Date: Fri, 25 Sep 2026 09:42:09 -0700 Subject: [PATCH 4/5] Update content/develop/ai/context-engine/context-retriever/quickstart.md Co-authored-by: andy-stark-redis <164213578+andy-stark-redis@users.noreply.github.com> --- .../develop/ai/context-engine/context-retriever/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/develop/ai/context-engine/context-retriever/quickstart.md b/content/develop/ai/context-engine/context-retriever/quickstart.md index 6e6e477177..5bddd6916d 100644 --- a/content/develop/ai/context-engine/context-retriever/quickstart.md +++ b/content/develop/ai/context-engine/context-retriever/quickstart.md @@ -12,7 +12,7 @@ weight: 10 bannerText: Redis Context Retriever is currently available in preview. Features and behavior are subject to change. --- -Use this quickstart to model a Redis data source as a context surface, generate the retrieval tools Context Retriever exposes, and call one of those tools as an agent would. You will install the Python client, create an admin key, define entities in a model file, create a surface from that file, create an agent key scoped to it, then list and call the generated tools. +Use this quickstart to model a Redis data source as a context surface, generate the retrieval tools that Context Retriever exposes, and call one of those tools as an agent would. You will install the Python client, create an admin key, define entities in a model file, create a surface from that file, create an agent key scoped to it, then list and call the generated tools. This quickstart uses Redis Cloud. If you're running Context Retriever self-managed, see [Install Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}) instead; every step after sign-in and admin-key creation is the same either way. From a532a72da13ee2fb2f7b325d2c6725fab2cbc944 Mon Sep 17 00:00:00 2001 From: mich-elle-luna Date: Fri, 25 Sep 2026 11:04:30 -0700 Subject: [PATCH 5/5] Address review feedback on Context Retriever quickstart - Add a "Load sample data" step with concrete redis-cli commands so the tool-call example returns predictable, documented results instead of "whatever data you happen to have." - Number the multi-action sections (sign in/create admin key, create surface, create agent key) per house style. - Replace the long run-on intro sentence with a scannable, linked list of the quickstart's steps. - Rename the Context Retriever self-managed page's title/linkTitle to include "Install" so it isn't mistaken for an overview page. --- .../context-retriever/quickstart.md | 113 +++++++++++------- .../context-retriever/self-managed/_index.md | 4 +- 2 files changed, 72 insertions(+), 45 deletions(-) diff --git a/content/develop/ai/context-engine/context-retriever/quickstart.md b/content/develop/ai/context-engine/context-retriever/quickstart.md index 5bddd6916d..207c164fe0 100644 --- a/content/develop/ai/context-engine/context-retriever/quickstart.md +++ b/content/develop/ai/context-engine/context-retriever/quickstart.md @@ -12,7 +12,19 @@ weight: 10 bannerText: Redis Context Retriever is currently available in preview. Features and behavior are subject to change. --- -Use this quickstart to model a Redis data source as a context surface, generate the retrieval tools that Context Retriever exposes, and call one of those tools as an agent would. You will install the Python client, create an admin key, define entities in a model file, create a surface from that file, create an agent key scoped to it, then list and call the generated tools. +Use this quickstart to model a Redis data source as a context surface, generate the retrieval tools that Context Retriever exposes, and call one of those tools as an agent would. + +This quickstart walks you through: + +1. [Install the Python client](#install-the-python-client) +1. [Sign in and create an admin key](#sign-in-and-create-an-admin-key) +1. [Define your data model](#define-your-data-model) +1. [Load sample data](#load-sample-data) +1. [Create a surface](#create-a-surface) +1. [Create an agent key](#create-an-agent-key) +1. [List the generated tools](#list-the-generated-tools) +1. [Call a tool](#call-a-tool) +1. [Clean up](#clean-up) This quickstart uses Redis Cloud. If you're running Context Retriever self-managed, see [Install Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}) instead; every step after sign-in and admin-key creation is the same either way. @@ -21,8 +33,9 @@ This quickstart uses Redis Cloud. If you're running Context Retriever self-manag To complete this quickstart, you need: * A Redis Cloud account. -* A Redis Cloud database that already contains some data, with a predictable key pattern (for example, `customer:1`, `customer:2`). If you don't have one, see [Create a database]({{< relref "/operate/rc/databases/create-database" >}}). +* A Redis Cloud database. If you don't have one, see [Create a database]({{< relref "/operate/rc/databases/create-database" >}}). * Python 3.11 or later and `pip`. +* `redis-cli`, to load sample data. See [Install redis-cli]({{< relref "/operate/oss_and_stack/install/install-stack/install-redis-cli" >}}). ## Install the Python client @@ -34,23 +47,23 @@ pip install redis-context-retriever ## Sign in and create an admin key -Start a session against your Redis Cloud account: +1. Start a session against your Redis Cloud account: -```bash -ctxctl auth login -u -``` + ```bash + ctxctl auth login -u + ``` -Create an admin key. An admin key authorizes operations such as creating surfaces and agent keys. +1. Create an admin key. An admin key authorizes operations such as creating surfaces and agent keys. -```bash -ctxctl --output json admin create --name "quickstart-admin" -``` + ```bash + ctxctl --output json admin create --name "quickstart-admin" + ``` -Save the returned key. Export it so later commands can use it: +1. Save the returned key. Export it so later commands can use it: -```bash -export CTX_ADMIN_KEY='' -``` + ```bash + export CTX_ADMIN_KEY='' + ``` This quickstart uses a Redis Cloud account for sign-in and admin-key creation. If you're running Context Retriever self-managed instead, see [Install Context Retriever]({{< relref "/operate/iris/context-retriever/self-managed" >}}) to bootstrap your first admin key. Every other step in this quickstart applies to both. @@ -71,48 +84,62 @@ class Customer(ContextModel): email: str = ContextField(description="Customer email address", index="tag") ``` -## Create a surface +## Load sample data -Create a context surface from your model file, pointing it at your Redis Cloud database: +Load a few customer hashes that match the model, so the tool call later in this quickstart returns predictable results: ```bash -ctxctl --output json surface create \ - --name "quickstart-surface" \ - --description "Quickstart context surface" \ - --models ./models.py \ - --redis-addr : \ - --redis-password '' \ - --admin-key "$CTX_ADMIN_KEY" +redis-cli -h -p -a '' HSET customer:1 id 1 name "Jane Doe" email "jane.doe@example.com" +redis-cli -h -p -a '' HSET customer:2 id 2 name "John Smith" email "john.smith@example.com" +redis-cli -h -p -a '' HSET customer:3 id 3 name "Jane Roberts" email "jane.roberts@example.com" ``` -Save the returned surface ID: +If you already have data that matches this shape, you can skip this step and use your own keys instead. -```bash -export CTX_SURFACE_ID='' -``` +## Create a surface -Confirm the surface was created: +1. Create a context surface from your model file, pointing it at your Redis Cloud database: -```bash -ctxctl surface describe "$CTX_SURFACE_ID" --admin-key "$CTX_ADMIN_KEY" -``` + ```bash + ctxctl --output json surface create \ + --name "quickstart-surface" \ + --description "Quickstart context surface" \ + --models ./models.py \ + --redis-addr : \ + --redis-password '' \ + --admin-key "$CTX_ADMIN_KEY" + ``` + +1. Save the returned surface ID: + + ```bash + export CTX_SURFACE_ID='' + ``` + +1. Confirm the surface was created: + + ```bash + ctxctl surface describe "$CTX_SURFACE_ID" --admin-key "$CTX_ADMIN_KEY" + ``` ## Create an agent key -An agent key authorizes an agent to call the tools generated for a surface. Create one scoped to the surface you just created: +An agent key authorizes an agent to call the tools generated for a surface. -```bash -ctxctl --output json agent create \ - --surface-id "$CTX_SURFACE_ID" \ - --name "quickstart-agent" \ - --admin-key "$CTX_ADMIN_KEY" -``` +1. Create one scoped to the surface you just created: -Save the returned key: + ```bash + ctxctl --output json agent create \ + --surface-id "$CTX_SURFACE_ID" \ + --name "quickstart-agent" \ + --admin-key "$CTX_ADMIN_KEY" + ``` -```bash -export CTX_AGENT_KEY='' -``` +1. Save the returned key: + + ```bash + export CTX_AGENT_KEY='' + ``` ## List the generated tools @@ -133,7 +160,7 @@ ctxctl tools call search_customer_by_text --agent-key "$CTX_AGENT_KEY" --args '{ ``` > [!NOTE] -> **What to expect:** A JSON result containing any customers whose indexed text fields match `jane`, up to 5 results. The agent never sends a database query directly. It calls a tool that Context Retriever generated from your model. +> **What to expect:** A JSON result containing `Jane Doe` and `Jane Roberts`, the two sample customers whose `name` field matches `jane`. The agent never sends a database query directly. It calls a tool that Context Retriever generated from your model. ## Clean up diff --git a/content/operate/iris/context-retriever/self-managed/_index.md b/content/operate/iris/context-retriever/self-managed/_index.md index 2609466662..802b1817f1 100644 --- a/content/operate/iris/context-retriever/self-managed/_index.md +++ b/content/operate/iris/context-retriever/self-managed/_index.md @@ -1,12 +1,12 @@ --- -Title: Self-managed Context Retriever +Title: Install Context Retriever (self-managed) alwaysopen: false categories: - docs - operate - iris description: Install and run Redis Context Retriever on a self-managed Kubernetes cluster using Helm. -linkTitle: Self-managed +linkTitle: Install (self-managed) weight: 40 hideListLinks: true bannerText: Redis Context Retriever self-managed is currently in private preview and subject to change. A license key is required to deploy — contact your Redis representative or [contact sales](https://redis.io/contact/).