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