Cấu trúc đối tượng giao diện

Tổng quan

Đối tượng interface cho phép tùy chỉnh các thành phần giao diện người dùng khác nhau trong ứng dụng, bao gồm các cài đặt về khả năng hiển thị và hành vi cho các thành phần như menu, bảng điều khiển và liên kết. Phần này cung cấp thông tin chi tiết về cấu trúc của đối tượng interface.

Đây là các trường nằm trong 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

Ghi chú:

• Các cấu hình interface được áp dụng trên toàn bộ ứng dụng.
• Các giá trị mặc định được cung cấp cho hầu hết các cài đặt nhưng có thể được ghi đè dựa trên các yêu cầu hoặc điều kiện cụ thể.
• Logic điều kiện trong ứng dụng có thể sửa đổi thêm các cài đặt này dựa trên các cấu hình khác như Model Specs.

Ví dụ

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

Đã lỗi thời đối với việc quản lý quyền. Các khóa con use, create, share và public dùng để khởi tạo quyền vai trò khi khởi động. Hãy ưu tiên sử dụng Admin Panel để quản lý quyền máy chủ MCP theo vai trò/nhóm/người dùng. Các khóa con placeholder và trustCheckbox không bị ảnh hưởng.

Khóa:

Các khóa phụ:

Các khóa con của trustCheckbox:

Ví dụ:

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

Khóa:

Các khóa phụ:

termsOfService

Khóa:

Các khóa phụ:

modelSelect

Khóa:

Mặc định: true

Ghi chú:

• Điều này bắt buộc phải là true nếu bạn đang sử dụng modelSpecs.addedEndpoints.
• Nếu modelSpecs.addedEndpoints được sử dụng và interface.modelSelect không được thiết lập một cách rõ ràng, nó sẽ mặc định là true.

Ví dụ:

interface:
  modelSelect: true

parameters

Khóa:

Mặc định: true

Ví dụ:

interface:
  parameters: false

contextUsage

Khóa:

Mặc định: true

Ví dụ:

interface:
  contextUsage: true

contextCost

Khóa:

Mặc định: false

Ghi chú:

• Đặt contextCost: true để chọn hiển thị các giá trị chi phí. Mức sử dụng token có thể vẫn hiển thị thông qua contextUsage trong khi các giá trị chi phí vẫn được ẩn đi.
• currency chỉ ảnh hưởng đến chi phí hiển thị khi tính năng hiển thị chi phí được bật.

Ví dụ:

interface:
  contextCost: true

currency

Khóa:

Các khóa phụ:

Ví dụ:

interface:
  currency:
    code: EUR
    rate: 0.92

presets

Khóa:

Mặc định: true

Ví dụ:

interface:
  presets: true

prompts

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò PROMPTS khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel để quản lý quyền nhắc lệnh (prompt) theo vai trò/nhóm/người dùng.

Khóa:

Mặc định: true

Quan trọng: Cấu hình Boolean so với Object

• Boolean (prompts: true): Chỉ cập nhật quyền use. Các giá trị quyền create, share và public hiện có được giữ nguyên từ cơ sở dữ liệu. Hãy sử dụng tùy chọn này như một tính năng bật/tắt đơn giản mà không ảnh hưởng đến các cài đặt khác đã được cấu hình thông qua bảng điều khiển quản trị.

• Object: Chỉ cập nhật các quyền phụ được chỉ định rõ ràng. Mọi quyền không có trong cấu hình sẽ được giữ nguyên từ cơ sở dữ liệu.

Khi sử dụng cấu trúc đối tượng:

Các khóa phụ:

Ví dụ (boolean - bật/tắt tính năng đơn giản):

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

Ví dụ (đối tượng - kiểm soát chi tiết):

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

Ví dụ (đối tượng - toàn quyền kiểm soát):

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

bookmarks

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò BOOKMARKS khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Mặc định: true

Ví dụ:

interface:
  bookmarks: true

memories

Đã lỗi thời đối với việc quản lý quyền. Gieo các quyền vai trò MEMORIES khi khởi động chỉ cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel. Lưu ý rằng nút chuyển đổi này tách biệt với cấu hình hành vi memory.

Khóa:

Mặc định: true

Lưu ý: Cài đặt này kiểm soát khả năng hiển thị trên giao diện người dùng của tính năng bộ nhớ. Để biết cấu hình chi tiết về hành vi của bộ nhớ (giới hạn token, cá nhân hóa, cài đặt tác nhân), hãy xem Memory Configuration.

