定制热词

Python

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


# 新加坡和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
# 若没有配置环境变量，请用百炼API Key将下行替换为：dashscope.api_key = "sk-xxx"
dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')

# 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1
dashscope.base_http_api_url = 'https://dashscope.aliyuncs.com/api/v1'

# 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：wss://dashscope-intl.aliyuncs.com/api-ws/v1/inference
dashscope.base_websocket_api_url='wss://dashscope.aliyuncs.com/api-ws/v1/inference'

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

my_vocabulary = [
    {"text": "语音实验室", "weight": 4}
]

service = VocabularyService()
vocabulary_id = service.create_vocabulary(
      prefix=prefix,
      target_model=target_model,
      vocabulary=my_vocabulary)

if service.query_vocabulary(vocabulary_id)['status'] == 'OK':
    recognition = Recognition(model=target_model,
                          format='wav',
                          sample_rate=16000,
                          callback=None,
                          vocabulary_id=vocabulary_id)
    result = recognition.call('asr_example.wav')
    print(result.output)

service.delete_vocabulary(vocabulary_id)

Java

import com.alibaba.dashscope.audio.asr.recognition.Recognition;
import com.alibaba.dashscope.audio.asr.recognition.RecognitionParam;
import com.alibaba.dashscope.audio.asr.vocabulary.Vocabulary;
import com.alibaba.dashscope.audio.asr.vocabulary.VocabularyService;
import com.alibaba.dashscope.exception.InputRequiredException;
import com.alibaba.dashscope.exception.NoApiKeyException;
import com.alibaba.dashscope.utils.Constants;
import com.google.gson.JsonArray;
import com.google.gson.JsonObject;

import java.io.File;
import java.util.ArrayList;
import java.util.List;

public class Main {
    // 新加坡和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
    // 若没有配置环境变量，请用百炼API Key将下行替换为：public static String apiKey = "sk-xxx"
    public static String apiKey = System.getenv("DASHSCOPE_API_KEY");

    public static void main(String[] args) throws NoApiKeyException, InputRequiredException {
        // 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1
        Constants.baseHttpApiUrl = "https://dashscope.aliyuncs.com/api/v1";
        // 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：wss://dashscope-intl.aliyuncs.com/api-ws/v1/inference
        Constants.baseWebsocketApiUrl = "wss://dashscope.aliyuncs.com/api-ws/v1/inference";

        String targetModel = "fun-asr-realtime";

        JsonArray vocabularyJson = new JsonArray();
        List<Hotword> wordList = new ArrayList<>();
        wordList.add(new Hotword("语音实验室", 4));

        for (Hotword word : wordList) {
            JsonObject jsonObject = new JsonObject();
            jsonObject.addProperty("text", word.text);
            jsonObject.addProperty("weight", word.weight);
            vocabularyJson.add(jsonObject);
        }

        VocabularyService service = new VocabularyService(apiKey);
        Vocabulary vocabulary = service.createVocabulary(targetModel, "testpfx", vocabularyJson);

        if ("OK".equals(service.queryVocabulary(vocabulary.getVocabularyId()).getStatus())) {
            Recognition recognizer = new Recognition();
            // 创建RecognitionParam
            RecognitionParam param =
                    RecognitionParam.builder()
                            .model(targetModel)
                            .apiKey(apiKey)
                            .format("wav")
                            .sampleRate(16000)
                            .build();

            try {
                System.out.println("识别结果：" + recognizer.call(param, new File("asr_example.wav")));
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                // 任务结束后关闭 WebSocket 连接
                recognizer.getDuplexApi().close(1000, "bye");
            }
        }

        service.deleteVocabulary(vocabulary.getVocabularyId());
        System.exit(0);
    }
}

class Hotword {
    String text;
    int weight;

    public Hotword(String text, int weight) {
        this.text = text;
        this.weight = weight;
    }
}

Python SDK

