summaryrefslogtreecommitdiff
path: root/examples/redis-unstable/modules/vector-sets/commands.json
diff options
context:
space:
mode:
Diffstat (limited to 'examples/redis-unstable/modules/vector-sets/commands.json')
-rw-r--r--examples/redis-unstable/modules/vector-sets/commands.json446
1 files changed, 0 insertions, 446 deletions
diff --git a/examples/redis-unstable/modules/vector-sets/commands.json b/examples/redis-unstable/modules/vector-sets/commands.json
deleted file mode 100644
index 5f42f87..0000000
--- a/examples/redis-unstable/modules/vector-sets/commands.json
+++ /dev/null
@@ -1,446 +0,0 @@
1{
2 "VADD": {
3 "summary": "Add one or more elements to a vector set, or update its vector if it already exists",
4 "complexity": "O(log(N)) for each element added, where N is the number of elements in the vector set.",
5 "group": "vector_set",
6 "since": "8.0.0",
7 "arity": -5,
8 "function": "vaddCommand",
9 "arguments": [
10 {
11 "name": "key",
12 "type": "key"
13 },
14 {
15 "token": "REDUCE",
16 "name": "reduce",
17 "type": "block",
18 "optional": true,
19 "arguments": [
20 {
21 "name": "dim",
22 "type": "integer"
23 }
24 ]
25 },
26 {
27 "name": "format",
28 "type": "oneof",
29 "arguments": [
30 {
31 "name": "fp32",
32 "type": "pure-token",
33 "token": "FP32"
34 },
35 {
36 "name": "values",
37 "type": "pure-token",
38 "token": "VALUES"
39 }
40 ]
41 },
42 {
43 "name": "vector",
44 "type": "string"
45 },
46 {
47 "name": "element",
48 "type": "string"
49 },
50 {
51 "token": "CAS",
52 "name": "cas",
53 "type": "pure-token",
54 "optional": true
55 },
56 {
57 "name": "quant_type",
58 "type": "oneof",
59 "optional": true,
60 "arguments": [
61 {
62 "name": "noquant",
63 "type": "pure-token",
64 "token": "NOQUANT"
65 },
66 {
67 "name": "bin",
68 "type": "pure-token",
69 "token": "BIN"
70 },
71 {
72 "name": "q8",
73 "type": "pure-token",
74 "token": "Q8"
75 }
76 ]
77 },
78 {
79 "token": "EF",
80 "name": "build-exploration-factor",
81 "type": "integer",
82 "optional": true
83 },
84 {
85 "token": "SETATTR",
86 "name": "attributes",
87 "type": "string",
88 "optional": true
89 },
90 {
91 "token": "M",
92 "name": "numlinks",
93 "type": "integer",
94 "optional": true
95 }
96 ],
97 "command_flags": [
98 "WRITE",
99 "DENYOOM"
100 ]
101 },
102 "VREM": {
103 "summary": "Remove an element from a vector set",
104 "complexity": "O(log(N)) for each element removed, where N is the number of elements in the vector set.",
105 "group": "vector_set",
106 "since": "8.0.0",
107 "arity": 3,
108 "function": "vremCommand",
109 "command_flags": [
110 "WRITE"
111 ],
112 "arguments": [
113 {
114 "name": "key",
115 "type": "key"
116 },
117 {
118 "name": "element",
119 "type": "string"
120 }
121 ]
122 },
123 "VSIM": {
124 "summary": "Return elements by vector similarity",
125 "complexity": "O(log(N)) where N is the number of elements in the vector set.",
126 "group": "vector_set",
127 "since": "8.0.0",
128 "arity": -4,
129 "function": "vsimCommand",
130 "command_flags": [
131 "READONLY"
132 ],
133 "arguments": [
134 {
135 "name": "key",
136 "type": "key"
137 },
138 {
139 "name": "format",
140 "type": "oneof",
141 "arguments": [
142 {
143 "name": "ele",
144 "type": "pure-token",
145 "token": "ELE"
146 },
147 {
148 "name": "fp32",
149 "type": "pure-token",
150 "token": "FP32"
151 },
152 {
153 "name": "values",
154 "type": "pure-token",
155 "token": "VALUES"
156 }
157 ]
158 },
159 {
160 "name": "vector_or_element",
161 "type": "string"
162 },
163 {
164 "token": "WITHSCORES",
165 "name": "withscores",
166 "type": "pure-token",
167 "optional": true
168 },
169 {
170 "token": "WITHATTRIBS",
171 "name": "withattribs",
172 "type": "pure-token",
173 "optional": true
174 },
175 {
176 "token": "COUNT",
177 "name": "count",
178 "type": "integer",
179 "optional": true
180 },
181 {
182 "token": "EPSILON",
183 "name": "max_distance",
184 "type": "double",
185 "optional": true
186 },
187 {
188 "token": "EF",
189 "name": "search-exploration-factor",
190 "type": "integer",
191 "optional": true
192 },
193 {
194 "token": "FILTER",
195 "name": "expression",
196 "type": "string",
197 "optional": true
198 },
199 {
200 "token": "FILTER-EF",
201 "name": "max-filtering-effort",
202 "type": "integer",
203 "optional": true
204 },
205 {
206 "token": "TRUTH",
207 "name": "truth",
208 "type": "pure-token",
209 "optional": true
210 },
211 {
212 "token": "NOTHREAD",
213 "name": "nothread",
214 "type": "pure-token",
215 "optional": true
216 }
217 ]
218 },
219 "VDIM": {
220 "summary": "Return the dimension of vectors in the vector set",
221 "complexity": "O(1)",
222 "group": "vector_set",
223 "since": "8.0.0",
224 "arity": 2,
225 "function": "vdimCommand",
226 "command_flags": [
227 "READONLY",
228 "FAST"
229 ],
230 "arguments": [
231 {
232 "name": "key",
233 "type": "key"
234 }
235 ]
236 },
237 "VCARD": {
238 "summary": "Return the number of elements in a vector set",
239 "complexity": "O(1)",
240 "group": "vector_set",
241 "since": "8.0.0",
242 "arity": 2,
243 "function": "vcardCommand",
244 "command_flags": [
245 "READONLY",
246 "FAST"
247 ],
248 "arguments": [
249 {
250 "name": "key",
251 "type": "key"
252 }
253 ]
254 },
255 "VEMB": {
256 "summary": "Return the vector associated with an element",
257 "complexity": "O(1)",
258 "group": "vector_set",
259 "since": "8.0.0",
260 "arity": -3,
261 "function": "vembCommand",
262 "command_flags": [
263 "READONLY"
264 ],
265 "arguments": [
266 {
267 "name": "key",
268 "type": "key"
269 },
270 {
271 "name": "element",
272 "type": "string"
273 },
274 {
275 "token": "RAW",
276 "name": "raw",
277 "type": "pure-token",
278 "optional": true
279 }
280 ]
281 },
282 "VLINKS": {
283 "summary": "Return the neighbors of an element at each layer in the HNSW graph",
284 "complexity": "O(1)",
285 "group": "vector_set",
286 "since": "8.0.0",
287 "arity": -3,
288 "function": "vlinksCommand",
289 "command_flags": [
290 "READONLY"
291 ],
292 "arguments": [
293 {
294 "name": "key",
295 "type": "key"
296 },
297 {
298 "name": "element",
299 "type": "string"
300 },
301 {
302 "token": "WITHSCORES",
303 "name": "withscores",
304 "type": "pure-token",
305 "optional": true
306 }
307 ]
308 },
309 "VINFO": {
310 "summary": "Return information about a vector set",
311 "complexity": "O(1)",
312 "group": "vector_set",
313 "since": "8.0.0",
314 "arity": 2,
315 "function": "vinfoCommand",
316 "command_flags": [
317 "READONLY",
318 "FAST"
319 ],
320 "arguments": [
321 {
322 "name": "key",
323 "type": "key"
324 }
325 ]
326 },
327 "VSETATTR": {
328 "summary": "Associate or remove the JSON attributes of elements",
329 "complexity": "O(1)",
330 "group": "vector_set",
331 "since": "8.0.0",
332 "arity": 4,
333 "function": "vsetattrCommand",
334 "command_flags": [
335 "WRITE"
336 ],
337 "arguments": [
338 {
339 "name": "key",
340 "type": "key"
341 },
342 {
343 "name": "element",
344 "type": "string"
345 },
346 {
347 "name": "json",
348 "type": "string"
349 }
350 ]
351 },
352 "VGETATTR": {
353 "summary": "Retrieve the JSON attributes of elements",
354 "complexity": "O(1)",
355 "group": "vector_set",
356 "since": "8.0.0",
357 "arity": 3,
358 "function": "vgetattrCommand",
359 "command_flags": [
360 "READONLY"
361 ],
362 "arguments": [
363 {
364 "name": "key",
365 "type": "key"
366 },
367 {
368 "name": "element",
369 "type": "string"
370 }
371 ]
372 },
373 "VRANDMEMBER": {
374 "summary": "Return one or multiple random members from a vector set",
375 "complexity": "O(N) where N is the absolute value of the count argument.",
376 "group": "vector_set",
377 "since": "8.0.0",
378 "arity": -2,
379 "function": "vrandmemberCommand",
380 "command_flags": [
381 "READONLY"
382 ],
383 "arguments": [
384 {
385 "name": "key",
386 "type": "key"
387 },
388 {
389 "name": "count",
390 "type": "integer",
391 "optional": true
392 }
393 ]
394 },
395 "VISMEMBER": {
396 "summary": "Check if an element exists in a vector set",
397 "complexity": "O(1)",
398 "group": "vector_set",
399 "since": "8.2.0",
400 "arity": 3,
401 "function": "vismemberCommand",
402 "command_flags": [
403 "READONLY"
404 ],
405 "arguments": [
406 {
407 "name": "key",
408 "type": "key"
409 },
410 {
411 "name": "element",
412 "type": "string"
413 }
414 ]
415 },
416 "VRANGE": {
417 "summary": "Return elements in a lexicographical range",
418 "complexity": "O(log(K)+M) where K is the number of elements in the start prefix, and M is the number of elements returned. In practical terms, the command is just O(M)",
419 "group": "vector_set",
420 "since": "8.4.0",
421 "arity": -4,
422 "function": "vrangeCommand",
423 "command_flags": [
424 "READONLY"
425 ],
426 "arguments": [
427 {
428 "name": "key",
429 "type": "key"
430 },
431 {
432 "name": "start",
433 "type": "string"
434 },
435 {
436 "name": "end",
437 "type": "string"
438 },
439 {
440 "name": "count",
441 "type": "integer",
442 "optional": true
443 }
444 ]
445 }
446}