`langchain_community.vectorstores.redis.base`.Redis¶

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

Redis向量数据库。

要使用，应该安装``redis`` python包并运行Redis Enterprise或Redis-Stack服务器。

对于生产用例，建议使用Redis Enterprise，因为扩展性、性能、稳定性和可用性要比Redis-Stack好得多。

然而，对于测试和原型设计，并不需要这样做。Redis-Stack可作为Docker容器使用，提供完整的向量搜索API。

# 在本地Docker中运行redis stack
docker run -d -p 6379:6379 -p 8001:8001 redis/redis-stack:latest

运行后，可以使用以下URL模式连接到redis服务器： - redis://<host>:<port> # 简单连接 - redis://<username>:<password>@<host>:<port> # 带身份验证的连接 - rediss://<host>:<port> # 带SSL连接 - rediss://<username>:<password>@<host>:<port> # 带SSL和身份验证的连接

示例：

以下示例展示了如何使用LangChain中的Redis VectorStore。

对于以下所有示例，假设我们有以下导入：

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

初始化、创建索引并加载文档

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

rds = Redis.from_documents(
    documents, # 来自加载器或创建的Document对象列表
    embeddings, # 一个Embeddings对象
    redis_url="redis://localhost:6379",
)

初始化、创建索引并加载带元数据的文档

rds = Redis.from_texts(
    texts, # 字符串列表
    metadata, # 元数据字典列表
    embeddings, # 一个Embeddings对象
    redis_url="redis://localhost:6379",
)

初始化、创建索引并加载带元数据的文档并返回键

rds, keys = Redis.from_texts_return_keys(
    texts, # 字符串列表
    metadata, # 元数据字典列表
    embeddings, # 一个Embeddings对象
    redis_url="redis://localhost:6379",
)

对于需要保持索引活动的用例，可以初始化一个索引名称，这样以后更容易引用

rds = Redis.from_texts(
    texts, # 字符串列表
    metadata, # 元数据字典列表
    embeddings, # 一个Embeddings对象
    index_name="my-index",
    redis_url="redis://localhost:6379",
)

初始化并连接到现有索引（来自上述）

# 必须从另一个索引传入schema和key_prefix
existing_rds = Redis.from_existing_index(
    embeddings, # 一个Embeddings对象
    index_name="my-index",
    schema=rds.schema, # 从另一个索引转储的schema
    key_prefix=rds.key_prefix, # 从另一个索引的键前缀
    redis_url="redis://localhost:6379",
)

高级示例：

可以提供自定义向量模式以更改Redis创建的底层向量模式。这对于生产用例很有用，可以优化向量模式以适应您的用例。例如，使用HNSW而不是默认的FLAT（knn）

vector_schema = {
    "algorithm": "HNSW"
}

rds = Redis.from_texts(
    texts, # 字符串列表
    metadata, # 元数据字典列表
    embeddings, # 一个Embeddings对象
    vector_schema=vector_schema,
    redis_url="redis://localhost:6379",
)

可以提供自定义索引模式以更改元数据的索引方式。如果想要使用Redis的混合查询（过滤）功能，这将很有用。

默认情况下，此实现将根据以下规则自动生成索引模式：

所有字符串都作为文本字段索引
所有数字都作为数值字段索引
所有字符串列表都作为标签字段索引（由langchain_community.vectorstores.redis.constants.REDIS_TAG_SEPARATOR连接）
所有None值不被索引，但仍存储在Redis中，这些值无法通过此接口检索，但可以使用原始Redis客户端检索。
所有其他类型不被索引

要覆盖这些规则，可以传入类似以下的自定义索引模式

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

通常，“credit_score”字段应该是文本字段，因为它是一个字符串，但我们可以通过上面显示的yaml配置（也可以是字典）和下面的代码来指定字段类型以覆盖此行为。

rds = Redis.from_texts(
    texts, # 字符串列表
    metadata, # 元数据字典列表
    embeddings, # 一个Embeddings对象
    index_schema="path/to/index_schema.yaml", # 也可以是字典
    redis_url="redis://localhost:6379",
)

