Estructura del objeto de interfaz

Descripción general

El objeto interface permite la personalización de varios elementos de la interfaz de usuario dentro de la aplicación, incluyendo la visibilidad y los ajustes de comportamiento para componentes como menús, paneles y enlaces. Esta sección proporciona un desglose detallado de la estructura del objeto interface.

Estos son los campos bajo 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

Notas:

• Las configuraciones de interface se aplican globalmente dentro de la aplicación.
• Se proporcionan valores predeterminados para la mayoría de los ajustes, pero pueden ser anulados según requisitos o condiciones específicas.
• La lógica condicional en la aplicación puede modificar aún más estos ajustes basándose en otras configuraciones como Model Specs.

Ejemplo

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

Obsoleto para la gestión de permisos. Las sub-claves use, create, share y public inicializan los permisos de rol al iniciar. Se prefiere el Admin Panel para gestionar los permisos de servidor MCP por rol/grupo/usuario. Las sub-claves placeholder y trustCheckbox no se ven afectadas.

Clave:

Sub-claves:

Sub-claves de trustCheckbox:

Ejemplo:

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

Clave:

Sub-claves:

termsOfService

Clave:

Sub-claves:

modelSelect

Clave:

Predeterminado: true

Notas:

• Esto debe ser true si se utiliza modelSpecs.addedEndpoints.
• Si se utiliza modelSpecs.addedEndpoints y interface.modelSelect no está configurado explícitamente, su valor predeterminado es true.

Ejemplo:

interface:
  modelSelect: true

parameters

Clave:

Predeterminado: true

Ejemplo:

interface:
  parameters: false

contextUsage

Clave:

Predeterminado: true

Ejemplo:

interface:
  contextUsage: true

contextCost

Clave:

Predeterminado: false

Notas:

• Establezca contextCost: true para habilitar los valores de costo visibles. El uso de tokens puede permanecer visible a través de contextUsage mientras los valores de costo permanecen ocultos.
• currency solo afecta a los costos mostrados cuando la visualización de costos está habilitada.

Ejemplo:

interface:
  contextCost: true

currency

Clave:

Sub-claves:

Ejemplo:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Clave:

Predeterminado: true

Ejemplo:

interface:
  presets: true

prompts

Obsoleto para la gestión de permisos. Inicializa los permisos de rol PROMPTS al inicio solo para el rol USER predeterminado. Se prefiere el Admin Panel para gestionar los permisos de prompts por rol/grupo/usuario.

Clave:

Predeterminado: true

Importante: Configuración booleana frente a objeto

• Booleano (prompts: true): Solo actualiza el permiso use. Los valores de permiso existentes create, share y public se conservan de la base de datos. Utilice esto como un simple interruptor de función sin afectar otras configuraciones establecidas a través del panel de administración.

• Objeto: Actualiza solo los sub-permisos que se especifican explícitamente. Cualquier permiso que no esté incluido en la configuración se conserva de la base de datos.

Al utilizar la estructura de objeto:

Sub-claves:

Ejemplo (booleano - interruptor de función simple):

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

Ejemplo (objeto - control granular):

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

Ejemplo (objeto - control total):

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

bookmarks

Obsoleto para la gestión de permisos. Inicializa el permiso de rol BOOKMARKS al inicio solo para el rol USER predeterminado. Se prefiere el uso del Panel de administración.

Clave:

Predeterminado: true

Ejemplo:

interface:
  bookmarks: true

memories

Obsoleto para la gestión de permisos. Inicializa los permisos del rol MEMORIES al inicio solo para el rol USER predeterminado. Se prefiere el Panel de administración. Tenga en cuenta que este interruptor es independiente de la configuración de comportamiento de memory.

Clave:

Predeterminado: true

Nota: Esto controla la visibilidad en la interfaz de usuario de la función de memorias. Para una configuración detallada del comportamiento de la memoria (límites de tokens, personalización, ajustes del agente), consulte la Configuración de memoria.

Ejemplo:

interface:
  memories: true

multiConvo

