Package com.mongodb.client.model

Class VectorSearchIndexFields

java.lang.Object

com.mongodb.client.model.VectorSearchIndexFields

public final class VectorSearchIndexFields
extends Object

A factory for defining fields within a vector search index definition.

A convenient way to use this class is to statically import all of its methods, which allows usage like:

    SearchIndexDefinition.vectorSearch(
        vectorField("plot_embedding")
            .numDimensions(1536)
            .similarity("euclidean")
            .indexingMethod("flat"),
        filterField("genre")
    );
 

Since:

5.8

See Also:

• SearchIndexDefinition.vectorSearch(Bson...)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	VectorSearchIndexFields.AutoEmbedField	An auto-embed field definition for a vector search index.
static final class	VectorSearchIndexFields.FilterField	A filter field definition for a vector search index.
static final class	VectorSearchIndexFields.VectorField	A vector field definition for a vector search index.

Method Summary

Modifier and Type	Method	Description
static VectorSearchIndexFields.AutoEmbedField	autoEmbedField(String path)	Creates an auto-embed field definition for a vector search index.
static VectorSearchIndexFields.FilterField	filterField(String path)	Creates a filter field definition for a vector search index.
static VectorSearchIndexFields.VectorField	vectorField(String path)	Creates a vector field definition for a vector search index.

Methods inherited from class java.lang.Object

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

Method Details

vectorField

public static VectorSearchIndexFields.VectorField vectorField(String path)

Creates a vector field definition for a vector search index.

Parameters:

path - the field path in the document

Returns:

a new VectorSearchIndexFields.VectorField

Since:

5.8

filterField

public static VectorSearchIndexFields.FilterField filterField(String path)

Creates a filter field definition for a vector search index.

Parameters:

path - the field path in the document

Returns:

a new VectorSearchIndexFields.FilterField

Since:

5.8

autoEmbedField

public static VectorSearchIndexFields.AutoEmbedField autoEmbedField(String path)

Creates an auto-embed field definition for a vector search index.

Parameters:

path - the field path in the document containing the content to embed

Returns:

a new VectorSearchIndexFields.AutoEmbedField

Since:

5.8