AI 助理
备案控制台
文档
输入文档关键字查找
首页 自然语言处理 NLP自学习平台 开发参考 SDK示例 Python SDK

Python SDK

更新时间：
产品详情
我的收藏

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

前提条件

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

环境要求

Python版本 >= 3.7。

步骤一：引入SDK

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

特化调用

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

  1. 访问NLP自学习平台。

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

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

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

其Python语言安装产品如下：

pip install alibabacloud_nlp_automl20191111==1.0.3

泛化调用

泛化调用方式不依赖任何一个产品的SDK，只依赖如下核心包com.aliyun.tea-openapi。其Python语言安装配置文件如下，最新版本请参见tea-openapi。

pip install alibabacloud-tea-openapi

步骤二：初始化Client

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

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

使用AK初始化

说明

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

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

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_nlp_automl20191111.client import Client as nlp_automl20191111Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_nlp_automl20191111 import models as nlp_automl_20191111_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


@staticmethod
def create_client() -> nlp_automl20191111Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378659.html。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
        config.endpoint = f'nlp-automl.cn-hangzhou.aliyuncs.com'
        return nlp_automl20191111Client(config)

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

说明

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

接口名称：CreateAsyncPredict

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

// 创建请求对象
create_async_predict_request = nlp_automl_20191111_models.CreateAsyncPredictRequest(
            // 模型ID 示例值：1
            model_id=1,
            // 预测内容
            content='全国土地利用总体规划'
        )
        // 运行时配置
        runtime = util_models.RuntimeOptions()

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

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_nlp_automl20191111.client import Client as nlp_automl20191111Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_nlp_automl20191111 import models as nlp_automl_20191111_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> nlp_automl20191111Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378659.html。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
        config.endpoint = f'nlp-automl.cn-hangzhou.aliyuncs.com'
        return nlp_automl20191111Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        create_async_predict_request = nlp_automl_20191111_models.CreateAsyncPredictRequest(
            model_id=1,
            content='全国土地利用总体规划'
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.create_async_predict_with_options(create_async_predict_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
       // 创建请求对象
       create_async_predict_request = nlp_automl_20191111_models.CreateAsyncPredictRequest(
            // 模型ID 示例值：1
            model_id=1,
            // 预测内容
            content='全国土地利用总体规划'
        )
        // 运行时配置
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.create_async_predict_with_options_async(create_async_predict_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])

接口名称：GetAsyncPredict

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

  // 创建请求对象
  get_async_predict_request = nlp_automl_20191111_models.GetAsyncPredictRequest(
            // 异步预测ID 示例值：1629
            async_predict_id=1629
        )
        // 运行时配置
        runtime = util_models.RuntimeOptions()

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

# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import os
import sys

from typing import List

from alibabacloud_nlp_automl20191111.client import Client as nlp_automl20191111Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_nlp_automl20191111 import models as nlp_automl_20191111_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


class Sample:
    def __init__(self):
        pass

    @staticmethod
    def create_client() -> nlp_automl20191111Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式，更多鉴权访问方式请参见：https://help.aliyun.com/document_detail/378659.html。
        config = open_api_models.Config(
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_ID。,
            access_key_id=os.environ['ALIBABA_CLOUD_ACCESS_KEY_ID'],
            # 必填，请确保代码运行环境设置了环境变量 ALIBABA_CLOUD_ACCESS_KEY_SECRET。,
            access_key_secret=os.environ['ALIBABA_CLOUD_ACCESS_KEY_SECRET']
        )
        # Endpoint 请参考 https://api.aliyun.com/product/nlp-automl
        config.endpoint = f'nlp-automl.cn-hangzhou.aliyuncs.com'
        return nlp_automl20191111Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
         // 创建请求对象
         get_async_predict_request = nlp_automl_20191111_models.GetAsyncPredictRequest(
            // 异步预测ID 示例值：1629
            async_predict_id=1629
        )
        // 运行时配置
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.get_async_predict_with_options(get_async_predict_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)

    @staticmethod
    async def main_async(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        get_async_predict_request = nlp_automl_20191111_models.GetAsyncPredictRequest(
            async_predict_id=1629
        )
        runtime = util_models.RuntimeOptions()
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.get_async_predict_with_options_async(get_async_predict_request, runtime)
        except Exception as error:
            # 此处仅做打印展示，请谨慎对待异常处理，在工程项目中切勿直接忽略异常。
            # 错误 message
            print(error.message)
            # 诊断地址
            print(error.data.get("Recommend"))
            UtilClient.assert_as_string(error.message)


if __name__ == '__main__':
    Sample.main(sys.argv[1:])
上一篇：Java SDK下一篇：C# SDK
文档推荐