Go SDK

前提条件

• 已安装 Go 1.16 或以上版本，并完成环境配置。

• 已获取项目 Appkey，并准备访问 Token 或用于获取 Token 的 AccessKey。项目配置请参见管理项目，Token 获取方法请参见获取 Token。

• 了解音频要求和服务参数，详情请参见实时语音识别接口说明。

安装 SDK

在 Go Module 项目目录中安装 SDK：

go get github.com/aliyun/alibabacloud-nls-go-sdk

项目尚未初始化 Module 时，先执行 go mod init <模块路径>。SDK 的导入路径为 github.com/aliyun/alibabacloud-nls-go-sdk，包名为 nls。

代码示例

示例使用 Go SDK v1.1.1，完成一次音频文件识别。运行前准备以下内容：

• 在程序运行环境中设置 NLS_APP_KEY 和 NLS_TOKEN。示例代码通过 os.Getenv 读取这两个变量，分别用于项目 Appkey 和访问 Token。

• 下载示例音频 test1.pcm，保存到程序工作目录。该文件为 16 kHz、单声道、16 bit PCM 音频；使用其他文件时，修改 audioPath，并使音频格式、采样率与识别参数及项目模型匹配。

package main

import (
    "fmt"
    "io"
    "log"
    "os"
    "time"

    nls "github.com/aliyun/alibabacloud-nls-go-sdk"
)

func waitResult(ch <-chan bool) error {
    select {
    case success, ok := <-ch:
        if !ok || !success {
            return fmt.Errorf("recognition task failed")
        }
        return nil
    case <-time.After(20 * time.Second):
        return fmt.Errorf("timed out waiting for recognition event")
    }
}

func printEvent(text string, param interface{}) {
    fmt.Println(text)
}

func recognize() error {
    appkey := os.Getenv("NLS_APP_KEY")
    token := os.Getenv("NLS_TOKEN")
    if appkey == "" || token == "" {
        return fmt.Errorf("set NLS_APP_KEY and NLS_TOKEN")
    }
    audioPath := "test1.pcm"
    audio, err := os.Open(audioPath)
    if err != nil {
        return err
    }
    defer audio.Close()

    config := nls.NewConnectionConfigWithToken(nls.DEFAULT_URL, appkey, token)
    logger := nls.NewNlsLogger(os.Stderr, "NLS ", log.LstdFlags)
    st, err := nls.NewSpeechTranscription(
        config, logger, printEvent, nil, nil, printEvent, nil, printEvent, nil, nil,
    )
    if err != nil {
        return err
    }
    defer st.Shutdown()

    params := nls.DefaultSpeechTranscriptionParam()
    started, err := st.Start(params, nil)
    if err != nil {
        return err
    }
    if err := waitResult(started); err != nil {
        return err
    }

    // 每 10 ms 发送 320 字节，对应 16 kHz、16 bit、单声道 PCM。
    buffer := make([]byte, 320)
    for {
        n, readErr := io.ReadFull(audio, buffer)
        if readErr != nil && readErr != io.EOF && readErr != io.ErrUnexpectedEOF {
            return readErr
        }
        if n > 0 {
            if err := st.SendAudioData(buffer[:n]); err != nil {
                return err
            }
            time.Sleep(10 * time.Millisecond)
        }
        if readErr == io.EOF || readErr == io.ErrUnexpectedEOF {
            break
        }
    }

    completed, err := st.Stop()
    if err != nil {
        return err
    }
    return waitResult(completed)
}

func main() {
    if err := recognize(); err != nil {
        log.Fatal(err)
    }
}

每句话的最终结果通过 SentenceEnd 回调消息中的 payload.result 返回，TranscriptionCompleted 表示整个识别任务结束。任务失败时，TaskFailed 回调消息提供错误信息。

连接配置

ConnectionConfig 保存连接参数。建议缓存通过 AccessKey 获取的 Token，并根据返回的过期时间更新，避免频繁获取 Token 导致限流。

func NewConnectionConfigWithToken(url string, appkey string, token string) *ConnectionConfig

func NewConnectionConfigWithAKInfoDefault(url string, appkey string, akid string, akkey string) (*ConnectionConfig, error)

func NewConnectionConfigFromJson(jsonStr string) (*ConnectionConfig, error)

识别参数与方法

func DefaultSpeechTranscriptionParam() SpeechTranscriptionStartParam

func NewSpeechTranscription(
    config *ConnectionConfig,
    logger *NlsLogger,
    taskfailed func(string, interface{}),
    started func(string, interface{}),
    sentencebegin func(string, interface{}),
    sentenceend func(string, interface{}),
    resultchanged func(string, interface{}),
    completed func(string, interface{}),
    closed func(interface{}),
    param interface{},
) (*SpeechTranscription, error)

func (st *SpeechTranscription) Start(param SpeechTranscriptionStartParam, extra map[string]interface{}) (chan bool, error)

func (st *SpeechTranscription) SendAudioData(data []byte) error

func (st *SpeechTranscription) Stop() (chan bool, error)

func (st *SpeechTranscription) Ctrl(param map[string]interface{}) error

func (st *SpeechTranscription) Shutdown()

SDK 常量

SDK 日志

func NewNlsLogger(w io.Writer, tag string, flag int) *NlsLogger