• 接口说明

  重要

  target_model：使用热词列表的语音识别模型，须和后续调用语音识别接口时使用的语音识别模型一致

  def create_vocabulary(self, target_model: str, prefix: str, vocabulary: List[dict]) -> str:
      '''
      创建热词列表
      param: target_model 热词列表对应的语音识别模型，必须与后续调用语音识别接口时使用的语音识别模型一致
      param: prefix 热词列表自定义前缀，仅允许数字和小写字母，小于十个字符。
      param: vocabulary 热词列表JSON
      return: 热词列表ID
      '''

• 示例代码

  import dashscope
  from dashscope.audio.asr import *
  import os
  
  # 新加坡和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
  # 若没有配置环境变量，请用百炼API Key将下行替换为：dashscope.api_key = "sk-xxx"
  dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
  
  # 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1
  dashscope.base_http_api_url = 'https://dashscope.aliyuncs.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}")

Java SDK

• 接口说明

  重要

  targetModel：使用热词列表的语音识别模型，须和后续调用语音识别接口时使用的语音识别模型一致

  /**
   * 创建新的热词列表
   *
   * @param targetModel 热词列表对应的语音识别模型，必须与后续调用语音识别接口时使用的语音识别模型一致
   * @param prefix 热词自定义前缀，仅允许数字和小写字母，小于十个字符。
   * @param vocabulary 热词列表JSON
   * @return 热词列表对象
   * @throws NoApiKeyException 如果apikey为空
   * @throws InputRequiredException 如果必须参数为空
   */
  public Vocabulary createVocabulary(String targetModel, String prefix, JsonArray vocabulary)
      throws NoApiKeyException, InputRequiredException 

• 示例代码

  import com.alibaba.dashscope.audio.asr.vocabulary.Vocabulary;
  import com.alibaba.dashscope.audio.asr.vocabulary.VocabularyService;
  import com.alibaba.dashscope.exception.InputRequiredException;
  import com.alibaba.dashscope.exception.NoApiKeyException;
  import com.alibaba.dashscope.utils.Constants;
  import com.google.gson.JsonArray;
  import com.google.gson.JsonObject;
  
  import java.util.ArrayList;
  import java.util.List;
  
  public class Main {
      // 新加坡和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
      // 若没有配置环境变量，请用百炼API Key将下行替换为：public static String apiKey = "sk-xxx"
      public static String apiKey = System.getenv("DASHSCOPE_API_KEY");
  
      public static void main(String[] args) throws NoApiKeyException, InputRequiredException {
          // 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1
          Constants.baseHttpApiUrl = "https://dashscope.aliyuncs.com/api/v1";
          String targetModel = "fun-asr";
  
          JsonArray vocabularyJson = new JsonArray();
          List<Hotword> wordList = new ArrayList<>();
          wordList.add(new Hotword("吴贻弓", 4));
          wordList.add(new Hotword("阙里人家", 4));
  
          for (Hotword word : wordList) {
              JsonObject jsonObject = new JsonObject();
              jsonObject.addProperty("text", word.text);
              jsonObject.addProperty("weight", word.weight);
              vocabularyJson.add(jsonObject);
          }
  
          VocabularyService service = new VocabularyService(apiKey);
          Vocabulary vocabulary = service.createVocabulary(targetModel, "testpfx", vocabularyJson);
          System.out.println("热词列表ID：" + vocabulary.getVocabularyId());
      }
  }
  
  class Hotword {
      String text;
      int weight;
      String lang;
  
      public Hotword(String text, int weight) {
          this.text = text;
          this.weight = weight;
      }
  }

RESTful API

• URL

  中国大陆（北京）：

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

  国际（新加坡）：

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

• 请求头

  参数	类型	是否必须	说明
  Authorization	string	支持	鉴权令牌，格式为Bearer <your_api_key>，使用时，将“<your_api_key>”替换为实际的API Key。
  Content-Type	string	支持	请求体中传输的数据的媒体类型。固定为application/json。

