Structure de l'objet d'interface

Vue d'ensemble

L'objet interface permet la personnalisation de divers éléments de l'interface utilisateur au sein de l'application, incluant les paramètres de visibilité et de comportement pour des composants tels que les menus, les panneaux et les liens. Cette section fournit une analyse détaillée de la structure de l'objet interface.

Voici les champs sous 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

Notes :

• Les configurations interface sont appliquées globalement au sein de l'application.
• Des valeurs par défaut sont fournies pour la plupart des paramètres, mais elles peuvent être remplacées en fonction de besoins ou de conditions spécifiques.
• La logique conditionnelle dans l'application peut modifier davantage ces paramètres en fonction d'autres configurations telles que les Model Specs.

Exemple

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

Obsolète pour la gestion des permissions. Les sous-clés use, create, share et public initialisent les permissions des rôles au démarrage. Préférez le Panneau d'administration pour gérer les permissions des serveurs MCP par rôle/groupe/utilisateur. Les sous-clés placeholder et trustCheckbox ne sont pas affectées.

Clé :

Sous-clés :

Sous-clés de trustCheckbox :

Exemple :

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

Clé :

Sous-clés :

termsOfService

Clé :

Sous-clés :

modelSelect

Clé :

Par défaut : true

Notes :

• Ceci doit être défini sur true si vous utilisez modelSpecs.addedEndpoints.
• Si modelSpecs.addedEndpoints est utilisé et que interface.modelSelect n'est pas explicitement défini, il est par défaut réglé sur true.

Exemple :

interface:
  modelSelect: true

parameters

Clé :

Par défaut : true

Exemple :

interface:
  parameters: false

contextUsage

Clé :

Par défaut : true

Exemple :

interface:
  contextUsage: true

contextCost

Clé :

Par défaut : false

Notes :

• Définissez contextCost: true pour activer l'affichage des valeurs de coût. L'utilisation des jetons peut rester visible via contextUsage tandis que les valeurs de coût restent masquées.
• currency affecte uniquement les coûts affichés lorsque l'affichage des coûts est activé.

Exemple :

interface:
  contextCost: true

currency

Clé :

Sous-clés :

Exemple :

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Clé :

Par défaut : true

Exemple :

interface:
  presets: true

prompts

Obsolète pour la gestion des permissions. Initialise les permissions de rôle PROMPTS au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration pour gérer les permissions des prompts par rôle/groupe/utilisateur.

Clé :

Par défaut : true

Important : Configuration booléenne vs objet

• Booléen (prompts: true) : Met uniquement à jour l'autorisation use. Les valeurs d'autorisation create, share et public existantes sont préservées dans la base de données. Utilisez ceci comme un simple commutateur de fonctionnalité sans affecter les autres paramètres configurés via le panneau d'administration.

• Objet : Met à jour uniquement les sous-autorisations explicitement spécifiées. Toutes les autorisations non incluses dans la configuration sont conservées telles qu'elles sont dans la base de données.

Lors de l'utilisation de la structure d'objet :

Sous-clés :

Exemple (booléen - bascule de fonctionnalité simple) :

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

Exemple (objet - contrôle granulaire) :

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

Exemple (objet - contrôle total) :

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

bookmarks

Obsolète pour la gestion des permissions. Initialise la permission de rôle BOOKMARKS au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration.

Clé :

Par défaut : true

Exemple :

interface:
  bookmarks: true

memories

Obsolète pour la gestion des permissions. Initialise les permissions du rôle MEMORIES au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration. Notez que ce commutateur est distinct de la configuration du comportement memory.

Clé :

Par défaut : true

Note : Ceci contrôle la visibilité de l'interface utilisateur pour la fonctionnalité de mémoires. Pour une configuration détaillée du comportement des mémoires (limites de jetons, personnalisation, paramètres des agents), consultez la Memory Configuration.

Exemple :

interface:
  memories: true

multiConvo

Obsolète pour la gestion des permissions. Initialise la permission de rôle MULTI_CONVO au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration.

Clé :

Par défaut : true

Exemple :

