Redis#

class langchain_community.vectorstores.redis.base.Redis(redis_url: str, index_name: str, embedding: Embeddings, index_schema: Dict[str, List[Dict[str, str]]] | str | PathLike | None = None, vector_schema: Dict[str, str | int] | None = None, relevance_score_fn: Callable[[float], float] | None = None, key_prefix: str | None = None, **kwargs: Any)[source]#

Redis vector database.

Deployment Options:

Below, we will use a local deployment as an example. However, Redis can be deployed in all of the following ways:

[Redis Cloud](https://redis.com/redis-enterprise-cloud/overview/)
[Docker (Redis Stack)](https://hub.docker.com/r/redis/redis-stack)
Cloud marketplaces: [AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-e6y7ork67pjwg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa), [Google Marketplace](https://console.cloud.google.com/marketplace/details/redislabs-public/redis-enterprise?pli=1), or [Azure Marketplace](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/garantiadata.redis_enterprise_1sp_public_preview?tab=Overview)
On-premise: [Redis Enterprise Software](https://redis.com/redis-enterprise-software/overview/)
Kubernetes: [Redis Enterprise Software on Kubernetes](https://docs.redis.com/latest/kubernetes/)

Setup:

Install redis, redisvl, and langchain-community and run Redis locally.

pip install -qU redis redisvl langchain-community
docker run -d -p 6379:6379 -p 8001:8001 redis/redis-stack:latest

Key init args — indexing params:

index_name: str: Name of the index.
index_schema: Optional[Union[Dict[str, ListOfDict], str, os.PathLike]]: Schema of the index and the vector schema. Can be a dict, or path to yaml file.
embedding: Embeddings: Embedding function to use.

Key init args — client params:

redis_url: str: Redis connection url.

Instantiate:

from langchain_community.vectorstores.redis import Redis
from langchain_openai import OpenAIEmbeddings

vector_store = Redis(
    redis_url="redis://localhost:6379",
    embedding=OpenAIEmbeddings(),
    index_name="users",
)

Add Documents:

from langchain_core.documents import Document

document_1 = Document(page_content="foo", metadata={"baz": "bar"})
document_2 = Document(page_content="thud", metadata={"bar": "baz"})
document_3 = Document(page_content="i will be deleted :(")

documents = [document_1, document_2, document_3]
ids = ["1", "2", "3"]
vector_store.add_documents(documents=documents, ids=ids)

Delete Documents:

vector_store.delete(ids=["3"])

Search:

results = vector_store.similarity_search(query="thud",k=1)
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'id': 'doc:users:2'}]

Search with filter:

from langchain_community.vectorstores.redis import RedisTag

results = vector_store.similarity_search(query="thud",k=1,filter=(RedisTag("baz") != "bar"))
for doc in results:
    print(f"* {doc.page_content} [{doc.metadata}]")

* thud [{'id': 'doc:users:2'}]

Search with score:

results = vector_store.similarity_search_with_score(query="qux",k=1)
for doc, score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.167700] foo [{'id': 'doc:users:1'}]

Async:

# add documents
# await vector_store.aadd_documents(documents=documents, ids=ids)

# delete documents
# await vector_store.adelete(ids=["3"])

# search
# results = vector_store.asimilarity_search(query="thud",k=1)

# search with score
results = await vector_store.asimilarity_search_with_score(query="qux",k=1)
for doc,score in results:
    print(f"* [SIM={score:3f}] {doc.page_content} [{doc.metadata}]")

* [SIM=0.167700] foo [{'id': 'doc:users:1'}]

Use as Retriever:

retriever = vector_store.as_retriever(
    search_type="mmr",
    search_kwargs={"k": 1, "fetch_k": 2, "lambda_mult": 0.5},
)
retriever.invoke("thud")

[Document(metadata={'id': 'doc:users:2'}, page_content='thud')]

Advanced examples:

Custom vector schema can be supplied to change the way that Redis creates the underlying vector schema. This is useful for production use cases where you want to optimize the vector schema for your use case. ex. using HNSW instead of FLAT (knn) which is the default

vector_schema = {
    "algorithm": "HNSW"
}

rds = Redis.from_texts(
    texts, # a list of strings
    metadata, # a list of metadata dicts
    embeddings, # an Embeddings object
    vector_schema=vector_schema,
    redis_url="redis://localhost:6379",
)

Custom index schema can be supplied to change the way that the metadata is indexed. This is useful for you would like to use the hybrid querying (filtering) capability of Redis.

By default, this implementation will automatically generate the index schema according to the following rules:

All strings are indexed as text fields

All numbers are indexed as numeric fields

All lists of strings are indexed as tag fields (joined by
langchain_community.vectorstores.redis.constants.REDIS_TAG_SEPARATOR)

All None values are not indexed but still stored in Redis these are
not retrievable through the interface here, but the raw Redis client can be used to retrieve them.

All other types are not indexed

To override these rules, you can pass in a custom index schema like the following

tag:
    - name: credit_score
text:
    - name: user
    - name: job

Typically, the credit_score field would be a text field since it’s a string, however, we can override this behavior by specifying the field type as shown with the yaml config (can also be a dictionary) above and the code below.

rds = Redis.from_texts(
    texts, # a list of strings
    metadata, # a list of metadata dicts
    embeddings, # an Embeddings object
    index_schema="path/to/index_schema.yaml", # can also be a dictionary
    redis_url="redis://localhost:6379",
)

When connecting to an existing index where a custom schema has been applied, it’s important to pass in the same schema to the from_existing_index method. Otherwise, the schema for newly added samples will be incorrect and metadata will not be returned.

Initialize Redis vector store with necessary components.

Attributes

`DEFAULT_VECTOR_SCHEMA`
`embeddings`	Access the query embedding object if available.
`schema`	Return the schema of the index.

Methods

`__init__`(redis_url, index_name, embedding[, ...])	Initialize Redis vector store with necessary components.
`aadd_documents`(documents, **kwargs)	Async run more documents through the embeddings and add to the vectorstore.
`aadd_texts`(texts[, metadatas, ids])	Async run more texts through the embeddings and add to the vectorstore.
`add_documents`(documents, **kwargs)	Add or update documents in the vectorstore.
`add_texts`(texts[, metadatas, embeddings, ...])	Add more texts to the vectorstore.
`adelete`([ids])	Async delete by vector ID or other criteria.
`afrom_documents`(documents, embedding, **kwargs)	Async return VectorStore initialized from documents and embeddings.
`afrom_texts`(texts, embedding[, metadatas, ids])	Async return VectorStore initialized from texts and embeddings.
`aget_by_ids`(ids, /)	Async get documents by their IDs.
`amax_marginal_relevance_search`(query[, k, ...])	Async return docs selected using the maximal marginal relevance.
`amax_marginal_relevance_search_by_vector`(...)	Async return docs selected using the maximal marginal relevance.
`as_retriever`(**kwargs)	Return VectorStoreRetriever initialized from this VectorStore.
`asearch`(query, search_type, **kwargs)	Async return docs most similar to query using a specified search type.
`asimilarity_search`(query[, k])	Async return docs most similar to query.
`asimilarity_search_by_vector`(embedding[, k])	Async return docs most similar to embedding vector.
`asimilarity_search_with_relevance_scores`(query)	Async return docs and relevance scores in the range [0, 1].
`asimilarity_search_with_score`(args, *kwargs)	Async run similarity search with distance.
`delete`([ids])	Delete a Redis entry.
`drop_index`(index_name, delete_documents, ...)	Drop a Redis search index.
`from_documents`(documents, embedding, **kwargs)	Return VectorStore initialized from documents and embeddings.
`from_existing_index`(embedding, index_name, ...)	Connect to an existing Redis index.
`from_texts`(texts, embedding[, metadatas, ...])	Create a Redis vectorstore from a list of texts.
`from_texts_return_keys`(texts, embedding[, ...])	Create a Redis vectorstore from raw documents.
`get_by_ids`(ids, /)	Get documents by their IDs.
`max_marginal_relevance_search`(query[, k, ...])	Return docs selected using the maximal marginal relevance.
`max_marginal_relevance_search_by_vector`(...)	Return docs selected using the maximal marginal relevance.
`search`(query, search_type, **kwargs)	Return docs most similar to query using a specified search type.
`similarity_search`(query[, k, filter, ...])	Run similarity search
`similarity_search_by_vector`(embedding[, k, ...])	Run similarity search between a query vector and the indexed vectors.
`similarity_search_limit_score`(query[, k, ...])
`similarity_search_with_relevance_scores`(query)	Return docs and relevance scores in the range [0, 1].
`similarity_search_with_score`(query[, k, ...])	Run similarity search with vector distance.
`write_schema`(path)	Write the schema to a yaml file.

Parameters:

redis_url (str)
index_name (str)
embedding (Embeddings)
index_schema (Optional[Union[Dict[str, ListOfDict], str, os.PathLike]])
vector_schema (Optional[Dict[str, Union[str, int]]])
relevance_score_fn (Optional[Callable[[float], float]])
key_prefix (Optional[str])
kwargs (Any)

Initialize Redis vector store with necessary components.

Parameters:

redis_url (str)
index_name (str)
embedding (Embeddings)
index_schema (Dict[str, List[Dict[str, str]]] | str | PathLike | None)
vector_schema (Dict[str, str | int] | None)
relevance_score_fn (Callable[[float], float] | None)
key_prefix (str | None)
kwargs (Any)

async aadd_documents(documents: list[Document], **kwargs: Any) → list[str]#

Async run more documents through the embeddings and add to the vectorstore.

Parameters:

documents (list[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of IDs does not match the number of documents.

Return type:

list[str]

async aadd_texts(texts: Iterable[str], metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → list[str]#

Async run more texts through the embeddings and add to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings to add to the vectorstore.
metadatas (list[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
ids (list[str] | None) – Optional list
**kwargs (Any) – vectorstore specific parameters.

Returns:

List of ids from adding the texts into the vectorstore.

Raises:

ValueError – If the number of metadatas does not match the number of texts.
ValueError – If the number of ids does not match the number of texts.

Return type:

list[str]

add_documents(documents: list[Document], **kwargs: Any) → list[str]#

Add or update documents in the vectorstore.

Parameters:

documents (list[Document]) – Documents to add to the vectorstore.
kwargs (Any) – Additional keyword arguments. if kwargs contains ids and documents contain ids, the ids in the kwargs will receive precedence.

Returns:

List of IDs of the added texts.

Raises:

ValueError – If the number of ids does not match the number of documents.

Return type:

list[str]

add_texts(texts: Iterable[str], metadatas: List[dict] | None = None, embeddings: List[List[float]] | None = None, batch_size: int = 1000, clean_metadata: bool = True, **kwargs: Any) → List[str][source]#

Add more texts to the vectorstore.

Parameters:

texts (Iterable[str]) – Iterable of strings/text to add to the vectorstore.
metadatas (Optional[List[dict]], optional) – Optional list of metadatas. Defaults to None.
embeddings (Optional[List[List[float]]], optional) – Optional pre-generated embeddings. Defaults to None.
keys (List[str]) or ids (List[str]) – Identifiers of entries. Defaults to None.
batch_size (int, optional) – Batch size to use for writes. Defaults to 1000.
clean_metadata (bool)
kwargs (Any)

Returns:

List of ids added to the vectorstore

Return type:

List[str]

async adelete(ids: list[str] | None = None, **kwargs: Any) → bool | None#

Async delete by vector ID or other criteria.

Parameters:

ids (list[str] | None) – List of ids to delete. If None, delete all. Default is None.
**kwargs (Any) – Other keyword arguments that subclasses might use.

Returns:

True if deletion is successful, False otherwise, None if not implemented.

Return type:

Optional[bool]

async classmethod afrom_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST#

Async return VectorStore initialized from documents and embeddings.

Parameters:

documents (list[Document]) – List of Documents to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from documents and embeddings.

Return type:

VectorStore

async classmethod afrom_texts(texts: list[str], embedding: Embeddings, metadatas: list[dict] | None = None, *, ids: list[str] | None = None, **kwargs: Any) → VST#

Async return VectorStore initialized from texts and embeddings.

Parameters:

texts (list[str]) – Texts to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
metadatas (list[dict] | None) – Optional list of metadatas associated with the texts. Default is None.
ids (list[str] | None) – Optional list of IDs associated with the texts.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from texts and embeddings.

Return type:

VectorStore

async aget_by_ids(ids: Sequence[str], /) → list[Document]#

Async get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: list[Document]

Added in version 0.2.11.

async amax_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
kwargs (Any)

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

async amax_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Async return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

as_retriever(**kwargs: Any) → RedisVectorStoreRetriever[source]#

Return VectorStoreRetriever initialized from this VectorStore.

Parameters:

**kwargs (Any) –

Keyword arguments to pass to the search function. Can include: search_type (Optional[str]): Defines the type of search that

the Retriever should perform. Can be “similarity” (default), “mmr”, or “similarity_score_threshold”.

search_kwargs (Optional[Dict]): Keyword arguments to pass to the

search function. Can include things like:

k: Amount of documents to return (Default: 4) score_threshold: Minimum relevance threshold

for similarity_score_threshold

fetch_k: Amount of documents to pass to MMR algorithm: (Default: 20)
lambda_mult: Diversity of results returned by MMR;: 1 for minimum diversity and 0 for maximum. (Default: 0.5)

filter: Filter by document metadata

Returns:

Retriever class for VectorStore.

Return type:

VectorStoreRetriever

Examples:

# Retrieve more documents with higher diversity
# Useful if your dataset has many similar documents
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# Fetch more documents for the MMR algorithm to consider
# But only return the top 5
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# Only retrieve documents that have a relevance score
# Above a certain threshold
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# Only get the single most similar document from the dataset
docsearch.as_retriever(search_kwargs={'k': 1})

# Use a filter to only retrieve documents from a specific paper
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

async asearch(query: str, search_type: str, **kwargs: Any) → list[Document]#

Async return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text.
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

list[Document]

async asimilarity_search(query: str, k: int = 4, **kwargs: Any) → list[Document]#

Async return docs most similar to query.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Return type:

list[Document]

async asimilarity_search_by_vector(embedding: list[float], k: int = 4, **kwargs: Any) → list[Document]#

Async return docs most similar to embedding vector.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query vector.

Return type:

list[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

Async return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs

Returns:

List of Tuples of (doc, similarity_score)

Return type:

list[tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → list[tuple[Document, float]]#

Async run similarity search with distance.

Parameters:

*args (Any) – Arguments to pass to the search method.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

list[tuple[Document, float]]

delete(ids: List[str] | None = None, **kwargs: Any) → bool[source]#

Delete a Redis entry.

Parameters:

ids (List[str] | None) – List of ids (keys in redis) to delete.
redis_url – Redis connection url. This should be passed in the kwargs or set as an environment variable: REDIS_URL.
kwargs (Any)

Returns:

Whether or not the deletions were successful.

Return type:

bool

Raises:

ValueError – If the redis python package is not installed.
ValueError – If the ids (keys in redis) are not provided

static drop_index(index_name: str, delete_documents: bool, **kwargs: Any) → bool[source]#

Drop a Redis search index.

Parameters:

index_name (str) – Name of the index to drop.
delete_documents (bool) – Whether to drop the associated documents.
kwargs (Any)

Returns:

Whether or not the drop was successful.

Return type:

bool

classmethod from_documents(documents: list[Document], embedding: Embeddings, **kwargs: Any) → VST#

Return VectorStore initialized from documents and embeddings.

Parameters:

documents (list[Document]) – List of Documents to add to the vectorstore.
embedding (Embeddings) – Embedding function to use.
kwargs (Any) – Additional keyword arguments.

Returns:

VectorStore initialized from documents and embeddings.

Return type:

VectorStore

classmethod from_existing_index(embedding: Embeddings, index_name: str, schema: Dict[str, List[Dict[str, str]]] | str | PathLike, key_prefix: str | None = None, **kwargs: Any) → Redis[source]#

Connect to an existing Redis index.

Example

from langchain_community.vectorstores import Redis
from langchain_community.embeddings import OpenAIEmbeddings

embeddings = OpenAIEmbeddings()

# must pass in schema and key_prefix from another index
existing_rds = Redis.from_existing_index(
    embeddings,
    index_name="my-index",
    schema=rds.schema, # schema dumped from another index
    key_prefix=rds.key_prefix, # key prefix from another index
    redis_url="redis://username:password@localhost:6379",
)

Parameters:

embedding (Embeddings) – Embedding model class (i.e. OpenAIEmbeddings) for embedding queries.
index_name (str) – Name of the index to connect to.
schema (Union[Dict[str, str], str, os.PathLike, Dict[str, ListOfDict]]) – Schema of the index and the vector schema. Can be a dict, or path to yaml file.
key_prefix (Optional[str]) – Prefix to use for all keys in Redis associated with this index.
**kwargs (Any) – Additional keyword arguments to pass to the Redis client.

Returns:

Redis VectorStore instance.

Return type:

Redis

Raises:

ValueError – If the index does not exist.
ImportError – If the redis python package is not installed.

Create a Redis vectorstore from a list of texts.

This is a user-friendly interface that:

Embeds documents.
Creates a new Redis index if it doesn’t already exist
Adds the documents to the newly created Redis index.

This method will generate schema based on the metadata passed in if the index_schema is not defined. If the index_schema is defined, it will compare against the generated schema and warn if there are differences. If you are purposefully defining the schema for the metadata, then you can ignore that warning.

To examine the schema options, initialize an instance of this class and print out the schema using the Redis.schema` property. This will include the content and content_vector classes which are always present in the langchain schema.

Example

from langchain_community.vectorstores import Redis
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
redisearch = RediSearch.from_texts(
    texts,
    embeddings,
    redis_url="redis://username:password@localhost:6379"
)

Parameters:

texts (List[str]) – List of texts to add to the vectorstore.
embedding (Embeddings) – Embedding model class (i.e. OpenAIEmbeddings) for embedding queries.
metadatas (Optional[List[dict]], optional) – Optional list of metadata dicts to add to the vectorstore. Defaults to None.
index_name (Optional[str], optional) – Optional name of the index to create or add to. Defaults to None.
(Optional[Union[Dict[str (index_schema) – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
ListOfDict] – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
str – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
os.PathLike]] – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
index_schema (Dict[str, List[Dict[str, str]]] | str | PathLike | None)
vector_schema (Dict[str, str | int] | None)
kwargs (Any)

Return type:

Redis

:paramoptional):: Optional fields to index within the metadata. Overrides generated schema. Defaults to None.

Parameters:

vector_schema (Optional[Dict[str, Union[str, int]]], optional) – Optional vector schema to use. Defaults to None.
**kwargs (Any) – Additional keyword arguments to pass to the Redis client.
texts (List[str])
embedding (Embeddings)
metadatas (List[dict] | None)
index_name (str | None)
index_schema (Dict[str, List[Dict[str, str]]] | str | PathLike | None)

Returns:

Redis VectorStore instance.

Return type:

Redis

Raises:

ValueError – If the number of metadatas does not match the number of texts.
ImportError – If the redis python package is not installed.

Create a Redis vectorstore from raw documents.

This is a user-friendly interface that:

Embeds documents.
Creates a new Redis index if it doesn’t already exist
Adds the documents to the newly created Redis index.
Returns the keys of the newly created documents once stored.

This method will generate schema based on the metadata passed in if the index_schema is not defined. If the index_schema is defined, it will compare against the generated schema and warn if there are differences. If you are purposefully defining the schema for the metadata, then you can ignore that warning.

To examine the schema options, initialize an instance of this class and print out the schema using the Redis.schema` property. This will include the content and content_vector classes which are always present in the langchain schema.

Example

from langchain_community.vectorstores import Redis
from langchain_community.embeddings import OpenAIEmbeddings
embeddings = OpenAIEmbeddings()
redis, keys = Redis.from_texts_return_keys(
    texts,
    embeddings,
    redis_url="redis://localhost:6379"
)

Parameters:

texts (List[str]) – List of texts to add to the vectorstore.
embedding (Embeddings) – Embeddings to use for the vectorstore.
metadatas (Optional[List[dict]], optional) – Optional list of metadata dicts to add to the vectorstore. Defaults to None.
index_name (Optional[str], optional) – Optional name of the index to create or add to. Defaults to None.
(Optional[Union[Dict[str (index_schema) – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
ListOfDict] – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
str – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
os.PathLike]] – optional): Optional fields to index within the metadata. Overrides generated schema. Defaults to None.
index_schema (Dict[str, List[Dict[str, str]]] | str | PathLike | None)
vector_schema (Dict[str, str | int] | None)
kwargs (Any)

Return type:

Tuple[Redis, List[str]]

:paramoptional):: Optional fields to index within the metadata. Overrides generated schema. Defaults to None.

Parameters:

vector_schema (Optional[Dict[str, Union[str, int]]], optional) – Optional vector schema to use. Defaults to None.
**kwargs (Any) – Additional keyword arguments to pass to the Redis client.
texts (List[str])
embedding (Embeddings)
metadatas (List[dict] | None)
index_name (str | None)
index_schema (Dict[str, List[Dict[str, str]]] | str | PathLike | None)

Returns:

Tuple of the Redis instance and the keys of: the newly created documents.

Return type:

Tuple[Redis, List[str]]

Raises:

ValueError – If the number of metadatas does not match the number of texts.

get_by_ids(ids: Sequence[str], /) → list[Document]#

Get documents by their IDs.

The returned documents are expected to have the ID field set to the ID of the document in the vector store.

Fewer documents may be returned than requested if some IDs are not found or if there are duplicated IDs.

Users should not assume that the order of the returned documents matches the order of the input IDs. Instead, users should rely on the ID field of the returned documents.

This method should NOT raise exceptions if no documents are found for some IDs.

Parameters:: ids (Sequence[str]) – List of ids to retrieve.
Returns:: List of Documents.
Return type:: list[Document]

Added in version 0.2.11.

max_marginal_relevance_search(query: str, k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, filter: RedisFilterExpression | None = None, return_metadata: bool = True, distance_threshold: float | None = None, **kwargs: Any) → List[Document][source]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity: among selected documents.

Parameters:

query (str) – Text to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
filter (RedisFilterExpression, optional) – Optional metadata filter. Defaults to None.
return_metadata (bool, optional) – Whether to return metadata. Defaults to True.
distance_threshold (Optional[float], optional) – Maximum vector distance between selected documents and the query vector. Defaults to None.
kwargs (Any)

Returns:

A list of Documents selected by maximal marginal relevance.

Return type:

List[Document]

max_marginal_relevance_search_by_vector(embedding: list[float], k: int = 4, fetch_k: int = 20, lambda_mult: float = 0.5, **kwargs: Any) → list[Document]#

Return docs selected using the maximal marginal relevance.

Maximal marginal relevance optimizes for similarity to query AND diversity among selected documents.

Parameters:

embedding (list[float]) – Embedding to look up documents similar to.
k (int) – Number of Documents to return. Defaults to 4.
fetch_k (int) – Number of Documents to fetch to pass to MMR algorithm. Default is 20.
lambda_mult (float) – Number between 0 and 1 that determines the degree of diversity among the results with 0 corresponding to maximum diversity and 1 to minimum diversity. Defaults to 0.5.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents selected by maximal marginal relevance.

Return type:

list[Document]

search(query: str, search_type: str, **kwargs: Any) → list[Document]#

Return docs most similar to query using a specified search type.

Parameters:

query (str) – Input text
search_type (str) – Type of search to perform. Can be “similarity”, “mmr”, or “similarity_score_threshold”.
**kwargs (Any) – Arguments to pass to the search method.

Returns:

List of Documents most similar to the query.

Raises:

ValueError – If search_type is not one of “similarity”, “mmr”, or “similarity_score_threshold”.

Return type:

list[Document]

similarity_search(query: str, k: int = 4, filter: RedisFilterExpression | None = None, return_metadata: bool = True, distance_threshold: float | None = None, **kwargs: Any) → List[Document][source]#

Run similarity search

Parameters:

query (str) – The query text for which to find similar documents.
k (int) – The number of documents to return. Default is 4.
filter (RedisFilterExpression, optional) – Optional metadata filter. Defaults to None.
return_metadata (bool, optional) – Whether to return metadata. Defaults to True.
distance_threshold (Optional[float], optional) – Maximum vector distance between selected documents and the query vector. Defaults to None.
kwargs (Any)

Returns:

A list of documents that are most similar to the query: text.

Return type:

List[Document]

similarity_search_by_vector(embedding: List[float], k: int = 4, filter: RedisFilterExpression | None = None, return_metadata: bool = True, distance_threshold: float | None = None, **kwargs: Any) → List[Document][source]#

Run similarity search between a query vector and the indexed vectors.

Parameters:

embedding (List[float]) – The query vector for which to find similar documents.
k (int) – The number of documents to return. Default is 4.
filter (RedisFilterExpression, optional) – Optional metadata filter. Defaults to None.
return_metadata (bool, optional) – Whether to return metadata. Defaults to True.
distance_threshold (Optional[float], optional) – Maximum vector distance between selected documents and the query vector. Defaults to None.
kwargs (Any)

Returns:

A list of documents that are most similar to the query: text.

Return type:

List[Document]

similarity_search_limit_score(query: str, k: int = 4, score_threshold: float = 0.2, **kwargs: Any) → List[Document][source]#

Deprecated since version langchain-community==0.0.1: Use 1)() instead.

Returns the most similar indexed documents to the query text within the score_threshold range.

Deprecated: Use similarity_search with distance_threshold instead.

Parameters:

query (str) – The query text for which to find similar documents.
k (int) – The number of documents to return. Default is 4.
score_threshold (float) – The minimum matching distance required for a document to be considered a match. Defaults to 0.2.
kwargs (Any)

Returns:

A list of documents that are most similar to the query text: including the match score for each document.

Return type:

List[Document]

Note

If there are no documents that satisfy the score_threshold value, an empty list is returned.

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → list[tuple[Document, float]]#

Return docs and relevance scores in the range [0, 1].

0 is dissimilar, 1 is most similar.

Parameters:

query (str) – Input text.
k (int) – Number of Documents to return. Defaults to 4.
**kwargs (Any) –
kwargs to be passed to similarity search. Should include: score_threshold: Optional, a floating point value between 0 to 1 to

filter the resulting set of retrieved docs.

Returns:

List of Tuples of (doc, similarity_score).

Return type:

list[tuple[Document, float]]

similarity_search_with_score(query: str, k: int = 4, filter: RedisFilterExpression | None = None, return_metadata: bool = True, **kwargs: Any) → List[Tuple[Document, float]][source]#

Run similarity search with vector distance.

The “scores” returned from this function are the raw vector distances from the query vector. For similarity scores, use similarity_search_with_relevance_scores.

Parameters:

query (str) – The query text for which to find similar documents.
k (int) – The number of documents to return. Default is 4.
filter (RedisFilterExpression, optional) – Optional metadata filter. Defaults to None.
return_metadata (bool, optional) – Whether to return metadata. Defaults to True.
kwargs (Any)

Returns:

A list of documents that are: most similar to the query with the distance for each document.

Return type:

List[Tuple[Document, float]]

write_schema(path: str | PathLike) → None[source]#

Write the schema to a yaml file.

Parameters:: path (str | PathLike)
Return type:: None

Examples using Redis

Redis