インターフェースオブジェクト構造

概要

interface オブジェクトを使用すると、メニュー、パネル、リンクなどのコンポーネントの表示設定や動作設定を含め、アプリケーション内のさまざまなユーザーインターフェース要素をカスタマイズできます。このセクションでは、interface オブジェクトの構造について詳しく解説します。

これらは interface 配下のフィールドです：

• mcpServers
• privacyPolicy
• termsOfService
• modelSelect
• parameters
• contextUsage
• contextCost
• currency
• presets
• prompts
• bookmarks
• memories
• multiConvo
• agents
• remoteAgents
• skills
• sharedLinks
• temporaryChat
• temporaryChatRetention
• retentionMode
• retainAgentFiles
• autoSubmitFromUrl
• customWelcome
• runCode
• webSearch
• fileSearch
• fileCitations
• defaultPinnedTools
• peoplePicker
• marketplace

注記:

• interface 設定は、アプリケーション全体にグローバルに適用されます。
• ほとんどの設定にはデフォルト値が提供されていますが、特定の要件や条件に基づいて上書きすることが可能です。
• アプリケーション内の条件付きロジックは、Model Specsのような他の設定に基づいて、これらの設定をさらに変更することができます。

例

interface:
  mcpServers:
    placeholder: 'MCP Servers'
    use: true
    create: true
    share: false
    public: false
    configureObo: false
    trustCheckbox:
      label: 'I trust this server'
      subLabel: 'Only enable servers you trust'
  privacyPolicy:
    externalUrl: 'https://example.com/privacy'
    openNewTab: true
  termsOfService:
    externalUrl: 'https://example.com/terms'
    openNewTab: true
    modalAcceptance: true
    modalTitle: 'Terms of Service'
    modalContent: |
      # Terms of Service
      ## Introduction
      Welcome to LibreChat!
  modelSelect: false
  parameters: true
  contextUsage: true
  contextCost: true
  currency:
    code: EUR
    rate: 0.92
  presets: false
  prompts:
    use: true
    create: true
    share: true
    public: false
  bookmarks: true
  multiConvo: true
  agents:
    use: true
    create: true
    share: true
    public: false
  skills:
    use: true
    create: true
    share: false
    public: false
    defaultActiveOnShare: false
  sharedLinks:
    create: true
    share: true
    public: false
    snapshotFiles: true
  customWelcome: 'Hey {{user.name}}! Welcome to LibreChat'
  runCode: true
  webSearch: true
  fileSearch: true
  fileCitations: true
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

mcpServers

権限管理については非推奨となりました。 use、create、share、および public サブキーは、起動時にロールの権限をシード（初期化）します。ロール/グループ/ユーザーごとの MCP サーバー権限の管理には、Admin Panel を使用することを推奨します。placeholder および trustCheckbox サブキーは影響を受けません。

キー:

サブキー:

trustCheckbox サブキー:

例:

interface:
  mcpServers:
    placeholder: 'Select MCP Server'
    use: true
    create: true
    share: false
    configureObo: false
    trustCheckbox:
      label:
        en: 'I trust this server'
        es: 'Confío en este servidor'
      subLabel:
        en: 'Only enable servers you trust'
        es: 'Solo habilite servidores en los que confíe'

privacyPolicy

キー:

サブキー:

termsOfService

キー:

サブキー:

modelSelect

キー:

デフォルト: true

注記:

• modelSpecs.addedEndpoints を使用する場合、これは true に設定する必要があります。
• modelSpecs.addedEndpoints が使用されており、interface.modelSelect が明示的に設定されていない場合、デフォルトで true になります。

例:

interface:
  modelSelect: true

parameters

キー:

デフォルト: true

例:

interface:
  parameters: false

contextUsage

キー:

デフォルト: true

例:

interface:
  contextUsage: true

contextCost

キー:

デフォルト: false

注記:

• contextCost: true を設定すると、コストの値を表示するようにオプトインできます。コストの値を非表示にしたまま、トークン使用量を contextUsage で表示し続けることも可能です。
• currency は、コスト表示が有効になっている場合にのみ、表示されるコストに影響します。

例:

interface:
  contextCost: true

currency

キー:

サブキー:

例:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

キー:

デフォルト: true

例:

interface:
  presets: true

prompts

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ PROMPTS ロールの権限をシードします。ロール、グループ、ユーザーごとのプロンプト権限の管理には、Admin Panel を使用することを推奨します。

