Skip to content

Commit 90203fd

Browse files
committed
Merge branch 'main' into DOC-4948
2 parents 3c22f1e + d07e999 commit 90203fd

File tree

240 files changed

+2744
-968
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

240 files changed

+2744
-968
lines changed

README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Redis Docs
22

3-
OPEN SOURCE LICENSE VS. TRADEMARKS. The three-clause BSD license gives you the right to redistribute and use the software in source and binary forms, with or without modification, under certain conditions. However, open source licenses like the three-clause BSD license do not address trademarks. For further details please read the [Redis Trademark Policy](https://redis.io/legal/trademark-policy/)."
4-
5-
## A note for Issue and PR submitters
6-
73
PRs are merged first to the `main` branch of this repo.
84
Periodically, the docs team will merge `main` into `latest`, which will make the changes visible on the docs site.
95
Please be patient, as there may be a lag of several days before `main` is merged into `latest`. If you want to see your changes before they're merged to `latest`, you can see them on https://redis.io/docs/staging/dev/.

config.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ rdi_redis_gears_version = "1.2.6"
5555
rdi_debezium_server_version = "2.3.0.Final"
5656
rdi_db_types = "cassandra|mysql|oracle|postgresql|sqlserver"
5757
rdi_cli_latest = "latest"
58-
rdi_current_version = "v1.6.5"
58+
rdi_current_version = "v1.6.6"
5959

6060
[params.clientsConfig]
6161
"Python"={quickstartSlug="redis-py"}

content/commands/info/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -602,7 +602,7 @@ It won't be included when `INFO` or `INFO ALL` are called, and it is returned on
602602

603603
| Redis<br />Enterprise | Redis<br />Cloud | <span style="min-width: 9em; display: table-cell">Notes</span> |
604604
|:----------------------|:-----------------|:------|
605-
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | In Redis Enterprise, `INFO` returns a different set of fields than Redis Community Edition.<br />Not supported for [scripts]({{<relref "/develop/interact/programmability">}}). |
605+
| <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | <span title="Supported">&#x2705; Standard</span><br /><span title="Supported"><nobr>&#x2705; Active-Active</nobr></span> | In Redis Enterprise, `INFO` returns a different set of fields than Redis Open Source.<br />Not supported for [scripts]({{<relref "/develop/interact/programmability">}}). |
606606

607607
Note: key memory usage is different on Redis Software or Redis Cloud active-active databases than on non-active-active databases. This is because memory usage includes some amount of CRDB overhead.
608608

content/commands/module-load/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,5 +49,5 @@ unmodified to the module.
4949
configuration directive in `redis.conf`.
5050

5151
{{< note >}}
52-
As of Redis CE v8.0.0, loading a module using the Redis CLI with configuration parameters is deprecated.
52+
As of Redis 8 in Redis Open Source, loading a module using the Redis CLI with configuration parameters is deprecated.
5353
{{< /note >}}

content/develop/ai/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,13 @@ This page organized into a few sections depending on what you’re trying to do:
3434
1. [**Search with vectors**]({{< relref "develop/interact/search-and-query/advanced-concepts/vectors#search-with-vectors" >}}): Redis supports several advanced querying strategies with vector fields including k-nearest neighbor ([KNN]({{< relref "develop/interact/search-and-query/advanced-concepts/vectors#knn-vector-search" >}})), [vector range queries]({{< relref "develop/interact/search-and-query/advanced-concepts/vectors#vector-range-queries" >}}), and [metadata filters]({{< relref "develop/interact/search-and-query/advanced-concepts/vectors#filters" >}}).
3535
1. [**Configure vector queries at runtime**]({{< relref "develop/interact/search-and-query/advanced-concepts/vectors#runtime-query-parameters" >}}). Select the best filter mode to optimize query execution.
3636

37+
#### Learn how to index and query vector embeddings
38+
* [redis-py (Python)]({{< relref "/develop/clients/redis-py/vecsearch" >}})
39+
* [NRedisStack (C#/.NET)]({{< relref "/develop/clients/dotnet/vecsearch" >}})
40+
* [node-redis (JavaScript)]({{< relref "/develop/clients/nodejs/vecsearch" >}})
41+
* [Jedis (Java)]({{< relref "/develop/clients/jedis/vecsearch" >}})
42+
* [go-redis (Go)]({{< relref "/develop/clients/go/vecsearch" >}})
43+
3744
## Concepts
3845

3946
Learn to perform vector search and use gateways and semantic caching in your AI/ML projects.
@@ -71,6 +78,7 @@ Retrieval Augmented Generation (aka RAG) is a technique to enhance the ability o
7178

7279
#### Agents
7380
AI agents can act autonomously to plan and execute tasks for the user.
81+
* [Redis Notebooks for LangGraph](https://github.com/redis-developer/langgraph-redis/tree/main/examples)
7482
* [Notebook to get started with LangGraph and agents](https://colab.research.google.com/github/redis-developer/redis-ai-resources/blob/main/python-recipes/agents/00_langgraph_redis_agentic_rag.ipynb)
7583
* [Build a collaborative movie recommendation system using Redis for data storage, CrewAI for agent-based task execution, and LangGraph for workflow management.](https://colab.research.google.com/github/redis-developer/redis-ai-resources/blob/main/python-recipes/agents/01_crewai_langgraph_redis.ipynb)
7684
* [Full-Featured Agent Architecture](https://github.com/redis-developer/redis-ai-resources/blob/main/python-recipes/agents/02_full_featured_agent.ipynb)
@@ -119,6 +127,7 @@ Need a deeper-dive through different use cases and topics?
119127

120128
## Ecosystem integrations
121129

130+
* [LangGraph & Redis: Build smarter AI agents with memory & persistence](https://redis.io/blog/langgraph-redis-build-smarter-ai-agents-with-memory-persistence/)
122131
* [Amazon Bedrock setup guide]({{< relref "/integrate/amazon-bedrock/set-up-redis" >}})
123132
* [LangChain Redis Package: Smarter AI apps with advanced vector storage and faster caching](https://redis.io/blog/langchain-redis-partner-package/)
124133
* [LlamaIndex integration for Redis as a vector store](https://gpt-index.readthedocs.io/en/latest/examples/vector_stores/RedisIndexDemo.html)

content/develop/clients/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,8 +57,8 @@ Redis does not document directly:
5757
## Requirements
5858

5959
You will need access to a Redis server to use these libraries.
60-
You can experiment with a local installation of Redis Community Edition
61-
(see [Install Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}})) or with a free trial of [Redis Cloud]({{< relref "/operate/rc" >}}).
60+
You can experiment with a local installation of Redis Open Source
61+
(see [Install Redis Open Source]({{< relref "/operate/oss_and_stack/install/install-stack/" >}})) or with a free trial of [Redis Cloud]({{< relref "/operate/rc" >}}).
6262
To interact with a Redis server without writing code, use the
6363
[Redis CLI]({{< relref "/develop/tools/cli" >}}) and
6464
[Redis Insight]({{< relref "/develop/tools/insight" >}}) tools.

content/develop/clients/dotnet/_index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ weight: 3
2020
The sections below explain how to install `NRedisStack` and connect your application
2121
to a Redis database.
2222

23-
`NRedisStack` requires a running [Redis Community Edition]({{< relref "/operate/oss_and_stack/install/install-stack/" >}}) server. See [Getting started]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis installation instructions.
23+
`NRedisStack` requires a running Redis server. See [here]({{< relref "/operate/oss_and_stack/install/" >}}) for Redis Open Source installation instructions.
2424

2525
You can also access Redis with an object-mapping client interface. See
2626
[Redis OM for .NET]({{< relref "/integrate/redisom-for-net" >}})
@@ -70,9 +70,9 @@ Console.WriteLine(String.Join("; ", hashFields));
7070
// Prints:
7171
// name: John; surname: Smith; company: Redis; age: 29
7272
```
73-
## Redis Community Edition modules
73+
## Redis Open Source modules
7474

75-
To access Redis Community Edition capabilities, use the appropriate interface like this:
75+
To access Redis Open Source capabilities, use the appropriate interface like this:
7676

7777
```
7878
IBloomCommands bf = db.BF();

content/develop/clients/dotnet/queryjson.md

Lines changed: 63 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,55 @@ categories:
99
- oss
1010
- kubernetes
1111
- clients
12-
description: Learn how to use the Redis query engine with JSON
13-
linkTitle: Index and query JSON
14-
title: Example - Index and query JSON documents
12+
description: Learn how to use the Redis query engine with JSON and hash documents.
13+
linkTitle: Index and query documents
14+
title: Index and query documents
1515
weight: 2
1616
---
1717

1818
This example shows how to create a
1919
[search index]({{< relref "/develop/interact/search-and-query/indexing" >}})
20-
for [JSON]({{< relref "/develop/data-types/json" >}}) data and
21-
run queries against the index.
20+
for [JSON]({{< relref "/develop/data-types/json" >}}) documents and
21+
run queries against the index. It then goes on to show the slight differences
22+
in the equivalent code for [hash]({{< relref "/develop/data-types/hashes" >}})
23+
documents.
2224

23-
Make sure that you have Redis Community Edition and `NRedisStack` installed.
25+
## Initialize
2426

25-
Start by importing dependencies:
27+
Make sure that you have [Redis Open Source]({{< relref "/operate/oss_and_stack" >}})
28+
or another Redis server available. Also install the
29+
[`NRedisStack`]({{< relref "/develop/clients/dotnet" >}}) client library if you
30+
haven't already done so.
31+
32+
Add the following dependencies:
2633

2734
{{< clients-example cs_home_json import >}}
2835
{{< /clients-example >}}
2936

30-
Connect to the database:
31-
32-
{{< clients-example cs_home_json connect >}}
33-
{{< /clients-example >}}
37+
## Create data
3438

3539
Create some test data to add to the database:
3640

3741
{{< clients-example cs_home_json create_data >}}
3842
{{< /clients-example >}}
3943

44+
## Add the index
45+
46+
Connect to your Redis database. The code below shows the most
47+
basic connection but see
48+
[Connect to the server]({{< relref "/develop/clients/dotnet/connect" >}})
49+
to learn more about the available connection options.
50+
51+
{{< clients-example cs_home_json connect >}}
52+
{{< /clients-example >}}
53+
4054
Create an index. In this example, only JSON documents with the key prefix `user:` are indexed. For more information, see [Query syntax]({{< relref "/develop/interact/search-and-query/query/" >}}).
4155

4256
{{< clients-example cs_home_json make_index >}}
4357
{{< /clients-example >}}
4458

59+
## Add the data
60+
4561
Add the three sets of user data to the database as
4662
[JSON]({{< relref "/develop/data-types/json" >}}) objects.
4763
If you use keys with the `user:` prefix then Redis will index the
@@ -50,6 +66,8 @@ objects automatically as you add them:
5066
{{< clients-example cs_home_json add_data >}}
5167
{{< /clients-example >}}
5268

69+
## Query the data
70+
5371
You can now use the index to search the JSON objects. The
5472
[query]({{< relref "/develop/interact/search-and-query/query" >}})
5573
below searches for objects that have the text "Paul" in any field
@@ -70,5 +88,39 @@ to count all users in each city.
7088
{{< clients-example cs_home_json query3 >}}
7189
{{< /clients-example >}}
7290

91+
## Differences with hash documents
92+
93+
Indexing for hash documents is very similar to JSON indexing but you
94+
need to specify some slightly different options.
95+
96+
When you create the schema for a hash index, you don't need to
97+
add aliases for the fields, since you use the basic names to access
98+
the fields anyway. Also, you must set the `On` option to `IndexDataType.HASH`
99+
in the `FTCreateParams` object when you create the index. The code below shows
100+
these changes with a new index called `hash-idx:users`, which is otherwise the
101+
same as the `idx:users` index used for JSON documents in the previous examples.
102+
103+
{{< clients-example cs_home_json make_hash_index >}}
104+
{{< /clients-example >}}
105+
106+
You use [`HashSet()`]({{< relref "/commands/hset" >}}) to add the hash
107+
documents instead of [`JSON.Set()`]({{< relref "/commands/json.set" >}}).
108+
Also, you must add the fields as key-value pairs instead of combining them
109+
into a single object.
110+
111+
{{< clients-example cs_home_json add_hash_data >}}
112+
{{< /clients-example >}}
113+
114+
The query commands work the same here for hash as they do for JSON (but
115+
the name of the hash index is different). The format of the result is
116+
almost the same except that the fields are returned directly in the
117+
`Document` object of the result (for JSON, the fields are all enclosed
118+
in a string under the key `json`):
119+
120+
{{< clients-example cs_home_json query1_hash >}}
121+
{{< /clients-example >}}
122+
123+
## More information
124+
73125
See the [Redis query engine]({{< relref "/develop/interact/search-and-query" >}}) docs
74126
for a full description of all query features with examples.

0 commit comments

Comments
 (0)