对话机器人服务 CBS-Python SDK:开始使用

时间：2024-05-10 15:39:43

对话机器人服务 CBS

开始使用

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

导入依赖模块

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 *

配置客户端连接参数

默认配置

# 使用默认配置，如出现'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

配置认证信息
 配置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获取或者通过委托授权获取。

初始化客户端

指定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是华为云各服务应用区域和各服务的终端节点，详情请查看地区和终端节点。

发送请求并查看响应

# 以调用 问答机器人 会话接口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)

异常处理

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

上一篇： 对话机器人服务 CBS-Python SDK:安装SDK

下一篇： 对话机器人服务 CBS-Python SDK:安装SDK