SDK使用指南

请参考 开始使用

NLP基础服务2.0依赖

npm install @alicloud/alinlp20200629 -S

通过环境变量配置访问凭证(AKSK)

  1. 说明:

    1. 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。

    2. 强烈建议不要把AccessKey和AccessKeySecret保存到代码里,会存在密钥泄漏风险,在此提供通过配置环境变量的方式来保存和访问aksk

  2. Linux和macOS系统配置方法

    export NLP_AK_ENV=<access_key_id>
    export NLP_SK_ENV=<access_key_secret>

    其中<access_key_id>替换为已准备好的AccessKey ID,<access_key_secret>替换为AccessKey Secret,AccessKey ID和AccessKey Secret的获取方式见步骤二:获取账号的AccessKey

  3. Windows系统配置方法

    1. 新建环境变量文件,添加环境变量NLP_AK_ENVNLP_SK_ENV,并写入已准备好的AccessKey ID和AccessKey Secret。

    2. 重启Windows系统。

代码示例

TypeScript

import Client, * as $Alinlp from '@alicloud/alinlp20200629';
import * as $OpenApi from '@alicloud/openapi-client';

export default class Test {
  static async main(): Promise<void> {
    const accessKeyId = process.env.NLP_AK_ENV;
		const accessKeySecret = process.env.NLP_SK_ENV;
    const config = new $OpenApi.Config({
    /**
      * 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
      * 此处以把AccessKey和AccessKeySecret保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里。
      * 强烈建议不要把AccessKey和AccessKeySecret保存到代码里,会存在密钥泄漏风险
      */
      accessKeyId: process.env.NLP_AK_ENV,
      accessKeySecret: process.env.NLP_SK_ENV,
      // 访问的区域
      regionId: 'cn-hangzhou',
      endpoint: 'alinlp.cn-hangzhou.aliyuncs.com'
    });
    const client = new Client(config);
    const request = new $Alinlp.GetNerChEcomRequest({
      serviceCode: "alinlp",
      text: "电动多功能磨浆机"
    });
    const resp = await client.getNerChEcom(request);
    console.log(resp.body);
  }
}

Test.main();

注:代码GetNerChEcomRequest中的GetNerChEcom是算法的actionName,可以替换成您需要的算法的值,可以在API参考文档中的请求参数-Action-示例值中找到;

示例:需要调用基础版-中文分词-通用,进入中文分词(基础版),复制下图中的示例值,将GetNerChEcomRequest替换为GetWsChGeneralRequest替换后要注意算法的请求参数也要更改,参考API文档即可。

actionName值的位置

JavaScript

const { default: Client, GetNerChEcomRequest } = require('@alicloud/alinlp20200629');
const { Config } = require('@alicloud/openapi-client');

async function main() {
  let config = new Config({
    /**
     * 阿里云账号AccessKey拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户。
     * 此处以把AccessKey和AccessKeySecret保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里。
     * 强烈建议不要把AccessKey和AccessKeySecret保存到代码里,会存在密钥泄漏风险
     */
    accessKeyId: process.env.NLP_AK_ENV,
    accessKeySecret: process.env.NLP_SK_ENV,
    // 访问的区域
    regionId: 'cn-hangzhou',
    endpoint: 'alinlp.cn-hangzhou.aliyuncs.com'
  });
  const client = new Client(config);
  const request = new GetNerChEcomRequest({
    serviceCode: "alinlp",
    text: "电动多功能磨浆机"
  });
  const resp = await client.getNerChEcom(request);
  console.log(resp.body);
}

main();

备注:如需调用其他算法也需要替换代码中的GetNerChEcomRequest,可参考上述中的替换方式。

调用异常自助排查

若调用过程中出现了异常可对照调用异常自助排查(错误码汇总),找到表格中对应的描述,描述中包含具体错误原因和解决方案