X-Api-App-Key

使用火山引擎控制台获取的APP ID，可参考 控制台使用FAQ-Q1

123456789

X-Api-Access-Key

使用火山引擎控制台获取的Access Token，可参考 控制台使用FAQ-Q1

your-access-key

X-Api-Resource-Id

表示调用服务的资源信息 ID

豆包流式语音识别模型1.0

• 小时版：volc.bigasr.sauc.duration
• 并发版：volc.bigasr.sauc.concurrent

豆包流式语音识别模型2.0

• 小时版：volc.seedasr.sauc.duration
• 并发版：volc.seedasr.sauc.concurrent

X-Api-Connect-Id

用于追踪当前连接的标志 ID，推荐设置UUID等

67ee89ba-7050-4c04-a3d7-ac61a63499b3

X-Api-Connect-Id

用于追踪当前调用信息的标志 ID，推荐用UUID等

67ee89ba-7050-4c04-a3d7-ac61a63499b3

X-Tt-Logid

服务端返回的 logid，建议用户获取和打印方便定位问题

202407261553070FACFE6D19421815D605

0

Protocol version

Header size

1

Message type

Message type specific flags

2

Message serialization method

Message compression

3

Reserved

4

[Optional header extensions]

5

[Payload, depending on the Message Type]

6

...

Protocol version (4)

将来可能会决定使用不同的协议版本，因此此字段是为了使客户端和服务器在版本上达成共识。

0b0001 - version 1 (目前只有该版本)

Header (4)

Header 大小。实际 header 大小（以字节为单位）是 header size value x 4 。

0b0001 - header size = 4 (1 x 4)

Message type (4)

消息类型。

0b0001 - 端上发送包含请求参数的 full client request
0b0010 - 端上发送包含音频数据的 audio only request
0b1001 - 服务端下发包含识别结果的 full server response
0b1111 - 服务端处理错误时下发的消息类型（如无效的消息格式，不支持的序列化方法等）

Message type specific flags (4)

Message type 的补充信息。

0b0000 - header后4个字节不为sequence number
0b0001 - header后4个字节为sequence number且为正
0b0010 - header后4个字节不为sequence number，仅指示此为最后一包（负包）
0b0011 - header后4个字节为sequence number且需要为负数（最后一包/负包）

Message serialization method (4)

full client request 的 payload 序列化方法；
服务器将使用与客户端相同的序列化方法。

0b0000 - 无序列化
0b0001 - JSON 格式

Message Compression (4)

定义 payload 的压缩方法；
服务端将使用客户端的压缩方法。

0b0000 - no compression
0b0001 - Gzip 压缩

Reserved (8)

保留以供将来使用，还用作填充（使整个标头总计4个字节）。

Header

Payload size (4B, unsigned int32)

Payload

user

用户相关配置

1

dict

提供后可供服务端过滤日志

uid

用户标识

2

string

建议采用 IMEI 或 MAC。

did

设备名称

2

string

platform

操作系统及API版本号

2

string

iOS/Android/Linux

sdk_version

sdk版本

2

string

app_version

app 版本

2

string

audio

音频相关配置

1

dict

✓

language

指定可识别的语言

2

string

注意：仅流式输入模式(bigmodel_nostream)支持此参数
当该键为空时，该模型支持中英文、上海话、闽南语，四川、陕西、粤语识别。当将其设置为下方特定键时，它可以识别指定语言。
英语：en-US
日语：ja-JP
印尼语：id-ID
西班牙语：es-MX
葡萄牙语：pt-BR
德语：de-DE
法语：fr-FR
韩语：ko-KR
菲律宾语：fil-PH
马来语：ms-MY
泰语：th-TH
阿拉伯语：ar-SA
例如，如果输入音频是德语，则此参数传入de-DE

format

音频容器格式

2

string

✓

pcm / wav / ogg / mp3
注意：pcm和wav内部音频流必须是pcm_s16le

codec

音频编码格式

