Struktura obiektu interfejsu

Przegląd

Obiekt interface umożliwia dostosowanie różnych elementów interfejsu użytkownika wewnątrz aplikacji, w tym ustawień widoczności i zachowania komponentów, takich jak menu, panele i linki. Ta sekcja zawiera szczegółowy podział struktury obiektu interface.

Oto pola w sekcji 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

Uwagi:

• Konfiguracje interface są stosowane globalnie w całej aplikacji.
• Wartości domyślne są zapewnione dla większości ustawień, ale można je zastąpić w oparciu o określone wymagania lub warunki.
• Logika warunkowa w aplikacji może dodatkowo modyfikować te ustawienia w oparciu o inne konfiguracje, takie jak Model Specs.

Przykład

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

Wycofane na rzecz zarządzania uprawnieniami. Podklucze use, create, share oraz public inicjują uprawnienia ról podczas uruchamiania. Zaleca się korzystanie z Panelu Administratora do zarządzania uprawnieniami serwera MCP dla poszczególnych ról/grup/użytkowników. Podklucze placeholder oraz trustCheckbox pozostają bez zmian.

Klucz:

Podklucze:

Podklucze trustCheckbox:

Przykład:

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

Klucz:

Podklucze:

termsOfService

Klucz:

Podklucze:

modelSelect

Klucz:

Domyślnie: true

Uwagi:

• Jest to wymagane, aby ustawić na true, jeśli używasz modelSpecs.addedEndpoints.
• Jeśli użyto modelSpecs.addedEndpoints, a interface.modelSelect nie zostało jawnie ustawione, domyślnie przyjmuje ono wartość true.

Przykład:

interface:
  modelSelect: true

parameters

Klucz:

Domyślnie: true

Przykład:

interface:
  parameters: false

contextUsage

Klucz:

Domyślnie: true

Przykład:

interface:
  contextUsage: true

contextCost

Klucz:

Domyślnie: false

Uwagi:

• Ustaw contextCost: true, aby włączyć widoczność wartości kosztów. Zużycie tokenów może pozostać widoczne dzięki contextUsage, podczas gdy wartości kosztów pozostaną ukryte.
• currency wpływa tylko na wyświetlane koszty, gdy wyświetlanie kosztów jest włączone.

Przykład:

interface:
  contextCost: true

currency

Klucz:

Podklucze:

Przykład:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Klucz:

Domyślnie: true

Przykład:

interface:
  presets: true

prompts

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienia roli PROMPTS podczas uruchamiania tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora w celu zarządzania uprawnieniami do promptów dla poszczególnych ról, grup lub użytkowników.

Klucz:

Domyślnie: true

Ważne: Konfiguracja typu Boolean a Object

• Wartość logiczna (prompts: true): Aktualizuje wyłącznie uprawnienie use. Istniejące wartości uprawnień create, share oraz public są zachowywane w bazie danych. Użyj tego jako prostego przełącznika funkcji bez wpływu na inne ustawienia skonfigurowane w panelu administratora.

• Obiekt: Aktualizuje tylko te poduprawnienia, które zostały wyraźnie określone. Wszelkie uprawnienia nieuwzględnione w konfiguracji są zachowywane w postaci pobranej z bazy danych.

Podczas korzystania ze struktury obiektu:

Podklucze:

Przykład (wartość logiczna - proste przełączanie funkcji):

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

Przykład (obiekt - szczegółowa kontrola):

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

Przykład (obiekt - pełna kontrola):

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

bookmarks

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienie roli BOOKMARKS przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Domyślnie: true

Przykład:

interface:
  bookmarks: true

memories

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje uprawnienia roli MEMORIES przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora. Uwaga: ten przełącznik jest niezależny od konfiguracji zachowania memory.

Klucz:

Domyślnie: true

Uwaga: To ustawienie kontroluje widoczność funkcji pamięci w interfejsie użytkownika. Szczegółową konfigurację zachowania pamięci (limity tokenów, personalizacja, ustawienia agenta) można znaleźć w Memory Configuration.

Przykład:

interface:
  memories: true

multiConvo

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje uprawnienie roli MULTI_CONVO przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Domyślnie: true

