如何下载/使用PythonSDK_智能推荐 AIRec(AIRec)-阿里云帮助中心

本文将详细介绍智能推荐的Python SDK安装步骤及调用示例。主要内容包括如何调用智能推荐以创建智能推荐实例接口，通过指定的实例ID查看实例详情接口，以及启动实例开始全量数据导入任务接口，并提供完整的集成步骤。

前提条件

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

环境要求

Python版本 >= 3.7。

步骤一：引入SDK

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

特化调用

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

访问智能推荐。
在所有语言栏目中选择您需要的SDK语言。
选择您需要的安装方式，将代码复制到您的项目中。
在您的项目中载入该依赖包。

其Python语言安装产品如下：

pip install alibabacloud_airec20201126==1.0.0

泛化调用

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

pip install alibabacloud-tea-openapi

步骤二：初始化Client

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

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

使用AK初始化

说明

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

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

更多认证信息配置方式，请参见管理访问凭据。
不同操作系统的环境变量配置方法不同，具体操作，请参见在Linux、macOS和Windows系统配置环境变量。

import os
import sys
from typing import List
from alibabacloud_airec20201126.client import Client as Airec20201126Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient


@staticmethod
def create_client() -> Airec20201126Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式
        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/Airec
        config.endpoint = f'airec.cn-hangzhou.aliyuncs.com'
        return Airec20201126Client(config)

步骤三：使用已初始化的Client调用智能推荐API

说明

初始化Client后，您可以通过Client调用智能推荐API。

接口名称：CreateInstance

此接口用于创建一个智能推荐预付费实例。调用该API无需参数，您需要根据实际业务需求设置运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

// 运行时配置
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_airec20201126.client import Client as Airec20201126Client
from alibabacloud_tea_openapi import models as open_api_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() -> Airec20201126Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式
        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/Airec
        config.endpoint = f'airec.cn-hangzhou.aliyuncs.com'
        return Airec20201126Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.create_instance_with_options(headers, 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()
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.create_instance_with_options_async(headers, 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:])

接口名称：DescribeInstance

此接口用于通过指定的实例ID查看实例详情。您需要根据实际业务需求设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

// 运行时配置
runtime = util_models.RuntimeOptions()
headers = {}
            // 请求时设置参数
            client.describe_instance_with_options('airec-cn-****', headers, runtime)

以下是使用AK通过指定的实例ID获取实例详情的完整示例代码：

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

from typing import List

from alibabacloud_airec20201126.client import Client as Airec20201126Client
from alibabacloud_tea_openapi import models as open_api_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() -> Airec20201126Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式
        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/Airec
        config.endpoint = f'airec.cn-hangzhou.aliyuncs.com'
        return Airec20201126Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.describe_instance_with_options('airec-cn-****', headers, 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()
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.describe_instance_with_options_async('airec-cn-****', headers, 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:])

接口名称：RunInstance

此接口用于启动一个实例开始全量数据导入任务。您需要根据实际业务需求设置相应的参数及运行时配置。同时，您也可以自定义运行时配置以满足特定需求。

 // 运行时配置
 runtime = util_models.RuntimeOptions()
 headers = {}
            // 请求时设置参数
            client.run_instance_with_options('airec-cn-****', headers, runtime)

以下是使用AK通过指定的实例ID启动实例开始全量数据导入任务的完整示例代码：

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

from typing import List

from alibabacloud_airec20201126.client import Client as Airec20201126Client
from alibabacloud_tea_openapi import models as open_api_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() -> Airec20201126Client:
        """
        使用AK&SK初始化账号Client
        @return: Client
        @throws Exception
        """
        # 工程代码泄露可能会导致 AccessKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考。
        # 建议使用更安全的 STS 方式
        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/Airec
        config.endpoint = f'airec.cn-hangzhou.aliyuncs.com'
        return Airec20201126Client(config)

    @staticmethod
    def main(
        args: List[str],
    ) -> None:
        client = Sample.create_client()
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            client.run_instance_with_options('airec-cn-****', headers, 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()
        runtime = util_models.RuntimeOptions()
        headers = {}
        try:
            # 复制代码运行请自行打印 API 的返回值
            await client.run_instance_with_options_async('airec-cn-****', headers, 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:])