Obsoleto para la gestión de permisos. Inicializa el permiso de rol MULTI_CONVO al inicio solo para el rol USER predeterminado. Se prefiere el uso del Admin Panel.

Clave:

Predeterminado: true

Ejemplo:

interface:
  multiConvo: true

agents

Más información sobre Agents

Obsoleto para la gestión de permisos. Inicializa los permisos del rol AGENTS al inicio solo para el rol USER predeterminado. Se prefiere el Admin Panel para gestionar los permisos de los agentes por rol/grupo/usuario.

Clave:

Predeterminado: true

Importante: Configuración booleana frente a objeto

• Booleano (agents: true): Solo actualiza el permiso use. Los valores de permiso existentes create, share y public se conservan de la base de datos. Utilice esto como un simple interruptor de función sin afectar otras configuraciones establecidas a través del panel de administración.

• Objeto: Actualiza solo los sub-permisos que se especifican explícitamente. Cualquier permiso que no esté incluido en la configuración se conserva de la base de datos.

Al utilizar la estructura de objeto:

Sub-claves:

Ejemplo (booleano - interruptor de función simple):

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

Ejemplo (objeto - control granular):

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

Ejemplo (objeto - control total):

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

remoteAgents

Controla el acceso a la API de Agents (endpoints compatibles con OpenAI y la API de Open Responses), lo cual permite que aplicaciones externas interactúen con los agentes de LibreChat mediante programación a través de claves de API.

Obsoleto para la gestión de permisos. Inicializa los permisos del rol REMOTE_AGENTS al inicio solo para el rol USER predeterminado. Se prefiere el uso del Admin Panel.

Clave:

Sub-claves:

Predeterminado: Todos los campos tienen como valor predeterminado false (deshabilitado).

Ejemplo:

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

Nota: Los usuarios administradores tienen todos los permisos de agentes remotos habilitados de forma predeterminada, independientemente de esta configuración.

skills

Obsoleto para la gestión de permisos. Inicializa los permisos de rol SKILLS al inicio solo para el rol USER predeterminado. Se prefiere el Admin Panel para gestionar los permisos de Skills por rol/grupo/usuario. defaultActiveOnShare no es un bit de permiso y sigue siendo una configuración de comportamiento en YAML.

Clave:

Predeterminado: true para use y create, false para share, public y defaultActiveOnShare.

Sub-claves:

Ejemplo:

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

Para el comportamiento y los modos de invocación de Skills, consulta Skills.

sharedLinks

Obsoleto para la gestión de permisos. Inicializa los permisos de rol SHARED_LINKS al inicio solo para el rol USER predeterminado. Se prefiere el Admin Panel para gestionar los permisos de enlaces compartidos por rol/grupo/usuario.

Clave:

Predeterminado: create: true, share: true, public: true

Importante: Configuración booleana frente a objeto

• Boolean (sharedLinks: true): Habilita todos los permisos de SHARED_LINKS para el rol USER predeterminado.
• Boolean (sharedLinks: false): Deshabilita todos los permisos de SHARED_LINKS para el rol USER predeterminado.
• Objeto: Actualiza solo los sub-permisos que se especifican explícitamente. Cualquier permiso que no esté incluido en la configuración se conserva de la base de datos.

Sub-claves:

Ejemplo:

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

Para el comportamiento de los enlaces compartidos orientados al usuario, consulte Shareable Links.

temporaryChat

Controla si la función de chat temporal está disponible para los usuarios. Los chats temporales no se guardan en el historial de conversaciones y se eliminan automáticamente después de un período de retención configurable.

Obsoleto para la gestión de permisos. Inicializa el permiso de rol TEMPORARY_CHAT al inicio solo para el rol USER predeterminado. Se prefiere el Panel de administración. temporaryChatRetention a continuación no es un permiso y sigue siendo la forma recomendada de configurar la retención.

Clave:

Predeterminado: true

Nota: El periodo de retención para los chats temporales se puede configurar usando temporaryChatRetention.

Ejemplo:

interface:
  temporaryChat: true

