Index

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

S

scorer(String) - Method in class com.redis.vl.query.TextQuery.Builder

Set the scoring algorithm.

search(VectorQuery) - Method in class com.redis.vl.index.SearchIndex

Search the index using a VectorQuery

search(EmbeddingSearchRequest) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore

search(String) - Method in class com.redis.vl.index.SearchIndex

Search the index using a query string

search(String, Map<String, Object>) - Method in class com.redis.vl.index.SearchIndex

Search the index using a query string with parameters

search(String, Map<String, Object>, int) - Method in class com.redis.vl.index.SearchIndex

Search the index using a query string with parameters and limit

search(String, Map<String, Object>, int, int) - Method in class com.redis.vl.index.SearchIndex

Search the index using a query string with parameters, offset, and limit

searchBufferCapacity(Integer) - Method in class com.redis.vl.query.VectorQuery.Builder

Set the search buffer capacity parameter for SVS-VAMANA algorithm.

searchBufferCapacity(Integer) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set the search buffer capacity parameter for SVS-VAMANA algorithm.

SearchIndex - Class in com.redis.vl.index

Manages Redis search index operations.

SearchIndex(RedisConnectionManager, IndexSchema) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with connection manager and schema

SearchIndex(IndexSchema) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with schema only (no connection)

SearchIndex(IndexSchema, boolean) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with schema and validateOnLoad option

SearchIndex(IndexSchema, String) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with schema and Redis URL

SearchIndex(IndexSchema, String, boolean) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with schema, Redis URL, and validateOnLoad option

SearchIndex(IndexSchema, UnifiedJedis) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with schema and UnifiedJedis client (preferred for RediSearch)

SearchIndex(IndexSchema, UnifiedJedis, boolean) - Constructor for class com.redis.vl.index.SearchIndex

Create a SearchIndex with schema, UnifiedJedis client, and validateOnLoad option

