api-doc-integration-risk-review 风险审阅助手

快速开始

更多技能

概述

风险审阅助手用于回答「这里有什么风险」、API文档、集成、开发者体验，适合technical、管理者、software、API文档在明确业务目标、内容材料或分析对象后调用。 它会结合接口文档内容、粘贴接口说明、鉴权方式、请求响应字段、错误码和调用限制。等输入，整理关键上下文，并输出摘要、诊断结论、行动建议和可复用交付物，便于继续执行、复盘或交付。

什么时候使用

适用场景

• 用户提出“这里有什么风险”这类问题，需要快速拆解目标、判断重点并形成可执行结果
• technical、管理者、software、API文档需要围绕风险审阅助手生成摘要、诊断结论、行动建议和可复用交付物
• 用户已经准备了上传接口资料（上传接口文档、字段表、联调记录、错误码表或变更说明。）、接口文档链接（填写公开可访问的 API 文档、SDK 文档或开发者指南链接。）、接口文档内容（粘贴接口说明、鉴权方式、请求响应字段、错误码和调用限制。），希望整理成可执行的分析或优化结果
• 用户需要把风险审阅助手相关材料转成清晰结论、优先级和下一步动作

调用方式

通过导出的 Python runner 直接调用 AI Skills API：

命令示例

基础调用

python3 scripts/run.py --params '{}'

带常用参数调用

python3 scripts/run.py --params '{"apiGuideFile":"上传接口资料"}'

参数说明

参数	类型	必填	默认	说明
apiGuideFile	string	否	-	上传接口文档、字段表、联调记录、错误码表或变更说明
apiGuideLink	string	否	-	填写公开可访问的 API 文档、SDK 文档或开发者指南链接；需要传可访问的完整 URL
apiGuideText	string	否	-	粘贴接口说明、鉴权方式、请求响应字段、错误码和调用限制
integrationRiskFocus	string	否	字段完整性	选择本次API 文档集成风险审查最需要优先处理的方向；可选值：字段完整性、错误处理、鉴权限流、联调风险
dependencyConstraintNotes	string	否	-	补充鉴权方式、限流、回调、幂等、兼容性和待确认字段
integrationScenarioContext	string	否	-	说明接入方、业务流程、调用频率、环境、依赖系统和上线时间

完整机器可读参数结构见 references/form-schema.json。

参数取值参考

当前技能没有需要额外查表的分类参数。

支持的输入格式

当前技能直接接收 JSON 参数；如果参数里包含链接字段，请传完整、可访问的 URL。

示例请求

下面的示例参数可直接传给 scripts/run.py，runner 会把它们发送给 AI Skills API。

python3 scripts/run.py --params '{"apiGuideFile":"上传接口资料"}'

等价的 --params JSON：

{
  "apiGuideFile": "上传接口资料"
}

返回结果示例

{
  "success": true,
  "data": {
    "message": "示例结果请以技能真实返回结构为准。"
  },
  "meta": {
    "executionTime": 842,
    "cached": false
  }
}

交付内容

• 摘要、诊断结论、行动建议和可复用交付物：围绕用户目标整理可直接阅读、复盘或交付的核心结果。
• 输入材料解读：结合上传接口资料（上传接口文档、字段表、联调记录、错误码表或变更说明。）、接口文档链接（填写公开可访问的 API 文档、SDK 文档或开发者指南链接。）、接口文档内容（粘贴接口说明、鉴权方式、请求响应字段、错误码和调用限制。）提炼关键上下文和判断依据。
• 下一步动作：给出优先级、执行建议或可继续加工的内容框架。

结果使用建议

• 先判断输出是否回答了用户关于「风险审阅助手」的核心问题。
• 再检查结果是否覆盖摘要、诊断结论、行动建议和可复用交付物，以及是否给出明确下一步动作。
• 如果输入材料较少，建议让用户补充目标、受众、限制条件或原始材料后再运行。

运行前准备

• AISKILLS_BASE_URL：默认 https://ai-skills.ai
• AISKILLS_API_KEY：必填，用于认证调用
• AISKILLS_TENANT_ID：默认 default