Verba

The Golden RAGtriever - 社区版 ✨

欢迎使用 Verba：The Golden RAGtriever，这是一个社区驱动的开源应用程序，旨在提供一个开箱即用、端到端、简化且用户友好的检索增强生成（RAG）界面。只需几个简单的步骤，即可轻松探索您的数据集并提取洞察，无论是通过本地的 Ollama 和 Huggingface，还是通过 Anthrophic、Cohere 和 OpenAI 等 LLM 提供商。这个项目是为社区而建，也由社区共建，请注意，它的维护可能不如其他 Weaviate 生产应用程序那样及时。欢迎随时为项目做出贡献，帮助我们让 Verba 变得更好！<3

pip install goldenverba

• Verba
• 🎯 什么是 Verba？
• ✨ 功能特性
• ✨ 开始使用 Verba
• 🔑 API 密钥
• Weaviate
• Ollama
• Unstructured
• AssemblyAI
• OpenAI
• HuggingFace
• Groq
• Novita AI
• 快速开始：使用 pip 部署
• 快速开始：从源码构建
• 快速开始：使用 Docker 部署
• 💾 Verba 使用指南
• 💖 开源贡献
• 🚩 已知问题
• ❔ 常见问题

什么是 Verba？

Verba 是一个完全可定制的个人助手，利用检索增强生成（RAG）来查询和与您的数据交互，支持本地或云端部署。它可以解答关于您的文档的问题，交叉引用多个数据点，或从现有知识库中获取洞察。Verba 将最先进的 RAG 技术与 Weaviate 的上下文感知数据库相结合。您可以根据个人用例，在不同的 RAG 框架、数据类型、分块与检索技术以及 LLM 提供商之间进行选择。

开源精神

Weaviate 很自豪能为社区提供这个开源项目。虽然我们努力尽快解决问题，但请理解，它的维护可能不如生产软件那样严格。我们欢迎并鼓励社区贡献，以帮助其平稳运行。非常感谢您帮助我们快速修复开放问题。

在此观看我们最新的 Verba 视频：

功能特性列表

缺少了什么功能？欢迎创建新的 Issue 或讨论来提出您的想法！

开始使用 Verba

您有三种部署 Verba 的选项：

• 通过 pip 安装

pip install goldenverba

• 从源码构建

git clone https://github.com/weaviate/Verba

pip install -e .

• 使用 Docker 部署

前提条件：如果不使用 Docker，请确保您的系统已安装 Python >=3.10.0,<3.13.0。

git clone https://github.com/weaviate/Verba

docker compose --env-file <your-env-file> up -d --build

如果您不熟悉 Python 和虚拟环境，请阅读 Python 教程指南。

API 密钥和环境变量

您可以在 Verba 前端设置所有 API 密钥，但为了简化操作，我们也可以准备一个 .env 文件，Verba 会自动在其中查找密钥。在您要启动 Verba 的同一目录中创建一个 .env 文件。您可以在 goldenverba 目录中找到 .env.example 文件。

确保只设置您打算使用的环境变量，缺失或不正确的环境变量值可能导致错误。

以下是您可能需要的 API 密钥和变量的完整列表：

Weaviate

Verba 根据您的需求提供了连接 Weaviate 实例的灵活性。您有三种选择：

1. 本地部署：使用 Weaviate Embedded，它在您的设备上本地运行（Windows 除外，请选择 Docker/云部署）
2. Docker 部署：当您运行 Verba 的 Dockerfile 时选择此选项。
3. 云部署：使用托管在 WCD 上的现有 Weaviate 实例来运行 Verba

💻 Weaviate Embedded
Embedded Weaviate 是一种部署模式，它从您的应用程序代码中运行 Weaviate 实例，而不是从独立的 Weaviate 服务器安装中运行。当您在 Local Deployment 模式下运行 Verba 时，它将在后台设置和管理 Embedded Weaviate。请注意，Weaviate Embedded 在 Windows 上不受支持，并且处于实验模式，可能会带来意外错误。我们建议使用 Docker 部署或云部署。您可以在这里阅读更多关于 Weaviate Embedded 的信息。

🌩️ Weaviate 云部署 (WCD)

如果您更喜欢基于云的解决方案，Weaviate Cloud (WCD) 提供了一个可扩展的托管环境。按照 Weaviate 集群设置指南 学习如何设置云集群并获取 API 密钥。

🐳 Docker 部署
另一种本地替代方案是使用 Docker 部署 Weaviate。更多详情，请遵循 如何使用 Docker 安装 Verba 部分。

⚙️ 自定义 Weaviate 部署

如果您自己托管 Weaviate，可以在 Verba 中使用 Custom 部署选项。这将允许您指定 Weaviate 实例的 URL、端口和 API 密钥。

Ollama

Verba 支持 Ollama 模型。在您的设备上下载并安装 Ollama (https://ollama.com/download)。确保使用