Class AzureDocumentDbEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.azure.documentdb.AzureDocumentDbEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>, AutoCloseable

public class AzureDocumentDbEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>, AutoCloseable

Stores embeddings in Azure DocumentDB.

See the vector search documentation for supported index types and cluster tiers.

When configured with a connection string, this store owns its MongoClient and must be closed when no longer needed. A supplied MongoClient remains caller-owned and is never closed by this store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureDocumentDbEmbeddingStore.Builder
static enum	AzureDocumentDbEmbeddingStore.VectorIndexType

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)	Adds a given embedding to the store.
String	add(Embedding embedding, TextSegment textSegment)	Adds a given embedding and the corresponding content that has been embedded to the store.
void	add(String id, Embedding embedding)	Adds a given embedding to the store.
List<String>	addAll(List<Embedding> embeddings)	Adds multiple embeddings to the store.
void	addAll(List<String> ids, List<Embedding> embeddings, List<TextSegment> embedded)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
static AzureDocumentDbEmbeddingStore.Builder	builder()
void	close()	Closes the internally created MongoClient, releasing its connection pools and threads.
EmbeddingSearchResult<TextSegment>	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, wait

Methods inherited from interface EmbeddingStore

addAll, addListener, addListeners, generateIds, remove, removeAll, removeAll, removeAll, searchAsync

Method Details

builder

public static AzureDocumentDbEmbeddingStore.Builder builder()

close

public void close()

Closes the internally created MongoClient, releasing its connection pools and threads. Repeated calls have no effect. A caller-supplied MongoClient is never closed.

Specified by:

close in interface AutoCloseable

add

public String add(Embedding embedding)

Description copied from interface: EmbeddingStore

Adds a given embedding to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

embedding - The embedding to be added to the store.

Returns:

The auto-generated ID associated with the added embedding.

add

public void add(String id,
 Embedding embedding)

Description copied from interface: EmbeddingStore

Adds a given embedding to the store.

Specified by:

add in interface EmbeddingStore<TextSegment>

Parameters:

id - The unique identifier for the embedding to be added.

embedding - The embedding to be added to the store.

add

public String add(Embedding embedding,
 TextSegment textSegment)

Description copied from interface: EmbeddingStore

Adds a given embedding and the corresponding content that has been embedded to the store.

Specified by:

add in interface EmbeddingStore<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

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

Description copied from interface: EmbeddingStore

Adds multiple embeddings to the store.

Specified by:

addAll in interface EmbeddingStore<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.

search

public EmbeddingSearchResult<TextSegment> search(EmbeddingSearchRequest request)

Description copied from interface: EmbeddingStore

Searches for the most similar (closest in the embedding space) Embeddings.
All search criteria are defined inside the EmbeddingSearchRequest.
EmbeddingSearchRequest.filter() can be used to filter by various metadata entries (e.g., user/memory ID). Please note that not all EmbeddingStore implementations support Filtering.

Specified by:

search in interface EmbeddingStore<TextSegment>

Parameters:

request - A request to search in an EmbeddingStore. Contains all search criteria.

Returns:

An EmbeddingSearchResult containing all found Embeddings.

addAll

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

Description copied from interface: EmbeddingStore

Adds multiple embeddings and their corresponding contents that have been embedded to the store.

The lists are positional: the i-th ID, the i-th embedding and the i-th embedded content belong together. ids and embeddings must therefore have the same size, and embedded, when provided, must have that size as well. A null list of IDs or embeddings counts as an empty list, so passing embeddings without IDs (or the other way around) is a size mismatch, not an empty input. ValidationUtils.ensureConsistentSizes(List, List, List) implements these rules and should be used by implementations.

Passing no embeddings at all (an empty or null embeddings together with an empty or null ids, and no embedded contents) is a no-op: nothing is stored and no exception is thrown.

Specified by:

addAll in interface EmbeddingStore<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, or null if they were not provided.