Alibaba Cloud Model Studio:Custom vocabulary

import dashscope
from dashscope.audio.asr import *


dashscope.api_key = 'your-dashscope-api-key'
prefix = 'prefix'
target_model = "paraformer-realtime-v2"

my_vocabulary = [
    {"text": "吴贻弓", "weight": 4, "lang": "zh"},
    {"text": "阙里人家", "weight": 4, "lang": "zh"},
]


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

print(f"your vocabulary id is {vocabulary_id}")

# use the vocabulary to recognize a file
recognition = Recognition(model=target_model,
                          format='wav',
                          sample_rate=16000,
                          callback=None,
                          vocabulary_id=vocabulary_id,
                          language_hints=['zh'])  # Only paraformer-v2 and paraformer-realtime-v2 supports language_hints
result = recognition.call('your-audio-file.wav')
print(result.output)

package org.example.customization;

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.google.gson.JsonArray;
import com.google.gson.JsonObject;

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

public class VocabularySampleCodes {
    public static String apiKey = "your-dashscope-apikey";

    public static void main(String[] args) throws NoApiKeyException, InputRequiredException {
        String targetModel = "paraformer-realtime-v2";
        // prepare vocabulary
        class Hotword {
            String text;
            int weight;
            String lang;

            public Hotword(String text, int weight, String lang) {
                this.text = text;
                this.weight = weight;
                this.lang = lang;
            }
        }
        JsonArray vocabulary = new JsonArray();
        List<Hotword> wordList = new ArrayList<>();
        wordList.add(new Hotword("吴贻弓", 4, "zh"));
        wordList.add(new Hotword("阙里人家", 4, "zh"));

        for (Hotword word : wordList) {
            JsonObject jsonObject = new JsonObject();
            jsonObject.addProperty("text", word.text);
            jsonObject.addProperty("weight", word.weight);
            jsonObject.addProperty("lang", word.lang);
            vocabulary.add(jsonObject);
        }
        // create vocabulary
        VocabularyService service = new VocabularyService(apiKey);
        Vocabulary myVoc = service.createVocabulary(targetModel, "prefix", vocabulary);
        System.out.println("your vocabulary id is " + myVoc.getVocabularyId());
        // use the vocabulary to recognize a file
        Recognition recognizer = new Recognition();
        RecognitionParam param =
                RecognitionParam.builder()
                        .model(targetModel)
                        .format("wav")
                        .sampleRate(16000)
                        .apiKey(apiKey)
                        .vocabularyId(myVoc.getVocabularyId())
                        // Only paraformer-v2 and paraformer-realtime-v2 supports language_hints
                        .parameter("language_hints", new String[] {"zh"})
                        .build();
        String result = recognizer.call(param, new File("your-local-audio-file.wav"));
        System.out.println(result);
        System.exit(0);
    }
}

service = VocabularyService(api_key="your-dashscope-apikey")

VocabularyService service = new VocabularyService("your-dashscope-apikey");

def create_vocabulary(self, target_model: str, prefix: str, vocabulary: List[dict]) -> str:
    '''
    Create a vocabulary.
    param: target_model The speech recognition model for the vocabulary.
    param: prefix A custom prefix for the vocabulary. It must contain fewer than 10 lowercase letters and digits.
    param: vocabulary A dictionary for the vocabulary.
    return: The vocabulary ID.
    '''

/**
 * Create a new vocabulary.
 *
 * @param targetModel The speech recognition model for the vocabulary.
 * @param prefix A custom prefix for the vocabulary. It must contain fewer than 10 lowercase letters and digits.
 * @param vocabulary The vocabulary list.
 * @return The vocabulary object.
 * @throws NoApiKeyException if the API key is empty.
 * @throws InputRequiredException if a required parameter is empty.
 */
public Vocabulary createVocabulary(String targetModel, String prefix, JsonArray vocabulary)
    throws NoApiKeyException, InputRequiredException 

def list_vocabularies(self, prefix=None, page_index: int = 0, page_size: int = 10) -> List[dict]:
    '''
    Query all created vocabularies.
    param: prefix A custom prefix. If specified, returns only the vocabularies with this prefix.
    param: page_index The page index.
    param: page_size The page size.
    return: A list of vocabulary identifiers.
    '''

/**
 * Query all created vocabularies. The default page index is 0, and the default page size is 10.
 *
 * @param prefix A custom prefix for the vocabulary.
 * @return An array of vocabulary objects.
 * @throws NoApiKeyException if the API key is empty.
 * @throws InputRequiredException if a required parameter is empty.
 */
public Vocabulary[] listVocabulary(String prefix)
    throws NoApiKeyException, InputRequiredException

/**
 * Query all created vocabularies.
 *
 * @param prefix A custom prefix for the vocabulary.
 * @param pageIndex The page index.
 * @param pageSize The page size.
 * @return An array of vocabulary objects.
 * @throws NoApiKeyException if the API key is empty.
 * @throws InputRequiredException if a required parameter is empty.
 */
public Vocabulary[] listVocabulary(String prefix, int pageIndex, int pageSize)
    throws NoApiKeyException, InputRequiredException

def query_vocabulary(self, vocabulary_id: str) -> List[dict]:
    '''
    Get the content of a vocabulary.
    param: vocabulary_id The vocabulary identifier.
    return: The vocabulary.
    '''

/**
 * Query a specific vocabulary.
 *
 * @param vocabularyId The vocabulary to query.
 * @return The vocabulary object.
 * @throws NoApiKeyException if the API key is empty.
 * @throws InputRequiredException if a required parameter is empty.
 */
public Vocabulary queryVocabulary(String vocabularyId)
    throws NoApiKeyException, InputRequiredException

def update_vocabulary(self, vocabulary_id: str, vocabulary: List[dict]) -> None:
    '''
    Replace an existing vocabulary with a new one.
    param: vocabulary_id The identifier of the vocabulary to replace.
    param: vocabulary The vocabulary.
    '''

/**
 * Update a vocabulary.
 *
 * @param vocabularyId The vocabulary to update.
 * @param vocabulary The vocabulary object.
 * @throws NoApiKeyException if the API key is empty.
 * @throws InputRequiredException if a required parameter is empty.
 */
public void updateVocabulary(String vocabularyId, JsonArray vocabulary)
    throws NoApiKeyException, InputRequiredException

def delete_vocabulary(self, vocabulary_id: str) -> None:
    '''
    Delete a vocabulary.
    param: vocabulary_id The identifier of the vocabulary to delete.
    '''

/**
 * Delete a vocabulary.
 *
 * @param vocabularyId The vocabulary to delete.
 * @throws NoApiKeyException if the API key is empty.
 * @throws InputRequiredException if a required parameter is empty.
 */
public void deleteVocabulary(String vocabularyId)
    throws NoApiKeyException, InputRequiredException