@henjicc/ai-sdk 0.8.0 → 0.10.0

package/docs/model-adaptation/Seed-ICL-2.0/Seed-ICL-2.0_/347/201/253/345/261/261/345/274/225/346/223/216.md

@@ -0,0 +1,65 @@
+# Seed-ICL 2.0 · 火山引擎
+
+最后更新：2026-09-28。官方文档公开可读；控制台、实际 API 需要账号与权限。
+
+## 产品与接入
+
+同一 Seed-ICL 2.0 模型提供“语音合成”和“克隆声音”模式；已有模型 ID 与语音密钥槽保持兼容。界面按火山引擎品牌归组，方舟和豆包语音分别配置凭据。
+
+新接入采用 V3：`POST https://openspeech.bytedance.com/api/v3/tts/voice_clone` 训练，`POST /api/v3/tts/get_voice` 查询，`POST /api/v3/tts/unidirectional` 合成。训练、查询使用 `X-Api-Key`、UUID `X-Api-Request-Id` 和 JSON Content-Type；合成还带 `X-Api-Resource-Id: seed-icl-2.0`。旧 V1 训练不再迭代，不复用旧协议。
+
+## 输入
+
+- 预付费音色传已有 `speaker_id`；后付费传 `speaker_id: custom_speaker_id` 和唯一的 `custom_speaker_id`。应用自动生成后者，无需手填。
+- 自定义代号长 8–256，仅字母、数字、横线、下划线；字母开头，不以横线/下划线结尾，不使用官方保留前后缀。SDK 自动值使用 `henji` 加 UUID。
+- `audio.data` 为 Base64 原始字节，单文件不超过 10 MB；支持 wav/mp3/ogg/m4a/aac/pcm，PCM 仅 24k 单声道。应用上传复用受管文件，SDK 通过媒体读取器取字节，直接发官方 JSON 接口，不要求公网 URL。应用优先接受可识别容器格式，不接受没有采样元信息的裸 PCM。
+- `audio.format` 总是显式填写（文档字段标必填，正文又说部分格式可省略，显式传递满足两者）。可选 `text` 是录音原文。
+- `language` 数字枚举 0–17、19–21；默认 0 中文。
+- `extra_params.demo_text` 为试听文本，4–300 字，语言应匹配录音；`enable_audio_denoise` 默认 false；`disable_volume_normalization` 默认 false。
+- 合成用真实音色代号作为 `req_params.speaker`，`model: seed-tts-2.0-standard`。
+
+## 状态、错误与恢复
+
+| 状态 | 响应约束 | 行为 | 终态 |
+|---|---|---|---|
+| 0 NotFound | `speaker_id` 字符串、`status` 整数 | 未训练/找不到音色，明确报错 | 是 |
+| 1 Training | 同上 | 保留任务身份，只查询同一个音色 | 否 |
+| 2 Success | 同上；`speaker_status[]` 中 `model_type=5` 对应复刻 2.0，`demo_audio` 为可选试听 URL | 音色可用，保存到音色库；有试听则返回试听 | 是 |
+| 3 Failed | 同上，可选 message | 明确训练失败 | 是 |
+| 4 Active | 同上 | 音色可合成，已激活不可再训练 | 是 |
+| HTTP 失败 / 非成功 code | 可带 `code/message` | 报供应商错误，不把错误当成空音色或成功 | 是 |
+| 缺失/非法 speaker_id 或 status | 不符合字段表 | 拒绝响应 | 是 |
+
+官方字面成功响应没有 `code`，不能强制要求 code 存在。成功必须同时具备有效音色与合法状态；不因为 HTTP 200 就判成功。`available_training_times/create_time/language` 可选；试听 URL 有效一小时，不作为永久音色身份。
+
+训练没有公开幂等保证，不自动重放；取消只终止本地等待，不能声称撤销远端训练。任务身份包含音色代号和名称，继续/恢复只调用查询接口。训练响应为处理中时返回 pending；提交后网络结果不确定时保留可查询身份并标记 submissionUnconfirmed，不假定已训练成功。查询复用现有轮询，正常处理中持续等待，取消或明确终态结束，连续查询失败最多 20 次。未知状态、空响应不会当成成功。官方未说明乱序、重复、远端取消、连接复用保证。普通 HTTP 由 transport 管理，响应完整消费，轮询计时器在取消时释放。
+
+## 费用
+
+公开刊例：Seed-TTS 2.0 / Seed-ICL 2.0 后付费合成均为 **3 元/万字符**；资源包另有折扣。后付费克隆音色 **138 元/音色**，首次正式语音合成时收费并固定音色；训练试听按复刻 2.0 字符费收取，七天未正式调用会删除。预付费槽位按购买数量分档，基础档 138 元/音色，每槽位可训练 15 次。客户端不自动购买或激活槽位。训练与正式合成必须分别显示其费用后果，不把训练试听当成免费，不把槽位费用隐藏在字符估价里。
+
+## 音色列表
+
+2026-09-28 复核：产品入口命名为“豆包语音 2.0”，语音合成模式同时提供系统音色和本地克隆音色。官方在线音色表的两个“豆包语音合成模型2.0”章节共 431 个去重音色（包含 `ICL_uranus_*` 命名的官方系统音色）；不采集后续 S2S 专用与 1.0 章节。旧清单 230 个漏掉了大小写不同的 ID，本次补齐。系统音色必须使用 `seed-tts-2.0` 资源；用户克隆音色使用 `seed-icl-2.0`，不能根据 ID 是否以 ICL 开头推断为收费克隆音色。
+
+官方确有控制面 `ListSpeakers`（2025-05-20）接口，`ResourceIDs: ["seed-tts-2.0"]`、Page、Limit；响应 Speakers 包含 VoiceType、Name 等。官方示例要求 `Authorization: HMAC-SHA256` AK/SK 签名，并非当前配置的语音 `X-Api-Key`。因此本次使用官方文档内置列表，不要求用户为音色选择额外配置控制面凭据。
+
+克隆提交前宿主必须弹出费用二次确认：训练试听 3 元/万字符，新建后付费音色首次正式合成另收 138 元且锁定，7 天未正式使用会删除；使用已有预付费音色会覆盖旧效果并消耗训练次数。取消、关闭或任务中止均不上传样本、不发训练请求；确认仅对本次提交有效。
+
+新版按 ID 查询不提供目录。控制面分页接口 `BatchListMegaTTSTrainStatus`（2025-05-21）要求 ProjectName，官方示例使用 HMAC AK/SK；本次不假定语音 Key 能代替控制面签名。已有槽位可导入一次，应用自动保存之后无需重复输入；新建后付费音色自动产生 ID。本地记录与语音密钥的 provider 隔离，不能混入方舟或派欧云音色。
+
+## Fixture
+
+`tests/fixtures/volcengine-speech/voice-clone.json` 保存训练/查询页面嵌入 API 示例的原样成功响应（仅替换 ID/URL 为不可联网值），以及字段表构造的各状态。负例由测试单独构造。验收覆盖无 code 的官方响应、训练→成功、错误、缺失字段、超限音频、取消与不重放。
+
+## 原始链接
+
+- [系统音色表](https://docs.volcengine.com/docs/DoubaoVoice/Tonelist-1?lang=zh)：2.0 中文与外语章节；公开。
+- [ListSpeakers](https://www.volcengine.com/docs/6561/2160690)：系统音色分页、资源筛选、HMAC 签名示例；公开。
+- [V3 训练](https://docs.volcengine.com/docs/DoubaoVoice/tone-training-http?lang=zh)：请求、状态、后付费 ID 规则；公开。
+- [V3 查询](https://docs.volcengine.com/docs/DoubaoVoice/tone-query-http?lang=zh)：状态、试听有效期；公开。
+- [合成](https://docs.volcengine.com/docs/DoubaoVoice/unidirectional-streaming-text-to-speech-http?lang=zh)：合成请求；公开。
+- [购买与使用](https://docs.volcengine.com/docs/DoubaoVoice/Soundreplicationorderingandusageguide?lang=zh)：激活、训练次数、有效期；公开。
+- [价格](https://docs.volcengine.com/docs/DoubaoVoice/Billinginstructions-21?lang=zh)：正式后付费、槽位与试听计费；公开。
+- [分页音色查询](https://www.volcengine.com/docs/6561/1801953)：控制面签名、项目与分页；公开。
+- [错误](https://www.volcengine.com/docs/6561/2534853)：供应商错误码；公开。

package/docs/model-adaptation/SeedASR-2.0-File/SeedASR-2.0-File_/347/201/253/345/261/261/345/274/225/346/223/216.md

@@ -1,115 +1,115 @@
-# SeedASR 2.0 File · 火山引擎
-
-| 项目 | 内容 |
-|---|---|
-| 最后更新 | 2026-08-31 |
-| 能力 | 录音文件异步识别（submit/query） |
-| SDK `modelId` | `seedasr-2.0-file` |
-| 火山请求模型 | `request.model_name="bigmodel"` + 2.0 资源 ID `volc.seedasr.auc` |
-| P0 输入 | 供应商可读取的 HTTP(S) 远端 URL |
-| 文档/价格 | 公开；API Key、开通和用量需登录 |
-
-## 1. 端点与新版鉴权
-
-```text
-POST https://openspeech.bytedance.com/api/v3/auc/bigmodel/submit
-POST https://openspeech.bytedance.com/api/v3/auc/bigmodel/query
-```
-
-P0 只实现新版控制台单 Key 鉴权：
-
-```text
-X-Api-Key: <API Key>
-X-Api-Resource-Id: volc.seedasr.auc
-X-Api-Request-Id: <客户端生成的 UUID，也是任务 ID>
-Content-Type: application/json
-```
-
-提交还带 `X-Api-Sequence: -1`。查询沿用同一个 UUID；可把提交响应的 `X-Tt-Logid` 回传到查询头，便于服务定位。旧版 `X-Api-App-Key + X-Api-Access-Key` 没有进入 P0，也不得和 `X-Api-Key` 混发。
-
-文档同页还列出 1.0 的 `volc.bigasr.auc`。本模型是 SeedASR 2.0，不能因为旧附件的默认值仍是 `volc.bigasr.auc` 就降级到 1.0。
-
-## 2. 提交请求
-
-```json
-{
-  "user": { "uid": "<request UUID>" },
-  "audio": {
-    "url": "https://audio.example/meeting.mp3",
-    "format": "mp3",
-    "language": "zh-CN"
-  },
-  "request": {
-    "model_name": "bigmodel",
-    "enable_itn": true,
-    "enable_punc": true,
-    "enable_ddc": false,
-    "show_utterances": true
-  }
-}
-```
-
-| 字段 | P0 行为 |
-|---|---|
-| `audio.url` | 必填，只接受 HTTP(S)；本地 bytes 和 `media-ref` 明确报 `unsupported_media_source` |
-| `audio.format` | 必填；只接受官方标准版枚举 `raw/wav/mp3/ogg`，可由 MIME、文件名或 URL 后缀推断 |
-| `audio.language` | 可选，来自通用输入 `language`；不应误放进 `request` |
-| `request.model_name` | 固定 `bigmodel`；2.0 由资源 ID 区分 |
-| `enable_itn` | 默认 `true` |
-| `enable_punc` | 默认 `true`，受通用 `punctuation` 控制 |
-| `enable_ddc` | P0 默认 `false` |
-| `show_utterances` | 默认 `true`，用于结构化句段/时间戳 |
-
-提交成功时 Response body 为空，结果必须从响应头判断：`X-Api-Status-Code=20000000`、`X-Api-Message`、`X-Tt-Logid`。不能因为 HTTP 200 就假定任务已提交成功。
-
-## 3. 查询状态与结果
-
-查询 body 固定 `{}`。P0 状态矩阵：
-
-| `X-Api-Status-Code` | 分类 | SDK 行为 |
-|---|---|---|
-| `20000000` | 成功终态 | 解析 JSON，发 `final/completed` |
-| `20000001` | 处理中 | 发 `processing`，继续轮询 |
-| `20000002` | 排队中 | 发 `processing`，继续轮询 |
-| `20000003` | 静音终态 | `provider_task_failed`，不伪造空成功 |
-| `45xxxxxx` | 请求/音频错误终态 | `provider_task_failed`，停止轮询 |
-| `55xxxxxx` | 服务端错误终态 | `provider_task_failed`，停止轮询 |
-| 缺少状态头 | 非法响应 | `invalid_response` |
-
-成功 JSON 的稳定读取路径：
-
-```text
-result.text
-result.utterances[].text/start_time/end_time/words[]
-audio_info.duration
-```
-
-SDK 将毫秒字段归一到 `durationMs/segments[].startMs/endMs/words[]`。成功终态却没有非空 `result.text` 时严格报 `invalid_response`。
-
-官方没有为该 submit/query 流程给出 P0 可依赖的远端取消端点。用户取消只中止当前 HTTP/等待和后续轮询，不再发送查询，也不声称已取消服务端任务。
-
-## 4. 价格与免费额度
-
-| 项目 | 官方公开值 |
-|---|---|
-| 后付费 | 0.8 元/小时 |
-| 免费试用 | 20 小时 |
-| 有效期 | 开通后 6 个月 |
-
-20 小时是需要在豆包语音控制台开通的试用额度，不是每月自动刷新。创建应用、开通服务和免费试用均需用户在控制台操作；实际扣费以最新价格页和账单为准。
-
-## 5. Fixture 与验证来源
-
-| Fixture | 分类 | 用途 |
-|---|---|---|
-| `asr-seedasr-field-construction.json` | `field-construction` | 官方未给文件成功字面样例；按字段表构造状态头、成功结果与 SDK 出站请求 |
-| `asr-seedasr-synthetic.json` | `synthetic-negative` | 静音/错误等断牙负例，不冒充真实返回 |
-
-## 6. 原始链接索引
-
-| 信息 | 链接 | 登录 |
-|---|---|---|
-| SeedASR 2.0 文件 API | https://docs.volcengine.com/docs/6561/1354868?lang=zh | 否 |
-| 文件识别示例/附件 | https://docs.volcengine.com/docs/6561/2628951?lang=zh | 否 |
-| 计费与免费试用 | https://docs.volcengine.com/docs/6561/1359369?lang=zh | 否 |
-| 豆包语音控制台 | https://console.volcengine.com/speech/new/overview | **是** |
+# SeedASR 2.0 File · 火山引擎
+
+| 项目 | 内容 |
+|---|---|
+| 最后更新 | 2026-08-31 |
+| 能力 | 录音文件异步识别（submit/query） |
+| SDK `modelId` | `seedasr-2.0-file` |
+| 火山请求模型 | `request.model_name="bigmodel"` + 2.0 资源 ID `volc.seedasr.auc` |
+| P0 输入 | 供应商可读取的 HTTP(S) 远端 URL |
+| 文档/价格 | 公开；API Key、开通和用量需登录 |
+
+## 1. 端点与新版鉴权
+
+```text
+POST https://openspeech.bytedance.com/api/v3/auc/bigmodel/submit
+POST https://openspeech.bytedance.com/api/v3/auc/bigmodel/query
+```
+
+P0 只实现新版控制台单 Key 鉴权：
+
+```text
+X-Api-Key: <API Key>
+X-Api-Resource-Id: volc.seedasr.auc
+X-Api-Request-Id: <客户端生成的 UUID，也是任务 ID>
+Content-Type: application/json
+```
+
+提交还带 `X-Api-Sequence: -1`。查询沿用同一个 UUID；可把提交响应的 `X-Tt-Logid` 回传到查询头，便于服务定位。旧版 `X-Api-App-Key + X-Api-Access-Key` 没有进入 P0，也不得和 `X-Api-Key` 混发。
+
+文档同页还列出 1.0 的 `volc.bigasr.auc`。本模型是 SeedASR 2.0，不能因为旧附件的默认值仍是 `volc.bigasr.auc` 就降级到 1.0。
+
+## 2. 提交请求
+
+```json
+{
+  "user": { "uid": "<request UUID>" },
+  "audio": {
+    "url": "https://audio.example/meeting.mp3",
+    "format": "mp3",
+    "language": "zh-CN"
+  },
+  "request": {
+    "model_name": "bigmodel",
+    "enable_itn": true,
+    "enable_punc": true,
+    "enable_ddc": false,
+    "show_utterances": true
+  }
+}
+```
+
+| 字段 | P0 行为 |
+|---|---|
+| `audio.url` | 必填，只接受 HTTP(S)；本地 bytes 和 `media-ref` 明确报 `unsupported_media_source` |
+| `audio.format` | 必填；只接受官方标准版枚举 `raw/wav/mp3/ogg`，可由 MIME、文件名或 URL 后缀推断 |
+| `audio.language` | 可选，来自通用输入 `language`；不应误放进 `request` |
+| `request.model_name` | 固定 `bigmodel`；2.0 由资源 ID 区分 |
+| `enable_itn` | 默认 `true` |
+| `enable_punc` | 默认 `true`，受通用 `punctuation` 控制 |
+| `enable_ddc` | P0 默认 `false` |
+| `show_utterances` | 默认 `true`，用于结构化句段/时间戳 |
+
+提交成功时 Response body 为空，结果必须从响应头判断：`X-Api-Status-Code=20000000`、`X-Api-Message`、`X-Tt-Logid`。不能因为 HTTP 200 就假定任务已提交成功。
+
+## 3. 查询状态与结果
+
+查询 body 固定 `{}`。P0 状态矩阵：
+
+| `X-Api-Status-Code` | 分类 | SDK 行为 |
+|---|---|---|
+| `20000000` | 成功终态 | 解析 JSON，发 `final/completed` |
+| `20000001` | 处理中 | 发 `processing`，继续轮询 |
+| `20000002` | 排队中 | 发 `processing`，继续轮询 |
+| `20000003` | 静音终态 | `provider_task_failed`，不伪造空成功 |
+| `45xxxxxx` | 请求/音频错误终态 | `provider_task_failed`，停止轮询 |
+| `55xxxxxx` | 服务端错误终态 | `provider_task_failed`，停止轮询 |
+| 缺少状态头 | 非法响应 | `invalid_response` |
+
+成功 JSON 的稳定读取路径：
+
+```text
+result.text
+result.utterances[].text/start_time/end_time/words[]
+audio_info.duration
+```
+
+SDK 将毫秒字段归一到 `durationMs/segments[].startMs/endMs/words[]`。成功终态却没有非空 `result.text` 时严格报 `invalid_response`。
+
+官方没有为该 submit/query 流程给出 P0 可依赖的远端取消端点。用户取消只中止当前 HTTP/等待和后续轮询，不再发送查询，也不声称已取消服务端任务。
+
+## 4. 价格与免费额度
+
+| 项目 | 官方公开值 |
+|---|---|
+| 后付费 | 0.8 元/小时 |
+| 免费试用 | 20 小时 |
+| 有效期 | 开通后 6 个月 |
+
+20 小时是需要在豆包语音控制台开通的试用额度，不是每月自动刷新。创建应用、开通服务和免费试用均需用户在控制台操作；实际扣费以最新价格页和账单为准。
+
+## 5. Fixture 与验证来源
+
+| Fixture | 分类 | 用途 |
+|---|---|---|
+| `asr-seedasr-field-construction.json` | `field-construction` | 官方未给文件成功字面样例；按字段表构造状态头、成功结果与 SDK 出站请求 |
+| `asr-seedasr-synthetic.json` | `synthetic-negative` | 静音/错误等断牙负例，不冒充真实返回 |
+
+## 6. 原始链接索引
+
+| 信息 | 链接 | 登录 |
+|---|---|---|
+| SeedASR 2.0 文件 API | https://docs.volcengine.com/docs/6561/1354868?lang=zh | 否 |
+| 文件识别示例/附件 | https://docs.volcengine.com/docs/6561/2628951?lang=zh | 否 |
+| 计费与免费试用 | https://docs.volcengine.com/docs/6561/1359369?lang=zh | 否 |
+| 豆包语音控制台 | https://console.volcengine.com/speech/new/overview | **是** |

package/docs/model-adaptation/SeedASR-2.0-Realtime/SeedASR-2.0-Realtime_/347/201/253/345/261/261/345/274/225/346/223/216.md

@@ -1,147 +1,147 @@
-# SeedASR 2.0 Realtime · 火山引擎
-
-| 项目 | 内容 |
-|---|---|
-| 最后更新 | 2026-09-24 |
-| 能力 | 双向实时语音识别（二进制 WebSocket） |
-| SDK `modelId` | `seedasr-2.0-realtime` |
-| 火山请求模型 | `request.model_name="bigmodel"` + 2.0 资源 ID `volc.seedasr.sauc.duration` |
-| P0 音频 | PCM S16LE、16 kHz、16 bit、单声道 |
-| 文档/价格 | 公开；API Key、开通和用量需登录 |
-
-## 1. 端点与新版鉴权
-
-P0 使用官方双向流式优化端点：
-
-```text
-wss://openspeech.bytedance.com/api/v3/sauc/bigmodel_async
-```
-
-握手头：
-
-```text
-X-Api-Key: <API Key>
-X-Api-Resource-Id: volc.seedasr.sauc.duration
-X-Api-Request-Id: <客户端生成的 UUID>
-X-Api-Sequence: -1
-```
-
-只支持新版 `X-Api-Key`。同一官方页面同时列出 1.0 的 `volc.bigasr.sauc.*` 与 2.0 的 `volc.seedasr.sauc.*`；本模型固定 2.0 小时版资源 ID。并发版 `volc.seedasr.sauc.concurrent` 属于另一计费形态，不在 P0 中静默切换。
-
-## 2. 首帧与音频规格
-
-首帧 JSON 经 UTF-8 + gzip 后装入二进制帧：
-
-```json
-{
-  "user": { "uid": "<request UUID>" },
-  "audio": {
-    "format": "pcm",
-    "codec": "raw",
-    "rate": 16000,
-    "bits": 16,
-    "channel": 1
-  },
-  "request": {
-    "model_name": "bigmodel",
-    "enable_itn": true,
-    "enable_punc": true,
-    "enable_ddc": false,
-    "show_utterances": true,
-    "enable_nonstream": false,
-    "result_type": "full"
-  }
-}
-```
-
-P0 不在 SDK 内转码：输入不符合 PCM S16LE/16 kHz/mono 时，在建立付费连接前失败。每个 PCM16 音频块的字节数必须为偶数。官方示例建议每 200 ms 一包，即 6400 字节；分块节奏由宿主负责。
-
-`bigmodel_async` 当前契约不发送 `audio.language`；传入 `language` 或热词 `hints` 会明确报不支持，避免静默丢参数。
-
-## 3. 二进制帧契约
-
-### 3.1 4 字节头
-
-| 位置 | 高 4 bit | 低 4 bit |
-|---|---|---|
-| byte 0 | version=`1` | header size=`1`（4 字节） |
-| byte 1 | message type | flags |
-| byte 2 | serialization | compression |
-| byte 3 | reserved | reserved |
-
-消息与标志：
-
-| 值 | 含义 |
-|---|---|
-| message type `1` | client full request |
-| message type `2` | client audio-only request |
-| message type `9` | server full response |
-| message type `15` | server error response |
-| flag bit `1` | 帧含 4 字节大端有符号 sequence |
-| flag bit `2` | 最后一包 |
-| flag bit `4` | 帧含 4 字节大端 event |
-| serialization `0/1` | none / JSON |
-| compression `0/1` | none / gzip |
-
-完整响应布局为 `header → [sequence] → [event] → uint32 payload_size → payload`；错误响应为 `header → [sequence] → [event] → uint32 error_code → uint32 payload_size → payload`。解析器要求声明长度与实际剩余字节完全一致，断牙和尾随字节都报 `invalid_response`。服务端 payload 同时接受 `compression=none/gzip`，其他压缩或序列化值拒绝。
-
-### 3.2 当前官方附件的客户端帧
-
-| 帧 | 头 hex | sequence | payload |
-|---|---|---|---|
-| 首帧 | `11 11 11 00` | `1` | JSON UTF-8 + gzip |
-| 普通音频 | `11 21 11 00` | 正数，从 `2` 递增 | 原始 PCM + gzip |
-| 最后一块真实音频 | `11 23 11 00` | 当前序号取负数 | 原始 PCM + gzip |
-
-协议字段表把原始音频描述为 `serialization=none`，但 2026-08-08 当前官方 Python 附件对音频帧实际写入 `serialization=JSON` 标志（第三字节 `0x11`），附件自带成功 `run.log` 也使用这一结构。P0 以可复现的当前官方附件为准锁定 `0x11`；这是已记录的官方资料内部差异，后续若官方修正文档或附件需重新验证，而不是同时猜两套发送协议。
-
-SDK 对音频保留一块延迟：收到下一块时才把上一块以正 sequence 发出；`finish()` 把最后一块真实音频以负 sequence 发送。不会制造空终止音频包。无任何真实音频就 `finish()` 会报 `invalid_audio`。
-
-## 4. 服务端事件矩阵
-
-| 服务端帧/字段 | Capability 事件 | 终态 | 行为 |
-|---|---|---|---|
-| 首个合法 type `9` full response | `started` | 否 | 官方附件该帧 `result.text=""`；SDK 不要求必须为空，也不产生空 partial |
-| type `9`，非空 `result.text` | `partial` | 否 | 文本变化才发，重复内容去重 |
-| `result.utterances[].definite=true` | `final` | 否 | 表示句段已确定，不等于整个连接结束；按时间范围/文本去重 |
-| flag bit `2`（last） | `completed` | 是 | 只有客户端已 `finish()` 后才合法；输出 `result.text/utterances/audio_info.duration` |
-| type `15` | 无 | 是（错误） | 读取 uint32 错误码；错误 payload 可为 JSON 或 UTF-8 文本，默认异常/日志只保留错误码，不带原始 message |
-| 未知 `event` 数字 | 无 | 否 | 只记脱敏 warning，仍按 type/payload 处理 |
-| WebSocket 提前断开 | 无 | 是（错误） | `provider_connection_closed`，不误报完成 |
-| text WebSocket frame | 无 | 是（错误） | 协议要求二进制，报 `invalid_response` |
-
-`utterances[].definite=true` 只能判断句段 final，整个会话终态必须看帧头 last 标志。整个终帧仍无有效文本时严格报 `invalid_response`。
-
-用户主动取消只关闭连接，不发送负 sequence 终帧，也不把取消伪装成正常完成。full request 默认在 15 秒内必须收到首个服务端响应，可用 `openTimeoutMs` 显式调整；超时会关闭半开连接。`finish()`、连接释放和显式 `close()` 都幂等；发送失败、服务端错误、断线、超时和取消都走同一个释放边界。
-
-同一响应帧可能同时产生 partial 与一个或多个 final。每次事件回调后重新检查取消/关闭，避免调用方在 partial 回调取消后，SDK 仍继续发出该帧的 final；该场景使用官方响应 payload 调整 last 标志构造，不代表新的供应商事件类型。
-
-2026-09-24 诊断复核：异常 details 保留实际 `modelId=seedasr-2.0-realtime`、`protocol=volcengine-binary-v1`、会话阶段、操作与最后一帧的序号/event/last 标志。原始服务端 message 和宿主异常可能包含识别内容或凭据，不进入默认诊断。握手失败后若关闭也失败，继续报告首个故障，并附 `cleanupFailed=true`。`volcengine-realtime-asr.test.ts` 使用既有官方帧结构、受控敏感文本错误与 Mock close 拒绝验证这些边界；不是额外真实服务实录。
-
-## 5. 价格与免费额度
-
-| 项目 | 官方公开值 |
-|---|---|
-| 后付费（小时版） | 1 元/小时 |
-| 免费试用 | 20 小时 |
-| 有效期 | 开通后 6 个月 |
-
-20 小时为需在豆包语音控制台开通的试用额度，不是每月自动刷新。并发版的资源与计费方式不同，不应把本页小时版单价套到并发版。
-
-## 6. Fixture 与验证来源
-
-| Fixture | 分类 | 用途 |
-|---|---|---|
-| `asr-seedasr-official.json` | `official-redacted` | 官方附件成功 `run.log` 的握手/空进度/终帧；仅 `log_id` 脱敏 |
-| `asr-seedasr-field-construction.json` | `field-construction` | 按官方当前附件构造三类客户端帧与首帧字段 |
-| `asr-seedasr-synthetic.json` | `synthetic-negative` | 未知 event、错误码、断牙/尾随字节等负例 |
-
-## 7. 原始链接索引
-
-| 信息 | 链接 | 登录 |
-|---|---|---|
-| 流式 API/二进制协议 | https://docs.volcengine.com/docs/6561/1354869?lang=zh | 否 |
-| 双向流式优化端点与当前附件 | https://docs.volcengine.com/docs/6561/2630027?lang=zh | 否 |
-| 流式调用示例/资源 ID | https://docs.volcengine.com/docs/6561/2628951?lang=zh | 否 |
-| 计费与免费试用 | https://docs.volcengine.com/docs/6561/1359369?lang=zh | 否 |
-| 豆包语音控制台 | https://console.volcengine.com/speech/new/overview | **是** |
+# SeedASR 2.0 Realtime · 火山引擎
+
+| 项目 | 内容 |
+|---|---|
+| 最后更新 | 2026-09-24 |
+| 能力 | 双向实时语音识别（二进制 WebSocket） |
+| SDK `modelId` | `seedasr-2.0-realtime` |
+| 火山请求模型 | `request.model_name="bigmodel"` + 2.0 资源 ID `volc.seedasr.sauc.duration` |
+| P0 音频 | PCM S16LE、16 kHz、16 bit、单声道 |
+| 文档/价格 | 公开；API Key、开通和用量需登录 |
+
+## 1. 端点与新版鉴权
+
+P0 使用官方双向流式优化端点：
+
+```text
+wss://openspeech.bytedance.com/api/v3/sauc/bigmodel_async
+```
+
+握手头：
+
+```text
+X-Api-Key: <API Key>
+X-Api-Resource-Id: volc.seedasr.sauc.duration
+X-Api-Request-Id: <客户端生成的 UUID>
+X-Api-Sequence: -1
+```
+
+只支持新版 `X-Api-Key`。同一官方页面同时列出 1.0 的 `volc.bigasr.sauc.*` 与 2.0 的 `volc.seedasr.sauc.*`；本模型固定 2.0 小时版资源 ID。并发版 `volc.seedasr.sauc.concurrent` 属于另一计费形态，不在 P0 中静默切换。
+
+## 2. 首帧与音频规格
+
+首帧 JSON 经 UTF-8 + gzip 后装入二进制帧：
+
+```json
+{
+  "user": { "uid": "<request UUID>" },
+  "audio": {
+    "format": "pcm",
+    "codec": "raw",
+    "rate": 16000,
+    "bits": 16,
+    "channel": 1
+  },
+  "request": {
+    "model_name": "bigmodel",
+    "enable_itn": true,
+    "enable_punc": true,
+    "enable_ddc": false,
+    "show_utterances": true,
+    "enable_nonstream": false,
+    "result_type": "full"
+  }
+}
+```
+
+P0 不在 SDK 内转码：输入不符合 PCM S16LE/16 kHz/mono 时，在建立付费连接前失败。每个 PCM16 音频块的字节数必须为偶数。官方示例建议每 200 ms 一包，即 6400 字节；分块节奏由宿主负责。
+
+`bigmodel_async` 当前契约不发送 `audio.language`；传入 `language` 或热词 `hints` 会明确报不支持，避免静默丢参数。
+
+## 3. 二进制帧契约
+
+### 3.1 4 字节头
+
+| 位置 | 高 4 bit | 低 4 bit |
+|---|---|---|
+| byte 0 | version=`1` | header size=`1`（4 字节） |
+| byte 1 | message type | flags |
+| byte 2 | serialization | compression |
+| byte 3 | reserved | reserved |
+
+消息与标志：
+
+| 值 | 含义 |
+|---|---|
+| message type `1` | client full request |
+| message type `2` | client audio-only request |
+| message type `9` | server full response |
+| message type `15` | server error response |
+| flag bit `1` | 帧含 4 字节大端有符号 sequence |
+| flag bit `2` | 最后一包 |
+| flag bit `4` | 帧含 4 字节大端 event |
+| serialization `0/1` | none / JSON |
+| compression `0/1` | none / gzip |
+
+完整响应布局为 `header → [sequence] → [event] → uint32 payload_size → payload`；错误响应为 `header → [sequence] → [event] → uint32 error_code → uint32 payload_size → payload`。解析器要求声明长度与实际剩余字节完全一致，断牙和尾随字节都报 `invalid_response`。服务端 payload 同时接受 `compression=none/gzip`，其他压缩或序列化值拒绝。
+
+### 3.2 当前官方附件的客户端帧
+
+| 帧 | 头 hex | sequence | payload |
+|---|---|---|---|
+| 首帧 | `11 11 11 00` | `1` | JSON UTF-8 + gzip |
+| 普通音频 | `11 21 11 00` | 正数，从 `2` 递增 | 原始 PCM + gzip |
+| 最后一块真实音频 | `11 23 11 00` | 当前序号取负数 | 原始 PCM + gzip |
+
+协议字段表把原始音频描述为 `serialization=none`，但 2026-08-08 当前官方 Python 附件对音频帧实际写入 `serialization=JSON` 标志（第三字节 `0x11`），附件自带成功 `run.log` 也使用这一结构。P0 以可复现的当前官方附件为准锁定 `0x11`；这是已记录的官方资料内部差异，后续若官方修正文档或附件需重新验证，而不是同时猜两套发送协议。
+
+SDK 对音频保留一块延迟：收到下一块时才把上一块以正 sequence 发出；`finish()` 把最后一块真实音频以负 sequence 发送。不会制造空终止音频包。无任何真实音频就 `finish()` 会报 `invalid_audio`。
+
+## 4. 服务端事件矩阵
+
+| 服务端帧/字段 | Capability 事件 | 终态 | 行为 |
+|---|---|---|---|
+| 首个合法 type `9` full response | `started` | 否 | 官方附件该帧 `result.text=""`；SDK 不要求必须为空，也不产生空 partial |
+| type `9`，非空 `result.text` | `partial` | 否 | 文本变化才发，重复内容去重 |
+| `result.utterances[].definite=true` | `final` | 否 | 表示句段已确定，不等于整个连接结束；按时间范围/文本去重 |
+| flag bit `2`（last） | `completed` | 是 | 只有客户端已 `finish()` 后才合法；输出 `result.text/utterances/audio_info.duration` |
+| type `15` | 无 | 是（错误） | 读取 uint32 错误码；错误 payload 可为 JSON 或 UTF-8 文本，默认异常/日志只保留错误码，不带原始 message |
+| 未知 `event` 数字 | 无 | 否 | 只记脱敏 warning，仍按 type/payload 处理 |
+| WebSocket 提前断开 | 无 | 是（错误） | `provider_connection_closed`，不误报完成 |
+| text WebSocket frame | 无 | 是（错误） | 协议要求二进制，报 `invalid_response` |
+
+`utterances[].definite=true` 只能判断句段 final，整个会话终态必须看帧头 last 标志。整个终帧仍无有效文本时严格报 `invalid_response`。
+
+用户主动取消只关闭连接，不发送负 sequence 终帧，也不把取消伪装成正常完成。full request 默认在 15 秒内必须收到首个服务端响应，可用 `openTimeoutMs` 显式调整；超时会关闭半开连接。`finish()`、连接释放和显式 `close()` 都幂等；发送失败、服务端错误、断线、超时和取消都走同一个释放边界。
+
+同一响应帧可能同时产生 partial 与一个或多个 final。每次事件回调后重新检查取消/关闭，避免调用方在 partial 回调取消后，SDK 仍继续发出该帧的 final；该场景使用官方响应 payload 调整 last 标志构造，不代表新的供应商事件类型。
+
+2026-09-24 诊断复核：异常 details 保留实际 `modelId=seedasr-2.0-realtime`、`protocol=volcengine-binary-v1`、会话阶段、操作与最后一帧的序号/event/last 标志。原始服务端 message 和宿主异常可能包含识别内容或凭据，不进入默认诊断。握手失败后若关闭也失败，继续报告首个故障，并附 `cleanupFailed=true`。`volcengine-realtime-asr.test.ts` 使用既有官方帧结构、受控敏感文本错误与 Mock close 拒绝验证这些边界；不是额外真实服务实录。
+
+## 5. 价格与免费额度
+
+| 项目 | 官方公开值 |
+|---|---|
+| 后付费（小时版） | 1 元/小时 |
+| 免费试用 | 20 小时 |
+| 有效期 | 开通后 6 个月 |
+
+20 小时为需在豆包语音控制台开通的试用额度，不是每月自动刷新。并发版的资源与计费方式不同，不应把本页小时版单价套到并发版。
+
+## 6. Fixture 与验证来源
+
+| Fixture | 分类 | 用途 |
+|---|---|---|
+| `asr-seedasr-official.json` | `official-redacted` | 官方附件成功 `run.log` 的握手/空进度/终帧；仅 `log_id` 脱敏 |
+| `asr-seedasr-field-construction.json` | `field-construction` | 按官方当前附件构造三类客户端帧与首帧字段 |
+| `asr-seedasr-synthetic.json` | `synthetic-negative` | 未知 event、错误码、断牙/尾随字节等负例 |
+
+## 7. 原始链接索引
+
+| 信息 | 链接 | 登录 |
+|---|---|---|
+| 流式 API/二进制协议 | https://docs.volcengine.com/docs/6561/1354869?lang=zh | 否 |
+| 双向流式优化端点与当前附件 | https://docs.volcengine.com/docs/6561/2630027?lang=zh | 否 |
+| 流式调用示例/资源 ID | https://docs.volcengine.com/docs/6561/2628951?lang=zh | 否 |
+| 计费与免费试用 | https://docs.volcengine.com/docs/6561/1359369?lang=zh | 否 |
+| 豆包语音控制台 | https://console.volcengine.com/speech/new/overview | **是** |