Chat UI documentation

Обзор конфигурации

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Обзор конфигурации

Интерфейс чата настраивается через переменные окружения. Значения по умолчанию указаны в .env; их можно переопределить в .env.local или через переменные окружения.

Необходимая конфигурация

Chat UI подключается к любому API-эндпоинту, совместимому с OpenAI:

OPENAI_BASE_URL=/static-proxy?url=https%3A%2F%2Frouter.huggingface.co%2Fv1
OPENAI_API_KEY=hf_************************

Модели автоматически обнаруживаются по адресу ${OPENAI_BASE_URL}/models. Ручная настройка моделей не требуется.

База данных

MONGODB_URL=mongodb://localhost:27017
MONGODB_DB_NAME=chat-ui

Для разработки MONGODB_URL является необязательным — Chat UI переключается на встроенный MongoDB, который сохраняет данные в ./db.

Переопределения модели

Чтобы настроить поведение модели, используйте переменную окружения MODELS (формат JSON5):

MODELS=`[
  {
    "id": "meta-llama/Llama-3.3-70B-Instruct",
    "name": "Llama 3.3 70B",
    "multimodal": false,
    "supportsTools": true
  }
]`

Переопределяемые свойства:

  • id — Идентификатор модели (должен совпадать с ID из эндпоинта /models)
  • name — отображаемое имя в интерфейсе
  • multimodal — Включить загрузку изображений
  • supportsTools — Включает вызов инструментов MCP для моделей, которые не указывают поддержку инструментов
  • parameters — Переопределение параметров по умолчанию (temperature, max_tokens и т. д.)

Модель задачи

Укажите конкретную модель для внутренних задач (генерация заголовков и т. д.):

TASK_MODEL=meta-llama/Llama-3.1-8B-Instruct

Если не задано, используется текущая модель диалога.

Расшифровка речи

Включите голосовой ввод с помощью Whisper:

TRANSCRIPTION_MODEL=openai/whisper-large-v3-turbo
TRANSCRIPTION_BASE_URL=/static-proxy?url=https%3A%2F%2Frouter.huggingface.co%2Fhf-inference%2Fmodels%3C!----%3E%3C%2Fpre%3E%3C%2Fdiv%3E%3C!----%3E 

Флаги функций

LLM_SUMMARIZATION=true          # Enable automatic conversation title generation
ENABLE_DATA_EXPORT=true         # Allow users to export their data
ALLOW_IFRAME=false              # Disallow embedding in iframes (set to true to allow)

Флаги сборки

Некоторые функции фиксируются при сборке приложения, а не читаются во время выполнения, поэтому сборка либо включает их, либо не предоставляет способа их активировать:

ML_ASSISTANT_MODE=true          # Compile in ML Assistant mode (composer header strip)

Передайте его в npm run build или в качестве --build-arg для docker build. Установка этого параметра на уже собранном экземпляре не имеет эффекта.

Модели ML Assistant

Когда сборка включает режим ML Assistant, его диалоги выполняются на фиксированном наборе моделей, а не на той модели, которую выбрал пользователь в композере. Каждая запись фиксирует провайдера инференса, на котором модель была проверена для длительных циклов инструментов (npm run probe-model выполняет эту проверку); предпочтения пользователя в выборе провайдера и auto игнорируются для диалогов в этом режиме, а алиас роутера отклоняется. Первая запись является значением по умолчанию. Фиксация провайдера — это функция роутера Hugging Face, поэтому самохостинговые развёртывания получают набор моделей без этой фиксации.

ML_ASSISTANT_MODELS=`[
  {"id": "zai-org/GLM-5.3-Flash", "provider": "together", "parameters": {"max_tokens": 49152}},
  {"id": "moonshotai/Kimi-K3", "provider": "together"}
]`

Оставьте поле пустым, и композер скроет переключатель; запрос, который по-прежнему запрашивает режим, будет отклонён.

Аутентификация пользователя

Используйте OpenID Connect для аутентификации:

OPENID_CLIENT_ID=your_client_id
OPENID_CLIENT_SECRET=your_client_secret
OPENID_SCOPES="openid profile"

См. конфигурацию OpenID для получения подробной информации.

Справочник по переменным окружения

Список всех доступных параметров приведен в файле .env.

Update on GitHub