Python SDK

准备工作

• 已注册华为云账号，并完成实名认证，账号不能处于欠费或冻结状态。
• 已具备开发环境，支持Python3及以上版本。
• 登录“我的凭证 > 访问秘钥”页面，获取Access Key（AK）和Secret Access Key（SK）。
• 登录“我的凭证”页面，获取“IAM用户名”“、账号名”以及待使用区域的“项目ID”。调用服务时会用到这些信息，请提前保存。

  本样例以“华北-北京四”区域为例，获取对应的项目ID（project_id）。

  图1 我的凭证
  
• 登录对话机器人服务管理控制台，在左侧菜单栏中选择“智能问答机器人”。在机器人列表，获取机器人ID（qabot_id）。
  图2 机器人ID
  

安装SDK

支持Python3及以上版本，执行python --version检查当前Python的版本信息。

使用SDK前，需要安装“huaweicloudsdkcore”和“huaweicloudsdkcbs”。有两种安装方式，分别如下。

• 使用pip安装

  # 安装核心库
  pip install huaweicloudsdkcore
  # 安装CBS服务库
  pip install huaweicloudsdkcbs

• 使用源码安装

  # 安装核心库
  cd huaweicloudsdkcore-3.0.89
  python setup.py install
  # 安装CBS服务库
  cd huaweicloudsdkcbs-3.0.89
  python setup.py install

开始使用

详细的SDK介绍，使用异步客户端，配置日志请参见SDK中心、Python SDK使用指导、Python SDK使用视频。

1. 导入依赖模块

   from huaweicloudsdkcore.auth.credentials import BasicCredentials
   from huaweicloudsdkcore.exceptions import exceptions
   from huaweicloudsdkcore.http.http_config import HttpConfig
   # 导入CBS服务库huaweicloudsdkcbs
   from huaweicloudsdkcbs.v1.region.cbs_region import CbsRegion
   from huaweicloudsdkcbs.v1 import *

2. 配置客户端连接参数
   • 默认配置

     # 使用默认配置，如出现'HttpConfig' is not defined报错，请检查是否已正确安装sdk
     config = HttpConfig.get_default_config()

   • 网络代理（可选）

     # 根据需要配置网络代理
     config.proxy_protocol = 'http'
     config.proxy_host = 'proxy.huaweicloud.com'
     config.proxy_port = 80
     config.proxy_user = 'username'
     config.proxy_password = 'password'

   • 超时配置（可选）

     # 默认连接超时时间为60秒，读取超时时间为120秒，支持统一指定超时时长timeout=timeout，或分别指定超时时长timeout=(connect timeout, read timeout)
     config.timeout = 120

   • SSL配置（可选）

     # 根据需要配置是否跳过SSL证书校验
     config.ignore_ssl_verification = True
     # 配置服务器端CA证书，用于SDK验证服务端证书合法性
     config.ssl_ca_cert = ssl_ca_cert

3. 配置认证信息

   配置AK、SK、project_id信息。华为云通过AK识别用户的身份，通过SK对请求数据进行签名验证，用于确保请求的机密性、完整性和请求者身份的正确性。

   • 使用永久AK和SK

     basic_credentials = BasicCredentials(ak, sk, project_id)

   • 使用临时AK和SK

     basic_credentials = BasicCredentials(ak, sk, project_id).with_security_token(security_token)

   认证参数说明：

   • ak、sk：访问秘钥信息，获取方法请参见准备工作。
   • project_id：华为云项目ID，获取方法请参见准备工作。
   • security_token：采用临时AK、SK 认证场景下的安全票据，可以通过token获取或者通过委托授权获取。
4. 初始化客户端
   • 指定region方式（推荐）

     # 增加region依赖
     from huaweicloudsdkcbs.v1.region.cbs_region import CbsRegion
     
     # 初始化客户端认证信息，使用当前客户端初始化方式可不填 project_id/domain_id，以BasicCredentials为例
     basic_credentials = BasicCredentials(ak, sk)
     
     # 初始化指定云服务的客户端 {Service}Client ，以初始化 Region 级服务CBS的 CbsClient 为例
     client = CbsClient.new_builder() \
         .with_http_config(config) \
         .with_credentials(basic_credentials) \
         .with_region(CbsRegion.value_of("cn-north-4")) \
         .build()

   • 指定云服务endpoint方式

     # 指定终端节点，以 CBS 服务北京四的 endpoint 为例
     endpoint = "https://cbs-ext.cn-north-4.myhuaweicloud.com"
     
     # 初始化客户端认证信息，需要填写相应 project_id/domain_id，以初始化 BasicCredentials 为例
     basic_credentials=BasicCredentials(ak, sk, project_id)
     
     # 初始化指定云服务的客户端 {Service}Client ，以初始化 Region 级服务CBS的 CbsClient 为例
     client = CbsClient.new_builder() \
         .with_http_config(config) \
         .with_credentials(basic_credentials) \
         .with_endpoint(endpoint) \
         .build()

     endpoint是华为云各服务应用区域和各服务的终端节点，详情请查看 地区和终端节点 。

5. 发送请求并查看响应

   # 以调用问答机器人会话接口ExecuteQaChat为例
   request = ExecuteQaChatRequest()
   # qabot_id获取方法参考本章节“准备工作”
   request.qabot_id = "e716b41a-1fee-4730..."
   request.body = PostRequestsReq(
       # session_id首轮不需要传入或可传入任意值，第二轮开始使用上一轮返回的session_id
       session_id="ad7a5010-3817...",
       question="查天气"
   )
   response = client.execute_qa_chat(request)
   print(response)

6. 异常处理

   表1 异常处理

   一级分类	一级分类说明	二级分类	二级分类说明
   ConnectionException	连接类异常	HostUnreachableException	网络不可达、被拒绝。
   		SslHandShakeException	SSL认证异常。
   RequestTimeoutException	响应超时异常	CallTimeoutException	单次请求，服务器处理超时未返回。
   		RetryOutageException	在重试策略消耗完成后，仍无有效的响应。
   ServiceResponseException	服务器响应异常	ServerResponseException	服务端内部错误，Http响应码：[500,]。
   		ClientRequestException	请求参数不合法，Http响应码：[400, 500)

   # 异常处理
   try:
       request = ExecuteQaChatRequest()
       response = client.execute_qa_chat(request)
       print(response)
   except exceptions.ClientRequestException as e:
       print(e.status_code)
       print(e.request_id)
       print(e.error_code)
       print(e.error_msg)

自动生成SDK代码示例

API Explorer提供API检索及平台调试，支持全量快速检索、可视化调试、帮助文档查看、在线咨询。

您只需要在API Explorer中修改接口参数，即可自动生成对应的代码示例。同时，可在集成开发环境CloudIDE中完成代码的构建、调试、运行等操作。

图3 API Explorer