Skip to content

Commit e5a1827

Browse files
committed
DOC-5495: modify vector set docs for 8.2 (initial commit)
1 parent bbd5fca commit e5a1827

File tree

4 files changed

+73
-2
lines changed

4 files changed

+73
-2
lines changed

content/commands/vismember.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
arguments:
3+
- name: key
4+
type: key
5+
- name: element
6+
type: string
7+
arity: 3
8+
categories:
9+
- docs
10+
- develop
11+
- stack
12+
- oss
13+
- rs
14+
- rc
15+
- oss
16+
- kubernetes
17+
- clients
18+
command_flags:
19+
- READONLY
20+
complexity: O(1)
21+
description: Check if an element exists in a vector set.
22+
function: vismemberCommand
23+
group: vector_set
24+
hidden: false
25+
linkTitle: VISMEMBER
26+
since: 8.0.0
27+
summary: Check if an element exists in a vector set.
28+
syntax_fmt: VISMEMBER key element
29+
syntax_str: element
30+
title: VISMEMBER
31+
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
32+
---
33+
34+
Check if an element exists in a vector set.
35+
36+
## Required arguments
37+
38+
<details open>
39+
<summary><code>key</code></summary>
40+
41+
is the name of the key that holds the vector set.
42+
</details>
43+
44+
<details open>
45+
<summary><code>element</code></summary>
46+
47+
is the name of the element you want to check for membership.
48+
</details>
49+
50+
## Return information
51+
52+
{{< multitabs id="vismember-return-info"
53+
tab1="RESP2"
54+
tab2="RESP3" >}}
55+
56+
[Integer reply](../../develop/reference/protocol-spec#integers): `0` if the element does not exist in the vector set, or the key does not exist. `1` if the element exists in the vector set.
57+
58+
-tab-sep-
59+
60+
[Boolean reply](../../develop/reference/protocol-spec#booleans): `false` if the element does not exist in the vector set, or the key does not exist. `true` if the element exists in the vector set.
61+
62+
{{< /multitabs >}}
63+
64+
## Related topics
65+
66+
- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})

content/commands/vrem.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ categories:
1010
- kubernetes
1111
- clients
1212
complexity: O(log(N)) for each element removed, where N is the number of elements in the vector set.
13-
description: Remove one or more elements from a vector set.
13+
description: Remove an element from a vector set.
1414
group: vector_set
1515
hidden: false
1616
linkTitle: VREM
1717
since: 8.0.0
18-
summary: Remove one or more elements from a vector set.
18+
summary: Remove an element from a vector set.
1919
syntax_fmt: "VREM key element"
2020
title: VREM
2121
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.

content/commands/vsim.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,11 @@ history:
1919
linkTitle: VSIM
2020
since: 8.0.0
2121
summary: Return elements by vector similarity.
22+
<<<<<<< Updated upstream
2223
syntax_fmt: "VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [WITHATTRIBS] [COUNT num]\n [EF search-exploration-factor] [FILTER expression] [FILTER-EF max-filtering-effort] [TRUTH] [NOTHREAD]"
24+
=======
25+
syntax_fmt: "VSIM key (ELE | FP32 | VALUES num) (vector | element) [WITHSCORES] [COUNT num] [EF search-exploration-factor]\n [FILTER expression] [FILTER-EF max-filtering-effort] [TRUTH] [NOTHREAD] [EPSILON]"
26+
>>>>>>> Stashed changes
2327
title: VSIM
2428
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
2529
---

content/develop/data-types/vector-sets/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ The following commands are available for vector sets:
3333
- [VEMB]({{< relref "/commands/vemb" >}}) - retrieve the approximate vector associated with a vector set element.
3434
- [VGETATTR]({{< relref "/commands/vgetattr" >}}) - retrieve the attributes of a vector set element.
3535
- [VINFO]({{< relref "/commands/vinfo" >}}) - retrieve metadata and internal details about a vector set, including size, dimensions, quantization type, and graph structure.
36+
- [VISMEMBER]({{< relref "/commands/vismember" >}}) - check if an element exists in a vector set.
3637
- [VLINKS]({{< relref "/commands/vlinks" >}}) - retrieve the neighbors of a specified element in a vector set; the connections for each layer of the HNSW graph.
3738
- [VRANDMEMBER]({{< relref "/commands/vrandmember" >}}) - retrieve random elements of a vector set.
3839
- [VREM]({{< relref "/commands/vrem" >}}) - remove an element from a vector set.

0 commit comments

Comments
 (0)