定制热词Python SDK参考

用户指南：提升识别准确率。热词列表数量上限等使用限制详见热词限制与计费。

接口地址

https://maas.qianwenaiapi.com/api/v1

VocabularyService

包路径：dashscope.audio.asr.VocabularyService 功能：管理热词列表的生命周期（创建、查询、更新、删除）

构造方法

VocabularyService(api_key: str = None, workspace: str = None, model: str = None)

未传 api_key 时，SDK 使用全局 dashscope.api_key 的值。

create_vocabulary() - 创建热词列表

方法签名：

def create_vocabulary(
    self,
    target_model: str,
    prefix: str,
    vocabulary: List[dict]) -> str

参数：

参数	类型	必填	说明
target_model	str	是	使用热词列表的语音识别模型，必须与后续调用语音识别接口时使用的模型一致。
prefix	str	是	热词列表自定义前缀，仅允许数字和小写字母，长度不超过10个字符。
vocabulary	List[dict]	是	热词列表，每个dict包含 text、weight、lang 等字段。详情请参见热词字典结构。

返回值：

类型	说明
str	热词列表ID。

list_vocabularies() - 批量查询热词列表

对应 HTTP API 的 action: list_vocabulary（HTTP 用单数，Python 方法名用复数 list_vocabularies）。 方法签名：

def list_vocabularies(
    self,
    prefix: str = None,
    page_index: int = 0,
    page_size: int = 10) -> List[dict]

参数：

参数	类型	必填	说明
prefix	str	否	热词列表自定义前缀，如果设定则只返回指定前缀的热词列表。
page_index	int	否	页码索引，从0开始计数。默认值：0。
page_size	int	否	每页包含数据条数。默认值：10。

返回值：

类型	说明
List[dict]	热词列表信息数组，每个dict包含 vocabulary_id、gmt_create、gmt_modified、status。

返回对象字段：

字段	类型	说明
vocabulary_id	str	热词列表ID。
gmt_create	str	创建时间。
gmt_modified	str	修改时间。
status	str	状态： OK：可调用 UNDEPLOYED：不可调用。

query_vocabulary() - 查询热词列表

方法签名：

def query_vocabulary(
    self,
    vocabulary_id: str) -> dict

参数：

参数	类型	必填	说明
vocabulary_id	str	是	需要查询的热词列表ID。

返回值：

类型	说明
dict	热词列表详细信息，包含 vocabulary、target_model、gmt_create、gmt_modified、status。

返回对象字段：

字段	类型	说明
vocabulary	List[dict]	热词列表内容。
target_model	str	使用热词列表的语音识别模型，必须与后续调用语音识别接口时使用的模型一致。
gmt_create	str	创建时间。
gmt_modified	str	修改时间。
status	str	状态： OK：可调用 UNDEPLOYED：不可调用。

update_vocabulary() - 更新热词列表

方法签名：

def update_vocabulary(
    self,
    vocabulary_id: str,
    vocabulary: List[dict]) -> None

参数：

参数	类型	必填	说明
vocabulary_id	str	是	需要更新的热词列表ID。
vocabulary	List[dict]	是	新的热词列表，将完全替换原有内容。

返回值：无

delete_vocabulary() - 删除热词列表

方法签名：

def delete_vocabulary(
    self,
    vocabulary_id: str) -> None

参数：

参数	类型	必填	说明
vocabulary_id	str	是	需要删除的热词列表ID。

返回值：无

热词字典结构

用于vocabulary参数的字典定义：

字段	类型	必填	说明
text	str	是	热词文本。热词文本的语言必须在所选模型的支持范围内，不同模型支持的语言各不相同。热词用于提升识别的准确率，请使用实际词语而非任意字符组合。长度限制：含非 ASCII 字符时不超过 15 个字符；纯 ASCII 时空格分隔片段不超过 7 个。
weight	int	是	热词权重。常用值：4。取值范围：[1, 5]。如果效果不明显，可以适当增加权重，但权重过大可能产生负面效果，导致其他词语识别不准确。
lang	str	否	待识别音频的语言代码。设置后，系统将对指定语种进行热词识别增强。如果无法提前确定语种，可不设置，模型会自动识别语种。取值范围（因模型而异）： Paraformer： zh: 中文 en: 英文 ja: 日语 yue: 粤语 ko: 韩语 de：德语 fr：法语 ru：俄语 Fun-ASR： zh: 中文 en: 英文 ja: 日语

示例代码

创建热词列表

import dashscope
from dashscope.audio.asr import *
import os

# 若没有配置环境变量，请用千问AI平台API Key将下行替换为：dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

dashscope.base_http_api_url = 'https://maas.qianwenaiapi.com/api/v1'

prefix = 'testpfx'
target_model = "fun-asr"

my_vocabulary = [
    {"text": "赛德克巴莱", "weight": 4}
]

# 创建热词
service = VocabularyService()
vocabulary_id = service.create_vocabulary(
    prefix=prefix,
    target_model=target_model,
    vocabulary=my_vocabulary)

print(f"热词列表ID为：{vocabulary_id}")

批量查询热词列表

import dashscope
from dashscope.audio.asr import *
import json
import os

# 若没有配置环境变量，请用千问AI平台API Key将下行替换为：dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

dashscope.base_http_api_url = 'https://maas.qianwenaiapi.com/api/v1'

service = VocabularyService()
vocabularies = service.list_vocabularies()
print(f"热词列表：{json.dumps(vocabularies)}")

查询热词列表

import dashscope
from dashscope.audio.asr import *
import json
import os

# 若没有配置环境变量，请用千问AI平台API Key将下行替换为：dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

dashscope.base_http_api_url = 'https://maas.qianwenaiapi.com/api/v1'

service = VocabularyService()
# 查询时替换为实际的热词列表ID
vocabulary = service.query_vocabulary("vocab-testpfx-xxx")
print(f"热词列表：{json.dumps(vocabulary)}")

更新热词列表

import dashscope
from dashscope.audio.asr import *
import os

# 若没有配置环境变量，请用千问AI平台API Key将下行替换为：dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

dashscope.base_http_api_url = 'https://maas.qianwenaiapi.com/api/v1'

service = VocabularyService()
my_vocabulary = [
    {"text": "赛德克巴莱", "weight": 4, "lang": "zh"}
]
# 替换为实际的热词列表ID
service.update_vocabulary("vocab-testpfx-xxx", my_vocabulary)

删除热词列表

import dashscope
from dashscope.audio.asr import *
import os

# 若没有配置环境变量，请用千问AI平台API Key将下行替换为：dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

dashscope.base_http_api_url = 'https://maas.qianwenaiapi.com/api/v1'

service = VocabularyService()
# 替换为实际的热词表ID
service.delete_vocabulary("vocab-testpfx-xxxx")

​接口地址

​VocabularyService

​构造方法

​create_vocabulary() - 创建热词列表

​list_vocabularies() - 批量查询热词列表

​query_vocabulary() - 查询热词列表

​update_vocabulary() - 更新热词列表

​delete_vocabulary() - 删除热词列表

​热词字典结构

​示例代码

​创建热词列表

​批量查询热词列表

​查询热词列表

​更新热词列表

​删除热词列表

接口地址

VocabularyService

构造方法

create_vocabulary() - 创建热词列表

list_vocabularies() - 批量查询热词列表

query_vocabulary() - 查询热词列表

update_vocabulary() - 更新热词列表

delete_vocabulary() - 删除热词列表

热词字典结构

示例代码

创建热词列表

批量查询热词列表

查询热词列表

更新热词列表

删除热词列表