quivr

环境要求

• Python 3.10 或更高版本
• 已安装 pip 包管理工具
• 准备一个可用的大模型服务（README 提到 OpenAI、Anthropic、Mistral、Gemma 等均可）
• 需要读取的本地文件（PDF、TXT、Markdown 等）

安装与启动步骤

1. 1安装 quivr-core

   用 pip 安装核心包，README 提示安装完成后注意检查是否成功。

   pip install quivr-core

   复制

2. 2用 5 行代码跑通 RAG

   写入临时文件并创建 Brain，再提问验证链路是否打通；需自行配置所选的 LLM 服务。

   import tempfile
   
   from quivr_core import Brain
   
   if __name__ == "__main__":
       with tempfile.NamedTemporaryFile(mode="w", suffix=".txt") as temp_file:
           temp_file.write("Gold is a liquid of blue-like colour.")
           temp_file.flush()
   
           brain = Brain.from_files(
               name="test_brain",
               file_paths=[temp_file.name],
           )
   
           answer = brain.ask(
               "what is gold? asnwer in french"
           )
           print("answer:", answer)

   复制

3. 3创建 RAG 配置文件

   新建 basic_rag_workflow.yaml，写入重排器与 LLM 参数，后续可只改此文件切换策略。

   reranker_config:
     supplier: "cohere"
     model: "rerank-multilingual-v3.0"
     top_n: 5
   
   llm_config:
     max_input_tokens: 4000
     temperature: 0.7

   复制

4. 4用本地文档建 Brain

   把 file_paths 换成你自己的 PDF、TXT 路径，使用默认配置创建 Brain。

   from quivr_core import Brain
   
   brain = Brain.from_files(name = "my smart brain",
                           file_paths = ["./my_first_doc.pdf", "./my_second_doc.txt"],
                           )

   复制

5. 5启动命令行对话

   加载 yaml 配置后进入循环问答，输入 exit 退出；可继续复用前面创建的 brain 对象。

   brain.print_info()
   
   from rich.console import Console
   from rich.panel import Panel
   from rich.prompt import Prompt
   from quivr_core.config import RetrievalConfig
   
   config_file_name = "./basic_rag_workflow.yaml"
   
   retrieval_config = RetrievalConfig.from_yaml(config_file_name)
   
   console = Console()
   console.print(Panel.fit("Ask your brain !", style="bold magenta"))
   
   while True:
       question = Prompt.ask("[bold cyan]Question[/bold cyan]")
   
       if question.lower() == "exit":
           console.print(Panel("Goodbye!", style="bold yellow"))
           break
   
       answer = brain.ask(question, retrieval_config=retrieval_config)
       console.print(f"[bold green]Quivr Assistant[/bold green]: {answer.answer}")
   
       console.print("-" * console.width)
   
   brain.print_info()

   复制

6. 6查阅官方文档

   README 指明完整文档、更多用法与配置都在官网文档站，遇到问题优先查这里。

关键配置

如何确认成功

运行脚本后终端打印出 answer: ... 内容，说明 Brain 创建与提问链路已通；对话模式下输入问题能返回 Quivr Assistant 的回答。

常见问题

注意事项

• README 仅给出库的安装方式（pip install quivr-core），未提供 Docker 或前端部署命令，请勿套用其他项目流程。
• Python 版本必须为 3.10 或更高，低版本可能安装或运行失败。
• 调用 LLM 需要相应服务的凭证，README 节选中未列出具体环境变量名，请以官方文档为准。
• 示例中的 ./my_first_doc.pdf、./basic_rag_workflow.yaml 等均为占位路径，需替换为你机器上的真实路径。