Package dev.langchain4j.store.embedding.redis

Class RedisEmbeddingStore

java.lang.Object
dev.langchain4j.store.embedding.redis.RedisEmbeddingStore
All Implemented Interfaces:
dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>
public class RedisEmbeddingStore extends Object implements dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.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, String prefix, Integer dimension, Collection<String> metadataKeys)
    Creates an instance of RedisEmbeddingStore

  • 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)
     
    static RedisEmbeddingStore.Builder
    builder()
     
    List<dev.langchain4j.store.embedding.EmbeddingMatch<dev.langchain4j.data.segment.TextSegment>>
    findRelevant(dev.langchain4j.data.embedding.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, remove, removeAll, removeAll, removeAll, search

  • Constructor Details

    • RedisEmbeddingStore

      public RedisEmbeddingStore(String host, Integer port, String user, String password, String indexName, String prefix, 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".
      prefix - The prefix of the key, should end with a colon (e.g., "embedding:") (optional). Default value: "embedding:".
      dimension - Embedding vector dimension
      metadataKeys - Metadata keys that should be persisted (optional)

  • Method Details

    • 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>

    • findRelevant

      public List<dev.langchain4j.store.embedding.EmbeddingMatch<dev.langchain4j.data.segment.TextSegment>> findRelevant(dev.langchain4j.data.embedding.Embedding referenceEmbedding, int maxResults, double minScore)
      Specified by:
      findRelevant in interface dev.langchain4j.store.embedding.EmbeddingStore<dev.langchain4j.data.segment.TextSegment>

    • builder

      public static RedisEmbeddingStore.Builder builder()