langchain_community.utilities.redis.get_client

langchain_community.utilities.redis.get_client(redis_url: str, **kwargs: Any) → RedisType[source]

从连接URL获取一个Redis客户端。此辅助函数接受Redis服务器（带/不带TLS的TCP或UnixSocket）的URL以及Redis Sentinel连接。

不支持Redis集群。

在创建连接之前会检查数据库驱动是否存在，否则将引发ValueError。

要使用它，您应该已经安装了redis python包。

示例

from langchain_community.utilities.redis import get_client
redis_client = get_client(
    redis_url="redis://username:password@localhost:6379"
    index_name="my-index",
    embedding_function=embeddings.embed_query,
)

要使用具有多个Redis服务器和Redis Sentinel的Redis复制设置，将“redis_url”设置为“redis+sentinel://”方案。使用此URL格式需要一个包含sentinel中Redis服务名称的路径，以获取正确的Redis服务器连接。默认服务名称为“mymaster”。可选的路径第二个部分是要连接的Redis数据库编号。

可选的用户名或密码用于连接到Redis服务器和Sentinel，服务器和Sentinel不支持不同的密码。而且，作为另一个限制条件，只能提供一个Sentinel实例。

示例

from langchain_community.utilities.redis import get_client
redis_client = get_client(
    redis_url="redis+sentinel://username:password@sentinelhost:26379/mymaster/0"
    index_name="my-index",
    embedding_function=embeddings.embed_query,
)
参数

  • redis_url (str) –

  • kwargs (Any) –

返回类型

RedisType