キー:

デフォルト: true

重要: ブール値とオブジェクトの設定について

• Boolean (prompts: true): use 権限のみを更新します。既存の create、share、および public 権限の値はデータベースから保持されます。管理パネルを通じて設定された他の設定に影響を与えることなく、シンプルな機能トグルとしてこれを使用してください。

• Object: 明示的に指定されたサブ権限のみを更新します。設定に含まれていない権限は、データベース内の既存の値が保持されます。

オブジェクト構造を使用する場合：

サブキー:

例 (boolean - シンプルな機能トグル):

interface:
  prompts: true # Only updates USE; create/share/public remain unchanged

例 (オブジェクト - 詳細な制御):

interface:
  prompts:
    use: true
    create: false # Disable creation while allowing use
    # share and public not specified - preserves existing values

例 (オブジェクト - 完全な制御):

interface:
  prompts:
    use: true
    create: true
    share: true
    public: false

bookmarks

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ BOOKMARKS ロール権限をシードします。代わりに Admin Panel を使用してください。

キー:

デフォルト: true

例:

interface:
  bookmarks: true

memories

権限管理については非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ MEMORIES ロールの権限をシードします。代わりに Admin Panel を使用することを推奨します。このトグルは memory の動作設定とは別であることに注意してください。

キー:

デフォルト: true

注: これはメモリ機能のUI表示を制御するものです。メモリの動作に関する詳細な設定（トークン制限、パーソナライゼーション、エージェント設定）については、Memory Configuration を参照してください。

例:

interface:
  memories: true

multiConvo

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ MULTI_CONVO ロール権限をシードします。代わりに Admin Panel を使用してください。

キー:

デフォルト: true

例:

interface:
  multiConvo: true

agents

Agents に関する詳細情報

権限管理については非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ AGENTS ロールの権限をシードします。ロール、グループ、ユーザーごとのエージェント権限の管理には、Admin Panel を使用することを推奨します。

キー:

デフォルト: true

重要: ブール値とオブジェクトの設定について

• Boolean (agents: true): use 権限のみを更新します。既存の create、share、および public 権限の値はデータベースから保持されます。管理パネルで設定された他の設定に影響を与えることなく、シンプルな機能トグルとしてこれを使用してください。

• Object: 明示的に指定されたサブ権限のみを更新します。設定に含まれていない権限は、データベース内の既存の値が保持されます。

オブジェクト構造を使用する場合：

サブキー:

例 (boolean - シンプルな機能トグル):

interface:
  agents: true # Only updates USE; create/share/public remain unchanged

例 (オブジェクト - 詳細な制御):

interface:
  agents:
    use: true
    create: false # Disable creation while allowing use
    # share and public not specified - preserves existing values

例 (オブジェクト - 完全な制御):

interface:
  agents:
    use: true
    create: true
    share: true
    public: false

remoteAgents

Agents API（OpenAI互換およびOpen Responses APIエンドポイント）へのアクセスを制御します。これにより、外部アプリケーションがAPIキーを介してプログラムからLibreChatエージェントと対話できるようになります。

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ REMOTE_AGENTS ロールの権限をシードします。代わりに Admin Panel を使用してください。

キー:

サブキー:

デフォルト: すべてのフィールドはデフォルトで false (無効) に設定されます。

例:

interface:
  remoteAgents:
    use: true
    create: true
    share: false
    public: false

注: 管理者ユーザーは、この設定に関係なく、デフォルトですべてのリモートエージェント権限が有効になっています。

skills

権限管理については非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ SKILLS ロールの権限をシードします。ロール、グループ、ユーザーごとのスキル権限の管理には、Admin Panel を使用することを推奨します。defaultActiveOnShare は権限ビットではなく、YAML の動作設定として残ります。

キー:

デフォルト: use と create は true、share、public、および defaultActiveOnShare は false です。

サブキー:

例:

interface:
  skills:
    use: true
    create: true
    share: false
    public: false
    defaultActiveOnShare: false

Skillsの動作と呼び出しモードについては、Skills を参照してください。

sharedLinks

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ SHARED_LINKS ロールの権限をシードします。ロール、グループ、ユーザーごとの共有リンク権限の管理には、Admin Panel を使用することを推奨します。

キー:

デフォルト: create: true, share: true, public: true

重要: ブール値とオブジェクトの設定について