searchWindowSize(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder

Set the search window size for SVS-VAMANA algorithm.

searchWindowSize(Integer) - Method in class com.redis.vl.query.VectorQuery.Builder

Set the search window size parameter for SVS-VAMANA algorithm.

searchWindowSize(Integer) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set the search window size parameter for SVS-VAMANA algorithm.

selectKeySentences(List<String>) - Method in class com.redis.vl.extensions.summarization.ExtractiveSelector

Select the most representative sentences using the default count.

selectKeySentences(List<String>, int) - Method in class com.redis.vl.extensions.summarization.ExtractiveSelector

Select the k most representative sentences from the input.

SemanticCache - Class in com.redis.vl.extensions.cache

Semantic cache for LLM responses using vector similarity.

SemanticCache.Builder - Class in com.redis.vl.extensions.cache

Builder for SemanticCache.

SemanticChatMessage - Class in com.redis.vl.extensions.messagehistory

A chat message with vector embedding for semantic search.

SemanticChatMessage() - Constructor for class com.redis.vl.extensions.messagehistory.SemanticChatMessage

SemanticMessageHistory - Class in com.redis.vl.extensions.messagehistory

Semantic Message History for storing and retrieving LLM conversation history with vector embeddings for semantic search.

SemanticMessageHistory(String, BaseVectorizer, UnifiedJedis) - Constructor for class com.redis.vl.extensions.messagehistory.SemanticMessageHistory

Initialize semantic message history with required parameters.

SemanticMessageHistory(String, String, String, BaseVectorizer, double, UnifiedJedis, boolean) - Constructor for class com.redis.vl.extensions.messagehistory.SemanticMessageHistory

Initialize semantic message history with all parameters.

SemanticMessageHistory(String, String, String, BaseVectorizer, UnifiedJedis) - Constructor for class com.redis.vl.extensions.messagehistory.SemanticMessageHistory

Initialize semantic message history with session tag and prefix.

SemanticMessageHistorySchema - Class in com.redis.vl.extensions.messagehistory

Schema for semantic message history index with vector field for semantic search.

SemanticRouter - Class in com.redis.vl.extensions.router

Semantic Router for managing and querying route vectors.

SemanticRouter(String) - Constructor for class com.redis.vl.extensions.router.SemanticRouter

Legacy constructor for backwards compatibility.

SemanticRouter.SemanticRouterBuilder - Class in com.redis.vl.extensions.router

Builder for SemanticRouter.

SemanticRouterBuilder() - Constructor for class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder

SemanticRouterIndexSchema - Class in com.redis.vl.extensions.router

Customized index schema for SemanticRouter.

SentenceSplitter - Class in com.redis.vl.extensions.summarization

OpenNLP-based sentence splitting utility.

SentenceSplitter() - Constructor for class com.redis.vl.extensions.summarization.SentenceSplitter

Create a sentence splitter using the default English model.

SentenceSplitter(SentenceModel) - Constructor for class com.redis.vl.extensions.summarization.SentenceSplitter

Create a sentence splitter with a custom model.

SentenceTransformersVectorizer - Class in com.redis.vl.utils.vectorize

Vectorizer that uses Sentence Transformers models downloaded from HuggingFace.

SentenceTransformersVectorizer(String) - Constructor for class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer

Create a vectorizer with default cache directory.

SentenceTransformersVectorizer(String, String) - Constructor for class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer

Create a vectorizer with custom cache directory.

SentinelConfig - Class in com.redis.vl.redis

Configuration for Redis Sentinel connections.

SentinelConfig() - Constructor for class com.redis.vl.redis.SentinelConfig

SentinelConfig.HostPort - Class in com.redis.vl.redis

Represents a host:port pair for Sentinel nodes

separator(String) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder

Set the separator for multi-value tags

serverUrl(String) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder

Set the LangCache server URL

SESSION_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants

SESSION_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants

Field name for session tag.

sessionTag - Variable in class com.redis.vl.extensions.messagehistory.BaseMessageHistory

set(String, String, float[]) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache

Store an embedding for a text.

set(AbstractPipeline, String, Map<String, Object>) - Method in class com.redis.vl.storage.BaseStorage

Set a key-value pair in Redis using a pipeline.

set(AbstractPipeline, String, Map<String, Object>) - Method in class com.redis.vl.storage.HashStorage

set(AbstractPipeline, String, Map<String, Object>) - Method in class com.redis.vl.storage.JsonStorage

setBatchSize(int) - Method in class com.redis.vl.query.VectorQuery

Set the batch size

setCache(EmbeddingsCache) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer

Set an embeddings cache for this vectorizer.

setCurrentTest(String) - Method in class com.redis.vl.test.vcr.VCRContext

Sets the current test context.

setDimensions(int) - Method in class com.redis.vl.utils.vectorize.LangChain4JVectorizer

Manually set the dimensions (useful if you know them ahead of time).

setDistanceThreshold(double) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory

Set the distance threshold for semantic search.

setDistanceThreshold(double) - Method in class com.redis.vl.query.VectorRangeQuery

Set the distance threshold for range filtering.

setDistanceThreshold(float) - Method in class com.redis.vl.extensions.cache.SemanticCache

Set the distance threshold for similarity matching.

setEffectiveMode(VCRMode) - Method in class com.redis.vl.test.vcr.VCRContext

Sets the effective VCR mode.

setEfRuntime(int) - Method in class com.redis.vl.query.VectorQuery

Set the EF runtime parameter for HNSW

setEpsilon(double) - Method in class com.redis.vl.query.VectorRangeQuery

Set the epsilon value for approximate search.

setFieldWeights(Map<String, Double>) - Method in class com.redis.vl.query.TextQuery

Update the field weights dynamically.

setFilter(Filter) - Method in class com.redis.vl.query.VectorQuery

Set the filter query

setHybridPolicy(String) - Method in class com.redis.vl.query.VectorQuery

Set the hybrid search policy

setKeySeparator(String) - Method in class com.redis.vl.schema.IndexSchema.Index

Set the key separator

setMode(VCRMode) - Method in class com.redis.vl.test.vcr.VCRChatModel

Sets the VCR mode.

setMode(VCRMode) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor

Sets the VCR mode.

setMode(VCRMode) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel

Sets the VCR mode.

setMode(VCRMode) - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel

Sets the VCR mode.

setMode(VCRMode) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel

Sets the VCR mode.

setModelName(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor

Sets the model name for cassette metadata.

setModelName(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel

Sets the model name for cassette metadata.

setModelName(String) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel

Sets the model name for cassette metadata.

setName(String) - Method in class com.redis.vl.schema.IndexSchema.Index

Set the index name

setPrefix(String) - Method in class com.redis.vl.schema.IndexSchema.Index

Set the key prefix (single prefix)

setPrefix(List<String>) - Method in class com.redis.vl.schema.IndexSchema.Index

Set multiple key prefixes.

setSearchBufferCapacity(int) - Method in class com.redis.vl.query.VectorQuery

Set the search buffer capacity parameter for SVS-VAMANA

setSearchBufferCapacity(int) - Method in class com.redis.vl.query.VectorRangeQuery

Set the search buffer capacity for SVS-VAMANA algorithm.

setSearchWindowSize(int) - Method in class com.redis.vl.query.VectorQuery

Set the search window size parameter for SVS-VAMANA

setSearchWindowSize(int) - Method in class com.redis.vl.query.VectorRangeQuery

Set the search window size for SVS-VAMANA algorithm.

setStopwords(List<String>) - Method in class com.redis.vl.schema.IndexSchema.Index

Set the stopwords configuration.

setStorageType(IndexSchema.StorageType) - Method in class com.redis.vl.schema.IndexSchema.Index

Set the storage type

setTestId(String) - Method in class com.redis.vl.test.vcr.VCRChatModel

Sets the test identifier for cassette key generation.

setTestId(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor

Sets the current test identifier.

setTestId(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel

Sets the current test identifier.

setTestId(String) - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel

Sets the test identifier for cassette key generation.

setTestId(String) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel

Sets the current test identifier.

setTtl(Integer) - Method in class com.redis.vl.extensions.cache.BaseCache

Set the default TTL for cache entries.

setUseSearchHistory(String) - Method in class com.redis.vl.query.VectorQuery

Set the use search history parameter for SVS-VAMANA

setUseSearchHistory(String) - Method in class com.redis.vl.query.VectorRangeQuery

Set the use search history mode for SVS-VAMANA algorithm.

setWithTtl(byte[], byte[], Integer) - Method in class com.redis.vl.extensions.cache.BaseCache

Helper method to set a byte array value with optional TTL.

setWithTtl(String, String, Integer) - Method in class com.redis.vl.extensions.cache.BaseCache

Helper method to set a value with optional TTL.

setWithTTL(String, String, float[], int) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache

Store an embedding with a specific TTL.

shutdown() - Method in class com.redis.vl.test.vcr.VCRContext

Shuts down the VCR context and releases resources.

size() - Method in class com.redis.vl.extensions.cache.BaseCache

Get the number of entries in the cache.

skipDecodeFields(String...) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set fields that should not be decoded from binary format (varargs).

skipDecodeFields(String...) - Method in class com.redis.vl.query.TextQuery.Builder

Set fields that should not be decoded from binary format (varargs).

skipDecodeFields(String...) - Method in class com.redis.vl.query.VectorQuery.Builder

Set fields that should not be decoded from binary format (varargs).

skipDecodeFields(String...) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set fields that should not be decoded from binary format (varargs).

skipDecodeFields(List<String>) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set fields that should not be decoded from binary format.

skipDecodeFields(List<String>) - Method in class com.redis.vl.query.TextQuery.Builder

Set fields that should not be decoded from binary format.

skipDecodeFields(List<String>) - Method in class com.redis.vl.query.VectorQuery.Builder

Set fields that should not be decoded from binary format.

skipDecodeFields(List<String>) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set fields that should not be decoded from binary format.

sortable - Variable in class com.redis.vl.schema.BaseField

Whether this field is sortable

sortable() - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder

Make the field sortable.

sortable() - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder

Make this field sortable (equivalent to sortable(true)).

sortable() - Method in class com.redis.vl.schema.TagField.TagFieldBuilder

Set the field as sortable

sortable() - Method in class com.redis.vl.schema.TextField.TextFieldBuilder

Set the field as sortable

sortable(boolean) - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder

Set whether the field is sortable.

sortable(boolean) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder

Set whether this field should be sortable.

sortable(boolean) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder

Set whether the field is sortable

sortable(boolean) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder

Set whether the field is sortable

sortable(boolean) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder

Set whether the field is sortable

sortAscending(boolean) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set whether to sort in ascending or descending order.

sortBy(SortField) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set the field to sort results by using SortField.

sortBy(SortField) - Method in class com.redis.vl.query.TextQuery.Builder

Set the sort field using SortField.

sortBy(SortField) - Method in class com.redis.vl.query.VectorQuery.Builder

Set the sort field using SortField.

sortBy(SortField) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set the sort field using SortField.

sortBy(String) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set the field to sort results by (defaults to ascending).

sortBy(String) - Method in class com.redis.vl.query.TextQuery.Builder

Set the sort field (defaults to ascending).

sortBy(String) - Method in class com.redis.vl.query.VectorQuery.Builder

Set the sort field (defaults to ascending).

sortBy(String) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set the field name to sort results by (defaults to ascending).

sortBy(String, String) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set the field to sort results by with explicit direction.

sortBy(String, String) - Method in class com.redis.vl.query.TextQuery.Builder

Set the sort field with explicit direction.

sortBy(String, String) - Method in class com.redis.vl.query.VectorQuery.Builder

Set the sort field with explicit direction.

sortBy(String, String) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set the sort field with explicit direction.

sortBy(List<SortField>) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder

Set the fields to sort results by (supports multiple fields, but only first is used).

sortBy(List<SortField>) - Method in class com.redis.vl.query.TextQuery.Builder

Set the sort fields (supports multiple fields, but only first is used).

sortBy(List<SortField>) - Method in class com.redis.vl.query.VectorQuery.Builder

Set the sort fields (supports multiple fields, but only first is used).

sortBy(List<SortField>) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set the sort fields (supports multiple fields, but only first is used).

sortDescending(boolean) - Method in class com.redis.vl.query.TextQuery.Builder

Set whether to sort in descending order.

sortDescending(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder

Set whether to sort in descending order

sortDescending(boolean) - Method in class com.redis.vl.query.VectorRangeQuery.Builder

Set whether to sort results in descending order.

SortField - Class in com.redis.vl.query

Represents a sort field with its direction.

SortField() - Constructor for class com.redis.vl.query.SortField

SortSpec - Class in com.redis.vl.query

Utility class for parsing flexible sort specifications into normalized format.

split(String) - Method in class com.redis.vl.extensions.summarization.SentenceSplitter

Split text into sentences.

splitWithSpans(String) - Method in class com.redis.vl.extensions.summarization.SentenceSplitter

Split text into sentences with position spans.

STDDEV - Enum constant in enum class com.redis.vl.query.ReducerFunction

REDUCE STDDEV 1 {property} - Return the standard deviation of a numeric property in the group.

stopwords(List<String>) - Method in class com.redis.vl.schema.IndexSchema.Builder

Set the stopwords configuration.

stopwords(Set<String>) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder

Set custom stopwords for text search.

storageType(IndexSchema.StorageType) - Method in class com.redis.vl.schema.IndexSchema.Builder

Set the storage type

StorageType - Enum Class in com.redis.vl.schema

Storage type for documents in Redis

store(String, byte[], Map<String, String>) - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore

Stores a document with metadata.

store(String, JsonObject) - Method in class com.redis.vl.test.vcr.VCRCassetteStore

Stores a cassette in Redis.

store(String, String) - Method in class com.redis.vl.extensions.cache.SemanticCache

Store a prompt-response pair in the cache.

store(String, String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory

Insert a prompt:response pair into the message history using the default session tag.

store(String, String) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory

Insert a prompt:response pair into the message history using the default session tag.

store(String, String, String) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory

Insert a prompt:response pair into the message history.

store(String, String, String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory

store(String, String, String) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory

store(String, String, Map<String, Object>) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache

Store a prompt-response pair in the cache.

store(String, String, Map<String, Object>) - Method in class com.redis.vl.extensions.cache.SemanticCache

Store a prompt-response pair with metadata.

store(String, String, Map<String, Object>, Integer) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache

Store a prompt-response pair in the cache with a per-entry TTL.

storeBatch(List<PromptResponsePair>) - Method in class com.redis.vl.extensions.cache.SemanticCache

Batch store multiple prompt-response pairs.

storeWithTTL(String, String, Map<String, Object>, int) - Method in class com.redis.vl.extensions.cache.SemanticCache

Store with custom TTL.

SUM - Enum constant in enum class com.redis.vl.extensions.router.DistanceAggregationMethod

Sum aggregation method

SUM - Enum constant in enum class com.redis.vl.query.ReducerFunction

REDUCE SUM 1 {property} - Return the sum of all numeric values of a given property in a group.

SVS_VAMANA - Enum constant in enum class com.redis.vl.schema.VectorField.Algorithm

SVS-VAMANA algorithm with compression support (Redis ≥ 8.2.0)

svsEpsilon(double) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder

Set the epsilon parameter for SVS-VAMANA range queries.

A B C D E F G H I J K L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form