当连接到应用了自定义模式的现有索引时，重要的是将相同的模式传递给``from_existing_index``方法。否则，新添加的样本的模式将不正确，并且元数据将不会被返回。

使用必要的组件初始化Redis向量存储。

Attributes

`DEFAULT_VECTOR_SCHEMA`
`embeddings`	如果可用，访问查询嵌入对象。
`schema`	返回索引的模式。

Methods

`__init__`(redis_url, index_name, embedding[, ...])	使用必要的组件初始化Redis向量存储。
`aadd_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`aadd_texts`(texts[, metadatas])	运行更多的文本通过嵌入，并添加到向量存储中。
`add_documents`(documents, **kwargs)	运行更多的文档通过嵌入并添加到向量存储中。
`add_texts`(texts[, metadatas, embeddings, ...])	向向量存储中添加更多文本。
`adelete`([ids])	根据向量ID或其他条件进行删除。
`afrom_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`afrom_texts`(texts, embedding[, metadatas])	返回从文本和嵌入初始化的VectorStore。
`amax_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`amax_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`as_retriever`(**kwargs)	返回从此VectorStore初始化的VectorStoreRetriever。
`asearch`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`asimilarity_search`(query[, k])	返回与查询最相似的文档。
`asimilarity_search_by_vector`(embedding[, k])	返回与嵌入向量最相似的文档。
`asimilarity_search_with_relevance_scores`(query)	返回文档和相关性分数在范围[0, 1]内，异步执行。
`asimilarity_search_with_score`(args, *kwargs)	使用异步方式运行相似性搜索与距离。
`delete`([ids])	删除Redis条目。
`drop_index`(index_name, delete_documents, ...)	删除一个Redis搜索索引。
`from_documents`(documents, embedding, **kwargs)	返回从文档和嵌入初始化的VectorStore。
`from_existing_index`(embedding, index_name, ...)	连接到现有的Redis索引。
`from_texts`(texts, embedding[, metadatas, ...])	从文本列表创建一个Redis向量存储。
`from_texts_return_keys`(texts, embedding[, ...])	从原始文档创建一个Redis向量存储。
`max_marginal_relevance_search`(query[, k, ...])	返回使用最大边际相关性选择的文档。
`max_marginal_relevance_search_by_vector`(...)	返回使用最大边际相关性选择的文档。
`search`(query, search_type, **kwargs)	返回使用指定搜索类型的查询最相似的文档。
`similarity_search`(query[, k, filter, ...])	运行相似性搜索
`similarity_search_by_vector`(embedding[, k, ...])	运行查询向量和索引向量之间的相似性搜索。
`similarity_search_limit_score`(query[, k, ...])	[Deprecated] 返回与查询文本在score_threshold范围内最相似的索引文档。
`similarity_search_with_relevance_scores`(query)	返回文档和相关性得分在[0, 1]范围内。
`similarity_search_with_score`(query[, k, ...])	运行使用向量距离进行相似性搜索。
`write_schema`(path)	将模式写入一个yaml文件。

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) –

__init__(redis_url: str, index_name: str, embedding: Embeddings, index_schema: Optional[Union[Dict[str, List[Dict[str, str]]], str, PathLike]] = None, vector_schema: Optional[Dict[str, Union[str, int]]] = None, relevance_score_fn: Optional[Callable[[float], float]] = None, key_prefix: Optional[str] = None, **kwargs: Any)[source]¶

使用必要的组件初始化Redis向量存储。

Parameters

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

async aadd_documents(documents: List[Document], **kwargs: Any) → List[str]¶

运行更多的文档通过嵌入并添加到向量存储中。

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

async aadd_texts(texts: Iterable[str], metadatas: Optional[List[dict]] = None, **kwargs: Any) → List[str]¶

运行更多的文本通过嵌入，并添加到向量存储中。

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

List[str]

add_documents(documents: List[Document], **kwargs: Any) → List[str]¶

