Go SDK

本文旨在详尽阐述如何将自然语言处理(NLP)自学习平台的GO SDK集成至您的系统中。我们将指导您创建一个异步预测接口,并获取异步任务的预测结果,同时提供完整的代码示例。

前提条件

调用阿里云OpenAPI通常需要设置访问密钥(AccessKey)。请确保已创建AccessKey。具体操作,请参见创建AccessKey。为了避免凭据泄露,常见的方案是将其写入到环境变量中,更多安全方案请参见使用访问凭据访问阿里云OpenAPI最佳实践

环境要求

  • Go 环境版本必须不低于 1.10.x

步骤一:引入SDK

阿里云SDK支持泛化与特化两种方式调用OpenAPI,详情参见泛化调用与特化调用,不同的调用方式需要引入的SDK也不同。

特化调用

您可以访问OpenAPI门户网站,搜索您需要的产品,查看产品支持的SDK语言及安装方法,然后在您的项目中引入SDK。本案例的SDK获取步骤如下:

  1. 访问NLP自学习平台 SDK

  2. 所有语言栏目中选择您需要的SDK语言。

  3. 选择您需要的安装方式,将代码复制到您的项目中。

  4. 在您的项目中载入该依赖包。

安装方式如下:

go get github.com/alibabacloud-go/nlp-automl-20191111

泛化调用

泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包github.com/alibabacloud-go/darabonba-openapi/v2/client。Go语言安装方式如下,最新版本请参见darabonba-openapi

go get github.com/alibabacloud-go/darabonba-openapi/v2/client

步骤二:初始化Client

请根据NLP自学习平台所属地域正确填写服务接入地址(又称“访问端点”或“Endpoint”),关于服务接入地址的更多信息,请参见支持的地域

以下将以特化调用代码为例,详细说明调用过程。如您选择泛化调用方案,更多信息请参见泛化调用与特化调用

使用AK初始化

说明

阿里云账号AccessKey拥有所有OpenAPI的访问权限,建议您使用RAM用户进行API访问或日常运维。强烈建议不要把AccessKey IDAccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。

本示例以将AccessKey配置在环境变量ALIBABA_CLOUD_ACCESS_KEY_IDALIBABA_CLOUD_ACCESS_KEY_SECRET的方式来实现身份验证为例。

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  nlp_automl20191111  "github.com/alibabacloud-go/nlp-automl-20191111/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)


// Description:
// 
// 使用AK&SK初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *nlp_automl20191111.Client, _err error) {
  // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
  // 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378661.html。
  config := &openapi.Config{
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  // Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
  config.Endpoint = tea.String("nlp-automl.cn-hangzhou.aliyuncs.com")
  _result = &nlp_automl20191111.Client{}
  _result, _err = nlp_automl20191111.NewClient(config)
  return _result, _err
}

步骤三:使用已初始化的Client调用NLP自学习平台API

说明

初始化Client后,您可以通过Client调用NLP自学习平台API

接口名称:CreateAsyncPredict

此接口用于创建一个异步预测。在调用过程中,您需要根据实际业务需求创建请求对象,并设置相应的参数及运行时配置。同时,您也可以自定义运行时配置以满足特定需求。

// 创建请求对象
createAsyncPredictRequest := &nlp_automl20191111.CreateAsyncPredictRequest{
  // 模型 ID。根据服务名称和服务版本创建异步预测的时候,此参数不必传;否则必传。
  ModelId: tea.Int32(1),
  // 预测内容,最大长度:1024 字节。
  Content: tea.String("全国土地利用总体规划"),
}
// 运行时配置
runtime := &util.RuntimeOptions{}

以下是使用AK创建一个流程的完整示例代码:

package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  nlp_automl20191111  "github.com/alibabacloud-go/nlp-automl-20191111/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)


