Chat UI documentation

Tổng quan về Cấu hình

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Tổng quan về Cấu hình

Giao diện Chat được cấu hình thông qua các biến môi trường. Giá trị mặc định nằm trong .env; ghi đè chúng trong .env.local hoặc thông qua môi trường của bạn.

Cấu hình bắt buộc

Chat UI kết nối với bất kỳ điểm cuối API tương thích OpenAI nào:

OPENAI_BASE_URL=https://router.huggingface.co/v1
OPENAI_API_KEY=hf_************************

Các mô hình được phát hiện tự động từ ${OPENAI_BASE_URL}/models. Không cần cấu hình mô hình thủ công.

Cơ sở dữ liệu

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

Để phát triển, MONGODB_URL là tùy chọn - Chat UI sẽ chuyển sang MongoDB nhúng được lưu trữ tại ./db.

Ghi đè Mô hình

Để tùy chỉnh hành vi của mô hình, hãy sử dụng biến môi trường MODELS (định dạng JSON5):

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

Ghi đè các thuộc tính:

  • id - Định danh mô hình (phải khớp với một ID từ endpoint /models)
  • name - Tên hiển thị trong giao diện người dùng
  • multimodal - Bật tải lên hình ảnh
  • supportsTools - Bật gọi công cụ MCP cho các mô hình không công bố hỗ trợ công cụ
  • parameters - Ghi đè các tham số mặc định (temperature, max_tokens, v.v.)

Mô hình tác vụ

Đặt một mô hình cụ thể cho các tác vụ nội bộ (tạo tiêu đề, v.v.):

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

Nếu không được đặt, mô hình hội thoại hiện tại sẽ được sử dụng.

Chuyển văn bản giọng nói

Bật nhập liệu giọng nói với Whisper:

TRANSCRIPTION_MODEL=openai/whisper-large-v3-turbo
TRANSCRIPTION_BASE_URL=https://router.huggingface.co/hf-inference/models

Cờ tính năng

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)

Cờ Build

Một số tính năng được cố định khi ứng dụng được xây dựng thay vì được đọc vào thời điểm chạy, do đó bản build sẽ bao gồm chúng hoặc không có cách nào để bật chúng lên:

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

Truyền nó vào npm run build, hoặc dưới dạng --build-arg cho docker build. Việc thiết lập nó trên một instance đã được build sẽ không có hiệu lực.

ML Assistant Models

Khi bản build phát hành chế độ ML Assistant, các cuộc hội thoại của nó sẽ chạy trên một bộ mô hình cố định thay vì mô hình mà composer đã chọn. Mỗi mục cố định nhà cung cấp suy luận mà mô hình đã được xác minh cho các vòng lặp công cụ dài (npm run probe-model chạy xác minh đó); sở thích nhà cung cấp của người dùng và auto bị bỏ qua đối với các cuộc hội thoại của chế độ, và alias của router bị từ chối. Mục đầu tiên là mặc định. Việc cố định nhà cung cấp là một tính năng của router Hugging Face, vì vậy các triển khai tự lưu trữ sẽ nhận được bộ mô hình mà không có nó.

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

Để trống và composer sẽ ẩn công tắc; một yêu cầu vẫn yêu cầu chế độ sẽ bị từ chối.

Xác thực người dùng

Sử dụng OpenID Connect để xác thực:

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

Xem cấu hình OpenID để biết thêm chi tiết.

Tham chiếu biến môi trường

Xem tệp .env để biết danh sách đầy đủ các tùy chọn khả dụng.

Update on GitHub