• Boolean (sharedLinks: true): デフォルトの USER ロールに対して、すべての SHARED_LINKS 権限を有効にします。
• Boolean (sharedLinks: false): デフォルトの USER ロールに対するすべての SHARED_LINKS 権限を無効にします。
• Object: 明示的に指定されたサブ権限のみを更新します。設定に含まれていない権限は、データベース内の既存の値が保持されます。

サブキー:

例:

interface:
  sharedLinks:
    create: true
    share: true
    public: false
    snapshotFiles: true

ユーザー向けの共有リンクの動作については、Shareable Links を参照してください。

temporaryChat

ユーザーが一時チャット機能を利用できるかどうかを制御します。一時チャットは会話履歴に保存されず、設定可能な保持期間が経過すると自動的に削除されます。

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ TEMPORARY_CHAT ロール権限をシードします。代わりに Admin Panel を使用してください。以下の temporaryChatRetention は権限ではなく、保持期間を設定するための推奨される方法として残ります。

キー:

デフォルト: true

注: 一時的なチャットの保持期間は temporaryChatRetention を使用して設定できます。

例:

interface:
  temporaryChat: true

temporaryChatRetention

temporaryChatRetention 設定を使用すると、一時的なチャットが自動的に削除されるまでの保持期間をカスタマイズできます。

キー:

検証ルール:

• 最小: 1時間（即時削除を防止します）
• 最大: 8760時間（最大1年間の保持）
• デフォルト: 720時間（30日間）

設定方法:

1. LibreChat.yaml（推奨）: interface.temporaryChatRetention: 168
2. 環境変数 (非推奨): TEMP_CHAT_RETENTION_HOURS=168

注意: 環境変数 TEMP_CHAT_RETENTION_HOURS は非推奨となりました。代わりに librechat.yaml の interface.temporaryChatRetention 設定オプションを使用してください。設定ファイルの値は環境変数よりも優先されます。

例:

interface:
  temporaryChatRetention: 168 # Retain temporary chats for 7 days
  retentionMode: 'temporary'

一般的な保持期間:

• 1時間: temporaryChatRetention: 1 (最小保持期間)
• 24時間: temporaryChatRetention: 24 (1日)
• 168時間: temporaryChatRetention: 168 (1週間)
• 720時間: temporaryChatRetention: 720 (30日間 - デフォルト)
• 8760時間: temporaryChatRetention: 8760 (1年間 - 最大値)

retentionMode

どのデータに保持期限を適用するかを制御します。

キー:

デフォルト: temporary

例:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

永続的なエージェントリソースファイルが全データ保持の対象外となるかどうかを制御します。

キー:

デフォルト: false

注記:

• この設定は、retentionMode が "all" に設定されている場合にのみ動作を変更します。
• 会話、メッセージ、およびエージェント以外のファイルに保持期限が設定されている場合でも、エージェントが永続的なリソースファイルを保持する必要がある場合は、これを true に設定します。

例:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'
  retainAgentFiles: true

autoSubmitFromUrl

/c/new のURLクエリパラメータ経由で提供されたプロンプトを、モデルに対して自動送信するかどうかを制御します。

認証済みのユーザーが /c/new?prompt=…&submit=true を開くと、LibreChatは通常、URLで指定されたプロンプトをコンポーザーに自動入力し、即座に送信します。これは、作成されたディープリンクや共有チャットURLのための便利な機能です。

外部ソースから作成されたリンクをユーザーが受け取る可能性があり、かつプロンプトインジェクションのペイロードがモデルに到達した場合にメモリやツールが有効なモデルが機密コンテキストを漏洩する可能性があるデプロイメントでは、オペレーターは自動送信を無効にすることができます。このフラグを false に設定すると、プロンプトはコンポーザーに事前入力された状態になりますが、ユーザーは明示的に Send を押す必要があります。

キー:

デフォルト: true (明示的に無効化されない限り、既存の動作が維持されます)。

注記:

• この設定は、URLベースのModel Specsの選択やその他のURLベースの設定には影響しません。自動送信のステップのみに影響します。
• クエリパラメータは、プロンプトのソースとして prompt と q の両方を受け付けますが、prompt が優先されます。submit=true がトリガーとなります。
• 機密性の高いメモリやツールデータを扱うインスタンスに推奨されます。このような環境では、ワンクリックのプロンプトインジェクション攻撃を防ぐため、ユーザーによる明示的な確認を必須とすべきです。