interface:
  multiConvo: true

agents

Plus d'informations sur les Agents

Obsolète pour la gestion des permissions. Initialise les permissions du rôle AGENTS au démarrage uniquement pour le rôle USER par défaut. Privilégiez le Panneau d'administration pour gérer les permissions des agents par rôle/groupe/utilisateur.

Clé :

Par défaut : true

Important : Configuration booléenne vs objet

• Booléen (agents: true) : Met uniquement à jour l'autorisation use. Les valeurs d'autorisation create, share et public existantes sont préservées dans la base de données. Utilisez ceci comme un simple commutateur de fonctionnalité sans affecter les autres paramètres configurés via le panneau d'administration.

• Objet : Met à jour uniquement les sous-autorisations explicitement spécifiées. Toutes les autorisations non incluses dans la configuration sont conservées telles qu'elles sont dans la base de données.

Lors de l'utilisation de la structure d'objet :

Sous-clés :

Exemple (booléen - bascule de fonctionnalité simple) :

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

Exemple (objet - contrôle granulaire) :

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

Exemple (objet - contrôle total) :

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

remoteAgents

Contrôle l'accès à l'API Agents (points de terminaison compatibles avec OpenAI et API Open Responses), ce qui permet aux applications externes d'interagir avec les agents LibreChat par programmation via des clés API.

Obsolète pour la gestion des permissions. Initialise les permissions du rôle REMOTE_AGENTS au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration.

Clé :

Sous-clés :

Par défaut : Tous les champs sont définis sur false (désactivé) par défaut.

Exemple :

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

Remarque : Les utilisateurs administrateurs ont toutes les autorisations d'agent distant activées par défaut, indépendamment de cette configuration.

skills

Obsolète pour la gestion des permissions. Initialise les permissions de rôle SKILLS au démarrage uniquement pour le rôle USER par défaut. Préférez le Admin Panel pour gérer les permissions des Skills par rôle/groupe/utilisateur. defaultActiveOnShare n'est pas un bit de permission et demeure un paramètre de comportement YAML.

Clé :

Par défaut : true pour use et create, false pour share, public et defaultActiveOnShare.

Sous-clés :

Exemple :

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

Pour le comportement des Skills et les modes d'invocation, consultez Skills.

sharedLinks

Obsolète pour la gestion des permissions. Initialise les permissions de rôle SHARED_LINKS au démarrage pour le rôle USER par défaut uniquement. Préférez le Panneau d'administration pour gérer les permissions des liens partagés par rôle/groupe/utilisateur.

Clé :

Par défaut : create: true, share: true, public: true

Important : Configuration booléenne vs objet

• Boolean (sharedLinks: true) : Active toutes les autorisations SHARED_LINKS pour le rôle USER par défaut.
• Boolean (sharedLinks: false) : Désactive toutes les autorisations SHARED_LINKS pour le rôle USER par défaut.
• Objet : Met à jour uniquement les sous-autorisations explicitement spécifiées. Toutes les autorisations non incluses dans la configuration sont conservées telles qu'elles sont dans la base de données.

Sous-clés :

Exemple :

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

Pour le comportement des liens partagés côté utilisateur, voir Shareable Links.

temporaryChat

Contrôle si la fonctionnalité de chat temporaire est disponible pour les utilisateurs. Les chats temporaires ne sont pas enregistrés dans l'historique des conversations et sont automatiquement supprimés après une période de rétention configurable.

Obsolète pour la gestion des permissions. Initialise la permission de rôle TEMPORARY_CHAT au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration. temporaryChatRetention ci-dessous n'est pas une permission et reste la méthode recommandée pour configurer la rétention.

Clé :

Par défaut : true

Remarque : La période de rétention pour les discussions temporaires peut être configurée à l'aide de temporaryChatRetention.

Exemple :

interface:
  temporaryChat: true

temporaryChatRetention

La configuration temporaryChatRetention vous permet de personnaliser la durée de conservation des conversations temporaires avant qu'elles ne soient automatiquement supprimées.

Clé :

Règles de validation :

