Client 类

NewClient

Go

func NewClient(config *Config) (*Client, error)

使用指定配置创建一个对话式 AI 引擎 REST Client。

信息

自 v0.7.0 版本新增。

参数

参数	数据类型	描述
config	Config	对话式 AI 引擎 REST Client 的配置，详见 Config。

返回值

• *Client：方法调用成功时返回对话式 AI 引擎 REST Client ，详见 Client。
• error：方法调用失败时返回错误信息，详见 error。

Join

Go

func (c *Client) Join(ctx context.Context, name string, payload *req.JoinPropertiesReqBody) (*resp.JoinResp, error)

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

信息

自 v0.7.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
name	string	智能体的唯一标识符，不能重复使用。
payload	JoinPropertiesReqBody	智能体的配置信息，包括频道信息、Token、LLM 设置、TTS 设置等。详见 JoinPropertiesReqBody。

返回值

• *JoinResp：方法调用成功时返回响应，详见 JoinResp。
• error：方法调用失败时返回错误对象，包含错误信息；调用成功时返回 nil。

Leave

Go

func (c *Client) Leave(ctx context.Context, agentId string) (*resp.LeaveResp, error)

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

信息

自 v0.7.0 版本新增。

注意

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

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
agentId	string	智能体 ID。

返回值

• *LeaveResp：方法调用成功时返回响应，详见 LeaveResp。
• error：方法调用失败时返回错误信息，成功时返回 nil。

Query

Go

func (c *Client) Query(ctx context.Context, agentId string) (*resp.QueryResp, error)

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

信息

自 v0.7.0 版本新增。

注意

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

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
agentId	string	智能体 ID。

返回值

• *resp.QueryResp：方法调用成功时返回响应，详见 QueryResp。
• error：方法调用失败时返回错误信息，详见 error；调用成功时返回 nil。

List

Go

func (c *Client) List(ctx context.Context, options ...req.ListOption) (*resp.ListResp, error)

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

信息

自 v0.7.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
options	...ListOption	可变参数，表示可以接受零个或多个参数。查询参数，详见 ListOption。

返回值

• 方法调用成功，返回 ListResp 对象，详见 ListResp。
• 方法调用失败，返回错误信息，详见 error。

Update

Go

func (c *Client) Update(ctx context.Context, agentId string, payload *req.UpdateReqBody) (*resp.UpdateResp, error)

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

信息

自 v0.7.0 版本新增。

注意

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

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
agentId	string	智能体 ID。
payload	*UpdateReqBody	要调整的参数，详见 UpdateReqBody。

返回值

• *UpdateResp：方法调用成功时返回响应，详见 UpdateResp。
• error：方法调用失败时返回错误对象，包含错误信息。

Interrupt

Go

func (c *Client) Interrupt(ctx context.Context, agentId string) (*resp.InterruptResp, error)

中断指定的智能体实例。

信息

自 v0.9.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
agentId	string	智能体 ID。

返回值

• *resp.InterruptResp：方法调用成功时返回响应，详见 InterruptResp。
• error：方法调用失败时返回错误信息，调用成功时返回 nil。

GetHistory

Go

func (c *Client) GetHistory(ctx context.Context, agentId string) (*resp.HistoryResp, error)

获取指定智能体实例的短期记忆。

信息

自 v0.9.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
agentId	string	智能体 ID。

返回值

• 方法调用成功时，返回 HistoryResp 对象，详见 HistoryResp。
• 方法调用失败时，返回错误信息，详见 error。

Speak

Go

func (c *Client) Speak(ctx context.Context, agentId string, payload *req.SpeakBody) (*resp.SpeakResp, error)

让指定智能体说出自定义消息。

信息

自 v0.9.0 版本新增。

参数

参数	数据类型	描述
ctx	Context	用于控制请求生命周期的上下文。
agentId	string	智能体 ID。
payload	SpeakBody	请求体，指定智能体说出自定义消息。详见 SpeakBody。

返回值

• 方法调用成功时，返回 SpeakResp 对象，详见 SpeakResp。
• 方法调用失败时，返回错误信息，详见 error。