Package com.datastax.astra.client.tables.definition.indexes

Class TableVectorIndexDefinition

java.lang.Object

com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition<TableVectorIndexDefinitionOptions>

com.datastax.astra.client.tables.definition.indexes.TableVectorIndexDefinition

public class TableVectorIndexDefinition
extends TableIndexDefinition<TableVectorIndexDefinitionOptions>

Represents a definition for table vector indices, allowing configuration of vector-specific options such as similarity metrics and source models. This class provides a fluent interface for building vector index definitions.

Example usage:

 
 TableVectorIndexDefinition vectorIndexDefinition = new TableVectorIndexDefinition()
     .column("feature_vector")
     .metric(SimilarityMetric.COSINE)
     .sourceModel("model_name")
     .options(new TableVectorIndexDefinitionOptions());
 
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SOURCE_MODEL_ADA002	Initial source model.
static final String	SOURCE_MODEL_BERT	Initial source model.
static final String	SOURCE_MODEL_COHERE_V3	Initial source model.
static final String	SOURCE_MODEL_GECKO	Initial source model.
static final String	SOURCE_MODEL_NV_QA_4	Initial source model.
static final String	SOURCE_MODEL_OPENAI_V3_LARGE	Initial source model.
static final String	SOURCE_MODEL_OPENAI_V3_SMALL	Initial source model.

Fields inherited from class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition

apiSupport, column, constructor, options

Constructor Summary

Constructors

Modifier	Constructor	Description
	TableVectorIndexDefinition()	Constructs a new TableVectorIndexDefinition instance.
protected	TableVectorIndexDefinition(TableVectorIndexDefinitionOptions options)	Constructs a new TableVectorIndexDefinition instance with the specified options.

Method Summary

Modifier and Type	Method	Description
TableVectorIndexDefinition	column(String column)	Sets the name of the column for the index.
TableVectorIndexDefinition	column(String column, TableIndexMapTypes type)	Sets the name of the column for the index.
TableVectorIndexDefinition	metric(SimilarityMetric metric)	Configures the similarity metric to be used for the vector index.
TableVectorIndexDefinition	options(TableVectorIndexDefinitionOptions options)	Sets the options for configuring the table index.
TableVectorIndexDefinition	sourceModel(String sourceModel)	Sets the source model for the vector index.

Methods inherited from class com.datastax.astra.client.tables.definition.indexes.TableIndexDefinition

mapImpl

Methods inherited from class java.lang.Object

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

Field Details

SOURCE_MODEL_ADA002

public static final String SOURCE_MODEL_ADA002

Initial source model.

See Also:

• Constant Field Values

SOURCE_MODEL_BERT

public static final String SOURCE_MODEL_BERT

Initial source model.

See Also:

• Constant Field Values

SOURCE_MODEL_COHERE_V3

public static final String SOURCE_MODEL_COHERE_V3

Initial source model.

See Also:

• Constant Field Values

SOURCE_MODEL_GECKO

public static final String SOURCE_MODEL_GECKO

Initial source model.

See Also:

• Constant Field Values

SOURCE_MODEL_NV_QA_4

public static final String SOURCE_MODEL_NV_QA_4

Initial source model.

See Also:

• Constant Field Values

SOURCE_MODEL_OPENAI_V3_LARGE

public static final String SOURCE_MODEL_OPENAI_V3_LARGE

Initial source model.

See Also:

• Constant Field Values

SOURCE_MODEL_OPENAI_V3_SMALL

public static final String SOURCE_MODEL_OPENAI_V3_SMALL

Initial source model.

See Also:

• Constant Field Values

Constructor Details

TableVectorIndexDefinition

public TableVectorIndexDefinition()

Constructs a new TableVectorIndexDefinition instance.

TableVectorIndexDefinition

protected TableVectorIndexDefinition(TableVectorIndexDefinitionOptions options)

Constructs a new TableVectorIndexDefinition instance with the specified options.

Parameters:

options - the options to use for the vector index.

Method Details

column

public TableVectorIndexDefinition column(String column)

Description copied from class: TableIndexDefinition

Sets the name of the column for the index.

Overrides:

column in class TableIndexDefinition<TableVectorIndexDefinitionOptions>

Parameters:

column - the name of the column to be indexed.

Returns:

a new instance with the updated column.

column

public TableVectorIndexDefinition column(String column,
 TableIndexMapTypes type)

Description copied from class: TableIndexDefinition

Sets the name of the column for the index.

Overrides:

column in class TableIndexDefinition<TableVectorIndexDefinitionOptions>

Parameters:

column - the name of the column to be indexed.

type - the type of the column to be indexed.

Returns:

the current instance of TableIndexDefinition for method chaining.

options

public TableVectorIndexDefinition options(TableVectorIndexDefinitionOptions options)

Description copied from class: TableIndexDefinition

Sets the options for configuring the table index.

Overrides:

options in class TableIndexDefinition<TableVectorIndexDefinitionOptions>

Parameters:

options - an instance of TableIndexDefinitionOptions containing index options.

Returns:

the current instance of TableIndexDefinition for method chaining.

metric

public TableVectorIndexDefinition metric(SimilarityMetric metric)

Configures the similarity metric to be used for the vector index.

Parameters:

metric - an instance of SimilarityMetric representing the similarity metric.

Returns:

the current instance of TableVectorIndexDefinition for method chaining.

sourceModel

public TableVectorIndexDefinition sourceModel(String sourceModel)

Sets the source model for the vector index.

Parameters:

sourceModel - the name of the source model to be associated with the vector index.

Returns:

the current instance of TableVectorIndexDefinition for method chaining.