rag-redis
这个模板使用 Redis(向量数据库)和 OpenAI(LLM)对 Nike 公司的财务 10k 报告文档执行 RAG。
它依赖于句子转换器 all-MiniLM-L6-v2
来嵌入 PDF 文件的片段和用户问题。
环境设置
设置 OPENAI_API_KEY
环境变量以访问 OpenAI 模型:
export OPENAI_API_KEY= <YOUR OPENAI API KEY>
设置以下 Redis 环境变量:
export REDIS_HOST = <YOUR REDIS HOST>
export REDIS_PORT = <YOUR REDIS PORT>
export REDIS_USER = <YOUR REDIS USER NAME>
export REDIS_PASSWORD = <YOUR REDIS PASSWORD>
支持的设置
我们使用各种环境变量来配置此应用程序
| 环境变量 | 描述 | 默认值 |
|----------------------|-----------------------------------|---------------|
| DEBUG
| 启用或禁用 Langchain 调试日志 | True |
| REDIS_HOST
| Redis 服务器的主机名 | "localhost" |
| REDIS_PORT
| Redis 服务器的端口 | 6379 |
| REDIS_USER
| Redis 服务器的用户 | "" |
| REDIS_PASSWORD
| Redis 服务器的密码 | "" |
| REDIS_URL
| 连接到 Redis 的完整 URL | None
,如果未提供,则从用户、密码、主机和端口构造 |
| INDEX_NAME
| 向量索引的名称 | "rag-redis" |
用法
要使用此软件包,您应首先在 Python 虚拟环境中安装 LangChain CLI 和 Pydantic:
pip install -U langchain-cli pydantic==1.10.13
要创建一个新的 LangChain 项目并将其安装为唯一软件包,您可以执行:
langchain app new my-app --package rag-redis
如果您想将其添加到现有项目中,只需运行:
langchain app add rag-redis
并将以下代码片段添加到您的 app/server.py
文件中:
from rag_redis.chain import chain as rag_redis_chain
add_routes(app, rag_redis_chain, path="/rag-redis")
(可选)现在让我们配置 LangSmith。 LangSmith 将帮助我们跟踪、监视和调试 LangChain 应用程序。 您可以在这里注册 LangSmith。 如果您没有访问权限,可以跳过此部分
export LANGCHAIN_TRACING_V2=true
export LANGCHAIN_API_KEY=<your-api-key>
export LANGCHAIN_PROJECT=<your-project> # 如果未指定,默认为 "default"
如果您在此目录中,那么您可以通过以下方式直接启动 LangServe 实例:
langchain serve
这将启动 FastAPI 应用程序,服务器在本地运行,地址为 http://localhost:8000 我们可以在 http://127.0.0.1:8000/docs 查看所有模板 我们可以在 http://127.0.0.1:8000/rag-redis/playground 访问 playground 我们可以通过以下代码访问模板:
from langserve.client import RemoteRunnable
runnable = RemoteRunnable("http://localhost:8000/rag-redis")