UpdateAgent

POST

https://aigc-aiagent-api.zegotech.cn/

通过向本接口传入智能体 ID 和基础配置，您可以更新一个现有的智能体。

Request

Query Parameters

Action string必填

可选值: [UpdateAgent]

接口原型参数

https://aigc-aiagent-api.zegotech.cn?Action=UpdateAgent

AppId uint32必填

💡公共参数。应用 Id，由 ZEGO 分配的用户唯一凭证。可从 ZEGO 控制台获取。

SignatureNonce string必填

💡公共参数。16 位 16 进制随机字符串（8 字节随机数的 hex 编码）。生成算法可参考签名示例。

Timestamp int64必填

💡公共参数。当前 Unix 时间戳，单位为秒。生成算法可参考签名示例，最多允许 10 分钟的误差。

Signature string必填

💡公共参数。签名，用于验证请求的合法性。请参考签名机制生成。

SignatureVersion string必填

可选值: [2.0]

默认值: 2.0

💡公共参数。签名版本号。

application/json

Body

required

📌 注意：只有传入本接口的参数才会生效，未传入的参数不会更新。

AgentId string必填

已注册智能体的唯一标识。

Name string

可选值: <= 64 characters

智能体名称

LLM object

Vendor string

可选值: [OpenAIChat, OpenAIResponses]

默认值: OpenAIChat

LLM 接口的供应商类别。

OpenAIChat：OpenAI 的 Chat Completions 接口类型。
OpenAIResponses：OpenAI 的 Responses API 接口类型。

Url string必填

接收请求的端点（可以是你自己的服务，也可以是任何 LLM 服务提供商提供的服务）。如果 Vendor 为 OpenAIChat ，则必须兼容 OpenAI Chat Completions API。例如：https://api.openai.com/v1/chat/completions

如果 Vendor 为 OpenAIResponses ，则必须兼容 OpenAI Responses API。例如：https://ark.cn-beijing.volces.com/api/v3/responses

📌 重要说明

如果 ApiKey 设置为 "zego_test"，则必须使用以下 Url 地址之一：

MiniMax：https://api.minimax.chat/v1/text/chatcompletion_v2

火山引擎（豆包）：https://ark.cn-beijing.volces.com/api/v3/chat/completions

阿里云百炼（通义千问）：https://dashscope.aliyuncs.com/compatible-mode/v1/chat/completions

阶跃星辰：https://api.stepfun.com/v1/chat/completions

ApiKey string

LLM 服务提供商用于认证的参数。默认为空，但在生产环境中必须提供。

📌 重要说明

在接入测试期间(AI Agent 服务开通 2 周内)，可以将该参数值设置为 "zego_test" 即可使用该服务。

Model string必填

LLM 模型。不同的 LLM 服务提供商支持不同的模型，请参考其官方文档选择合适的模型。

📌 重要说明

如果 ApiKey 设置为 "zego_test"，则必须使用以下模型之一：

MiniMax：

MiniMax-Text-01

火山引擎（豆包）：

doubao-1-5-pro-32k-250115

doubao-1-5-lite-32k-250115

阿里云百炼（通义千问）：

qwen-plus

阶跃星辰：

step-2-16k

SystemPrompt string

智能体系统提示（prompt）。调用 LLM 时附加在最前的预定义信息，用于控制 LLM 输出。可以是角色设定、提示词和回答样例等。

Temperature number

可选值: >= 0 and <= 2

默认值: 0.7

数值越高，输出越随机；数值越低，输出越集中和确定。

TopP number

可选值: >= 0 and <= 1

默认值: 0.9

采样方法，数值越小，确定性越强；数值越大，随机性越强。

Params object

LLM 服务提供商支持的其他参数，如最大 Token 数量限制等。不同的 LLM 提供商支持不同的参数，请参考其官方文档并根据需要填写。

AddAgentInfo boolean

默认值: false

