Class MongoDbEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.mongodb.MongoDbEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class MongoDbEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Represents a MongoDB indexed collection as an embedding store.

More info on using MongoDb vector search.

tutorial how to use vector search with MongoDB Atlas (great starting point).

To deploy a local instance of Atlas, see this guide.

If you are using a free tier, #createIndex = true might not be supported, so you will need to create an index manually. In your Atlas web console go to: DEPLOYMENT -> Database -> {your cluster} -> Atlas Search tab -> Create Index Search -> "JSON Editor" under "Atlas Vector Search" (not "Atlas Search") -> Next -> Select your database in the left pane -> Insert the following JSON into the right pane (set "numDimensions" and additional metadata fields to desired values)

{
  "fields" : [ {
    "type" : "vector",
    "path" : "embedding",
    "numDimensions" : 384,
    "similarity" : "cosine"
  }, {
    "type" : "filter",
    "path" : "metadata.test-key"
  } ]
}

-> Next -> Create Search Index

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MongoDbEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
MongoDbEmbeddingStore(com.mongodb.client.MongoClient mongoClient, String databaseName, String collectionName, String indexName, Long maxResultRatio, com.mongodb.client.model.CreateCollectionOptions createCollectionOptions, org.bson.conversions.Bson filter, IndexMapping indexMapping, Boolean createIndex)

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)
String	add(Embedding embedding, TextSegment textSegment)
void	add(String id, Embedding embedding)
List<String>	addAll(List<Embedding> embeddings)
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> embedded)
static MongoDbEmbeddingStore.Builder	builder()
void	removeAll()
void	removeAll(Filter filter)
void	removeAll(Collection<String> ids)
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)

Methods inherited from class Object

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

Methods inherited from interface EmbeddingStore

addAll, generateIds, remove

Constructor Details

MongoDbEmbeddingStore

public MongoDbEmbeddingStore(com.mongodb.client.MongoClient mongoClient,
 String databaseName,
 String collectionName,
 String indexName,
 Long maxResultRatio,
 com.mongodb.client.model.CreateCollectionOptions createCollectionOptions,
 org.bson.conversions.Bson filter,
 IndexMapping indexMapping,
 Boolean createIndex)

Method Details

builder

public static MongoDbEmbeddingStore.Builder builder()

add

public String add(Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public void add(String id,
 Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public String add(Embedding embedding,
 TextSegment textSegment)

Specified by:

add in interface EmbeddingStore<TextSegment>

addAll

public List<String> addAll(List<Embedding> embeddings)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll()

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Collection<String> ids)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

removeAll

public void removeAll(Filter filter)

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Specified by:

search in interface EmbeddingStore<TextSegment>

addAll

public void addAll(List<String> ids,
 List<Embedding> embeddings,
 List<TextSegment> embedded)

Specified by:

addAll in interface EmbeddingStore<TextSegment>