Skip to content

Commit 2d58f6a

Browse files
updates sphynx docs to include Vector class
1 parent e23b652 commit 2d58f6a

File tree

3 files changed

+32
-0
lines changed

3 files changed

+32
-0
lines changed

docs/api/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Reference documentation for the RedisVL API.
1515
1616
schema
1717
searchindex
18+
vector
1819
query
1920
filter
2021
vectorizer

docs/api/query.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,17 @@ CountQuery
8888
:inherited-members:
8989
:show-inheritance:
9090
:exclude-members: add_filter,get_args,highlight,return_field,summarize
91+
92+
93+
94+
MultiVectorQuery
95+
==========
96+
97+
.. currentmodule:: redisvl.query
98+
99+
100+
.. autoclass:: MultiVectorQuery
101+
:members:
102+
:inherited-members:
103+
:show-inheritance:
104+
:exclude-members: add_filter,get_args,highlight,return_field,summarize

docs/api/vector.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
2+
*****
3+
Vector
4+
*****
5+
6+
The Vector class in RedisVL is a container that encapsulates a numerical vector, it's datatype, corresponding index field name, and optional importance weight. It is used when constructing multi-vector queries using the MultiVectorQuery class.
7+
8+
9+
Vector
10+
===========
11+
12+
.. currentmodule:: redisvl.query
13+
14+
15+
.. autoclass:: Vector
16+
:members:
17+
:exclude-members:

0 commit comments

Comments
 (0)