volcengine-documentation

volcengine-documentation Volcano Engine documentation skill

Function Description

Volcano Engine documentation comprehensive query skill, supportingdocument retrievalandcontent acquisitiontwo core functions. Volcano Engine documentation is Volcano's most authoritative official data, covering the full usage chain of all products.

Decision Logic (Must Read)

Trigger Judgment Rules

1. User provides a documentation link: directly call the fetch interface to obtain the complete content, without needing to search first.

Rules for using search and fetch together

1. User question-type needs: prioritize calling the search interface (by default without the ServiceCodes parameter), which returns 5 results; prioritize using the returned Content to answer.
2. Secondary retrieval optimization: if the first search result does not match well, based on the ServiceCodes field in the first returned result, carry the corresponding product code parameter to perform a secondary retrieval, narrowing the scope to obtain more precise results.
3. Need complete documentation content: first call search to find the corresponding documentation link, then call fetch to obtain the full text content.

Function Description

1. Document Retrieval (search)

Retrieve relevant Volcano Engine official documentation based on user questions, supporting filtering by product.

• Request URL:https://docs-api.cn-beijing.volces.com/api/v1/doc/search

Request Parameters

Parameter Name	Type	Required	Description
Query	string	Yes	The user's specific question description
Limit	number	No	The number of documents returned by retrieval, defaulting to 5
ServiceCodes	array	No	Product filter condition, specifying that only documents of certain products are queried; the product code can be obtained through the ServiceCodes field in the returned results

Return Parameters

The core valid data is in the Result.DocList field, and each document item includes:

Field Name	Type	Description
Title	string	Official documentation title
Url	string	Official documentation access link
Content	string	Complete documentation content
ServiceCodes	array	List of product codes to which the document belongs

---

2. Content Acquisition (fetch)

Based on a Volcano Engine official documentation link, obtain the corresponding complete documentation content, supporting structured parsing of the document title and body content.

• Request URL:https://docs-api.cn-beijing.volces.com/api/v1/doc/fetch

Request Parameters

Parameter Name	Type	Required	Description
Url	string	Yes	Volcano Engine official documentation link, in a format such as https://www.volcengine.com/docs/6349/162514

⚠️ Important Handling Rule: If the Url contains query parameters (for example https://www.volcengine.com/docs/6396/624853?lang=zh), all query parameters need to be removed before the request, keeping only the https://www.volcengine.com/docs/6396/624853 part for the request.

Return Parameters

The core valid data is in the Result In the field:

Field name	Type	Description
Title	string	The full title of the document
Content	string	The full body content of the document, as text after structured parsing

Result handling rules

General mandatory rules

1. At the end of every answermustattach the corresponding official documentation link as the reference source, using the [文档标题](纯净URL) format, and every result must be annotated with the source address
2. If multiple results are returned, display them sorted by relevance, showing at most the 3 most relevant results, with each result accompanied by the corresponding documentation link
3. Links must use those returned by the scriptCleanUrl(with all query parameters stripped); URLs with?lang=zhand similar parameters are prohibited

Retrieval result handling

1. Prefer using the returned Content to answer the user's question, as the information is more accurate
2. The interface directly returns the complete document content, with no need for additional summarization or extraction

Content retrieval result handling

1. The interface directly returns the complete document content, which can be used directly without additional processing

Tool usage instructions

Retrieve documents

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

Example:

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

Retrieve the complete document content

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

Example:

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