获取客户端#

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

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

不支持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哨兵的Redis复制设置，请将“redis_url”设置为“redis+sentinel://”方案。使用此URL格式时，需要一个路径来保存哨兵中的Redis服务名称，以获取正确的Redis服务器连接。默认的服务名称是“mymaster”。路径的可选第二部分是要连接的Redis数据库编号。

可选的用户名或密码用于与rediserver和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,
)
Parameters:

  • redis_url (str)

  • kwargs (Any)

Return type:

Redis类型

On this page