HTTP API for Short Sentence Recognition

Prerequisites

• You have completed the configurations as instructed in Configuring the Java Environment.
• Ensure that the audio file to be recognized exists. If needed, you can obtain the sample audio file from the downloaded SDK package.

Initializing Client

Initialize AsrCustomizationClient. Its parameters include AuthInfo and SisConfig.

Request Parameters

The request class is AsrCustomShortRequest. For details, see Table 3.

Response Parameters

The response class is AsrCustomShortResponse. For details, see Table 4.

Sample Code

The following example is for reference only. Obtain and run the latest code in section Obtaining SDKs.

import com.huawei.sis.bean.SisConfig;
import com.huawei.sis.bean.SisConstant;
import com.huawei.sis.bean.request.AsrCustomShortRequest;
import com.huawei.sis.bean.response.AsrCustomShortResponse;
import com.huawei.sis.bean.AuthInfo;
import com.huawei.sis.client.AsrCustomizationClient;
import com.huawei.sis.exception.SisException;
import com.huawei.sis.util.IOUtils;
import java.util.List;
import com.huawei.sis.util.JsonUtils;


/**
 * Short Sentence Recognition
 *
 * Copyright 2021 Huawei Technologies Co.,Ltd.
 */
public class AsrCustomizationDemo {
  private static final int SLEEP_TIME = 500;
  private static final int MAX_POLLING_NUMS = 1000;

  // Hard-coded or plaintext AK and SK are risky. For security purposes, encrypt your AK and SK and store them in the configuration file or environment variables.
  // In this example, the AK and SK are stored in environment variables for identity authentication. Before running this example, configure environment variables HUAWEICLOUD_SDK_AK and HUAWEICLOUD_SDK_SK.
  private String ak = System.getenv("HUAWEICLOUD_SDK_AK");
  private String sk = System.getenv("HUAWEICLOUD_SDK_SK");
  

  private String region = "";    // Region, such as ap-southeast-3
  private String projectId = ""; // Project ID corresponding to the region. Log in to the management console, move the cursor over your username in the upper right corner, and choose My Credentials from the drop-down list. On the displayed page, view the project ID. If there are multiple projects, expand Region and obtain the sub-project ID from the Project ID column.
* 
  // Sentence Transcription parameters
  private String path = "";             // Audio file path, for example, D:/test.wav. The SDK converts the audio file into a Base64-encoded file.
  private String pathAudioFormat = "";  // File format, for example, WAV.
  private String pathProperty = "chinese_16k_general";     // Attribute string, language_sampleRate_domain. chinese_16k_general is recommended for 16 kHZ models.


  /**
   * Configure Sentence Transcription parameters. All parameters have default values. You can use them without configuring their values.
   *
   * @param request Sentence Transcription request
   */
  private void setShortParameter(AsrCustomShortRequest request) {

    // Set whether to add punctuation marks. The default value is no.
    request.setAddPunc("yes");
  }

  /**
   * Define config. All parameters are optional. Set the timeout intervals.
   *
   * @return SisConfig
   */
  private SisConfig getConfig() {
    SisConfig config = new SisConfig();
    // Set the connection timeout interval. The default value is 10000 ms.
    config.setConnectionTimeout(SisConstant.DEFAULT_CONNECTION_TIMEOUT);
   // Set the read timeout interval. The default value is 10000 ms.
    config.setReadTimeout(SisConstant.DEFAULT_READ_TIMEOUT);
    // Set the proxy. Ensure that the proxy is available before setting it. The unencrypted proxy can also be used for proxy initialization, for example, new ProxyHostInfo(host, port).
    // ProxyHostInfo proxy = new ProxyHostInfo(host, port, username, password);
    // config.setProxy(proxy);
    return config;
  }


  /**
   * Sentence Transcription demo
   */
  private void shortDemo() {
    try {
      // 1. Initialize the AsrCustomizationClient.
      // Define authInfo based on the ak, sk, region, and projectId parameters.
      AuthInfo authInfo = new AuthInfo(ak, sk, region, projectId);
      // Set config, which is related to timeout settings.
      SisConfig config = getConfig();
      // Construct the AsrCustomizationClient based on authInfo and config.
      AsrCustomizationClient asr = new AsrCustomizationClient(authInfo, config);

      // 2. Configure the request.
      String data = IOUtils.getEncodeDataByPath(path);
      AsrCustomShortRequest request = new AsrCustomShortRequest(data, pathAudioFormat, pathProperty);
      // Set request parameters. All parameters are optional.
      setShortParameter(request);

      // 3. Send the request and obtain a response.
      AsrCustomShortResponse response = asr.getAsrShortResponse(request);
      // Print the result.
      System.out.println(JsonUtils.obj2Str(response, true));

    } catch (SisException e) {
      e.printStackTrace();
      System.out.println("error_code:" + e.getErrorCode() + "\nerror_msg:" + e.getErrorMsg());
    }
  }

  public static void main(String[] args) {
    AsrCustomizationDemo demo = new AsrCustomizationDemo();
    demo.shortDemo();
  }

}