Ví dụ:

interface:
  memories: true

multiConvo

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò MULTI_CONVO khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Mặc định: true

Ví dụ:

interface:
  multiConvo: true

agents

Thông tin thêm về Agents

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền cho vai trò AGENTS khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel để quản lý quyền của agent theo vai trò/nhóm/người dùng.

Khóa:

Mặc định: true

Quan trọng: Cấu hình Boolean so với Object

• Boolean (agents: true): Chỉ cập nhật quyền use. Các giá trị quyền create, share và public hiện có được giữ nguyên từ cơ sở dữ liệu. Hãy sử dụng tùy chọn này như một công tắc tính năng đơn giản mà không ảnh hưởng đến các cài đặt khác đã được cấu hình thông qua bảng quản trị.

• Object: Chỉ cập nhật các quyền phụ được chỉ định rõ ràng. Mọi quyền không có trong cấu hình sẽ được giữ nguyên từ cơ sở dữ liệu.

Khi sử dụng cấu trúc đối tượng:

Các khóa phụ:

Ví dụ (boolean - bật/tắt tính năng đơn giản):

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

Ví dụ (đối tượng - kiểm soát chi tiết):

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

Ví dụ (đối tượng - toàn quyền kiểm soát):

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

remoteAgents

Kiểm soát quyền truy cập vào Agents API (các endpoint tương thích với OpenAI và Open Responses API), cho phép các ứng dụng bên ngoài tương tác với các agent của LibreChat theo phương thức lập trình thông qua API keys.

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò REMOTE_AGENTS khi khởi động cho vai trò USER mặc định. Ưu tiên sử dụng Admin Panel.

Khóa:

Các khóa phụ:

Mặc định: Tất cả các trường mặc định là false (đã tắt).

Ví dụ:

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

Lưu ý: Người dùng quản trị viên (Admin) được bật tất cả các quyền tác nhân từ xa theo mặc định bất kể cấu hình này.

skills

Đã lỗi thời đối với việc quản lý quyền. Gieo các quyền vai trò SKILLS khi khởi động chỉ cho vai trò USER mặc định. Ưu tiên sử dụng Admin Panel để quản lý quyền Skills theo vai trò/nhóm/người dùng. defaultActiveOnShare không phải là một bit quyền và vẫn là một thiết lập hành vi trong YAML.

Khóa:

Mặc định: true cho use và create, false cho share, public, và defaultActiveOnShare.

Các khóa phụ:

Ví dụ:

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

Để biết về hành vi và chế độ gọi của Skills, hãy xem Skills.

sharedLinks

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền cho vai trò SHARED_LINKS khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel để quản lý quyền liên kết chia sẻ theo vai trò/nhóm/người dùng.

Khóa:

Mặc định: create: true, share: true, public: true

Quan trọng: Cấu hình Boolean so với Object

• Boolean (sharedLinks: true): Kích hoạt tất cả các quyền SHARED_LINKS cho vai trò USER mặc định.
• Boolean (sharedLinks: false): Vô hiệu hóa tất cả các quyền SHARED_LINKS cho vai trò USER mặc định.
• Object: Chỉ cập nhật các quyền phụ được chỉ định rõ ràng. Mọi quyền không có trong cấu hình sẽ được giữ nguyên từ cơ sở dữ liệu.

Các khóa phụ:

Ví dụ:

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

Để biết về hành vi của liên kết chia sẻ dành cho người dùng, hãy xem Shareable Links.

temporaryChat

Kiểm soát việc tính năng trò chuyện tạm thời có khả dụng cho người dùng hay không. Các cuộc trò chuyện tạm thời sẽ không được lưu vào lịch sử hội thoại và sẽ tự động bị xóa sau một khoảng thời gian lưu giữ có thể cấu hình được.

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò TEMPORARY_CHAT khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel. temporaryChatRetention bên dưới không phải là một quyền và vẫn là cách được khuyến nghị để cấu hình thời gian lưu trữ.

Khóa:

Mặc định: true

Lưu ý: Thời gian lưu giữ cho các cuộc trò chuyện tạm thời có thể được cấu hình bằng cách sử dụng temporaryChatRetention.

Ví dụ:

interface:
  temporaryChat: true

temporaryChatRetention

Cấu hình temporaryChatRetention cho phép bạn tùy chỉnh thời gian lưu giữ các cuộc trò chuyện tạm thời trước khi chúng bị tự động xóa.

Khóa:

