redis.clients.jedis.params

Class VAddParams

java.lang.Object

redis.clients.jedis.params.VAddParams

All Implemented Interfaces:

IParams

@Experimental
public class VAddParams
extends java.lang.Object
implements IParams

Parameters for the VADD command.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VAddParams.QuantizationType

Constructor Summary

Constructors

Constructor and Description
VAddParams()

Method Summary

Modifier and Type	Method and Description
void	addParams(CommandArguments args)
VAddParams	bin() Forces the vector to use binary quantization instead of int8.
VAddParams	cas() Performs the operation partially using threads, in a check-and-set style.
VAddParams	ef(int buildExplorationFactor) Plays a role in the effort made to find good candidates when connecting the new node to the existing Hierarchical Navigable Small World (HNSW) graph.
VAddParams	m(int numLinks) The maximum number of connections that each node of the graph will have with other nodes.
VAddParams	noQuant() Forces the vector to be created without int8 quantization.
VAddParams	q8() Forces the vector to use signed 8-bit quantization.
VAddParams	setAttr(java.lang.String attributes) Associates attributes in the form of a JavaScript object to the newly created entry or updates the attributes (if they already exist).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VAddParams

public VAddParams()

Method Detail

cas

public VAddParams cas()

Performs the operation partially using threads, in a check-and-set style. The neighbor candidates collection, which is slow, is performed in the background, while the command is executed in the main thread.

Returns:

VAddParams

noQuant

public VAddParams noQuant()

Forces the vector to be created without int8 quantization.

Returns:

VAddParams

q8

public VAddParams q8()

Forces the vector to use signed 8-bit quantization. This is the default.

Returns:

VAddParams

bin

public VAddParams bin()

Forces the vector to use binary quantization instead of int8. This is much faster and uses less memory, but impacts the recall quality.

Returns:

VAddParams

ef

public VAddParams ef(int buildExplorationFactor)

Plays a role in the effort made to find good candidates when connecting the new node to the existing Hierarchical Navigable Small World (HNSW) graph. The default is 200. Using a larger value may help in achieving a better recall.

Parameters:

buildExplorationFactor - the exploration factor

Returns:

VAddParams

setAttr

public VAddParams setAttr(java.lang.String attributes)

Associates attributes in the form of a JavaScript object to the newly created entry or updates the attributes (if they already exist).

Parameters:

attributes - the attributes as a JSON string

Returns:

VAddParams

m

public VAddParams m(int numLinks)

The maximum number of connections that each node of the graph will have with other nodes. The default is 16. More connections means more memory, but provides for more efficient graph exploration.

Parameters:

numLinks - the maximum number of connections

Returns:

VAddParams

addParams

public void addParams(CommandArguments args)

Specified by:

addParams in interface IParams