Class AbstractAzureCosmosDBNoSqlEmbeddingStore

java.lang.Object

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

All Implemented Interfaces:

EmbeddingStore<TextSegment>

Direct Known Subclasses:

AzureCosmosDBNoSqlContentRetriever, AzureCosmosDbNoSqlEmbeddingStore

public class AbstractAzureCosmosDBNoSqlEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	DEFAULT_CONTAINER_NAME
protected static final String	DEFAULT_DATABASE_NAME
protected static final Integer	DEFAULT_MAX_RESULTS
protected static final String	DEFAULT_PARTITION_KEY_PATH
protected static final AzureCosmosDBSearchQueryType	DEFAULT_SEARCH_QUERY_TYPE
protected static final Integer	DEFAULT_THROUGHPUT
protected AzureCosmosDBNoSqlFilterMapper	filterMapper
protected static final String	USER_AGENT

Constructor Summary

Constructors

Constructor	Description
AbstractAzureCosmosDBNoSqlEmbeddingStore()

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.
String	add(TextSegment textSegment)
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.
void	close()	Closes the CosmosDB client and releases resources.
void	deleteContainer()
EmbeddingSearchResult<TextSegment>	findRelevantWithFullTextRanking(String content, Integer maxResults, double minScore, Filter filter)
EmbeddingSearchResult<TextSegment>	findRelevantWithFullTextSearch(String content, Integer maxResults, double minScore, Filter filter)
EmbeddingSearchResult<TextSegment>	findRelevantWithHybridSearch(Embedding referenceEmbedding, String content, Integer maxResults, double minScore, Filter filter)
protected void	initialize(String endpoint, com.azure.core.credential.AzureKeyCredential keyCredential, com.azure.core.credential.TokenCredential tokenCredential, String databaseName, String containerName, String partitionKeyPath, com.azure.cosmos.models.IndexingPolicy indexingPolicy, com.azure.cosmos.models.CosmosVectorEmbeddingPolicy cosmosVectorEmbeddingPolicy, com.azure.cosmos.models.CosmosFullTextPolicy cosmosFullTextPolicy, Integer vectorStoreThroughput, AzureCosmosDBSearchQueryType searchQueryType, AzureCosmosDBNoSqlFilterMapper filterMapper)
void	remove(String id)	Removes a single embedding from the store by ID.
void	removeAll(Collection<String> ids)	Removes all embeddings that match the specified IDs from the store.
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, generateIds, removeAll, removeAll

Field Details

USER_AGENT

protected static final String USER_AGENT

See Also:

• Constant Field Values

DEFAULT_DATABASE_NAME

protected static final String DEFAULT_DATABASE_NAME

See Also:

• Constant Field Values

DEFAULT_CONTAINER_NAME

protected static final String DEFAULT_CONTAINER_NAME

See Also:

• Constant Field Values

DEFAULT_THROUGHPUT

protected static final Integer DEFAULT_THROUGHPUT

DEFAULT_PARTITION_KEY_PATH

protected static final String DEFAULT_PARTITION_KEY_PATH

See Also:

• Constant Field Values

DEFAULT_SEARCH_QUERY_TYPE

protected static final AzureCosmosDBSearchQueryType DEFAULT_SEARCH_QUERY_TYPE

DEFAULT_MAX_RESULTS

protected static final Integer DEFAULT_MAX_RESULTS

filterMapper

protected AzureCosmosDBNoSqlFilterMapper filterMapper

Constructor Details

AbstractAzureCosmosDBNoSqlEmbeddingStore

public AbstractAzureCosmosDBNoSqlEmbeddingStore()

Method Details

initialize

protected void initialize(String endpoint,
 com.azure.core.credential.AzureKeyCredential keyCredential,
 com.azure.core.credential.TokenCredential tokenCredential,
 String databaseName,
 String containerName,
 String partitionKeyPath,
 com.azure.cosmos.models.IndexingPolicy indexingPolicy,
 com.azure.cosmos.models.CosmosVectorEmbeddingPolicy cosmosVectorEmbeddingPolicy,
 com.azure.cosmos.models.CosmosFullTextPolicy cosmosFullTextPolicy,
 Integer vectorStoreThroughput,
 AzureCosmosDBSearchQueryType searchQueryType,
 AzureCosmosDBNoSqlFilterMapper filterMapper)

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.

add

public String add(TextSegment textSegment)

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.

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.

remove

public void remove(String id)

Description copied from interface: EmbeddingStore

Removes a single embedding from the store by ID.

Specified by:

remove in interface EmbeddingStore<TextSegment>

Parameters:

id - The unique ID of the embedding to be removed.

removeAll

public void removeAll(Collection<String> ids)

Description copied from interface: EmbeddingStore

Removes all embeddings that match the specified IDs from the store.

Specified by:

removeAll in interface EmbeddingStore<TextSegment>

Parameters:

ids - A collection of unique IDs of the embeddings to be removed.

deleteContainer

public void deleteContainer()

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.

findRelevantWithFullTextSearch

public EmbeddingSearchResult<TextSegment> findRelevantWithFullTextSearch(String content,
 Integer maxResults,
 double minScore,
 Filter filter)

findRelevantWithFullTextRanking

public EmbeddingSearchResult<TextSegment> findRelevantWithFullTextRanking(String content,
 Integer maxResults,
 double minScore,
 Filter filter)

findRelevantWithHybridSearch

public EmbeddingSearchResult<TextSegment> findRelevantWithHybridSearch(Embedding referenceEmbedding,
 String content,
 Integer maxResults,
 double minScore,
 Filter filter)

close

public void close()

Closes the CosmosDB client and releases resources. This method should be called when the store is no longer needed to prevent resource leaks.