# ConvoAIClient 类 (/zh-CN/api-reference/conversational-ai/restclient-java/convoaiclient.java) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## create [#create] ```java public static synchronized ConvoAIClient create(ConvoAIConfig convoAIConfig) ``` 使用指定配置创建 [`ConvoAIClient`](/zh-CN/api-reference/conversational-ai/restclient-java/convoaiclient.java) 实例。 :::info[信息] 自 v0.3.0 版本新增。 ::: #### 参数 [#参数] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `convoAIConfig` | `ConvoAIConfig` | 对话式 AI 引擎的配置参数。详见 [`ConvoAIConfig`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#convoaiconfig)。 | #### 返回值 [#返回值] 方法调用成功,返回 [`ConvoAIClient`](/zh-CN/api-reference/conversational-ai/restclient-java/convoaiclient.java) 实例。 ## join [#join] ```java public abstract Mono join(JoinConvoAIReq request); ``` 创建一个智能体实例并加入指定的 RTC 频道。 :::info[信息] 自 v0.3.0 版本新增。 ::: #### 参数 [#参数-1] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `request` | `JoinConvoAIReq` | 加入对话式 AI 引擎的请求参数。详见 [`JoinConvoAIReq`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#joinconvoaireq)。 | #### 返回值 [#返回值-1] 方法调用成功,返回 [`JoinConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#joinconvoaires) 实例。 ## leave [#leave] ```java public abstract Mono leave(String agentId); ``` 停止指定的智能体实例并离开 RTC 频道。 :::info[信息] 自 v0.3.0 版本新增。 ::: :::warning[注意] 调用此方法前,请确保已通过调用 [`join`](/zh-CN/api-reference/conversational-ai/restclient-java/convoaiclient.java#join) 获取智能体 ID。 ::: #### 参数 [#参数-2] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `agentId` | `String` | 智能体 ID。 | ## list [#list] ```java public abstract Mono list(ListConvoAIReq request); ``` 获取符合指定条件的智能体列表。 :::info[信息] 自 v0.3.0 版本新增。 ::: #### 参数 [#参数-3] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `request` | `ListConvoAIReq` | 用于列出智能体的参数。详见 [`ListConvoAIReq`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#listconvoaireq)。 | #### 返回值 [#返回值-2] 方法调用成功,返回 [`ListConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#listconvoaires) 对象。 ## query [#query] ```java public abstract Mono query(String agentId); ``` 查询指定智能体实例的当前状态。 :::info[信息] 自 v0.3.0 版本新增。 ::: :::warning[注意] 在使用此方法前,请确保已通过调用 [`join`](/zh-CN/api-reference/conversational-ai/restclient-java/convoaiclient.java#join) API 获取智能体 ID。 ::: #### 参数 [#参数-4] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `agentId` | `String` | 智能体 ID。 | #### 返回值 [#返回值-3] 方法调用成功,返回 [`QueryConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#queryconvoaires) 实例。 ## update [#update] ```java public abstract Mono update(String agentId, UpdateConvoAIReq request); ``` 在运行时调整智能体的参数。 :::info[信息] 自 v0.3.0 版本新增。 ::: :::warning[注意] 在使用此方法前,请确保已通过调用 [`join`](/zh-CN/api-reference/conversational-ai/restclient-java/convoaiclient.java#join) API 获取智能体 ID。 ::: #### 参数 [#参数-5] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `agentId` | `String` | 智能体 ID。 | | `request` | `UpdateConvoAIReq` | 用于更新智能体的参数,详见 [`UpdateConvoAIReq`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#updateconvoaireq)。 | #### 返回值 [#返回值-4] 方法调用成功,返回 [`UpdateConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#updateconvoaires) 对象。 ## interrupt [#interrupt] ```java public abstract Mono interrupt(String agentId); ``` 中断指定的智能体实例。 :::info[信息] 自 v0.4.0 版本新增。 ::: #### 参数 [#参数-6] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `agentId` | `String` | 要中断的智能体 ID。 | #### 返回值 [#返回值-5] 方法调用成功,返回中断响应结果,详见 [`InterruptConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#interruptconvoaires)。 ## speak [#speak] ```java public abstract Mono speak(String agentId, SpeakConvoAIReq request); ``` 为指定的智能体实例播报自定义消息。 :::info[信息] 自 v0.4.0 版本新增。 ::: #### 参数 [#参数-7] | 参数 | 数据类型 | 描述 | | --- | --- | --- | | `agentId` | `String` | 智能体 ID。 | | `request` | `SpeakConvoAIReq` | 播报自定义消息的请求体,详见 [`SpeakConvoAIReq`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#speakconvoaireq)。 | #### 返回值 [#返回值-6] 方法调用成功,返回响应对象 [`SpeakConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#speakconvoaires)。详见 [`SpeakConvoAIRes`](/zh-CN/api-reference/conversational-ai/restclient-java/struct#speakconvoaires)。