Chat UI documentation

チャット UI

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

チャット UI

ツール、マルチモーダル入力、およびモデル間のインテリジェントなルーティングに対応したオープンソースのチャットインターフェースです。このアプリは、バックエンドでMongoDBとSvelteKitを使用しています。ライブバージョンであるhf.co/chatのHuggingChatをお試しください。または、ご自身のインスタンスをセットアップすることもできます。

Chat UI は、OpenAI 互換の API エンドポイントに接続できるため、以下と連携できます:

MCP Tools: Model Context Protocol (MCP) サーバーを介した関数呼び出し

LLM Router: リクエストごとに最適なモデルを選択するためのインテリジェントなルーティング

マルチモーダル: ビジョンをサポートするモデルでの画像のアップロード

OpenID: OpenID Connect による任意のユーザー認証

クイックスタート

ステップ 1 - .env.local を作成する:

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

OpenAI互換のエンドポイントを任意に使用できます:

プロバイダーOPENAI_BASE_URLOPENAI_API_KEY
Hugging Face/static-proxy?url=https%3A%2F%2Frouter.huggingface.co%2Fv1%3C%2Fcode%3E%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Ehf_xxx%3C%2Fcode%3E%3C%2Ftd%3E%3C%2Ftr%3E%3Ctr%3E%3Ctd%3EOllama%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Ehttp%3A%2F%2F127.0.0.1%3A11434%2Fv1%3C%2Fcode%3E%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Eollama%3C%2Fcode%3E%3C%2Ftd%3E%3C%2Ftr%3E%3Ctr%3E%3Ctd%3Ellama.cpp%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Ehttp%3A%2F%2F127.0.0.1%3A8080%2Fv1%3C%2Fcode%3E%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Esk-local%3C%2Fcode%3E%3C%2Ftd%3E%3C%2Ftr%3E%3Ctr%3E%3Ctd%3EOpenRouter%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Ehttps%3A%2F%2Fopenrouter.ai%2Fapi%2Fv1%3C%2Fcode%3E%3C%2Ftd%3E%3Ctd%3E%3Ccode%3Esk-or-v1-xxx%3C%2Fcode%3E%3C%2Ftd%3E%3C%2Ftr%3E%3C%2Ftbody%3E%3C%2Ftable%3E

ステップ 2 - インストールと実行:

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

以上です!Chat UIはエンドポイントから利用可能なモデルを自動的に検出します。

MongoDBは開発において任意です。MONGODB_URLが設定されていない場合、Chat UIは./dbに永続化される組み込みデータベースを使用します。

本番環境でのデプロイについては、インストールガイドを参照してください。

Update on GitHub