接口对象结构

概述

interface 对象允许对应用程序内的各种用户界面元素进行自定义，包括菜单、面板和链接等组件的可见性和行为设置。本节详细介绍了 interface 对象的结构。

这些是 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

注意：

• interface 配置在应用程序中全局应用。
• 大多数设置都提供了默认值，但可以根据特定需求或条件进行覆盖。
• 应用程序中的条件逻辑可以根据 Model Specs 等其他配置进一步修改这些设置。

示例

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

已弃用，建议使用权限管理功能。 use、create、share 和 public 子键用于在启动时植入角色权限。建议优先使用 Admin Panel 来管理每个角色/组/用户的 MCP 服务器权限。placeholder 和 trustCheckbox 子键不受影响。

密钥：

子键：

trustCheckbox 子键：

示例：

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

密钥：

子键：

termsOfService

密钥：

子键：

modelSelect

密钥：

默认值： true

注意：

• 如果使用 modelSpecs.addedEndpoints，则此项必须设置为 true。
• 如果使用了 modelSpecs.addedEndpoints 且未明确设置 interface.modelSelect，则默认值为 true。

示例：

interface:
  modelSelect: true

parameters

密钥：

默认值： true

示例：

interface:
  parameters: false

contextUsage

密钥：

默认值： true

示例：

interface:
  contextUsage: true

contextCost

密钥：

默认值： false

注意：

• 设置 contextCost: true 以启用可见的成本数值。Token 使用量可以通过 contextUsage 保持可见，同时隐藏成本数值。
• currency 仅在启用成本显示时影响显示的费用。

示例：

interface:
  contextCost: true

currency

密钥：

子键：

示例：

interface:
  currency:
    code: EUR
    rate: 0.92

presets

密钥：

默认值： true

示例：

interface:
  presets: true

prompts

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 PROMPTS 角色权限。建议优先使用 Admin Panel 来管理各角色/组/用户的提示词权限。

密钥：

默认值： true

重要：布尔值与对象配置的区别

• 布尔值 (prompts: true)：仅更新 use 权限。现有的 create、share 和 public 权限值将从数据库中保留。将其用作简单的功能开关，而不会影响通过管理面板配置的其他设置。

• Object: 仅更新明确指定的子权限。配置中未包含的任何权限都将从数据库中保留。

当使用对象结构时：

子键：

示例（布尔值 - 简单功能开关）：

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

示例（对象 - 细粒度控制）：

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

示例（对象 - 完全控制）：

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

bookmarks

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 BOOKMARKS 角色权限。建议优先使用 Admin Panel。

密钥：

默认值： true

示例：

interface:
  bookmarks: true

memories

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 MEMORIES 角色权限。建议优先使用 Admin Panel。请注意，此开关与 memory 行为配置是分开的。

密钥：

默认值： true

注意： 此设置控制界面中记忆功能的可见性。有关记忆行为的详细配置（令牌限制、个性化、智能体设置），请参阅 Memory Configuration。

示例：

interface:
  memories: true

multiConvo

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 MULTI_CONVO 角色权限。建议优先使用 Admin Panel。

密钥：

默认值： true

示例：

interface:
  multiConvo: true

agents

更多关于 Agents 的信息

已弃用，建议使用权限管理功能。 仅在启动时为默认的 USER 角色植入 AGENTS 角色权限。建议优先使用 Admin Panel 来管理针对不同角色/组/用户的智能体权限。

密钥：

默认值： true

重要：布尔值与对象配置的区别

• Boolean (agents: true): 仅更新 use 权限。现有的 create、share 和 public 权限值将从数据库中保留。将其用作简单的功能开关，而不会影响通过管理面板配置的其他设置。

• Object: 仅更新明确指定的子权限。配置中未包含的任何权限都将从数据库中保留。

当使用对象结构时：

子键：

示例（布尔值 - 简单功能开关）：

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

示例（对象 - 细粒度控制）：

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

示例（对象 - 完全控制）：

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

remoteAgents

控制对 Agents API（兼容 OpenAI 和 Open Responses API 端点）的访问，该 API 允许外部应用程序通过 API 密钥以编程方式与 LibreChat 智能体进行交互。

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 REMOTE_AGENTS 角色权限。建议优先使用 Admin Panel。