运行更多的文档通过嵌入并添加到向量存储中。

参数:: documents (List[Document]): 要添加到向量存储中的文档。
返回:: List[str]: 添加的文本的ID列表。

Parameters

documents (List[Document]) –
kwargs (Any) –

Return type

List[str]

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

向向量存储中添加更多文本。

参数:: texts (Iterable[str]): 要添加到向量存储中的字符串/文本的可迭代对象。 metadatas (Optional[List[dict]], optional): 元数据的可选列表。默认为None。 embeddings (Optional[List[List[float]]], optional): 可选的预生成的嵌入。默认为None。 keys (List[str]) or ids (List[str]): 条目的标识符。默认为None。 batch_size (int, optional): 用于写入的批处理大小。默认为1000。
返回:: List[str]: 添加到向量存储中的id列表

Parameters

texts (Iterable[str]) –
metadatas (Optional[List[dict]]) –
embeddings (Optional[List[List[float]]]) –
batch_size (int) –
clean_metadata (bool) –
kwargs (Any) –

Return type

List[str]

async adelete(ids: Optional[List[str]] = None, **kwargs: Any) → Optional[bool]¶

根据向量ID或其他条件进行删除。

参数：: ids：要删除的ID列表。 **kwargs：子类可能使用的其他关键字参数。
返回：: Optional[bool]：如果删除成功则为True，否则为False，如果未实现则为None。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

Optional[bool]

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

返回从文档和嵌入初始化的VectorStore。

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

async classmethod afrom_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, **kwargs: Any) → VST¶

返回从文本和嵌入初始化的VectorStore。

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
kwargs (Any) –

Return type

VST

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

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：: query：要查找类似文档的文本。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：0到1之间的数字，确定结果之间多样性的程度，0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

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]¶

返回使用最大边际相关性选择的文档。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

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

返回从此VectorStore初始化的VectorStoreRetriever。

参数：

search_type（可选[str]）：定义Retriever应执行的搜索类型。: 可以是”similarity”（默认值）、”mmr”或”similarity_score_threshold”。
search_kwargs（可选[Dict]）：传递给搜索函数的关键字参数。可以包括：: k：要返回的文档数量（默认值：4） score_threshold：用于similarity_score_threshold的最小相关性阈值 fetch_k：传递给MMR算法的文档数量（默认值：20） lambda_mult：MMR返回结果的多样性；1表示最小多样性，0表示最大多样性（默认值：0.5） filter：按文档元数据筛选

返回：

VectorStoreRetriever：VectorStore的Retriever类。

示例：

# 检索更多具有更高多样性的文档
# 如果数据集中有许多相似的文档，则很有用
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 6, 'lambda_mult': 0.25}
)

# 为MMR算法考虑更多文档
# 但只返回前5个
docsearch.as_retriever(
    search_type="mmr",
    search_kwargs={'k': 5, 'fetch_k': 50}
)

# 仅检索具有特定阈值以上相关性分数的文档
docsearch.as_retriever(
    search_type="similarity_score_threshold",
    search_kwargs={'score_threshold': 0.8}
)

# 仅从数据集中获取最相似的单个文档
docsearch.as_retriever(search_kwargs={'k': 1})

# 使用筛选器仅从特定论文中检索文档
docsearch.as_retriever(
    search_kwargs={'filter': {'paper_title':'GPT-4 Technical Report'}}
)

Parameters: kwargs (Any) –
Return type: RedisVectorStoreRetriever

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

返回使用指定搜索类型的查询最相似的文档。

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

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

返回与查询最相似的文档。

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Document]

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

返回与嵌入向量最相似的文档。

Parameters

embedding (List[float]) –
k (int) –
kwargs (Any) –

Return type

List[Document]

async asimilarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和相关性分数在范围[0, 1]内，异步执行。

0表示不相似，1表示最相似。

参数：: query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似度分数）的列表

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

async asimilarity_search_with_score(*args: Any, **kwargs: Any) → List[Tuple[Document, float]]¶

