Estrutura do Objeto de Interface

Visão geral

O objeto interface permite a personalização de vários elementos da interface do usuário dentro da aplicação, incluindo configurações de visibilidade e comportamento para componentes como menus, painéis e links. Esta seção fornece um detalhamento da estrutura do objeto interface.

Estes são os campos em 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:

• As configurações de interface são aplicadas globalmente dentro da aplicação.
• Valores padrão são fornecidos para a maioria das configurações, mas podem ser substituídos com base em requisitos ou condições específicas.
• A lógica condicional na aplicação pode modificar ainda mais essas configurações com base em outras configurações, como Model Specs.

Exemplo

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 gerenciamento de permissões. As subchaves use, create, share e public definem as permissões de função na inicialização. Prefira o Painel Administrativo para gerenciar permissões de servidor MCP por função/grupo/usuário. As subchaves placeholder e trustCheckbox não são afetadas.

Chave:

Sub-chaves:

Sub-chaves do trustCheckbox:

Exemplo:

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

Chave:

Sub-chaves:

termsOfService

Chave:

Sub-chaves:

modelSelect

Chave:

Padrão: true

Notas:

• Isso deve ser definido como true se você estiver usando modelSpecs.addedEndpoints.
• Se modelSpecs.addedEndpoints for usado e interface.modelSelect não estiver explicitamente definido, o padrão será true.

Exemplo:

interface:
  modelSelect: true

parameters

Chave:

Padrão: true

Exemplo:

interface:
  parameters: false

contextUsage

Chave:

Padrão: true

Exemplo:

interface:
  contextUsage: true

contextCost

Chave:

Padrão: false

Notas:

• Defina contextCost: true para optar por valores de custo visíveis. O uso de tokens pode permanecer visível através de contextUsage enquanto os valores de custo permanecem ocultos.
• currency afeta apenas os custos exibidos quando a exibição de custo está ativada.

Exemplo:

interface:
  contextCost: true

currency

Chave:

Sub-chaves:

Exemplo:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Chave:

Padrão: true

Exemplo:

interface:
  presets: true

prompts

Obsoleto para gerenciamento de permissões. Inicializa as permissões de função PROMPTS na inicialização apenas para a função USER padrão. Prefira o Painel de Administração para gerenciar permissões de prompts por função/grupo/usuário.

Chave:

Padrão: true

Importante: Configuração Booleana vs Objeto

• Boolean (prompts: true): Atualiza apenas a permissão use. Os valores de permissão create, share e public existentes são preservados do banco de dados. Use isso como um simples seletor de recursos (feature toggle) sem afetar outras configurações definidas através do painel administrativo.

• Objeto: Atualiza apenas as subpermissões que são explicitamente especificadas. Quaisquer permissões não incluídas na configuração são preservadas a partir do banco de dados.

Ao usar a estrutura de objeto:

Sub-chaves:

Exemplo (booleano - alternância simples de recurso):

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

Exemplo (objeto - controle granular):

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

Exemplo (objeto - controle total):

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

bookmarks

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função BOOKMARKS na inicialização apenas para a função USER padrão. Prefira o Painel de Administração.

Chave:

Padrão: true

Exemplo:

interface:
  bookmarks: true

memories

Obsoleto para gerenciamento de permissões. Define as permissões da função MEMORIES na inicialização apenas para a função USER padrão. Prefira o Painel de Administração. Observe que esta opção é separada da configuração de comportamento memory.

Chave:

Padrão: true

Nota: Isso controla a visibilidade da interface do recurso de memórias. Para uma configuração detalhada do comportamento da memória (limites de tokens, personalização, configurações de agente), consulte a Configuração de Memória.

Exemplo:

interface:
  memories: true

multiConvo

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função MULTI_CONVO na inicialização apenas para a função USER padrão. Prefira o Painel do Administrador.

Chave:

Padrão: true

Exemplo:

interface:
  multiConvo: true

agents

Mais informações sobre Agents

Obsoleto para gerenciamento de permissões. Inicializa as permissões da função AGENTS na inicialização apenas para a função USER padrão. Prefira o Painel de Administração para gerenciar permissões de agentes por função/grupo/usuário.

Chave:

Padrão: true

Importante: Configuração Booleana vs Objeto

• Boolean (agents: true): Atualiza apenas a permissão use. Os valores de permissão create, share e public existentes são preservados no banco de dados. Use isso como um simples interruptor de recurso (feature toggle) sem afetar outras configurações definidas através do painel administrativo.

• Objeto: Atualiza apenas as subpermissões que são explicitamente especificadas. Quaisquer permissões não incluídas na configuração são preservadas a partir do banco de dados.

Ao usar a estrutura de objeto:

Sub-chaves:

Exemplo (booleano - alternância simples de recurso):

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

Exemplo (objeto - controle granular):

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

Exemplo (objeto - controle total):

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

remoteAgents

Controla o acesso à API de Agents (endpoints compatíveis com OpenAI e API de Open Responses), que permite que aplicações externas interajam com agentes do LibreChat programaticamente via chaves de API.