temporaryChatRetention

La configuración temporaryChatRetention le permite personalizar cuánto tiempo se conservan los chats temporales antes de ser eliminados automáticamente.

Clave:

Reglas de validación:

• Mínimo: 1 hora (evita la eliminación inmediata)
• Máximo: 8760 horas (retención máxima de 1 año)
• Predeterminado: 720 horas (30 días)

Métodos de configuración:

1. LibreChat.yaml (recomendado): interface.temporaryChatRetention: 168
2. Variable de entorno (obsoleta): TEMP_CHAT_RETENTION_HOURS=168

Nota: La variable de entorno TEMP_CHAT_RETENTION_HOURS está obsoleta. Por favor, utilice la opción de configuración interface.temporaryChatRetention en librechat.yaml en su lugar. El valor del archivo de configuración tiene prioridad sobre la variable de entorno.

Ejemplo:

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

Períodos de retención comunes:

• 1 hora: temporaryChatRetention: 1 (retención mínima)
• 24 horas: temporaryChatRetention: 24 (1 día)
• 168 horas: temporaryChatRetention: 168 (1 semana)
• 720 horas: temporaryChatRetention: 720 (30 días - valor predeterminado)
• 8760 horas: temporaryChatRetention: 8760 (1 año - máximo)

retentionMode

Controla qué datos reciben plazos de retención.

Clave:

Predeterminado: temporary

Ejemplo:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Controla si los archivos de recursos de agentes persistentes están exentos de la retención de todos los datos.

Clave:

Predeterminado: false

Notas:

• Esta configuración solo cambia el comportamiento cuando retentionMode está establecido en "all".
• Establezca esto en true cuando los agentes deban conservar sus archivos de recursos persistentes incluso mientras las conversaciones, los mensajes y los archivos que no son de agentes reciben plazos de retención.

Ejemplo:

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

autoSubmitFromUrl

Controla si un prompt proporcionado a través de parámetros de consulta de URL en /c/new se envía automáticamente al modelo.

Cuando un usuario autenticado abre /c/new?prompt=…&submit=true, LibreChat normalmente rellena previamente el campo de redacción con el prompt proporcionado en la URL y lo envía inmediatamente. Esta es una función de conveniencia para enlaces profundos (deeplinks) personalizados y URLs de chat compartidas.

Para despliegues donde los usuarios puedan recibir enlaces manipulados de fuentes externas —y donde los modelos con memoria o herramientas habilitadas podrían filtrar contexto sensible si una carga útil de inyección de prompts llega al modelo—, los operadores pueden desactivar el envío automático. Con el flag establecido en false, el prompt se sigue rellenando previamente en el editor, pero el usuario debe presionar Enviar explícitamente.

Clave:

Predeterminado: true (el comportamiento existente se conserva a menos que se deshabilite explícitamente).

Notas:

• Esta configuración no afecta la selección de Model Specs basada en URL ni otras configuraciones basadas en URL, solo el paso de envío automático.
• El parámetro de consulta acepta tanto prompt como q como fuente del prompt, teniendo prompt prioridad. submit=true es el activador.
• Recomendado para instancias que manejan datos sensibles de memoria o herramientas, donde un vector de inyección de prompts de un solo clic debería requerir la confirmación explícita del usuario.

Ejemplo:

interface:
  autoSubmitFromUrl: false

customWelcome

Clave:

Predeterminado: Ninguno (si no se especifica, se utiliza un saludo predeterminado)

Ejemplo:

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

Nota: Puedes usar {{user.name}} dentro del mensaje customWelcome para insertar dinámicamente el nombre del usuario y así ofrecer una experiencia de saludo personalizada.

runCode

Habilita/deshabilita el botón "Run Code" para los bloques de código Markdown. Más información en la API de Code Interpreter de LibreChat

Nota: Esta configuración no deshabilita la Capacidad de Intérprete de Código de los Agentes. Para deshabilitar la Capacidad de los Agentes, consulte la configuración del endpoint de Agentes en su lugar.