密钥：

子键：

默认值： 所有字段默认为 false（禁用）。

示例：

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

注意： 无论此配置如何，管理员用户默认拥有所有远程代理权限。

skills

已弃用，建议使用权限管理。 仅在启动时为默认 USER 角色植入 SKILLS 角色权限。建议优先使用 Admin Panel 来管理各角色/组/用户的 Skills 权限。defaultActiveOnShare 并非权限位，仍作为 YAML 行为设置保留。

密钥：

默认值： use 和 create 为 true，share、public 和 defaultActiveOnShare 为 false。

子键：

示例：

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

有关 Skills 行为和调用模式，请参阅 Skills。

sharedLinks

已弃用，建议使用权限管理功能。 仅在启动时为默认 USER 角色植入 SHARED_LINKS 角色权限。建议优先使用 Admin Panel 来管理各角色/组/用户的共享链接权限。

密钥：

默认值： create: true, share: true, public: true

重要：布尔值与对象配置的区别

• Boolean (sharedLinks: true): 为默认的 USER 角色启用所有 SHARED_LINKS 权限。
• Boolean (sharedLinks: false): 禁用默认 USER 角色的所有 SHARED_LINKS 权限。
• Object: 仅更新明确指定的子权限。配置中未包含的任何权限都将从数据库中保留。

子键：

示例：

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

关于面向用户的共享链接行为，请参阅 Shareable Links。

temporaryChat

控制临时聊天功能是否对用户可用。临时聊天不会保存到对话历史记录中，并会在可配置的保留期后自动删除。

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 TEMPORARY_CHAT 角色权限。建议优先使用 Admin Panel。下方的 temporaryChatRetention 并非权限设置，仍是配置保留策略的推荐方式。

密钥：

默认值： true

注意： 临时对话的保留期限可以通过 temporaryChatRetention 进行配置。

示例：

interface:
  temporaryChat: true

temporaryChatRetention

temporaryChatRetention 配置允许您自定义临时聊天记录在被自动删除前保留的时长。

密钥：

验证规则：

• 最小值：1 小时（防止立即删除）
• 最大值：8760 小时（最长保留 1 年）
• 默认值：720 小时（30 天）

配置方法：

1. LibreChat.yaml（推荐）：interface.temporaryChatRetention: 168
2. 环境变量 (已弃用): TEMP_CHAT_RETENTION_HOURS=168

注意： 环境变量 TEMP_CHAT_RETENTION_HOURS 已弃用。请改用 librechat.yaml 中的 interface.temporaryChatRetention 配置选项。配置文件中的值优先级高于环境变量。

示例：

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

常见保留期限：

• 1 小时: temporaryChatRetention: 1 (最小保留时间)
• 24 小时: temporaryChatRetention: 24 (1 天)
• 168 小时: temporaryChatRetention: 168 (1 周)
• 720 小时: temporaryChatRetention: 720 (30 天 - 默认值)
• 8760 小时: temporaryChatRetention: 8760 (1 年 - 最大值)

retentionMode

控制哪些数据接收保留期限。

密钥：

默认值： temporary

示例：

interface:
  temporaryChatRetention: 168
  retentionMode: 'all'

retainAgentFiles

控制持久化智能体资源文件是否免于全量数据保留。

密钥：

默认值： false

注意：

• 此设置仅在 retentionMode 设置为 "all" 时才会改变行为。
• 当代理应在对话、消息和非代理文件受到保留期限限制时仍保留其持久化资源文件时，请将此项设置为 true。

示例：

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

autoSubmitFromUrl

控制通过 /c/new 的 URL 查询参数提供的提示词是否自动提交给模型。

当已通过身份验证的用户打开 /c/new?prompt=…&submit=true 时，LibreChat 通常会使用 URL 中提供的提示词预填充输入框并立即提交。这是为精心设计的深度链接和共享聊天 URL 提供的一项便捷功能。

对于用户可能从外部来源接收到精心构造的链接，且启用记忆或工具的模型在提示词注入负载到达模型时可能泄露敏感上下文的部署场景，管理员可以禁用自动提交。将此标志设置为 false 后，提示词仍会预填在输入框中，但用户必须显式点击 发送 按钮。

密钥：