2

string

raw / opus，默认为 raw(表示pcm)
注意: 当format为ogg的时候，codec必须是opus，
当format为mp3的时候，codec不生效，传默认值raw即可

rate

音频采样率

2

int

默认为 16000，目前只支持16000

bits

音频采样点位数

2

int

默认为 16，暂只支持16bits

channel

音频声道数

2

int

1(mono) / 2(stereo)，默认为1。

request

请求相关配置

1

dict

✓

model_name

模型名称

2

string

✓

目前只有bigmodel

enable_nonstream

开启二遍识别

2

bool

开启流式+非流式二遍识别模式：在一个接口里实现即双向流式实时返回逐字文本+流式输入模式（nostream）重新识别该分句音频片段提升准确率，既可以满足客户实时上屏需求（快），又可以在最终结果中保证识别准确率（准）。
目前二遍识别仅在双向流式优化版上支持，不支持旧版链路。
开启二遍识别后，会默认开启VAD分句（默认800ms判停，数值可通过end_window_size参数配置），VAD分句判停时，会使用非流式模型（nostream接口）重新识别该分句音频。且只有在非流式（nostream接口）输出的识别结果中会输出"definite": true 分句标识。

enable_itn

启用itn

2

bool

默认为true。
文本规范化 (ITN) 是自动语音识别 (ASR) 后处理管道的一部分。 ITN 的任务是将 ASR 模型的原始语音输出转换为书面形式，以提高文本的可读性。
例如，“一九七零年”->“1970年”和“一百二十三美元”->“$123”。

enable_punc

启用标点

2

bool

默认为true。

enable_ddc

启用顺滑

2

bool

默认为false。
**语义顺滑**‌是一种技术，旨在提高自动语音识别（ASR）结果的文本可读性和流畅性。这项技术通过删除或修改ASR结果中的不流畅部分，如停顿词、语气词、语义重复词等，使得文本更加易于阅读和理解。

show_utterances

输出语音停顿、分句、分词信息

2

bool

show_speech_rate（仅nostream接口和双向流式优化版支持）

分句信息携带语速

2

bool

如果设为"True"，则会在分句additions信息中使用speech_rate标记，单位为 token/s。默认 "False"。
双向流式优化版启用此功能会默认开启VAD分句（默认800ms判停，数值可通过end_window_size参数配置。识别结果中"definite": true的分句的additions信息中携带标记信息）

show_volume（仅nostream接口和双向流式优化版支持）

分句信息携带音量

2

bool

如果设为"True"，则会在分句additions信息中使用volume标记，单位为 分贝。默认 "False"。
双向流式优化版启用此功能会默认开启VAD分句（默认800ms判停，数值可通过end_window_size参数配置。识别结果中"definite": true的分句的additions信息中携带标记信息）

enable_lid（仅nostream接口和双向流式优化版支持）

启用语种检测

2

bool

目前能识别语种，且能出识别结果的语言：中英文、上海话、闽南语，四川、陕西、粤语
如果设为"True"，则会在additions信息中使用lid_lang标记, 返回对应的语种标签。默认 "False"
支持的标签包括：

• singing_en：英文唱歌
• singing_mand：普通话唱歌
• singing_dia_cant：粤语唱歌
• speech_en：英文说话
• speech_mand：普通话说话
• speech_dia_nan：闽南语
• speech_dia_wuu：吴语（含上海话）
• speech_dia_cant：粤语说话
• speech_dia_xina：西南官话（含四川话）
• speech_dia_zgyu：中原官话（含陕西话）
• other_langs：其它语种（其它语种人声）
• others：检测不出（非语义人声和非人声）
  空时代表无法判断（例如传入音频过短等）

实际不支持识别的语种（无识别结果），但该参数可检测并输出对应lang_code。对应的标签如下：

