用途
volcengine-knowledge-search 用于检索火山引擎官方文档并获取全文,适合回答关于火山引擎产品概念、用法、计费规则、部署步骤、最佳实践和服务条款的问题,也适合阅读用户提供的 www.volcengine.com/docs/ 或 docs.volcengine.com/docs/ 链接正文。
主要能力
ve docs search:按自然语言问题检索官方文档,返回标题、纯净 URL、ServiceCodes 和正文摘要,支持限制返回条数、限定产品编码、控制摘要长度。ve docs fetch:获取指定文档链接的正文,支持按字符分页续读,适用于需要完整步骤、精确规则或全文总结的场景。- 由 CLI 负责请求、响应解析、正文清洗和分页,技能层负责场景判断、query 改写、二次检索和来源引用。
使用方式
调用前需在进程环境中携带 VE_CALLER_TYPE=ai_agent、VE_CALLER_NAME(由 Agent 按实际宿主环境确定)和 VE_SKILL_NAME(取当前执行操作的 skill 的 frontmatter name)。每次工具调用可能启动新的 shell,必须重新传入三项变量。
首次使用先确认 ve docs search --help 与 ve docs fetch --help 可用;若 ve 未安装或缺少子命令,加载 volcengine-cli skill,按其「Install or upgrade the ve CLI」章节安装最新版。文档命令访问公开服务,无需登录、AK/SK、profile 或地域配置。
流程选择:
- 用户提供具体文章链接:直接 fetch。
- 用户提出问题:补全产品名和具体方向后 search,首次检索不带产品过滤。
- 结果过宽或不相关:改写 query;只有确认相关结果的 ServiceCodes 后,才用该编码二次检索。
- 需要完整步骤、限制条件、精确计费规则或全文总结:对相关结果 URL 执行 fetch,按需续读。
示例:
VE_CALLER_TYPE=ai_agent VE_CALLER_NAME="<agent-id>" VE_SKILL_NAME="<current-volcengine-skill>" \
ve docs search "对象存储 TOS 如何计费" --limit 3 --output text
search 参数:--limit N 返回文档数;--service-code CODE 限定产品,可重复传;--snippet-length N 控制摘要字符数。默认输出 JSON,--output text 输出可读 Markdown,JSON 结果在 documents 数组中,字段为 title、url、service_codes、snippet。
fetch 参数:--start-index N 从第 N 个 Unicode 字符开始(从 0 起);--max-length N 当前页最多返回字符数,默认 5000。长文末尾会提示下一页的 --start-index,用同一 URL 和返回索引继续读。JSON 输出可读取 content、start_index、next_start_index、remaining_characters、has_more、has_content;has_more=true 时用 next_start_index 续读,结束时该字段为 null。
适用场景
- 查询火山引擎产品的计费方式、配置步骤、限制条件与最佳实践。
- 阅读用户提供的具体文档链接正文。
- 对检索结果做二次精搜或全文续读后给出带来源的回答。
限制与注意事项
/docs/{产品编号}是产品文档导航页,没有单篇文章正文;识别到此类链接时应按产品名和用户关心的方向 search,定位具体文章再 fetch,并向用户说明链接类型。has_content=false表示没有取得正文,不能据此编造内容;需检查链接是否为导航页、过期或错误地址,再用 search 定位替代文档。- 正常空结果(退出码 0 且 documents 为空)应改写 query 或放宽产品过滤,不代表服务故障。
- 参数错误按
--help修正,数量和长度须为正数,起始索引非负。 - 请求失败时读取 stderr 区分网络问题与上游业务错误;超时或 DownstreamError 等暂时性故障可重试一两次,持续失败应说明原因,不能把失败当成无结果。公开文档请求失败无需补充云账号凭据。
- 回答应基于已读取内容,部分页面不能表述为已读完整篇;引用使用 CLI 返回的纯净 URL,格式为
[文档标题](URL),优先展示最多 3 条最相关来源。
暂未提供
该资料的收费方式、价格、平台覆盖范围与效果数据暂未提供。