如果此值为 true，AI Agent 服务器在请求 LLM 服务时会在请求参数中包含智能体信息（agent_info）。包含的智能体信息数示例请参考使用自定义 LLM。您可以使用此参数在自定义 LLM 服务中执行额外的业务逻辑。

agent_info 的结构如下：

room_id: 房间 ID
user_id: 用户 ID
agent_instance_id: 智能体实例 ID

📌 重要说明：仅在 Vendor 为 "OpenAIChat" 时有效。

AgentExtraInfo object

Agent 扩展信息，服务器在请求 LLM 服务时会在请求参数中透传该参数。透传参数示例请参考使用自定义 LLM。您可以使用此参数在自定义 LLM 服务中执行额外的业务逻辑。📌 重要说明：仅在 Vendor 为 "OpenAIChat" 时有效。

key string

额外信息键。

value

额外信息值，可以是任意类型。

TTS object

Vendor string必填

可选值: [Aliyun, ByteDance, ByteDanceV3, ByteDanceFlowing, MiniMax, CosyVoice]

语音合成（TTS）服务提供商。详细请参考配置 TTS > TTS 参数说明

Params objectrequired

TTS 配置参数，格式为 JSON 对象。包含 app 参数（用于认证）和其他参数（用于调整 TTS 效果）。详细请参考配置 TTS > Params 参数说明

app object必填

用于 TTS 服务鉴权，不同的 Vendor 值要求传入的 app 参数的结构不同，详细请参考配置 TTS > Params 参数说明

other_params string

📌 重要说明

other_params 不是一个有效参数，仅仅是为了说明如何透传厂商参数。除 app 参数外，其余参数均直接透传厂商参数。详细请参考配置 TTS > Params 参数说明

FilterText object[]

从 LLM 返回的内容中过滤指定标点符号内的文本，然后再进行语音合成。注意：

需要在 LLM > SystemPrompt 中定义哪些内容应该放在指定标点符号内
此参数在更新智能体实例时无法更新

Array[

BeginCharacters string必填

过滤文本的开始标点符号。例如，如果要过滤 () 中的内容，请设置为 (。

EndCharacters string必填

过滤文本的结束标点符号。例如，如果要过滤 () 中的内容，请设置为 )。

]

TerminatorText string

可选值: <= 4 characters

可用于设置 TTS 的终止文本。若输入 TTS 的文本中出现匹配 TerminatorText 字符串的内容，则本轮 TTS 从 TerminatorText 字符串（包含）开始的内容将不再进行语音合成。

📌 重要说明

双向流式只能设置一个字符。

ASR object

Vendor string

可选值: [Tencent, AliyunParaformer, AliyunGummy, Microsoft]

默认值: Tencent

ASR 厂商。可参考配置 ASR 参数说明。

Params object

厂商参数，具体使用方式参考配置 ASR 中的 Params 参数说明。

VADSilenceSegmentation number

可选值: >= 200 and <= 2000

默认值: 500

用于设置用户说话停顿多少秒后，不再将两句话视为一句。单位为 ms，范围 [200，2000]，默认为 500。详细说明请参考语音识别断句。

📌 重要说明

当 Vendor 为 "Tencent" （默认）时，最大值为 1500。

PauseInterval number

可选值: >= 200 and <= 2000

用于设置用户说话停顿多少秒内，将两句话视为一句，即 ASR 多句拼接。单位为 ms，范围 [200，2000]。仅当此值大于 VADSilenceSegmentation 时，才会启用 ASR 多句拼接。详细说明请参考语音识别断句。

HotWord string已废弃

该参数已废弃。请通过 Params 厂商参数设置。

Responses

更新成功

application/json

数据结构
按数据结构生成的示例

Schema

Code integer

返回码，0 表示成功，其他值表示失败。详情请参考返回码说明。

Message string

请求结果说明

RequestId string

请求 ID

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "1843985617336143872"
}

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "1843985617336143872"
}