Module spring.data.mongodb

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

Class VectorIndex

java.lang.Object

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

All Implemented Interfaces:

SearchIndexDefinition

public class VectorIndex
extends Object
implements SearchIndexDefinition

SearchIndexDefinition for creating MongoDB Vector Index required to run $vectorSearch queries.

Since:

4.5

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VectorIndex.Quantization	Vector quantization.
static enum	VectorIndex.SimilarityFunction	Similarity function used to calculate vector distance.
static class	VectorIndex.VectorFieldBuilder	Builder to create a vector field

Constructor Summary

Constructors

Constructor	Description
VectorIndex(String name)	Create a new VectorIndex instance.

Method Summary

Modifier and Type	Method	Description
VectorIndex	addFilter(String path)	Add a filter field.
VectorIndex	addVector(String path, Consumer<VectorIndex.VectorFieldBuilder> customizer)	Add a vector field and accept a VectorIndex.VectorFieldBuilder customizer.
org.bson.Document	getDefinition(TypeInformation<?> entity, MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)	Returns the actual index definition for this index in the context of a potential entity to resolve field name mappings.
String	getName()
String	getType()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.index.SearchIndexDefinition

getIndexDocument, getRawIndexDocument

Constructor Details

VectorIndex

public VectorIndex(String name)

Create a new VectorIndex instance.

Parameters:

name - The name of the index.

Method Details

addFilter

@Contract("_ -> this")
public VectorIndex addFilter(String path)

Add a filter field.

Parameters:

path - dot notation to field/property used for filtering.

Returns:

this.

addVector

@Contract("_, _ -> this")
public VectorIndex addVector(String path,
 Consumer<VectorIndex.VectorFieldBuilder> customizer)

Add a vector field and accept a VectorIndex.VectorFieldBuilder customizer.

Parameters:

path - dot notation to field/property used for filtering.

customizer - customizer function.

Returns:

this.

getName

public String getName()

Specified by:

getName in interface SearchIndexDefinition

Returns:

the name of the index.

getType

public String getType()

Specified by:

getType in interface SearchIndexDefinition

Returns:

the type of the index. Typically, search or vectorSearch.

getDefinition

public org.bson.Document getDefinition(@Nullable
 TypeInformation<?> entity,
 @Nullable
 MappingContext<? extends MongoPersistentEntity<?>,MongoPersistentProperty> mappingContext)

Description copied from interface: SearchIndexDefinition

Returns the actual index definition for this index in the context of a potential entity to resolve field name mappings. Entity and context can be null to create a generic index definition without applying field name mapping.

Specified by:

getDefinition in interface SearchIndexDefinition

Parameters:

entity - can be null.

mappingContext - can be null.

Returns:

never null.

toString

public String toString()

Overrides:

toString in class Object