ConvoAIClient 类

  • Java

更新时间

create

Java
public static synchronized ConvoAIClient create(ConvoAIConfig convoAIConfig)

使用指定配置创建 ConvoAIClient 实例。

信息

自 v0.3.0 版本新增。

参数

参数数据类型描述
convoAIConfigConvoAIConfig对话式 AI 引擎的配置参数。详见 ConvoAIConfig。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回 ConvoAIClient 实例。

join

Java
public abstract Mono<JoinConvoAIRes> join(JoinConvoAIReq request);

创建一个智能体实例并加入指定的 RTC 频道。

信息

自 v0.3.0 版本新增。

参数

参数数据类型描述
requestJoinConvoAIReq加入对话式 AI 引擎的请求参数。详见 JoinConvoAIReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回 JoinConvoAIRes 实例。

leave

Java
public abstract Mono<Void> leave(String agentId);

停止指定的智能体实例并离开 RTC 频道。

信息

自 v0.3.0 版本新增。

注意

调用此方法前,请确保已通过调用 join 获取智能体 ID。

参数

参数数据类型描述
agentIdString智能体 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

list

Java
public abstract Mono<ListConvoAIRes> list(ListConvoAIReq request);

获取符合指定条件的智能体列表。

信息

自 v0.3.0 版本新增。

参数

参数数据类型描述
requestListConvoAIReq用于列出智能体的参数。详见 ListConvoAIReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回 ListConvoAIRes 对象。

query

Java
public abstract Mono<QueryConvoAIRes> query(String agentId);

查询指定智能体实例的当前状态。

信息

自 v0.3.0 版本新增。

注意

在使用此方法前,请确保已通过调用 join API 获取智能体 ID。

参数

参数数据类型描述
agentIdString智能体 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回 QueryConvoAIRes 实例。

update

Java
public abstract Mono<UpdateConvoAIRes> update(String agentId, UpdateConvoAIReq request);

在运行时调整智能体的参数。

信息

自 v0.3.0 版本新增。

注意

在使用此方法前,请确保已通过调用 join API 获取智能体 ID。

参数

参数数据类型描述
agentIdString智能体 ID。
requestUpdateConvoAIReq用于更新智能体的参数,详见 UpdateConvoAIReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回 UpdateConvoAIRes 对象。

interrupt

Java
public abstract Mono<InterruptConvoAIRes> interrupt(String agentId);

中断指定的智能体实例。

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
agentIdString要中断的智能体 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回中断响应结果,详见 InterruptConvoAIRes。

speak

Java
public abstract Mono<SpeakConvoAIRes> speak(String agentId, SpeakConvoAIReq request);

为指定的智能体实例播报自定义消息。

信息

自 v0.4.0 版本新增。

参数

参数数据类型描述
agentIdString智能体 ID。
requestSpeakConvoAIReq播报自定义消息的请求体,详见 SpeakConvoAIReq。
表格内容超出当前宽度,可横向滚动查看更多列。

返回值

方法调用成功,返回响应对象 SpeakConvoAIRes。详见 SpeakConvoAIRes。