Package dev.langchain4j.store.embedding.azure.cosmos.nosql

Class AzureCosmosDbNoSqlEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.azure.cosmos.nosql.AzureCosmosDbNoSqlEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class AzureCosmosDbNoSqlEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Implementation of EmbeddingStore that uses Azure Cosmos DB NoSQL API for storing and retrieving embeddings. This store provides vector search capabilities using Cosmos DB's vector search functionality.

You can read more about vector search using Azure Cosmos DB NoSQL here.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AzureCosmosDbNoSqlEmbeddingStore.AzureCosmosDbNoSqlEmbeddingStoreBuilder	Builder for creating AzureCosmosDbNoSqlEmbeddingStore instances.

Constructor Summary

Constructors

Constructor	Description
AzureCosmosDbNoSqlEmbeddingStore(com.azure.cosmos.CosmosClient cosmosClient, String databaseName, String containerName, com.azure.cosmos.models.CosmosVectorEmbeddingPolicy cosmosVectorEmbeddingPolicy, List<com.azure.cosmos.models.CosmosVectorIndexSpec> cosmosVectorIndexes, com.azure.cosmos.models.CosmosContainerProperties containerProperties)	Creates a new instance of AzureCosmosDbNoSqlEmbeddingStore.

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 AzureCosmosDbNoSqlEmbeddingStore.AzureCosmosDbNoSqlEmbeddingStoreBuilder	builder()	Creates a new builder for AzureCosmosDbNoSqlEmbeddingStore.
List<EmbeddingMatch<TextSegment>>	findRelevant(Embedding referenceEmbedding, int maxResults, double minScore)	Finds embeddings relevant to the reference embedding.
EmbeddingSearchResult<TextSegment>	search(EmbeddingSearchRequest request)	Searches for the most similar (closest in the embedding space) Embeddings.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.langchain4j.store.embedding.EmbeddingStore

addAll, generateIds, remove, removeAll, removeAll, removeAll

Constructor Details

AzureCosmosDbNoSqlEmbeddingStore

public AzureCosmosDbNoSqlEmbeddingStore(com.azure.cosmos.CosmosClient cosmosClient,
 String databaseName,
 String containerName,
 com.azure.cosmos.models.CosmosVectorEmbeddingPolicy cosmosVectorEmbeddingPolicy,
 List<com.azure.cosmos.models.CosmosVectorIndexSpec> cosmosVectorIndexes,
 com.azure.cosmos.models.CosmosContainerProperties containerProperties)

Creates a new instance of AzureCosmosDbNoSqlEmbeddingStore.

Parameters:

cosmosClient - The Cosmos DB client

databaseName - The name of the database

containerName - The name of the container

cosmosVectorEmbeddingPolicy - The vector embedding policy

cosmosVectorIndexes - The vector indexes

containerProperties - The container properties

Throws:

IllegalArgumentException - if any of the required parameters is null or empty

Method Details

builder

public static AzureCosmosDbNoSqlEmbeddingStore.AzureCosmosDbNoSqlEmbeddingStoreBuilder builder()

Creates a new builder for AzureCosmosDbNoSqlEmbeddingStore.

Returns:

a new builder instance

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.

findRelevant

public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding,
 int maxResults,
 double minScore)

Finds embeddings relevant to the reference embedding.

Parameters:

referenceEmbedding - The reference embedding to compare against

maxResults - The maximum number of results to return

minScore - The minimum similarity score required

Returns:

A list of embedding matches ordered by relevance

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.

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.