Obsoleto para gerenciamento de permissões. Inicializa as permissões da função REMOTE_AGENTS na inicialização apenas para a função USER padrão. Prefira o Painel de Administração.

Chave:

Sub-chaves:

Padrão: Todos os campos têm como padrão false (desativado).

Exemplo:

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

Nota: Usuários administradores têm todas as permissões de agente remoto habilitadas por padrão, independentemente desta configuração.

skills

Obsoleto para gerenciamento de permissões. Inicializa as permissões de função SKILLS na inicialização apenas para a função USER padrão. Prefira o Admin Panel para gerenciar permissões de Skills por função/grupo/usuário. defaultActiveOnShare não é um bit de permissão e permanece como uma configuração de comportamento no YAML.

Chave:

Padrão: true para use e create, false para share, public e defaultActiveOnShare.

Sub-chaves:

Exemplo:

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

Para o comportamento de Skills e modos de invocação, veja Skills.

sharedLinks

Obsoleto para gerenciamento de permissões. Inicializa as permissões de função SHARED_LINKS na inicialização apenas para a função USER padrão. Prefira o Painel de Administração para gerenciar permissões de links compartilhados por função/grupo/usuário.

Chave:

Padrão: create: true, share: true, public: true

Importante: Configuração Booleana vs Objeto

• Boolean (sharedLinks: true): Habilita todas as permissões de SHARED_LINKS para a função USER padrão.
• Boolean (sharedLinks: false): Desativa todas as permissões de SHARED_LINKS para a função USER padrão.
• Objeto: Atualiza apenas as subpermissões que são explicitamente especificadas. Quaisquer permissões não incluídas na configuração são preservadas a partir do banco de dados.

Sub-chaves:

Exemplo:

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

Para o comportamento de links compartilhados voltado ao usuário, veja Shareable Links.

temporaryChat

Controla se o recurso de chat temporário está disponível para os usuários. Chats temporários não são salvos no histórico de conversas e são excluídos automaticamente após um período de retenção configurável.

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função TEMPORARY_CHAT na inicialização apenas para a função USER padrão. Prefira o Painel de Administração. temporaryChatRetention abaixo não é uma permissão e continua sendo a maneira recomendada de configurar a retenção.

Chave:

Padrão: true

Nota: O período de retenção para chats temporários pode ser configurado usando temporaryChatRetention.

Exemplo:

interface:
  temporaryChat: true

temporaryChatRetention

A configuração temporaryChatRetention permite que você personalize por quanto tempo os chats temporários são retidos antes de serem excluídos automaticamente.

Chave:

Regras de Validação:

• Mínimo: 1 hora (evita a exclusão imediata)
• Máximo: 8760 horas (retenção máxima de 1 ano)
• Padrão: 720 horas (30 dias)

Métodos de Configuração:

1. LibreChat.yaml (recomendado): interface.temporaryChatRetention: 168
2. Variável de Ambiente (obsoleto): TEMP_CHAT_RETENTION_HOURS=168

Nota: A variável de ambiente TEMP_CHAT_RETENTION_HOURS está obsoleta. Por favor, utilize a opção de configuração interface.temporaryChatRetention no librechat.yaml em seu lugar. O valor no arquivo de configuração tem precedência sobre a variável de ambiente.

Exemplo:

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

Períodos de Retenção Comuns:

• 1 hora: temporaryChatRetention: 1 (retenção mínima)
• 24 horas: temporaryChatRetention: 24 (1 dia)
• 168 horas: temporaryChatRetention: 168 (1 semana)
• 720 horas: temporaryChatRetention: 720 (30 dias - padrão)
• 8760 horas: temporaryChatRetention: 8760 (1 ano - máximo)

retentionMode

Controla quais dados recebem prazos de retenção.

Chave:

Padrão: temporary

Exemplo:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Controla se os arquivos de recursos de agentes persistentes estão isentos da retenção de todos os dados.

Chave:

Padrão: false

Notas:

• Esta configuração só altera o comportamento quando retentionMode está definido como "all".
• Defina isso como true quando os agentes devem manter seus arquivos de recursos persistentes mesmo enquanto conversas, mensagens e arquivos que não são de agentes recebem prazos de retenção.

Exemplo:

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

autoSubmitFromUrl

Controla se um prompt fornecido via parâmetros de consulta de URL em /c/new é enviado automaticamente para o modelo.

Quando /c/new?prompt=…&submit=true é aberto por um usuário autenticado, o LibreChat normalmente preenche o campo de composição com o prompt fornecido pela URL e o envia imediatamente. Este é um recurso de conveniência para deeplinks criados e URLs de chat compartilhadas.

Para implantações onde os usuários podem receber links criados a partir de fontes externas — e onde modelos habilitados para memória ou ferramentas podem vazar contexto sensível se um payload de injeção de prompt atingir o modelo — os operadores podem desativar o envio automático. Com a flag definida como false, o prompt ainda é pré-preenchido no compositor, mas o usuário deve pressionar Enviar explicitamente.

