Chat UI documentation

Resumen de la configuración

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Resumen de la configuración

La interfaz de chat se configura mediante variables de entorno. Los valores predeterminados están en .env; puedes sobrescribirlos en .env.local o a través de tu entorno.

Configuración requerida

La interfaz de chat se conecta a cualquier punto de finalización de API compatible con OpenAI:

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

Los modelos se detectan automáticamente desde ${OPENAI_BASE_URL}/models. No se requiere configuración manual de modelos.

Base de datos

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

Para el desarrollo, MONGODB_URL es opcional: la interfaz de Chat usa una instancia de MongoDB integrada que persiste en ./db.

Sobrescrituras de modelo

Para personalizar el comportamiento del modelo, use la variable de entorno MODELS (formato JSON5):

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

Propiedades de anulación:

  • id - Identificador del modelo (debe coincidir con un ID del endpoint /models)
  • name - Nombre para mostrar en la interfaz de usuario
  • multimodal - Habilitar la carga de imágenes
  • supportsTools - Habilita la invocación de herramientas MCP para modelos que no anuncian soporte para herramientas
  • parameters - Anula los parámetros predeterminados (temperature, max_tokens, etc.)

Modelo de tarea

Establecer un modelo específico para tareas internas (generación de títulos, etc.):

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

Si no se establece, se utiliza el modelo de conversación actual.

Transcripción de voz

Activar la entrada de voz con 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 

Banderas de características

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)

Banderas de compilación

Algunas características se fijan cuando la aplicación se compila, en lugar de leerse en tiempo de ejecución, por lo que una compilación las incluye o no tiene forma de activarlas:

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

Pásalo a npm run build o como --build-arg a docker build. Establecerlo en una instancia ya construida no tiene efecto.

Modelos de Asistente de ML

When the build ships ML Assistant mode, its conversations run on a fixed model set rather than whatever the composer has selected. Each entry pins the inference provider the model was verified on for long tool loops (npm run probe-model runs that verification); the user’s provider preference and auto are ignored for mode conversations, and the router alias is rejected. The first entry is the default. The provider pin is a Hugging Face router feature, so self-hosted deployments get the model set without it.

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

Déjalo vacío y el compositor oculta el interruptor; una solicitud que aún pide el modo se rechaza.

Autenticación de usuario

Use OpenID Connect para la autenticación:

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

Consulte configuración de OpenID para obtener más detalles.

Referencia de variables de entorno

Consulte el archivo .env para obtener la lista completa de opciones disponibles.

Update on GitHub