• singing_hi：印度语唱歌
• singing_ja：日语唱歌
• singing_ko：韩语唱歌
• singing_th：泰语唱歌
• speech_hi：印地语说话
• speech_ja：日语说话
• speech_ko：韩语说话
• speech_th：泰语说话
• speech_kk：哈萨克语说话
• speech_bo：藏语说话
• speech_ug：维语
• speech_mn：蒙古语
• speech_dia_ql：琼雷话
• speech_dia_hsn：湘语
• speech_dia_jin：晋语
• speech_dia_hak：客家话
• speech_dia_chao：潮汕话
• speech_dia_juai：江淮官话
• speech_dia_lany：兰银官话
• speech_dia_dbiu：东北官话
• speech_dia_jliu：胶辽官话
• speech_dia_jlua：冀鲁官话
• speech_dia_cdo：闽东话
• speech_dia_gan：赣语
• speech_dia_mnp：闽北语
• speech_dia_czh：徽语

双向流式优化版启用此功能会默认开启VAD分句（默认800ms判停，数值可通过end_window_size参数配置。识别结果中"definite": true的分句的additions信息中携带标记信息）

enable_emotion_detection（仅nostream接口和双向流式优化版支持）

启用情绪检测

2

bool

如果设为"True"，则会在分句additions信息中使用emotion标记, 返回对应的情绪标签。默认 "False"
支持的情绪标签包括：

• "angry"：表示情绪为生气
• "happy"：表示情绪为开心
• "neutral"：表示情绪为平静或中性
• "sad"：表示情绪为悲伤
• "surprise"：表示情绪为惊讶

双向流式优化版启用此功能会默认开启VAD分句（默认800ms判停，数值可通过end_window_size参数配置。识别结果中"definite": true的分句的additions信息中携带标记信息）

enable_gender_detection（仅nostream接口和双向流式优化版支持）

启用性别检测

2

bool

如果设为"True"，则会在分句additions信息中使用gender标记, 返回对应的性别标签（male/female）。默认 "False"。
双向流式优化版启用此功能会默认开启VAD分句（默认800ms判停，数值可通过end_window_size参数配置。识别结果中"definite": true的分句的additions信息中携带标记信息）

result_type

结果返回方式

2

string

默认为"full",全量返回。
设置为"single"则为增量结果返回，即不返回之前分句的结果。

enable_accelerate_text

是否启动首字返回加速

2

bool

如果设为"True"，则会尽量加速首字返回，但会降低首字准确率。
默认 "False"

accelerate_score

首字返回加速率

2

int

配合enable_accelerate_text参数使用，默认为0，表示不加速，取值范围[0-20]，值越大，首字出字越快

vad_segment_duration

语义切句的最大静音阈值

2

int

单位ms，默认为3000。当静音时间超过该值时，会将文本分为两个句子。不决定判停，所以不会修改definite出现的位置。在end_window_size配置后，该参数失效。

end_window_size

强制判停时间

2

int

单位ms，默认为800，最小200。静音时长超过该值，会直接判停，输出definite。配置该值，不使用语义分句，根据静音时长来分句。用于实时性要求较高场景，可以提前获得definite句子

force_to_speech_time

强制语音时间

2

int

单位ms，默认为10000，最小1。音频时长超过该值之后，才会判停，根据静音时长输出definite，需配合end_window_size使用。
用于解决短音频+实时性要求较高场景，不配置该参数，只使用end_window_size时，前10s不会判停。推荐设置1000，可能会影响识别准确率。

sensitive_words_filter

敏感词过滤

2

string

敏感词过滤功能,支持开启或关闭,支持自定义敏感词。该参数可实现：不处理(默认,即展示原文)、过滤、替换为*。
示例：
system_reserved_filter //是否使用系统敏感词，会替换成*(默认系统敏感词主要包含一些限制级词汇）
filter_with_empty // 想要替换成空的敏感词
filter_with_signed // 想要替换成 * 的敏感词

