实时事件参考

实时文本转语音 API 所接收事件的参考文档

参考文档 · 列出实时文本转语音 WebSocket API 发送和接收的所有事件。

有关 API 及其选项的更多信息，请查看实时文本转语音 API 的 API 参考文档。

committed_transcript 是每个片段稳定的最终事件。公共 API 不会单独发出 final_transcript 事件。

发送的事件

事件	说明	使用时机
`input_audio_chunk`	发送用于转录的音频数据	持续传输音频时

接收的事件

事件	说明	接收时机
`session_started`	确认连接并返回会话配置	建立 WebSocket 连接后立即接收
`partial_transcript`	正在处理片段的实时转录更新。后续部分转录会替换之前的内容。也会作为保活消息发送：若片段没有未提交文本，则 `text` 为空；否则会重复最新的部分转录	音频处理期间、提交前。配置后，也会大约每隔 `keepalive_interval_ms` 作为保活消息发送
`committed_transcript`	一个片段的已确定转录。这是该片段稳定的最终文本，不会再更改	提交后（手动提交或由 VAD 触发）
`committed_transcript_with_timestamps`	包含词级时间戳和检测到的 `language_code` 的已提交转录	在已提交转录后发送。仅当查询参数中包含 `include_timestamps=true` 或 `include_language_detection=true` 时接收
`committed_transcript_entities`	在已提交转录片段中检测到的实体及其字符偏移量	每个已提交转录后不久发送。仅当查询参数中包含 `entity_detection` 时接收
`edited_transcript`	已提交转录片段的编辑版本，以及原始已提交文本	每个已提交转录后不久发送。仅当查询参数中包含 `transcript_edit` 时接收

错误处理

发生错误时，WebSocket 连接关闭前会返回错误消息。

错误类型	说明
`auth_error`	请求身份验证时发生错误。请再次检查 API 密钥
`quota_exceeded`	已超出使用配额
`transcriber_error`	转录音频时发生错误。
`input_error`	处理音频块时发生错误。可能是输入格式或参数无效导致
`invalid_request`	连接参数被拒绝。请根据 API 参考文档检查查询参数
`error`	通用服务器错误
`commit_throttled`	短时间内发起过多提交请求，提交操作已被限流
`unaccepted_terms`	尚未接受使用 Scribe 的服务条款。请在 ElevenLabs 控制台查看并接受条款与条件
`rate_limited`	请求已被限流。请减少短时间内的请求量
`queue_overflow`	处理队列已满。请减少短时间内的请求量
`resource_exhausted`	服务器资源已满。请稍后重试
`session_time_limit_exceeded`	已达到最长会话时长。请开始新会话或升级订阅
`chunk_size_exceeded`	音频块过大。请减小音频块大小
`insufficient_audio_activity`	发送的音频活动不足，无法维持连接