跳转到主要内容
千问云 home page
开放平台文档
定制热词

定制热词 HTTP API

通过HTTP API管理定制热词列表，包括创建、查询、更新和删除热词列表。

用户指南：定制热词。

服务端点

POST https://dashscope.aliyuncs.com/api/v1/services/audio/asr/customization

请求头

参数类型是否必选说明
Authorizationstring是鉴权令牌，格式为Bearer $DASHSCOPE_API_KEY。
Content-Typestring是请求体的媒体类型，固定为application/json。

创建热词列表

请求体

model string （必选） 定制热词模型，固定为speech-biasing。 input object （必选） 输入参数对象。

请求示例

curl -X POST https://dashscope.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "create_vocabulary",
        "target_model": "fun-asr",
        "prefix": "testpfx",
        "vocabulary": [
          {"text": "赛德克巴莱", "weight": 4}
        ]
    }
}'

返回体

request_id string 本次调用的唯一标识符。 output object 模型返回的数据。 usage object 本次请求用量信息。

返回示例

{
  "output": {
    "vocabulary_id": "vocab-testpfx-5112c3de3705486baxxxxxxx"
  },
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

批量查询热词列表

请求体

model string （必选） 定制热词模型，固定为speech-biasing。 input object （必选） 输入参数对象。

请求示例

curl -X POST https://dashscope.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "list_vocabulary",
        "prefix": "testpfx",
        "page_index": 0,
        "page_size": 10
    }
}'

返回体

request_id string 本次调用的唯一标识符。 output object 模型返回的数据。 usage object 本次请求用量信息。

返回示例

{
  "output": {
    "vocabulary_list": [
      {
        "gmt_create": "2026-03-02 18:07:38",
        "gmt_modified": "2026-03-02 18:07:38",
        "status": "OK",
        "vocabulary_id": "vocab-ciotest-8e74bef2accf4xxxxxxxx"
      },
      {
        "gmt_create": "2026-02-27 19:04:48",
        "gmt_modified": "2026-02-28 13:40:40",
        "status": "OK",
        "vocabulary_id": "vocab-sifasr-f483ad46e1844fxxxxxxxx"
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "request_id": "81d51a05-8cdd-45c0-973f-xxxxxxxx"
}

查询热词列表

请求体

model string （必选） 定制热词模型，固定为speech-biasing。 input object （必选） 输入参数对象。

请求示例

curl -X POST https://dashscope.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "query_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxxx"
    }
}'

返回体

request_id string 本次调用的唯一标识符。 output object 模型返回的数据。 usage object 本次请求用量信息。

返回示例

{
  "output": {
    "gmt_create": "2025-12-19 11:47:11",
    "gmt_modified": "2025-12-19 11:47:11",
    "status": "OK",
    "target_model": "fun-asr",
    "vocabulary": [
      {
        "lang": "zh",
        "text": "赛德克巴莱",
        "weight": 4
      }
    ]
  },
  "usage": {
    "count": 1
  },
  "request_id": "3d461d3f-b2c4-4de5-xxxx"
}

更新热词列表

请求体

model string （必选） 定制热词模型，固定为speech-biasing。 input object （必选） 输入参数对象。

请求示例

curl -X POST https://dashscope.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "update_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx",
        "vocabulary": [
          {"text": "赛德克巴莱", "weight": 4, "lang": "zh"}
        ]
    }
}'

返回体

request_id string 本次调用的唯一标识符。 output object 模型返回的数据，固定为空。 usage object 本次请求用量信息。

返回示例

{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}

删除热词列表

请求体

model string （必选） 定制热词模型，固定为speech-biasing。 input object （必选） 输入参数对象。

请求示例

curl -X POST https://dashscope.aliyuncs.com/api/v1/services/audio/asr/customization \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "speech-biasing",
    "input": {
        "action": "delete_vocabulary",
        "vocabulary_id": "vocab-testpfx-xxx"
    }
}'

返回体

request_id string 本次调用的唯一标识符。 output object 模型返回的数据，固定为空。 usage object 本次请求用量信息。

返回示例

{
  "output": {},
  "usage": {
    "count": 1
  },
  "request_id": "aee47022-2352-40fe-acfa-xxxx"
}