Package com.mongodb.client.model

Interface SearchIndexDefinition

All Superinterfaces:

org.bson.conversions.Bson

All Known Implementing Classes:

VectorSearchIndexDefinition

@Sealed
public interface SearchIndexDefinition
extends org.bson.conversions.Bson

A definition for an Atlas Search index.

This interface provides factory methods for creating search index definitions that can be passed to SearchIndexModel.

Since:

5.8

See Also:

• SearchIndexModel
• VectorSearchIndexDefinition

Field Summary

Fields inherited from interface org.bson.conversions.Bson

DEFAULT_CODEC_REGISTRY

Method Summary

Static Methods

Modifier and Type	Method	Description
static VectorSearchIndexDefinition	vectorSearch(List<? extends org.bson.conversions.Bson> fields)	Creates a vector search index definition with the specified fields.
static VectorSearchIndexDefinition	vectorSearch(org.bson.conversions.Bson... fields)	Creates a vector search index definition with the specified fields.

Methods inherited from interface org.bson.conversions.Bson

toBsonDocument, toBsonDocument

Method Details

vectorSearch

static VectorSearchIndexDefinition vectorSearch(org.bson.conversions.Bson... fields)

Creates a vector search index definition with the specified fields.

The resulting definition produces a document of the form {"fields": [...]}, suitable for use with SearchIndexType.vectorSearch().

Parameters:

fields - the fields for the vector search index. Each field should be created using VectorSearchIndexFields factory methods, or may be a raw Bson document.

Returns:

a new VectorSearchIndexDefinition

Since:

5.8

See Also:

• VectorSearchIndexFields.vectorField(String)
• VectorSearchIndexFields.filterField(String)
• VectorSearchIndexFields.autoEmbedField(String)

vectorSearch

static VectorSearchIndexDefinition vectorSearch(List<? extends org.bson.conversions.Bson> fields)

Creates a vector search index definition with the specified fields.

The resulting definition produces a document of the form {"fields": [...]}, suitable for use with SearchIndexType.vectorSearch().

Parameters:

fields - the fields for the vector search index. Each field should be created using VectorSearchIndexFields factory methods, or may be a raw Bson document.

Returns:

a new VectorSearchIndexDefinition

Since:

5.8

See Also:

• VectorSearchIndexFields.vectorField(String)
• VectorSearchIndexFields.filterField(String)
• VectorSearchIndexFields.autoEmbedField(String)