更新智能体配置
更新时间不可用
更新指定运行中智能体的部分参数配置。
POST
https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/{appid}/agents/{agentId}/updateappidstring必填
你的项目使用的 App ID。
agentIdstring必填
智能体实例 ID，即智能体的唯一标识。调用 POST 创建对话式智能体 成功后在响应包体中获取。
Authorizationstring必填
发送 HTTP 请求时，你可以从以下鉴权方式中任选其一：
- 使用 Token 认证（推荐）：参考实现 HTTP 鉴权生成 Token 并填入
AuthorizationHeader。传参示例：Authorization: agora token="007abcxxxxxxx123"。 - 使用 Basic Auth：参考实现 HTTP 鉴权生成 Base64 编码的
Authorization字段。传参示例：Authorization: Basic NDI1OTQ3N2I4MzYy...YwZjA=。
tokenstring用于鉴权的动态密钥。如果你的项目已启用 App 证书，则务必在该字段中传入你项目的动态密钥。运行中的智能体收到 104 agent expire 事件后，你可以调用本接口并更新该字段以刷新 RTC Token。详见使用 Token 鉴权。
大语言模型 (LLM) 设置。
system_messagesarray<object>一组每次调用 LLM 时被附加在最前的预定义信息，用于控制 LLM 输出。可以是角色设定、提示词和回答样例等。要求与 OpenAI 协议兼容。
paramsobject在消息体内传输的 LLM 附加信息，例如使用的模型、最大 Token 数限制等。不同的 LLM 供应商支持的配置不同，请参考对应文档按需填入。
注意
该字段更新后将覆盖智能体创建时的配置。更新时，请确保传入完整的 params 字段。
响应
- 若返回的状态码为
200则表示请求成功。响应包体中包含本次请求的结果。 - 若返回的状态码不为
200则表示请求失败。响应包体中包含错误的类别和描述，你可以参考响应状态码了解可能的原因。
响应 Body
agent_idstring智能体唯一标识符。
create_tsinteger智能体创建时间戳。
statestring智能体运行状态：
IDLE(0)：空闲状态的智能体。STARTING(1)：正在启动的智能体。RUNNING(2)：正在运行的智能体。STOPPING(3)：正在停止的智能体。STOPPED(4)：已完成退出的智能体。FAILED(6)：执行失败的智能体。
请求示例
curl --request POST \
--url "https://api.agora.io/cn/api/conversational-ai-agent/v2/projects/:appid/agents/:agentId/update" \
--header 'Authorization: agora token="007abcxxxxxxx123"' \
-H 'Content-Type: application/json' \
-d '{
"properties": {
"token": "007eJxTYxxxxxxxxxxIaHMLAAAA0ex66",
"llm": {
"system_messages": [
{
"role": "system",
"content": "You are a helpful assistant. xxx"
},
{
"role": "system",
"content": "Previously, user has talked about their favorite hobbies with some key topics: xxx"
}
],
"params": {
"model": "abab6.5s-chat",
"max_token": 1024
}
}
}
}'响应示例
{
"agent_id": "1NT29XOXFT4Jxxxx410TXRCFG10HI00",
"create_ts": 173836896,
"state": "RUNNING"
}