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
10 changes: 5 additions & 5 deletions content/operate/rc/langcache/create-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ LangCache does not support the following databases during public preview:
- Databases with the [default user]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) turned off
{{< /note >}}

- An [OpenAI API key](https://platform.openai.com/api-keys). LangCache uses OpenAI to generate embeddings for prompts and responses.
- An API key for your embedding provider, if not using the default Redis embedding provider. LangCache supports [OpenAI](https://platform.openai.com/api-keys) and the Redis embedding provider during public preview.

## Create a LangCache service

Expand Down Expand Up @@ -67,10 +67,10 @@ The **Embedding settings** section defines the embedding model used by your serv

| Setting name |Description|
|:----------------------|:----------|
| **Supported Embedding Provider** | The embedding provider to use for your service. LangCache only supports OpenAI during public preview. |
| **Embedding provider API key** | Enter your embedding provider's API key. |
| **Embedding Provider** | The embedding provider to use for your service. Select between `Redis` and `OpenAI`. |
| **Embedding provider API key** | Enter your embedding provider's API key if not using the default Redis embedding provider. |
| **Model** | Select the embedding model to use for your service. |
| **Similarity threshold** | Set the minimum similarity score required to consider a cached response a match. Range: `0.5` to `1.0`. Default: `0.9`<br/><br/>A higher value means more precise matches, but if it's too high, you will compromise on the number of matches and may lose relevant matches. A lower value means more matches, but may include less relevant matches. We recommend starting between `0.8` and `0.9` and then fine-tuning based on your results. |
| **Similarity threshold** | Set the minimum similarity score required to consider a cached response a match. Range: `0.5` to `1.0`. Default: `0.85`<br/><br/>A higher value means more precise matches, but if it's too high, you will compromise on the number of matches and may lose relevant matches. A lower value means more matches, but may include less relevant matches. We recommend starting between `0.8` and `0.9` and then fine-tuning based on your results. |

### Attributes settings

Expand Down Expand Up @@ -111,7 +111,7 @@ A window containing your LangCache service key will appear. Select **Copy** to c
{{<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/>

If you lose the service key value, you will need to [replace the service key]({{< relref "/operate/rc/langcache/view-edit-cache#replace-service-api-key" >}}) to be able to use the LangCache API.
If you lose the service key value, you will need to [generate a new service key]({{< relref "/operate/rc/langcache/view-edit-cache#replace-service-api-key" >}}) to be able to use the LangCache API.
{{</warning>}}

You'll be taken to your LangCache service's **Configuration** page. You'll also be able to see your LangCache service in the LangCache service list.
Expand Down
18 changes: 11 additions & 7 deletions content/operate/rc/langcache/view-edit-cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,17 +39,17 @@ The **Connectivity** section provides the connection details for your LangCache
| **Cache ID** | The unique ID of your LangCache service. |
| **API Base URL** | The base URL for LangCache API requests. |

Select the **Copy** button next to the Cache ID and API Base URL to copy them to the clipboard. If you lost the API key value or need to rotate the key, you can [replace the service API key](#replace-service-api-key) at any time.
Select the **Copy** button next to the Cache ID and API Base URL to copy them to the clipboard. If you lost the API key value or need to rotate the key, you can [generate a new service API key](#replace-service-api-key) at any time.

See [use the LangCache API]({{< relref "/operate/rc/langcache/use-langcache" >}}) for more information on how to use these values.

#### Replace service API key
#### Generate a new service API key {#replace-service-api-key}

The API key is only available immediately after you create the LangCache service. If you lost this value, or need to rotate the key, you can replace the service key at any time.
The API key is only available immediately after you create the LangCache service. If you lost this value, or need to rotate the key, you can generate a new service key at any time.

To replace the service key:
To generate a new service key:

1. Select **Replace key**.
1. Select **Generate key**.

{{<image filename="images/rc/langcache-replace-key.png" alt="The Replace Key button." >}}

Expand All @@ -60,9 +60,11 @@ To replace the service key:
{{<image filename="images/rc/langcache-service-key.png" alt="The LangCache service key window. Use the Copy button to save the service key to the clipboard." >}}

{{<warning>}}
After you generate a new service key, calls to the LangCache API with the old key will fail. <br/><br/>

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

If you lose the service key value, you will need to replace the key again.
If you lose the service key value, you will need to generate a new key again.
{{</warning>}}

### General
Expand All @@ -77,7 +79,9 @@ The **General** section provides configuration details for your LangCache servic
| **Database** | The database that stores your cache data. |
| **Similarity threshold** | The minimum similarity score required to consider a cached response a match. _(Editable)_ |
| **TTL** | The number of seconds to cache entries before they expire. _(Editable)_ |
| **Embedding Provider** | The embedding provider to use for your service. |
| **Embedding Provider** | The embedding provider used for your service. |
| **Embedding Model** | The embedding model used for your service. |
| **Embedding Model API key** | The obfuscated API key for the embedding provider. |

Some of these settings can be changed after cache creation. To do so, select the **Edit** button.

Expand Down
Binary file modified static/images/rc/langcache-embedding-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/langcache-replace-key.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/langcache-view-connectivity.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/images/rc/langcache-view-general.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.