Struktur Objek Antarmuka

Ikhtisar

Objek interface memungkinkan penyesuaian berbagai elemen antarmuka pengguna di dalam aplikasi, termasuk pengaturan visibilitas dan perilaku untuk komponen seperti menu, panel, dan tautan. Bagian ini memberikan rincian mendalam mengenai struktur objek interface.

Ini adalah kolom-kolom di bawah 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

Catatan:

• Konfigurasi interface diterapkan secara global di dalam aplikasi.
• Nilai default disediakan untuk sebagian besar pengaturan namun dapat diganti berdasarkan persyaratan atau kondisi tertentu.
• Logika kondisional dalam aplikasi dapat memodifikasi pengaturan ini lebih lanjut berdasarkan konfigurasi lain seperti Model Specs.

Contoh

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

Tidak digunakan lagi untuk manajemen izin. Sub-kunci use, create, share, dan public melakukan seed pada izin peran saat startup. Gunakan Admin Panel untuk mengelola izin server MCP per peran/grup/pengguna. Sub-kunci placeholder dan trustCheckbox tidak terpengaruh.

Kunci:

Sub-kunci:

Sub-key trustCheckbox:

Contoh:

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

Kunci:

Sub-kunci:

termsOfService

Kunci:

Sub-kunci:

modelSelect

Kunci:

Default: true

Catatan:

• Ini wajib diatur ke true jika menggunakan modelSpecs.addedEndpoints.
• Jika modelSpecs.addedEndpoints digunakan dan interface.modelSelect tidak diatur secara eksplisit, maka nilainya secara default adalah true.

Contoh:

interface:
  modelSelect: true

parameters

Kunci:

Default: true

Contoh:

interface:
  parameters: false

contextUsage

Kunci:

Default: true

Contoh:

interface:
  contextUsage: true

contextCost

Kunci:

Default: false

Catatan:

• Atur contextCost: true untuk memilih agar nilai biaya terlihat. Penggunaan token dapat tetap terlihat melalui contextUsage sementara nilai biaya tetap disembunyikan.
• currency hanya memengaruhi biaya yang ditampilkan saat tampilan biaya diaktifkan.

Contoh:

interface:
  contextCost: true

currency

Kunci:

Sub-kunci:

Contoh:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Kunci:

Default: true

Contoh:

interface:
  presets: true

prompts

Tidak digunakan lagi untuk manajemen izin. Melakukan seeding izin peran PROMPTS saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel untuk mengelola izin prompt per peran/grup/pengguna.

Kunci:

Default: true

Penting: Konfigurasi Boolean vs Objek

• Boolean (prompts: true): Hanya memperbarui izin use. Nilai izin create, share, dan public yang sudah ada akan dipertahankan dari basis data. Gunakan ini sebagai pengalih fitur sederhana tanpa memengaruhi pengaturan lain yang dikonfigurasi melalui panel admin.

• Objek: Hanya memperbarui sub-izin yang ditentukan secara eksplisit. Izin apa pun yang tidak disertakan dalam konfigurasi akan dipertahankan dari basis data.

Saat menggunakan struktur objek:

Sub-kunci:

Contoh (boolean - pengalih fitur sederhana):

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

Contoh (objek - kontrol granular):

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

Contoh (objek - kontrol penuh):

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

bookmarks

Tidak digunakan lagi untuk manajemen izin. Menambahkan izin peran BOOKMARKS saat startup hanya untuk peran USER default. Gunakan Admin Panel sebagai gantinya.

Kunci:

Default: true

Contoh:

interface:
  bookmarks: true

memories

Tidak digunakan lagi untuk manajemen izin. Menginisialisasi izin peran MEMORIES saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel. Perhatikan bahwa tombol ini terpisah dari konfigurasi perilaku memory.

Kunci:

Default: true

Catatan: Ini mengontrol visibilitas UI fitur memori. Untuk konfigurasi perilaku memori yang mendetail (batas token, personalisasi, pengaturan agen), lihat Memory Configuration.

Contoh:

interface:
  memories: true

multiConvo

