Struttura dell'oggetto interfaccia

Panoramica

L'oggetto interface consente la personalizzazione di vari elementi dell'interfaccia utente all'interno dell'applicazione, incluse le impostazioni di visibilità e comportamento per componenti come menu, pannelli e link. Questa sezione fornisce un'analisi dettagliata della struttura dell'oggetto interface.

Questi sono i campi sotto 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

Note:

• Le configurazioni interface vengono applicate globalmente all'interno dell'applicazione.
• I valori predefiniti sono forniti per la maggior parte delle impostazioni, ma possono essere sovrascritti in base a requisiti o condizioni specifiche.
• La logica condizionale nell'applicazione può modificare ulteriormente queste impostazioni in base ad altre configurazioni, come le Model Specs.

Esempio

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

Deprecato per la gestione dei permessi. Le sotto-chiavi use, create, share e public inizializzano i permessi dei ruoli all'avvio. Si preferisca l'Admin Panel per gestire i permessi del server MCP per ruolo/gruppo/utente. Le sotto-chiavi placeholder e trustCheckbox non sono interessate.

Chiave:

Sotto-chiavi:

Sotto-chiavi di trustCheckbox:

Esempio:

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

Chiave:

Sotto-chiavi:

termsOfService

Chiave:

Sotto-chiavi:

modelSelect

Chiave:

Predefinito: true

Note:

• Questo deve essere impostato su true se si utilizza modelSpecs.addedEndpoints.
• Se modelSpecs.addedEndpoints viene utilizzato e interface.modelSelect non è impostato esplicitamente, il valore predefinito è true.

Esempio:

interface:
  modelSelect: true

parameters

Chiave:

Predefinito: true

Esempio:

interface:
  parameters: false

contextUsage

Chiave:

Predefinito: true

Esempio:

interface:
  contextUsage: true

contextCost

Chiave:

Predefinito: false

Note:

• Imposta contextCost: true per abilitare la visualizzazione dei valori di costo. L'utilizzo dei token può rimanere visibile tramite contextUsage mentre i valori di costo rimangono nascosti.
• currency influisce solo sui costi visualizzati quando la visualizzazione dei costi è abilitata.

Esempio:

interface:
  contextCost: true

currency

Chiave:

Sotto-chiavi:

Esempio:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Chiave:

Predefinito: true

Esempio:

interface:
  presets: true

prompts

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo PROMPTS all'avvio solo per il ruolo USER predefinito. Si preferisca il Admin Panel per gestire i permessi dei prompt per ruolo/gruppo/utente.

Chiave:

Predefinito: true

Importante: Configurazione Booleana vs Oggetto

• Boolean (prompts: true): Aggiorna solo l'autorizzazione use. I valori di autorizzazione esistenti create, share e public vengono preservati dal database. Utilizzalo come un semplice interruttore di funzionalità senza influire sulle altre impostazioni configurate tramite il pannello di amministrazione.

• Oggetto: Aggiorna solo le sotto-autorizzazioni specificate esplicitamente. Tutte le autorizzazioni non incluse nella configurazione vengono mantenute dal database.

Quando si utilizza la struttura a oggetti:

Sotto-chiavi:

Esempio (booleano - semplice attivazione di funzionalità):

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

Esempio (oggetto - controllo granulare):

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

Esempio (oggetto - controllo completo):

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

bookmarks

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo BOOKMARKS all'avvio solo per il ruolo USER predefinito. Si preferisce l'uso del Pannello di Amministrazione.

Chiave:

Predefinito: true

Esempio:

interface:
  bookmarks: true

memories

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo MEMORIES all'avvio solo per il ruolo USER predefinito. Si preferisca il Pannello di Amministrazione. Nota: questo interruttore è separato dalla configurazione del comportamento memory.

Chiave:

Predefinito: true

Nota: Questo controlla la visibilità nell'interfaccia utente della funzionalità memorie. Per una configurazione dettagliata del comportamento della memoria (limiti di token, personalizzazione, impostazioni dell'agente), consulta la Configurazione della Memoria.

Esempio:

interface:
  memories: true

