C# SDK

本文将详细介绍NLP自学习平台的C# SDK安装步骤及调用示例。主要内容包括如何调用NLP自学习平台以创建异步预测接口,以及如何获取异步预测结果接口,并提供完整的集成步骤。以帮助您更好地理解与应用NLP自学习平台的功能。

前提条件

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

环境要求

net framework >= 4.5 或 .Net Core >= 2.0。

步骤一:引入SDK

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

特化调用

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

  1. 访问NLP自学习平台

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

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

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

C#语言安装产品如下:

dotnet add package AlibabaCloud.SDK.Nlp-automl20191111 --version 1.0.3

泛化调用

泛化调用方式不依赖任何一个产品的SDK,只依赖如下核心包AlibabaCloud.OpenApiClient。其C#语言安装配置文件如下,最新版本请参见AlibabaCloud.OpenApiClient

dotnet add package AlibabaCloud.OpenApiClient --version 0.1.8

步骤二:初始化Client

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

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

使用AK初始化

说明

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

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;


namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>使用AK&amp;SK初始化账号Client</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Nlp_automl20191111.Client CreateClient()
        {
            // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
            // 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378671.html。
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
            {
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
            };
            // Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
            config.Endpoint = "nlp-automl.cn-hangzhou.aliyuncs.com";
            return new AlibabaCloud.SDK.Nlp_automl20191111.Client(config);
        }

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

说明

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

接口名称:CreateAsyncPredict

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

  // 创建请求对象
  AlibabaCloud.SDK.Nlp_automl20191111.Models.CreateAsyncPredictRequest createAsyncPredictRequest = new AlibabaCloud.SDK.Nlp_automl20191111.Models.CreateAsyncPredictRequest
            {   
                // 模型ID 示例值:1
                ModelId = 1,
                // 预测内容
                Content = "全国土地利用总体规划",
            };
            // 运行时配置
            AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();

以下是使用AK创建一个异步预测的完整示例代码:

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;


namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>使用AK&amp;SK初始化账号Client</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Nlp_automl20191111.Client CreateClient()
        {
            // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
            // 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378671.html。
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
            {
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
            };
            // Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
            config.Endpoint = "nlp-automl.cn-hangzhou.aliyuncs.com";
            return new AlibabaCloud.SDK.Nlp_automl20191111.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Nlp_automl20191111.Client client = CreateClient();
              // 创建请求对象
  AlibabaCloud.SDK.Nlp_automl20191111.Models.CreateAsyncPredictRequest createAsyncPredictRequest = new AlibabaCloud.SDK.Nlp_automl20191111.Models.CreateAsyncPredictRequest
            {   
                // 模型ID 示例值:1
                ModelId = 1,
                // 预测内容
                Content = "全国土地利用总体规划",
            };
            // 运行时配置
            AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
            try
            {
                // 复制代码运行请自行打印 API 的返回值
                client.CreateAsyncPredictWithOptions(createAsyncPredictRequest, runtime);
            }
            catch (TeaException error)
            {
                // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
                // 错误 message
                Console.WriteLine(error.Message);
                // 诊断地址
                Console.WriteLine(error.Data["Recommend"]);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(new Dictionary<string, object>
                {
                    { "message", _error.Message }
                });
                // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
                // 错误 message
                Console.WriteLine(error.Message);
                // 诊断地址
                Console.WriteLine(error.Data["Recommend"]);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
        }


    }
}

接口名称:GetAsyncPredict

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

  // 创建请求参数
  AlibabaCloud.SDK.Nlp_automl20191111.Models.GetAsyncPredictRequest getAsyncPredictRequest = new AlibabaCloud.SDK.Nlp_automl20191111.Models.GetAsyncPredictRequest
            {   // 异步预测ID 示例值:1629
                AsyncPredictId = 1629,
            };
            // 运行时配置
            AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();

以下是使用AK获取异步预测结果的完整示例代码:

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

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;

using Tea;
using Tea.Utils;


namespace AlibabaCloud.SDK.Sample
{
    public class Sample 
    {

        /// <term><b>Description:</b></term>
        /// <description>
        /// <para>使用AK&amp;SK初始化账号Client</para>
        /// </description>
        /// 
        /// <returns>
        /// Client
        /// </returns>
        /// 
        /// <term><b>Exception:</b></term>
        /// Exception
        public static AlibabaCloud.SDK.Nlp_automl20191111.Client CreateClient()
        {
            // 工程代码泄露可能会导致 AccessKey 泄露,并威胁账号下所有资源的安全性。以下代码示例仅供参考。
            // 建议使用更安全的 STS 方式,更多鉴权访问方式请参见:https://help.aliyun.com/document_detail/378671.html。
            AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config
            {
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。
                AccessKeyId = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_ID"),
                // 必填,请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。
                AccessKeySecret = Environment.GetEnvironmentVariable("ALIBABA_CLOUD_ACCESS_KEY_SECRET"),
            };
            // Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
            config.Endpoint = "nlp-automl.cn-hangzhou.aliyuncs.com";
            return new AlibabaCloud.SDK.Nlp_automl20191111.Client(config);
        }

        public static void Main(string[] args)
        {
            AlibabaCloud.SDK.Nlp_automl20191111.Client client = CreateClient();
            // 创建请求参数
            AlibabaCloud.SDK.Nlp_automl20191111.Models.GetAsyncPredictRequest getAsyncPredictRequest = new AlibabaCloud.SDK.Nlp_automl20191111.Models.GetAsyncPredictRequest
            {   // 异步预测ID 示例值:1629
                AsyncPredictId = 1629,
            };
            // 运行时配置
            AlibabaCloud.TeaUtil.Models.RuntimeOptions runtime = new AlibabaCloud.TeaUtil.Models.RuntimeOptions();
            try
            {
                // 复制代码运行请自行打印 API 的返回值
                client.GetAsyncPredictWithOptions(getAsyncPredictRequest, runtime);
            }
            catch (TeaException error)
            {
                // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
                // 错误 message
                Console.WriteLine(error.Message);
                // 诊断地址
                Console.WriteLine(error.Data["Recommend"]);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
            catch (Exception _error)
            {
                TeaException error = new TeaException(new Dictionary<string, object>
                {
                    { "message", _error.Message }
                });
                // 此处仅做打印展示,请谨慎对待异常处理,在工程项目中切勿直接忽略异常。
                // 错误 message
                Console.WriteLine(error.Message);
                // 诊断地址
                Console.WriteLine(error.Data["Recommend"]);
                AlibabaCloud.TeaUtil.Common.AssertAsString(error.Message);
            }
        }


    }
}