Hugging Face 的 logo

聊天 UI 文档

复制 HuggingChat

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验

开始使用

复制 HuggingChat

HuggingChat 的配置文件存储在 chart/env/prod.yaml 文件中。它是我们 CI/CD 管道中使用的环境变量的真相来源。对于 HuggingChat，由于我们需要自定义应用程序颜色以及基本路径，因此我们构建了一个自定义 Docker 镜像。你可以在这里找到工作流程。

如果你想更改 HuggingChat 生产环境中使用的模型配置，则应该针对 chart/env/prod.yaml 进行更改。

在本地运行 HuggingChat 的副本

如果你想在本地运行 HuggingChat 的精确副本，你需要先执行以下操作

  1. 在 hub 上创建一个具有 openid profile email 权限的 OAuth 应用。确保将回调 URL 设置为类似于 http://localhost:5173/chat/login/callback 的内容，该内容与你的本地实例的正确路径相匹配。
  2. 使用你的 Hugging Face 帐户创建一个 HF 令牌。你需要一个专业帐户才能访问 HuggingChat 提供的一些大型模型。
  3. 在 serper.dev 上创建一个免费帐户（你将获得 2500 次免费搜索查询）
  4. 以任何你想要的方式运行 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 脚本使用假数据填充数据库

npm run populate <flags here>

必须指定至少一个标志，以下标志可用

  • reset - 重置数据库
  • all - 填充所有表格
  • users - 填充用户表格
  • settings - 为现有用户填充设置表格
  • assistants - 为现有用户填充助手表格
  • conversations - 为现有用户填充对话表格

例如，你可以这样使用它

npm run populate reset

清除数据库。然后登录应用程序以创建你的用户并运行以下命令

npm run populate users settings assistants conversations

使用假数据填充数据库，包括你的用户的假对话和助手。

< > 更新 在 GitHub 上

←架构