Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractVectorizerBuilder(String) - Constructor for class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Protected constructor for subclasses.
- add(Embedding) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- add(Embedding, TextSegment) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- add(String, Embedding) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- add(String, Embedding, TextSegment) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
-
Adds an embedding with a specified ID and text segment.
- addAll(List<Embedding>) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- addAll(List<Embedding>, List<TextSegment>) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- addDocument(String, Map<String, Object>) - Method in class com.redis.vl.index.SearchIndex
-
Add a document to the index
- addField(BaseField) - Method in class com.redis.vl.schema.IndexSchema
-
Add a single field
- addFields(List<Map<String, Object>>) - Method in class com.redis.vl.schema.IndexSchema
-
Add multiple fields from a list of maps
- addMessage(Map<String, String>) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
-
Insert a single prompt or response into the message history using the default session tag.
- addMessage(Map<String, String>) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Insert a single prompt or response into the message history using the default session tag.
- addMessage(Map<String, String>, String) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Insert a single prompt or response into the message history.
- addMessage(Map<String, String>, String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- addMessage(Map<String, String>, String) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- addMessages(List<Map<String, String>>) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
-
Insert a list of prompts and responses into the message history using the default session tag.
- addMessages(List<Map<String, String>>) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Insert a list of prompts and responses into the message history using the default session tag.
- addMessages(List<Map<String, String>>, String) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Insert a list of prompts and responses into the message history.
- addMessages(List<Map<String, String>>, String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- addMessages(List<Map<String, String>>, String) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- addNumericField(String, Consumer<NumericField.NumericFieldBuilder>) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Add a numeric field with customization
- addRouteReferences(String, List<String>) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Add reference(s) to an existing route.
- addTagField(String, Consumer<TagField.TagFieldBuilder>) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Add a tag field with customization
- addTextField(String, Consumer<TextField.TextFieldBuilder>) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Add a text field with customization
- addVectorField(String, int, Consumer<VectorField.VectorFieldBuilder>) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Add a vector field with customization
- after(long) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Create a filter for timestamps after a given epoch time.
- after(Instant) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps after the given instant.
- after(LocalDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps after the given datetime (assumes UTC).
- after(ZonedDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps after the given zoned datetime.
- afterAll(ExtensionContext) - Method in class com.redis.vl.test.vcr.VCRExtension
- afterEach(ExtensionContext) - Method in class com.redis.vl.test.vcr.VCRExtension
- AggregateHybridQuery - Class in com.redis.vl.query
-
AggregateHybridQuery combines text and vector search in Redis using aggregation.
- AggregationQuery - Class in com.redis.vl.query
-
Base class for aggregation queries used to create aggregation queries for Redis.
- AggregationQuery() - Constructor for class com.redis.vl.query.AggregationQuery
-
Protected constructor for subclasses.
- algorithm(VectorField.VectorAlgorithm) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the vector indexing algorithm
- alias - Variable in class com.redis.vl.schema.BaseField
-
Optional alias for the field
- alias(String) - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Set the field alias.
- alias(String) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Set the field alias.
- alias(String) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set the field alias
- alias(String) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the field alias
- alias(String) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the field alias
- alpha(float) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the weight for combining text and vector scores.
- and(Filter...) - Static method in class com.redis.vl.query.Filter
-
Combine filters with AND
- apiKey(String) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set the LangCache API key
- areDimensionsDetected() - Method in class com.redis.vl.utils.vectorize.LangChain4JVectorizer
-
Check if dimensions have been auto-detected.
- ArrayUtils - Class in com.redis.vl.utils
-
Utility class for array conversions.
- asc(String) - Static method in class com.redis.vl.query.SortField
-
Create a SortField with ascending order.
- AVG - Enum constant in enum class com.redis.vl.extensions.router.DistanceAggregationMethod
-
Average aggregation method
- AVG - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE AVG 1 {property} - Return the average value of a numeric property.
- azure(String, String) - Static method in class com.redis.vl.utils.vectorize.VectorizerBuilder
-
Create a builder for Azure OpenAI embeddings.
B
- BaseCache - Class in com.redis.vl.extensions.cache
-
Abstract base class for all cache implementations.
- BaseCache(String, UnifiedJedis) - Constructor for class com.redis.vl.extensions.cache.BaseCache
-
Creates a new BaseCache instance without TTL.
- BaseCache(String, UnifiedJedis, Integer) - Constructor for class com.redis.vl.extensions.cache.BaseCache
-
Creates a new BaseCache instance.
- BaseField - Class in com.redis.vl.schema
-
Base class for all field types in RedisVL.
- BaseField(String) - Constructor for class com.redis.vl.schema.BaseField
-
Create a field with just a name (defaults: indexed=true, sortable=false).
- BaseField(String, String, boolean, boolean) - Constructor for class com.redis.vl.schema.BaseField
-
Create a field with all properties.
- BaseMessageHistory - Class in com.redis.vl.extensions.messagehistory
-
Base class for message history implementations.
- BaseMessageHistory(String, String) - Constructor for class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Initialize message history.
- BaseReranker - Class in com.redis.vl.utils.rerank
-
Abstract base class for document rerankers.
- BaseReranker(String, List<String>, int, boolean) - Constructor for class com.redis.vl.utils.rerank.BaseReranker
-
Create a reranker with the specified configuration.
- BaseStorage - Class in com.redis.vl.storage
-
Base class for internal storage handling in Redis.
- BaseStorage(IndexSchema) - Constructor for class com.redis.vl.storage.BaseStorage
-
Creates a new BaseStorage instance.
- BaseStorage.KeyValuePair - Class in com.redis.vl.storage
-
Helper class for key-value pairs used during preprocessing and validation.
- baseUrl(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.OpenAIVectorizerBuilder
-
Set the base URL for OpenAI API.
- BaseVectorizer - Class in com.redis.vl.utils.vectorize
-
Abstract base class for text vectorizers.
- BaseVectorizer(String, int) - Constructor for class com.redis.vl.utils.vectorize.BaseVectorizer
-
Creates a new BaseVectorizer.
- BaseVectorizer(String, int, String) - Constructor for class com.redis.vl.utils.vectorize.BaseVectorizer
-
Creates a new BaseVectorizer with specified data type.
- BaseVectorizer.BatchCacheResult - Class in com.redis.vl.utils.vectorize
-
Helper class to hold batch cache results.
- BatchCacheResult(List<float[]>, List<String>, List<Integer>) - Constructor for class com.redis.vl.utils.vectorize.BaseVectorizer.BatchCacheResult
-
Creates a new batch cache result.
- batchQuery(List<Filter>) - Method in class com.redis.vl.index.SearchIndex
-
Execute multiple filter queries in batch
- batchQuery(List<Filter>, int) - Method in class com.redis.vl.index.SearchIndex
-
Execute multiple filter queries in batch with specified batch size
- batchSearch(List<String>) - Method in class com.redis.vl.index.SearchIndex
-
Execute multiple search queries in batch
- batchSearch(List<String>, int) - Method in class com.redis.vl.index.SearchIndex
-
Execute multiple search queries in batch with specified batch size
- before(long) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Create a filter for timestamps before a given epoch time.
- before(Instant) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps before the given instant.
- before(LocalDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps before the given datetime (assumes UTC).
- before(ZonedDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps before the given zoned datetime.
- beforeAll(ExtensionContext) - Method in class com.redis.vl.test.vcr.VCRExtension
- beforeEach(ExtensionContext) - Method in class com.redis.vl.test.vcr.VCRExtension
- between(double, double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values between min and max (inclusive).
- between(int, int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values between min and max (inclusive).
- between(long, long) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Create a filter for timestamps between two epoch times.
- between(Instant, Instant) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps between the given instants.
- between(LocalDateTime, LocalDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps between the given datetimes (assumes UTC).
- between(ZonedDateTime, ZonedDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps between the given zoned datetimes.
- BFLOAT16 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType
-
Brain Float 16-bit (specialized for ML)
- blockSize(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the block size for FLAT algorithm
- box(double, double, double, double) - Method in class com.redis.vl.query.Filter.GeoFilterBuilder
-
Create a filter for locations within a bounding box.
- build() - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Build the LangCacheSemanticCache
- build() - Method in class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Build the SemanticCache
- build() - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Build the SemanticRouter.
- build() - Method in class com.redis.vl.extensions.summarization.ExtractiveSelector.Builder
- build() - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore.Builder
-
Builds the chat memory store.
- build() - Method in class com.redis.vl.langchain4j.RedisVLContentRetriever.Builder
-
Builds the retriever.
- build() - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore.Builder
-
Builds the document store.
- build() - Method in class com.redis.vl.query.Filter
-
Build the filter query string
- build() - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Build the FilterQuery instance.
- build() - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Build the HybridQuery instance.
- build() - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Build the MultiVectorQuery instance.
- build() - Method in class com.redis.vl.query.TextQuery.Builder
-
Build the TextQuery instance.
- build() - Method in class com.redis.vl.query.Vector.Builder
-
Build the Vector instance.
- build() - Method in class com.redis.vl.query.VectorQuery.Builder
-
Build the VectorQuery
- build() - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Build the VectorRangeQuery instance.
- build() - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Build the GeoField.
- build() - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Build the IndexSchema
- build() - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Build the NumericField instance.
- build() - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Build the TagField
- build() - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Build the TextField
- build() - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Build the VectorField
- build() - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker.Builder
-
Build the HFCrossEncoderReranker instance.
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Build the vectorizer.
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AzureOpenAIVectorizerBuilder
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.CustomVectorizerBuilder
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.HuggingFaceVectorizerBuilder
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.LocalVectorizerBuilder
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.OllamaVectorizerBuilder
- build() - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.OpenAIVectorizerBuilder
- builder() - Static method in class com.redis.vl.extensions.router.SemanticRouter
-
Create a new builder for SemanticRouter.
- builder() - Static method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore
-
Creates a builder for RedisVLChatMemoryStore.
- builder() - Static method in class com.redis.vl.langchain4j.RedisVLContentRetriever
-
Creates a builder for RedisVLContentRetriever.
- builder() - Static method in class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Creates a builder for RedisVLDocumentStore.
- builder() - Static method in class com.redis.vl.query.AggregateHybridQuery
-
Create a new builder for AggregateHybridQuery (delegates to HybridQuery.builder()).
- builder() - Static method in class com.redis.vl.query.FilterQuery
-
Create a new builder.
- builder() - Static method in class com.redis.vl.query.HybridQuery
-
Create a new builder for HybridQuery.
- builder() - Static method in class com.redis.vl.query.MultiVectorQuery
-
Create a new Builder for MultiVectorQuery.
- builder() - Static method in class com.redis.vl.query.TextQuery
-
Create a new Builder for TextQuery.
- builder() - Static method in class com.redis.vl.query.Vector
-
Create a new Builder for Vector.
- builder() - Static method in class com.redis.vl.query.VectorQuery
-
Create a builder
- builder() - Static method in class com.redis.vl.query.VectorRangeQuery
-
Create a new Builder for VectorRangeQuery.
- builder() - Static method in class com.redis.vl.schema.GeoField
-
Create a GeoField builder (Lombok-style).
- builder() - Static method in class com.redis.vl.schema.IndexSchema
-
Create a builder
- builder() - Static method in class com.redis.vl.schema.NumericField
-
Create a NumericField builder (Lombok-style).
- builder() - Static method in class com.redis.vl.schema.TagField
-
Create a TagField builder (Lombok-style)
- builder() - Static method in class com.redis.vl.schema.TextField
-
Create a TextField builder (Lombok-style)
- builder() - Static method in class com.redis.vl.schema.VectorField
-
Create a VectorField builder (Lombok-style)
- builder() - Static method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker
-
Create a new builder for HFCrossEncoderReranker.
- builder(SentenceTransformersVectorizer) - Static method in class com.redis.vl.extensions.summarization.ExtractiveSelector
-
Builder for ExtractiveSelector.
- Builder() - Constructor for class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Create a new Builder instance
- Builder() - Constructor for class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Create a new Builder instance
- Builder() - Constructor for class com.redis.vl.langchain4j.RedisVLChatMemoryStore.Builder
- Builder() - Constructor for class com.redis.vl.langchain4j.RedisVLContentRetriever.Builder
- Builder() - Constructor for class com.redis.vl.langchain4j.RedisVLDocumentStore.Builder
- Builder() - Constructor for class com.redis.vl.query.TextQuery.Builder
- Builder() - Constructor for class com.redis.vl.query.VectorQuery.Builder
-
Create a new Builder instance
- Builder() - Constructor for class com.redis.vl.utils.rerank.HFCrossEncoderReranker.Builder
-
Creates a new builder with default settings.
- Builder(SentenceTransformersVectorizer) - Constructor for class com.redis.vl.extensions.summarization.ExtractiveSelector.Builder
- buildQueryString() - Method in class com.redis.vl.query.AggregationQuery
-
Build the base query string for the aggregation.
- buildQueryString() - Method in class com.redis.vl.query.HybridQuery
-
Build the full query string for text search with optional filtering.
- buildQueryString() - Method in class com.redis.vl.query.MultiVectorQuery
-
Build the Redis query string for multi-vector search.
- buildRedisAggregation() - Method in class com.redis.vl.query.AggregationQuery
-
Build the Redis AggregationBuilder for this query.
- buildRedisAggregation() - Method in class com.redis.vl.query.HybridQuery
-
Build the Redis AggregationBuilder for this hybrid query.
- buildRedisAggregation() - Method in class com.redis.vl.query.MultiVectorQuery
-
Build the Redis AggregationBuilder for multi-vector search.
- buildRedisQuery() - Method in class com.redis.vl.query.FilterQuery
-
Build Redis Query object from FilterQuery.
- bytesToFloatArray(byte[]) - Static method in class com.redis.vl.utils.ArrayUtils
-
Convert byte array to float array using little-endian byte order.
C
- cache - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Optional cache for storing embeddings.
- cache - Variable in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Optional embeddings cache.
- CACHE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- CACHE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for prompt vector in cache.
- cacheDir(String) - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker.Builder
-
Set the cache directory for model storage.
- CacheHit - Class in com.redis.vl.extensions.cache
-
Represents a cache hit from SemanticCache.
- CacheHit(String, String, float, Map<String, Object>) - Constructor for class com.redis.vl.extensions.cache.CacheHit
-
Creates a new CacheHit.
- cacheId(String) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set the LangCache cache ID
- cacheMisses - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer.BatchCacheResult
-
The texts that were not found in cache.
- cacheMissIndices - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer.BatchCacheResult
-
The indices of cache misses in the results list.
- call(String) - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
- call(Message...) - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
- call(Prompt) - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
- call(EmbeddingRequest) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
- callRealBatchEmbedding(List<String>) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Called to perform actual batch embedding call.
- callRealEmbedding(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Called to perform the actual embedding call.
- caseSensitive() - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set tag matching as case-sensitive
- caseSensitive(boolean) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set whether tag matching is case-sensitive
- ChatMessage - Class in com.redis.vl.extensions.messagehistory
-
A single chat message exchanged between a user and an LLM.
- ChatMessage() - Constructor for class com.redis.vl.extensions.messagehistory.ChatMessage
- check(String) - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Check for a semantically similar prompt in the cache.
- check(String, Filter) - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Check for a semantically similar prompt with filtering.
- check(String, Map<String, Object>, int, List<String>, Object, Float) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Check the cache for semantically similar prompts.
- checkBatch(List<String>) - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Batch check multiple prompts.
- checkTopK(String, int) - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Get top-k similar results.
- clear() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Clear all entries in the cache.
- clear() - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Clear the cache of all entries.
- clear() - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Clears the chat message history.
- clear() - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- clear() - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- clear() - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Clear all route data from Redis.
- clear() - Method in class com.redis.vl.index.SearchIndex
-
Clear all documents from the index without dropping the index itself
- clear(Filter) - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Clear cache with optional filter.
- close() - Method in class com.redis.vl.redis.RedisConnectionManager
-
Close the connection manager and release resources
- close() - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker
-
Close the reranker and clean up resources.
- close() - Method in class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
-
Close the vectorizer and clean up resources
- CohereReranker - Class in com.redis.vl.utils.rerank
-
Reranker that uses Cohere's Rerank API to rerank documents based on query relevance.
- com.redis.vl.exceptions - package com.redis.vl.exceptions
- com.redis.vl.extensions - package com.redis.vl.extensions
- com.redis.vl.extensions.cache - package com.redis.vl.extensions.cache
- com.redis.vl.extensions.messagehistory - package com.redis.vl.extensions.messagehistory
- com.redis.vl.extensions.router - package com.redis.vl.extensions.router
- com.redis.vl.extensions.summarization - package com.redis.vl.extensions.summarization
- com.redis.vl.index - package com.redis.vl.index
- com.redis.vl.langchain4j - package com.redis.vl.langchain4j
- com.redis.vl.query - package com.redis.vl.query
- com.redis.vl.redis - package com.redis.vl.redis
- com.redis.vl.schema - package com.redis.vl.schema
- com.redis.vl.storage - package com.redis.vl.storage
- com.redis.vl.test.vcr - package com.redis.vl.test.vcr
- com.redis.vl.utils - package com.redis.vl.utils
- com.redis.vl.utils.rerank - package com.redis.vl.utils.rerank
- com.redis.vl.utils.vectorize - package com.redis.vl.utils.vectorize
- compression(VectorField.CompressionType) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the compression type for SVS-VAMANA algorithm.
- conditional(String, String) - Static method in class com.redis.vl.query.Filter
-
Create a conditional text filter (value1|value2|...)
- Constants - Class in com.redis.vl.extensions
-
Constants used across RedisVL extensions.
- constructionWindowSize(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the construction window size for SVS-VAMANA algorithm.
- content() - Method in record class com.redis.vl.langchain4j.RedisVLDocumentStore.Document
-
Returns the value of the
contentrecord component. - CONTENT_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- CONTENT_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for message content.
- convertBytes(Map<String, Object>) - Method in class com.redis.vl.storage.BaseStorage
-
Convert byte arrays in the map to appropriate types.
- convertBytes(Map<String, Object>) - Method in class com.redis.vl.storage.HashStorage
- convertBytes(Map<String, Object>) - Method in class com.redis.vl.storage.JsonStorage
- COSINE - Enum constant in enum class com.redis.vl.schema.VectorField.DistanceMetric
-
Cosine distance
- cosineSimilarity(EmbeddedSentence) - Method in class com.redis.vl.extensions.summarization.EmbeddedSentence
-
Calculate cosine similarity with another embedded sentence.
- count(CountQuery) - Method in class com.redis.vl.index.SearchIndex
-
Count documents matching a query
- COUNT - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE COUNT 0 - Count the number of records in each group
- COUNT_DISTINCT - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE COUNT_DISTINCT 1 {property} - Count the number of distinct values for property.
- COUNT_DISTINCTISH - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE COUNT_DISTINCTISH 1 {property} - Same as COUNT_DISTINCT but provides an approximation instead of an exact count
- CountQuery - Class in com.redis.vl.query
-
Query to count documents matching a filter
- CountQuery(Filter) - Constructor for class com.redis.vl.query.CountQuery
-
Create a count query with a Filter object.
- CountQuery(String) - Constructor for class com.redis.vl.query.CountQuery
-
Create a count query with a filter string.
- create() - Method in class com.redis.vl.index.SearchIndex
-
Create the index in Redis using FT.CREATE
- create(boolean) - Method in class com.redis.vl.index.SearchIndex
-
Create the index with overwrite option
- create(boolean, boolean) - Method in class com.redis.vl.index.SearchIndex
-
Create the index with overwrite and drop options
- createBatchEmbeddingCassette(float[][], String, String) - Static method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Creates a cassette JSON object for batch embeddings.
- createEmbeddingCassette(float[], String, String) - Static method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Creates a cassette JSON object for an embedding.
- createKey(String, String, String) - Static method in class com.redis.vl.storage.BaseStorage
-
Create a Redis key using a combination of a prefix, separator, and the identifier.
- createKeyForObject(Map<String, Object>, String) - Method in class com.redis.vl.storage.BaseStorage
-
Construct a Redis key for a given object, optionally using a specified field from the object as the key.
- CrossEncoderLoader - Class in com.redis.vl.utils.rerank
-
Loads and runs ONNX cross-encoder models for document reranking.
- CrossEncoderLoader() - Constructor for class com.redis.vl.utils.rerank.CrossEncoderLoader
-
Creates a new CrossEncoderLoader.
- currentTimestamp() - Static method in class com.redis.vl.utils.Utils
-
Get current timestamp with microsecond precision.
- custom(String) - Static method in class com.redis.vl.query.Filter
-
Create a custom filter expression
- custom(String, Object) - Static method in class com.redis.vl.utils.vectorize.VectorizerBuilder
-
Create a builder for a custom LangChain4J EmbeddingModel.
D
- dataDir() - Element in annotation interface com.redis.vl.test.vcr.VCRTest
-
The directory where VCR cassettes (recorded responses) are stored.
- dataType(VectorField.VectorDataType) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the data type
- DEFAULT_DISTANCE_THRESHOLD - Static variable in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Default distance threshold for semantic search.
- DEFAULT_NUM_RESULTS - Static variable in class com.redis.vl.index.SearchIndex
-
Default number of results to return when limit is not specified.
- defaultBatchSize - Variable in class com.redis.vl.storage.BaseStorage
-
Default batch size for bulk operations.
- defaultNumSentences(int) - Method in class com.redis.vl.extensions.summarization.ExtractiveSelector.Builder
- delete() - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Delete the entire cache.
- delete() - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Clear all conversation history and remove any search indices.
- delete() - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- delete() - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- delete() - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Delete the semantic router index from Redis.
- delete(boolean) - Method in class com.redis.vl.index.SearchIndex
-
Delete the index
- delete(String) - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Deletes a document by ID.
- delete(String) - Method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Deletes a cassette.
- deleteByAttributes(Map<String, Object>) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Delete cache entries matching the given attributes.
- deleteById(String) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Delete a single cache entry by ID.
- deleteCassettes(List<String>) - Method in class com.redis.vl.test.vcr.VCRContext
-
Deletes the specified cassettes.
- deleteDocument(String) - Method in class com.redis.vl.index.SearchIndex
-
Delete a document from the index
- deleteMessages(Object) - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore
- deleteRouteReferences(String, List<String>, List<String>) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Delete references from an existing route.
- denormCosineDistance(float) - Static method in class com.redis.vl.utils.Utils
-
Denormalize a similarity score (0-1) to a Redis COSINE distance (0-2).
- deploymentName(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AzureOpenAIVectorizerBuilder
-
Set the Azure deployment name.
- desc(String) - Static method in class com.redis.vl.query.SortField
-
Create a SortField with descending order.
- determineEffectiveMode(String, VCRMode) - Method in class com.redis.vl.test.vcr.VCRRegistry
-
Determines the effective VCR mode for a test based on registry status.
- dialect(int) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Set the query dialect.
- dialect(int) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the query dialect version.
- dialect(int) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the query dialect.
- dimension() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
- dimensions - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer
-
The dimension of the embedding vectors.
- dimensions - Variable in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Optional embedding dimensions override.
- dimensions() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
- dimensions(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the number of dimensions
- DIMENSIONS_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- DIMENSIONS_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for embedding dimensions.
- disconnect() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Disconnect from Redis.
- DistanceAggregationMethod - Enum Class in com.redis.vl.extensions.router
-
Enumeration for distance aggregation methods.
- distanceMetric(VectorField.DistanceMetric) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the distance metric
- distanceMetric(VectorField.DistanceMetric) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the distance metric
- distanceScale(String) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set the distance scale for distance thresholds
- distanceThreshold(double) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the distance threshold for range filtering.
- distanceThreshold(float) - Method in class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Set the distance threshold for semantic similarity
- Document(byte[], Map<String, String>) - Constructor for record class com.redis.vl.langchain4j.RedisVLDocumentStore.Document
-
Creates an instance of a
Documentrecord class. - doubleArrayToFloats(double[]) - Static method in class com.redis.vl.utils.ArrayUtils
-
Convert double array to float array.
- downloadModel(String) - Method in class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Download a model from HuggingFace with default revision.
- downloadModel(String, String) - Method in class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Download a model from HuggingFace with specified revision.
- drop() - Method in class com.redis.vl.index.SearchIndex
-
Drop the index using FT.DROPINDEX
- drop(String) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Remove a specific exchange from the conversation history.
- drop(String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- drop(String) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- drop(String, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Delete an embedding for a text.
- dropKeys(String) - Method in class com.redis.vl.index.SearchIndex
-
Drop a single key
- dropKeys(List<String>) - Method in class com.redis.vl.index.SearchIndex
-
Drop multiple keys
- dropWithData() - Method in class com.redis.vl.index.SearchIndex
-
Drop the index and delete all documents using FT.DROPINDEX DD
- dtype - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer
-
The data type for embeddings (e.g., "float32").
- dtype - Variable in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Data type for embeddings (default: float32).
- dtype(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the data type for vector storage.
- dtype(String) - Method in class com.redis.vl.query.Vector.Builder
-
Set the vector data type.
E
- efRuntime(Integer) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the EF runtime parameter for HNSW
- embed(TextSegment) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
- embed(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Generates a single embedding, intercepting based on VCR mode.
- embed(String) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
- embed(String) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
- embed(String) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Embed a single text string.
- embed(String, Function<String, String>, boolean, boolean) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Embed a single text string with full options.
- embed(List<String>) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
- embed(Document) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
- embedAll(List<TextSegment>) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
- embedBatch(List<String>) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Generates batch embeddings, intercepting based on VCR mode.
- embedBatch(List<String>) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Embed multiple text strings in batch.
- embedBatch(List<String>, Function<String, String>, int, boolean, boolean) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Embed multiple text strings with full options.
- embedBatchAsLists(List<String>) - Method in class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
-
Generate embeddings for a batch of texts with default batch size.
- EmbeddedSentence - Class in com.redis.vl.extensions.summarization
-
A sentence with its embedding, implementing Clusterable for k-means.
- EmbeddedSentence(int, float[]) - Constructor for class com.redis.vl.extensions.summarization.EmbeddedSentence
-
Create an embedded sentence.
- EMBEDDING_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- EMBEDDING_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for embedding vector.
- embeddingModel(EmbeddingModel) - Method in class com.redis.vl.langchain4j.RedisVLContentRetriever.Builder
-
Sets the embedding model.
- EmbeddingsCache - Class in com.redis.vl.extensions.cache
-
Cache for storing and retrieving text embeddings.
- EmbeddingsCache(String, UnifiedJedis) - Constructor for class com.redis.vl.extensions.cache.EmbeddingsCache
-
Creates a new EmbeddingsCache instance without TTL.
- EmbeddingsCache(String, UnifiedJedis, Integer) - Constructor for class com.redis.vl.extensions.cache.EmbeddingsCache
-
Creates a new EmbeddingsCache instance.
- embeddingStore(RedisVLEmbeddingStore) - Method in class com.redis.vl.langchain4j.RedisVLContentRetriever.Builder
-
Sets the embedding store.
- embedForResponse(List<String>) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
- embedSentences(List<String>) - Method in class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
-
Embed multiple sentences for clustering/selection.
- ENTRY_ID_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- ENTRY_ID_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for cache entry ID.
- epsilon(double) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the epsilon value for approximate HNSW search.
- epsilon(double) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the epsilon parameter for HNSW algorithm
- eq(double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values equal to the specified value.
- eq(int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values equal to the specified value.
- eq(long) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Create a filter for timestamps equal to a given epoch time.
- eq(Instant) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps equal to the given instant.
- eq(LocalDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps equal to the given datetime (assumes UTC).
- eq(ZonedDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps equal to the given zoned datetime.
- equals(Object) - Method in record class com.redis.vl.langchain4j.RedisVLDocumentStore.Document
-
Indicates whether some other object is "equal to" this one.
- equals(Object) - Method in class com.redis.vl.query.Vector
- equals(Object) - Method in class com.redis.vl.schema.BaseField
- equals(Object) - Method in class com.redis.vl.schema.IndexSchema
- equals(Object) - Method in class com.redis.vl.schema.IndexSchema.Index
- escape(String) - Method in class com.redis.vl.utils.TokenEscaper
-
Escape special characters in the input string.
- exact(String, String) - Static method in class com.redis.vl.query.Filter
-
Create an exact match filter
- Example Usage: - Search tag in class com.redis.vl.extensions.summarization.ExtractiveSelector
- Section
- execute(Function<UnifiedJedis, T>) - Method in class com.redis.vl.redis.RedisConnectionManager
-
Execute a command with the Redis client.
- executeVoid(Consumer<UnifiedJedis>) - Method in class com.redis.vl.redis.RedisConnectionManager
-
Execute a command without a return value.
- exists() - Method in class com.redis.vl.index.SearchIndex
-
Check if index exists using FT.INFO
- exists(String) - Method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Checks if a cassette exists.
- exists(String, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Check if an embedding exists for a text.
- expire(String, Integer) - Method in class com.redis.vl.extensions.cache.BaseCache
-
Set expiration on a key.
- expireKeys(String, int) - Method in class com.redis.vl.index.SearchIndex
-
Set expiration time for a key
- expireKeys(List<String>, int) - Method in class com.redis.vl.index.SearchIndex
-
Set expiration time for multiple keys
- ExtensionConstants - Class in com.redis.vl.extensions
-
Constants used within the extension classes.
- extractBatchEmbeddings(JsonObject) - Static method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Extracts batch embeddings from a cassette JSON object.
- extractEmbedding(JsonObject) - Static method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Extracts embedding from a cassette JSON object.
- ExtractiveSelector - Class in com.redis.vl.extensions.summarization
-
BERT-based extractive summarization using sentence clustering.
- ExtractiveSelector(SentenceTransformersVectorizer) - Constructor for class com.redis.vl.extensions.summarization.ExtractiveSelector
-
Create an extractive selector with default settings.
- ExtractiveSelector(SentenceTransformersVectorizer, int) - Constructor for class com.redis.vl.extensions.summarization.ExtractiveSelector
-
Create an extractive selector with custom number of sentences.
- ExtractiveSelector(SentenceTransformersVectorizer, int, int) - Constructor for class com.redis.vl.extensions.summarization.ExtractiveSelector
-
Create an extractive selector with full configuration.
- ExtractiveSelector.Builder - Class in com.redis.vl.extensions.summarization
F
- FAILED - Enum constant in enum class com.redis.vl.test.vcr.VCRRegistry.RecordingStatus
-
Test recording failed
- fetch(String) - Method in class com.redis.vl.index.SearchIndex
-
Fetch a document by ID or key
- field(BaseField) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Add a field to the schema
- field(String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the vector field name
- field(String) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the vector field name to search.
- fieldName(String) - Method in class com.redis.vl.query.Vector.Builder
-
Set the vector field name to search.
- FieldType - Enum Class in com.redis.vl.schema
-
Enumeration of field types supported by RedisVL.
- Filter - Class in com.redis.vl.query
-
Represents a filter for Redis search
- Filter.GeoFilterBuilder - Class in com.redis.vl.query
-
Builder for geo filters
- Filter.GeoUnit - Enum Class in com.redis.vl.query
-
Geographic units for radius queries
- Filter.NumericFilterBuilder - Class in com.redis.vl.query
-
Builder for numeric filters
- Filter.TimestampFilterBuilder - Class in com.redis.vl.query
-
Builder for timestamp filters
- filterExpression(Filter) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Set the filter expression.
- filterExpression(Filter) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set an additional filter expression for the query using a Filter object.
- filterExpression(Filter) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the filter expression.
- filterExpression(Filter) - Method in class com.redis.vl.query.TextQuery.Builder
-
Set the filter expression.
- filterExpression(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set an additional filter expression for the query using a raw Redis query string.
- FilterQuery - Class in com.redis.vl.query
-
A query for running a filtered search with a filter expression (no vector search).
- FilterQuery.FilterQueryBuilder - Class in com.redis.vl.query
-
Builder for FilterQuery with defensive copying.
- finalize() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Empty finalizer to prevent finalizer attacks on subclasses.
- finalize() - Method in class com.redis.vl.schema.BaseField
-
Empty finalizer to prevent finalizer attacks on subclasses.
- findRelevant(Embedding, int) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- findRelevant(Embedding, int, double) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- FIRST_VALUE - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE FIRST_VALUE {nargs} {property} [BY {property} [ASC|DESC]] - Return the first or top value of a given property in the group, optionally by comparing that or another property
- FLAT - Enum constant in enum class com.redis.vl.schema.VectorField.Algorithm
-
FLAT algorithm for exact vector search
- FLOAT16 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType
-
IEEE 754 half-precision 16-bit float
- FLOAT32 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType
-
IEEE 754 single-precision 32-bit float
- FLOAT64 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType
-
IEEE 754 double-precision 64-bit float
- floatArrayToBytes(float[]) - Static method in class com.redis.vl.utils.ArrayUtils
-
Convert float array to byte array using little-endian byte order.
- flush() - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Flush the entire cache.
- formatContext(List<Map<String, Object>>, boolean) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Formats messages from Redis into either text strings or structured maps.
- formatContext(List<Map<String, Object>>, boolean) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Format messages with metadata deserialization support.
- formatKey(String, String, int) - Static method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Formats a cassette key.
- from(RedisConnectionConfig) - Static method in class com.redis.vl.redis.RedisConnectionManager
-
Create a connection manager from configuration.
- from(String) - Static method in class com.redis.vl.redis.RedisConnectionManager
-
Create a connection manager from a URI.
- from(String, int) - Static method in class com.redis.vl.redis.RedisConnectionManager
-
Create a connection manager from host and port.
- fromDict(Map<String, Object>) - Static method in class com.redis.vl.extensions.messagehistory.ChatMessage
-
Creates a ChatMessage from a Map (typically from Redis).
- fromDict(Map<String, Object>) - Static method in class com.redis.vl.extensions.messagehistory.SemanticChatMessage
-
Creates a SemanticChatMessage from a Map (typically from Redis).
- fromDict(Map<String, Object>) - Static method in class com.redis.vl.extensions.router.Route
-
Create route from map representation.
- fromDict(Map<String, Object>) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from a dictionary/map
- fromDict(Map<String, Object>) - Static method in class com.redis.vl.schema.IndexSchema
-
Create IndexSchema from dictionary (Map)
- fromDict(Map<String, Object>, String) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from a dictionary/map with a Redis URL
- fromDict(Map<String, Object>, String, boolean) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from a dictionary/map with a Redis URL and validateOnLoad option
- fromDict(Map<String, Object>, UnifiedJedis) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from a dictionary/map with a UnifiedJedis client
- fromDict(Map<String, Object>, UnifiedJedis, boolean) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from a dictionary/map with a UnifiedJedis client and validateOnLoad option
- fromExisting(String, UnifiedJedis) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from an existing index in Redis
- fromHostPort(String, int) - Static method in class com.redis.vl.redis.RedisConnectionConfig
-
Create a default configuration with host and port.
- fromJson(String) - Static method in class com.redis.vl.extensions.router.Route
-
Create route from JSON string.
- fromJson(String) - Static method in class com.redis.vl.schema.IndexSchema
-
Create IndexSchema from JSON string
- fromParams(String, int, String) - Static method in class com.redis.vl.extensions.router.SemanticRouterIndexSchema
-
Create an index schema based on router name and vector dimensions.
- fromParams(String, String) - Static method in class com.redis.vl.extensions.messagehistory.MessageHistorySchema
-
Creates an IndexSchema for message history with the standard fields.
- fromParams(String, String, int, String) - Static method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistorySchema
-
Creates an IndexSchema for semantic message history with standard fields plus vector field.
- fromRedisType(String) - Static method in enum class com.redis.vl.schema.FieldType
-
Get the FieldType from its Redis type name.
- fromUri(String) - Static method in class com.redis.vl.redis.RedisConnectionConfig
-
Create a default configuration with URI.
- fromUrl(String) - Static method in class com.redis.vl.redis.SentinelConfig
-
Parse a Sentinel URL into a SentinelConfig.
- fromValue(String) - Static method in enum class com.redis.vl.extensions.router.DistanceAggregationMethod
-
Get the DistanceAggregationMethod from a string value.
- fromValue(String) - Static method in enum class com.redis.vl.schema.IndexSchema.StorageType
-
Get StorageType from string value
- fromValue(String) - Static method in enum class com.redis.vl.schema.StorageType
-
Get StorageType from string value.
- fromYaml(String) - Static method in class com.redis.vl.index.SearchIndex
-
Create a SearchIndex from a YAML file
- fromYaml(String) - Static method in class com.redis.vl.schema.IndexSchema
-
Create IndexSchema from YAML string
- fromYamlFile(String) - Static method in class com.redis.vl.schema.IndexSchema
-
Create IndexSchema from YAML file
- FT - Enum constant in enum class com.redis.vl.query.Filter.GeoUnit
-
Feet
- fuzzy(String, String) - Static method in class com.redis.vl.query.Filter
-
Create a fuzzy match filter
G
- generate(String) - Method in class com.redis.vl.test.vcr.VCRChatModel
- generate(List<ChatMessage>) - Method in class com.redis.vl.test.vcr.VCRChatModel
- generateCassetteKey(String) - Method in class com.redis.vl.test.vcr.VCRContext
-
Generates a unique cassette key for the current test and call type.
- generateEmbedding(String) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Generate embedding for a single text (to be implemented by subclasses).
- generateEmbedding(String) - Method in class com.redis.vl.utils.vectorize.LangChain4JVectorizer
- generateEmbedding(String) - Method in class com.redis.vl.utils.vectorize.MockVectorizer
- generateEmbedding(String) - Method in class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
- generateEmbeddingsBatch(List<String>, int) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Generate embeddings for multiple texts in batch (to be implemented by subclasses).
- generateEmbeddingsBatch(List<String>, int) - Method in class com.redis.vl.utils.vectorize.LangChain4JVectorizer
- generateEmbeddingsBatch(List<String>, int) - Method in class com.redis.vl.utils.vectorize.MockVectorizer
- generateEmbeddingsBatch(List<String>, int) - Method in class com.redis.vl.utils.vectorize.SentenceTransformersVectorizer
- geo(String) - Static method in class com.redis.vl.query.Filter
-
Create a geo filter builder
- GEO - Enum constant in enum class com.redis.vl.schema.FieldType
-
Geo field for geographic queries
- GeoField - Class in com.redis.vl.schema
-
GeoField represents a geographic field in Redis.
- GeoField(String) - Constructor for class com.redis.vl.schema.GeoField
-
Create a GeoField with just a name.
- GeoField.GeoFieldBuilder - Class in com.redis.vl.schema
-
Fluent builder for GeoField
- get(String) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Get a route by its name.
- get(String, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Retrieve an embedding for a text.
- get(UnifiedJedis, Collection<String>) - Method in class com.redis.vl.storage.BaseStorage
-
Retrieve objects from Redis by keys with default batch size.
- get(UnifiedJedis, Collection<String>, Integer) - Method in class com.redis.vl.storage.BaseStorage
-
Retrieve objects from Redis by keys.
- get(UnifiedJedis, Collection<String>, Integer) - Method in class com.redis.vl.storage.HashStorage
- getAlgorithm() - Method in class com.redis.vl.schema.VectorField
-
Get the algorithm as our enum type
- getAllRecordedTests() - Method in class com.redis.vl.test.vcr.VCRRegistry
-
Gets all recorded test IDs.
- getAlpha() - Method in class com.redis.vl.query.HybridQuery
-
Get the alpha weighting factor.
- getApiCalls() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the API call count.
- getBatchSize() - Method in class com.redis.vl.query.VectorQuery
-
Get the batch size
- getCache() - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Get the embeddings cache if present.
- getCacheHits() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Gets the number of cache hits.
- getCacheHits() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the cache hit count.
- getCacheHits() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Gets the cache hit count.
- getCacheHits() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Gets the cache hit count.
- getCacheHits() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Gets the number of cache hits.
- getCacheHits() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Gets the cache hit count.
- getCacheMisses() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Gets the number of cache misses.
- getCacheMisses() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the cache miss count.
- getCacheMisses() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Gets the cache miss count.
- getCacheMisses() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Gets the cache miss count.
- getCacheMisses() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Gets the number of cache misses.
- getCacheMisses() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Gets the cache miss count.
- getCassetteKey() - Method in exception class com.redis.vl.test.vcr.VCRCassetteMissingException
-
Gets the cassette key that was not found.
- getCassetteKeys(String) - Method in class com.redis.vl.test.vcr.VCRRegistry
-
Gets the cassette keys for a test.
- getCassetteStore() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the cassette store for storing/retrieving cassettes.
- getClient() - Method in class com.redis.vl.redis.RedisConnectionManager
-
Get the underlying UnifiedJedis client.
- getConfiguredMode() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the configured VCR mode.
- getCurrentCassetteKeys() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the cassette keys generated for the current test.
- getCurrentTestId() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the current test ID.
- getDataDir() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the data directory path.
- getDataType() - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Get the vector data type.
- getDelegate() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Gets the underlying delegate model.
- getDelegate() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Gets the underlying delegate model.
- getDelegate() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Gets the underlying delegate model.
- getDelegate() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Gets the underlying delegate model.
- getDialect() - Method in class com.redis.vl.query.FilterQuery
-
Get the query dialect.
- getDialect() - Method in class com.redis.vl.query.HybridQuery
-
Get the query dialect version.
- getDimensions() - Method in class com.redis.vl.schema.VectorField
-
Get dimensions
- getDimensions() - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Get the embedding dimensions.
- getDirection() - Method in class com.redis.vl.query.SortField
-
Get the direction as a string.
- getDistance() - Method in class com.redis.vl.extensions.cache.CacheHit
-
Get the vector distance.
- getDistanceMetric() - Method in class com.redis.vl.query.VectorQuery
-
Get the distance metric
- getDistanceMetric() - Method in class com.redis.vl.schema.VectorField
-
Get distance metric
- getDistanceThreshold() - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Get the current distance threshold.
- getDistanceThreshold() - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Get the distance threshold for semantic search.
- getDistanceThreshold() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the distance threshold for range filtering.
- getDocumentCount() - Method in class com.redis.vl.index.SearchIndex
-
Get document count in the index
- getDocuments() - Method in class com.redis.vl.utils.rerank.RerankResult
-
Get the reranked documents.
- getDtype() - Method in class com.redis.vl.query.HybridQuery
-
Get the data type for vector storage.
- getEffectiveMode() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the effective VCR mode for the current test.
- getEfRuntime() - Method in class com.redis.vl.query.VectorQuery
-
Get the EF runtime parameter for HNSW
- getEmbedding(String) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Get embedding for a single text.
- getEmbeddingModel() - Method in class com.redis.vl.utils.vectorize.LangChain4JVectorizer
-
Get the underlying LangChain4J embedding model.
- getEmbeddings(List<String>) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Get embeddings for multiple texts.
- getEpsilon() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the epsilon value for approximate search.
- getField() - Method in class com.redis.vl.query.VectorQuery
-
Get the vector field name
- getField() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the field name to search.
- getField(String) - Method in class com.redis.vl.schema.IndexSchema
-
Get a field by name
- getFields() - Method in class com.redis.vl.schema.IndexSchema
-
Get a copy of the fields list
- getFieldsByType(Class<T>) - Method in class com.redis.vl.schema.IndexSchema
-
Get fields of a specific type
- getFieldType() - Method in class com.redis.vl.schema.BaseField
-
Get the field type.
- getFieldType() - Method in class com.redis.vl.schema.GeoField
- getFieldType() - Method in class com.redis.vl.schema.NumericField
- getFieldType() - Method in class com.redis.vl.schema.TagField
- getFieldType() - Method in class com.redis.vl.schema.TextField
- getFieldType() - Method in class com.redis.vl.schema.VectorField
- getFieldWeights() - Method in class com.redis.vl.query.TextQuery
-
Get a copy of the field weights.
- getFilter() - Method in class com.redis.vl.query.CountQuery
-
Get the Filter object for this query.
- getFilter() - Method in class com.redis.vl.query.VectorQuery
-
Get the filter query
- getFilterExpression() - Method in class com.redis.vl.query.FilterQuery
-
Get the filter expression.
- getFilterExpression() - Method in class com.redis.vl.query.HybridQuery
-
Get the filter expression.
- getFilterString() - Method in class com.redis.vl.query.CountQuery
-
Get the filter string for this query.
- getHiddenSize() - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Get the hidden size (same as embedding dimension).
- getHitCount() - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Get the hit count.
- getHitRate() - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Get the cache hit rate.
- getHybridField() - Method in class com.redis.vl.query.VectorQuery
-
Get the hybrid search field
- getHybridPolicy() - Method in class com.redis.vl.query.VectorQuery
-
Get the hybrid search policy
- getHybridQuery() - Method in class com.redis.vl.query.VectorQuery
-
Get the hybrid search query
- getIndex() - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- getIndex() - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Get the underlying search index.
- getIndex() - Method in class com.redis.vl.schema.IndexSchema
-
Get the index configuration (defensive copy)
- getIndexSchema() - Method in class com.redis.vl.storage.BaseStorage
-
Get the index schema.
- getInfo() - Method in class com.redis.vl.index.SearchIndex
-
Get index information using FT.INFO
- getJedis() - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore
-
Gets the underlying Jedis client.
- getJedis() - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Gets the underlying Jedis client.
- getJedis() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the Redis client.
- getK() - Method in class com.redis.vl.query.VectorQuery
-
Deprecated.Use getNumResults() instead
- getK() - Method in class com.redis.vl.query.VectorRangeQuery
-
Deprecated.Use getNumResults() instead
- getKeyPrefix() - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore
-
Gets the key prefix.
- getKeyPrefix() - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Gets the key prefix.
- getKeys(List<Map<String, Object>>, List<String>, String) - Method in class com.redis.vl.storage.BaseStorage
-
Generate Redis keys for a list of objects.
- getKeySeparator() - Method in class com.redis.vl.index.SearchIndex
-
Get the key separator
- getKeySeparator() - Method in class com.redis.vl.schema.IndexSchema.Index
-
Get the key separator
- getLimit() - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Get the maximum number of results to return.
- getMessages() - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Returns the full chat history.
- getMessages() - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- getMessages() - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- getMessages(Object) - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore
- getMetadata() - Method in class com.redis.vl.extensions.cache.CacheHit
-
Get the metadata.
- getMetadata() - Method in class com.redis.vl.extensions.cache.PromptResponsePair
-
Get the metadata.
- getMissCount() - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Get the miss count.
- getMode() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Gets the current VCR mode.
- getMode() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Gets the current VCR mode.
- getMode() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Gets the current VCR mode.
- getMode() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Gets the current VCR mode.
- getMode() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Gets the current VCR mode.
- getModel() - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Get the model name.
- getModelName() - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Get the model name.
- getName() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Get the cache name.
- getName() - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Get the cache name.
- getName() - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
- getName() - Method in class com.redis.vl.index.SearchIndex
-
Get the index name
- getName() - Method in class com.redis.vl.schema.IndexSchema
-
Get the index name
- getName() - Method in class com.redis.vl.schema.IndexSchema.Index
-
Get the index name
- getNumResults() - Method in class com.redis.vl.query.FilterQuery
-
Get the number of results to return.
- getNumResults() - Method in class com.redis.vl.query.HybridQuery
-
Get the maximum number of results.
- getNumResults() - Method in class com.redis.vl.query.VectorQuery
-
Get the number of results to return
- getNumResults() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the maximum number of results to return.
- getParams() - Method in class com.redis.vl.query.AggregationQuery
-
Get the parameters for the aggregation query.
- getParams() - Method in class com.redis.vl.query.FilterQuery
-
Get additional query parameters.
- getParams() - Method in class com.redis.vl.query.HybridQuery
-
Get the parameters for the aggregation query.
- getParams() - Method in class com.redis.vl.query.MultiVectorQuery
-
Convert to parameter map for query execution.
- getPoint() - Method in class com.redis.vl.extensions.summarization.EmbeddedSentence
-
Get the embedding as double array (required by Clusterable).
- getPreFilter() - Method in class com.redis.vl.query.VectorQuery
-
Get the pre-filter expression
- getPrefix() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Get the cache prefix.
- getPrefix() - Method in class com.redis.vl.index.SearchIndex
-
Get the key prefix for documents
- getPrefix() - Method in class com.redis.vl.schema.IndexSchema
-
Get the prefix
- getPrefix() - Method in class com.redis.vl.schema.IndexSchema.Index
-
Get the key prefix (normalized).
- getPrefixRaw() - Method in class com.redis.vl.schema.IndexSchema.Index
-
Get the raw prefix value (can be String or List).
- getPrompt() - Method in class com.redis.vl.extensions.cache.CacheHit
-
Get the matched prompt.
- getPrompt() - Method in class com.redis.vl.extensions.cache.PromptResponsePair
-
Get the prompt.
- getRankBy() - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Get the fields to rank by.
- getRecent(int, boolean, boolean, String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
-
Retrieve the recent conversation history (backward-compatible overload without role filter).
- getRecent(int, boolean, boolean, String) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Retrieve the recent conversation history in sequential order.
- getRecent(int, boolean, boolean, String, Object) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Retrieve the recent conversation history in sequential order.
- getRecent(int, boolean, boolean, String, Object) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
- getRecent(int, boolean, boolean, String, Object) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
- getRecordedCount() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Gets the number of recorded responses.
- getRecordedCount() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Gets the number of recorded cassettes.
- getRecordedCount() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Gets the number of recorded cassettes.
- getRecordedCount() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Gets the number of recorded responses.
- getRecordedCount() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Gets the number of recorded cassettes.
- getRecordedKeys() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Gets the recorded cassette keys.
- getRegistry() - Method in class com.redis.vl.test.vcr.VCRContext
-
Gets the VCR registry.
- getRelevant(String, boolean, int, boolean, String, Double, Object) - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Search the message history for information semantically related to the specified prompt.
- getResponse() - Method in class com.redis.vl.extensions.cache.CacheHit
-
Get the cached response.
- getResponse() - Method in class com.redis.vl.extensions.cache.PromptResponsePair
-
Get the response.
- getResponse(AbstractPipeline, String) - Method in class com.redis.vl.storage.BaseStorage
-
Get a response for retrieving a value from Redis using a pipeline.
- getResponse(AbstractPipeline, String) - Method in class com.redis.vl.storage.HashStorage
- getResponse(AbstractPipeline, String) - Method in class com.redis.vl.storage.JsonStorage
- getReturnFields() - Method in class com.redis.vl.query.FilterQuery
-
Get the fields to return in results.
- getReturnFields() - Method in class com.redis.vl.query.HybridQuery
-
Get an unmodifiable view of the return fields.
- getReturnFields() - Method in class com.redis.vl.query.VectorQuery
-
Get the fields to return in results
- getReturnFields() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the list of fields to return in results.
- getRouteNames() - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Get the list of route names.
- getRouteReferences(String, List<String>, List<String>) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Get references for an existing route.
- getRouteThresholds() - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Get the distance thresholds for each route.
- getScoreCalculations() - Method in class com.redis.vl.query.MultiVectorQuery
-
Get individual score calculations.
- getScores() - Method in class com.redis.vl.utils.rerank.RerankResult
-
Get the relevance scores for each document.
- getScoringFormula() - Method in class com.redis.vl.query.MultiVectorQuery
-
Get the scoring formula for combining vector similarities.
- getSearchBufferCapacity() - Method in class com.redis.vl.query.VectorQuery
-
Get the search buffer capacity for SVS-VAMANA
- getSearchBufferCapacity() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the search buffer capacity for SVS-VAMANA algorithm.
- getSearchIndex() - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
-
Gets the underlying SearchIndex.
- getSearchWindowSize() - Method in class com.redis.vl.query.VectorQuery
-
Get the search window size for SVS-VAMANA
- getSearchWindowSize() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the search window size for SVS-VAMANA algorithm.
- getSentinelHosts() - Method in class com.redis.vl.redis.SentinelConfig
-
Get an unmodifiable view of the Sentinel hosts list.
- getSessionTag() - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
- getSkipDecodeFields() - Method in class com.redis.vl.query.FilterQuery
-
Get the list of fields that should not be decoded from binary format.
- getSkipDecodeFields() - Method in class com.redis.vl.query.TextQuery
-
Get the list of fields that should not be decoded from binary format.
- getSkipDecodeFields() - Method in class com.redis.vl.query.VectorQuery
-
Get the list of fields that should not be decoded from binary format.
- getSkipDecodeFields() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the list of fields that should not be decoded from binary format.
- getSortBy() - Method in class com.redis.vl.query.FilterQuery
-
Get the field to sort by.
- getSortBy() - Method in class com.redis.vl.query.VectorQuery
-
Get the sort field
- getSortBy() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the field name to sort results by.
- getStopwords() - Method in class com.redis.vl.query.HybridQuery
-
Get an unmodifiable view of the stopwords.
- getStopwords() - Method in class com.redis.vl.schema.IndexSchema.Index
-
Get the stopwords configuration.
- getStorageType() - Method in class com.redis.vl.index.SearchIndex
-
Get the storage type
- getStorageType() - Method in class com.redis.vl.schema.IndexSchema
-
Get the storage type
- getStorageType() - Method in class com.redis.vl.schema.IndexSchema.Index
-
Get the storage type
- getTestId() - Method in exception class com.redis.vl.test.vcr.VCRCassetteMissingException
-
Gets the test identifier.
- getTestId() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Gets the current test identifier.
- getTestId() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Gets the current test identifier.
- getTestStatus(String) - Method in class com.redis.vl.test.vcr.VCRRegistry
-
Gets the recording status of a test.
- getText() - Method in class com.redis.vl.query.HybridQuery
-
Get the text query string.
- getTextFieldName() - Method in class com.redis.vl.query.HybridQuery
-
Get the text field name.
- getTextScorer() - Method in class com.redis.vl.query.HybridQuery
-
Get the text scoring algorithm.
- getTokenizer() - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Get a copy of the tokenizer configuration to prevent internal representation exposure.
- getTopScore() - Method in class com.redis.vl.utils.rerank.RerankResult
-
Get the highest score from the result.
- getTtl() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Get the default TTL for cache entries.
- getTtl() - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Get the TTL for cache entries.
- getType() - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Get the vector type identifier.
- getType() - Method in class com.redis.vl.utils.vectorize.LangChain4JVectorizer
- getUseSearchHistory() - Method in class com.redis.vl.query.VectorQuery
-
Get the use search history parameter for SVS-VAMANA
- getUseSearchHistory() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the use search history mode for SVS-VAMANA algorithm.
- getValue() - Method in enum class com.redis.vl.extensions.router.DistanceAggregationMethod
-
Get the string value of the aggregation method.
- getValue() - Method in enum class com.redis.vl.query.Filter.GeoUnit
-
Get the string value of this geographic unit.
- getValue() - Method in enum class com.redis.vl.schema.IndexSchema.StorageType
-
Get the string value of this storage type
- getValue() - Method in enum class com.redis.vl.schema.StorageType
-
Get the string value of this storage type.
- getValue() - Method in enum class com.redis.vl.schema.VectorField.Algorithm
-
Get the algorithm value
- getValue() - Method in enum class com.redis.vl.schema.VectorField.CompressionType
-
Get the compression type value for Redis
- getValue() - Method in enum class com.redis.vl.schema.VectorField.DistanceMetric
-
Get the distance metric value
- getValue() - Method in enum class com.redis.vl.schema.VectorField.VectorDataType
-
Get the data type value
- getVector() - Method in class com.redis.vl.query.HybridQuery
-
Get a copy of the query vector.
- getVector() - Method in class com.redis.vl.query.Vector
-
Get a copy of the vector.
- getVector() - Method in class com.redis.vl.query.VectorQuery
-
Get the query vector
- getVector() - Method in class com.redis.vl.query.VectorRangeQuery
-
Get the query vector.
- getVectorFieldName() - Method in class com.redis.vl.query.HybridQuery
-
Get the vector field name.
- getVectorizer() - Method in class com.redis.vl.extensions.messagehistory.SemanticMessageHistory
-
Get the vectorizer used for embeddings.
- graphMaxDegree(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the graph max degree for SVS-VAMANA algorithm.
- gt(double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values greater than the specified value (exclusive).
- gt(int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values greater than the specified value (exclusive).
- gt(Instant) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps greater than the given instant.
- gt(LocalDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps greater than the given datetime (assumes UTC).
- gte(double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values greater than or equal to the specified value.
- gte(int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values greater than or equal to the specified value.
H
- hasField(String) - Method in class com.redis.vl.schema.IndexSchema
-
Check if a field exists
- HASH - Enum constant in enum class com.redis.vl.schema.IndexSchema.StorageType
-
Hash storage type
- HASH - Enum constant in enum class com.redis.vl.schema.StorageType
-
Hash storage type
- hashCode() - Method in record class com.redis.vl.langchain4j.RedisVLDocumentStore.Document
-
Returns a hash code value for this object.
- hashCode() - Method in class com.redis.vl.query.Vector
- hashCode() - Method in class com.redis.vl.schema.BaseField
- hashCode() - Method in class com.redis.vl.schema.IndexSchema
- hashCode() - Method in class com.redis.vl.schema.IndexSchema.Index
- HashStorage - Class in com.redis.vl.storage
-
Internal subclass of BaseStorage for the Redis hash data type.
- HashStorage(IndexSchema) - Constructor for class com.redis.vl.storage.HashStorage
-
Creates a new HashStorage instance for managing Redis hash data structures.
- hasScores() - Method in class com.redis.vl.utils.rerank.RerankResult
-
Check if this result includes scores.
- HFCrossEncoderReranker - Class in com.redis.vl.utils.rerank
-
HuggingFace Cross-Encoder reranker using real ONNX models.
- HFCrossEncoderReranker() - Constructor for class com.redis.vl.utils.rerank.HFCrossEncoderReranker
-
Default constructor with default model and settings.
- HFCrossEncoderReranker.Builder - Class in com.redis.vl.utils.rerank
-
Builder for creating HFCrossEncoderReranker instances.
- HNSW - Enum constant in enum class com.redis.vl.schema.VectorField.Algorithm
-
HNSW algorithm for approximate nearest neighbor search
- hnswEfConstruction(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the EF_CONSTRUCTION parameter for HNSW algorithm
- hnswEfRuntime(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the EF_RUNTIME parameter for HNSW algorithm
- hnswM(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the M parameter for HNSW algorithm
- HostPort(String, int) - Constructor for class com.redis.vl.redis.SentinelConfig.HostPort
- httpClient(OkHttpClient) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set the HTTP client (primarily for testing)
- huggingFace(String) - Static method in class com.redis.vl.utils.vectorize.VectorizerBuilder
-
Create a builder for HuggingFace embeddings.
- HuggingFaceModelDownloader - Class in com.redis.vl.utils.vectorize
-
Downloads and caches HuggingFace models locally for offline use.
- HuggingFaceModelDownloader(String) - Constructor for class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Create a downloader with cache directory and default settings.
- HuggingFaceModelDownloader(String, String) - Constructor for class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Create a downloader with cache directory and custom base URL.
- HuggingFaceModelDownloader(String, String, int) - Constructor for class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Create a downloader with cache directory, base URL, and custom timeout.
- HuggingFaceModelDownloader(String, String, HuggingFaceModelDownloader.ProgressListener) - Constructor for class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Create a downloader with cache directory, base URL, and progress listener.
- HuggingFaceModelDownloader(String, String, HuggingFaceModelDownloader.ProgressListener, int) - Constructor for class com.redis.vl.utils.vectorize.HuggingFaceModelDownloader
-
Create a downloader with all custom settings.
- HuggingFaceModelDownloader.ProgressListener - Interface in com.redis.vl.utils.vectorize
-
Progress listener for download tracking.
- hybridField(String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the hybrid search field
- hybridQuery(String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the hybrid search query
- HybridQuery - Class in com.redis.vl.query
-
HybridQuery combines text and vector search in Redis using aggregation.
- HybridQuery.HybridQueryBuilder - Class in com.redis.vl.query
-
Builder for creating HybridQuery instances with fluent API.
I
- ID_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- ID_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for message entry ID.
- index() - Method in class com.redis.vl.extensions.summarization.EmbeddedSentence
-
Get the original index of this sentence.
- index(IndexSchema.Index) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Set the builder from an Index configuration
- Index() - Constructor for class com.redis.vl.schema.IndexSchema.Index
-
Creates a new Index with default values
- Index(String) - Constructor for class com.redis.vl.schema.IndexSchema.Index
-
Creates a new Index with the given name
- indexed - Variable in class com.redis.vl.schema.BaseField
-
Whether this field should be indexed
- indexed(boolean) - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Set whether the field is indexed.
- indexed(boolean) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Set whether this field should be indexed.
- indexed(boolean) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set whether the field is indexed
- indexed(boolean) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set whether the field is indexed
- indexed(boolean) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set whether the field is indexed
- indexEmpty() - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Index empty string values (equivalent to indexEmpty(true)).
- indexEmpty() - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Index empty string values (equivalent to indexEmpty(true)).
- indexEmpty(boolean) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set whether to index empty string values.
- indexEmpty(boolean) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set whether to index empty string values.
- indexMissing() - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Index missing values (equivalent to indexMissing(true)).
- indexMissing() - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Index missing values (equivalent to indexMissing(true)).
- indexMissing() - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Index missing values (equivalent to indexMissing(true)).
- indexMissing() - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Index missing values (equivalent to indexMissing(true)).
- indexMissing(boolean) - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Set whether to index missing values (documents without this field).
- indexMissing(boolean) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Set whether to index missing values (documents without this field).
- indexMissing(boolean) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set whether to index missing values (documents without this field).
- indexMissing(boolean) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set whether to index missing values (documents without this field).
- indexSchema - Variable in class com.redis.vl.storage.BaseStorage
-
The index schema for this storage instance.
- IndexSchema - Class in com.redis.vl.schema
-
Represents the schema definition for a Redis search index.
- IndexSchema.Builder - Class in com.redis.vl.schema
-
Builder for IndexSchema
- IndexSchema.Index - Class in com.redis.vl.schema
-
Inner class to hold index configuration
- IndexSchema.StorageType - Enum Class in com.redis.vl.schema
-
Storage type for documents in Redis
- info() - Method in class com.redis.vl.index.SearchIndex
-
Get index information
- initialCapacity(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the initial capacity for FLAT algorithm
- initialize() - Method in class com.redis.vl.test.vcr.VCRContext
-
Initializes the VCR context, starting Redis and loading existing cassettes.
- inOrder(boolean) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Set whether to require in-order term matching.
- inOrder(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set whether terms must be in order
- inOrder(boolean) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set whether query terms must appear in order.
- INSERTED_AT_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- INSERTED_AT_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for cache insertion timestamp.
- INT8 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType
-
8-bit signed integer
- IP - Enum constant in enum class com.redis.vl.schema.VectorField.DistanceMetric
-
Inner Product distance
- isConnected() - Method in class com.redis.vl.extensions.cache.BaseCache
-
Check if the cache is connected to Redis.
- isConnected() - Method in class com.redis.vl.redis.RedisConnectionManager
-
Check if the connection manager is connected.
- isInOrder() - Method in class com.redis.vl.query.FilterQuery
-
Check if in-order matching is required.
- isInOrder() - Method in class com.redis.vl.query.VectorQuery
-
Check if terms must be in order
- isInOrder() - Method in class com.redis.vl.query.VectorRangeQuery
-
Check if query terms must appear in order.
- isLeanVec() - Method in enum class com.redis.vl.schema.VectorField.CompressionType
-
Check if this is a LeanVec compression type.
- isLVQ() - Method in enum class com.redis.vl.schema.VectorField.CompressionType
-
Check if this is an LVQ compression type.
- isNormalizeVectorDistance() - Method in class com.redis.vl.query.VectorQuery
-
Check if vector distance should be normalized
- isNormalizeVectorDistance() - Method in class com.redis.vl.query.VectorRangeQuery
-
Check if vector distances should be normalized.
- isPlaybackMode() - Method in enum class com.redis.vl.test.vcr.VCRMode
-
Checks if this mode can use cached responses.
- isRecordMode() - Method in enum class com.redis.vl.test.vcr.VCRMode
-
Checks if this mode can potentially make real API calls and record responses.
- isReturnDistance() - Method in class com.redis.vl.query.VectorQuery
-
Check if distance values should be returned
- isReturnScore() - Method in class com.redis.vl.query.VectorQuery
-
Check if similarity scores should be returned
- isReturnScore() - Method in class com.redis.vl.query.VectorRangeQuery
-
Check if scores should be returned with results.
- isReturnScore() - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Check if scores should be returned with results.
- isSortDescending() - Method in class com.redis.vl.query.VectorQuery
-
Check if sorting is descending
- isSortDescending() - Method in class com.redis.vl.query.VectorRangeQuery
-
Check if results should be sorted in descending order.
J
- jedis(UnifiedJedis) - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Set the UnifiedJedis client.
- jedis(UnifiedJedis) - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore.Builder
-
Sets the Redis client.
- jedis(UnifiedJedis) - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore.Builder
-
Sets the Redis client.
- JSON - Enum constant in enum class com.redis.vl.schema.IndexSchema.StorageType
-
JSON storage type
- JSON - Enum constant in enum class com.redis.vl.schema.StorageType
-
JSON storage type
- JsonStorage - Class in com.redis.vl.storage
-
Internal subclass of BaseStorage for the Redis JSON data type.
- JsonStorage(IndexSchema) - Constructor for class com.redis.vl.storage.JsonStorage
-
Creates a new JsonStorage instance for managing Redis JSON data structures.
K
- k(int) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Deprecated.Use numResults() instead
- k(int) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Deprecated.Use numResults() instead
- key(String) - Method in class com.redis.vl.index.SearchIndex
-
Generate a full key from an ID using the index prefix and separator
- keyPrefix(String) - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore.Builder
-
Sets the key prefix.
- keyPrefix(String) - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore.Builder
-
Sets the key prefix.
- KM - Enum constant in enum class com.redis.vl.query.Filter.GeoUnit
-
Kilometers
L
- L2 - Enum constant in enum class com.redis.vl.schema.VectorField.DistanceMetric
-
L2 (Euclidean) distance
- LangCacheSemanticCache - Class in com.redis.vl.extensions.cache
-
LLM Cache implementation using the LangCache managed service.
- LangCacheSemanticCache.Builder - Class in com.redis.vl.extensions.cache
-
Builder for LangCacheSemanticCache.
- LangChain4JFilterMapper - Class in com.redis.vl.langchain4j
-
Maps LangChain4J Filter types to RedisVL Filter queries.
- LangChain4JFilterMapper() - Constructor for class com.redis.vl.langchain4j.LangChain4JFilterMapper
- LangChain4JVectorizer - Class in com.redis.vl.utils.vectorize
-
LangChain4J-based vectorizer that can work with any LangChain4J EmbeddingModel.
- LangChain4JVectorizer(String, EmbeddingModel) - Constructor for class com.redis.vl.utils.vectorize.LangChain4JVectorizer
-
Creates a new LangChain4JVectorizer with auto-detected dimensions.
- LangChain4JVectorizer(String, EmbeddingModel, int) - Constructor for class com.redis.vl.utils.vectorize.LangChain4JVectorizer
-
Creates a new LangChain4JVectorizer with known dimensions.
- LangChain4JVectorizer(String, EmbeddingModel, int, String) - Constructor for class com.redis.vl.utils.vectorize.LangChain4JVectorizer
-
Creates a new LangChain4JVectorizer with known dimensions and data type.
- LangChain4JVectorizer(String, EmbeddingModel, EmbeddingsCache) - Constructor for class com.redis.vl.utils.vectorize.LangChain4JVectorizer
-
Creates a new LangChain4JVectorizer with cache.
- LeanVec4x8 - Enum constant in enum class com.redis.vl.schema.VectorField.CompressionType
-
LeanVec with 4x8 bit quantization (supports dimensionality reduction)
- LeanVec8x8 - Enum constant in enum class com.redis.vl.schema.VectorField.CompressionType
-
LeanVec with 8x8 bit quantization (supports dimensionality reduction)
- limit - Variable in class com.redis.vl.utils.rerank.BaseReranker
-
Maximum number of results to return.
- limit(int) - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker.Builder
-
Set the maximum number of results to return.
- listDocumentIds() - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Lists all document IDs in this store.
- listIndexes() - Method in class com.redis.vl.index.SearchIndex
-
List all search indexes in Redis
- load(List<Map<String, Object>>) - Method in class com.redis.vl.index.SearchIndex
-
Load data with automatic ULID key generation.
- load(List<Map<String, Object>>, String) - Method in class com.redis.vl.index.SearchIndex
-
Load data with specified id field.
- load(List<Map<String, Object>>, String, Function<Map<String, Object>, Map<String, Object>>) - Method in class com.redis.vl.index.SearchIndex
-
Load data with preprocessing.
- loadDefaultStopwords(String) - Static method in class com.redis.vl.query.AggregateHybridQuery
-
Load default stopwords for a given language (delegates to HybridQuery.loadDefaultStopwords()).
- loadDefaultStopwords(String) - Static method in class com.redis.vl.query.HybridQuery
-
Load default stopwords for a given language.
- loadModel(Path) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Load an ONNX model from the specified directory.
- loadModel(Path, OrtEnvironment) - Method in class com.redis.vl.utils.rerank.CrossEncoderLoader
-
Load an ONNX cross-encoder model from the specified directory.
- loadModel(Path, OrtEnvironment) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Load an ONNX model from the specified directory with a specific environment.
- local(String) - Static method in class com.redis.vl.utils.vectorize.VectorizerBuilder
-
Create a builder for local embedding models.
- lt(double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values less than the specified value (exclusive).
- lt(int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values less than the specified value (exclusive).
- lt(Instant) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps less than the given instant.
- lt(LocalDateTime) - Method in class com.redis.vl.query.Filter.TimestampFilterBuilder
-
Filter for timestamps less than the given datetime (assumes UTC).
- lte(double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values less than or equal to the specified value.
- lte(int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values less than or equal to the specified value.
- LVQ4 - Enum constant in enum class com.redis.vl.schema.VectorField.CompressionType
-
Learned Vector Quantization - 4 bits per dimension
- LVQ4x4 - Enum constant in enum class com.redis.vl.schema.VectorField.CompressionType
-
Learned Vector Quantization - 4x4 bits (hybrid)
- LVQ4x8 - Enum constant in enum class com.redis.vl.schema.VectorField.CompressionType
-
Learned Vector Quantization - 4x8 bits (hybrid)
- LVQ8 - Enum constant in enum class com.redis.vl.schema.VectorField.CompressionType
-
Learned Vector Quantization - 8 bits per dimension
M
- M - Enum constant in enum class com.redis.vl.query.Filter.GeoUnit
-
Meters
- makeKey(String) - Method in class com.redis.vl.extensions.cache.BaseCache
-
Generate a Redis key with the cache prefix.
- map(Filter) - Static method in class com.redis.vl.langchain4j.LangChain4JFilterMapper
-
Map LangChain4J Filter to RedisVL Filter.
- MAX - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE MAX 1 {property} - Return the maximal value of a property, whether it is a string, number or NULL.
- maxIterations(int) - Method in class com.redis.vl.extensions.summarization.ExtractiveSelector.Builder
- maxResults(int) - Method in class com.redis.vl.langchain4j.RedisVLContentRetriever.Builder
-
Sets the maximum number of results.
- mdrop(List<String>, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Delete multiple embeddings in batch.
- meanPooling(float[][][]) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Deprecated.Use meanPoolingWithAttention for correct sentence-transformers behavior
- meanPoolingWithAttention(float[][][], long[][]) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Apply attention-masked mean pooling to token embeddings (Sentence Transformers style).
- MESSAGE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- MESSAGE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for message vector field in semantic message history.
- MessageHistory - Class in com.redis.vl.extensions.messagehistory
-
Message History for storing and retrieving LLM conversation history.
- MessageHistory(String, String, String, UnifiedJedis) - Constructor for class com.redis.vl.extensions.messagehistory.MessageHistory
-
Initialize message history.
- MessageHistory(String, UnifiedJedis) - Constructor for class com.redis.vl.extensions.messagehistory.MessageHistory
-
Initialize message history.
- MessageHistorySchema - Class in com.redis.vl.extensions.messagehistory
-
Schema for message history index.
- metadata() - Method in record class com.redis.vl.langchain4j.RedisVLDocumentStore.Document
-
Returns the value of the
metadatarecord component. - METADATA_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- METADATA_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for metadata (used in both MessageHistory and SemanticCache).
- mexists(List<String>, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Check existence of multiple embeddings in batch.
- mget(List<String>, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Retrieve multiple embeddings in batch.
- MI - Enum constant in enum class com.redis.vl.query.Filter.GeoUnit
-
Miles
- MIN - Enum constant in enum class com.redis.vl.extensions.router.DistanceAggregationMethod
-
Minimum aggregation method
- MIN - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE MIN 1 {property} - Return the minimal value of a property, whether it is a string, number or NULL.
- minScore(double) - Method in class com.redis.vl.langchain4j.RedisVLContentRetriever.Builder
-
Sets the minimum similarity score.
- MISSING - Enum constant in enum class com.redis.vl.test.vcr.VCRRegistry.RecordingStatus
-
Test has no recording
- MockVectorizer - Class in com.redis.vl.utils.vectorize
-
Mock vectorizer for testing purposes.
- MockVectorizer(String, int) - Constructor for class com.redis.vl.utils.vectorize.MockVectorizer
-
Creates a new MockVectorizer.
- mode() - Element in annotation interface com.redis.vl.test.vcr.VCRTest
-
The VCR operating mode for this test class.
- model - Variable in class com.redis.vl.utils.rerank.BaseReranker
-
The model name or identifier used for reranking.
- model(String) - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker.Builder
-
Set the model name.
- model(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.HuggingFaceVectorizerBuilder
-
Set the HuggingFace model to use.
- model(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.OllamaVectorizerBuilder
-
Set the Ollama model to use.
- model(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.OpenAIVectorizerBuilder
-
Set the OpenAI model to use.
- MODEL_NAME_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- MODEL_NAME_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for model name in embeddings cache.
- modelName - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer
-
The name of the embedding model.
- modelName - Variable in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Model name for this vectorizer.
- modelName() - Element in annotation interface com.redis.vl.test.vcr.VCRModel
-
Optional model name for embedding cache key generation.
- mset(Map<String, float[]>, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Store multiple embeddings in batch.
- MultiVectorQuery - Class in com.redis.vl.query
-
MultiVectorQuery allows for search over multiple vector fields in a document simultaneously.
- MultiVectorQuery.Builder - Class in com.redis.vl.query
-
Builder for creating MultiVectorQuery instances.
N
- name - Variable in class com.redis.vl.extensions.cache.BaseCache
-
The name of the cache.
- name - Variable in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
- name - Variable in class com.redis.vl.schema.BaseField
-
The name of the field in Redis
- name(String) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set the cache name
- name(String) - Method in class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Set the cache name
- name(String) - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Set the router name.
- name(String) - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Set the field name.
- name(String) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Set the index name
- name(String) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Set the field name.
- name(String) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set the field name
- name(String) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the field name
- name(String) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the field name
- ne(double) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values not equal to the specified value.
- ne(int) - Method in class com.redis.vl.query.Filter.NumericFilterBuilder
-
Create a filter for values not equal to the specified value.
- normalize(float[][]) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Normalize embeddings to unit length.
- normalizeVectorDistance(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set whether to normalize vector distance
- normalizeVectorDistance(boolean) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set whether to normalize vector distances.
- normCosineDistance(float) - Static method in class com.redis.vl.utils.Utils
-
Normalize a Redis COSINE distance (0-2) to a similarity score (0-1).
- noStem() - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Disable stemming for this field
- noStem(boolean) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set whether to disable stemming
- noStopwords() - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Disable stopwords entirely (equivalent to stopwords(Collections.emptyList())).
- not(Filter) - Static method in class com.redis.vl.query.Filter
-
Negate a filter
- notRadius(double, double, double, Filter.GeoUnit) - Method in class com.redis.vl.query.Filter.GeoFilterBuilder
-
Create a filter for locations NOT within a radius of a point.
- numeric(String) - Static method in class com.redis.vl.query.Filter
-
Create a numeric filter builder
- NUMERIC - Enum constant in enum class com.redis.vl.schema.FieldType
-
Numeric field for range queries
- NumericField - Class in com.redis.vl.schema
-
NumericField represents a numeric field in Redis.
- NumericField(String) - Constructor for class com.redis.vl.schema.NumericField
-
Create a NumericField with just a name.
- NumericField.NumericFieldBuilder - Class in com.redis.vl.schema
-
Fluent builder for NumericField
- numResults(int) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Set the number of results to return.
- numResults(int) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the maximum number of results to return.
- numResults(int) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the maximum number of results to return.
- numResults(int) - Method in class com.redis.vl.query.TextQuery.Builder
-
Set the number of results to return.
- numResults(int) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the number of results to return
- numResults(int) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the maximum number of results to return.
O
- of(String) - Static method in class com.redis.vl.schema.GeoField
-
Create a GeoField with fluent API.
- of(String) - Static method in class com.redis.vl.schema.IndexSchema
-
Create with fluent API
- of(String) - Static method in class com.redis.vl.schema.NumericField
-
Create a NumericField with fluent API.
- of(String) - Static method in class com.redis.vl.schema.TagField
-
Create a TagField with fluent API
- of(String) - Static method in class com.redis.vl.schema.TextField
-
Create a TextField with fluent API
- of(String, double[]) - Static method in class com.redis.vl.query.VectorQuery
-
Create a VectorQuery with fluent API for double array
- of(String, float[]) - Static method in class com.redis.vl.query.VectorQuery
-
Create a VectorQuery with fluent API for float array
- of(String, int) - Static method in class com.redis.vl.schema.VectorField
-
Create a VectorField with fluent API
- OFF - Enum constant in enum class com.redis.vl.test.vcr.VCRMode
-
Disable VCR entirely.
- ollama(String) - Static method in class com.redis.vl.utils.vectorize.VectorizerBuilder
-
Create a builder for Ollama embeddings.
- OnnxModelLoader - Class in com.redis.vl.utils.vectorize
-
Loads and runs ONNX models for generating embeddings.
- OnnxModelLoader() - Constructor for class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Creates a new OnnxModelLoader.
- onProgress(String, long, long) - Method in interface com.redis.vl.utils.vectorize.HuggingFaceModelDownloader.ProgressListener
-
Called periodically during download to report progress.
- openAI(String) - Static method in class com.redis.vl.utils.vectorize.VectorizerBuilder
-
Create a builder for OpenAI embeddings.
- or(Filter...) - Static method in class com.redis.vl.query.Filter
-
Combine filters with OR
- organizationId(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.OpenAIVectorizerBuilder
-
Set the OpenAI organization ID.
- OUTDATED - Enum constant in enum class com.redis.vl.test.vcr.VCRRegistry.RecordingStatus
-
Test recording is outdated
- overwrite(boolean) - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Set whether to overwrite existing index.
P
- paginate(Object, int) - Method in class com.redis.vl.index.SearchIndex
-
Execute a query and return results in paginated batches.
- params(Map<String, Object>) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Set query parameters.
- parseKey(String) - Static method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Parses a cassette key into its components.
- parseSortSpec(SortField) - Static method in class com.redis.vl.query.SortSpec
-
Parse a single SortField.
- parseSortSpec(String) - Static method in class com.redis.vl.query.SortSpec
-
Parse a single field name (defaults to ascending order).
- parseSortSpec(String, String) - Static method in class com.redis.vl.query.SortSpec
-
Parse a single field name with direction.
- parseSortSpec(List<SortField>) - Static method in class com.redis.vl.query.SortSpec
-
Parse a list of SortFields (supports multiple fields).
- persistCassettes() - Method in class com.redis.vl.test.vcr.VCRContext
-
Persists cassettes by triggering a Redis BGSAVE.
- phonetic(String) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the phonetic matcher
- PLAYBACK - Enum constant in enum class com.redis.vl.test.vcr.VCRMode
-
Use cached responses only.
- PLAYBACK_OR_RECORD - Enum constant in enum class com.redis.vl.test.vcr.VCRMode
-
Smart mode: use cache if it exists, otherwise record.
- preFilter(String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the pre-filter expression
- prefix - Variable in class com.redis.vl.extensions.cache.BaseCache
-
The Redis key prefix for this cache.
- prefix(String) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Set the key prefix (single prefix)
- prefix(String, String) - Static method in class com.redis.vl.query.Filter
-
Create a prefix filter
- prefix(List<String>) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Set multiple key prefixes.
- preloadBatchCassette(String, float[][]) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Preloads a batch cassette into the in-memory cache (for testing).
- preloadBatchCassette(String, float[][]) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Preloads a batch cassette into the in-memory cache (for testing).
- preloadBatchCassette(String, float[][]) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Preloads a batch cassette into the in-memory cache (for testing).
- preloadCassette(String, float[]) - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Preloads a cassette into the in-memory cache (for testing).
- preloadCassette(String, float[]) - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Preloads a cassette into the in-memory cache (for testing).
- preloadCassette(String, float[]) - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Preloads a cassette into the in-memory cache (for testing).
- preloadCassette(String, String) - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Preloads a cassette for testing purposes.
- preloadCassette(String, String) - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Preloads a cassette for testing purposes.
- preprocessAndValidateObjects(List<Map<String, Object>>, String, List<String>, Function<Map<String, Object>, Map<String, Object>>, boolean) - Method in class com.redis.vl.storage.BaseStorage
-
Preprocess and validate a list of objects.
- preprocessObject(Map<String, Object>, Function<Map<String, Object>, Map<String, Object>>) - Static method in class com.redis.vl.storage.BaseStorage
-
Apply a preprocessing function to the object if provided.
- printStatistics() - Method in class com.redis.vl.test.vcr.VCRContext
-
Prints VCR statistics to stdout.
- processEmbedding(float[], boolean) - Method in class com.redis.vl.utils.vectorize.BaseVectorizer
-
Convert embedding to byte buffer if requested.
- PROMPT_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- PROMPT_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for prompt text in cache.
- PromptResponsePair - Class in com.redis.vl.extensions.cache
-
Represents a prompt-response pair for batch operations.
- PromptResponsePair(String, String) - Constructor for class com.redis.vl.extensions.cache.PromptResponsePair
-
Creates a new PromptResponsePair without metadata.
- PromptResponsePair(String, String, Map<String, Object>) - Constructor for class com.redis.vl.extensions.cache.PromptResponsePair
-
Creates a new PromptResponsePair with metadata.
Q
- QUANTILE - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE QUANTILE 2 {property} {quantile} - Return the value of a numeric property at a given quantile of the results.
- query(Object) - Method in class com.redis.vl.index.SearchIndex
-
Query the index using various query types and return results as a list of maps
- query(String) - Method in class com.redis.vl.index.SearchIndex
-
Query the index and return results as a list of maps
R
- radius(double, double, double, Filter.GeoUnit) - Method in class com.redis.vl.query.Filter.GeoFilterBuilder
-
Create a filter for locations within a radius of a point.
- RANDOM_SAMPLE - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE RANDOM_SAMPLE {nargs} {property} {sample_size} - Perform a reservoir sampling of the group elements with a given size, and return an array of the sampled items with an even distribution.
- rank(String, List<?>) - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Rerank documents based on their relevance to the query.
- rank(String, List<?>) - Method in class com.redis.vl.utils.rerank.CohereReranker
-
Rerank documents based on query relevance using Cohere's Rerank API.
- rank(String, List<?>) - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker
- rank(String, List<?>) - Method in class com.redis.vl.utils.rerank.VoyageAIReranker
-
Rerank documents based on query relevance using VoyageAI's Rerank API.
- rank(String, List<?>, Map<String, Object>) - Method in class com.redis.vl.utils.rerank.CohereReranker
-
Rerank documents based on query relevance using Cohere's Rerank API with runtime parameter overrides.
- rank(String, List<?>, Map<String, Object>) - Method in class com.redis.vl.utils.rerank.VoyageAIReranker
-
Rerank documents based on query relevance using VoyageAI's Rerank API with runtime parameter overrides.
- rankBy - Variable in class com.redis.vl.utils.rerank.BaseReranker
-
Optional list of field names to rank by (may be null).
- RECORD - Enum constant in enum class com.redis.vl.test.vcr.VCRMode
-
Always make real API calls and overwrite any existing cassettes.
- RECORD_FAILED - Enum constant in enum class com.redis.vl.test.vcr.VCRMode
-
Re-record only tests that previously failed.
- RECORD_NEW - Enum constant in enum class com.redis.vl.test.vcr.VCRMode
-
Only record tests that are not already in the registry.
- recordApiCall() - Method in class com.redis.vl.test.vcr.VCRContext
-
Records an API call.
- recordCacheHit() - Method in class com.redis.vl.test.vcr.VCRContext
-
Records a cache hit.
- recordCacheMiss() - Method in class com.redis.vl.test.vcr.VCRContext
-
Records a cache miss.
- RECORDED - Enum constant in enum class com.redis.vl.test.vcr.VCRRegistry.RecordingStatus
-
Test has been successfully recorded
- recreate() - Method in class com.redis.vl.index.SearchIndex
-
Recreate the index (drop if exists and create new)
- REDIS_KEY_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- REDIS_KEY_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for Redis key in semantic cache.
- redisClient - Variable in class com.redis.vl.extensions.cache.BaseCache
-
The Redis client connection.
- redisClient(UnifiedJedis) - Method in class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Set the Redis client
- RedisConnectionConfig - Class in com.redis.vl.redis
-
Configuration for Redis connections.
- RedisConnectionManager - Class in com.redis.vl.redis
-
Manages Redis connections using the modern Jedis 7.2+ API.
- RedisConnectionManager(RedisConnectionConfig) - Constructor for class com.redis.vl.redis.RedisConnectionManager
-
Create a new connection manager with the given configuration.
- RedisConnectionManager(SentinelConfig) - Constructor for class com.redis.vl.redis.RedisConnectionManager
-
Create a new connection manager with Sentinel configuration.
- redisImage() - Element in annotation interface com.redis.vl.test.vcr.VCRTest
-
The Docker image to use for the Redis container.
- RedisVLChatMemoryStore - Class in com.redis.vl.langchain4j
-
LangChain4J ChatMemoryStore implementation using Redis as the backend.
- RedisVLChatMemoryStore(UnifiedJedis) - Constructor for class com.redis.vl.langchain4j.RedisVLChatMemoryStore
-
Creates a new RedisVLChatMemoryStore with default prefix.
- RedisVLChatMemoryStore(UnifiedJedis, String) - Constructor for class com.redis.vl.langchain4j.RedisVLChatMemoryStore
-
Creates a new RedisVLChatMemoryStore with custom prefix.
- RedisVLChatMemoryStore(UnifiedJedis, String, Integer) - Constructor for class com.redis.vl.langchain4j.RedisVLChatMemoryStore
-
Creates a new RedisVLChatMemoryStore with custom prefix and TTL.
- RedisVLChatMemoryStore.Builder - Class in com.redis.vl.langchain4j
-
Builder for RedisVLChatMemoryStore.
- RedisVLContentRetriever - Class in com.redis.vl.langchain4j
-
LangChain4J ContentRetriever implementation using RedisVL as the backend.
- RedisVLContentRetriever(RedisVLEmbeddingStore, EmbeddingModel) - Constructor for class com.redis.vl.langchain4j.RedisVLContentRetriever
-
Creates a new RedisVLContentRetriever.
- RedisVLContentRetriever(RedisVLEmbeddingStore, EmbeddingModel, int, double) - Constructor for class com.redis.vl.langchain4j.RedisVLContentRetriever
-
Creates a new RedisVLContentRetriever with custom parameters.
- RedisVLContentRetriever.Builder - Class in com.redis.vl.langchain4j
-
Builder for RedisVLContentRetriever.
- RedisVLDocumentStore - Class in com.redis.vl.langchain4j
-
RedisVL Document Store for storing raw binary content (images, PDFs, etc.) for multimodal RAG.
- RedisVLDocumentStore(UnifiedJedis) - Constructor for class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Creates a new RedisVLDocumentStore with default prefix.
- RedisVLDocumentStore(UnifiedJedis, String) - Constructor for class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Creates a new RedisVLDocumentStore with custom prefix.
- RedisVLDocumentStore.Builder - Class in com.redis.vl.langchain4j
-
Builder for RedisVLDocumentStore.
- RedisVLDocumentStore.Document - Record Class in com.redis.vl.langchain4j
-
Represents a document with content and metadata.
- RedisVLEmbeddingStore - Class in com.redis.vl.langchain4j
-
LangChain4J EmbeddingStore implementation using RedisVL as the backend.
- RedisVLEmbeddingStore(SearchIndex) - Constructor for class com.redis.vl.langchain4j.RedisVLEmbeddingStore
-
Creates a new RedisVLEmbeddingStore with default field names.
- RedisVLEmbeddingStore(SearchIndex, String, String, String) - Constructor for class com.redis.vl.langchain4j.RedisVLEmbeddingStore
-
Creates a new RedisVLEmbeddingStore with custom field names.
- RedisVLException - Exception Class in com.redis.vl.exceptions
-
Base exception for RedisVL operations
- RedisVLException(String) - Constructor for exception class com.redis.vl.exceptions.RedisVLException
-
Constructs a new RedisVLException with the specified detail message.
- RedisVLException(String, Throwable) - Constructor for exception class com.redis.vl.exceptions.RedisVLException
-
Constructs a new RedisVLException with the specified detail message and cause.
- reduce(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the dimensionality reduction factor for LeanVec compression.
- ReducerFunction - Enum Class in com.redis.vl.query
-
Enumeration of available reducer functions for Redis aggregation operations.
- references(List<String>) - Method in class com.redis.vl.extensions.router.Route.RouteBuilder
-
Set the references list with a mutable copy.
- registerFailure(String, String) - Method in class com.redis.vl.test.vcr.VCRRegistry
-
Registers a failed test recording.
- registerSuccess(String, List<String>) - Method in class com.redis.vl.test.vcr.VCRRegistry
-
Registers a successful test recording.
- removeAll() - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- removeAll(Filter) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- removeAll(Collection<String>) - Method in class com.redis.vl.langchain4j.RedisVLEmbeddingStore
- removeField(String) - Method in class com.redis.vl.schema.IndexSchema
-
Remove a field by name
- RerankResult - Class in com.redis.vl.utils.rerank
-
Result from a reranking operation containing reranked documents and optional scores.
- RerankResult(List<?>, List<Double>) - Constructor for class com.redis.vl.utils.rerank.RerankResult
-
Create a rerank result with documents and scores.
- resetCallCounter() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Resets the call counter.
- resetCallCounter() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Resets the call counter (call at start of each test).
- resetCallCounter() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Resets the call counter (call at start of each test).
- resetCallCounter() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Resets the call counter.
- resetCallCounter() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Resets the call counter (call at start of each test).
- resetCallCounters() - Method in class com.redis.vl.test.vcr.VCRContext
-
Resets call counters for a new test.
- resetStatistics() - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Reset statistics counters.
- resetStatistics() - Method in class com.redis.vl.test.vcr.VCRChatModel
-
Resets all statistics.
- resetStatistics() - Method in class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Resets statistics.
- resetStatistics() - Method in class com.redis.vl.test.vcr.VCREmbeddingModel
-
Resets statistics.
- resetStatistics() - Method in class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Resets all statistics.
- resetStatistics() - Method in class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Resets statistics.
- RESPONSE_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- RESPONSE_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for response text in cache.
- results - Variable in class com.redis.vl.utils.vectorize.BaseVectorizer.BatchCacheResult
-
The results list with nulls for cache misses.
- retrieve(Query) - Method in class com.redis.vl.langchain4j.RedisVLContentRetriever
- retrieve(String) - Method in class com.redis.vl.langchain4j.RedisVLDocumentStore
-
Retrieves a document by ID.
- retrieve(String) - Method in class com.redis.vl.test.vcr.VCRCassetteStore
-
Retrieves a cassette from Redis.
- returnDistance(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set whether to return distance values
- returnFields(String...) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the fields to return in results (varargs).
- returnFields(String...) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the fields to return in results
- returnFields(String...) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the fields to return in results (varargs).
- returnFields(List<String>) - Method in class com.redis.vl.query.FilterQuery.FilterQueryBuilder
-
Set return fields.
- returnFields(List<String>) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the fields to return in results.
- returnFields(List<String>) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the fields to return in results (list).
- returnFields(List<String>) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the fields to return in results
- returnFields(List<String>) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the fields to return in results (list).
- returnScore - Variable in class com.redis.vl.utils.rerank.BaseReranker
-
Whether to include relevance scores in results.
- returnScore(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set whether to return similarity scores
- returnScore(boolean) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set whether to return scores with results.
- returnScore(boolean) - Method in class com.redis.vl.utils.rerank.HFCrossEncoderReranker.Builder
-
Set whether to return scores with results.
- ROLE_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- ROLE_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for message role (e.g., user, assistant, system).
- route(String) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Route a query to the best matching route.
- route(String, float[], DistanceAggregationMethod) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Route a query to the best matching route with full control.
- Route - Class in com.redis.vl.extensions.router
-
Model representing a routing path with associated metadata and thresholds.
- Route() - Constructor for class com.redis.vl.extensions.router.Route
- ROUTE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- ROUTE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for route vector in semantic router.
- ROUTE_VECTOR_FIELD_NAME - Static variable in class com.redis.vl.extensions.router.SemanticRouterIndexSchema
-
Constant for route vector field name
- Route.RouteBuilder - Class in com.redis.vl.extensions.router
-
Custom builder to ensure references list is mutable.
- RouteBuilder() - Constructor for class com.redis.vl.extensions.router.Route.RouteBuilder
- routeMany(String) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Route a query to multiple matching routes.
- routeMany(String, Integer, float[], DistanceAggregationMethod) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Route a query to multiple matching routes with full control.
- RouteMatch - Class in com.redis.vl.extensions.router
-
Model representing a matched route with distance information.
- RouteMatch() - Constructor for class com.redis.vl.extensions.router.RouteMatch
- routes(List<Route>) - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Set the routes.
- routingConfig(RoutingConfig) - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Set the routing configuration.
- RoutingConfig - Class in com.redis.vl.extensions.router
-
Configuration for routing behavior.
- RoutingConfig() - Constructor for class com.redis.vl.extensions.router.RoutingConfig
- runInference(OrtSession, long[][], long[][], long[][]) - Method in class com.redis.vl.utils.rerank.CrossEncoderLoader
-
Run inference to get relevance score.
- runInference(OrtSession, OnnxTensor) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Run inference on the model with tokenized input.
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.
T
- tag(String, String...) - Static method in class com.redis.vl.query.Filter
-
Create a tag filter
- TAG - Enum constant in enum class com.redis.vl.schema.FieldType
-
Tag field for exact matching
- TagField - Class in com.redis.vl.schema
-
TagField represents an exact-match field in Redis.
- TagField(String) - Constructor for class com.redis.vl.schema.TagField
-
Create a TagField with just a name
- TagField.TagFieldBuilder - Class in com.redis.vl.schema
-
Fluent builder for TagField
- tagLike(String, String...) - Static method in class com.redis.vl.query.Filter
-
Create a tag wildcard filter for pattern matching.
- tagNot(String, String...) - Static method in class com.redis.vl.query.Filter
-
Create a negated tag filter (tag != value)
- testFailed(ExtensionContext, Throwable) - Method in class com.redis.vl.test.vcr.VCRExtension
- testSuccessful(ExtensionContext) - Method in class com.redis.vl.test.vcr.VCRExtension
- text(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the text query string.
- text(String) - Method in class com.redis.vl.query.TextQuery.Builder
-
Set the text to search for.
- text(String, String) - Static method in class com.redis.vl.query.Filter
-
Create a text search filter
- TEXT - Enum constant in enum class com.redis.vl.schema.FieldType
-
Text field for full-text search
- TEXT_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- TEXT_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for text in embeddings cache.
- textField(String) - Method in class com.redis.vl.query.TextQuery.Builder
-
Set a single text field to search (backward compatible).
- TextField - Class in com.redis.vl.schema
-
TextField represents a full-text searchable field in Redis.
- TextField(String) - Constructor for class com.redis.vl.schema.TextField
-
Create a TextField with just a name
- TextField.TextFieldBuilder - Class in com.redis.vl.schema
-
Fluent builder for TextField
- textFieldName(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the name of the text field to search.
- textFieldWeights(Map<String, Double>) - Method in class com.redis.vl.query.TextQuery.Builder
-
Set multiple text fields with weights.
- textNot(String, String) - Static method in class com.redis.vl.query.Filter
-
Create a negated text filter (text != value)
- TextQuery - Class in com.redis.vl.query
-
Full-text search query with support for field weights and sorting.
- TextQuery.Builder - Class in com.redis.vl.query
-
Builder for TextQuery with support for field weights and sorting.
- textScorer(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the scoring algorithm for text search.
- timestamp(String) - Static method in class com.redis.vl.query.Filter
-
Create a timestamp filter builder
- TIMESTAMP_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- TIMESTAMP_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for message timestamp.
- toDict() - Method in class com.redis.vl.extensions.messagehistory.ChatMessage
-
Converts the ChatMessage to a Map suitable for storing in Redis.
- toDict() - Method in class com.redis.vl.extensions.messagehistory.SemanticChatMessage
-
Converts the SemanticChatMessage to a Map using default float32 dtype.
- toDict() - Method in class com.redis.vl.extensions.router.Route
-
Convert route to a map for JSON serialization.
- toDict() - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Convert router to dictionary for JSON serialization.
- toDict(String) - Method in class com.redis.vl.extensions.messagehistory.SemanticChatMessage
-
Converts the SemanticChatMessage to a Map suitable for storing in Redis.
- toJedisFieldName() - Method in class com.redis.vl.schema.BaseField
-
Convert to Jedis FieldName for query building.
- toJedisSchemaField() - Method in class com.redis.vl.schema.BaseField
-
Convert to Jedis SchemaField for index creation.
- toJedisSchemaField() - Method in class com.redis.vl.schema.GeoField
- toJedisSchemaField() - Method in class com.redis.vl.schema.NumericField
- toJedisSchemaField() - Method in class com.redis.vl.schema.TagField
- toJedisSchemaField() - Method in class com.redis.vl.schema.TextField
- toJedisSchemaField() - Method in class com.redis.vl.schema.VectorField
- toJson() - Method in class com.redis.vl.extensions.router.Route
-
Convert route to JSON string.
- toJson() - Method in class com.redis.vl.schema.BaseField
-
Serialize this field to JSON.
- toJson() - Method in class com.redis.vl.schema.IndexSchema
-
Serialize to JSON
- TokenEscaper - Class in com.redis.vl.utils
-
Escape punctuation within an input string.
- TokenEscaper() - Constructor for class com.redis.vl.utils.TokenEscaper
-
Default constructor using default escaped characters.
- TokenEscaper(Pattern) - Constructor for class com.redis.vl.utils.TokenEscaper
-
Constructor with custom escape pattern.
- tokenize(String) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Tokenize a single text string.
- tokenizeAndEscapeQuery(String) - Method in class com.redis.vl.query.HybridQuery
-
Tokenize and escape the user query.
- tokenizeBatch(List<String>) - Method in class com.redis.vl.utils.vectorize.OnnxModelLoader
-
Tokenize a batch of text strings.
- tokenizePair(String, String) - Method in class com.redis.vl.utils.rerank.CrossEncoderLoader
-
Tokenize a query-document pair for cross-encoder input.
- TOLIST - Enum constant in enum class com.redis.vl.query.ReducerFunction
-
REDUCE TOLIST 1 {property} - Merge all distinct values of a given property into a single array.
- toMap() - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Convert the SemanticRouter to a Map representation.
- TOOL_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- TOOL_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for tool call ID.
- toParams() - Method in class com.redis.vl.query.MultiVectorQuery
-
Convert to parameter map for query execution.
- toParams() - Method in class com.redis.vl.query.VectorQuery
-
Convert to parameter map for query execution
- toParams() - Method in class com.redis.vl.query.VectorRangeQuery
-
Convert to parameter map for query execution
- toQueryString() - Method in class com.redis.vl.query.MultiVectorQuery
-
Build the Redis query string for multi-vector search.
- toQueryString() - Method in class com.redis.vl.query.TextQuery
-
Build the Redis query string for text search with weighted fields.
- toQueryString() - Method in class com.redis.vl.query.VectorQuery
-
Build the query string for Redis
- toQueryString() - Method in class com.redis.vl.query.VectorRangeQuery
-
Build the query string for Redis range query
- toString() - Method in class com.redis.vl.extensions.cache.CacheHit
- toString() - Method in record class com.redis.vl.langchain4j.RedisVLDocumentStore.Document
-
Returns a string representation of this record class.
- toString() - Method in class com.redis.vl.query.CountQuery
- toString() - Method in class com.redis.vl.query.MultiVectorQuery
- toString() - Method in class com.redis.vl.query.TextQuery
- toString() - Method in class com.redis.vl.query.Vector
- toString() - Method in class com.redis.vl.query.VectorQuery
- toString() - Method in class com.redis.vl.query.VectorRangeQuery
- toString() - Method in class com.redis.vl.schema.BaseField
- toString() - Method in enum class com.redis.vl.schema.StorageType
- toString() - Method in class com.redis.vl.utils.rerank.RerankResult
- toYaml() - Method in class com.redis.vl.schema.IndexSchema
-
Serialize to YAML
- trainingThreshold(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the training threshold for SVS-VAMANA compression.
- ttl - Variable in class com.redis.vl.extensions.cache.BaseCache
-
Default time-to-live in seconds for cache entries.
- ttl(Integer) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set the TTL for cache entries
- ttl(Integer) - Method in class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Set the TTL for cache entries
- ttlSeconds(Integer) - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore.Builder
-
Sets the TTL for conversation history.
U
- UINT8 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType
-
8-bit unsigned integer
- unf() - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Use un-normalized form for sorting (equivalent to unf(true))
- unf() - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Use un-normalized form for sorting (equivalent to unf(true))
- unf(boolean) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Set whether to use un-normalized form for sorting
- unf(boolean) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set whether to use un-normalized form for sorting
- update(String, String) - Method in class com.redis.vl.extensions.cache.SemanticCache
-
Update an existing cache entry.
- update(String, String, Object) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache
-
Update specific fields within an existing cache entry.
- UPDATED_AT_FIELD_NAME - Static variable in class com.redis.vl.extensions.Constants
- UPDATED_AT_FIELD_NAME - Static variable in class com.redis.vl.extensions.ExtensionConstants
-
Field name for cache update timestamp.
- updateDocument(String, Map<String, Object>) - Method in class com.redis.vl.index.SearchIndex
-
Update an existing document
- updateMessages(Object, List<ChatMessage>) - Method in class com.redis.vl.langchain4j.RedisVLChatMemoryStore
- updateRoutingConfig(RoutingConfig) - Method in class com.redis.vl.extensions.router.SemanticRouter
-
Update the routing configuration.
- updateTTL(String, String, int) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache
-
Update the TTL for an existing embedding.
- useExactSearch(boolean) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set whether to use exact search
- useSearchHistory(String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the use search history parameter for SVS-VAMANA algorithm.
- useSearchHistory(String) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the use search history parameter for SVS-VAMANA algorithm.
- useSemanticSearch(boolean) - Method in class com.redis.vl.extensions.cache.LangCacheSemanticCache.Builder
-
Set whether to use semantic search
- Utils - Class in com.redis.vl.utils
-
Utility methods for RedisVL.
V
- validate() - Method in class com.redis.vl.extensions.router.Route
-
Validate the route configuration.
- validate() - Method in class com.redis.vl.extensions.router.RoutingConfig
-
Validate the routing configuration.
- validate(Map<String, Object>) - Method in class com.redis.vl.storage.BaseStorage
-
Validate an object against the schema.
- validateDocs(List<?>) - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Validate documents parameter.
- validateQuery(String) - Method in class com.redis.vl.utils.rerank.BaseReranker
-
Validate query parameter.
- validateRoles(Object) - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
-
Validate and normalize role parameter for filtering messages.
- valueOf(String) - Static method in enum class com.redis.vl.extensions.router.DistanceAggregationMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.query.Filter.GeoUnit
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.query.ReducerFunction
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.FieldType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.IndexSchema.StorageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.StorageType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.VectorField.Algorithm
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.VectorField.CompressionType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.VectorField.DistanceMetric
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.schema.VectorField.VectorDataType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.test.vcr.VCRMode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class com.redis.vl.test.vcr.VCRRegistry.RecordingStatus
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class com.redis.vl.extensions.router.DistanceAggregationMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.query.Filter.GeoUnit
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.query.ReducerFunction
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.FieldType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.IndexSchema.StorageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.StorageType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.VectorField.Algorithm
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.VectorField.CompressionType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.VectorField.DistanceMetric
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.schema.VectorField.VectorDataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.test.vcr.VCRMode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class com.redis.vl.test.vcr.VCRRegistry.RecordingStatus
-
Returns an array containing the constants of this enum class, in the order they are declared.
- VCR_MODE_ENV - Static variable in class com.redis.vl.test.vcr.VCRContext
-
Environment variable name for overriding VCR mode.
- VCRCassetteMissingException - Exception Class in com.redis.vl.test.vcr
-
Exception thrown when a VCR cassette is not found during playback mode.
- VCRCassetteMissingException(String, String) - Constructor for exception class com.redis.vl.test.vcr.VCRCassetteMissingException
-
Creates a new exception.
- VCRCassetteStore - Class in com.redis.vl.test.vcr
-
Stores and retrieves VCR cassettes (recorded API responses) in Redis.
- VCRCassetteStore(UnifiedJedis) - Constructor for class com.redis.vl.test.vcr.VCRCassetteStore
-
Creates a new cassette store.
- VCRChatModel - Class in com.redis.vl.test.vcr
-
VCR wrapper for LangChain4J ChatLanguageModel that records and replays LLM responses.
- VCRChatModel(ChatLanguageModel) - Constructor for class com.redis.vl.test.vcr.VCRChatModel
-
Creates a new VCRChatModel wrapping the given delegate.
- VCRChatModel(ChatLanguageModel, VCRCassetteStore) - Constructor for class com.redis.vl.test.vcr.VCRChatModel
-
Creates a new VCRChatModel wrapping the given delegate with Redis storage.
- VCRContext - Class in com.redis.vl.test.vcr
-
Manages VCR state and resources throughout a test session.
- VCRContext(VCRTest) - Constructor for class com.redis.vl.test.vcr.VCRContext
-
Creates a new VCR context with the given configuration.
- VCRDisabled - Annotation Interface in com.redis.vl.test.vcr
-
Disables VCR functionality for a specific test method.
- VCREmbeddingInterceptor - Class in com.redis.vl.test.vcr
-
Intercepts embedding calls for VCR recording and playback.
- VCREmbeddingInterceptor() - Constructor for class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Creates a new interceptor without Redis (for unit testing).
- VCREmbeddingInterceptor(VCRCassetteStore) - Constructor for class com.redis.vl.test.vcr.VCREmbeddingInterceptor
-
Creates a new interceptor with Redis cassette storage.
- VCREmbeddingModel - Class in com.redis.vl.test.vcr
-
VCR-enabled wrapper around a LangChain4J EmbeddingModel.
- VCREmbeddingModel(EmbeddingModel) - Constructor for class com.redis.vl.test.vcr.VCREmbeddingModel
-
Creates a VCR-enabled embedding model wrapper.
- VCREmbeddingModel(EmbeddingModel, VCRCassetteStore) - Constructor for class com.redis.vl.test.vcr.VCREmbeddingModel
-
Creates a VCR-enabled embedding model wrapper with Redis storage.
- VCRExtension - Class in com.redis.vl.test.vcr
-
JUnit 5 extension that provides VCR (Video Cassette Recorder) functionality for recording and playing back LLM API calls during tests.
- VCRExtension() - Constructor for class com.redis.vl.test.vcr.VCRExtension
- VCRMode - Enum Class in com.redis.vl.test.vcr
-
VCR operating modes that determine how LLM calls are handled during tests.
- VCRModel - Annotation Interface in com.redis.vl.test.vcr
-
Marks a field to be automatically wrapped with VCR recording/playback functionality.
- VCRModelWrapper - Class in com.redis.vl.test.vcr
-
Utility class for wrapping model instances with VCR interceptors.
- VCRRecord - Annotation Interface in com.redis.vl.test.vcr
-
Forces a specific test method to use RECORD mode, overriding the class-level VCR mode.
- VCRRegistry - Class in com.redis.vl.test.vcr
-
Tracks which tests have been recorded and their status.
- VCRRegistry(UnifiedJedis) - Constructor for class com.redis.vl.test.vcr.VCRRegistry
-
Creates a new VCR registry.
- VCRRegistry.RecordingStatus - Enum Class in com.redis.vl.test.vcr
-
Recording status for a test.
- VCRSpringAIChatModel - Class in com.redis.vl.test.vcr
-
VCR wrapper for Spring AI ChatModel that records and replays LLM responses.
- VCRSpringAIChatModel(ChatModel) - Constructor for class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Creates a new VCRSpringAIChatModel wrapping the given delegate.
- VCRSpringAIChatModel(ChatModel, VCRCassetteStore) - Constructor for class com.redis.vl.test.vcr.VCRSpringAIChatModel
-
Creates a new VCRSpringAIChatModel wrapping the given delegate with Redis storage.
- VCRSpringAIEmbeddingModel - Class in com.redis.vl.test.vcr
-
VCR-enabled wrapper around a Spring AI EmbeddingModel.
- VCRSpringAIEmbeddingModel(EmbeddingModel) - Constructor for class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Creates a VCR-enabled embedding model wrapper.
- VCRSpringAIEmbeddingModel(EmbeddingModel, VCRCassetteStore) - Constructor for class com.redis.vl.test.vcr.VCRSpringAIEmbeddingModel
-
Creates a VCR-enabled embedding model wrapper with Redis storage.
- VCRTest - Annotation Interface in com.redis.vl.test.vcr
-
Enables VCR (Video Cassette Recorder) functionality for a test class.
- vector(double[]) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the query vector
- vector(float[]) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the query vector for similarity search.
- vector(float[]) - Method in class com.redis.vl.query.Vector.Builder
-
Set the query vector.
- vector(float[]) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the query vector
- vector(float[]) - Method in class com.redis.vl.query.VectorRangeQuery.Builder
-
Set the query vector.
- vector(Vector) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the vectors to search (accepts a single Vector).
- Vector - Class in com.redis.vl.query
-
Simple object containing the necessary arguments to perform a multi-vector query.
- VECTOR - Enum constant in enum class com.redis.vl.schema.FieldType
-
Vector field for similarity search
- Vector.Builder - Class in com.redis.vl.query
-
Builder for creating Vector instances.
- VectorField - Class in com.redis.vl.schema
-
VectorField represents a vector field in Redis for similarity search.
- VectorField(String, int) - Constructor for class com.redis.vl.schema.VectorField
-
Create a VectorField with name and dimensions (defaults to FLAT algorithm, COSINE distance)
- VectorField.Algorithm - Enum Class in com.redis.vl.schema
-
Vector indexing algorithms
- VectorField.CompressionType - Enum Class in com.redis.vl.schema
-
Vector compression types for SVS-VAMANA algorithm.
- VectorField.DistanceMetric - Enum Class in com.redis.vl.schema
-
Distance metrics for vector similarity
- VectorField.VectorDataType - Enum Class in com.redis.vl.schema
-
Vector data types
- VectorField.VectorFieldBuilder - Class in com.redis.vl.schema
-
Fluent builder for VectorField
- vectorFieldName(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder
-
Set the name of the vector field to search.
- vectorizer(BaseVectorizer) - Method in class com.redis.vl.extensions.cache.SemanticCache.Builder
-
Set the vectorizer
- vectorizer(BaseVectorizer) - Method in class com.redis.vl.extensions.router.SemanticRouter.SemanticRouterBuilder
-
Set the vectorizer.
- VectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Factory class for creating vectorizers with common providers.
- VectorizerBuilder.AbstractVectorizerBuilder<T> - Class in com.redis.vl.utils.vectorize
-
Abstract base builder for all vectorizer builders.
- VectorizerBuilder.AzureOpenAIVectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Builder for Azure OpenAI embedding vectorizers.
- VectorizerBuilder.CustomVectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Builder for custom LangChain4J embedding vectorizers.
- VectorizerBuilder.HuggingFaceVectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Builder for HuggingFace embedding vectorizers.
- VectorizerBuilder.LocalVectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Builder for local ONNX embedding vectorizers.
- VectorizerBuilder.OllamaVectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Builder for Ollama embedding vectorizers.
- VectorizerBuilder.OpenAIVectorizerBuilder - Class in com.redis.vl.utils.vectorize
-
Builder for OpenAI embedding vectorizers.
- VectorQuery - Class in com.redis.vl.query
-
Represents a vector similarity search query
- VectorQuery.Builder - Class in com.redis.vl.query
-
Builder for VectorQuery
- VectorRangeQuery - Class in com.redis.vl.query
-
Vector range query for finding vectors within a distance threshold.
- VectorRangeQuery.Builder - Class in com.redis.vl.query
-
Builder for creating VectorRangeQuery instances.
- vectors(Vector...) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the vectors to search (accepts multiple Vectors as varargs).
- vectors(List<Vector>) - Method in class com.redis.vl.query.MultiVectorQuery.Builder
-
Set the vectors to search (accepts a List of Vectors).
- VoyageAIReranker - Class in com.redis.vl.utils.rerank
-
Reranker that uses VoyageAI's Rerank API to rerank documents based on query relevance.
W
- weight(double) - Method in class com.redis.vl.query.Vector.Builder
-
Set the weight for this vector in multi-vector scoring.
- weight(double) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the weight for scoring in full-text search
- wildcard(String, String) - Static method in class com.redis.vl.query.Filter
-
Create a wildcard filter
- withAlgorithm(VectorField.VectorAlgorithm) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the vector indexing algorithm (alternative method)
- withAlias(String) - Method in class com.redis.vl.schema.GeoField.GeoFieldBuilder
-
Set the field alias (alternative method name).
- withAlias(String) - Method in class com.redis.vl.schema.NumericField.NumericFieldBuilder
-
Set the field alias (alias for alias() method).
- withAlias(String) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set the field alias (alternative method)
- withAlias(String) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the field alias (alternative method)
- withAlias(String) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the field alias (alternative method)
- withCache(EmbeddingsCache) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Set the embeddings cache to use.
- withDataType(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Set the data type for embeddings.
- withDimensions(int) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder
-
Set the expected dimensions (optional - will auto-detect if not specified).
- withDistanceMetric(VectorField.DistanceMetric) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the distance metric (alternative method)
- withDistanceMetric(VectorField.DistanceMetric) - Method in class com.redis.vl.query.VectorQuery
-
Create a copy with modified distance metric
- withDistanceMetric(VectorField.DistanceMetric) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the distance metric (alternative method)
- withEfRuntime(int) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the EF runtime parameter for HNSW (alternative method)
- withHnswEfConstruction(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the EF_CONSTRUCTION parameter for HNSW algorithm (alternative method)
- withHnswM(int) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder
-
Set the M parameter for HNSW algorithm (alternative method)
- withHybridSearch(String, String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set hybrid search parameters
- withK(int) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Deprecated.Use numResults() instead
- withK(int) - Method in class com.redis.vl.query.VectorQuery
-
Deprecated.Use withNumResults() instead
- withNumResults(int) - Method in class com.redis.vl.query.VectorQuery
-
Create a copy with modified numResults value
- withPhonetic(String) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the phonetic matcher (alternative method)
- withPreFilter(String) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set the pre-filter expression (alternative method)
- withPreFilter(String) - Method in class com.redis.vl.query.VectorQuery
-
Create a copy with modified pre-filter
- withPrefix(String) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Set the key prefix (alias for prefix)
- withReturnDistance(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set whether to return distance values (alternative method)
- withReturnScore(boolean) - Method in class com.redis.vl.query.VectorQuery.Builder
-
Set whether to return similarity scores (alternative method)
- withSeparator(String) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder
-
Set the separator for multi-value tags (alternative method)
- withStorageType(IndexSchema.StorageType) - Method in class com.redis.vl.schema.IndexSchema.Builder
-
Set the storage type (alias for storageType)
- withWeight(double) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder
-
Set the weight for scoring in full-text search (alternative method)
- wrapField(Object, Field, String, VCRMode, String, VCRCassetteStore) - Static method in class com.redis.vl.test.vcr.VCRModelWrapper
-
Wraps a model field with the appropriate VCR interceptor.
- wrapModel(Object, String, VCRMode, String, VCRCassetteStore) - Static method in class com.redis.vl.test.vcr.VCRModelWrapper
-
Wraps a model with the appropriate VCR interceptor based on its type.
- write(UnifiedJedis, List<Map<String, Object>>) - Method in class com.redis.vl.storage.BaseStorage
-
Write a batch of objects to Redis with default parameters.
- write(UnifiedJedis, List<Map<String, Object>>, String, List<String>) - Method in class com.redis.vl.storage.BaseStorage
-
Write with id field.
- write(UnifiedJedis, List<Map<String, Object>>, String, List<String>, Integer) - Method in class com.redis.vl.storage.BaseStorage
-
Write with TTL.
- write(UnifiedJedis, List<Map<String, Object>>, String, List<String>, Integer, Integer) - Method in class com.redis.vl.storage.BaseStorage
-
Write with batch size.
- write(UnifiedJedis, List<Map<String, Object>>, String, List<String>, Integer, Integer, Function<Map<String, Object>, Map<String, Object>>) - Method in class com.redis.vl.storage.BaseStorage
-
Write with preprocessing.
- write(UnifiedJedis, List<Map<String, Object>>, String, List<String>, Integer, Integer, Function<Map<String, Object>, Map<String, Object>>, boolean) - Method in class com.redis.vl.storage.BaseStorage
-
Write a batch of objects to Redis.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form