# Client 类 (/zh-CN/api-reference/conversational-ai/restclient-go/client.go)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## NewClient [#newclient]
```go
func NewClient(config *Config) (*Client, error)
```
使用指定配置创建一个对话式 AI 引擎 REST Client。
:::info[信息]
自 v0.7.0 版本新增。
:::
#### 参数 [#参数]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `config` | `Config` | 对话式 AI 引擎 REST Client 的配置,详见 [`Config`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#config)。 |
#### 返回值 [#返回值]
- `*Client`:方法调用成功时返回对话式 AI 引擎 REST Client ,详见 [`Client`](/zh-CN/api-reference/conversational-ai/restclient-go/client.go)。
- `error`:方法调用失败时返回错误信息,详见 `error`。
## Join [#join]
```go
func (c *Client) Join(ctx context.Context, name string, payload *req.JoinPropertiesReqBody) (*resp.JoinResp, error)
```
创建智能体实例并加入指定的 RTC 频道。
:::info[信息]
自 v0.7.0 版本新增。
:::
#### 参数 [#参数-1]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `name` | `string` | 智能体的唯一标识符,不能重复使用。 |
| `payload` | `JoinPropertiesReqBody` | 智能体的配置信息,包括频道信息、Token、LLM 设置、TTS 设置等。详见 [`JoinPropertiesReqBody`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#joinpropertiesreqbody)。 |
#### 返回值 [#返回值-1]
- `*JoinResp`:方法调用成功时返回响应,详见 [`JoinResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#joinresp)。
- `error`:方法调用失败时返回错误对象,包含错误信息;调用成功时返回 `nil`。
## Leave [#leave]
```go
func (c *Client) Leave(ctx context.Context, agentId string) (*resp.LeaveResp, error)
```
停止指定的智能体实例并离开 RTC 频道。
:::info[信息]
自 v0.7.0 版本新增。
:::
:::warning[注意]
调用此方法前,请确保已通过调用 [`Join`](/zh-CN/api-reference/conversational-ai/restclient-go/client.go#join) 获取智能体 ID。
:::
#### 参数 [#参数-2]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `agentId` | `string` | 智能体 ID。 |
#### 返回值 [#返回值-2]
- `*LeaveResp`:方法调用成功时返回响应,详见 [`LeaveResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#leaveresp)。
- `error`:方法调用失败时返回错误信息,成功时返回 `nil`。
## Query [#query]
```go
func (c *Client) Query(ctx context.Context, agentId string) (*resp.QueryResp, error)
```
查询指定智能体实例的当前状态。
:::info[信息]
自 v0.7.0 版本新增。
:::
:::warning[注意]
在使用此方法前,请确保已通过调用 [`Join`](/zh-CN/api-reference/conversational-ai/restclient-go/client.go#join) 获取智能体 ID。
:::
#### 参数 [#参数-3]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `agentId` | `string` | 智能体 ID。 |
#### 返回值 [#返回值-3]
- `*resp.QueryResp`:方法调用成功时返回响应,详见 [`QueryResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#queryresp)。
- `error`:方法调用失败时返回错误信息,详见 `error`;调用成功时返回 `nil`。
## List [#list]
```go
func (c *Client) List(ctx context.Context, options ...req.ListOption) (*resp.ListResp, error)
```
获取符合指定条件的智能体列表。
:::info[信息]
自 v0.7.0 版本新增。
:::
#### 参数 [#参数-4]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `options` | `...ListOption` | 可变参数,表示可以接受零个或多个参数。查询参数,详见 [`ListOption`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#listoption)。 |
#### 返回值 [#返回值-4]
- 方法调用成功,返回 [`ListResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#listresp) 对象,详见 [`ListResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#listresp)。
- 方法调用失败,返回错误信息,详见 `error`。
## Update [#update]
```go
func (c *Client) Update(ctx context.Context, agentId string, payload *req.UpdateReqBody) (*resp.UpdateResp, error)
```
在运行时调整智能体的参数。
:::info[信息]
自 v0.7.0 版本新增。
:::
:::warning[注意]
在使用此方法前,请确保已通过调用 [`Join`](/zh-CN/api-reference/conversational-ai/restclient-go/client.go#join) 获取智能体 ID。
:::
#### 参数 [#参数-5]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `agentId` | `string` | 智能体 ID。 |
| `payload` | `*UpdateReqBody` | 要调整的参数,详见 [`UpdateReqBody`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#updatereqbody)。 |
#### 返回值 [#返回值-5]
- `*UpdateResp`:方法调用成功时返回响应,详见 [`UpdateResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#updateresp)。
- `error`:方法调用失败时返回错误对象,包含错误信息。
## Interrupt [#interrupt]
```go
func (c *Client) Interrupt(ctx context.Context, agentId string) (*resp.InterruptResp, error)
```
中断指定的智能体实例。
:::info[信息]
自 v0.9.0 版本新增。
:::
#### 参数 [#参数-6]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `agentId` | `string` | 智能体 ID。 |
#### 返回值 [#返回值-6]
- `*resp.InterruptResp`:方法调用成功时返回响应,详见 [`InterruptResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#interruptresp)。
- `error`:方法调用失败时返回错误信息,调用成功时返回 `nil`。
## GetHistory [#gethistory]
```go
func (c *Client) GetHistory(ctx context.Context, agentId string) (*resp.HistoryResp, error)
```
获取指定智能体实例的短期记忆。
:::info[信息]
自 v0.9.0 版本新增。
:::
#### 参数 [#参数-7]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `agentId` | `string` | 智能体 ID。 |
#### 返回值 [#返回值-7]
- 方法调用成功时,返回 [`HistoryResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#historyresp) 对象,详见 [`HistoryResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#historyresp)。
- 方法调用失败时,返回错误信息,详见 `error`。
## Speak [#speak]
```go
func (c *Client) Speak(ctx context.Context, agentId string, payload *req.SpeakBody) (*resp.SpeakResp, error)
```
让指定智能体说出自定义消息。
:::info[信息]
自 v0.9.0 版本新增。
:::
#### 参数 [#参数-8]
| 参数 | 数据类型 | 描述 |
| --- | --- | --- |
| `ctx` | `Context` | 用于控制请求生命周期的上下文。 |
| `agentId` | `string` | 智能体 ID。 |
| `payload` | `SpeakBody` | 请求体,指定智能体说出自定义消息。详见 [`SpeakBody`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#speakbody)。 |
#### 返回值 [#返回值-8]
- 方法调用成功时,返回 [`SpeakResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#speakresp) 对象,详见 [`SpeakResp`](/zh-CN/api-reference/conversational-ai/restclient-go/struct#speakresp)。
- 方法调用失败时,返回错误信息,详见 `error`。