multiConvo

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo MULTI_CONVO all'avvio solo per il ruolo USER predefinito. Si preferisca l'uso del Pannello di Amministrazione.

Chiave:

Predefinito: true

Esempio:

interface:
  multiConvo: true

agents

Maggiori informazioni sugli Agents

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo AGENTS all'avvio solo per il ruolo USER predefinito. Si preferisce l'uso del Admin Panel per gestire i permessi degli agenti per ruolo/gruppo/utente.

Chiave:

Predefinito: true

Importante: Configurazione Booleana vs Oggetto

• Boolean (agents: true): Aggiorna solo l'autorizzazione use. I valori di autorizzazione esistenti create, share e public vengono preservati dal database. Utilizzalo come un semplice interruttore di funzionalità senza influire su altre impostazioni configurate tramite il pannello di amministrazione.

• Oggetto: Aggiorna solo le sotto-autorizzazioni specificate esplicitamente. Tutte le autorizzazioni non incluse nella configurazione vengono mantenute dal database.

Quando si utilizza la struttura a oggetti:

Sotto-chiavi:

Esempio (booleano - semplice attivazione di funzionalità):

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

Esempio (oggetto - controllo granulare):

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

Esempio (oggetto - controllo completo):

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

remoteAgents

Controlla l'accesso all'API degli Agent (endpoint compatibili con OpenAI e API Open Responses), che consente alle applicazioni esterne di interagire con gli agenti di LibreChat in modo programmatico tramite chiavi API.

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo REMOTE_AGENTS all'avvio solo per il ruolo USER predefinito. Si preferisca l'uso del Pannello di Amministrazione.

Chiave:

Sotto-chiavi:

Predefinito: Tutti i campi sono impostati su false (disabilitati) per impostazione predefinita.

Esempio:

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

Nota: Gli utenti amministratori hanno tutti i permessi di agente remoto abilitati per impostazione predefinita, indipendentemente da questa configurazione.

skills

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo SKILLS all'avvio solo per il ruolo USER predefinito. Si preferisca il Pannello di Amministrazione per gestire i permessi delle Skills per ruolo/gruppo/utente. defaultActiveOnShare non è un bit di permesso e rimane un'impostazione di comportamento YAML.

Chiave:

Predefinito: true per use e create, false per share, public e defaultActiveOnShare.

Sotto-chiavi:

Esempio:

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

Per il comportamento delle Skills e le modalità di invocazione, consulta Skills.

sharedLinks

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo SHARED_LINKS all'avvio solo per il ruolo USER predefinito. Si preferisce utilizzare il Pannello di Amministrazione per gestire i permessi dei link condivisi per ruolo/gruppo/utente.

Chiave:

Predefinito: create: true, share: true, public: true

Importante: Configurazione Booleana vs Oggetto

• Boolean (sharedLinks: true): Abilita tutti i permessi SHARED_LINKS per il ruolo USER predefinito.
• Boolean (sharedLinks: false): Disabilita tutti i permessi SHARED_LINKS per il ruolo USER predefinito.
• Oggetto: Aggiorna solo le sotto-autorizzazioni specificate esplicitamente. Tutte le autorizzazioni non incluse nella configurazione vengono mantenute dal database.

Sotto-chiavi:

Esempio:

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

Per il comportamento dei link condivisi rivolti all'utente, vedere Shareable Links.

temporaryChat

Controlla se la funzionalità di chat temporanea è disponibile per gli utenti. Le chat temporanee non vengono salvate nella cronologia delle conversazioni e vengono eliminate automaticamente dopo un periodo di conservazione configurabile.

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo TEMPORARY_CHAT all'avvio solo per il ruolo USER predefinito. Si preferisca il Pannello di Amministrazione. temporaryChatRetention qui sotto non è un permesso e rimane il metodo consigliato per configurare la conservazione.

Chiave:

Predefinito: true

Nota: Il periodo di conservazione per le chat temporanee può essere configurato utilizzando temporaryChatRetention.

Esempio:

interface:
  temporaryChat: true

temporaryChatRetention

