与 GitHub 仓库聊天

此仓库包含 Python 脚本，演示如何使用 Streamlit、OpenAI GPT-3.5-turbo 和 Activeloop 的 Deep Lake 构建聊天机器人。

该聊天机器人会搜索存储在 Deep Lake 中的数据集，从任意 Git 仓库中找到相关信息，并根据用户输入生成回复。

文件

• src/utils/process.py：此脚本会克隆一个 Git 仓库，处理其中的文本文件，使用 OpenAIEmbeddings 计算嵌入向量，并将这些向量存储到 DeepLake 实例中。

• src/utils/chat.py：此脚本创建了一个 Streamlit Web 应用程序，用于与用户和 DeepLake 实例交互，借助 OpenAI GPT-3.5-turbo 生成聊天机器人回复。

• src/main.py：此脚本包含命令行界面 (CLI)，允许您运行聊天机器人应用程序。

设置

在开始之前，请确保注册 Activeloop 和 OpenAI 账户，并创建 API 密钥。

要设置并运行该项目，请按照以下步骤操作：

1. 克隆仓库并进入项目目录：

git clone https://github.com/peterw/Chat-with-Git-Repo.git
cd Chat-with-Git-Repo

2. 使用 pip 安装所需依赖包：

pip install -r requirements.txt

如需安装开发依赖，可执行以下命令：

pip install -r dev-requirements.txt

3. 设置环境变量：

复制 .env.example 文件：

cp .env.example .env

填写您的 API 密钥和用户名：

OPENAI_API_KEY=your_openai_api_key
ACTIVELOOP_TOKEN=your_activeloop_api_token
ACTIVELOOP_USERNAME=your_activeloop_username

4. 使用 CLI 运行聊天机器人应用程序。您可以选择处理一个 Git 仓库，也可以使用现有数据集启动聊天应用。

如需完整的 CLI 指令，请运行 python src/main.py --help

要处理一个 Git 仓库，使用 process 子命令：

python src/main.py process --repo-url https://github.com/username/repo_name

您还可以指定其他选项，例如在处理仓库时要包含的文件扩展名、DeepLake 数据集的名称，以及克隆仓库的目标路径：

python src/main.py process --repo-url https://github.com/username/repo_name --include-file-extensions .md .txt --activeloop-dataset-name my-dataset --repo-destination repos

要使用现有数据集启动聊天应用，使用 chat 子命令：

python src/main.py chat --activeloop-dataset-name my-dataset

Streamlit 聊天应用将会运行，您可以在 http://localhost:8501（或下一个可用端口）与聊天机器人互动，询问有关该仓库的问题。

赞助商

✨ 更快地发现盈利机会：Exploding Insights

许可证

MIT 许可证

Chat-with-Git-Repo 快速上手指南

本工具允许你通过自然语言与任意 GitHub 仓库进行对话。它利用 Streamlit 构建界面，结合 OpenAI GPT-3.5-turbo 生成回答，并使用 Activeloop Deep Lake 存储和检索代码库中的相关信息。

环境准备

在开始之前，请确保满足以下条件：

• 系统要求：Python 3.8+ 环境，已安装 git。
• 账号准备：
  • OpenAI 账号及 API Key。
  • Activeloop 账号、API Token 及用户名。
• 网络提示：由于涉及访问 GitHub、OpenAI 及 Activeloop 服务，国内开发者可能需要配置代理或使用加速方案以确保连接稳定。

安装步骤

1. 克隆项目并进入目录：

   git clone https://github.com/peterw/Chat-with-Git-Repo.git
   cd Chat-with-Git-Repo
   

2. 安装依赖包： （如需国内加速，可添加 -i https://pypi.tuna.tsinghua.edu.cn/simple 参数）

   pip install -r requirements.txt
   

3. 配置环境变量： 复制示例配置文件并填入你的密钥信息：

   cp .env.example .env
   

   编辑 .env 文件，填入以下内容：

   OPENAI_API_KEY=your_openai_api_key
   ACTIVELOOP_TOKEN=your_activeloop_api_token
   ACTIVELOOP_USERNAME=your_activeloop_username
   

基本使用

本工具通过命令行接口（CLI）进行操作，主要包含“处理仓库”和“启动对话”两个步骤。

1. 处理 GitHub 仓库

首先将目标仓库的代码转换为向量数据并存储到 Deep Lake。以下命令以处理任意公开仓库为例：

python src/main.py process --repo-url https://github.com/username/repo_name

可选参数：你可以指定仅处理特定后缀的文件（如 .md, .txt），或自定义数据集名称：

python src/main.py process --repo-url https://github.com/username/repo_name --include-file-extensions .md .txt --activeloop-dataset-name my-dataset

2. 启动聊天应用

数据处理完成后，使用以下命令启动 Streamlit 网页界面：

python src/main.py chat --activeloop-dataset-name my-dataset

启动成功后，终端会显示访问地址（通常为 http://localhost:8501）。在浏览器中打开该地址，即可输入关于该仓库代码的问题，AI 将基于仓库内容生成回答。