Class AstraDbEmbeddingStore
java.lang.Object
dev.langchain4j.store.embedding.astradb.AstraDbEmbeddingStore
- All Implemented Interfaces:
EmbeddingStore<TextSegment>
Implementation of
EmbeddingStore
using AstraDB.- See Also:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionAstraDbEmbeddingStore
(@NonNull com.dtsx.astra.sdk.AstraDBCollection client) Initialization of the store with an EXISTING collection.AstraDbEmbeddingStore
(@NonNull com.dtsx.astra.sdk.AstraDBCollection client, int itemsPerChunk, int concurrentThreads) Initialization of the store with an EXISTING collection. -
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.void
Adds a given embedding to the store.Adds multiple embeddings to the store.void
Adds multiple embeddings and their corresponding contents that have been embedded to the store.com.dtsx.astra.sdk.AstraDBCollection
void
clear()
Delete all records from the table.int
findRelevant
(Embedding referenceEmbedding, int maxResults, double minScore) findRelevant
(Embedding referenceEmbedding, io.stargate.sdk.data.domain.query.Filter metaDatafilter, int maxResults, double minScore) Semantic search with metadata filtering.int
search
(EmbeddingSearchRequest request) Searches for the most similar (closest in the embedding space)Embedding
s.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
-
Field Details
-
KEY_ATTRIBUTES_BLOB
Saving the text chunk as an attribut.- See Also:
-
KEY_SIMILARITY
Metadata used for similarity.- See Also:
-
-
Constructor Details
-
AstraDbEmbeddingStore
public AstraDbEmbeddingStore(@NonNull @NonNull com.dtsx.astra.sdk.AstraDBCollection client) Initialization of the store with an EXISTING collection.- Parameters:
client
- astra db collection client
-
AstraDbEmbeddingStore
public AstraDbEmbeddingStore(@NonNull @NonNull com.dtsx.astra.sdk.AstraDBCollection client, int itemsPerChunk, int concurrentThreads) Initialization of the store with an EXISTING collection.- Parameters:
client
- astra db collection clientitemsPerChunk
- size of 1 chunk in between 1 and 20
-
-
Method Details
-
clear
public void clear()Delete all records from the table. -
add
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
embedding
- The embedding to be added to the store.- Returns:
- The auto-generated ID associated with the added embedding.
-
add
Adds a given embedding and the corresponding content that has been embedded to the store.- Specified by:
add
in 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.
-
add
Adds a given embedding to the store.- Specified by:
add
in interfaceEmbeddingStore<TextSegment>
- Parameters:
id
- The unique identifier for the embedding to be added.embedding
- The embedding to be added to the store.
-
addAll
Adds multiple embeddings to the store.- Specified by:
addAll
in 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.
-
addAll
public void addAll(List<String> ids, List<Embedding> embeddingList, List<TextSegment> textSegmentList) Description copied from interface:EmbeddingStore
Adds multiple embeddings and their corresponding contents that have been embedded to the store.- Specified by:
addAll
in interfaceEmbeddingStore<TextSegment>
- Parameters:
ids
- A list of IDs associated with the added embeddings.embeddingList
- A list of embeddings to be added to the store.textSegmentList
- A list of original contents that were embedded.
-
search
Description copied from interface:EmbeddingStore
Searches for the most similar (closest in the embedding space)Embedding
s.
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 allEmbeddingStore
implementations supportFilter
ing.- Specified by:
search
in interfaceEmbeddingStore<TextSegment>
- Parameters:
request
- A request to search in anEmbeddingStore
. Contains all search criteria.- Returns:
- An
EmbeddingSearchResult
containing all foundEmbedding
s.
-
findRelevant
public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding, int maxResults, double minScore) -
findRelevant
public List<EmbeddingMatch<TextSegment>> findRelevant(Embedding referenceEmbedding, io.stargate.sdk.data.domain.query.Filter metaDatafilter, int maxResults, double minScore) Semantic search with metadata filtering.- Parameters:
referenceEmbedding
- vectormetaDatafilter
- fileter for metadatamaxResults
- limitminScore
- threshold- Returns:
- records
-
astraDBCollection
public com.dtsx.astra.sdk.AstraDBCollection astraDBCollection() -
itemsPerChunk
public int itemsPerChunk() -
concurrentThreads
public int concurrentThreads()
-