La configurazione temporaryChatRetention ti consente di personalizzare per quanto tempo le chat temporanee vengono conservate prima di essere eliminate automaticamente.

Chiave:

Regole di convalida:

• Minimo: 1 ora (impedisce l'eliminazione immediata)
• Massimo: 8760 ore (ritenzione massima di 1 anno)
• Predefinito: 720 ore (30 giorni)

Metodi di configurazione:

1. LibreChat.yaml (consigliato): interface.temporaryChatRetention: 168
2. Variabile d'ambiente (deprecata): TEMP_CHAT_RETENTION_HOURS=168

Nota: La variabile d'ambiente TEMP_CHAT_RETENTION_HOURS è deprecata. Si prega di utilizzare l'opzione di configurazione interface.temporaryChatRetention in librechat.yaml. Il valore nel file di configurazione ha la precedenza sulla variabile d'ambiente.

Esempio:

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

Periodi di conservazione comuni:

• 1 ora: temporaryChatRetention: 1 (ritenzione minima)
• 24 ore: temporaryChatRetention: 24 (1 giorno)
• 168 ore: temporaryChatRetention: 168 (1 settimana)
• 720 ore: temporaryChatRetention: 720 (30 giorni - predefinito)
• 8760 ore: temporaryChatRetention: 8760 (1 anno - massimo)

retentionMode

Controlla quali dati ricevono scadenze di conservazione.

Chiave:

Predefinito: temporary

Esempio:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Controlla se i file delle risorse degli agenti persistenti sono esenti dalla conservazione di tutti i dati.

Chiave:

Predefinito: false

Note:

• Questa impostazione modifica il comportamento solo quando retentionMode è impostato su "all".
• Impostare su true quando gli agenti devono mantenere i propri file di risorse persistenti anche quando le conversazioni, i messaggi e i file non relativi agli agenti sono soggetti a scadenze di conservazione.

Esempio:

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

autoSubmitFromUrl

Controlla se un prompt fornito tramite parametri di query URL su /c/new viene inviato automaticamente al modello.

Quando /c/new?prompt=…&submit=true viene aperto da un utente autenticato, LibreChat normalmente precompila il compositore con il prompt fornito dall'URL e lo invia immediatamente. Questa è una funzionalità di comodità per deeplink creati ad hoc e URL di chat condivisi.

Per le distribuzioni in cui gli utenti potrebbero ricevere link manipolati da fonti esterne — e dove i modelli con memoria o strumenti abilitati potrebbero divulgare contesti sensibili se un payload di prompt-injection raggiungesse il modello — gli operatori possono disabilitare l'invio automatico. Con il flag impostato su false, il prompt viene comunque precompilato nel composer, ma l'utente deve premere esplicitamente Invia.

Chiave:

Predefinito: true (il comportamento esistente viene preservato a meno che non venga esplicitamente disabilitato).

Note:

• Questa impostazione non influisce sulla selezione del Model Specs basata su URL o su altre impostazioni basate su URL, ma solo sul passaggio di invio automatico.
• Il parametro di query accetta sia prompt che q come origine del prompt, con prompt che ha la precedenza. submit=true è il trigger.
• Consigliato per istanze che gestiscono dati sensibili di memoria o strumenti, dove un vettore di prompt-injection con un solo clic dovrebbe richiedere l'esplicita conferma dell'utente.

Esempio:

interface:
  autoSubmitFromUrl: false

customWelcome

Chiave:

Predefinito: Nessuno (se non specificato, viene utilizzato un saluto predefinito)

Esempio:

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

Nota: Puoi utilizzare {{user.name}} all'interno del messaggio customWelcome per inserire dinamicamente il nome dell'utente per un'esperienza di saluto personalizzata.

runCode

Abilita/disabilita il pulsante "Run Code" per i blocchi di codice Markdown. Maggiori informazioni sull'API di Code Interpreter di LibreChat

Nota: Questa impostazione non disabilita la Funzionalità Interprete di Codice degli Agenti. Per disabilitare la funzionalità degli Agenti, consultare invece la configurazione dell'endpoint Agenti.

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo RUN_CODE all'avvio solo per il ruolo USER predefinito. Si preferisca l'uso del Pannello di Amministrazione.

Chiave:

Predefinito: true

Esempio:

interface:
  runCode: true

webSearch

Abilita/disabilita il pulsante di ricerca web nell'interfaccia di chat. Maggiori informazioni sulla Configurazione della Ricerca Web

Nota: Questa impostazione non disabilita la Funzionalità di Ricerca Web degli Agenti. Per disabilitare la funzionalità degli Agenti, consultare invece la configurazione dell'endpoint Agenti.

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo WEB_SEARCH all'avvio solo per il ruolo USER predefinito. Si preferisca l' Admin Panel.

Chiave:

Predefinito: true

Esempio:

interface:
  webSearch: true

fileSearch

Abilita/disabilita il pulsante di ricerca file (per l'utilizzo dell'API RAG tramite tool) nell'interfaccia di chat

Nota: Questa impostazione non disabilita la Funzionalità di ricerca file degli Agent. Per disabilitare la funzionalità degli Agent, consultare invece la configurazione dell'endpoint degli Agent.

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo FILE_SEARCH all'avvio solo per il ruolo USER predefinito. Si preferisca l'uso del Pannello di Amministrazione.

Chiave:

Predefinito: true

Esempio:

interface:
  fileSearch: true

fileCitations

Controlla la disponibilità globale della funzionalità di citazione dei file. Quando disabilitata, rimuove effettivamente il permesso FILE_CITATIONS per tutti gli utenti, impedendo la visualizzazione di qualsiasi citazione di file durante l'utilizzo della ricerca file, indipendentemente dai permessi dei singoli utenti.

Deprecato per la gestione dei permessi. Inizializza/abilita globalmente il permesso del ruolo FILE_CITATIONS all'avvio. Si preferisce utilizzare il Pannello di Amministrazione per gestire i permessi delle citazioni per ruolo/gruppo/utente.

Nota:

• Questa impostazione funge da interruttore globale per il sistema di permessi FILE_CITATIONS a livello dell'intera applicazione.
• Quando impostato su false, nessun utente vedrà le citazioni dei file, anche se gli è stato concesso il permesso tramite i ruoli.
• Le citazioni dei file richiedono che la funzionalità fileSearch sia abilitata.
• Quando si utilizzano agenti con funzionalità di ricerca file, il comportamento delle citazioni (quantità e qualità) può essere configurato tramite la configurazione dell'endpoint Agents.

Chiave:

Predefinito: true

Esempio:

interface:
  fileCitations: true

defaultPinnedTools

Preimposta gli strumenti fissati nella barra dei prompt iniziale per gli utenti che non hanno personalizzato lo stato dei propri strumenti fissati. Una volta che un utente fissa o rimuove uno strumento, LibreChat preserva la scelta dell'utente.

Chiave:

Valori supportati:

• Chiavi degli strumenti integrati: artifacts, execute_code, web_search, file_search, skills
• mcp per fissare il menu a tendina dei server MCP
• Un nome specifico di server MCP per impostare quel server come fissato

Esempio:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Controlla quali tipi di entità (utenti, gruppi, ruoli) sono disponibili per la selezione nell'interfaccia di selezione delle persone, solitamente utilizzato durante la condivisione di agenti o la gestione dei controlli di accesso.

Deprecato per la gestione dei permessi. Inizializza i permessi del ruolo PEOPLE_PICKER all'avvio solo per il ruolo USER predefinito. Si preferisca l'uso del Pannello di Amministrazione.

Chiave:

Sotto-chiavi:

Predefinito:

peoplePicker:
  users: true
  groups: true
  roles: true

Esempio:

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

marketplace

Abilita/disabilita l'accesso all'Agent Marketplace.

Deprecato per la gestione dei permessi. Inizializza il permesso del ruolo MARKETPLACE all'avvio solo per il ruolo USER predefinito. Si preferisca l'uso del Admin Panel.

Chiave:

Sotto-chiavi:

Predefinito:

marketplace:
  use: false

Esempio:

interface:
  marketplace:
    use: true # Enable marketplace access