Przykład:

interface:
  multiConvo: true

agents

Więcej informacji na temat Agents

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje uprawnienia roli AGENTS przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora do zarządzania uprawnieniami agentów dla poszczególnych ról, grup lub użytkowników.

Klucz:

Domyślnie: true

Ważne: Konfiguracja typu Boolean a Object

• Boolean (agents: true): Aktualizuje tylko uprawnienie use. Istniejące wartości uprawnień create, share oraz public są zachowywane z bazy danych. Użyj tego jako prostego przełącznika funkcji bez wpływu na inne ustawienia skonfigurowane w panelu administratora.

• Obiekt: Aktualizuje tylko te poduprawnienia, które zostały wyraźnie określone. Wszelkie uprawnienia nieuwzględnione w konfiguracji są zachowywane w postaci pobranej z bazy danych.

Podczas korzystania ze struktury obiektu:

Podklucze:

Przykład (wartość logiczna - proste przełączanie funkcji):

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

Przykład (obiekt - szczegółowa kontrola):

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

Przykład (obiekt - pełna kontrola):

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

remoteAgents

Kontroluje dostęp do Agents API (punktów końcowych zgodnych z OpenAI oraz Open Responses API), co pozwala zewnętrznym aplikacjom na programową interakcję z agentami LibreChat za pomocą kluczy API.

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienia roli REMOTE_AGENTS przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Podklucze:

Domyślnie: Wszystkie pola mają domyślnie wartość false (wyłączone).

Przykład:

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

Uwaga: Użytkownicy z uprawnieniami administratora mają domyślnie włączone wszystkie uprawnienia zdalnego agenta, niezależnie od tej konfiguracji.

skills

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienia roli SKILLS przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora w celu zarządzania uprawnieniami do umiejętności (Skills) dla poszczególnych ról/grup/użytkowników. defaultActiveOnShare nie jest bitem uprawnień i pozostaje ustawieniem zachowania w pliku YAML.

Klucz:

Domyślnie: true dla use i create, false dla share, public oraz defaultActiveOnShare.

Podklucze:

Przykład:

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

Aby uzyskać informacje na temat zachowania Skills i trybów wywoływania, zobacz Skills.

sharedLinks

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje uprawnienia roli SHARED_LINKS przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora w celu zarządzania uprawnieniami do udostępnionych linków dla poszczególnych ról/grup/użytkowników.

Klucz:

Domyślnie: create: true, share: true, public: true

Ważne: Konfiguracja typu Boolean a Object

• Boolean (sharedLinks: true): Włącza wszystkie uprawnienia SHARED_LINKS dla domyślnej roli USER.
• Boolean (sharedLinks: false): Wyłącza wszystkie uprawnienia SHARED_LINKS dla domyślnej roli USER.
• Obiekt: Aktualizuje tylko te poduprawnienia, które zostały wyraźnie określone. Wszelkie uprawnienia nieuwzględnione w konfiguracji są zachowywane w postaci pobranej z bazy danych.

Podklucze:

Przykład:

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

Aby uzyskać informacje na temat zachowania udostępnionych linków z perspektywy użytkownika, zobacz Shareable Links.

temporaryChat

Określa, czy funkcja czatu tymczasowego jest dostępna dla użytkowników. Czaty tymczasowe nie są zapisywane w historii konwersacji i są automatycznie usuwane po upływie konfigurowalnego okresu przechowywania.

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienie roli TEMPORARY_CHAT podczas uruchamiania tylko dla domyślnej roli USER. Preferowany jest Panel Administratora. Poniższe temporaryChatRetention nie jest uprawnieniem i pozostaje zalecanym sposobem konfiguracji retencji.

Klucz:

Domyślnie: true

Uwaga: Okres przechowywania tymczasowych czatów można skonfigurować za pomocą temporaryChatRetention.

Przykład:

interface:
  temporaryChat: true

temporaryChatRetention

Konfiguracja temporaryChatRetention pozwala dostosować czas przechowywania tymczasowych czatów przed ich automatycznym usunięciem.

Klucz:

Zasady walidacji:

• Minimum: 1 godzina (zapobiega natychmiastowemu usunięciu)
• Maksimum: 8760 godzin (maksymalnie 1 rok przechowywania)
• Domyślnie: 720 godzin (30 dni)

Metody konfiguracji:

1. LibreChat.yaml (zalecane): interface.temporaryChatRetention: 168
2. Zmienna środowiskowa (przestarzała): TEMP_CHAT_RETENTION_HOURS=168

Uwaga: Zmienna środowiskowa TEMP_CHAT_RETENTION_HOURS jest przestarzała. Zamiast niej należy użyć opcji konfiguracyjnej interface.temporaryChatRetention w pliku librechat.yaml. Wartość z pliku konfiguracyjnego ma pierwszeństwo przed zmienną środowiskową.

Przykład:

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

Typowe okresy przechowywania:

• 1 godzina: temporaryChatRetention: 1 (minimalna retencja)
• 24 godziny: temporaryChatRetention: 24 (1 dzień)
• 168 godzin: temporaryChatRetention: 168 (1 tydzień)
• 720 godzin: temporaryChatRetention: 720 (30 dni - domyślnie)
• 8760 godzin: temporaryChatRetention: 8760 (1 rok – maksimum)

retentionMode

Określa, które dane podlegają terminom przechowywania.

Klucz:

Domyślnie: temporary

Przykład:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Określa, czy trwałe pliki zasobów agenta są zwolnione z retencji wszystkich danych.

Klucz:

Domyślnie: false

Uwagi:

• To ustawienie zmienia zachowanie tylko wtedy, gdy retentionMode jest ustawione na "all".
• Ustaw tę wartość na true, gdy agenci powinni zachowywać swoje trwałe pliki zasobów, nawet jeśli konwersacje, wiadomości i pliki niebędące plikami agenta podlegają terminom retencji.

Przykład:

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

autoSubmitFromUrl

Określa, czy prompt dostarczony za pomocą parametrów zapytania URL w /c/new jest automatycznie przesyłany do modelu.

Gdy /c/new?prompt=…&submit=true zostanie otwarte przez uwierzytelnionego użytkownika, LibreChat standardowo wypełnia pole wprowadzania tekstu promptem dostarczonym w adresie URL i przesyła go natychmiast. Jest to funkcja ułatwiająca korzystanie ze specjalnie przygotowanych linków (deeplinks) oraz udostępnionych adresów URL czatów.

W przypadku wdrożeń, w których użytkownicy mogą otrzymywać spreparowane linki ze źródeł zewnętrznych — oraz tam, gdzie modele z obsługą pamięci lub narzędzi mogłyby ujawnić poufny kontekst, jeśli ładunek typu prompt-injection dotrze do modelu — operatorzy mogą wyłączyć automatyczne przesyłanie. Gdy flaga jest ustawiona na false, prompt jest nadal wstępnie wypełniany w polu edycji, ale użytkownik musi wyraźnie nacisnąć przycisk Wyślij (Send).

Klucz:

Domyślnie: true (istniejące zachowanie jest zachowane, chyba że zostanie jawnie wyłączone).

Uwagi:

• To ustawienie nie wpływa na wybór Model Specs sterowany adresem URL ani na inne ustawienia sterowane adresem URL — jedynie na krok automatycznego przesyłania.
• Parametr zapytania akceptuje zarówno prompt, jak i q jako źródło promptu, przy czym prompt ma wyższy priorytet. submit=true jest wyzwalaczem.
• Zalecane dla instancji obsługujących wrażliwe dane z pamięci lub narzędzi, gdzie wektor ataku typu prompt-injection wymagający jednego kliknięcia powinien wymagać wyraźnego potwierdzenia przez użytkownika.

Przykład:

interface:
  autoSubmitFromUrl: false

customWelcome

Klucz:

Domyślnie: Brak (jeśli nie określono, używane jest domyślne powitanie)

Przykład:

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

Uwaga: Możesz użyć {{user.name}} wewnątrz wiadomości customWelcome, aby dynamicznie wstawić imię użytkownika w celu uzyskania spersonalizowanego powitania.

runCode

Włącza/wyłącza przycisk „Uruchom kod” dla bloków kodu Markdown. Więcej informacji na temat LibreChat Code Interpreter API