• 消息体

  包含所有请求参数的消息体如下，对于可选字段，在实际业务中可根据需求省略。

  重要

  注意区分如下参数：

  • model：定制热词模型，固定为speech-biasing

  • target_model：使用热词列表的语音识别模型，须和后续调用语音识别接口时使用的语音识别模型一致

  {
      "model": "speech-biasing",
      "input": {
          "action": "create_vocabulary",
          "target_model": "fun-asr",
          "prefix": "testpfx",
          "vocabulary": [
            {"text": "赛德克巴莱", "weight": 4, "lang": "zh"}
          ]
      }
  }

• 请求参数

  参数	类型	默认值	是否必须	说明
  model	string	-	支持	定制热词模型，固定为speech-biasing。
  action	string	-	支持	操作类型，固定为create_vocabulary。
  target_model	string	-	支持	使用热词列表的语音识别模型。详情请参见支持的模型。 必须与后续调用语音识别接口时使用的语音识别模型一致。
  prefix	string	-	支持	为热词列表指定一个便于识别的名称（仅允许数字和小写字母，长度小于十个字符）。 该关键字会在热词列表ID中出现，例如关键字为“testpfx”，最终热词列表ID为“vocab-testpfx-51773d05xxxxxx”
  vocabulary	array[object]	-	支持	热词列表JSON，详情请参见热词简介。

• 响应参数

  点击查看响应示例

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

  需关注的参数如下：

  参数	类型	说明
  vocabulary_id	string	热词列表ID。

• 示例代码

  cURL示例如下（Java和Python示例请参见对应的SDK）。

  若未将API Key配置到环境变量，需将示例中的$DASHSCOPE_API_KEY替换为实际的API Key。

  # ======= 重要提示 =======
  # 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1/services/audio/asr/customization
  # 新加坡地域和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
  # === 执行时请删除该注释 ===
  
  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}
          ]
      }
  }'

Python SDK

• 接口说明

  def list_vocabularies(self, prefix=None, page_index: int = 0, page_size: int = 10) -> List[dict]:
      '''
      查询已创建的所有热词列表
      param: prefix 自定义前缀，如果设定则只返回指定前缀的热词列表标识符列表。
      param: page_index 查询的页索引
      param: page_size 查询页大小
      return: 热词列表标识符列表
      '''

• 示例代码

  import dashscope
  from dashscope.audio.asr import *
  import json
  import os
  
  # 新加坡和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
  # 若没有配置环境变量，请用百炼API Key将下行替换为：dashscope.api_key = "sk-xxx"
  dashscope.api_key = os.environ.get('DASHSCOPE_API_KEY')
  
  # 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1
  dashscope.base_http_api_url = 'https://dashscope.aliyuncs.com/api/v1'
  
  service = VocabularyService()
  vocabularies = service.list_vocabularies()
  print(f"热词列表：{json.dumps(vocabularies)}")

• 响应参数

  点击查看响应示例

  [
    {
      "gmt_create": "2025-04-22 14:23:35",
      "vocabulary_id": "vocab-testpfx-5112c3de3705486baxxxxxxx",
      "gmt_modified": "2025-04-22 14:23:35",
      "status": "OK"
    }
  ]

  需关注的参数如下：

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

Java SDK

• 接口说明

  /**
   * 查询已创建的所有热词列表。默认的页索引为0，默认的页大小为10
   *
   * @param prefix 热词自定义前缀
   * @return 热词列表对象数组
   * @throws NoApiKeyException 如果apikey为空
   * @throws InputRequiredException 如果必须参数为空
   */
  public Vocabulary[] listVocabulary(String prefix)
      throws NoApiKeyException, InputRequiredException
  
  /**
   * 查询已创建的所有热词列表
   *
   * @param prefix 热词自定义前缀
   * @param pageIndex 查询的页索引
   * @param pageSize 查询的页大小
   * @return 热词列表对象数组
   * @throws NoApiKeyException 如果apikey为空
   * @throws InputRequiredException 如果必须参数为空
   */
  public Vocabulary[] listVocabulary(String prefix, int pageIndex, int pageSize)
      throws NoApiKeyException, InputRequiredException

