Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions content/operate/iris/agent-memory/create-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,20 @@ From the [Redis Cloud console](https://cloud.redis.io/), select **Agent Memory**

If you have not already created an Agent Memory service, you'll see a page with an introduction to Agent Memory. Otherwise, select **New service** to go to the Agent Memory introduction page.

{{<image filename="images/rc/langcache-new-service.png" alt="The New service button." width="150px" >}}
![The New service button.](/images/rc/langcache-new-service.png)
{width="150px"}

From here:

- Select **Quick create** to create a Redis Agent Memory service with default settings using your Free 30MB database. If you haven't created a Free database yet, Redis Cloud will create one and set up the Redis Agent Memory service for you.

{{<image filename="images/rc/langcache-quick-create.png" alt="The Quick create button." width="150px" >}}
![The Quick create button.](/images/rc/langcache-quick-create.png)
{width="150px"}

After Redis Cloud creates your Agent Memory service, a window containing your Agent Memory service key will appear. Select **Copy** to copy the key to your clipboard.

{{<image filename="images/rc/agent-memory-service-key.png" alt="The Agent Memory service key window. Use the Copy button to save the service key to the clipboard." width=40% >}}
![The Agent Memory service key window. Use the Copy button to save the service key to the clipboard.](/images/rc/agent-memory-service-key.png)
{width="40%"}

{{<warning>}}
This is the only time the value of the user key is available. Save it to a secure location before closing the dialog box.<br/><br/>
Expand All @@ -57,7 +60,8 @@ If you lose the service key value, you will need to [generate a new service key]

- If you want to customize your Redis Agent Memory service, select **Create custom**.

{{<image filename="images/rc/agent-memory-custom-service.png" alt="The Create custom button to create an Agent Memory service." width="150px" >}}
![The Create custom button to create an Agent Memory service.](/images/rc/agent-memory-custom-service.png)
{width="150px"}

This takes you to the **Create Agent Memory Service** page. This page is divided into the following sections:

Expand All @@ -71,7 +75,7 @@ If you lose the service key value, you will need to [generate a new service key]

The **General settings** section defines basic properties of your service.

{{<image filename="images/rc/agent-memory-general-settings.png" alt="The General settings section." >}}
![The General settings section.](/images/rc/agent-memory-general-settings.png)

| Setting name |Description|
|:----------------------|:----------|
Expand All @@ -83,7 +87,7 @@ The **General settings** section defines basic properties of your service.

The **Memory configuration** section allows you to define the time-to-live (TTL) of your agent's memories, set how often memories are extracted, and control automatic summarization of session memory.

{{<image filename="images/rc/agent-memory-memory-configuration.png" alt="The Memory configuration section." >}}
![The Memory configuration section.](/images/rc/agent-memory-memory-configuration.png)

| Setting name |Description|
|:----------------------|:----------|
Expand Down Expand Up @@ -112,15 +116,15 @@ Select **Use Redis in-built keys** to use Redis-managed model credentials. This

LLM model options can change. Use the console to see the current choices; values shown in the screenshot are examples.

{{<image filename="images/rc/agent-memory-ai-model-create.png" alt="The AI model and credentials section with Bring my own key selected. The section contains the provider, API key, LLM model, and embedding model settings." >}}
![The AI model and credentials section with Bring my own key selected. The section contains the provider, API key, LLM model, and embedding model settings.](/images/rc/agent-memory-ai-model-create.png)

The same provider key is used for both model types. The credential source, provider, and embedding model are fixed after you create the service. For configuration, key rotation, security, and troubleshooting guidance, see [Configure AI models for Agent Memory]({{< relref "/operate/iris/agent-memory/model-configuration" >}}).

### Memory types & extraction {#memory-types-and-extraction}

The **Memory types & extraction** section allows you to define custom long-term memory types with structured fields and an optional extraction strategy. Each enabled type runs independently.

{{<image filename="images/rc/agent-memory-memory-types.png" alt="The Memory types & extraction section." >}}
![The Memory types & extraction section.](/images/rc/agent-memory-memory-types.png)

#### Custom memory types

Expand Down Expand Up @@ -169,7 +173,7 @@ Detector matches are applied deterministically. Semantic exclusions only steer t
Sensitive-data exclusions are an early-stage feature, enabled for selected accounts. If you want to try them, contact your Redis representative or [contact sales](https://redis.io/contact/).
{{< /note >}}

{{<image filename="images/rc/agent-memory-sensitive-data-exclusions.png" alt="The Sensitive-data exclusions section." >}}
![The Sensitive-data exclusions section.](/images/rc/agent-memory-sensitive-data-exclusions.png)

Exclusions are applied when long-term memories are created from a session. Session memory is unaffected: events and their summaries are kept as sent. Exclusions are also not applied to long-term memories your application creates directly through the API or an SDK.

Expand Down Expand Up @@ -232,11 +236,12 @@ Semantic exclusions are **advisory**. They steer the extraction model, but they

When you are done setting the details of your Agent Memory service, select **Create** to create it.

{{<image filename="images/rc/button-access-management-user-key-create.png" alt="Use the Create button to create an Agent Memory service." >}}
![Use the Create button to create an Agent Memory service.](/images/rc/button-access-management-user-key-create.png)

A window containing your Agent Memory service key will appear. Select **Copy** to copy the key to your clipboard.

{{<image filename="images/rc/agent-memory-service-key.png" alt="The Agent Memory service key window. Use the Copy button to save the service key to the clipboard." width=40% >}}
![The Agent Memory service key window. Use the Copy button to save the service key to the clipboard.](/images/rc/agent-memory-service-key.png)
{width="40%"}

{{<warning>}}
This is the only time the value of the user key is available. Save it to a secure location before closing the dialog box.<br/><br/>
Expand Down
6 changes: 3 additions & 3 deletions content/operate/iris/agent-memory/model-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ To configure your own model provider key:

1. Complete the other service settings, then select **Create**.

{{<image filename="images/rc/agent-memory-ai-model-create.png" alt="The AI model and credentials section with Bring my own key selected. The section contains the provider, API key, LLM model, and embedding model settings." >}}
![The AI model and credentials section with Bring my own key selected. The section contains the provider, API key, LLM model, and embedding model settings.](/images/rc/agent-memory-ai-model-create.png)

The key is used for both the LLM and embedding calls. Redis stores the key securely and does not show it again after you create the service.

Expand All @@ -81,7 +81,7 @@ To view the configuration:

1. On the **Configuration** tab, find **AI model and credentials**.

{{<image filename="images/rc/agent-memory-ai-model-details.png" alt="The AI model and credentials section for an existing service. It shows the provider, embedding model, LLM model, and a User-managed API key status." >}}
![The AI model and credentials section for an existing service. It shows the provider, embedding model, LLM model, and a User-managed API key status.](/images/rc/agent-memory-ai-model-details.png)

The **User-managed** status confirms that the service uses your provider key. Redis does not display or return the saved value.

Expand All @@ -99,7 +99,7 @@ To update the service:

1. Select **Save**.

{{<image filename="images/rc/agent-memory-ai-model-edit.png" alt="The AI model and credentials section in edit mode. The provider and embedding model are read-only. The LLM model and Replace API key settings are editable." >}}
![The AI model and credentials section in edit mode. The provider and embedding model are read-only. The LLM model and Replace API key settings are editable.](/images/rc/agent-memory-ai-model-edit.png)

After the update completes, new operations use the replacement key. Operations that were already in progress can continue to use the previous key. The replacement applies to both LLM and embedding calls.

Expand Down
28 changes: 16 additions & 12 deletions content/operate/iris/agent-memory/view-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ After you have [created your first Agent Memory service]({{< relref "/operate/ir

This page displays a list of all Agent Memory services associated with your account.

{{<image filename="images/rc/agent-memory-service-list.png" alt="The Agent Memory service in the Agent Memory service list." >}}
![The Agent Memory service in the Agent Memory service list.](/images/rc/agent-memory-service-list.png)

Select your Agent Memory service from the list to view the service's details.

Expand All @@ -40,7 +40,7 @@ Some of these settings can be changed after service creation. To do so, select t

The **General settings** section provides the connection details and general settings for your Agent Memory service.

{{<image filename="images/rc/agent-memory-view-general.png" alt="The General settings for the Agent Memory service." >}}
![The General settings for the Agent Memory service.](/images/rc/agent-memory-view-general.png)

| Setting name |Description|
|:----------------------|:----------|
Expand All @@ -57,7 +57,7 @@ Follow the [Redis Agent Memory REST API quickstart]({{< relref "/develop/ai/cont

The **Memory configuration** section shows the time-to-live (TTL) for memory storage, the extraction cadence, and the automatic summarization settings for session memory.

{{<image filename="images/rc/agent-memory-view-memory-configuration.png" alt="The Memory configuration section for the Agent Memory service." >}}
![The Memory configuration section for the Agent Memory service.](/images/rc/agent-memory-view-memory-configuration.png)

| Setting name |Description|
|:----------------------|:----------|
Expand All @@ -74,15 +74,15 @@ The **AI model and credentials** section appears when the service uses your mode

Provider and model values shown in the screenshot are examples.

{{<image filename="images/rc/agent-memory-ai-model-details.png" alt="The AI model and credentials section for an existing service. It shows the provider, embedding model, LLM model, and a User-managed API key status." >}}
![The AI model and credentials section for an existing service. It shows the provider, embedding model, LLM model, and a User-managed API key status.](/images/rc/agent-memory-ai-model-details.png)

The provider and embedding model are read-only. You can change the LLM model or replace the provider key. For update steps, key rotation behavior, security, and troubleshooting guidance, see [Configure AI models for Agent Memory]({{< relref "/operate/iris/agent-memory/model-configuration" >}}).

### Memory types & extraction {#memory-types-and-extraction}

The **Memory types & extraction** section shows any [custom memory types]({{< relref "/operate/iris/agent-memory/create-service#custom-memory-types" >}}) defined for the service, each listed with its name, fields, and extraction strategy.

{{<image filename="images/rc/agent-memory-view-memory-types.png" alt="The Memory types & extraction section for the Agent Memory service." >}}
![The Memory types & extraction section for the Agent Memory service.](/images/rc/agent-memory-view-memory-types.png)

#### Custom memory types

Expand All @@ -105,7 +105,7 @@ The **Sensitive-data exclusions** section shows the [sensitive-data exclusions](
Sensitive-data exclusions are an early-stage feature, enabled for selected accounts. If you want to try them, contact your Redis representative or [contact sales](https://redis.io/contact/).
{{< /note >}}

{{<image filename="images/rc/agent-memory-view-sensitive-data-exclusions.png" alt="The Sensitive-data exclusions section for the Agent Memory service." >}}
![The Sensitive-data exclusions section for the Agent Memory service.](/images/rc/agent-memory-view-sensitive-data-exclusions.png)

| Setting name |Description|
|:----------------------|:----------|
Expand All @@ -126,7 +126,7 @@ Semantic exclusions are **advisory**. They steer the extraction model, but they

The **Actions** section lets you flush or delete your Agent Memory service.

{{<image filename="images/rc/agent-memory-view-actions.png" alt="The actions for the Agent Memory service." >}}
![The actions for the Agent Memory service.](/images/rc/agent-memory-view-actions.png)

#### Flush memory entries

Expand Down Expand Up @@ -167,7 +167,7 @@ The **Metrics** tab provides a series of graphs showing performance data for you

The **API keys** tab shows a list of all API keys for your service.

{{<image filename="images/rc/agent-memory-view-api-keys.png" alt="The actions for the Agent Memory service." >}}
![The actions for the Agent Memory service.](/images/rc/agent-memory-view-api-keys.png)

Here, you can generate a new API key or remove any keys that are no longer in use. You can generate or remove service API keys at any time.

Expand All @@ -177,17 +177,20 @@ To generate a new service key:

1. Select **New API key**.

{{<image filename="images/rc/agent-memory-new-api-key.png" alt="The New API key button." width=150px >}}
![The New API key button.](/images/rc/agent-memory-new-api-key.png)
{width="150px"}

1. Enter a new name for your API key.

{{<image filename="images/rc/agent-memory-add-api-key.png" alt="The Add API key window." width="37.5%" >}}
![The Add API key window.](/images/rc/agent-memory-add-api-key.png)
{width="37.5%"}

1. Select **Generate key** to generate your new API key.

1. The new key will appear in a dialog box. Select **Copy** to copy the key to the clipboard.

{{<image filename="images/rc/agent-memory-service-key.png" alt="The Agent Memory service key window. Use the Copy button to save the service key to the clipboard." width=40% >}}
![The Agent Memory service key window. Use the Copy button to save the service key to the clipboard.](/images/rc/agent-memory-service-key.png)
{width="40%"}

{{<warning>}}
This is the only time the value of the user key is available. Save it to a secure location before closing the dialog box. <br/><br/>
Expand All @@ -199,4 +202,5 @@ If you lose the service key value, you will need to generate a new key again.

To delete an API key, select the **Delete API key** button next to the old key.

{{<image filename="images/rc/icon-delete-lb.png" width="36px" alt="Delete button." >}}
![Delete button.](/images/rc/icon-delete-lb.png)
{width="36px"}
13 changes: 7 additions & 6 deletions content/operate/iris/context-retriever/create-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ From the [Redis Cloud console](https://cloud.redis.io/), select **Context Retrie

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" >}}
![The New service button.](/images/rc/langcache-new-service.png)
{width="150px"}

From here, you can either:

Expand All @@ -44,7 +45,7 @@ For this guide, select **Create custom service**.

The **General settings** section defines basic properties of your service.

{{<image filename="images/rc/context-retriever-general-settings.png" alt="The General settings section." >}}
![The General settings section.](/images/rc/context-retriever-general-settings.png)

| Setting name | Description |
|:-------------|:------------|
Expand All @@ -58,11 +59,11 @@ Select **Entities** to continue.

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." >}}
![The Entities section.](/images/rc/context-retriever-define-entities.png)

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." >}}
![The Entity table with the Entity Name, Key template, and description.](/images/rc/context-retriever-define-entities-table.png)

- In the **Entity name** field, enter the name of one of the business objects that is in your database.

Expand Down Expand Up @@ -94,11 +95,11 @@ If you use Auto-detect fields, make sure that the fields and relationships that

- Select **Manually enter fields** to manually enter the fields yourself.

{{<image filename="images/rc/context-retriever-fields.png" alt="The Configure fields step." >}}
![The Configure fields step.](/images/rc/context-retriever-fields.png)

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." >}}
![The Add field table.](/images/rc/context-retriever-add-field.png)

- 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.
Expand Down
14 changes: 9 additions & 5 deletions content/operate/iris/context-retriever/view-admin-keys.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ A Context Retriever **admin key** authorizes administrative operations against C

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." >}}
![The Admin keys tab showing the list of admin keys.](/images/rc/context-retriever-admin-keys-list.png)

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.

Expand All @@ -37,17 +37,20 @@ 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 >}}
![The New admin key button.](/images/rc/context-retriever-new-admin-key.png)
{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." width="37.5%" >}}
![The Add admin key window.](/images/rc/context-retriever-add-admin-key.png)
{width="37.5%"}

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=40% >}}
![The Context Retriever admin key window. Use the Copy button to save the admin key to the clipboard.](/images/rc/context-retriever-admin-key.png)
{width="40%"}

{{<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/>
Expand All @@ -59,6 +62,7 @@ If you lose the admin key value, you will need to generate a new 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." >}}
![Delete button.](/images/rc/icon-delete-lb.png)
{width="36px"}

Deleting an admin key immediately revokes any administrative operations that rely on it. This action cannot be undone.
Loading
Loading