Quy tắc xác thực:

• Tối thiểu: 1 giờ (ngăn chặn việc xóa ngay lập tức)
• Tối đa: 8760 giờ (thời gian lưu trữ tối đa 1 năm)
• Mặc định: 720 giờ (30 ngày)

Các phương thức cấu hình:

1. LibreChat.yaml (được khuyến nghị): interface.temporaryChatRetention: 168
2. Biến môi trường (đã lỗi thời): TEMP_CHAT_RETENTION_HOURS=168

Lưu ý: Biến môi trường TEMP_CHAT_RETENTION_HOURS đã bị loại bỏ. Vui lòng sử dụng tùy chọn cấu hình interface.temporaryChatRetention trong librechat.yaml thay thế. Giá trị trong tệp cấu hình sẽ được ưu tiên hơn biến môi trường.

Ví dụ:

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

Các khoảng thời gian lưu giữ phổ biến:

• 1 giờ: temporaryChatRetention: 1 (thời gian lưu trữ tối thiểu)
• 24 giờ: temporaryChatRetention: 24 (1 ngày)
• 168 giờ: temporaryChatRetention: 168 (1 tuần)
• 720 giờ: temporaryChatRetention: 720 (30 ngày - mặc định)
• 8760 giờ: temporaryChatRetention: 8760 (1 năm - tối đa)

retentionMode

Kiểm soát dữ liệu nào nhận được thời hạn lưu giữ.

Khóa:

Mặc định: temporary

Ví dụ:

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

Kiểm soát việc liệu các tệp tài nguyên tác nhân bền vững có được miễn trừ khỏi chính sách lưu giữ tất cả dữ liệu hay không.

Khóa:

Mặc định: false

Ghi chú:

• Cài đặt này chỉ thay đổi hành vi khi retentionMode được đặt thành "all".
• Đặt giá trị này thành true khi các agent cần giữ lại các tệp tài nguyên bền vững của chúng ngay cả khi các cuộc trò chuyện, tin nhắn và các tệp không phải của agent đã đến thời hạn lưu giữ.

Ví dụ:

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

autoSubmitFromUrl

Kiểm soát việc liệu một prompt được cung cấp thông qua các tham số truy vấn URL trên /c/new có được tự động gửi đến model hay không.

Khi /c/new?prompt=…&submit=true được mở bởi một người dùng đã xác thực, LibreChat thường sẽ tự động điền nội dung vào trình soạn thảo bằng prompt được cung cấp trong URL và gửi đi ngay lập tức. Đây là một tính năng tiện lợi dành cho các deeplink được tạo sẵn và các URL trò chuyện được chia sẻ.

Đối với các triển khai mà người dùng có thể nhận được các liên kết được tạo sẵn từ các nguồn bên ngoài — và nơi các mô hình có hỗ trợ bộ nhớ hoặc công cụ có thể làm rò rỉ ngữ cảnh nhạy cảm nếu payload tiêm câu lệnh (prompt-injection) tiếp cận được mô hình — người vận hành có thể vô hiệu hóa tính năng tự động gửi. Khi cờ này được đặt thành false, câu lệnh vẫn được điền sẵn trong trình soạn thảo nhưng người dùng phải nhấn Send một cách thủ công.

Khóa:

Mặc định: true (hành vi hiện tại được giữ nguyên trừ khi bị vô hiệu hóa một cách rõ ràng).

Ghi chú:

• Cài đặt này không ảnh hưởng đến việc chọn Model Specs dựa trên URL hoặc các cài đặt dựa trên URL khác — chỉ ảnh hưởng đến bước tự động gửi.
• Tham số truy vấn chấp nhận cả prompt và q làm nguồn prompt, trong đó prompt được ưu tiên hơn. submit=true là trình kích hoạt.
• Được khuyến nghị cho các instance xử lý dữ liệu bộ nhớ hoặc công cụ nhạy cảm, nơi mà một vector tấn công prompt-injection chỉ với 1 cú nhấp chuột cần phải có sự xác nhận rõ ràng từ người dùng.

Ví dụ:

interface:
  autoSubmitFromUrl: false

customWelcome

Khóa:

Mặc định: Không có (nếu không được chỉ định, lời chào mặc định sẽ được sử dụng)

Ví dụ:

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

Lưu ý: Bạn có thể sử dụng {{user.name}} trong tin nhắn customWelcome để chèn tên người dùng một cách linh hoạt nhằm tạo trải nghiệm chào mừng được cá nhân hóa.

