Package dev.langchain4j.community.store.embedding.duckdb

Class DuckDBEmbeddingStore

java.lang.Object

dev.langchain4j.community.store.embedding.duckdb.DuckDBEmbeddingStore

All Implemented Interfaces:

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

public class DuckDBEmbeddingStore
extends Object
implements dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

Implementation of EmbeddingStore using DuckDB This implementation uses cosine distance and supports storing Metadata

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DuckDBEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
DuckDBEmbeddingStore(String filePath, String tableName)	Initializes a new instance of DuckDBEmbeddingStore with the specified parameters.

Method Summary

Modifier and Type	Method	Description
String	add(dev.langchain4j.data.embedding.Embedding embedding)
String	add(dev.langchain4j.data.embedding.Embedding embedding, dev.langchain4j.data.segment.TextSegment textSegment)
void	add(String id, dev.langchain4j.data.embedding.Embedding embedding)
List<String>	addAll(List<dev.langchain4j.data.embedding.Embedding> embeddings)
List<String>	addAll(List<dev.langchain4j.data.embedding.Embedding> embeddings, List<dev.langchain4j.data.segment.TextSegment> embedded)
void	addAll(List<String> ids, List<dev.langchain4j.data.embedding.Embedding> embeddings, List<dev.langchain4j.data.segment.TextSegment> embedded)
static DuckDBEmbeddingStore.Builder	builder()
protected String	embeddingToParam(dev.langchain4j.data.embedding.Embedding embedding)
static DuckDBEmbeddingStore	inMemory()
void	removeAll()
void	removeAll(dev.langchain4j.store.embedding.filter.Filter filter)
void	removeAll(Collection<String> ids)
dev.langchain4j.store.embedding.EmbeddingSearchResult<dev.langchain4j.data.segment.TextSegment>	search(dev.langchain4j.store.embedding.EmbeddingSearchRequest request)

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

generateIds, remove

Constructor Details

DuckDBEmbeddingStore

public DuckDBEmbeddingStore(String filePath,
 String tableName)

Initializes a new instance of DuckDBEmbeddingStore with the specified parameters.

Parameters:

filePath - File used to persist DuckDB database. If not specified, the database will be stored in-memory.

tableName - The database table name to use. If not specified, "embeddings" will be used

Method Details

inMemory

public static DuckDBEmbeddingStore inMemory()

Returns:

a new instance of DuckDBEmbeddingStore with the default configuration and database stored in-memory

builder

public static DuckDBEmbeddingStore.Builder builder()

add

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

Specified by:

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

add

public void add(String id,
 dev.langchain4j.data.embedding.Embedding embedding)

Specified by:

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

add

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

Specified by:

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

addAll

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

Specified by:

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

addAll

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

Specified by:

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

removeAll

public void removeAll(Collection<String> ids)

Specified by:

removeAll in interface dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

removeAll

public void removeAll(dev.langchain4j.store.embedding.filter.Filter filter)

Specified by:

removeAll in interface dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

removeAll

public void removeAll()

Specified by:

removeAll in interface dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

search

public dev.langchain4j.store.embedding.EmbeddingSearchResult<dev.langchain4j.data.segment.TextSegment> search(dev.langchain4j.store.embedding.EmbeddingSearchRequest request)

Specified by:

search in interface dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

addAll

public void addAll(List<String> ids,
 List<dev.langchain4j.data.embedding.Embedding> embeddings,
 List<dev.langchain4j.data.segment.TextSegment> embedded)

Specified by:

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

embeddingToParam

protected String embeddingToParam(dev.langchain4j.data.embedding.Embedding embedding)