Intelligent Speech Interaction:Use the POP API to manage business-specific hotwords

Add dependencies and configure credentials

The example uses aliyun-java-sdk-core 3.7.1 and fastjson 1.2.83. For SDK setup, see Get started. For generic request usage, see Generic calls.

The Alibaba Cloud SDK for Java core library must be version 3.5.0 or later. Versions 4.0.0 and later also require their corresponding third-party dependencies.

<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>aliyun-java-sdk-core</artifactId>
    <version>3.7.1</version>
</dependency>
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>fastjson</artifactId>
    <version>1.2.83</version>
</dependency>

Set ALIYUN_AK_ID and ALIYUN_AK_SECRET to the AccessKey ID and AccessKey secret, respectively. The code reads credentials from these environment variables; no command-line arguments are required.

Call the API

After the update, WordWeights contains only watermelon, demonstrating full replacement. The example creates one vocabulary, so the account must have an available vocabulary slot before execution.

import com.alibaba.fastjson.JSONObject;
import com.aliyuncs.CommonRequest;
import com.aliyuncs.CommonResponse;
import com.aliyuncs.DefaultAcsClient;
import com.aliyuncs.IAcsClient;
import com.aliyuncs.exceptions.ClientException;
import com.aliyuncs.http.MethodType;
import com.aliyuncs.http.ProtocolType;
import com.aliyuncs.profile.DefaultProfile;
import java.util.UUID;

public class AsrVocabPopApiDemo {
    private static final String REGION_ID = "ap-southeast-1";
    private static final String DOMAIN = "nls-slp.ap-southeast-1.aliyuncs.com";
    private final IAcsClient client;

    public AsrVocabPopApiDemo(String accessKeyId, String accessKeySecret) {
        client = new DefaultAcsClient(DefaultProfile.getProfile(
                REGION_ID, accessKeyId, accessKeySecret));
    }

    private CommonRequest request(String action) {
        CommonRequest request = new CommonRequest();
        request.setDomain(DOMAIN);
        request.setProtocol(ProtocolType.HTTPS);
        request.setVersion("2018-11-20");
        request.setMethod(MethodType.POST);
        request.setAction(action);
        return request;
    }

    private JSONObject execute(CommonRequest request) {
        CommonResponse response;
        try {
            response = client.getCommonResponse(request);
        } catch (ClientException e) {
            throw new IllegalStateException("Request failed: " + e.getErrCode());
        }
        JSONObject result = JSONObject.parseObject(response.getData());
        if (response.getHttpStatus() != 200) {
            throw new IllegalStateException("HTTP " + response.getHttpStatus()
                    + ", Code=" + result.getString("Code")
                    + ", Message=" + result.getString("Message")
                    + ", RequestId=" + result.getString("RequestId"));
        }
        return result;
    }

    public String createAsrVocab(String name, String description, JSONObject words) {
        CommonRequest request = request("CreateAsrVocab");
        request.putBodyParameter("Name", name);
        request.putBodyParameter("Description", description);
        request.putBodyParameter("WordWeights", words.toJSONString());
        return execute(request).getString("VocabId");
    }

    public JSONObject getAsrVocab(String vocabId) {
        CommonRequest request = request("GetAsrVocab");
        request.putBodyParameter("Id", vocabId);
        return execute(request).getJSONObject("Vocab");
    }

    public void updateAsrVocab(String vocabId, String name,
            String description, JSONObject words) {
        CommonRequest request = request("UpdateAsrVocab");
        request.putBodyParameter("Id", vocabId);
        request.putBodyParameter("Name", name);
        request.putBodyParameter("Description", description);
        request.putBodyParameter("WordWeights", words.toJSONString());
        execute(request);
    }

    public JSONObject listAsrVocab(int pageNumber, int pageSize) {
        CommonRequest request = request("ListAsrVocab");
        request.putBodyParameter("PageNumber", pageNumber);
        request.putBodyParameter("PageSize", pageSize);
        return execute(request).getJSONObject("Page");
    }

    public void deleteAsrVocab(String vocabId) {
        CommonRequest request = request("DeleteAsrVocab");
        request.putBodyParameter("Id", vocabId);
        execute(request);
    }

    private static String requiredEnv(String name) {
        String value = System.getenv(name);
        if (value == null || value.trim().isEmpty()) {
            throw new IllegalArgumentException("Set environment variable " + name);
        }
        return value;
    }

    public static void main(String[] args) {
        AsrVocabPopApiDemo demo = new AsrVocabPopApiDemo(
                requiredEnv("ALIYUN_AK_ID"), requiredEnv("ALIYUN_AK_SECRET"));
        String name = "example_vocab_" + UUID.randomUUID().toString();
        JSONObject words = new JSONObject();
        words.put("apple", 3);
        words.put("watermelon", 3);

        String vocabId = demo.createAsrVocab(name, "Example vocabulary", words);
        System.out.println("Created vocabulary: " + vocabId);
        try {
            System.out.println("Vocabulary: " + demo.getAsrVocab(vocabId));

            JSONObject updatedWords = new JSONObject();
            updatedWords.put("watermelon", 2);
            demo.updateAsrVocab(vocabId, name, "Updated vocabulary", updatedWords);
            System.out.println("Updated vocabulary: " + demo.getAsrVocab(vocabId));

            JSONObject page = demo.listAsrVocab(1, 10);
            System.out.println("Total vocabularies: " + page.getIntValue("TotalItems"));
        } finally {
            demo.deleteAsrVocab(vocabId);
            System.out.println("Deleted example vocabulary: " + vocabId);
        }
    }
}

Create a vocabulary

Call CreateAsrVocab to create a vocabulary.

Retrieve a vocabulary

Call GetAsrVocab to retrieve a vocabulary.

Update a vocabulary

Call UpdateAsrVocab to update the name, description, and word weights. WordWeights replaces all existing hotwords and weights; it does not append to them. Include all hotwords to retain in the request.

Delete a vocabulary

Call DeleteAsrVocab to delete a vocabulary.

List vocabularies

Call ListAsrVocab to retrieve vocabularies by page. Results are sorted by update time in descending order. Hotwords and weights are omitted to reduce the response size.