Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
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.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form