dev.langchain4j.store.embedding.cassandra

Class CassandraEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.cassandra.CassandraEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

public class CassandraEmbeddingStore
extends Object

Implementation of EmbeddingStore using Cassandra AstraDB.

See Also:

EmbeddingStore, MetadataVectorCassandraTable

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CassandraEmbeddingStore.Builder Syntax Sugar Builder.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.dtsx.astra.sdk.cassio.MetadataVectorCassandraTable	embeddingTable Represents an embedding table in Cassandra, it is a table with a vector column.

Constructor Summary

Constructors

Constructor and Description
CassandraEmbeddingStore(CassandraEmbeddingConfiguration config) Build the store from the configuration.

Method Summary

Modifier and Type	Method and Description
String	add(@NonNull dev.langchain4j.data.embedding.Embedding embedding) Add a new embedding to the store.
String	add(@NonNull dev.langchain4j.data.embedding.Embedding embedding, dev.langchain4j.data.segment.TextSegment textSegment) Add a new embedding to the store.
void	add(@NonNull String rowId, @NonNull dev.langchain4j.data.embedding.Embedding embedding) Add a new embedding to the store.
List<String>	addAll(List<dev.langchain4j.data.embedding.Embedding> embeddingList) Add multiple embeddings as a single action.
List<String>	addAll(List<dev.langchain4j.data.embedding.Embedding> embeddingList, List<dev.langchain4j.data.segment.TextSegment> textSegmentList) Add multiple embeddings as a single action.
static CassandraEmbeddingStore.Builder	builder()
List<EmbeddingMatch<dev.langchain4j.data.segment.TextSegment>>	findRelevant(dev.langchain4j.data.embedding.Embedding embedding, int maxResults, double minScore) Search for relevant.
List<EmbeddingMatch<dev.langchain4j.data.segment.TextSegment>>	findRelevant(dev.langchain4j.data.embedding.Embedding embedding, int maxResults, double minScore, Metadata metadata) Similarity Search ANN based on the embedding.

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

findRelevant

Field Detail

embeddingTable

protected com.dtsx.astra.sdk.cassio.MetadataVectorCassandraTable embeddingTable

Represents an embedding table in Cassandra, it is a table with a vector column.

Constructor Detail

CassandraEmbeddingStore

public CassandraEmbeddingStore(CassandraEmbeddingConfiguration config)

Build the store from the configuration.

Parameters:

config - configuration

Method Detail

builder

public static CassandraEmbeddingStore.Builder builder()

add

public String add(@NonNull
                  @NonNull dev.langchain4j.data.embedding.Embedding embedding)

Add a new embedding to the store. - the row id is generated - text and metadata are not stored

Specified by:

add in interface EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Parameters:

embedding - representation of the list of floats

Returns:

newly created row id

add

public String add(@NonNull
                  @NonNull dev.langchain4j.data.embedding.Embedding embedding,
                  dev.langchain4j.data.segment.TextSegment textSegment)

Add a new embedding to the store. - the row id is generated - text and metadata coming from the text Segment

Specified by:

add in interface EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Parameters:

embedding - representation of the list of floats

textSegment - text content and metadata

Returns:

newly created row id

add

public void add(@NonNull
                @NonNull String rowId,
                @NonNull
                @NonNull dev.langchain4j.data.embedding.Embedding embedding)

Add a new embedding to the store.

Specified by:

add in interface EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Parameters:

rowId - the row id

embedding - representation of the list of floats

addAll

public List<String> addAll(List<dev.langchain4j.data.embedding.Embedding> embeddingList)

Add multiple embeddings as a single action.

Specified by:

addAll in interface EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Parameters:

embeddingList - embeddings list

Returns:

list of new row if (same order as the input)

addAll

public List<String> addAll(List<dev.langchain4j.data.embedding.Embedding> embeddingList,
                           List<dev.langchain4j.data.segment.TextSegment> textSegmentList)

Add multiple embeddings as a single action.

Specified by:

addAll in interface EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Parameters:

embeddingList - embeddings

textSegmentList - text segments

Returns:

list of new row if (same order as the input)

findRelevant

public List<EmbeddingMatch<dev.langchain4j.data.segment.TextSegment>> findRelevant(dev.langchain4j.data.embedding.Embedding embedding,
                                                                                   int maxResults,
                                                                                   double minScore)

Search for relevant.

Specified by:

findRelevant in interface EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Parameters:

embedding - current embeddings

maxResults - max number of result

minScore - threshold

Returns:

list of matching elements

findRelevant

public List<EmbeddingMatch<dev.langchain4j.data.segment.TextSegment>> findRelevant(dev.langchain4j.data.embedding.Embedding embedding,
                                                                                   int maxResults,
                                                                                   double minScore,
                                                                                   Metadata metadata)

Similarity Search ANN based on the embedding.

Parameters:

embedding - vector

maxResults - max number of results

minScore - score minScore

metadata - map key-value to build a metadata filter

Returns:

list of matching results