跳转至

AI 工具中文教程模板

最后核验:YYYY-MM-DD

适用范围:产品名称与已核验版本;需要的 API 协议

← 返回教程总目录

1. 这篇教程适合谁

说明工具定位、读者需要完成的目标,以及本文不覆盖的能力边界。

2. 准备工作

列出操作系统、工具版本、Base URL、API Key、模型 ID 和协议要求。密钥统一使用 sk-your-key 等明显占位符。

3. 安装与版本确认

给出官方安装途径和版本检查命令,并说明 Windows、macOS、Linux 的差异。

4. 配置步骤

按界面点击顺序或配置文件层级逐步说明。每个字段解释“填什么”和“为什么”。

5. 最小验证

提供一个成本低、结果明确的测试。写清成功时应看到什么,以及如何确认请求实际使用了目标模型。

6. 常见错误

至少覆盖认证失败、地址错误、模型不存在、限流和协议不兼容;工具有特殊错误时补充日志位置。

7. 安全提醒

  • 不要把完整 API Key 提交到 Git、Issue、聊天截图或录屏。
  • 使用环境变量或系统密钥存储保存凭据。
  • 怀疑泄露时立即撤销旧 Key,并创建权限更小的新 Key。

8. 参考资料与核验记录

只列出实际用于核验的官方文档、官方仓库或官方发布说明,并记录最后核验日期。