RedisVL API on Docs

Filter

Mon, 01 Jan 0001 00:00:00 +0000

FilterExpression

`class FilterExpression(_filter=None, operator=None, left=None, right=None)`

A FilterExpression is a logical combination of filters in RedisVL.

LLM Cache

Mon, 01 Jan 0001 00:00:00 +0000

SemanticCache

LLM Message History

Mon, 01 Jan 0001 00:00:00 +0000

SemanticMessageHistory

Query

Mon, 01 Jan 0001 00:00:00 +0000

Query classes in RedisVL provide a structured way to define simple or complex queries for different use cases. Each query class wraps the redis-py Query module https://github.com/redis/redis-py/blob/master/redis/commands/search/query.py with extended functionality for ease-of-use.

VectorQuery

`class VectorQuery(vector, vector_field_name, return_fields=None, filter_expression=None, dtype='float32', num_results=10, return_score=True, dialect=2, sort_by=None, in_order=False, hybrid_policy=None, batch_size=None, ef_runtime=None, epsilon=None, search_window_size=None, use_search_history=None, search_buffer_capacity=None, normalize_vector_distance=False)`

Bases: BaseVectorQuery, BaseQuery

Rerankers

Mon, 01 Jan 0001 00:00:00 +0000

CohereReranker

Schema

Mon, 01 Jan 0001 00:00:00 +0000

Schema in RedisVL provides a structured format to define index settings and field configurations using the following three components:

Component	Description
version	The version of the schema spec. Current supported version is 0.1.0.
index	Index specific settings like name, key prefix, key separator, and storage type.
fields	Subset of fields within your data to include in the index and any custom settings.

IndexSchema

Search Index Classes

Mon, 01 Jan 0001 00:00:00 +0000

Class	Description
SearchIndex	Primary class to write, read, and search across data structures in Redis.
AsyncSearchIndex	Async version of the SearchIndex to write, read, and search across data structures in Redis.

SearchIndex

`class SearchIndex(schema, redis_client=None, redis_url=None, connection_kwargs=None, validate_on_load=False, **kwargs)`

A search index class for interacting with Redis as a vector database.

Semantic Router

Mon, 01 Jan 0001 00:00:00 +0000

Semantic Router

`class SemanticRouter(name, routes, vectorizer=None, routing_config=None, redis_client=None, redis_url='redis://localhost:6379', overwrite=False, connection_kwargs={})`

Semantic Router for managing and querying route vectors.

Vector

Mon, 01 Jan 0001 00:00:00 +0000

The Vector class in RedisVL is a container that encapsulates a numerical vector, it’s datatype, corresponding index field name, and optional importance weight. It is used when constructing multi-vector queries using the MultiVectorQuery class.

Vector

`class Vector(*, vector, field_name, dtype='float32', weight=1.0)`

Simple object containing the necessary arguments to perform a multi vector query.

Vectorizers

Mon, 01 Jan 0001 00:00:00 +0000

`NOTE`

Backwards Compatibility: Several vectorizers have deprecated aliases available in the redisvl.utils.vectorize.text module for backwards compatibility: