Package org.springframework.ai.vectorstore

Class RedisVectorStore.RedisVectorStoreConfig.Builder

java.lang.Object

org.springframework.ai.vectorstore.RedisVectorStore.RedisVectorStoreConfig.Builder

Enclosing class:

RedisVectorStore.RedisVectorStoreConfig

public static class RedisVectorStore.RedisVectorStoreConfig.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
RedisVectorStore.RedisVectorStoreConfig	build()	Returns the immutable configuration.
RedisVectorStore.RedisVectorStoreConfig.Builder	withContentFieldName(String name)	Configures the Redis content field name to use.
RedisVectorStore.RedisVectorStoreConfig.Builder	withEmbeddingFieldName(String name)	Configures the Redis embedding field name to use.
RedisVectorStore.RedisVectorStoreConfig.Builder	withIndexName(String name)	Configures the Redis index name to use.
RedisVectorStore.RedisVectorStoreConfig.Builder	withMetadataFields(List<RedisVectorStore.MetadataField> fields)
RedisVectorStore.RedisVectorStoreConfig.Builder	withMetadataFields(RedisVectorStore.MetadataField... fields)
RedisVectorStore.RedisVectorStoreConfig.Builder	withPrefix(String prefix)	Configures the Redis key prefix to use (default: "embedding:").
RedisVectorStore.RedisVectorStoreConfig.Builder	withURI(String uri)	Configures the Redis URI to use.
RedisVectorStore.RedisVectorStoreConfig.Builder	withVectorAlgorithm(RedisVectorStore.Algorithm algorithm)	Configures the Redis vector algorithmto use.

Methods inherited from class java.lang.Object

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

Method Details

withURI

public RedisVectorStore.RedisVectorStoreConfig.Builder withURI(String uri)

Configures the Redis URI to use.

Parameters:

uri - the Redis URI to use

Returns:

this builder

withIndexName

public RedisVectorStore.RedisVectorStoreConfig.Builder withIndexName(String name)

Configures the Redis index name to use.

Parameters:

name - the index name to use

Returns:

this builder

withPrefix

public RedisVectorStore.RedisVectorStoreConfig.Builder withPrefix(String prefix)

Configures the Redis key prefix to use (default: "embedding:").

Parameters:

prefix - the prefix to use

Returns:

this builder

withContentFieldName

public RedisVectorStore.RedisVectorStoreConfig.Builder withContentFieldName(String name)

Configures the Redis content field name to use.

Parameters:

name - the content field name to use

Returns:

this builder

withEmbeddingFieldName

public RedisVectorStore.RedisVectorStoreConfig.Builder withEmbeddingFieldName(String name)

Configures the Redis embedding field name to use.

Parameters:

name - the embedding field name to use

Returns:

this builder

withVectorAlgorithm

public RedisVectorStore.RedisVectorStoreConfig.Builder withVectorAlgorithm(RedisVectorStore.Algorithm algorithm)

Configures the Redis vector algorithmto use.

Parameters:

algorithm - the vector algorithm to use

Returns:

this builder

withMetadataFields

public RedisVectorStore.RedisVectorStoreConfig.Builder withMetadataFields(RedisVectorStore.MetadataField... fields)

withMetadataFields

public RedisVectorStore.RedisVectorStoreConfig.Builder withMetadataFields(List<RedisVectorStore.MetadataField> fields)

build

public RedisVectorStore.RedisVectorStoreConfig build()

Returns the immutable configuration.

Returns:

the immutable configuration