Tidak lagi digunakan untuk manajemen izin. Menambahkan izin peran MULTI_CONVO saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Default: true

Contoh:

interface:
  multiConvo: true

agents

Info lebih lanjut tentang Agents

Tidak digunakan lagi untuk manajemen izin. Menginisialisasi izin peran AGENTS saat startup hanya untuk peran USER default. Gunakan Admin Panel untuk mengelola izin agen per peran/grup/pengguna.

Kunci:

Default: true

Penting: Konfigurasi Boolean vs Objek

• Boolean (agents: true): Hanya memperbarui izin use. Nilai izin create, share, dan public yang sudah ada akan dipertahankan dari basis data. Gunakan ini sebagai pengalih fitur sederhana tanpa memengaruhi pengaturan lain yang dikonfigurasi melalui panel admin.

• Objek: Hanya memperbarui sub-izin yang ditentukan secara eksplisit. Izin apa pun yang tidak disertakan dalam konfigurasi akan dipertahankan dari basis data.

Saat menggunakan struktur objek:

Sub-kunci:

Contoh (boolean - pengalih fitur sederhana):

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

Contoh (objek - kontrol granular):

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

Contoh (objek - kontrol penuh):

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

remoteAgents

Mengontrol akses ke Agents API (endpoint yang kompatibel dengan OpenAI dan Open Responses API), yang memungkinkan aplikasi eksternal untuk berinteraksi dengan agen LibreChat secara terprogram melalui kunci API.

Tidak digunakan lagi untuk manajemen izin. Melakukan seeding izin peran REMOTE_AGENTS saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Sub-kunci:

Default: Semua kolom secara default bernilai false (dinonaktifkan).

Contoh:

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

Catatan: Pengguna admin memiliki semua izin agen jarak jauh yang diaktifkan secara default terlepas dari konfigurasi ini.

skills

Tidak digunakan lagi untuk manajemen izin. Melakukan seeding izin peran SKILLS saat startup hanya untuk peran USER default. Gunakan Admin Panel untuk mengelola izin Skills per peran/grup/pengguna. defaultActiveOnShare bukan merupakan bit izin dan tetap menjadi pengaturan perilaku YAML.

Kunci:

Default: true untuk use dan create, false untuk share, public, dan defaultActiveOnShare.

Sub-kunci:

Contoh:

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

Untuk perilaku Skills dan mode pemanggilan, lihat Skills.

sharedLinks

Tidak lagi digunakan untuk manajemen izin. Menginisialisasi izin peran SHARED_LINKS saat startup hanya untuk peran USER default. Gunakan Admin Panel untuk mengelola izin tautan bersama per peran/grup/pengguna.

Kunci:

Default: create: true, share: true, public: true

Penting: Konfigurasi Boolean vs Objek

• Boolean (sharedLinks: true): Mengaktifkan semua izin SHARED_LINKS untuk peran USER default.
• Boolean (sharedLinks: false): Menonaktifkan semua izin SHARED_LINKS untuk peran USER default.
• Objek: Hanya memperbarui sub-izin yang ditentukan secara eksplisit. Izin apa pun yang tidak disertakan dalam konfigurasi akan dipertahankan dari basis data.

Sub-kunci:

Contoh:

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

Untuk perilaku tautan berbagi yang menghadap pengguna, lihat Shareable Links.

temporaryChat

Mengontrol apakah fitur obrolan sementara tersedia bagi pengguna. Obrolan sementara tidak disimpan ke riwayat percakapan dan akan dihapus secara otomatis setelah periode retensi yang dapat dikonfigurasi.

Tidak digunakan lagi untuk manajemen izin. Menambahkan izin peran TEMPORARY_CHAT saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel. temporaryChatRetention di bawah ini bukanlah sebuah izin dan tetap menjadi cara yang direkomendasikan untuk mengonfigurasi retensi.

Kunci:

Default: true

Catatan: Periode retensi untuk obrolan sementara dapat dikonfigurasi menggunakan temporaryChatRetention.

Contoh:

interface:
  temporaryChat: true

temporaryChatRetention