"sensitive_words_filter":{\"system_reserved_filter\":true,\"filter_with_empty\":[\"敏感词\"],\"filter_with_signed\":[\"敏感词\"]}",

enable_poi_fc（nostream接口&双向流式优化版-开启二遍支持）

开启 POI function call

2

bool

对于语音识别困难的词语，能调用专业的地图领域推荐词服务辅助识别
示例：

"request": {
    "enable_poi_fc": true,
    "corpus": {
        "context": "{\"loc_info\":{\"city_name\":\"北京市\"}}"
    }
}

其中loc_info字段可选，传入该字段结果相对更精准，city_name单位为地级市。

enable_music_fc（nostream接口&双向流式优化版-开启二遍支持）

开启音乐 function call

2

bool

对于语音识别困难的词语，能调用专业的音领域推荐词服务辅助识别
示例：

"request": {
    "enable_music_fc": true
}

corpus

语料/干预词等

2

dict

boosting_table_name

自学习平台上设置的热词词表名称

3

string

热词表功能和设置方法可以参考文档

boosting_table_id

自学习平台上设置的热词词表id

3

string

热词表功能和设置方法可以参考文档

correct_table_name

自学习平台上设置的替换词词表名称

3

string

替换词功能和设置方法可以参考文档

correct_table_id

自学习平台上设置的替换词词表id

3

string

替换词功能和设置方法可以参考文档

context

热词或者上下文

3

string

1. 热词直传（优先级高于传热词表），双向流式支持100tokens，流式输入nostream支持5000个词

"context":"{"hotwords":[{"word":"热词1号"}, {"word":"热词2号"}]}"

2. 上下文，限制800 tokens及20轮（含）内，超出会按照时间顺序从新到旧截断，优先保留更新的对话

context_data字段按照从新到旧的顺序排列，传入需要序列化为jsonstring（转义引号）
豆包流式语音识别模型2.0，支持将上下文理解的范围从纯文本扩展到视觉层面，
通过理解图像内容，帮助模型更精准地完成语音转录。通过image_url传入图片，
图片限制传入1张，大小：500k以内（格式：jpeg、jpg、png ）

上下文:可以加入对话历史、聊天所在bot信息、个性化信息、业务场景信息等,如:
a.对话历史:把最近几轮的对话历史传进来
b.聊天所在bot信息:如"我在和林黛玉聊天","我在使用A助手和手机对话"
c.个性化信息:"我当前在北京市海淀区","我有四川口音","我喜欢音乐"
d.业务场景信息:"当前是中国平安的营销人员针对外部客户采访的录音,可能涉及..."
{
    \"context_type\": \"dialog_ctx\",
    \"context_data\":[
        {\"text\": \"text1\"},
        {\"image_url\": \"image_url\"},
        {\"text\": \"text2\"},
        {\"text\": \"text3\"},
        {\"text\": \"text4\"},
        ...
    ]
}

Header

Payload size (4B, unsigned int32)

Payload

Header

Sequence

Payload size (4B, unsigned int32)

Payload

result

识别结果

1

list

仅当识别成功时填写

text

整个音频的识别结果文本

2

string

仅当识别成功时填写。

utterances

识别结果语音分句信息

2

list

仅当识别成功且开启show_utterances时填写。

text

utterance级的文本内容

3

string

仅当识别成功且开启show_utterances时填写。

start_time

起始时间（毫秒）

3

int

仅当识别成功且开启show_utterances时填写。

end_time

结束时间（毫秒）

3

int

仅当识别成功且开启show_utterances时填写。

definite

是否是一个确定分句

3

bool

仅当识别成功且开启show_utterances时填写。

Header

Error message code (4B, unsigned int32)

Error message size (4B, unsigned int32)

Error message (UTF8 string)

20000000

成功

45000001

请求参数无效

请求参数缺失必需字段 / 字段值无效 / 重复请求。

45000002

空音频

45000081

等包超时

45000151

音频格式不正确

550xxxxx

服务内部处理错误

55000031

服务器繁忙

服务过载，无法处理当前请求。