Java SDK

本章节介绍对话机器人服务Java SDK，您可以参考本章节进行快速集成开发。

<dependency>
    <groupId>com.huaweicloud.sdk</groupId>
    <artifactId>huaweicloud-sdk-core</artifactId>
    <version>3.0.89</version>
</dependency>
<dependency>
   <groupId>com.huaweicloud.sdk</groupId>
   <artifactId>huaweicloud-sdk-cbs</artifactId>
   <version>3.0.89</version>
</dependency>

1. 导入依赖模块

   import com.huaweicloud.sdk.core.auth.ICredential;
   // 对用户身份进行认证
   import com.huaweicloud.sdk.core.auth.BasicCredentials;
   // Http配置
   importcom.huaweicloud.sdk.core.http.HttpConfig;
   // 请求异常类
   import com.huaweicloud.sdk.core.exception.ConnectionException;
   import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
   import com.huaweicloud.sdk.core.exception.ServiceResponseException;
   // 导入cbs sdk
   import com.huaweicloud.sdk.cbs.v1.region.CbsRegion;
   import com.huaweicloud.sdk.cbs.v1.*;
   import com.huaweicloud.sdk.cbs.v1.model.*;

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

     // 使用默认配置
     HttpConfig config = HttpConfig.getDefaultHttpConfig();

   • 网络代理（可选）

     // 根据需要配置网络代理，网络代理默认的协议为 `http` 协议
     config.withProxyHost("proxy.huaweicloud.com")
         .withProxyPort(8080)
         .withProxyUsername("test")
         .withProxyPassword("test");

   • 超时配置（可选）

     // 默认连接超时时间为60秒，可根据需要调整
     config.withTimeout(60);

   • SSL配置（可选）

     // 根据需要配置是否跳过SSL证书验证
     config.withIgnoreSSLVerification(true);

3. 配置认证信息

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

   • 使用永久AK和SK

     BasicCredentials basicCredentials = new BasicCredentials()
         .withAk(ak)
         .withSk(sk)
         .withProjectId(projectId);

   • 使用临时AK和SK

     BasicCredentials basicCredentials = new BasicCredentials()
         .withAk(ak)
         .withSk(sk)
         .withSecurityToken(securityToken)
         .withProjectId(projectId)

   认证参数说明：

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

     // 增加region依赖
     import com.huaweicloud.sdk.cbs.v1.region.CbsRegion;
     
     // 初始化客户端认证信息，使用当前客户端初始化方式可不填 projectId/domainId，以初始化 BasicCredentials 为例
     BasicCredentials basicCredentials = new BasicCredentials()
         .withAk(ak)
         .withSk(sk);
     
     // 初始化指定云服务的客户端 {Service}Client ，以初始化 Region 级服务CBS的 CbsClient 为例
     CbsClient client = CbsClient.newBuilder()
         .withHttpConfig(config)
         .withCredential(basicCredentials)
         .withRegion(CbsRegion.valueOf("cn-north-4"))
         .build();

   • 指定云服务endpoint方式

     // 指定终端节点，以CBS服务北京四的 endpoint 为例
     String endpoint = "https://cbs-ext.cn-north-4.myhuaweicloud.com";
     
     // 初始化客户端认证信息，需要填写相应 projectId/domainId，以初始化 BasicCredentials 为例
     BasicCredentials basicCredentials = new BasicCredentials()
         .withAk(ak)
         .withSk(sk)
         .withProjectId(projectId);
     
     // 初始化指定云服务的客户端 {Service}Client ，以初始化 Region 级服务CBS的 CbsClient 为例
     CbsClient client = CbsClient.newBuilder()
         .withHttpConfig(config)
         .withCredential(basicCredentials)
         .withEndpoint(endpoint)
         .build();

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

5. 发送请求并查看响应

   // 以调用问答机器人会话接口ExecuteQaChat为例
   ExecuteQaChatRequest request = new ExecuteQaChatRequest();
   // qabot_id获取方法参考本章节“准备工作”
   request.withQabotId("e716b41a-1fee-4730...");
   PostRequestsReq body = new PostRequestsReq();
   // session_id首轮不需要传入或可传入任意值，第二轮开始使用上一轮返回的session_id
   body.withSessionId("ad7a5010-38...");
   body.withQuestion("查天气");
   request.withBody(body);
   try {
       ExecuteQaChatResponse response = client.executeQaChat(request);
       System.out.println(response.toString());
   } catch (ConnectionException e) {
       e.printStackTrace();
   } catch (RequestTimeoutException e) {
       e.printStackTrace();
   } catch (ServiceResponseException e) {
       e.printStackTrace();
       System.out.println(e.getHttpStatusCode());
       System.out.println(e.getErrorCode());
       System.out.println(e.getErrorMsg());
   }

6. 异常处理

   表1 异常处理

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

   // 异常处理
   try {
       ExecuteQaChatResponse response = client.executeQaChat(request);
       System.out.println(response.toString());
   } catch (ConnectionException e) {
       e.printStackTrace();
   } catch (RequestTimeoutException e) {
       e.printStackTrace();
   } catch (ServiceResponseException e) {
       e.printStackTrace();
       System.out.println(e.getHttpStatusCode());
       System.out.println(e.getErrorCode());
       System.out.println(e.getErrorMsg());
   }

自动生成SDK代码示例

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

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

图3 API Explorer