Obsoleto para la gestión de permisos. Inicializa el permiso de rol RUN_CODE al inicio solo para el rol USER predeterminado. Se prefiere el Panel de administración.

Clave:

Predeterminado: true

Ejemplo:

interface:
  runCode: true

webSearch

Habilita/deshabilita el botón de búsqueda web en la interfaz de chat. Más información en Web Search Configuration

Nota: Esta configuración no deshabilita la Capacidad de búsqueda web de los Agents. Para deshabilitar la capacidad de los Agents, consulte la configuración del endpoint de Agents en su lugar.

Obsoleto para la gestión de permisos. Inicializa el permiso de rol WEB_SEARCH al inicio solo para el rol USER predeterminado. Se prefiere el Panel de administración.

Clave:

Predeterminado: true

Ejemplo:

interface:
  webSearch: true

fileSearch

Habilita/deshabilita el botón de búsqueda de archivos (para el uso de la API de RAG mediante herramientas) en la interfaz de chat

Nota: Esta configuración no deshabilita la Capacidad de búsqueda de archivos de los agentes. Para deshabilitar la capacidad de los agentes, consulte la configuración del endpoint de agentes en su lugar.

Obsoleto para la gestión de permisos. Inicializa el permiso de rol FILE_SEARCH al inicio solo para el rol USER predeterminado. Se prefiere el Panel de administración.

Clave:

Predeterminado: true

Ejemplo:

interface:
  fileSearch: true

fileCitations

Controla la disponibilidad global de la funcionalidad de citas de archivos. Cuando está desactivada, elimina efectivamente el permiso FILE_CITATIONS para todos los usuarios, evitando que se muestren citas de archivos al utilizar la búsqueda de archivos, independientemente de los permisos individuales de cada usuario.

Obsoleto para la gestión de permisos. Establece/restringe globalmente el permiso de rol FILE_CITATIONS al inicio. Se prefiere el Panel de administración para gestionar los permisos de citas por rol/grupo/usuario.

Nota:

• Este ajuste actúa como un interruptor global para el sistema de permisos FILE_CITATIONS en toda la aplicación.
• Cuando se establece en false, ningún usuario verá las citas de archivos, incluso si se les ha otorgado el permiso a través de roles.
• Las citas de archivos requieren que la función fileSearch esté habilitada.
• Al utilizar agentes con capacidad de búsqueda de archivos, el comportamiento de las citas (cantidad y calidad) puede configurarse a través de la configuración del endpoint de Agents.

Clave:

Predeterminado: true

Ejemplo:

interface:
  fileCitations: true

defaultPinnedTools

Predefine las herramientas ancladas en la barra de prompts inicial para los usuarios que no han personalizado su estado de herramientas ancladas. Una vez que un usuario ancla o desancla una herramienta, LibreChat preserva la elección de dicho usuario.

Clave:

Valores admitidos:

• Claves de herramientas integradas: artifacts, execute_code, web_search, file_search, skills
• mcp para fijar el menú desplegable de servidores MCP
• Un nombre de servidor MCP específico para establecer ese servidor como fijado

Ejemplo:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Controla qué tipos de principales (usuarios, grupos, roles) están disponibles para su selección en la interfaz del selector de personas, utilizado normalmente al compartir agentes o gestionar controles de acceso.

Obsoleto para la gestión de permisos. Inicializa los permisos de rol PEOPLE_PICKER al inicio solo para el rol USER predeterminado. Se prefiere el Admin Panel.

Clave:

Sub-claves:

Predeterminado:

peoplePicker:
  users: true
  groups: true
  roles: true

Ejemplo:

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

marketplace

Habilita/deshabilita el acceso al Agent Marketplace.

Obsoleto para la gestión de permisos. Inicializa el permiso de rol MARKETPLACE al inicio solo para el rol USER predeterminado. Se prefiere el Panel de administración.

Clave:

Sub-claves:

Predeterminado:

marketplace:
  use: false

Ejemplo:

interface:
  marketplace:
    use: true # Enable marketplace access