Delphic

存档通知：我们建议您查看该应用程序的更现代版本的OpenContracts，该版本将LlamainDex的0.10*分支与Django + PGVector集成在一起，以将Postgres用作矢量商店。对于如何构建具有大型语言模型的流响应的Django驱动应用程序，这仍然是一个很好的概念证明，但尚未维护。

我没有时间维护它，它需要许多升级才能准备好生产。让我知道您是否有兴趣接管维护。

Delphic

一个简单的框架，用于使用LlamainDex来构建和部署LLM代理，可用于分析和操纵文档中的文本数据。

许可证：麻省理工学院

获得设置

注意 /注释

Delphic的初始版本仅基于OpenAI的API。我们完全计划支持其他大型语言模型（LLM），无论是由第三方API提供的自托管还是动力。但是，目前，截至2023年4月，打开AI的API仍然可能是最有能力和最容易部署的API。由于该框架基于LlamainDex，并且与Langchain完全兼容，因此使用其他LLM将很容易。但是，目前，即使您正在自我托管此工具，您的文本也将使用OpenAI进行处理。如果Openai的服务条款给您带来了问题，我们将其留给您解决。对于您使用此工具和OpenAI API到达的任何问题，我们概不负责。

本地入门

只需运行应用程序

启动和运行的最快方法是克隆此存储库，然后在本地部署应用程序。

您将需要Docker和Docker撰写以遵循这些说明。 Digitalocean除了是一位出色的云主机外，还提供了一些最容易遵循的说明。请在此处查看它们或去Docker官方说明。

1. 首先，克隆回购：

 git clone

2. 然后，更改为目录：

 cd delphic

3. 不要忘记将示例env文件复制到./.envs/.local/（您可能需要成为超级用户/使用SUDO，具体取决于所需的位置）

 mkdir -p ./.envs/.local/
cp -a ./docs/sample_envs/local/.frontend ./frontend
cp -a ./docs/sample_envs/local/.django ./.envs/.local
cp -a ./docs/sample_envs/local/.postgres ./.envs/.local

4. 并且，下一个更新您的.django配置（您可能还需要编辑.postgres ，以使您的数据库用户一个唯一的密码）以包含OpenAI API密钥

5. 然后，构建Docker图像：

 sudo docker-compose --profile fullstack -f local.yml build

6. 最后，要启动该应用程序，请输入：

 sudo docker-compose --profile fullstack -f local.yml up

转到localhost:3000查看前端。

我想开发 /修改前端

如果您想积极开发前端，我们建议您不要使用--profile=fullstack标志，因为每个更改都需要进行完整的容器重建。相反，请参见开发环境，而不是上面的步骤＃5，

生产部署

这是假设您想在某种完全合格的域（例如delphic.opensource.legal）中向Internet提供该应用程序。为此，您需要更新几个配置。

TODO-插入文档

使用该应用程序

设置用户

为了实际使用该应用程序（目前，我们打算使与未经验证的用户共享某些模型成为可能），您需要登录。您可以使用Superuser或非Superuser。无论哪种情况，有人都需要首先使用控制台创建超级用户：

为什么要设置Django Superuser？ Django Superuser具有应用程序中的所有权限，并且可以管理系统的所有方面，包括创建，修改和删除用户，收集和其他数据。设置超级用户可以使您能够完全控制和管理应用程序。

警告 /免责声明

**目前，登录的任何用户都将具有完整的权限。我们计划实现为OpenContracts开发的更精确的，基于角色的访问控制模块，但是，现在，请注意，任何具有任何类型的登录凭据的人都可以创建和删除集合。创建收藏品使用OpenAi积分 /费用

首先，设置Django Superuser：

1. 运行以下命令创建超级用户：

 sudo docker-compose -f local.yml run django python manage.py createsuperuser

2. 将提示您为超级用户提供用户名，电子邮件地址和密码。输入所需的信息。

第二（如果需要），设置其他用户

按照部署说明在本地启动您的Delphic应用程序。

1. 通过导航到http：// localhost：8000/admin在浏览器中访问django管理员界面。
2. 使用您之前创建的超级用户凭据登录。
3. 单击“用户”部分中的“用户”链接。
4. 单击右上角的“添加用户 +”按钮。
5. 输入新用户的所需信息，例如用户名和密码。单击“保存”以创建用户。
6. 要授予新用户的额外权限或使其成为超级用户，请单击用户列表中的用户名，向下滚动到“权限”部分，然后相应地配置其权限。保存您的更改。

创建和查询集合

警告 - 如果您将OpenAI用作LLM引擎，则任何收集互动都将使用API​​积分 /成本金钱。如果您使用自己的OpenAI API密钥，您还接受了他们的服务条款，这可能不适合您的用例。请自己勤奋。

要访问提问界面，请提起全幕，然后访问http://localhost:3000

delphic.demo.mp4

发展环境

如果您想为Delphic做出贡献或滚动自己的版本，则需要确保设置开发环境。

后端设置

在后端，您需要拥有一个工作的Python环境来运行预订格式检查。您可以使用系统Python解释器，但是我们建议使用Pyenv并创建基于Python> = 3.10的虚拟Env。

预先设置

然后，在您本地存储库的根部运行以下命令：

 pip install -r ./requirements/local.txt
pre-commit install

现在，当您进行提交时，OU AR代码格式和样式检查将自动运行。

运行测试

我们有一个基本的测试套件./tests您可以通过输入来运行测试：

 sudo docker-compose -f local.yml run django python manage.py test

前端设置

在前端，我们使用节点V18.15.0。我们假设您正在使用NVM。我们还没有任何前端测试（对不起）。

设置和启动节点开发服务器

CD进入前端目录，安装前端依赖项并启动开发服务器（请注意，我们假设您已安装了NVM。如果您现在不安装它）：

 cd frontend
nvm use
npm install yarn
yarn install

键入yarn start将在http://localhost:3000上启动您的前端开发服务器。您仍然需要启动后端才能使其正常工作。

运行后端撰写堆栈，而无需fullstack配置标志

在没有全面标志的情况下启动后端：

 sudo docker-compose -f local.yml up