Konfigurasi temporaryChatRetention memungkinkan Anda untuk menyesuaikan berapa lama obrolan sementara disimpan sebelum dihapus secara otomatis.

Kunci:

Aturan Validasi:

• Minimum: 1 jam (mencegah penghapusan segera)
• Maksimum: 8760 jam (retensi maksimum 1 tahun)
• Default: 720 jam (30 hari)

Metode Konfigurasi:

1. LibreChat.yaml (disarankan): interface.temporaryChatRetention: 168
2. Variabel Lingkungan (tidak digunakan lagi): TEMP_CHAT_RETENTION_HOURS=168

Catatan: Variabel lingkungan TEMP_CHAT_RETENTION_HOURS sudah tidak digunakan lagi (deprecated). Harap gunakan opsi konfigurasi interface.temporaryChatRetention di dalam librechat.yaml sebagai gantinya. Nilai dalam file konfigurasi lebih diutamakan daripada variabel lingkungan.

Contoh:

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

Periode Retensi Umum:

• 1 jam: temporaryChatRetention: 1 (retensi minimal)
• 24 jam: temporaryChatRetention: 24 (1 hari)
• 168 jam: temporaryChatRetention: 168 (1 minggu)
• 720 jam: temporaryChatRetention: 720 (30 hari - default)
• 8760 jam: temporaryChatRetention: 8760 (1 tahun - maksimum)

retentionMode

Mengontrol data mana yang menerima tenggat waktu retensi.

Kunci:

Default: temporary

Contoh:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Mengontrol apakah file sumber daya agen persisten dikecualikan dari retensi semua data.

Kunci:

Default: false

Catatan:

• Pengaturan ini hanya mengubah perilaku saat retentionMode diatur ke "all".
• Atur ini ke true jika agen harus tetap menyimpan file sumber daya persisten mereka meskipun percakapan, pesan, dan file non-agen menerima batas waktu retensi.

Contoh:

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

autoSubmitFromUrl

Mengontrol apakah prompt yang diberikan melalui parameter kueri URL pada /c/new dikirim secara otomatis ke model.

Ketika /c/new?prompt=…&submit=true dibuka oleh pengguna yang terautentikasi, LibreChat biasanya mengisi composer dengan prompt yang diberikan melalui URL dan langsung mengirimkannya. Ini adalah fitur kenyamanan untuk deeplink yang dibuat khusus dan URL obrolan yang dibagikan.

Untuk penyebaran di mana pengguna mungkin menerima tautan yang dibuat khusus dari sumber eksternal — dan di mana model yang mendukung memori atau alat dapat membocorkan konteks sensitif jika payload injeksi perintah mencapai model — operator dapat menonaktifkan pengiriman otomatis (auto-submission). Dengan flag yang diatur ke false, perintah tetap akan terisi sebelumnya di komposer, tetapi pengguna harus menekan Send secara eksplisit.

Kunci:

Default: true (perilaku yang ada tetap dipertahankan kecuali dinonaktifkan secara eksplisit).

Catatan:

• Pengaturan ini tidak memengaruhi pemilihan Model Specs berbasis URL atau pengaturan berbasis URL lainnya — hanya langkah pengiriman otomatis.
• Parameter kueri menerima prompt dan q sebagai sumber prompt, dengan prompt yang lebih diutamakan. submit=true adalah pemicunya.
• Direkomendasikan untuk instance yang menangani memori sensitif atau data alat, di mana vektor injeksi prompt 1-klik harus memerlukan konfirmasi eksplisit dari pengguna.

Contoh:

interface:
  autoSubmitFromUrl: false

customWelcome

Kunci:

Default: None (jika tidak ditentukan, salam default akan digunakan)

Contoh:

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

Catatan: Anda dapat menggunakan {{user.name}} di dalam pesan customWelcome untuk menyisipkan nama pengguna secara dinamis guna mendapatkan pengalaman sapaan yang dipersonalisasi.

runCode

Mengaktifkan/menonaktifkan tombol "Run Code" untuk Blok Kode Markdown. Info lebih lanjut mengenai LibreChat Code Interpreter API

