You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/operate/rc/langcache/create-service.md
+37-14Lines changed: 37 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,19 +32,39 @@ LangCache does not support the following databases during public preview:
32
32
33
33
From the [Redis Cloud console](https://cloud.redis.io/), select **LangCache** from the left-hand menu.
34
34
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.
35
+
If you have not already created a LangCache service, you'll see a page with an introduction to LangCache. Otherwise, select **New service** to go to the LangCache introduction page.
36
36
37
-
{{<imagefilename="images/rc/langcache-create-first-service.png"alt="The Let's create a service button."width="200px" >}}
37
+
{{<imagefilename="images/rc/langcache-new-service.png"alt="The New service button."width="150px" >}}
38
38
39
-
If you have already created a LangCache service, select **New service** to create another one.
39
+
From here:
40
40
41
-
{{<imagefilename="images/rc/langcache-new-service.png"alt="The New service button."width="150px" >}}
41
+
- Select **Quick create** to create a LangCache 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 LangCache service for you.
After Redis Cloud creates your LangCache service, a window containing your LangCache service key will appear. Select **Copy** to copy the key to your clipboard.
46
+
47
+
{{<imagefilename="images/rc/langcache-service-key.png"alt="The LangCache service key window. Use the Copy button to save the service key to the clipboard." >}}
48
+
49
+
{{<warning>}}
50
+
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/>
42
51
43
-
This takes you to the **Create LangCache service** page. The page is divided into the following sections:
52
+
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.
53
+
{{</warning>}}
54
+
55
+
After your cache is created, you can [use the LangCache API]({{< relref "/operate/rc/langcache/use-langcache" >}}) from your client app.
56
+
57
+
You can also [view and edit the cache]({{< relref "/operate/rc/langcache/view-edit-cache" >}}) and [monitor the cache's performance]({{< relref "/operate/rc/langcache/monitor-cache" >}}).
58
+
59
+
- If you want to customize your LangCache service, select **Create custom service**.
44
60
45
-
1. The [General settings](#general-settings) section defines basic properties of your service.
46
-
1. The [Embedding settings](#embedding-settings) section defines the embedding model used by your service.
47
-
1. The [Attributes settings](#attributes-settings) section allows you to define attributes for your service.
61
+
{{<imagefilename="images/rc/langcache-custom-service.png"alt="The Create custom service button."width="150px" >}}
62
+
63
+
This takes you to the **Create LangCache service** page. The page is divided into the following sections:
64
+
65
+
1. The [General settings](#general-settings) section defines basic properties of your service.
66
+
1. The [Embedding settings](#embedding-settings) section defines the embedding model used by your service.
67
+
1. The [Attributes settings](#attributes-settings) section allows you to define attributes for your service.
48
68
49
69
### General settings
50
70
@@ -57,19 +77,22 @@ The **General settings** section defines basic properties of your service.
57
77
|**Service name**| Enter a name for your LangCache service. We recommend you use a name that describes your service's purpose. |
58
78
|**Select database**| Select the Redis Cloud database to use for this service from the list. |
59
79
|**TTL**| The time to live (TTL) for cache entries, in milliseconds. Default: `No expiration` - items in the cache will remain until manually removed. |
60
-
|**User**| The [database access user]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control" >}}) to use for this service. LangCache only supports the [`default` user]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) during public preview. |
80
+
|**User for this service**| The [database access user]({{< relref "/operate/rc/security/access-control/data-access-control/role-based-access-control" >}}) to use for this service. LangCache only supports the [`default` user]({{< relref "/operate/rc/security/access-control/data-access-control/default-user" >}}) during public preview. |
61
81
62
82
### Embedding settings
63
83
64
84
The **Embedding settings** section defines the embedding model used by your service.
Required settings depend on the embedding provider you select.
89
+
68
90
| Setting name |Description|
69
91
|:----------------------|:----------|
70
-
|**Embedding Provider**| The embedding provider to use for your service. Select between `Redis` and `OpenAI`. |
71
-
|**Embedding provider API key**| Enter your embedding provider's API key if not using the default Redis embedding provider. |
72
-
|**Model**| Select the embedding model to use for your service. |
92
+
|**Embedding Provider**| The embedding provider to use for your service. Select between `Redis`, `OpenAI`, and `Bring your own`. <br/>Any embedding provider you use must support the [OpenAI embeddings API](https://platform.openai.com/docs/api-reference/embeddings). |
93
+
|**Embedding provider API key**| Enter your embedding provider's API key *(`OpenAI` and `Bring your own` embedding providers only)*|
94
+
|**Embedding provider URL**| Enter your embedding provider's API URL *(`Bring your own` embedding provider only)*|
95
+
|**Model**| Select or enter the embedding model to use for your service. |
73
96
|**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. |
74
97
75
98
### Attributes settings
@@ -78,7 +101,7 @@ Attributes provide powerful scoping capabilities for your LangCache operations.
78
101
79
102
The **Attributes settings** section allows you to define attributes for your service. It is collapsed by default.
Copy file name to clipboardExpand all lines: content/operate/rc/langcache/monitor-cache.md
+2-6Lines changed: 2 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ You can monitor a LangCache service's performance from the **Metrics** tab of th
17
17
18
18
The **Metrics** tab provides a series of graphs showing performance data for your LangCache service.
19
19
20
-
You can switch between daily and weekly stats using the **Day** and **Week** buttons at the top of the page. Each graph also includes minimum, average, maximum, and latest values.
20
+
You can switch between hourly, daily, and weekly stats using the **Hour**, **Day**, and **Week** buttons at the top of the page. Each graph also includes minimum, average, maximum, and latest values.
21
21
22
22
## LangCache metrics reference
23
23
@@ -48,8 +48,4 @@ High cache latency may indicate one of the following:
48
48
- Inefficient embedding generation from the embedding provider
49
49
- Large cache requiring longer comparison times
50
50
- Network latency between the cache and embedding provider
51
-
- Resource constraints
52
-
53
-
### Cache items
54
-
55
-
The total number of entries stores in your cache. Each item includes the query string, embedding, response, and other metadata.
Copy file name to clipboardExpand all lines: content/operate/rc/langcache/view-edit-cache.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ The **Connectivity** section provides the connection details for your LangCache
37
37
|:----------------------|:----------|
38
38
|**API Key**| The Bearer token for your LangCache API requests. |
39
39
|**Cache ID**| The unique ID of your LangCache service. |
40
-
|**API Base URL**|The base URL for LangCache API requests. |
40
+
|**URL List**|A list of base URLs for LangCache API requests. Use the closest URL for the best performance. |
41
41
42
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 [generate a new service API key](#replace-service-api-key) at any time.
0 commit comments