Skip to content

Commit 0000190

Browse files
committed
Get up-to-date
1 parent dd5295a commit 0000190

File tree

7 files changed

+58
-13
lines changed

7 files changed

+58
-13
lines changed

content/operate/rc/langcache/create-service.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,27 @@ Redis LangCache provides vector search capabilities and efficient caching for AI
1818
To create a LangCache service, you will need:
1919

2020
- A Redis Cloud database. If you don't have one, see [Create a database]({{< relref "/operate/rc/databases/create-database" >}}).
21+
2122
{{< note >}}
2223
LangCache does not support the following databases during public preview:
2324
- Databases with a [CIDR allow list]({{< relref "/operate/rc/security/cidr-whitelist" >}})
2425
- [Active-Active]({{< relref "/operate/rc/databases/configuration/active-active-redis" >}}) databases
2526
- Databases with the [default user]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) turned off
2627
{{< /note >}}
28+
2729
- An [OpenAI API key](https://platform.openai.com/api-keys). LangCache uses OpenAI to generate embeddings for prompts and responses.
2830

2931
## Create a LangCache service
3032

31-
1. From the [Redis Cloud console](https://cloud.redis.io/), select **LangCache** from the left-hand menu.
33+
From the [Redis Cloud console](https://cloud.redis.io/), select **LangCache** from the left-hand menu.
3234

33-
1. When you access the LangCache page for the first time, you will see a page with an introduction to LangCache. Select **Let's create a service** to create your first service.
35+
When you access the LangCache page for the first time, you will see a page with an introduction to LangCache. Select **Let's create a service** to create your first service.
3436

35-
{{<image filename="images/rc/langcache-create-first-service.png" alt="The Let's create a service button." width="200px" >}}
37+
{{<image filename="images/rc/langcache-create-first-service.png" alt="The Let's create a service button." width="200px" >}}
3638

37-
If you have already created a LangCache service, select **New service** to create another one.
39+
If you have already created a LangCache service, select **New service** to create another one.
3840

39-
{{<image filename="images/rc/langcache-new-service.png" alt="The New service button." width="150px" >}}
41+
{{<image filename="images/rc/langcache-new-service.png" alt="The New service button." width="150px" >}}
4042

4143
This takes you to the **Create LangCache service** page. The page is divided into the following sections:
4244

@@ -68,7 +70,7 @@ The **Embedding settings** section defines the embedding model used by your serv
6870
| **Supported Embedding Provider** | The embedding provider to use for your service. LangCache only supports OpenAI during public preview. |
6971
| **Embedding provider API key** | Enter your embedding provider's API key. |
7072
| **Model** | Select the embedding model to use for your service. |
71-
| **Similarity threshold** | Set the minimum similarity score required to consider a cached response a match. Range: `0.0` to `1.0`. Default: `0.9`<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. |
73+
| **Similarity threshold** | Set the minimum similarity score required to consider a cached response a match. Range: `0.0` 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. |
7274

7375
### Attributes settings
7476

@@ -102,6 +104,16 @@ When you are done setting the details of your LangCache service, select **Create
102104

103105
{{<image filename="images/rc/button-access-management-user-key-create.png" alt="Use the Create button to create a LangCache service." >}}
104106

107+
A window containing your LangCache service key will appear. Select **Copy** to copy the key to your clipboard.
108+
109+
{{<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." >}}
110+
111+
{{<warning>}}
112+
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/>
113+
114+
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.
115+
{{</warning>}}
116+
105117
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.
106118

107119
{{<image filename="images/rc/langcache-service-list.png" alt="The LangCache service in the LangCache service list." >}}

content/operate/rc/langcache/use-langcache.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@ You can use the LangCache API from your client app to store and retrieve LLM, RA
1616
To access the LangCache API, you need:
1717

1818
- LangCache API base URL
19-
- LangCache API token
19+
- LangCache service API key
2020
- Cache ID
2121

22-
All of these values are available in the LangCache service's **Configuration** page.
22+
The base URL and cache ID are available in the LangCache service's **Configuration** page in the [**Connectivity** section]({{< relref "/operate/rc/langcache/view-edit-cache#connectivity" >}}).
2323

24-
When you call the API, you need to pass the LangCache API token in the `Authorization` header as a Bearer token and the Cache ID as the `cacheId` path parameter.
24+
The LangCache API key is only available immediately after you create the LangCache service. If you lost this value, you will need to [replace the service API key]({{< relref "/operate/rc/langcache/view-edit-cache#replace-service-api-key" >}}) to be able to use the LangCache API.
25+
26+
When you call the API, you need to pass the LangCache API key in the `Authorization` header as a Bearer token and the Cache ID as the `cacheId` path parameter.
2527

2628
For example, to check the health of the cache using `cURL`:
2729

content/operate/rc/langcache/view-edit-cache.md

Lines changed: 35 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,20 +39,47 @@ The **Connectivity** section provides the connection details for your LangCache
3939
| **Cache ID** | The unique ID of your LangCache service. |
4040
| **API Base URL** | The base URL for LangCache API requests. |
4141

42-
Select the **Copy** button next to each value to copy them to the clipboard. See [use the LangCache API]({{< relref "/operate/rc/langcache/use-langcache" >}}) for more information on how to use these values.
42+
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.
43+
44+
See [use the LangCache API]({{< relref "/operate/rc/langcache/use-langcache" >}}) for more information on how to use these values.
45+
46+
#### Replace service API key
47+
48+
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.
49+
50+
To replace the service key:
51+
52+
1. Select **Replace key**.
53+
54+
{{<image filename="images/rc/langcache-replace-key.png" alt="The Replace Key button." >}}
55+
56+
1. A confirmation dialog will appear. Select **Confirm** to confirm.
57+
58+
1. The new key will appear in a dialog box. Select **Copy** to copy the key to the clipboard.
59+
60+
{{<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." >}}
61+
62+
{{<warning>}}
63+
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/>
64+
65+
If you lose the service key value, you will need to replace the key again.
66+
{{</warning>}}
4367

4468
### General
4569

4670
The **General** section provides configuration details for your LangCache service.
4771

72+
{{<image filename="images/rc/langcache-view-general.png" alt="The general settings for the LangCache service." >}}
73+
4874
| Setting name |Description|
4975
|:----------------------|:----------|
50-
| **Service name** | The name of the LangCache service. _(Editable)_ |
76+
| **Service name** | The name of the LangCache service. |
5177
| **Database** | The database that stores your cache data. |
52-
| **Distance threshold** | The minimum similarity score required to consider a cached response a match. _(Editable)_ |
78+
| **Similarity threshold** | The minimum similarity score required to consider a cached response a match. _(Editable)_ |
79+
| **TTL** | The number of seconds to cache entries before they expire. _(Editable)_ |
5380
| **Embedding Provider** | The embedding provider to use for your service. |
5481

55-
Some of the configuration settings can be changed after cache creation. To do so, select the **Edit** button.
82+
Some of these settings can be changed after cache creation. To do so, select the **Edit** button.
5683

5784
### Attributes
5885

@@ -93,3 +120,7 @@ To delete your LangCache service:
93120
1. Select **Delete** again to confirm.
94121

95122
Deleting the LangCache service is permanent and cannot be undone.
123+
124+
## Metrics tab
125+
126+
The **Metrics** tab provides a series of graphs showing performance data for your LangCache service. See [Monitor a LangCache service]({{< relref "/operate/rc/langcache/monitor-cache" >}}) for more information.
4.4 KB
Loading
23 KB
Loading
1.18 KB
Loading
17.3 KB
Loading

0 commit comments

Comments
 (0)