Chat UI 文件
復刻 HuggingChat
加入 Hugging Face 社群
並獲得增強的文件體驗
開始使用
復刻 HuggingChat
HuggingChat 的配置檔案儲存在 chart/env/prod.yaml
檔案中。它是我們 CI/CD 管道所用環境變數的真實來源。對於 HuggingChat,由於我們需要自定義應用顏色和基礎路徑,我們構建了一個自定義的 docker 映象。你可以在這裡找到工作流。
如果你想更改 HuggingChat 在生產環境中使用的模型配置,你應該針對 chart/env/prod.yaml
進行操作。
在本地執行 HuggingChat 的副本
如果你想在本地執行 HuggingChat 的精確副本,你需要先完成以下操作:
- 在 Hub 上建立一個 OAuth 應用,並賦予其
openid profile email
許可權。確保將回調 URL 設定為類似於https://:5173/chat/login/callback
的地址,以匹配你本地例項的正確路徑。 - 使用你的 Hugging Face 賬戶建立一個 HF Token。你需要一個 Pro 賬戶才能訪問透過 HuggingChat 提供的一些較大型號的模型。
- 在 serper.dev 上建立一個免費賬戶(你將獲得 2500 次免費搜尋查詢)。
- 以任何你喜歡的方式(本地或遠端)執行一個 MongoDB 例項。
然後,你可以建立一個新的 .env.SECRET_CONFIG
檔案,內容如下:
MONGODB_URL=<link to your mongo DB from step 4>
HF_TOKEN=<your HF token from step 2>
OPENID_CONFIG=`{
PROVIDER_URL: "https://huggingface.co",
CLIENT_ID: "<your client ID from step 1>",
CLIENT_SECRET: "<your client secret from step 1>",
}`
SERPER_API_KEY=<your serper API key from step 3>
MESSAGES_BEFORE_LOGIN=<can be any numerical value, or set to 0 to require login>
然後你可以在 chat-ui 的根目錄下執行 npm run updateLocalEnv
。這將建立一個 .env.local
檔案,它結合了 chart/env/prod.yaml
和 .env.SECRET_CONFIG
檔案。之後,你可以執行 npm run dev
來啟動你的 HuggingChat 本地例項。
填充資料庫
此指令碼使用的 MONGODB_URL
將從 .env.local
中獲取。請確保它是正確的!該命令直接在資料庫上執行。
你可以使用 populate
指令碼,透過 faker 資料來填充資料庫:
npm run populate <flags here>
必須至少指定一個標誌,可用的標誌如下:
reset
- 重置資料庫all
- 填充所有表users
- 填充使用者表settings
- 為現有使用者填充設定表assistants
- 為現有使用者填充助手錶conversations
- 為現有使用者填充對話表
例如,你可以這樣使用:
npm run populate reset
來清空資料庫。然後在應用中登入以建立你的使用者,並執行以下命令:
npm run populate users settings assistants conversations
來用假資料填充資料庫,包括為你的使用者建立的假對話和助手。
< > 在 GitHub 上更新