• 示例代码

  import com.alibaba.dashscope.audio.asr.vocabulary.Vocabulary;
  import com.alibaba.dashscope.audio.asr.vocabulary.VocabularyService;
  import com.alibaba.dashscope.exception.InputRequiredException;
  import com.alibaba.dashscope.exception.NoApiKeyException;
  import com.alibaba.dashscope.utils.Constants;
  import com.google.gson.Gson;
  import com.google.gson.GsonBuilder;
  
  public class Main {
      // 新加坡和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
      // 若没有配置环境变量，请用百炼API Key将下行替换为：public static String apiKey = "sk-xxx"
      public static String apiKey = System.getenv("DASHSCOPE_API_KEY");
  
      public static void main(String[] args) throws NoApiKeyException, InputRequiredException {
          // 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1
          Constants.baseHttpApiUrl = "https://dashscope.aliyuncs.com/api/v1";
  
          VocabularyService service = new VocabularyService(apiKey);
          Vocabulary[] vocabularies = service.listVocabulary("testpfx");
          Gson gson = new GsonBuilder()
                  .setPrettyPrinting()
                  .create();
          System.out.println("热词列表：" + gson.toJson(vocabularies));
      }
  }

• 点击查看响应示例

  [
    {
      "gmt_create": "2025-04-22 14:23:35",
      "vocabulary_id": "vocab-testpfx-5112c3de3705486baxxxxxxx",
      "gmt_modified": "2025-04-22 14:23:35",
      "status": "OK"
    }
  ]

  需关注的参数如下：

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

RESTful API

• URL

  中国大陆（北京）：

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

  国际（新加坡）：

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

• 请求头

  参数	类型	是否必须	说明
  Authorization	string	支持	鉴权令牌，格式为Bearer <your_api_key>，使用时，将“<your_api_key>”替换为实际的API Key。
  Content-Type	string	支持	请求体中传输的数据的媒体类型。固定为application/json。

• 消息体

  包含所有请求参数的消息体如下，对于可选字段，在实际业务中可根据需求省略。

  重要

  model：定制热词模型，固定为speech-biasing

  {
      "model": "speech-biasing",
      "input": {
          "action": "list_vocabulary",
          "prefix": "testpfx",
          "page_index": 0,
          "page_size": 10
      }
  }

• 请求参数

  参数	类型	默认值	是否必须	说明
  model	string	-	支持	定制热词模型，固定为speech-biasing。
  action	string	-	支持	操作类型，固定为list_vocabulary。
  prefix	string	-	不支持	热词列表自定义前缀，仅允许数字和小写字母，小于十个字符。
  page_index	integer	0	不支持	页码索引，从0开始计数。
  page_size	integer	10	不支持	每页包含数据条数。

• 响应参数

  点击查看响应示例

  {
    "output": {
      "vocabulary_list": [
        {
          "gmt_create": "2025-12-19 11:47:11",
          "gmt_modified": "2025-12-19 11:47:11",
          "status": "OK",
          "vocabulary_id": "vocab-testpfx-xxxxxxxx"
        }
      ]
    },
    "usage": {
      "count": 1
    },
    "request_id": "10e8cde2-b711-4609-b19b-xxxxxx"
  }

  需关注的参数如下：

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

• 示例代码

  cURL示例如下（Java和Python示例请参见对应的SDK）。

  若未将API Key配置到环境变量，需将示例中的$DASHSCOPE_API_KEY替换为实际的API Key。

  # ======= 重要提示 =======
  # 以下为北京地域url，若使用新加坡地域的模型，需将url替换为：https://dashscope-intl.aliyuncs.com/api/v1/services/audio/asr/customization
  # 新加坡地域和北京地域的API Key不同。获取API Key：https://help.aliyun.com/zh/model-studio/get-api-key
  # === 执行时请删除该注释 ===
  
  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
      }
  }'