Chat UI documentation

設定の概要

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

設定の概要

Chat UIは環境変数によって設定されます。デフォルト値は.envに定義されており、.env.localまたは環境変数で上書きできます。

必須の構成

Chat UI は、OpenAI 互換の API エンドポイントに接続できます:

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

モデルは${OPENAI_BASE_URL}/modelsから自動的に検出されます。手動でのモデル設定は不要です。

データベース

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

開発環境では、MONGODB_URL は任意です。Chat UI は、./db に永続化される組み込みの MongoDB にフォールバックします。

モデルのオーバーライド

モデルの動作をカスタマイズするには、MODELS 環境変数(JSON5 形式)を使用します:

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

プロパティのオーバーライド:

  • id - モデル識別子(/models エンドポイントの ID と一致する必要があります)
  • name - UIに表示される名前
  • multimodal - 画像のアップロードを有効化
  • supportsTools - ツールサポートを宣言していないモデルでMCPツール呼び出しを有効にします
  • parameters - 既定のパラメータ(temperature、max_tokens など)を上書きします

タスクモデル

内部タスク(タイトル生成など)に特定のモデルを設定します:

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

設定されていない場合、現在の会話モデルが使用されます。

音声書き起こし

Whisperで音声入力を有効にする:

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

機能フラグ

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)

ビルドフラグ

一部の機能は、アプリのビルド時に固定され、実行時に読み込まれるものではないため、ビルド時にそれらが含まれるか、有効化する方法が存在しないかのどちらかになります。

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

npm run buildに渡すか、docker buildの--build-argとして指定してください。すでにビルド済みのインスタンスに設定しても、効果はありません。

MLアシスタントモデル

ビルドに ML Assistant モードが同梱されると、その会話ではコンポーザーで選択されたモデルではなく、固定のモデルセットが使用されます。各エントリは、長時間のツールループに対して検証済みの推論プロバイダーを固定します(npm run probe-model がその検証を実行します)。モードの会話では、ユーザーのプロバイダー設定と auto は無視され、ルーターエイリアスは拒否されます。最初のエントリがデフォルトです。プロバイダーの固定は Hugging Face ルーターの機能であるため、セルフホスト環境ではこの固定なしでモデルセットが提供されます。

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

空欄にすると、composer はスイッチを非表示にします。モードを指定したままのリクエストは拒否されます。

ユーザー認証

認証にOpenID Connectを使用します:

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

詳細については、OpenID構成を参照してください。

環境変数リファレンス

利用可能なオプションの完全なリストについては、.envファイルを参照してください。

Update on GitHub