runCode

Bật/tắt nút "Run Code" cho các Khối mã Markdown. Xem thêm thông tin tại LibreChat Code Interpreter API

Lưu ý: Cài đặt này không vô hiệu hóa Agents Code Interpreter Capability. Để vô hiệu hóa Agents Capability, hãy xem Agents Endpoint configuration thay vào đó.

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền RUN_CODE khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Mặc định: true

Ví dụ:

interface:
  runCode: true

webSearch

Bật/tắt nút tìm kiếm web trong giao diện trò chuyện. Xem thêm thông tin tại Cấu hình Tìm kiếm Web

Lưu ý: Cài đặt này không vô hiệu hóa Khả năng Tìm kiếm Web của Agents. Để vô hiệu hóa Khả năng của Agents, hãy xem cấu hình endpoint Agents thay vào đó.

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò WEB_SEARCH khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Mặc định: true

Ví dụ:

interface:
  webSearch: true

fileSearch

Bật/tắt nút tìm kiếm tệp (để sử dụng RAG API thông qua công cụ) trong giao diện trò chuyện

Lưu ý: Cài đặt này không vô hiệu hóa Agents File Search Capability. Để vô hiệu hóa Agents Capability, hãy xem Agents Endpoint configuration thay vào đó.

Đã lỗi thời đối với việc quản lý quyền. Chỉ gieo (seed) quyền vai trò FILE_SEARCH khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Mặc định: true

Ví dụ:

interface:
  fileSearch: true

fileCitations

Kiểm soát tính khả dụng toàn cục của chức năng trích dẫn tệp. Khi bị vô hiệu hóa, nó sẽ xóa quyền FILE_CITATIONS đối với tất cả người dùng, ngăn chặn việc hiển thị bất kỳ trích dẫn tệp nào khi sử dụng tính năng tìm kiếm tệp, bất kể quyền của từng người dùng.

Đã lỗi thời đối với việc quản lý quyền. Gieo/cổng quyền vai trò FILE_CITATIONS trên toàn cầu khi khởi động. Ưu tiên sử dụng Admin Panel để quản lý quyền trích dẫn theo vai trò/nhóm/người dùng.

Lưu ý:

• Cài đặt này đóng vai trò là công tắc bật/tắt toàn cục cho hệ thống quyền FILE_CITATIONS trên toàn bộ ứng dụng.
• Khi được đặt thành false, sẽ không có người dùng nào nhìn thấy trích dẫn tệp, ngay cả khi họ đã được cấp quyền thông qua các vai trò.
• Các trích dẫn tệp yêu cầu tính năng fileSearch phải được bật.
• Khi sử dụng các agent có khả năng tìm kiếm tệp, hành vi trích dẫn (số lượng và chất lượng) có thể được cấu hình thông qua cấu hình endpoint Agents.

Khóa:

Mặc định: true

Ví dụ:

interface:
  fileCitations: true

defaultPinnedTools

Gieo các công cụ được ghim trên thanh nhắc ban đầu cho những người dùng chưa tùy chỉnh trạng thái công cụ được ghim của họ. Khi người dùng ghim hoặc bỏ ghim một công cụ, LibreChat sẽ bảo lưu lựa chọn đó của người dùng.

Khóa:

Các giá trị được hỗ trợ:

• Các khóa công cụ tích hợp sẵn: artifacts, execute_code, web_search, file_search, skills
• mcp để ghim menu thả xuống của các máy chủ MCP
• Một tên máy chủ MCP cụ thể để ghim máy chủ đó làm mục đã ghim

Ví dụ:

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

Kiểm soát các loại đối tượng chính (người dùng, nhóm, vai trò) khả dụng để lựa chọn trong giao diện chọn người, thường được sử dụng khi chia sẻ các agent hoặc quản lý kiểm soát truy cập.

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò PEOPLE_PICKER khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Các khóa phụ:

Mặc định:

peoplePicker:
  users: true
  groups: true
  roles: true

Ví dụ:

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

marketplace

Bật/tắt quyền truy cập vào Agent Marketplace.

Đã lỗi thời đối với việc quản lý quyền. Chỉ khởi tạo quyền vai trò MARKETPLACE khi khởi động cho vai trò USER mặc định. Hãy ưu tiên sử dụng Admin Panel.

Khóa:

Các khóa phụ:

Mặc định:

marketplace:
  use: false

Ví dụ:

interface:
  marketplace:
    use: true # Enable marketplace access