默认值： true（除非明确禁用，否则保留现有行为）。

注意：

• 此设置不会影响基于 URL 的 Model Specs 选择或其他基于 URL 的设置，仅影响自动提交步骤。
• 查询参数同时接受 prompt 和 q 作为提示词来源，其中 prompt 具有优先权。submit=true 为触发条件。
• 推荐用于处理敏感记忆或工具数据的实例，在这种情况下，一键式提示词注入向量应需要用户明确确认。

示例：

interface:
  autoSubmitFromUrl: false

customWelcome

密钥：

默认值： 无（如果未指定，则使用默认问候语）

示例：

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

注意： 您可以在 customWelcome 消息中使用 {{user.name}} 来动态插入用户的姓名，从而实现个性化的问候体验。

runCode

启用/禁用 Markdown 代码块的“运行代码”按钮。更多信息请参阅 LibreChat Code Interpreter API

注意： 此设置不会禁用 Agents Code Interpreter Capability。若要禁用 Agents 功能，请参阅 Agents Endpoint configuration。

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 RUN_CODE 角色权限。建议优先使用 Admin Panel。

密钥：

默认值： true

示例：

interface:
  runCode: true

webSearch

在聊天界面中启用/禁用网页搜索按钮。更多信息请参阅 网页搜索配置

注意： 此设置不会禁用 Agents Web Search Capability。若要禁用 Agents 功能，请参阅 Agents Endpoint configuration。

已弃用，建议使用权限管理。 仅在启动时为默认 USER 角色植入 WEB_SEARCH 角色权限。建议优先使用 Admin Panel。

密钥：

默认值： true

示例：

interface:
  webSearch: true

fileSearch

在聊天界面中启用/禁用文件搜索（用于通过工具使用 RAG API）按钮

注意： 此设置不会禁用 Agents File Search Capability。若要禁用 Agents 功能，请参阅 Agents Endpoint configuration。

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 FILE_SEARCH 角色权限。建议优先使用 Admin Panel。

密钥：

默认值： true

示例：

interface:
  fileSearch: true

fileCitations

控制文件引用功能的全局可用性。禁用时，它实际上会移除所有用户的 FILE_CITATIONS 权限，从而防止在使用文件搜索时显示任何文件引用，无论个人用户权限如何。

已弃用，建议使用权限管理。 在启动时为 FILE_CITATIONS 角色权限设置种子/全局门控。建议优先使用 Admin Panel 来管理针对角色/组/用户的引用权限。

注意：

• 此设置充当系统范围内 FILE_CITATIONS 权限的全局开关。
• 当设置为 false 时，即使已通过角色授予权限，所有用户也都将无法看到文件引用。
• 文件引用功能需要启用 fileSearch 特性。
• 当使用具有文件搜索功能的 Agent 时，可以通过 Agents endpoint configuration 来配置引用行为（数量和质量）。

密钥：

默认值： true

示例：

interface:
  fileCitations: true

defaultPinnedTools

为尚未自定义固定工具状态的用户设定初始提示词栏固定工具。一旦用户固定或取消固定某个工具，LibreChat 将会保留该用户的选择。

密钥：

支持的值：

• 内置工具密钥：artifacts、execute_code、web_search、file_search、skills
• mcp 以固定 MCP 服务器下拉菜单
• 一个特定的 MCP 服务器名称，用于将该服务器固定为已置顶状态

示例：

interface:
  defaultPinnedTools:
    - artifacts
    - execute_code
    - mcp

peoplePicker

控制在人员选择器界面中可供选择的主体类型（用户、组、角色），通常用于共享 Agent 或管理访问控制时。

已弃用，建议使用权限管理。 仅在启动时为默认 USER 角色植入 PEOPLE_PICKER 角色权限。建议优先使用 Admin Panel。

密钥：

子键：

默认：

peoplePicker:
  users: true
  groups: true
  roles: true

示例：

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

marketplace

启用/禁用对 Agent Marketplace 的访问。

已弃用，建议使用权限管理。 仅在启动时为默认的 USER 角色植入 MARKETPLACE 角色权限。建议优先使用 Admin Panel。

密钥：

子键：

默认：

marketplace:
  use: false

示例：

interface:
  marketplace:
    use: true # Enable marketplace access