SEC洞察 🏦

SEC洞察利用LlamaIndex的检索增强生成（RAG）能力，回答关于美国证券交易委员会10-K和10-Q文件的问题。

您现在可以在secinsights.ai上开始使用该应用。

您还可以观看我们在YouTube上的端到端教程指南，了解该项目！本视频涵盖了产品功能、系统架构、开发环境搭建，以及如何将此应用程序与您自己的自定义文档一起使用（不仅仅是SEC申报文件！）。视频设有章节，方便您跳转到最相关的内容部分。

我们为什么要做这个？🤔

随着RAG应用从原型逐步走向生产，我们认为开发者社区会发现一个完整的、可运行的真实世界RAG应用示例非常有价值。

SEC洞察在本地和云端都能良好运行。它还具备许多可以直接应用于大多数RAG应用的产品特性。

您可以将此仓库作为构建自己RAG应用时的参考，或者直接将其Fork下来，为您的项目奠定坚实的基础。

产品特性 😎

• 基于聊天的文档问答，支持多文档池
• 引用LLM响应所依据的源数据
• PDF查看器，支持高亮显示引用内容
• 使用基于API的工具（如polygon.io）来回答定量问题
• 通过服务器发送事件实现LLM响应的token级别流式传输
• 聊天过程中推理步骤（子问题）的流式输出

开发特性 🤓

• 基础设施即代码，可直接部署到Vercel和Render
• Vercel和Render.com提供持续部署服务。只需将更改合并到main分支，即可完成发布。
• 前端和后端均提供生产环境和预览环境！轻松试用您的更改后再发布。
• 强大的本地环境设置，利用LocalStack和Docker Compose
• 监控和性能分析由Sentry提供
• 负载测试由Loader.io提供
• LLM可观性由Arize Phoenix提供
• 多种Python脚本，用于REPL式聊天和数据管理

技术栈 ⚒️

• 前端
  • React / Next.js
  • Tailwind CSS
• 后端
  • FastAPI
  • Docker
  • SQLAlchemy
  • OpenAI（gpt-3.5-turbo + text-embedding-ada-002）
  • PGVector
  • LlamaIndex 🦙
• 基础设施
  • Render.com
    • 后端托管
    • Postgres 15
  • Vercel
    • 前端托管
  • AWS
    • Cloudfront
    • S3

系统架构

使用 💻

请参阅frontend/和backend/文件夹中的README.md文件，获取各自的设置说明。如上所述，我们还在YouTube上提供了一个教程这里，介绍如何设置该项目的开发环境。

我们还在/.devcontainer/devcontainer.json中包含了一个针对GitHub Codespaces的配置文件。如果您选择使用GitHub Codespaces，您的Codespace将预先配置好运行该项目所需的大量库和系统依赖项。这可能是启动并运行该项目的最快方式！不过，开发者们也成功地在Linux、macOS和Windows环境中设置了该项目！

如果您在尝试运行该项目时有任何疑问，可以通过查阅我们的常见问题解答或浏览我们的GitHub Issues快速找到答案！如果仍未找到满意的答案，请随时创建一个新的GitHub Issue，我们将竭诚为您提供帮助！

我们还有一个专门的#sec-insights频道在Discord上，我们可以更迅速地帮助您解决一些小问题。

注意事项 🧐

• 目前前端不支持移动端
• 我们开发该项目的主要目的是为全栈RAG应用提供一个坚实的基础。在RAG性能方面仍有改进空间！

贡献 💡

我们非常欢迎各类贡献！我们期待看到 LlamaIndex 社区带来的创意和改进。

特别感谢 @Evanc123 为该项目构建前端界面的出色工作！

SEC Insights 快速上手指南

SEC Insights 是一个基于 LlamaIndex 构建的检索增强生成（RAG）应用，专门用于问答美国证券交易委员会（SEC）的 10-K 和 10-Q 文件。本项目提供了完整的端到端 RAG 应用示例，支持本地运行及云端部署。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统：Linux, macOS 或 Windows (推荐使用 WSL2)
• 核心依赖：
  • Docker 及 Docker Compose（用于本地数据库和向量存储）
  • Node.js (v18+) 及 npm/yarn
  • Python 3.9+
• API 密钥：
  • OpenAI API Key：用于调用 gpt-3.5-turbo 和 text-embedding-ada-002 模型。
  • Polygon.io API Key（可选）：用于回答量化金融数据相关问题。
• 推荐工具：
  • GitHub Codespaces：最快上手方式，预配置了所有依赖和环境。

安装步骤

方法一：使用 GitHub Codespaces（推荐）

这是最快捷的启动方式，无需在本地安装复杂依赖。

1. 点击仓库顶部的 "Open in GitHub Codespaces" 按钮。
2. 等待环境构建完成（自动安装 Python、Node.js 及系统库）。
3. 在终端中按照下方“基本使用”部分配置环境变量并启动服务。

方法二：本地手动安装

1. 克隆项目

git clone https://github.com/run-llama/sec-insights.git
cd sec-insights

2. 后端设置 (Backend)

进入后端目录并设置 Python 虚拟环境：

cd backend
python -m venv venv
source venv/bin/activate  # Windows 用户请使用: venv\Scripts\activate

# 安装依赖
pip install -r requirements.txt

配置环境变量（创建 .env 文件）：

cp .env.example .env
# 编辑 .env 文件，填入 OPENAI_API_KEY 等必要信息

启动后端服务（依赖 Docker 运行 PostgreSQL 和 PGVector）：

docker-compose up -d
# 运行数据库迁移
python scripts/migrate.py
# 启动 FastAPI 服务
uvicorn main:app --reload --host 0.0.0.0 --port 8000

3. 前端设置 (Frontend)

打开新终端窗口，进入前端目录：

cd frontend
npm install
# 如果下载缓慢，可尝试使用淘宝镜像源
# npm config set registry https://registry.npmmirror.com
# npm install

# 创建 .env.local 文件并配置后端地址
echo "NEXT_PUBLIC_API_URL=http://localhost:8000" > .env.local

# 启动开发服务器
npm run dev

基本使用

1. 访问应用： 在浏览器中打开 http://localhost:3000。

2. 上传文档：

   • 在聊天界面上传 SEC 10-K 或 10-Q 的 PDF 文件（也支持其他自定义文档）。
   • 系统将自动利用 LlamaIndex 进行索引处理。

3. 开始问答：

   • 在对话框输入关于文档内容的问题，例如：“该公司去年的营收是多少？”
   • 查看引用：回答将附带源数据引用，点击引用可在右侧 PDF 阅读器中高亮显示对应段落。
   • 流式输出：您将看到推理步骤（子问题）和最终答案的逐字流式输出。

4. 高级功能：

   • 若配置了 Polygon.io API，可直接询问需要实时金融数据计算的量化问题。
   • 通过 REPL 脚本（位于 backend/scripts）进行命令行模式的数据管理和调试。

提示：详细的前后端独立配置说明请参阅项目根目录下 frontend/README.md 和 backend/README.md。