本文へ移動
cccskills
無料GitHub で公開

volcengine-documentation

火山引擎官方文档查询工具,支持文档检索和全文获取。涵盖火山引擎全部产品、开发者工具、服务支持、最佳实践,包括产品介绍、使用、计费、部署、故障排查、API、SDK、服务条款/协议等全流程。任何涉及火山引擎产品咨询、使用问题、文档查询的需求都优先调用本技能。

インストール方法を見る

含まれるファイル(2)

  • SKILL.md4.4 KB
  • scripts/volcengine_docs.py3.7 KB

SKILL.md(原文)

インストールする前に、エージェントに与えられる指示の中身を確認できます。

volcengine-documentation 火山引擎文档技能

功能描述

火山引擎文档综合查询技能,支持文档检索和内容获取两个核心功能,火山引擎文档是火山最权威的官方数据,涵盖全产品使用全链路。

决策逻辑(必看)

触发判断规则

  1. 用户提供文档链接:直接调用 fetch 接口获取完整内容,无需先检索。

search 和 fetch 配合规则

  1. 用户提问类需求:优先调用 search 接口(默认不携带ServiceCodes参数),返回5条结果,优先使用返回的Content内容回答。
  2. 二次检索优化:如果第一次搜索结果匹配度不高,可根据第一次返回结果中的ServiceCodes字段,携带对应产品编码参数执行二次检索,缩小范围获取更精准结果。
  3. 需要完整文档内容:先调用 search 找到对应文档链接,再调用 fetch 获取全文内容。

功能说明

1. 文档检索 (search)

根据用户问题检索相关火山引擎官方文档,支持按产品过滤。

  • 请求地址:https://docs-api.cn-beijing.volces.com/api/v1/doc/search

请求参数

参数名类型必填说明
Querystring是用户的具体问题描述
Limitnumber否检索返回的文档数量,默认返回5篇
ServiceCodesarray<string>否产品过滤条件,指定仅查询某几个产品的文档,可通过返回结果中的ServiceCodes字段获取产品编码

返回参数

核心有效数据在 Result.DocList 字段中,每个文档项包含:

字段名类型说明
Titlestring官方文档标题
Urlstring文档官方访问链接
Contentstring文档完整内容
ServiceCodesarray<string>文档所属产品编码列表

2. 内容获取 (fetch)

根据火山引擎官方文档链接,获取对应的完整文档内容,支持结构化解析文档标题、正文内容。

  • 请求地址:https://docs-api.cn-beijing.volces.com/api/v1/doc/fetch

请求参数

参数名类型必填说明
Urlstring是火山引擎官方文档链接,格式如 https://www.volcengine.com/docs/6349/162514

⚠️ 重要处理规则: 如果Url包含query参数(例如 https://www.volcengine.com/docs/6396/624853?lang=zh),需要在请求前去掉所有query参数,只保留 https://www.volcengine.com/docs/6396/624853 部分进行请求。

返回参数

核心有效数据在 Result 字段中:

字段名类型说明
Titlestring文档的完整标题
Contentstring文档的完整正文内容,结构化解析后的文本

结果处理规则

通用强制规则

  1. 所有回答末尾必须附上对应的官方文档链接作为参考来源,使用 [文档标题](纯净URL) 格式,每条结果都要标注来源地址
  2. 如果返回多个结果,按相关性排序展示,最多展示3条最相关的结果,每条结果都附带对应的文档链接
  3. 链接必须使用脚本返回的CleanUrl(已剥离所有query参数),禁止使用带?lang=zh等参数的URL

检索结果处理

  1. 优先使用返回的Content内容回答用户问题,信息更准确
  2. 接口直接返回文档完整内容,无需做额外摘要提炼

内容获取结果处理

  1. 接口直接返回文档完整内容,可直接使用无需额外处理

工具使用方法

检索文档

python {skill_dir}/scripts/volcengine_docs.py search "查询关键词" [返回数量] [产品编码1,产品编码2...]

示例:

python {skill_dir}/scripts/volcengine_docs.py search "tos是什么" 1 tos

获取文档完整内容

python {skill_dir}/scripts/volcengine_docs.py fetch "火山引擎文档链接"

示例:

python {skill_dir}/scripts/volcengine_docs.py fetch "https://www.volcengine.com/docs/6349/162514?lang=zh"

レビュー

まだレビューはありません。使ってみた感想をお寄せください。

同じリポジトリのスキル

概要と使いどころ

Deploy, update, validate, and troubleshoot the AgentKit hybrid-cloud customer-service demo in this directory. Use when a user asks an AI coding agent to follow the README, deploy or update the demo, configure OpenAPI/Runtime/Knowledge/Memory/Sandbox/MCP/Skills/A2A, run customer-view validation, or record manual platform steps and failures.

日本語の概要は準備中です。原文の説明を表示しています。

bytedance/agentkit-samples4702026年10月9日 更新

Generate deterministic SVG algorithmic artwork. Invoke when the user asks for geometric, generative, or algorithmic visual art.

日本語の概要は準備中です。原文の説明を表示しています。

bytedance/agentkit-samples4702026年10月9日 更新

通过本地 Python CLI 和 OpenAPI 客户端管理、排查火山云手机资源。适用于查询实例和资源、截图、执行命令、查看任务、检查应用、主机和机房容量、标签、DNS、路由,以及操作已授权的测试云手机实例。

日本語の概要は準備中です。原文の説明を表示しています。

bytedance/agentkit-samples4702026年10月9日 更新

Launch and continue the Volcengine AI Research survey workflow for concept testing, audience design, questionnaire drafting, interview guide generation, execution confirmation, progress checks, and result queries. Use this skill when the user wants to create, revise, confirm, execute, or follow up on a real AI research survey task in ABCompass instead of doing generic brainstorming, copywriting, translation, summarization, or broad market discussion.

日本語の概要は準備中です。原文の説明を表示しています。

bytedance/agentkit-samples4702026年10月9日 更新

Create and check long-running video material evaluation tasks. Use this skill when the user wants to submit videos for evaluation, check an existing video evaluation task list, or fetch the result of a previously created video evaluation task. This skill is not a general-purpose video upload skill because upload is allowed only as an internal step of task creation. Authentication uses an API key passed as an Authorization bearer token.

日本語の概要は準備中です。原文の説明を表示しています。

bytedance/agentkit-samples4702026年10月9日 更新

火山引擎 AntiDDoSPro 高防域名只读巡检。用户要查域名健康、攻击、流量、CC/WAF/区域封禁、智能防护或 CCAI 状态时使用。

日本語の概要は準備中です。原文の説明を表示しています。

bytedance/agentkit-samples4702026年10月9日 更新

bytedance のスキルをすべて見る

このスキルの問題を報告する