使用异步方式运行相似性搜索与距离。

Parameters

args (Any) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

static delete(ids: Optional[List[str]] = None, **kwargs: Any) → bool[source]¶

删除Redis条目。

参数：: ids：要删除的id列表（在redis中的键）。 redis_url：Redis连接URL。这应该在kwargs中传递或设置为环境变量：REDIS_URL。
返回：: bool：删除是否成功。
引发：: ValueError：如果未安装redis python包。 ValueError：如果未提供ids（在redis中的键）。

Parameters

ids (Optional[List[str]]) –
kwargs (Any) –

Return type

bool

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

删除一个Redis搜索索引。

参数：: index_name（str）：要删除的索引名称。 delete_documents（bool）：是否删除关联的文档。
返回：: bool：删除是否成功。

Parameters

index_name (str) –
delete_documents (bool) –
kwargs (Any) –

Return type

bool

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

返回从文档和嵌入初始化的VectorStore。

Parameters

documents (List[Document]) –
embedding (Embeddings) –
kwargs (Any) –

Return type

VST

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

连接到现有的Redis索引。

示例：

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

embeddings = OpenAIEmbeddings()

# 必须从另一个索引中传递模式和键前缀
existing_rds = Redis.from_existing_index(
    embeddings,
    index_name="my-index",
    schema=rds.schema, # 从另一个索引中导出的模式
    key_prefix=rds.key_prefix, # 从另一个索引中的键前缀
    redis_url="redis://username:password@localhost:6379",
)

参数:

embedding (Embeddings): 嵌入模型类（例如OpenAIEmbeddings）用于嵌入查询。 index_name (str): 要连接的索引的名称。 schema (Union[Dict[str, str], str, os.PathLike, Dict[str, ListOfDict]]):

索引和向量模式的模式。可以是字典或yaml文件的路径。

key_prefix (Optional[str]): 与此索引关联的Redis中所有键的前缀。 **kwargs (Any): 传递给Redis客户端的其他关键字参数。

返回:

Redis: Redis VectorStore实例。

引发:

ValueError: 如果索引不存在。 ImportError: 如果未安装redis python包。

Parameters

embedding (Embeddings) –
index_name (str) –
schema (Union[Dict[str, List[Dict[str, str]]], str, PathLike]) –
key_prefix (Optional[str]) –
kwargs (Any) –

Return type

Redis

classmethod from_texts(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, index_name: Optional[str] = None, index_schema: Optional[Union[Dict[str, List[Dict[str, str]]], str, PathLike]] = None, vector_schema: Optional[Dict[str, Union[str, int]]] = None, **kwargs: Any) → Redis[source]¶

从文本列表创建一个Redis向量存储。

这是一个用户友好的接口，可以：

嵌入文档。
如果索引不存在，则创建一个新的Redis索引。
将文档添加到新创建的Redis索引中。

如果未定义`index_schema`，此方法将根据传入的元数据生成模式。如果定义了`index_schema`，它将与生成的模式进行比较，并在存在差异时发出警告。如果您有意为元数据定义模式，则可以忽略该警告。

要查看模式选项，请初始化此类的一个实例，并使用`Redis.schema`属性打印出模式。这将包括langchain模式中始终存在的content和content_vector类。

示例：

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"
)

参数：

texts (List[str]): 要添加到向量存储中的文本列表。 embedding (Embeddings): 嵌入模型类（例如OpenAIEmbeddings）用于嵌入查询。 metadatas (Optional[List[dict]], optional): 要添加到向量存储中的元数据字典的可选列表。默认为None。 index_name (Optional[str], optional): 要创建或添加的索引的可选名称。默认为None。 index_schema (Optional[Union[Dict[str, ListOfDict], str, os.PathLike]], optional): 要在元数据中索引的可选字段。覆盖生成的模式。默认为None。 vector_schema (Optional[Dict[str, Union[str, int]]], optional): 要使用的向量模式。默认为None。 **kwargs (Any): 要传递给Redis客户端的其他关键字参数。

返回：