例:

interface:
  autoSubmitFromUrl: false

customWelcome

キー:

デフォルト: なし (指定がない場合は、デフォルトの挨拶が使用されます)

例:

interface:
  customWelcome: 'Hey {{user.name}}! Welcome to LibreChat'

注: customWelcome メッセージ内で {{user.name}} を使用することで、ユーザー名を動的に挿入し、パーソナライズされた挨拶を表示できます。

runCode

Markdownコードブロックの「コードを実行」ボタンを有効/無効にします。詳細については、LibreChat Code Interpreter API を参照してください。

注: この設定は Agents Code Interpreter Capability を無効にするものではありません。Agents Capability を無効にするには、代わりに Agents Endpoint configuration を参照してください。

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ RUN_CODE ロール権限をシードします。代わりに Admin Panel を使用してください。

キー:

デフォルト: true

例:

interface:
  runCode: true

webSearch

チャットインターフェース内のウェブ検索ボタンの有効/無効を切り替えます。詳細は Web Search Configuration を参照してください。

注: この設定は Agents Web Search Capability を無効にするものではありません。Agents 機能を無効にするには、代わりに Agents Endpoint configuration を参照してください。

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ WEB_SEARCH ロール権限をシードします。代わりに Admin Panel を使用してください。

キー:

デフォルト: true

例:

interface:
  webSearch: true

fileSearch

チャットインターフェース内のファイル検索（ツール経由のRAG API使用用）ボタンの有効化/無効化を切り替えます。

注: この設定は Agents File Search Capability を無効にするものではありません。Agents Capability を無効にするには、代わりに Agents Endpoint configuration を参照してください。

権限管理のため非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ FILE_SEARCH ロール権限をシードします。 Admin Panel の使用を推奨します。

キー:

デフォルト: true

例:

interface:
  fileSearch: true

fileCitations

ファイル引用機能のグローバルな有効性を制御します。無効にすると、すべてのユーザーから FILE_CITATIONS 権限が実質的に削除され、個々のユーザー権限に関係なく、ファイル検索使用時にファイル引用が表示されなくなります。

権限管理としては非推奨です。 起動時に FILE_CITATIONS ロール権限をシード（初期化）またはグローバルにゲートします。ロール/グループ/ユーザーごとの引用権限の管理には、Admin Panel の使用を推奨します。

注記:

• この設定は、システム全体における FILE_CITATIONS 権限のグローバルな切り替えスイッチとして機能します。
• false に設定すると、ロールを通じて権限が付与されている場合でも、すべてのユーザーに対してファイルの引用が表示されなくなります。
• ファイル引用機能を使用するには、fileSearch機能を有効にする必要があります。
• ファイル検索機能を持つエージェントを使用する場合、引用の動作（量と質）は Agents endpoint configuration を通じて設定できます。

キー:

デフォルト: true

例:

interface:
  fileCitations: true

defaultPinnedTools

ユーザーがピン留めされたツールの状態をカスタマイズしていない場合に、プロンプトバーの初期ツールをシードします。ユーザーがツールをピン留めまたはピン留め解除すると、LibreChatはそのユーザーの選択を保持します。

キー:

サポートされている値:

• 組み込みツールキー: artifacts, execute_code, web_search, file_search, skills
• mcp を使用して MCP サーバーのドロップダウンをピン留めします
• そのサーバーをピン留めされた状態にするための、特定のMCPサーバー名

例:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

ピープルピッカーインターフェースで選択可能なプリンシパルの種類（ユーザー、グループ、ロール）を制御します。通常、エージェントの共有やアクセス制御の管理時に使用されます。

権限管理については非推奨となりました。 起動時にデフォルトの USER ロールに対してのみ PEOPLE_PICKER ロールの権限をシードします。代わりに Admin Panel を使用してください。

キー:

サブキー:

デフォルト:

peoplePicker:
  users: true
  groups: true
  roles: true

例:

interface:
  peoplePicker:
    users: true
    groups: true
    roles: false # Disable role selection in people picker

marketplace

Agent Marketplaceへのアクセスを有効/無効にします。

権限管理については非推奨です。 起動時にデフォルトの USER ロールに対してのみ MARKETPLACE ロールの権限をシードします。 管理パネル の使用を推奨します。

キー:

サブキー:

デフォルト:

marketplace:
  use: false

例:

interface:
  marketplace:
    use: true # Enable marketplace access