Package org.apache.cassandra.index.sai.disk.v1

Class IndexWriterConfig

java.lang.Object

org.apache.cassandra.index.sai.disk.v1.IndexWriterConfig

public class IndexWriterConfig
extends java.lang.Object

Per-index config for storage-attached index writers.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CONSTRUCTION_BEAM_WIDTH
static int	DEFAULT_CONSTRUCTION_BEAM_WIDTH
static int	DEFAULT_MAXIMUM_NODE_CONNECTIONS
static io.github.jbellis.jvector.vector.VectorSimilarityFunction	DEFAULT_SIMILARITY_FUNCTION
static int	MAX_TOP_K
static int	MAXIMUM_CONSTRUCTION_BEAM_WIDTH
static int	MAXIMUM_MAXIMUM_NODE_CONNECTIONS
static java.lang.String	MAXIMUM_NODE_CONNECTIONS
static java.lang.String	OPTIMIZE_FOR
static java.lang.String	SIMILARITY_FUNCTION
static java.lang.String	validSimilarityFunctions

Constructor Summary

Constructors

Constructor	Description
IndexWriterConfig(int maximumNodeConnections, int constructionBeamWidth, io.github.jbellis.jvector.vector.VectorSimilarityFunction similarityFunction, OptimizeFor optimizerFor)

Method Summary

Modifier and Type	Method	Description
static IndexWriterConfig	emptyConfig()
static IndexWriterConfig	fromOptions(java.lang.String indexName, IndexTermType indexTermType, java.util.Map<java.lang.String,java.lang.String> options)
int	getConstructionBeamWidth()
int	getMaximumNodeConnections()
OptimizeFor	getOptimizeFor()
io.github.jbellis.jvector.vector.VectorSimilarityFunction	getSimilarityFunction()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAXIMUM_NODE_CONNECTIONS

public static final java.lang.String MAXIMUM_NODE_CONNECTIONS

See Also:

Constant Field Values

MAXIMUM_MAXIMUM_NODE_CONNECTIONS

public static final int MAXIMUM_MAXIMUM_NODE_CONNECTIONS

See Also:

Constant Field Values

DEFAULT_MAXIMUM_NODE_CONNECTIONS

public static final int DEFAULT_MAXIMUM_NODE_CONNECTIONS

See Also:

Constant Field Values

CONSTRUCTION_BEAM_WIDTH

public static final java.lang.String CONSTRUCTION_BEAM_WIDTH

See Also:

Constant Field Values

MAXIMUM_CONSTRUCTION_BEAM_WIDTH

public static final int MAXIMUM_CONSTRUCTION_BEAM_WIDTH

See Also:

Constant Field Values

DEFAULT_CONSTRUCTION_BEAM_WIDTH

public static final int DEFAULT_CONSTRUCTION_BEAM_WIDTH

See Also:

Constant Field Values

SIMILARITY_FUNCTION

public static final java.lang.String SIMILARITY_FUNCTION

See Also:

Constant Field Values

DEFAULT_SIMILARITY_FUNCTION

public static final io.github.jbellis.jvector.vector.VectorSimilarityFunction DEFAULT_SIMILARITY_FUNCTION

validSimilarityFunctions

public static final java.lang.String validSimilarityFunctions

OPTIMIZE_FOR

public static final java.lang.String OPTIMIZE_FOR

See Also:

Constant Field Values

MAX_TOP_K

public static final int MAX_TOP_K

Constructor Detail

IndexWriterConfig

public IndexWriterConfig(int maximumNodeConnections,
                         int constructionBeamWidth,
                         io.github.jbellis.jvector.vector.VectorSimilarityFunction similarityFunction,
                         OptimizeFor optimizerFor)

Method Detail

getMaximumNodeConnections

public int getMaximumNodeConnections()

getConstructionBeamWidth

public int getConstructionBeamWidth()

getSimilarityFunction

public io.github.jbellis.jvector.vector.VectorSimilarityFunction getSimilarityFunction()

getOptimizeFor

public OptimizeFor getOptimizeFor()

fromOptions

public static IndexWriterConfig fromOptions(java.lang.String indexName,
                                            IndexTermType indexTermType,
                                            java.util.Map<java.lang.String,java.lang.String> options)

emptyConfig

public static IndexWriterConfig emptyConfig()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object