火山引擎官方文档
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @org-eyw2ohcx/jinsun-fiver-volc-docs-103。
技能介绍
要解决什么问题
在火山引擎上做接入、排障或选型时,产品面很广,文档分散在 volcengine.com/docs 各个产品线下。单靠浏览器翻目录或站内搜索,很难在一次对话里把「和问题最相关的官方表述」拉齐,更别说用户已经丢过来一条带 ?lang=zh 的文档链接、你只需要全文而不是摘要的情况。
这个技能把火山引擎文档检索和内容获取拆成两条明确路径,并约定 Agent 何时先 search、何时直接 fetch、何时用 ServiceCodes 做二次收窄。
核心能力怎么工作
- 文档检索(search):向
https://docs-api.cn-beijing.volces.com/api/v1/doc/search提交用户问题(Query),默认返回 5 条;结果在Result.DocList里,每项含 Title、Url、Content(可直接用于回答)、ServiceCodes(产品编码)。首次检索通常不带ServiceCodes;若匹配度不够,可用首轮结果里的产品编码再搜一次。 - 内容获取(fetch):用户给出官方文档链接时,调用
https://docs-api.cn-beijing.volces.com/api/v1/doc/fetch,请求前必须去掉 URL 上全部 query(例如只保留https://www.volcengine.com/docs/6396/624853),在Result中取完整 Title 与 Content。 - 问答类流程:先 search,优先用返回的
Content作答;需要整篇文档时,先 search 定位链接,再 fetch 拉全文。
边界与注意点
- 数据范围限于火山引擎官方文档 API 能检索/解析的页面,不能替代控制台里的实时配额、工单或非标迁移说明。
- 对外展示链接须用接口返回的干净 URL(无 query),回答末尾需附官方文档来源;多结果时按相关性展示,最多 3 条。
ServiceCodes过滤依赖 search 返回里的编码,产品名和用户口语不一致时要靠二次检索缩小范围,而不是臆测产品。
使用场景
- 线上报错要对照官方 API 参数说明,用自然语言问题检索对应产品线文档段落
- 用户粘贴带 lang 参数的 docs 链接,需要拉取该页完整正文用于对照配置
- 跨多个火山产品选型,首轮检索结果太杂,用 ServiceCodes 二次搜索缩小到目标产品
- 回答集成问题前先 search 定位文档,再 fetch 获取整篇安装或权限说明
适合人员
- 负责火山引擎 SDK/API 接入、需要以官方文档为准编写示例与错误处理的开发
- 为客户做云上迁移或排障、需在对话中引用权威文档链接与原文的解决方案架构师
- 编写火山产品 FAQ 或内部 Runbook、要把分散在各产品下的官方说明对齐的运营与技术支持
- 在 Agent 里挂载企业知识工具、希望问答自动附带可点击官方来源的研发工程师