程序包 com.baidubce.appbuilder.console.appbuilderclient

类 AppBuilderClient

java.lang.Object

com.baidubce.appbuilder.base.component.Component

com.baidubce.appbuilder.console.appbuilderclient.AppBuilderClient

public class AppBuilderClient
extends Component

字段概要

字段

修饰符和类型	字段	说明
String	appID

从类继承的字段 com.baidubce.appbuilder.base.component.Component

httpClient

构造器概要

构造器

构造器	说明
AppBuilderClient(String appID)
AppBuilderClient(String appID, String secretKey)
AppBuilderClient(String appID, String secretKey, String gateway)

方法概要

修饰符和类型	方法	说明
String	createConversation()	创建会话
AppBuilderClientIterator	run(AppBuilderClientRunRequest requestBody)
AppBuilderClientIterator	run(String query, String conversationId, String[] fileIds, boolean stream)	运行AgentBuilder，根据输入的问题、会话ID、文件ID数组以及是否以流模式返回结果，返回AgentBuilderIterator迭代器。
String	uploadLocalFile(String conversationId, String filePath)	上传本地文件到指定会话中

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

appID

public String appID

构造器详细资料

AppBuilderClient

public AppBuilderClient(String appID)

AppBuilderClient

public AppBuilderClient(String appID,
                        String secretKey)

AppBuilderClient

public AppBuilderClient(String appID,
                        String secretKey,
                        String gateway)

方法详细资料

createConversation

public String createConversation()
                          throws IOException,
                                 AppBuilderServerException

创建会话

返回:

返回会话ID

抛出:

IOException - 当请求失败时抛出IOException

AppBuilderServerException - 当服务器返回错误码时抛出AppBuilderServerException

uploadLocalFile

public String uploadLocalFile(String conversationId,
                              String filePath)
                       throws IOException,
                              AppBuilderServerException

上传本地文件到指定会话中

参数:

conversationId - 会话ID

filePath - 文件路径

返回:

上传后的文件ID

抛出:

IOException - 当请求失败时抛出IOException

AppBuilderServerException - 当服务器返回错误码时抛出AppBuilderServerException

run

public AppBuilderClientIterator run(String query,
                                    String conversationId,
                                    String[] fileIds,
                                    boolean stream)
                             throws IOException,
                                    AppBuilderServerException

运行AgentBuilder，根据输入的问题、会话ID、文件ID数组以及是否以流模式返回结果，返回AgentBuilderIterator迭代器。

参数:

query - 查询字符串

conversationId - 会话ID

fileIds - 文件ID数组

stream - 是否以流的形式返回结果

返回:

AgentBuilderIterator 迭代器，包含 AgentBuilder 的运行结果

抛出:

IOException - 如果在 I/O 操作过程中发生错误

AppBuilderServerException - 如果 AppBuilder 服务器返回错误

run

public AppBuilderClientIterator run(AppBuilderClientRunRequest requestBody)
                             throws IOException,
                                    AppBuilderServerException

抛出:

IOException

AppBuilderServerException