Update Agent

POST

/api/v1/indices/rag/app/update

cURL

curl -X POST "https://{workspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/indices/rag/app/update" \
  -H "Authorization: Bearer $DASHSCOPE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "aid-8f3a1b2c4d5e6f70",
    "agent_name": "客服知识问答助手 v2",
    "agent_config": {
        "agent_policy": "agentic",
        "agent_model": "qwen3.6-plus",
        "enable_session_file": "false",
        "enable_refusal": "true",
        "enable_anti_leak": "true",
        "enable_rich_text": "false",
        "enable_citation": "true",
        "temperature": 0.7,
        "max_num_llm_calls": 10,
        "kb_search_configs": [
            {
                "id": "pipeline-xxxxxx",
                "weight": 1,
                "dense_similarity_top_k": 15,
                "rerank_top_n": 5,
                "rerank": {
                    "model_name": "gte-rerank-hybrid",
                    "rerank_mode": "custom",
                    "rerank_instruct": "根据用户问题的技术领域对文档进行相关性排序"
                }
            }
        ]
    }
}'

{
  "request_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status_code": 200,
  "code": "Success",
  "message": "",
  "status": "SUCCESS",
  "success": true,
  "data": {
    "agent_id": "aid-8f3a1b2c4d5e6f70"
  }
}

Update an Agent's name, description, or draft configuration.

Updating an Agent requires the Knowledge Base - Modify permission.

agent_config only allows modifications to the beta draft version; published versions only permit updates to agent_version_desc. To modify the configuration of a published version, first call update to update the beta draft, then call deploy to publish the new version.

The agent_config structure is identical to that used in Create Agent.

Authorizations

string

header

required

DashScope API Key，在控制台 API Key 页面获取。

Body

application/json

string

required

Agent ID。

string

新的 Agent 名称，最长 200 字符。

Required range:length <= 200

string

新的 Agent 描述，最长 1000 字符。

Required range:length <= 1000

string

Agent 版本号，默认 beta。传入已发布版本号时只能修改 agent_version_desc。

string

版本描述。

object

Agent 配置对象，不传则使用默认配置。

Show child attributes

string

Agent 使用的模型名称，如 qwen3.7-plus、qwen3.6-plus。

enum<string>

Agent 策略：turbo（极速模式）或 agentic（智能体模式）。

Available options:turbo,agentic

enum<string>

是否开启防泄漏功能，true 或 false。

Available options:true,false

enum<string>

是否开启引用标注，true 或 false。

Available options:true,false

enum<string>

是否启用知识库路由（search 场景），true 或 false。

Available options:true,false

enum<string>

是否开启拒答功能，true 或 false。

Available options:true,false

enum<string>

是否开启富文本输出，true 或 false。

Available options:true,false

enum<string>

是否开启会话文件功能，true 或 false。

Available options:true,false

object

全局混排配置（search 场景）。

Show child attributes

string

混排模型代码。含 VL 知识库时仅限多模态模型；其他情况支持全部排序模型。

enum<string>

混排模式：qa、similar 或 custom。非 custom 模式下 rerank_instruct 会被自动清空。

Available options:qa,similar,custom

string

自定义混排指令，仅在 rerank_mode 为 custom 时生效，最长 500 字符。

Required range:length <= 500

string

路由模型名称，enable_kb_router 为 true 时必填，须在平台白名单内。

object[]

知识库检索配置列表。

Show child attributes

enum<string>

知识库可信度等级：low、medium、high。不传时默认回填 medium。

Available options:low,medium,high

integer

稠密检索返回的 Top-K 数量，范围 [1, 100]。

Required range:1 <= x <= 100

string

关联的知识库 Pipeline ID。

object

重排序配置。

Show child attributes

string

重排序模型名称，如 gte-rerank-hybrid。

string

自定义重排序指令，仅在 rerank_mode 为 custom 时生效，最长 500 字符。

Required range:length <= 500

enum<string>

重排序模式：qa（问答匹配）、similar（相似度匹配）或 custom（自定义指令）。非 custom 模式下 rerank_instruct 会被自动清空。

Available options:qa,similar,custom

number

重排序最低分数阈值，范围 [0, 1]，分数低于此值的切片会被过滤。

Required range:0 <= x <= 1

integer

重排序后保留的 Top-N 数量，范围 [1, 20]。

Required range:1 <= x <= 20

unknown[]

检索过滤条件，按知识库 schema 校验。

integer

稀疏检索 Top K，范围 [0, 100]。

Required range:0 <= x <= 100

number

知识库权重。

integer

最大生成 token 数，须大于等于 1。

Required range:x >= 1

integer

Agent 最大 LLM 调用次数，范围 [1, 30]。

Required range:1 <= x <= 30

integer

混排 Top N（search 场景），范围 [1, 20]。

Required range:1 <= x <= 20

integer

会话文件最大解析长度，须小于模型的 max_context_length。

Required range:x >= 1

number

模型采样温度，取值范围 [0, 2]。

Required range:0 <= x <= 2

string

自定义系统提示词（chat 场景），放在 agent_config 顶层，透传不校验，长度/生效由下游运行时决定。注意字段名是 user_system_prompt 而非 system_prompt。

Response

200-application/json

string

请求唯一标识，排查问题时请提供此 ID。

integer

HTTP 状态码。

string

响应码，成功时为 Success。

string

提示信息。

enum<string>

请求状态：SUCCESS 或 FAILED。

Available options:SUCCESS,FAILED

boolean

请求是否成功。

object

Show child attributes

string

Agent ID。