Redis: Redis向量存储实例。

引发：

ValueError: 如果元数据的数量与文本的数量不匹配。 ImportError: 如果未安装redis python包。

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
index_name (Optional[str]) –
index_schema (Optional[Union[Dict[str, List[Dict[str, str]]], str, PathLike]]) –
vector_schema (Optional[Dict[str, Union[str, int]]]) –
kwargs (Any) –

Return type

Redis

classmethod from_texts_return_keys(texts: List[str], embedding: Embeddings, metadatas: Optional[List[dict]] = None, index_name: Optional[str] = None, index_schema: Optional[Union[Dict[str, List[Dict[str, str]]], str, PathLike]] = None, vector_schema: Optional[Dict[str, Union[str, int]]] = None, **kwargs: Any) → Tuple[Redis, List[str]][source]¶

从原始文档创建一个Redis向量存储。

这是一个用户友好的接口，它：

嵌入文档。
如果索引不存在，则创建一个新的Redis索引。
将文档添加到新创建的Redis索引中。
存储后返回新创建文档的键。

要查看模式选项，请初始化此类的一个实例，并使用`Redis.schema`属性打印模式。这将包括始终存在于langchain模式中的content和content_vector类。

示例：

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"
)

参数：

texts（List[str]）：要添加到向量存储中的文本列表。 embedding（Embeddings）：用于向量存储的嵌入。 metadatas（Optional[List[dict]，可选）：要添加到向量存储中的元数据字典的可选列表。默认为None。 index_name（Optional[str]，可选）：要创建或添加的索引的可选名称。默认为None。 index_schema（Optional[Union[Dict[str，ListOfDict]，str，os.PathLike]，可选）：要在元数据中索引的可选字段。覆盖生成的模式。默认为None。 vector_schema（Optional[Dict[str，Union[str，int]]，可选）：要使用的向量模式。默认为None。 **kwargs（Any）：传递给Redis客户端的其他关键字参数。

返回：

Tuple[Redis，List[str]]：Redis实例和新创建文档的键的元组。

Raises：

ValueError：如果元数据的数量与文本的数量不匹配。

Parameters

texts (List[str]) –
embedding (Embeddings) –
metadatas (Optional[List[dict]]) –
index_name (Optional[str]) –
index_schema (Optional[Union[Dict[str, List[Dict[str, str]]], str, PathLike]]) –
vector_schema (Optional[Dict[str, Union[str, int]]]) –
kwargs (Any) –

Return type

Tuple[Redis, List[str]]

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

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：: query（str）：要查找类似文档的文本。 k（int）：要返回的文档数量。默认为4。 fetch_k（int）：要获取以传递给MMR算法的文档数量。 lambda_mult（float）：0到1之间的数字，确定结果之间多样性的程度，0对应于最大多样性，1对应于最小多样性。默认为0.5。 filter（RedisFilterExpression，可选）：可选的元数据过滤器。默认为None。 return_metadata（bool，可选）：是否返回元数据。默认为True。 distance_threshold（Optional[float]，可选）：所选文档与查询向量之间的最大向量距离。默认为None。
返回：: List[Document]：通过最大边际相关性选择的文档列表。

Parameters

query (str) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
filter (Optional[RedisFilterExpression]) –
return_metadata (bool) –
distance_threshold (Optional[float]) –
kwargs (Any) –

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]¶

返回使用最大边际相关性选择的文档。

最大边际相关性优化了与查询的相似性和所选文档之间的多样性。

参数：: embedding：要查找相似文档的嵌入。 k：要返回的文档数量。默认为4。 fetch_k：要获取以传递给MMR算法的文档数量。 lambda_mult：介于0和1之间的数字，确定结果之间多样性的程度，其中0对应最大多样性，1对应最小多样性。默认为0.5。
返回：: 由最大边际相关性选择的文档列表。

Parameters

embedding (List[float]) –
k (int) –
fetch_k (int) –
lambda_mult (float) –
kwargs (Any) –

Return type

List[Document]

search(query: str, search_type: str, **kwargs: Any) → List[Document]¶

返回使用指定搜索类型的查询最相似的文档。

Parameters

query (str) –
search_type (str) –
kwargs (Any) –

Return type

List[Document]

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

运行相似性搜索

参数:

query (str): 要查找相似文档的查询文本。 k (int): 要返回的文档数量。默认为4。 filter (RedisFilterExpression, optional): 可选的元数据过滤器。

默认为None。

return_metadata (bool, optional): 是否返回元数据。: 默认为True。
distance_threshold (Optional[float], optional): 选定文档与查询向量之间的最大向量距离。: 默认为None。

返回:

List[Document]: 与查询文本最相似的文档列表。

Parameters

query (str) –
k (int) –
filter (Optional[RedisFilterExpression]) –
return_metadata (bool) –
distance_threshold (Optional[float]) –
kwargs (Any) –

Return type

List[Document]

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

运行查询向量和索引向量之间的相似性搜索。

参数:: embedding (List[float]): 要查找相似文档的查询向量。 k (int): 要返回的文档数量。默认为4。 filter (RedisFilterExpression, optional): 可选的元数据过滤器。默认为None。 return_metadata (bool, optional): 是否返回元数据。默认为True。 distance_threshold (Optional[float], optional): 选定文档与查询向量之间的最大向量距离。默认为None。
返回:: List[Document]: 与查询文本最相似的文档列表。

Parameters

embedding (List[float]) –
k (int) –
filter (Optional[RedisFilterExpression]) –
return_metadata (bool) –
distance_threshold (Optional[float]) –
kwargs (Any) –

Return type

List[Document]

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

[Deprecated] 返回与查询文本在score_threshold范围内最相似的索引文档。

已弃用：请改用带有distance_threshold的similarity_search。

参数：: query（str）：要查找相似文档的查询文本。 k（int）：要返回的文档数量。默认为4。 score_threshold（float）：要被视为匹配所需的最小匹配*距离*。默认为0.2。
返回：: List[Document]：与查询文本最相似的文档列表，包括每个文档的匹配分数。
注意：: 如果没有文档满足score_threshold值，则返回一个空列表。

Notes

Deprecated since version langchain-community==0.0.1: Use similarity_search(distance_threshold=0.1) instead.

Parameters

query (str) –
k (int) –
score_threshold (float) –
kwargs (Any) –

Return type

List[Document]

similarity_search_with_relevance_scores(query: str, k: int = 4, **kwargs: Any) → List[Tuple[Document, float]]¶

返回文档和相关性得分在[0, 1]范围内。

0表示不相似，1表示最相似。

参数：: query：输入文本 k：要返回的文档数量。默认为4。 **kwargs：要传递给相似性搜索的kwargs。应包括：

score_threshold：可选，介于0到1之间的浮点值，用于过滤检索到的文档集
返回：: 元组列表（doc，相似性得分）

Parameters

query (str) –
k (int) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

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

运行使用 向量距离 进行相似性搜索。

从此函数返回的“scores”是从查询向量到原始向量距离。对于相似性分数，请使用``similarity_search_with_relevance_scores``。

参数:

query (str): 要查找相似文档的查询文本。 k (int): 要返回的文档数量。默认为4。 filter (RedisFilterExpression, optional): 可选的元数据过滤器。

默认为None。

return_metadata (bool, optional): 是否返回元数据。: 默认为True。

返回:

List[Tuple[Document, float]]: 与查询最相似的文档列表，以及每个文档的距离。

Parameters

query (str) –
k (int) –
filter (Optional[RedisFilterExpression]) –
return_metadata (bool) –
kwargs (Any) –

Return type

List[Tuple[Document, float]]

write_schema(path: Union[str, PathLike]) → None[source]¶

将模式写入一个yaml文件。

Parameters: path (Union[str, PathLike]) –
Return type: None

langchain_community.vectorstores.redis.base.Redis¶

Examples using Redis¶

`langchain_community.vectorstores.redis.base`.Redis¶