Chave:

Padrão: true (o comportamento existente é preservado, a menos que seja explicitamente desativado).

Notas:

• Esta configuração não afeta a seleção de Model Specs via URL ou outras configurações baseadas em URL — apenas a etapa de envio automático.
• O parâmetro de consulta aceita tanto prompt quanto q como fonte do prompt, com prompt tendo precedência. submit=true é o gatilho.
• Recomendado para instâncias que lidam com memória sensível ou dados de ferramentas, onde um vetor de injeção de prompt de 1 clique deve exigir confirmação explícita do usuário.

Exemplo:

interface:
  autoSubmitFromUrl: false

customWelcome

Chave:

Padrão: Nenhum (se não especificado, uma saudação padrão é usada)

Exemplo:

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

Nota: Você pode usar {{user.name}} dentro da mensagem customWelcome para inserir dinamicamente o nome do usuário para uma experiência de saudação personalizada.

runCode

Ativa/desativa o botão "Run Code" para blocos de código Markdown. Mais informações na API do Code Interpreter do LibreChat

Nota: Esta configuração não desativa a Capacidade de Interpretador de Código de Agentes. Para desativar a Capacidade de Agentes, consulte a configuração do endpoint de Agentes em vez disso.

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função RUN_CODE na inicialização apenas para a função USER padrão. Prefira o Painel de Administração.

Chave:

Padrão: true

Exemplo:

interface:
  runCode: true

webSearch

Ativa/desativa o botão de pesquisa na web na interface de chat. Mais informações em Configuração de Pesquisa na Web

Nota: Esta configuração não desativa a Capacidade de Pesquisa na Web dos Agents. Para desativar a Capacidade dos Agents, consulte a configuração do endpoint Agents em vez disso.

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função WEB_SEARCH na inicialização apenas para a função USER padrão. Prefira o Painel de Administração.

Chave:

Padrão: true

Exemplo:

interface:
  webSearch: true

fileSearch

Ativa/desativa o botão de pesquisa de arquivos (para uso da API de RAG via ferramenta) na interface de chat

Nota: Esta configuração não desativa a Capacidade de Pesquisa de Arquivos dos Agents. Para desativar a Capacidade dos Agents, consulte a configuração do endpoint de Agents em vez disso.

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função FILE_SEARCH na inicialização apenas para a função USER padrão. Prefira o Painel de Administração.

Chave:

Padrão: true

Exemplo:

interface:
  fileSearch: true

fileCitations

Controla a disponibilidade global da funcionalidade de citações de arquivos. Quando desativada, ela efetivamente remove a permissão FILE_CITATIONS para todos os usuários, impedindo que quaisquer citações de arquivos sejam exibidas ao usar a pesquisa de arquivos, independentemente das permissões individuais do usuário.

Obsoleto para gerenciamento de permissões. Define/habilita globalmente a permissão de função FILE_CITATIONS na inicialização. Prefira o Painel do Administrador para gerenciar permissões de citações por função/grupo/usuário.

Nota:

• Esta configuração atua como um interruptor global para o sistema de permissão FILE_CITATIONS em toda a instância.
• Quando definido como false, nenhum usuário verá citações de arquivos, mesmo que tenham recebido a permissão através de funções.
• As citações de arquivos exigem que o recurso fileSearch esteja habilitado.
• Ao usar agentes com capacidade de pesquisa de arquivos, o comportamento de citação (quantidade e qualidade) pode ser configurado através da configuração do endpoint de Agents.

Chave:

Padrão: true

Exemplo:

interface:
  fileCitations: true

defaultPinnedTools

Define as ferramentas fixadas iniciais na barra de prompt para usuários que não personalizaram o estado de suas ferramentas fixadas. Assim que um usuário fixa ou desafixa uma ferramenta, o LibreChat preserva a escolha desse usuário.

Chave:

Valores suportados:

• Chaves de ferramentas integradas: artifacts, execute_code, web_search, file_search, skills
• mcp para fixar o menu suspenso de servidores MCP
• Um nome de servidor MCP específico para definir esse servidor como fixado

Exemplo:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Controla quais tipos de principais (usuários, grupos, funções) estão disponíveis para seleção na interface de seletor de pessoas, normalmente usado ao compartilhar agentes ou gerenciar controles de acesso.

Obsoleto para gerenciamento de permissões. Inicializa as permissões de função PEOPLE_PICKER na inicialização apenas para a função USER padrão. Prefira o Painel de Administração.

Chave:

Sub-chaves:

Padrão:

peoplePicker:
  users: true
  groups: true
  roles: true

Exemplo:

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

marketplace

Habilita/desabilita o acesso ao Agent Marketplace.

Obsoleto para gerenciamento de permissões. Inicializa a permissão de função MARKETPLACE na inicialização apenas para a função USER padrão. Prefira o Painel Administrativo.

Chave:

Sub-chaves:

Padrão:

marketplace:
  use: false

Exemplo:

interface:
  marketplace:
    use: true # Enable marketplace access