Uwaga: To ustawienie nie wyłącza funkcji interpretera kodu agentów. Aby wyłączyć funkcję agentów, zapoznaj się z konfiguracją endpointu Agents.

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje uprawnienie roli RUN_CODE podczas uruchamiania tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Domyślnie: true

Przykład:

interface:
  runCode: true

webSearch

Włącza/wyłącza przycisk wyszukiwania w sieci w interfejsie czatu. Więcej informacji w Konfiguracja wyszukiwania w sieci

Uwaga: To ustawienie nie wyłącza funkcji wyszukiwania w sieci dla Agentów. Aby wyłączyć funkcję Agentów, zapoznaj się z konfiguracją punktu końcowego Agentów.

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienie roli WEB_SEARCH podczas uruchamiania tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Domyślnie: true

Przykład:

interface:
  webSearch: true

fileSearch

Włącza/wyłącza przycisk wyszukiwania plików (do użycia RAG API poprzez narzędzie) w interfejsie czatu

Uwaga: To ustawienie nie wyłącza funkcji wyszukiwania w plikach agentów. Aby wyłączyć funkcję agentów, zobacz zamiast tego konfigurację punktu końcowego agentów.

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienie roli FILE_SEARCH przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Domyślnie: true

Przykład:

interface:
  fileSearch: true

fileCitations

Kontroluje globalną dostępność funkcji cytowań plików. Gdy jest wyłączona, skutecznie usuwa uprawnienie FILE_CITATIONS dla wszystkich użytkowników, uniemożliwiając wyświetlanie jakichkolwiek cytowań plików podczas korzystania z wyszukiwania plików, niezależnie od indywidualnych uprawnień użytkownika.

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje/globalnie udostępnia uprawnienie roli FILE_CITATIONS podczas uruchamiania. Zaleca się korzystanie z Panelu Administratora w celu zarządzania uprawnieniami do cytowań dla poszczególnych ról/grup/użytkowników.

Uwaga:

• To ustawienie działa jako globalny przełącznik dla systemu uprawnień FILE_CITATIONS w całej aplikacji.
• Gdy ustawiono na false, żaden użytkownik nie będzie widział cytowań plików, nawet jeśli przyznano mu do tego uprawnienia poprzez role.
• Cytowania plików wymagają włączenia funkcji fileSearch.
• Podczas korzystania z agentów z funkcją wyszukiwania plików, zachowanie cytowań (ilość i jakość) można skonfigurować poprzez konfigurację endpointu Agents.

Klucz:

Domyślnie: true

Przykład:

interface:
  fileCitations: true

defaultPinnedTools

Inicjuje początkowe przypięte narzędzia na pasku promptów dla użytkowników, którzy nie dostosowali jeszcze stanu przypiętych narzędzi. Gdy użytkownik przypnie lub odepnie narzędzie, LibreChat zachowuje jego wybór.

Klucz:

Obsługiwane wartości:

• Wbudowane klucze narzędzi: artifacts, execute_code, web_search, file_search, skills
• mcp aby przypiąć menu rozwijane serwerów MCP
• Określona nazwa serwera MCP, aby dodać ten serwer do przypiętych

Przykład:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Określa, które typy podmiotów (użytkownicy, grupy, role) są dostępne do wyboru w interfejsie wyboru osób, co jest zazwyczaj używane podczas udostępniania agentów lub zarządzania kontrolą dostępu.

Wycofane na rzecz zarządzania uprawnieniami. Inicjuje uprawnienia roli PEOPLE_PICKER przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Podklucze:

Domyślne:

peoplePicker:
  users: true
  groups: true
  roles: true

Przykład:

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

marketplace

Włącza/wyłącza dostęp do Agent Marketplace.

Przestarzałe w kontekście zarządzania uprawnieniami. Inicjuje uprawnienie roli MARKETPLACE przy starcie tylko dla domyślnej roli USER. Zaleca się korzystanie z Panelu Administratora.

Klucz:

Podklucze:

Domyślne:

marketplace:
  use: false

Przykład:

interface:
  marketplace:
    use: true # Enable marketplace access