// Description:
// 
// 使用AK&SK初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *nlp_automl20191111.Client, _err error) {
  // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
  // 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378661.html。
  config := &openapi.Config{
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  // Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
  config.Endpoint = tea.String("nlp-automl.cn-hangzhou.aliyuncs.com")
  _result = &nlp_automl20191111.Client{}
  _result, _err = nlp_automl20191111.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }
  
  // 创建请求对象
  createAsyncPredictRequest := &nlp_automl20191111.CreateAsyncPredictRequest{
    // 模型 ID。根据服务名称和服务版本创建异步预测的时候,此参数不必传;否则必传。
    ModelId: tea.Int32(1),
    // 预测内容,最大长度:1024 字节。
    Content: tea.String("全国土地利用总体规划"),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.CreateAsyncPredictWithOptions(createAsyncPredictRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

接口名称:GetAsyncPredict

此接口用于获取异步预测结果。在调用过程中,您需要根据实际业务需求创建请求对象,并设置相应的参数及运行时配置。同时,您也可以自定义运行时配置以满足特定需求。

// 创建请求对象
getAsyncPredictRequest := &nlp_automl20191111.GetAsyncPredictRequest{
  // 异步预测 ID,通过调用 CreateAsyncPredict 接口获取。  
  AsyncPredictId: tea.Int32(1629),
}
// 运行时配置
runtime := &util.RuntimeOptions{}

以下是使用AK获取流程相关信息的完整示例代码:

// This file is auto-generated, don't edit it. Thanks.
package main

import (
  "encoding/json"
  "strings"
  "fmt"
  "os"
  nlp_automl20191111  "github.com/alibabacloud-go/nlp-automl-20191111/client"
  openapi  "github.com/alibabacloud-go/darabonba-openapi/v2/client"
  util  "github.com/alibabacloud-go/tea-utils/v2/service"
  "github.com/alibabacloud-go/tea/tea"
)


// Description:
// 
// 使用AK&SK初始化账号Client
// 
// @return Client
// 
// @throws Exception
func CreateClient () (_result *nlp_automl20191111.Client, _err error) {
  // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
  // 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378661.html。
  config := &openapi.Config{
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
    AccessKeyId: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")),
    // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
    AccessKeySecret: tea.String(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")),
  }
  // Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
  config.Endpoint = tea.String("nlp-automl.cn-hangzhou.aliyuncs.com")
  _result = &nlp_automl20191111.Client{}
  _result, _err = nlp_automl20191111.NewClient(config)
  return _result, _err
}

func _main (args []*string) (_err error) {
  client, _err := CreateClient()
  if _err != nil {
    return _err
  }
  
  // 创建请求对象
  getAsyncPredictRequest := &nlp_automl20191111.GetAsyncPredictRequest{
    // 异步预测 ID,通过调用 CreateAsyncPredict 接口获取。
    AsyncPredictId: tea.Int32(1629),
  }
  // 运行时配置
  runtime := &util.RuntimeOptions{}
  tryErr := func()(_e error) {
    defer func() {
      if r := tea.Recover(recover()); r != nil {
        _e = r
      }
    }()
    // 复制代码运行请自行打印 API 的返回值
    _, _err = client.GetAsyncPredictWithOptions(getAsyncPredictRequest, runtime)
    if _err != nil {
      return _err
    }

    return nil
  }()

  if tryErr != nil {
    var error = &tea.SDKError{}
    if _t, ok := tryErr.(*tea.SDKError); ok {
      error = _t
    } else {
      error.Message = tea.String(tryErr.Error())
    }
    // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
    // 错误 message
    fmt.Println(tea.StringValue(error.Message))
    // 诊断地址
    var data interface{}
    d := json.NewDecoder(strings.NewReader(tea.StringValue(error.Data)))
    d.Decode(&data)
    if m, ok := data.(map[string]interface{}); ok {
      recommend, _ := m["Recommend"]
      fmt.Println(recommend)
    }
    _, _err = util.AssertAsString(error.Message)
    if _err != nil {
      return _err
    }
  }
  return _err
}


func main() {
  err := _main(tea.StringSlice(os.Args[1:]))
  if err != nil {
    panic(err)
  }
}

SDK调用示例

您可以使用API级别的多语言SDK Demo进行调试。示例代码,请参见开发者门户OpenAPI Explorer