跳到主要内容

帮助中心

该分类包含 3 条以 system.help. 开头的 Runtime 系统命令。

1. 列出帮助​

完整命令：system.help.list

列出已发布的 Soln 帮助中心主题，含 docId、标题、分类、链接与章节标题；回答“如何使用”的问题前可先浏览产品手册。 · 风险：读取

sl system help list \
  [--keyword value] [--locale en|zh-CN] [--limit n] [--json]

参数：

  • keyword（可选）— Optional filter over help topic titles, paths, and section titles
  • locale（可选）— Help content locale: en or zh-CN. Defaults to the conversation locale, then en
  • limit（可选）— Number of topics, 1-200; defaults to 50

2. 搜索帮助​

完整命令：system.help.search

在已发布的 Soln 帮助中心内容中检索“如何使用 Soln”的操作步骤，返回匹配主题、有限的正文片段以及可引用的页面链接。 · 风险：读取

sl system help search \
  --query value [--locale en|zh-CN] [--limit n] [--json]

参数：

  • query（必填）— Natural-language description of the system task the user wants to perform, in the user language
  • locale（可选）— Help content locale: en or zh-CN. Defaults to the conversation locale, then en
  • limit（可选）— Number of matching topics, 1-20; defaults to 5

3. 读取帮助​

完整命令：system.help.read

按 docId 读取一篇已发布的帮助中心主题，支持按字符分页；docId 取自 system.help.search 或 system.help.list 的返回结果。 · 风险：读取

sl system help read \
  --doc-id value [--locale en|zh-CN] [--start-character n] \
  [--max-chars n] [--json]

参数：

  • docId（必填）— Topic docId returned by system.help.search or system.help.list, for example using-soln/forms/using-forms
  • locale（可选）— Help content locale: en or zh-CN. Defaults to the conversation locale, then en. English is used when the topic has no translation
  • startCharacter（可选）— Character offset for continued reading; use position.next from the previous response
  • maxChars（可选）— Maximum characters returned in one call, 500-40000; defaults to 8000