Index (core 0.0.1 API)

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

A

AbstractVectorizerBuilder(String) - Constructor for class com.redis.vl.utils.vectorize.VectorizerBuilder.AbstractVectorizerBuilder: Protected constructor for subclasses.
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>, 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
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>>, 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
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.
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
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.
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.
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.
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.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.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.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.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.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() - Constructor for class com.redis.vl.extensions.cache.SemanticCache.Builder: Create a new Builder instance
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.
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.
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.
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.
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.
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.
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.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.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.index - package com.redis.vl.index
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.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
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.
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
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
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

dataType(VectorField.VectorDataType) - Method in class com.redis.vl.schema.VectorField.VectorFieldBuilder: Set the data type
defaultBatchSize - Variable in class com.redis.vl.storage.BaseStorage: Default batch size for bulk operations.
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.router.SemanticRouter: Delete the semantic router index from Redis.
delete(boolean) - Method in class com.redis.vl.index.SearchIndex: Delete the index
deleteDocument(String) - Method in class com.redis.vl.index.SearchIndex: Delete a document from the index
deleteRouteReferences(String, List<String>, List<String>) - Method in class com.redis.vl.extensions.router.SemanticRouter: Delete references from an existing route.
deploymentName(String) - Method in class com.redis.vl.utils.vectorize.VectorizerBuilder.AzureOpenAIVectorizerBuilder: Set the Azure deployment name.
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.
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(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
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
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, 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.

E

efRuntime(Integer) - Method in class com.redis.vl.query.VectorQuery.Builder: Set the EF runtime parameter for HNSW
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.
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.
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.
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.
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 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
execute(Function<Jedis, T>) - Method in class com.redis.vl.redis.RedisConnectionManager: Execute a command with a Jedis connection.
executeVoid(Consumer<Jedis>) - 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, 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.

F

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.
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.
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.
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 vector indexing
FLOAT32 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType: 32-bit floating point
FLOAT64 - Enum constant in enum class com.redis.vl.schema.VectorField.VectorDataType: 64-bit floating point
floatArrayToBytes(float[]) - Static method in class com.redis.vl.utils.ArrayUtils: Convert float array to byte array using little-endian byte order.
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.
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.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.
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.
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

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
getAlpha() - Method in class com.redis.vl.query.HybridQuery: Get the alpha weighting factor.
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.
getDataType() - Method in class com.redis.vl.utils.vectorize.BaseVectorizer: Get the vector data type.
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.
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.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.
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
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.
getFilterExpression() - Method in class com.redis.vl.query.TextQuery: 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.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.redis.RedisConnectionManager: Get a Jedis connection from the pool.
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
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
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.
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.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.
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
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.BaseMessageHistory: Retrieve the recent conversation history in sequential order.
getRecent(int, boolean, boolean, String) - Method in class com.redis.vl.extensions.messagehistory.MessageHistory
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(Pipeline, String) - Method in class com.redis.vl.storage.BaseStorage: Get a response for retrieving a value from Redis using a pipeline.
getResponse(Pipeline, String) - Method in class com.redis.vl.storage.HashStorage
getResponse(Pipeline, 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.TextQuery: Get 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.
getScorer() - Method in class com.redis.vl.query.TextQuery: Get the scoring algorithm
getScores() - Method in class com.redis.vl.utils.rerank.RerankResult: Get the relevance scores for each document.
getSessionTag() - Method in class com.redis.vl.extensions.messagehistory.BaseMessageHistory
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.
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
getText() - Method in class com.redis.vl.query.HybridQuery: Get the text query string.
getText() - Method in class com.redis.vl.query.TextQuery: Get the search text
getTextField() - Method in class com.redis.vl.query.TextQuery: Get the text field to search in
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.
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
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.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.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.
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 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 vector indexing
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
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(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
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
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.
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.
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.
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.
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
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
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.
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.
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.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.

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.
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.
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_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.
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.
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.
mset(Map<String, float[]>, String) - Method in class com.redis.vl.extensions.cache.EmbeddingsCache: Store multiple embeddings in batch.

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.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.
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
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.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
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.
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.
phonetic(String) - Method in class com.redis.vl.schema.TextField.TextFieldBuilder: Set the phonetic matcher
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
prefix(String, String) - Static method in class com.redis.vl.query.Filter: Create a prefix filter
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.
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).
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 and provides connection pooling.
RedisConnectionManager(RedisConnectionConfig) - Constructor for class com.redis.vl.redis.RedisConnectionManager: Create a new connection manager with the given configuration.
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.
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.
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.
resetStatistics() - Method in class com.redis.vl.extensions.cache.SemanticCache: Reset statistics counters.
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.
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.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.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

search(VectorQuery) - Method in class com.redis.vl.index.SearchIndex: Search the index using a VectorQuery
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
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, Jedis) - Constructor for class com.redis.vl.index.SearchIndex: Create a SearchIndex with schema and Jedis client
SearchIndex(IndexSchema, Jedis, boolean) - Constructor for class com.redis.vl.index.SearchIndex: Create a SearchIndex with schema, Jedis client, 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
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.
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.
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.
separator(String) - Method in class com.redis.vl.schema.TagField.TagFieldBuilder: Set the separator for multi-value tags
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(Pipeline, String, Map<String, Object>) - Method in class com.redis.vl.storage.BaseStorage: Set a key-value pair in Redis using a pipeline.
set(Pipeline, String, Map<String, Object>) - Method in class com.redis.vl.storage.HashStorage
set(Pipeline, 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.
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.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.
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.
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
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
setStorageType(IndexSchema.StorageType) - Method in class com.redis.vl.schema.IndexSchema.Index: Set the storage type
setTtl(Integer) - Method in class com.redis.vl.extensions.cache.BaseCache: Set the default TTL for cache entries.
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.
size() - Method in class com.redis.vl.extensions.cache.BaseCache: Get the number of entries in the cache.
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(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.VectorQuery.Builder: Set the sort field
sortBy(String) - Method in class com.redis.vl.query.VectorRangeQuery.Builder: Set the field name to sort results by.
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.
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(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, 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, 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, Map<String, Object>) - Method in class com.redis.vl.extensions.cache.SemanticCache: Store a prompt-response pair with metadata.
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.

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
tagNot(String, String...) - Static method in class com.redis.vl.query.Filter: Create a negated tag filter (tag != value)
text(String) - Method in class com.redis.vl.query.HybridQuery.HybridQueryBuilder: Set the text query string.
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 - 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.
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
TextQuery(String, String, String, Filter, List<String>) - Constructor for class com.redis.vl.query.TextQuery: Create a text query with all parameters.
TextQuery(String, String, String, List<String>) - Constructor for class com.redis.vl.query.TextQuery: Create a text query without a filter expression.
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.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.
toJedisFieldName() - Method in class com.redis.vl.schema.BaseField: Convert to Jedis FieldName for query building.
toJedisPoolConfig() - Method in class com.redis.vl.redis.RedisConnectionConfig: Create a JedisPoolConfig from this configuration.
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.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.TextQuery: Build the query string for Redis text search
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 class com.redis.vl.query.CountQuery
toString() - Method in class com.redis.vl.query.TextQuery
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
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.SemanticCache.Builder: Set the TTL for cache entries

U

update(String, String) - Method in class com.redis.vl.extensions.cache.SemanticCache: Update 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
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.
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.
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.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.
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.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.
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.VectorQuery.Builder: Set the query vector
vector(float[]) - Method in class com.redis.vl.query.VectorRangeQuery.Builder: Set the query vector.
VECTOR - Enum constant in enum class com.redis.vl.schema.FieldType: Vector field for similarity search
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.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.
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.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)
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.

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