Skip to content

DOC-5495: modify vector set docs for 8.2 (initial commit) #1875

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: feat-ros-8.2
Choose a base branch
from
Draft
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
66 changes: 66 additions & 0 deletions content/commands/vismember.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
arguments:
- name: key
type: key
- name: element
type: string
arity: 3
categories:
- docs
- develop
- stack
- oss
- rs
- rc
- oss
- kubernetes
- clients
command_flags:
- READONLY
complexity: O(1)
description: Check if an element exists in a vector set.
function: vismemberCommand
group: vector_set
hidden: false
linkTitle: VISMEMBER
since: 8.0.0
summary: Check if an element exists in a vector set.
syntax_fmt: VISMEMBER key element
syntax_str: element
title: VISMEMBER
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
---

Check if an element exists in a vector set.

## Required arguments

<details open>
<summary><code>key</code></summary>

is the name of the key that holds the vector set.
</details>

<details open>
<summary><code>element</code></summary>

is the name of the element you want to check for membership.
</details>

## Return information

{{< multitabs id="vismember-return-info"
tab1="RESP2"
tab2="RESP3" >}}

[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.

-tab-sep-

[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.

{{< /multitabs >}}

## Related topics

- [Vector sets]({{< relref "/develop/data-types/vector-sets" >}})
4 changes: 2 additions & 2 deletions content/commands/vrem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ categories:
- kubernetes
- clients
complexity: O(log(N)) for each element removed, where N is the number of elements in the vector set.
description: Remove one or more elements from a vector set.
description: Remove an element from a vector set.
group: vector_set
hidden: false
linkTitle: VREM
since: 8.0.0
summary: Remove one or more elements from a vector set.
summary: Remove an element from a vector set.
syntax_fmt: "VREM key element"
title: VREM
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
Expand Down
2 changes: 1 addition & 1 deletion content/commands/vsim.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ history:
linkTitle: VSIM
since: 8.0.0
summary: Return elements by vector similarity.
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]"
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] [EPSILON]"
title: VSIM
bannerText: Vector set is a new data type that is currently in preview and may be subject to change.
---
Expand Down
1 change: 1 addition & 0 deletions content/develop/data-types/vector-sets/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ The following commands are available for vector sets:
- [VEMB]({{< relref "/commands/vemb" >}}) - retrieve the approximate vector associated with a vector set element.
- [VGETATTR]({{< relref "/commands/vgetattr" >}}) - retrieve the attributes of a vector set element.
- [VINFO]({{< relref "/commands/vinfo" >}}) - retrieve metadata and internal details about a vector set, including size, dimensions, quantization type, and graph structure.
- [VISMEMBER]({{< relref "/commands/vismember" >}}) - check if an element exists in a vector set.
- [VLINKS]({{< relref "/commands/vlinks" >}}) - retrieve the neighbors of a specified element in a vector set; the connections for each layer of the HNSW graph.
- [VRANDMEMBER]({{< relref "/commands/vrandmember" >}}) - retrieve random elements of a vector set.
- [VREM]({{< relref "/commands/vrem" >}}) - remove an element from a vector set.
Expand Down