• Minimum : 1 heure (empêche la suppression immédiate)
• Maximum : 8760 heures (rétention maximale de 1 an)
• Par défaut : 720 heures (30 jours)

Méthodes de configuration :

1. LibreChat.yaml (recommandé) : interface.temporaryChatRetention: 168
2. Variable d'environnement (obsolète) : TEMP_CHAT_RETENTION_HOURS=168

Note : La variable d'environnement TEMP_CHAT_RETENTION_HOURS est obsolète. Veuillez utiliser l'option de configuration interface.temporaryChatRetention dans librechat.yaml à la place. La valeur du fichier de configuration est prioritaire sur la variable d'environnement.

Exemple :

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

Périodes de rétention courantes :

• 1 heure : temporaryChatRetention: 1 (rétention minimale)
• 24 heures : temporaryChatRetention: 24 (1 jour)
• 168 heures : temporaryChatRetention: 168 (1 semaine)
• 720 heures : temporaryChatRetention: 720 (30 jours - par défaut)
• 8760 heures : temporaryChatRetention: 8760 (1 an - maximum)

retentionMode

Contrôle quelles données reçoivent des délais de conservation.

Clé :

Par défaut : temporary

Exemple :

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Contrôle si les fichiers de ressources d'agent persistants sont exemptés de la rétention de toutes les données.

Clé :

Par défaut : false

Notes :

• Ce paramètre ne modifie le comportement que lorsque retentionMode est défini sur "all".
• Définissez ceci sur true lorsque les agents doivent conserver leurs fichiers de ressources persistants même si les conversations, les messages et les fichiers non liés aux agents sont soumis à des délais de rétention.

Exemple :

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

autoSubmitFromUrl

Détermine si une invite fournie via les paramètres de requête d'URL sur /c/new est automatiquement soumise au modèle.

Lorsqu'un utilisateur authentifié ouvre /c/new?prompt=…&submit=true, LibreChat pré-remplit normalement le champ de saisie avec le prompt fourni dans l'URL et le soumet immédiatement. Il s'agit d'une fonctionnalité pratique pour les liens profonds personnalisés et les URL de chat partagées.

Pour les déploiements où les utilisateurs peuvent recevoir des liens conçus par des sources externes — et où les modèles activés pour la mémoire ou les outils pourraient divulguer un contexte sensible si une charge utile d'injection de prompt atteint le modèle — les opérateurs peuvent désactiver la soumission automatique. Avec cet indicateur défini sur false, le prompt est toujours pré-rempli dans le compositeur, mais l'utilisateur doit appuyer explicitement sur Envoyer.

Clé :

