Package dev.langchain4j.store.embedding.redis

Class RedisEmbeddingStore

java.lang.Object

dev.langchain4j.store.embedding.redis.RedisEmbeddingStore

All Implemented Interfaces:

EmbeddingStore<TextSegment>

public class RedisEmbeddingStore
extends Object
implements EmbeddingStore<TextSegment>

Represents a Redis index as an embedding store. Current implementation assumes the index uses the cosine distance metric.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedisEmbeddingStore.Builder

Constructor Summary

Constructors

Constructor	Description
RedisEmbeddingStore(String host, Integer port, String user, String password, String indexName, Integer dimension, Collection<String> metadataKeys)	Creates an instance of RedisEmbeddingStore

Method Summary

Modifier and Type	Method	Description
String	add(Embedding embedding)
String	add(Embedding embedding, TextSegment textSegment)
void	add(String id, Embedding embedding)
List<String>	addAll(List<Embedding> embeddings)
List<String>	addAll(List<Embedding> embeddings, List<TextSegment> embedded)
static RedisEmbeddingStore.Builder	builder()
List<EmbeddingMatch<TextSegment>>	findRelevant(Embedding referenceEmbedding, int maxResults, double minScore)

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, findRelevant, findRelevant, search

Constructor Details

RedisEmbeddingStore

public RedisEmbeddingStore(String host,
 Integer port,
 String user,
 String password,
 String indexName,
 Integer dimension,
 Collection<String> metadataKeys)

Creates an instance of RedisEmbeddingStore

Parameters:

host - Redis Stack Server host

port - Redis Stack Server port

user - Redis Stack username (optional)

password - Redis Stack password (optional)

indexName - The name of the index (optional). Default value: "embedding-index".

dimension - Embedding vector dimension

metadataKeys - Metadata keys that should be persisted (optional)

Method Details

add

public String add(Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public void add(String id,
 Embedding embedding)

Specified by:

add in interface EmbeddingStore<TextSegment>

add

public String add(Embedding embedding,
 TextSegment textSegment)

Specified by:

add in interface EmbeddingStore<TextSegment>

addAll

public List<String> addAll(List<Embedding> embeddings)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

addAll

public List<String> addAll(List<Embedding> embeddings,
 List<TextSegment> embedded)

Specified by:

addAll in interface EmbeddingStore<TextSegment>

findRelevant

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

Specified by:

findRelevant in interface EmbeddingStore<TextSegment>

builder

public static RedisEmbeddingStore.Builder builder()