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)	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.
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.
List<String>	addAll(List<Embedding> embeddings, List<TextSegment> embedded)	Adds multiple embeddings and their corresponding contents that have been embedded to the store.
static RedisEmbeddingStore.Builder	builder()
List<EmbeddingMatch<TextSegment>>	findRelevant(Embedding referenceEmbedding, int maxResults, double minScore)	Finds the most relevant (closest in space) embeddings to the provided reference 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, findRelevant, findRelevant, remove, removeAll, removeAll, removeAll, 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)

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.

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 List<String> addAll(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:

embeddings - A list of embeddings to be added to the store.

embedded - A list of original contents that were embedded.

Returns:

A list of auto-generated IDs associated with the added embeddings.

findRelevant

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

Description copied from interface: EmbeddingStore

Finds the most relevant (closest in space) embeddings to the provided reference embedding.

Specified by:

findRelevant in interface EmbeddingStore<TextSegment>

Parameters:

referenceEmbedding - The embedding used as a reference. Returned embeddings should be relevant (closest) to this one.

maxResults - The maximum number of embeddings to be returned.

minScore - The minimum relevance score, ranging from 0 to 1 (inclusive). Only embeddings with a score of this value or higher will be returned.

Returns:

A list of embedding matches. Each embedding match includes a relevance score (derivative of cosine distance), ranging from 0 (not relevant) to 1 (highly relevant).

builder

public static RedisEmbeddingStore.Builder builder()