rag-search

环境要求

• Python 环境（可运行 pip 与 uvicorn）
• OpenAI 兼容的 API（OPENAI_API_KEY / OPENAI_BASE_URL）
• Zilliz（Milvus）向量库的 URI 与 Token
• Serper 搜索服务的 SERPER_API_KEY
• 可访问外网以调用上述第三方服务

安装与启动步骤

1. 1准备 .env 文件

   在项目根目录新建 .env，按 README 模板逐项填写搜索、OpenAI、Zilliz 与鉴权配置，留空的项服务会不可用。

   SERPER_API_KEY=
   OPENAI_BASE_URL=
   OPENAI_API_KEY=
   OPENAI_MODEL=gpt-3.5-turbo
   OPENAI_EMBED_MODEL=text-embedding-ada-002
   
   ZILLIZ_URI=
   ZILLIZ_TOKEN=
   ZILLIZ_DIM=1536
   ZILLIZ_COLLECTION=
   
   AUTH_API_KEY=

   复制

2. 2安装依赖

   在项目根目录执行，按 requirements.txt 安装 FastAPI、uvicorn 等运行依赖，建议先建虚拟环境。

   pip install -r requirements.txt

   复制

3. 3启动 FastAPI 服务

   在项目根目录用 uvicorn 启动 main:app，默认监听 8069 端口，--reload 便于开发时热更新。

   uvicorn main:app --reload --port 8069

   复制

4. 4验证 ping 接口

   服务起来后访问根路径，确认进程与路由正常，再继续调用检索接口。

   GET http://127.0.0.1:8069/

   复制

5. 5调用 RAG 搜索

   向 /rag-search 发 POST，请求头带 Bearer 鉴权，body 控制检索条数、是否重排与阈值过滤。

   {
       "query": "ThinkAny.AI",
       "search_n": 10,
       "search_provider": "google",
       "is_reranking": true,
       "is_detail": true,
       "detail_min_score": 0.7,
       "detail_top_k": 3,
       "is_filter": true,
       "filter_min_score": 0.8,
       "filter_top_k": 6
   }

   复制

关键配置

如何确认成功

浏览器或客户端访问 http://127.0.0.1:8069/ 的 GET ping 接口能正常返回，即代表服务启动成功。

常见问题

注意事项

• .env 必须放在项目根目录，服务启动时读取。
• OPENAI_MODEL 默认 gpt-3.5-turbo，OPENAI_EMBED_MODEL 默认 text-embedding-ada-002，改动嵌入模型时需同步设置 ZILLIZ_DIM。
• ZILLIZ_DIM、ZILLIZ_COLLECTION 等其余配置项也需按 .env 模板补齐，否则相关功能不可用。
• 该服务依赖 Serper、OpenAI、Zilliz 三方密钥，建议先各自申请并验证可用后再启动。