Class MongoDbEmbeddingStore
java.lang.Object
dev.langchain4j.store.embedding.mongodb.MongoDbEmbeddingStore
- All Implemented Interfaces:
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 -
Constructor Summary
ConstructorsConstructorDescriptionMongoDbEmbeddingStore(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 TypeMethodDescriptionAdds a given embedding to the store.add(Embedding embedding, TextSegment textSegment) Adds a given embedding and the corresponding content that has been embedded to the store.voidAdds a given embedding to the store.Adds multiple embeddings to the store.voidAdds multiple embeddings and their corresponding contents that have been embedded to the store.builder()voidRemoves all embeddings from the store.voidRemoves all embeddings that match the specifiedFilterfrom the store.voidremoveAll(Collection<String> ids) Removes all embeddings that match the specified IDs from the store.search(EmbeddingSearchRequest request) Searches for the most similar (closest in the embedding space)Embeddings.Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods 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
-
add
Description copied from interface:EmbeddingStoreAdds a given embedding to the store.- Specified by:
addin interfaceEmbeddingStore<TextSegment>- Parameters:
embedding- The embedding to be added to the store.- Returns:
- The auto-generated ID associated with the added embedding.
-
add
Description copied from interface:EmbeddingStoreAdds a given embedding to the store.- Specified by:
addin interfaceEmbeddingStore<TextSegment>- Parameters:
id- The unique identifier for the embedding to be added.embedding- The embedding to be added to the store.
-
add
Description copied from interface:EmbeddingStoreAdds a given embedding and the corresponding content that has been embedded to the store.- Specified by:
addin interfaceEmbeddingStore<TextSegment>- Parameters:
embedding- The embedding to be added to the store.textSegment- Original content that was embedded.- Returns:
- The auto-generated ID associated with the added embedding.
-
addAll
Description copied from interface:EmbeddingStoreAdds multiple embeddings to the store.- Specified by:
addAllin interfaceEmbeddingStore<TextSegment>- Parameters:
embeddings- A list of embeddings to be added to the store.- Returns:
- A list of auto-generated IDs associated with the added embeddings.
-
removeAll
public void removeAll()Description copied from interface:EmbeddingStoreRemoves all embeddings from the store.- Specified by:
removeAllin interfaceEmbeddingStore<TextSegment>
-
removeAll
Description copied from interface:EmbeddingStoreRemoves all embeddings that match the specified IDs from the store.- Specified by:
removeAllin interfaceEmbeddingStore<TextSegment>- Parameters:
ids- A collection of unique IDs of the embeddings to be removed.
-
removeAll
Description copied from interface:EmbeddingStoreRemoves all embeddings that match the specifiedFilterfrom the store.- Specified by:
removeAllin interfaceEmbeddingStore<TextSegment>- Parameters:
filter- The filter to be applied to theMetadataof theTextSegmentduring removal. Only embeddings whoseTextSegment'sMetadatamatch theFilterwill be removed.
-
search
Description copied from interface:EmbeddingStoreSearches for the most similar (closest in the embedding space)Embeddings.
All search criteria are defined inside theEmbeddingSearchRequest.
EmbeddingSearchRequest.filter()can be used to filter by various metadata entries (e.g., user/memory ID). Please note that not allEmbeddingStoreimplementations supportFiltering.- Specified by:
searchin interfaceEmbeddingStore<TextSegment>- Parameters:
request- A request to search in anEmbeddingStore. Contains all search criteria.- Returns:
- An
EmbeddingSearchResultcontaining all foundEmbeddings.
-
addAll
Description copied from interface:EmbeddingStoreAdds multiple embeddings and their corresponding contents that have been embedded to the store.- Specified by:
addAllin interfaceEmbeddingStore<TextSegment>- Parameters:
ids- A list of IDs associated with the added embeddings.embeddings- A list of embeddings to be added to the store.embedded- A list of original contents that were embedded.
-