Package dev.langchain4j.store.embedding.redis

Class RedisEmbeddingStore.Builder

java.lang.Object

dev.langchain4j.store.embedding.redis.RedisEmbeddingStore.Builder

Enclosing class:

RedisEmbeddingStore

public static class RedisEmbeddingStore.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RedisEmbeddingStore	build()
RedisEmbeddingStore.Builder	dimension(Integer dimension)
RedisEmbeddingStore.Builder	host(String host)
RedisEmbeddingStore.Builder	indexName(String indexName)
RedisEmbeddingStore.Builder	metadataFieldsName(Collection<String> metadataFieldsName)	Deprecated. use metadataKeys(Collection) instead
RedisEmbeddingStore.Builder	metadataKeys(Collection<String> metadataKeys)
RedisEmbeddingStore.Builder	password(String password)
RedisEmbeddingStore.Builder	port(Integer port)
RedisEmbeddingStore.Builder	prefix(String prefix)
RedisEmbeddingStore.Builder	user(String user)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

host

public RedisEmbeddingStore.Builder host(String host)

Parameters:

host - Redis Stack host

port

public RedisEmbeddingStore.Builder port(Integer port)

Parameters:

port - Redis Stack port

user

public RedisEmbeddingStore.Builder user(String user)

Parameters:

user - Redis Stack username (optional)

password

public RedisEmbeddingStore.Builder password(String password)

Parameters:

password - Redis Stack password (optional)

indexName

public RedisEmbeddingStore.Builder indexName(String indexName)

Parameters:

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

Returns:

builder

prefix

public RedisEmbeddingStore.Builder prefix(String prefix)

Parameters:

prefix - The prefix of the key, should end with a colon (e.g., "embedding:") (optional). Default value: "embedding:".

Returns:

builder

dimension

public RedisEmbeddingStore.Builder dimension(Integer dimension)

Parameters:

dimension - embedding vector dimension

Returns:

builder

metadataFieldsName

@Deprecated
public RedisEmbeddingStore.Builder metadataFieldsName(Collection<String> metadataFieldsName)

Deprecated.

use metadataKeys(Collection) instead

Parameters:

metadataFieldsName - metadata fields names (optional)

metadataKeys

public RedisEmbeddingStore.Builder metadataKeys(Collection<String> metadataKeys)

Parameters:

metadataKeys - Metadata keys that should be persisted (optional)

build

public RedisEmbeddingStore build()