Chat UI documentation

Interface de chat

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Interface de chat

Interface de chat de código aberto com suporte a ferramentas, entradas multimodais e roteamento inteligente entre modelos. O aplicativo usa MongoDB e SvelteKit nos bastidores. Experimente a versão ao vivo chamada HuggingChat em hf.co/chat ou configure sua própria instância.

A interface de chat se conecta a qualquer endpoint de API compatível com a OpenAI, funcionando com:

Ferramentas MCP: Chamadas de função via servidores do Model Context Protocol (MCP)

LLM Router: roteamento inteligente para selecionar o melhor modelo para cada solicitação

Multimodal: Uploads de imagens em modelos que suportam visão

OpenID: Autenticação de usuário opcional via OpenID Connect

Início rápido

Etapa 1 - Crie .env.local:

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

Você pode usar qualquer endpoint compatível com a OpenAI:

ProvedorOPENAI_BASE_URLOPENAI_API_KEY
Hugging Facehttps://router.huggingface.co/v1hf_xxx
Ollamahttp://127.0.0.1:11434/v1ollama
llama.cpphttp://127.0.0.1:8080/v1sk-local
OpenRouterhttps://openrouter.ai/api/v1sk-or-v1-xxx

Etapa 2 - Instalar e executar:

git clone https://github.com/huggingface/chat-ui
cd chat-ui
npm install
npm run dev -- --open

É isso! A Chat UI descobrirá automaticamente os modelos disponíveis a partir do seu endpoint.

MongoDB é opcional para desenvolvimento. Quando MONGODB_URL não está definido, o Chat UI usa um banco de dados embutido que persiste em ./db.

Para implantações em produção, consulte os guias de instalação.

Update on GitHub