帮你快速理解、总结文档立即下载

set_prompt

最近更新时间:2026-08-27 17:42:01
我的收藏

方法介绍

set_prompt 用于将指定层级的 Prompt 应用到目标范围,或者清除目标范围上的自定义设置。功能说明如下:
灵活范围:支持实例级、团队级和 Agent 级三种目标范围。目标范围由参数组合决定:
不传 team_idagent_ids:实例级。
仅传 team_id:团队级。
同时传 team_idagent_ids:Agent 级。
批量设置:Agent 级支持批量设置 1 至 100 个 Agent。
应用与清除:通过 action 参数控制是应用 Prompt 还是清除已有设置。
操作审计:支持传入 user_id,操作记录将写入变更日志。

导入

from tencentdb_agent_memory.v3 import AsyncMemoryPromptClient

方法签名

# 应用 Prompt
async def apply(
self,
memory_prompt_id: str,
*,
layer: str,
team_id: Optional[str] = None,
agent_ids: Optional[List[str]] = None,
) -> Dict[str, Any]

# 清除 Prompt 设置
async def clear(
self,
*,
layer: str,
team_id: Optional[str] = None,
agent_ids: Optional[List[str]] = None,
) -> Dict[str, Any]

使用示例

from tencentdb_agent_memory.v3 import AsyncMemoryPromptClient

client = AsyncMemoryPromptClient(
endpoint="https://memory.tdai.tencentyun.com",
api_key="sk-xxxxxxxxxxxxxxxx",
service_id="tdai-mem-xxxxxxxx"
)

# 应用 Prompt 到团队
result = await client.apply(
memory_prompt_id="mp-550e8400-e29b-41d4-a716-446655440000", # 必填,Prompt ID
layer="l1", # 必填,Memory 层级:l1/l2/l3
team_id="team-001", # 可选,团队 ID
)
print(result)

# 批量清除 Agent 设置
result = await client.clear(
layer="l1", # 必填,Memory 层级
team_id="team-001", # 可选,团队 ID
agent_ids=["agent-001", "agent-002"], # 可选,Agent ID 列表,1-100 个
)
print(result)

请求参数

参数名
类型
必填
描述说明
action
str
操作类型。取值范围:
apply:应用 Prompt
clear:清除设置
layer
str
操作的 Memory 层级。取值范围:l1l2l3action=apply 时,Prompt 自身 layer 必须与此一致
memory_prompt_id
str
要应用的 Prompt ID。action=apply 时必填;action=clear 时无需传入
team_id
str
团队目标 ID。不传表示实例级设置
agent_ids
List[str]
Agent 目标 ID 列表。数量限制:[1, 100],元素不可重复。传入时必须同时传 team_id
user_id
str
操作人用户 ID,传入后将记录到操作日志中

响应示例

{
"affected": 3
}

响应参数说明

参数名
类型
参数含义
affected
int
实际新增、替换或清除的设置数量。重复操作时为 0

错误码

错误码
触发场景
处理建议
400
参数不合法(如 action 取值错误、layer 不匹配、agent_ids 超限)
检查参数是否符合约束条件
400
Prompt 自身的层级与请求指定的 layer 不一致
确认 Prompt 的 layer 与请求参数一致
401
API Key 缺失或格式不正确
检查 Bearer Token 配置
404
指定 Prompt 不存在或已被删除
确认 Prompt ID 是否正确
503
Prompt 存储服务暂时不可用
稍后重试