Package com.datastax.astra.client.model

Class CollectionOptions.CollectionOptionsBuilder

java.lang.Object

com.datastax.astra.client.model.CollectionOptions.CollectionOptionsBuilder

Enclosing class:

CollectionOptions

public static class CollectionOptions.CollectionOptionsBuilder
extends Object

Builder for CollectionInfo.

Constructor Summary

Constructors

Constructor	Description
CollectionOptionsBuilder()	Default constructor.

Method Summary

Modifier and Type	Method	Description
CollectionOptions	build()	Build the output.
CollectionOptions.CollectionOptionsBuilder	defaultIdType(CollectionIdTypes idType)	Builder Pattern with the Identifiers.
CollectionOptions.CollectionOptionsBuilder	indexingAllow(String... properties)	Builder pattern.
CollectionOptions.CollectionOptionsBuilder	indexingDeny(@NonNull String... properties)	Builder pattern.
CollectionOptions.CollectionOptionsBuilder	vector(int dimension, @NonNull SimilarityMetric function)	Builder pattern.
CollectionOptions.CollectionOptionsBuilder	vectorDimension(int size)	Builder pattern.
CollectionOptions.CollectionOptionsBuilder	vectorize(String provider, String modeName)	Enable Vectorization within the collection.
CollectionOptions.CollectionOptionsBuilder	vectorize(String provider, String modeName, String sharedSecretKey)	Enable Vectorization within the collection.
CollectionOptions.CollectionOptionsBuilder	vectorize(String provider, String modeName, String sharedSecretKey, Map<String,Object> parameters)	Enable Vectorization within the collection.
CollectionOptions.CollectionOptionsBuilder	vectorSimilarity(@NonNull SimilarityMetric function)	Builder pattern.

Methods inherited from class java.lang.Object

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

Constructor Details

CollectionOptionsBuilder

public CollectionOptionsBuilder()

Default constructor.

Method Details

defaultIdType

public CollectionOptions.CollectionOptionsBuilder defaultIdType(CollectionIdTypes idType)

Builder Pattern with the Identifiers.

Parameters:

idType - type of ids

Returns:

self reference

vectorDimension

public CollectionOptions.CollectionOptionsBuilder vectorDimension(int size)

Builder pattern.

Parameters:

size - size

Returns:

self reference

vectorSimilarity

public CollectionOptions.CollectionOptionsBuilder vectorSimilarity(@NonNull
 @NonNull SimilarityMetric function)

Builder pattern.

Parameters:

function - function

Returns:

self reference

indexingDeny

public CollectionOptions.CollectionOptionsBuilder indexingDeny(@NonNull
 @NonNull String... properties)

Builder pattern.

Parameters:

properties - size

Returns:

self reference

indexingAllow

public CollectionOptions.CollectionOptionsBuilder indexingAllow(String... properties)

Builder pattern.

Parameters:

properties - size

Returns:

self reference

vector

public CollectionOptions.CollectionOptionsBuilder vector(int dimension,
 @NonNull
 @NonNull SimilarityMetric function)

Builder pattern.

Parameters:

dimension - dimension

function - function

Returns:

self reference

vectorize

public CollectionOptions.CollectionOptionsBuilder vectorize(String provider,
 String modeName)

Enable Vectorization within the collection.

Parameters:

provider - provider Name (LLM)

modeName - mode name

Returns:

self reference

vectorize

public CollectionOptions.CollectionOptionsBuilder vectorize(String provider,
 String modeName,
 String sharedSecretKey)

Enable Vectorization within the collection.

Parameters:

provider - provider Name (LLM)

modeName - mode name

sharedSecretKey - name of the key in the system

Returns:

self reference

vectorize

public CollectionOptions.CollectionOptionsBuilder vectorize(String provider,
 String modeName,
 String sharedSecretKey,
 Map<String,Object> parameters)

Enable Vectorization within the collection.

Parameters:

provider - provider Name (LLM)

modeName - mode name

sharedSecretKey - name of the key in the system

parameters - expected parameters for vectorize

Returns:

self reference

build

public CollectionOptions build()

Build the output.

Returns:

collection definition