ragbase 的安装和配置教程

2025-05-18 15:07:47作者：卓艾滢Kingsley

1. 项目基础介绍和主要编程语言

ragbase 是一个完全本地的 RAG（Retrieval-Augmented Generation）项目，它允许用户通过聊天界面与 PDF 文档进行交互。该项目利用了自然语言处理（NLP）技术，可以让用户就文档内容提出问题，并得到基于文档信息的回答。ragbase 的主要编程语言是 Python，同时也使用了 Jupyter Notebook 来展示示例和实验结果。

2. 项目使用的关键技术和框架

该项目使用了一系列的关键技术和框架，主要包括：

Ollama：一个可以在本地运行的 LLM（Large Language Model）框架。
Groq API：用于快速推理的 API，支持多种 LLM。
LangChain：用于构建基于 LLM 的应用程序。
Qdrant：一个向量搜索/数据库，用于存储和检索文档的向量表示。
FlashRank：一个快速的重新排序工具，用于优化搜索结果。
FastEmbed：轻量级且快速的嵌入向量生成工具。
Streamlit：用于构建数据应用的 UI 界面。
PDFium：用于处理 PDF 文档并提取文本。

3. 项目安装和配置的准备工作及详细步骤

准备工作

在开始安装 ragbase 之前，请确保您的计算机上已安装以下环境和工具：

Python 3.x
Git
Poetry（用于依赖管理）

安装步骤

克隆项目仓库

打开命令行界面，执行以下命令来克隆项目仓库：
```
git clone git@github.com:curiousily/ragbase.git
cd ragbase
```
安装依赖

使用 Poetry 安装项目所需的依赖：
```
poetry install
```
获取 LLM

项目默认使用 gemma2:9b 作为 LLM，您可以执行以下命令来获取：
```
ollama pull gemma2:9b
```
如果您希望使用其他 LLM，可以根据需要进行更改。
运行 Ollama 服务器

启动 Ollama 服务器，以便可以在应用中使用 LLM：
```
ollama serve
```
启动 RagBase

最后，运行以下命令启动 ragbase 应用：
```
poetry run streamlit run app.py
```
运行成功后，您应该能在浏览器中看到一个基于 Streamlit 构建的聊天界面，通过它就可以与您的 PDF 文档进行交互了。