01 / API Guide
最小接入从服务端开始
API Key 只保存在服务端环境变量或密钥管理服务中。浏览器前端不得直接携带长期凭据。首次接入先完成一个短请求,再逐步加入流式输出、重试、预算和日志。
请求前检查
- 凭据是否隔离
- 模型与超时是否明确
- 输入是否完成脱敏
- 失败是否可安全重试
server-side example
client = Client(
api_key=ENV["API_KEY"],
timeout=30
)
result = client.chat(
model="reasoning-model",
messages=messages
)
02 / Error Ledger
错误码不是重试按钮
先判断错误是否可恢复,再决定重试。认证失败和参数错误应立即停止;限流与临时服务错误可采用带抖动的指数退避。
| 状态 | 含义 | 处理方式 |
400 | 请求参数无效 | 校验字段、模型名与内容格式,不自动重试。 |
401 | 鉴权失败 | 检查凭据来源与权限,停止当前请求。 |
429 | 速率或额度受限 | 读取服务提示,指数退避并加入随机抖动。 |
5xx | 临时服务异常 | 有限次数重试,超过阈值后降级并告警。 |
04 / Long Context
128K 不是一次塞满的理由
长上下文能容纳更多材料,但检索、证据定位和任务拆分仍然必要。推荐先建立文档地图,再逐段抽取事实,最后生成跨文档结论。