Catatan: Pengaturan ini tidak menonaktifkan Agents Code Interpreter Capability. Untuk menonaktifkan Agents Capability, lihat konfigurasi Agents Endpoint sebagai gantinya.

Tidak digunakan lagi untuk manajemen izin. Menambahkan izin peran RUN_CODE saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Default: true

Contoh:

interface:
  runCode: true

webSearch

Mengaktifkan/menonaktifkan tombol pencarian web di antarmuka obrolan. Info lebih lanjut tentang Web Search Configuration

Catatan: Pengaturan ini tidak menonaktifkan Agents Web Search Capability. Untuk menonaktifkan Agents Capability, lihat Agents Endpoint configuration sebagai gantinya.

Tidak digunakan lagi untuk manajemen izin. Menambahkan izin peran WEB_SEARCH saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Default: true

Contoh:

interface:
  webSearch: true

fileSearch

Mengaktifkan/menonaktifkan tombol pencarian file (untuk penggunaan API RAG melalui tool) di antarmuka obrolan

Catatan: Pengaturan ini tidak menonaktifkan Agents File Search Capability. Untuk menonaktifkan Agents Capability, lihat konfigurasi Agents Endpoint sebagai gantinya.

Tidak digunakan lagi untuk manajemen izin. Menambahkan izin peran FILE_SEARCH saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Default: true

Contoh:

interface:
  fileSearch: true

fileCitations

Mengontrol ketersediaan global fungsionalitas sitasi file. Saat dinonaktifkan, ini secara efektif menghapus izin FILE_CITATIONS untuk semua pengguna, mencegah sitasi file apa pun ditampilkan saat menggunakan pencarian file, terlepas dari izin pengguna individu.

Tidak digunakan lagi untuk manajemen izin. Melakukan seeding/membatasi izin peran FILE_CITATIONS secara global saat startup. Gunakan Admin Panel untuk mengelola izin sitasi per peran/grup/pengguna.

Catatan:

• Pengaturan ini berfungsi sebagai tombol pengalih global untuk sistem izin FILE_CITATIONS di seluruh aplikasi.
• Jika diatur ke false, tidak ada pengguna yang akan melihat sitasi file, meskipun mereka telah diberikan izin melalui peran.
• Kutipan file memerlukan fitur fileSearch untuk diaktifkan.
• Saat menggunakan agen dengan kemampuan pencarian file, perilaku sitasi (kuantitas dan kualitas) dapat dikonfigurasi melalui konfigurasi endpoint Agents.

Kunci:

Default: true

Contoh:

interface:
  fileCitations: true

defaultPinnedTools

Menetapkan alat yang disematkan (pinned tools) pada bilah perintah awal untuk pengguna yang belum menyesuaikan status alat yang disematkan milik mereka. Setelah pengguna menyematkan atau melepas sematan alat, LibreChat akan mempertahankan pilihan pengguna tersebut.

Kunci:

Nilai yang didukung:

• Kunci alat bawaan: artifacts, execute_code, web_search, file_search, skills
• mcp untuk menyematkan dropdown server MCP
• Nama server MCP spesifik untuk menyematkan server tersebut sebagai disematkan (pinned)

Contoh:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Mengontrol jenis prinsipal (pengguna, grup, peran) mana yang tersedia untuk dipilih di antarmuka pemilih orang, biasanya digunakan saat membagikan agen atau mengelola kontrol akses.

Tidak digunakan lagi untuk manajemen izin. Melakukan seeding izin peran PEOPLE_PICKER saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Sub-kunci:

Default:

peoplePicker:
  users: true
  groups: true
  roles: true

Contoh:

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

marketplace

Mengaktifkan/menonaktifkan akses ke Agent Marketplace.

Tidak digunakan lagi untuk manajemen izin. Menambahkan izin peran MARKETPLACE saat startup hanya untuk peran USER default. Lebih disarankan menggunakan Admin Panel.

Kunci:

Sub-kunci:

Default:

marketplace:
  use: false

Contoh:

interface:
  marketplace:
    use: true # Enable marketplace access