Par défaut : true (le comportement existant est préservé à moins d'être explicitement désactivé).

Notes :

• Ce paramètre n'affecte pas la sélection de Model Specs basée sur l'URL ou d'autres paramètres basés sur l'URL — seulement l'étape de soumission automatique.
• Le paramètre de requête accepte à la fois prompt et q comme source d'invite, prompt étant prioritaire. submit=true est le déclencheur.
• Recommandé pour les instances traitant des données sensibles de mémoire ou d'outils, où un vecteur d'injection de prompt en un clic devrait nécessiter une confirmation explicite de l'utilisateur.

Exemple :

interface:
  autoSubmitFromUrl: false

customWelcome

Clé :

Par défaut : Aucun (si non spécifié, un message d'accueil par défaut est utilisé)

Exemple :

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

Remarque : Vous pouvez utiliser {{user.name}} dans le message customWelcome pour insérer dynamiquement le nom de l'utilisateur afin d'offrir un message de bienvenue personnalisé.

runCode

Active/désactive le bouton « Exécuter le code » pour les blocs de code Markdown. Plus d'informations sur l'API Code Interpreter de LibreChat

Remarque : Ce paramètre ne désactive pas la capacité d'interprète de code des Agents. Pour désactiver la capacité des Agents, consultez plutôt la configuration de l'endpoint Agents.

Obsolète pour la gestion des permissions. Initialise la permission de rôle RUN_CODE au démarrage uniquement pour le rôle USER par défaut. Préférez l'utilisation du Panneau d'administration.

Clé :

Par défaut : true

Exemple :

interface:
  runCode: true

webSearch

Active/désactive le bouton de recherche web dans l'interface de chat. Plus d'informations sur la Configuration de la recherche web

Remarque : Ce paramètre ne désactive pas la fonctionnalité de recherche Web des Agents. Pour désactiver la fonctionnalité des Agents, consultez plutôt la configuration de l'endpoint Agents.

Obsolète pour la gestion des permissions. Initialise la permission de rôle WEB_SEARCH au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration.

Clé :

Par défaut : true

Exemple :

interface:
  webSearch: true

fileSearch

Active/désactive le bouton de recherche de fichiers (pour l'utilisation de l'API RAG via un outil) dans l'interface de chat

Remarque : Ce paramètre ne désactive pas la fonctionnalité de recherche de fichiers des Agents. Pour désactiver la fonctionnalité des Agents, consultez plutôt la configuration de l'endpoint Agents.

Obsolète pour la gestion des permissions. Initialise la permission de rôle FILE_SEARCH au démarrage uniquement pour le rôle USER par défaut. Préférez l'utilisation du Panneau d'administration.

Clé :

Par défaut : true

Exemple :

interface:
  fileSearch: true

fileCitations

Contrôle la disponibilité globale de la fonctionnalité de citations de fichiers. Lorsqu'elle est désactivée, elle supprime effectivement l'autorisation FILE_CITATIONS pour tous les utilisateurs, empêchant l'affichage de toute citation de fichier lors de l'utilisation de la recherche de fichiers, indépendamment des autorisations individuelles des utilisateurs.

Obsolète pour la gestion des permissions. Initialise/active globalement la permission de rôle FILE_CITATIONS au démarrage. Privilégiez le Panneau d'administration pour gérer les permissions de citations par rôle/groupe/utilisateur.

Remarque :

• Ce paramètre agit comme un commutateur global pour le système de permissions FILE_CITATIONS à l'échelle de l'instance.
• Lorsque défini sur false, aucun utilisateur ne verra les citations de fichiers, même s'ils ont reçu l'autorisation via des rôles.
• Les citations de fichiers nécessitent que la fonctionnalité fileSearch soit activée.
• Lors de l'utilisation d'agents avec une capacité de recherche de fichiers, le comportement des citations (quantité et qualité) peut être configuré via la configuration de l'endpoint Agents.

Clé :

Par défaut : true

Exemple :

interface:
  fileCitations: true

defaultPinnedTools

Initialise les outils épinglés dans la barre de saisie pour les utilisateurs qui n'ont pas personnalisé l'état de leurs outils épinglés. Une fois qu'un utilisateur épingle ou désépingle un outil, LibreChat préserve le choix de cet utilisateur.

Clé :

Valeurs prises en charge :

• Clés d'outils intégrées : artifacts, execute_code, web_search, file_search, skills
• mcp pour épingler le menu déroulant des serveurs MCP
• Un nom de serveur MCP spécifique pour définir ce serveur comme épinglé

Exemple :

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Contrôle quels types de principaux (utilisateurs, groupes, rôles) sont disponibles à la sélection dans l'interface de sélection des personnes, généralement utilisé lors du partage d'agents ou de la gestion des contrôles d'accès.

Obsolète pour la gestion des permissions. Initialise les permissions du rôle PEOPLE_PICKER au démarrage uniquement pour le rôle USER par défaut. Préférez l'utilisation du Panneau d'administration.

Clé :

Sous-clés :

Par défaut :

peoplePicker:
  users: true
  groups: true
  roles: true

Exemple :

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

marketplace

Active/désactive l'accès à l'Agent Marketplace.

Obsolète pour la gestion des permissions. Initialise la permission de rôle MARKETPLACE au démarrage uniquement pour le rôle USER par défaut. Préférez le Panneau d'administration.

Clé :

Sous-clés :

Par défaut :

marketplace:
  use: false

Exemple :

interface:
  marketplace:
    use: true # Enable marketplace access