查询参数
了解如何在 LibreChat 中使用 URL 查询参数配置聊天对话。动态设置模型、endpoint 和对话设置。
LibreChat 可以直接通过 URL 配置聊天对话。在聊天路径后附加查询参数,即可在聊天加载前选择 endpoint 和模型、预填输入内容或覆盖对话设置。
聊天路径
查询参数必须遵循有效的聊天路径:
- 新对话:
/c/new? - 现有对话:
/c/[conversation-id]?(其中conversation-id为现有对话的 ID)
基本用法
endpoint 和 model 参数涵盖了大多数情况。请同时设置这两个参数以获得可预测的结果:
Endpoint 选择
单独使用 endpoint 以在不指定模型的情况下切换 endpoint:
当仅设置 endpoint 时,LibreChat 会回退到该 endpoint 上次选择的模型(来自 localStorage)。如果没有之前的选择,它将使用该 endpoint 列表中的第一个模型。
endpoint 的值必须是以下之一:
对于 custom endpoint,请使用其配置的名称作为值(不区分大小写):
模型选择
单独使用 model 来在当前 endpoint 内切换模型:
当仅设置 model 时,LibreChat 仅在模型存在于当前 endpoint 时才会应用它。当前 endpoint 为默认 endpoint 或最后选定的 endpoint。
Prompt
prompt 参数会预填充聊天输入框:
q 是 prompt 的可互换简写:
将其与其他参数结合使用:
自动提交
添加 submit=true 以自动发送提示词,无需手动确认:
这对于自动化工作流(Raycast、Alfred、Automator)和外部集成非常有用。将其与其他参数结合使用,即可实现完全脚本化的启动:
URL 编码
查询值中的特殊字符必须进行 URL 编码。常见的替换如下:
| 字符 | 编码 |
|---|---|
: | %3A |
/ | %2F |
? | %3F |
# | %23 |
& | %26 |
= | %3D |
+ | %2B |
| 空格 | %20 (或 +) |
例如:
JavaScript 内置的 encodeURIComponent() 会为您处理编码:
在浏览器控制台(Ctrl+Shift+I)中运行此代码以查看编码后的 URL。
Model Specs, Agents, and Assistants
Model specs
通过名称选择 model spec:
这会加载 spec 中定义的每一项设置。当存在 spec 时,URL 中的其他模型参数将被忽略。
Agents
通过 ID 加载 Agent 而无需指定 endpoint:
这会自动将 endpoint 设置为 agents。
Assistants
通过 ID 加载 assistant 的方式相同:
这会自动将 endpoint 设置为 assistants。
支持的参数
LibreChat 设置
| 参数 | 描述 |
|---|---|
maxContextTokens | 覆盖系统定义的上下文窗口。 |
resendFiles | 控制后续消息中的文件重新提交。 |
promptPrefix | 设置自定义指令 / 系统消息。 |
imageDetail | 图像质量:low、auto 或 high。仅适用于 OpenAI、类 OpenAI 自定义 endpoint 以及 Azure OpenAI(默认为 auto)。 |
spec | 通过精确名称选择一个 Model Specs。设置此项后,其他模型参数将被忽略,优先使用该 spec。如果 spec 配置了 enforce: true,则 URL 查询参数要生效可能需要此参数。 |
fileTokenLimit | 文件处理的最大 token 限制,用于控制成本和资源使用。该请求值会覆盖 YAML 中的默认值。 |
模型参数
支持的模型参数因 endpoint 而异。数值必须符合提供商 API 的要求。
OpenAI, Custom, Azure OpenAI:
Google, Anthropic:
Anthropic, Bedrock (Anthropic models):
将 promptCache 设置为 true 或 false 以切换 prompt caching:
请参阅 Anthropic prompt caching docs 和 Bedrock prompt caching docs 以获取详细信息。
Bedrock:
Assistants / Azure Assistants:
这些参数中的大多数与 Model Spec Preset Fields 共享;请参阅该处以获取完整参考。
示例
单个 URL 中的多个参数:
加载带有 prompt 的 Model Specs:
当使用 spec 时,其他模型参数将被忽略,以优先使用 spec 的配置。
验证
在应用所有参数之前,LibreChat 会根据其 schema 对它们进行验证。无效的参数和值将被忽略;有效的设置将应用于对话。
请谨慎使用查询参数
- 滥用或超出提供商限制可能会导致 API 错误。
- 如果遇到错误请求(bad request error),请点击 New Chat 重置对话。
- 如果所选的 endpoint 不支持某个参数,则该参数无效。
最佳实践
- 尽可能同时设置
endpoint和model。 - 确认 endpoint 支持您传递的每个参数。
- 请将数值保持在提供商的限制范围内。
- 在共享 URL 之前,请先测试参数组合。
查询参数可以轻松共享特定的对话配置、收藏不同的聊天设置,并从外部工具自动化启动聊天。
这篇指南怎么样?