Package org.springframework.data.mongodb.core.index

Class VectorIndex.VectorFieldBuilder

java.lang.Object

org.springframework.data.mongodb.core.index.VectorIndex.VectorFieldBuilder

Enclosing class:

VectorIndex

public static class VectorIndex.VectorFieldBuilder
extends Object

Builder to create a vector field

Method Summary

Modifier and Type	Method	Description
VectorIndex.VectorFieldBuilder	cosine()	Use similarity based on the angle between vectors.
VectorIndex.VectorFieldBuilder	dimensions(int dimensions)	Number of vector dimensions enforced at index- & query-time.
VectorIndex.VectorFieldBuilder	dotProduct()	Use similarity based on both angle and magnitude of the vectors.
VectorIndex.VectorFieldBuilder	euclidean()	Use similarity based the distance between vector ends.
VectorIndex.VectorFieldBuilder	quantization(String quantization)	Quantization used.
VectorIndex.VectorFieldBuilder	quantization(VectorIndex.Quantization quantization)	Quantization used.
VectorIndex.VectorFieldBuilder	similarity(String similarity)	Similarity function used.
VectorIndex.VectorFieldBuilder	similarity(VectorIndex.SimilarityFunction similarity)	Similarity function used.

Methods inherited from class java.lang.Object

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

Method Details

dimensions

@Contract("_ -> this")
public VectorIndex.VectorFieldBuilder dimensions(int dimensions)

Number of vector dimensions enforced at index- & query-time.

Parameters:

dimensions - value between 0 and 4096.

Returns:

this.

cosine

@Contract(" -> this")
public VectorIndex.VectorFieldBuilder cosine()

Use similarity based on the angle between vectors.

Returns:

new instance of VectorIndex.

euclidean

@Contract(" -> this")
public VectorIndex.VectorFieldBuilder euclidean()

Use similarity based the distance between vector ends.

dotProduct

@Contract(" -> this")
public VectorIndex.VectorFieldBuilder dotProduct()

Use similarity based on both angle and magnitude of the vectors.

Returns:

new instance of VectorIndex.

similarity

@Contract("_ -> this")
public VectorIndex.VectorFieldBuilder similarity(String similarity)

Similarity function used.

Parameters:

similarity - should be one of euclidean | cosine | dotProduct.

Returns:

this.

See Also:

• VectorIndex.SimilarityFunction
• similarity(SimilarityFunction)

similarity

@Contract("_ -> this")
public VectorIndex.VectorFieldBuilder similarity(VectorIndex.SimilarityFunction similarity)

Similarity function used.

Parameters:

similarity - must not be null.

Returns:

this.

quantization

public VectorIndex.VectorFieldBuilder quantization(String quantization)

Quantization used.

Parameters:

quantization - should be one of none | scalar | binary.

Returns:

this.

See Also:

• VectorIndex.Quantization
• quantization(Quantization)

quantization

public VectorIndex.VectorFieldBuilder quantization(VectorIndex.Quantization quantization)

Quantization used.

Parameters:

quantization - must not be null.

Returns:

this.