Documentation

接入文档

接口怎么调、密钥怎么发、用量怎么算、迁移怎么回退。技术评估需要的东西都在这一页。

四条对接入方的承诺

接入一个中间层,最大的顾虑是"进得来出不去"。这四条是我们对此的自我约束,写在文档里而不是口头说说。

改配置,不改代码

接口兼容主流规范,存量业务只替换服务地址与密钥,SDK 与调用代码保持不变。

策略在服务端

路由、缓存、限流、模型白名单都在服务端配置,调整策略不需要业务发版。

用量可自证

计费口径公开,明细精确到单次调用并可导出,你可以自己对账而不是只能信我们。

随时可以走

迁入迁出都是改配置,不做数据或格式锁定;需要时提供回退方案与灰度开关。

01 · Endpoint & Auth

接口与鉴权

服务地址与密钥在开通后提供。接口兼容主流规范,支持流式透传,请求与响应结构与你现在用的保持一致——这是"改两行配置即接入"的前提。密钥分级签发,不同团队、项目与环境各拿各的,互不影响。能力细节见网关产品页

  • 兼容主流规范请求与响应结构不变,SDK 无需更换
  • 流式透传流式响应逐块转发,不增加可感知延迟
  • 标准鉴权Authorization 头携带密钥,由我们签发与轮换
  • 分级密钥按团队、项目、环境分别签发,可单独禁用
  • 模型白名单限定每个密钥可调用的模型范围
  • 速率限制按密钥配置 RPM / TPM,防止单方拖垮整体
02 · Server-side Config

路由、缓存与限流配置

调用行为由服务端策略决定,业务侧不需要感知。同一个模型往往有多个可用通道,价格与稳定性各不相同且随时在变;把选择权交给服务端,意味着上游变化时你不用改代码,也不用重新发版。

  • 路由偏好按成本优先、时延优先或指定通道分流
  • 故障转移上游报错或超时自动重试到备用通道
  • 提示词缓存稳定前缀自动命中,可按接口开关
  • 响应缓存完全相同的请求直接返回,有效期可配
  • 绕过规则带随机性或时效性的请求自动跳过缓存
  • 灰度权重新通道按百分比放量,验证后再全量
03 · Usage & Billing

用量与计费口径

公开计费口径是为了让你能自己对账。每次调用都记录通道、耗时、是否命中缓存、输入输出 token 与状态码;命中缓存的部分按缓存价计,节省金额在报表里单列。所有明细可导出,对接你自己的报表或内部计费系统。价格与套餐见服务定价

  • 调用级明细逐次记录通道、耗时、token 与状态码
  • 缓存单列命中缓存的用量与节省金额分开呈现
  • 多维拆分按模型、密钥、业务线拆分用量与花费
  • 预算控制设置额度上限,达到即停,不会意外超支
  • 明细导出可导出对接自有报表与计费系统
  • 时区口径账单与报表统一按北京时间的自然日切分
04 · Migration & Rollback

迁移与回退

迁移是有风险的动作,所以我们默认按可回退的方式做:先在测试环境跑通,再用灰度把一小部分真实流量切过来,观察指标无异常后逐步放量。任何一步出问题,把配置切回去即可,不需要回滚代码。

  • 测试环境先行用独立密钥在测试环境跑通全部调用路径
  • 灰度切流按百分比把真实流量切过来,先小后大
  • 指标对照迁移前后的成功率、P95 时延与成本逐项对比
  • 一键回退改配置即切回原路径,不涉及代码回滚
  • 并行期可保留一段双跑期,确认稳定后再下线旧链路
  • 迁出同样简单不做数据与格式锁定,离开也是改配置
05 · Delivery & Acceptance

项目交付与验收通则

项目制服务(数据处理、模型定制、内容生产、定制开发)遵循同一套交付通则:范围书面化、样本先验收、按里程碑推进、以事先约定的标准判定是否达标。各条产品线自己的流程细节写在各自的产品页,这里只讲对所有项目都成立的部分。

  • 范围书面化服务范围、交付物清单与排除项写进合同
  • 样本先验收先小批量交付供验收,确认标准后再批量执行
  • 里程碑推进按节点交付与汇报,每节点单独确认
  • 标准判定以事先约定的验收标准判定,不以主观感受判定
  • 质保期交付后提供约定期限的质保与运维支持
  • 数据处置项目结束按约定期限销毁中间产物并出具说明
Getting Started

接入四步

从提出需求到上线,通常在一周之内。

说明场景与规模

使用场景、预计调用量与合规要求,我们据此评估接入方案。

开通与配置

签发密钥与额度,按需配置路由、缓存与限流策略。

灰度验证

测试环境跑通后小比例切流,对照指标确认无回归。

全量与保障

逐步放量至全量,并提供监控告警与工单响应。

Contact

文档没覆盖的问题

直接问我们,一个工作日内答复。需要接口详细说明或安全问卷答复的,也可以直接索取。

联系我们