Chat UI documentation
Visão geral da configuração
Visão geral da configuração
A interface de chat é configurada por meio de variáveis de ambiente. Os valores padrão estão em .env; substitua-os em .env.local ou por meio do seu ambiente.
Configuração Obrigatória
A interface de chat se conecta a qualquer endpoint de API compatível com a OpenAI:
OPENAI_BASE_URL=/static-proxy?url=https%3A%2F%2Frouter.huggingface.co%2Fv1
OPENAI_API_KEY=hf_************************Os modelos são descobertos automaticamente em ${OPENAI_BASE_URL}/models. Não é necessária configuração manual de modelos.
Banco de dados
MONGODB_URL=mongodb://localhost:27017
MONGODB_DB_NAME=chat-uiPara desenvolvimento, MONGODB_URL é opcional - a Chat UI usa um MongoDB embutido que persiste em ./db.
Substituições de Modelo
Para personalizar o comportamento do modelo, use a variável de ambiente MODELS (formato JSON5):
MODELS=`[
{
"id": "meta-llama/Llama-3.3-70B-Instruct",
"name": "Llama 3.3 70B",
"multimodal": false,
"supportsTools": true
}
]`Propriedades de substituição:
id- Identificador do modelo (deve corresponder a um ID do endpoint/models)name- Nome de exibição na interfacemultimodal- Ativar o envio de imagenssupportsTools- Ativa a chamada de ferramentas MCP para modelos que não anunciam suporte a ferramentasparameters- Substitui os parâmetros padrão (temperature, max_tokens, etc.)
Modelo de Tarefa
Defina um modelo específico para tarefas internas (geração de títulos, etc.):
TASK_MODEL=meta-llama/Llama-3.1-8B-InstructSe não for definido, o modelo de conversa atual é usado.
Transcrição de Voz
Ative a entrada de voz com 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 Bandeiras de Funcionalidade
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)
Flags de Compilação
Algumas funcionalidades são fixadas quando o aplicativo é compilado, em vez de serem lidas em tempo de execução, portanto uma compilação ou as inclui ou não tem como ativá-las:
ML_ASSISTANT_MODE=true # Compile in ML Assistant mode (composer header strip)
Passe-o para npm run build, ou como um --build-arg para docker build. Definir isso em uma instância já construída não tem efeito.
Modelos do Assistente 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"}
]`
Deixe-o vazio e o compositor oculta o interruptor; uma solicitação que ainda solicita o modo é recusada.
Autenticação de Usuário
Use OpenID Connect para autenticação:
OPENID_CLIENT_ID=your_client_id
OPENID_CLIENT_SECRET=your_client_secret
OPENID_SCOPES="openid profile"
Veja configuração do OpenID para mais detalhes.
Referência de Variáveis de Ambiente
Consulte o arquivo .env para a lista completa de opções disponíveis.
Update on GitHub