【亲测免费】 Arguflow 项目教程

1. 项目介绍

Arguflow 是一个集成了搜索、推荐、RAG（Retrieval-Augmented Generation）和分析功能的综合性基础设施项目。它通过 API 提供服务，旨在帮助开发者快速构建和部署复杂的搜索和推荐系统。Arguflow 支持自托管，可以在私有云或本地环境中运行，并且集成了多种先进的搜索和推荐技术，如语义向量搜索、全文本/神经搜索、子句高亮显示等。

2. 项目快速启动

2.1 环境准备

在开始之前，请确保您的系统已经安装了以下软件包：

• curl
• gcc
• g++
• make
• pkg-config
• python3
• python3-pip
• libpq-dev
• libssl-dev
• openssl

对于 Debian/Ubuntu 系统，可以使用以下命令安装：

sudo apt install curl gcc g++ make pkg-config python3 python3-pip libpq-dev libssl-dev openssl

2.2 安装 Node.js 和 Yarn

首先，安装 NVM（Node Version Manager）：

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash

安装完成后，重新启动终端，然后安装 Node.js 的 LTS 版本和 Yarn：

nvm install --lts
npm install -g yarn

2.3 安装 Rust

使用以下命令安装 Rust：

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

2.4 设置环境变量

复制环境变量文件到相应目录：

cp env/analytics /frontends/analytics/.env
cp env/chat /frontends/chat/.env
cp env/search /frontends/search/.env
cp env/server /server/.env
cp env/dashboard /frontends/dashboard/.env

2.5 启动 Docker 容器

使用以下命令启动 Docker 容器：

cat env/chat env/search env/server env/docker-compose > env /convenience.sh -l

2.6 启动服务

使用以下命令启动服务：

cd clients/ts-sdk
yarn build
cd frontends
yarn
yarn dev
cd server
cargo watch -x run
cd server
cargo run --bin ingestion-worker
cd server
cargo run --bin file-worker
cd server
cargo run --bin delete-worker
cd search
yarn
yarn dev

2.7 验证安装

访问 localhost:8090/redoc 查看 OpenAPI 参考文档，并确保服务正常运行。

3. 应用案例和最佳实践

3.1 语义向量搜索

Arguflow 集成了 OpenAI 或 Jina 的嵌入模型和 Qdrant，提供了语义向量搜索功能。开发者可以通过 API 上传数据并进行语义搜索，从而实现更智能的搜索体验。

3.2 全文本/神经搜索

Arguflow 支持全文本和神经搜索，通过 naver/efficient-splade-VI-BT-large-query 模型，实现了对上传数据的 typo 容忍和高质量的稀疏向量搜索。

3.3 推荐系统

Arguflow 提供了推荐 API，可以根据用户的交互行为（如收藏、点赞等）推荐相似的内容。这对于构建用户粘性强的平台非常有用。

4. 典型生态项目

4.1 Qdrant

Qdrant 是一个高效的向量搜索引擎，Arguflow 集成了 Qdrant，提供了强大的向量搜索功能。

4.2 OpenAI

OpenAI 提供了先进的自然语言处理模型，Arguflow 通过集成 OpenAI 的嵌入模型，增强了语义搜索的能力。

4.3 Jina

Jina 是一个开源的神经搜索框架，Arguflow 通过集成 Jina，提供了更多的嵌入模型选择，增强了搜索的多样性。

通过以上步骤，您可以快速启动并使用 Arguflow 项目，构建强大的搜索和推荐系统。