AISDK API接口

AISDK API接口

本文档仅适用于AI-2.0.0.0及以上版本。

1. 接口类说明

本文档所有接口所涉及的相关类及说明如下:

接口 说明
AiManager SDK 功能接口类,用于调用SDK相关功能
Callback 通用的回调接口,返回成功或失败的相关信息

获取 AiManager

类名 com.getui.ai.AiManager
接口 public static AiManager getInstance()

说明:

用于获取单例 AiManager 对象

返回:

返回 AiManager 单例对象

2. 初始化

接口说明

建议在 Application.onCreate()中判断用户已经同意隐私政策后初始化SDK,初始化时会读取配置及启动相关服务


     public void initialize(Context context, Callback<String> callback)

调用示例

/*
     onFailure中的错误码说明:
     -10001:初始化未成功
     -10002:重复初始化
     -10003:SDK入参错误
     -10004:appid未配置
     -30001:网络错误

     -40001:频率超限,1s1次
     -40002:重复请求
     -40004:agentid 不合法
     -10008:连接异常
     -10010:连接超时
     */        

AiManager.getInstance().initialize(getApplicationContext(), new Callback<String>() {
            @Override
            public void onFailure(Throwable t) {
                //初始化失败
                Log.e("AISDK", "初始化失败", t);
            }

            @Override
            public void onResponse(String response) {
                //初始化成功,返回 'sdk init success'
                Log.d("AISDK", "初始化成功: " + response);
            }
        });

3. 版本信息

接口说明

获取aisdk版本信息。

    /**
     * 获取版本号.
     * @return version 版本号.
     */
    public String getVersion()

调用示例

AiManager.getInstance().getVersion();

4. 加载智能体页面

接口说明

需要确保在SDK初始化成功才能调用

public void loadAgent(String agentId, boolean show, Callback<String> callback)

注意:

  • 需要确保在SDK初始化成功才能调用,否则会抛出-10001错误码

参数说明

方法 参数类型 说明 必填 默认值
agentId String 智能体ID -
show boolean 是否拉起智能体页面 -

调用示例


 /*
     onFailure中的错误码说明:
     -10001:初始化未成功
     -10002:重复初始化
     -10003:SDK入参错误
     -10004:appid未配置
     -30001:网络错误

     -40001:频率超限,1s1次
     -40002:重复请求
     -40004:agentid 不合法
     -10008:连接异常
     -10010:连接超时
     */

AiManager.getInstance().loadAgent("{替换为你的agentId}", true, new Callback<String>() {
            @Override
            public void onFailure(Throwable t) {
                Log.e("AISDK", "loadAgent failed", t);
            }

            @Override
            public void onResponse(String response) {
                Log.e("AISDK", "loadAgent success");
            }
        });

返回示例

  • 加载成功
{"url":"https:xxxxxx"}

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询