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

list_prompt_settings

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

方法介绍

list_prompt_settings 用于查询实例、团队或 Agent 与 Prompt 的绑定关系。功能说明如下:
组合筛选:支持按 Prompt ID、目标类型、团队 ID、Agent ID、Memory 层级等维度组合筛选。
分页查询:通过 limitoffset 参数实现分页,支持自定义排序方向。
绑定详情:返回每条设置记录的完整信息,包括操作人和更新时间。

导入

from tencentdb_agent_memory.v3 import AsyncMemoryPromptClient

方法签名

async def list_settings(
self,
*,
memory_prompt_id: Optional[str] = None,
target_type: Optional[str] = None,
team_id: Optional[str] = None,
agent_id: Optional[str] = None,
layer: Optional[str] = None,
limit: Optional[int] = None,
offset: Optional[int] = None,
time_order: Optional[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"
)

result = await client.list_settings(
target_type="team", # 可选,目标类型:instance/team/agent
layer="l1", # 可选,筛选层级
limit=20, # 可选,单次返回最大条数
offset=0 # 可选,分页偏移量
)
for item in result["items"]:
print(f"{item['setting_id']} -> {item['memory_prompt_id']}")

请求参数

参数名
类型
必填
描述说明
memory_prompt_id
str
按 Prompt ID 筛选
target_type
str
目标类型。
取值范围:instance(实例级)、team(团队级)、agent(Agent 级)
互斥约束:instance 不可同时传 team_idagent_idteam 不可同时传 agent_id
team_id
str
团队 ID
agent_id
str
Agent ID。传入时必须同时传 team_id
layer
str
Memory 层级筛选。取值范围:l1l2l3
limit
int
单页数量。取值范围:[1, 100],默认值:20
offset
int
分页偏移量。最小值:0,默认值:0
time_order
str
时间排序方向。取值范围:asc(升序)、desc(降序,默认)

响应示例

{
"items": [
{
"setting_id": "ps-aabb1122",
"target_type": "team",
"team_id": "team-001",
"agent_id": null,
"layer": "l1",
"memory_prompt_id": "mp-550e8400-e29b-41d4-a716-446655440000",
"updated_by": "user-001",
"updated_at_ms": 1723968000000
}
]
}

响应参数说明

参数名
类型
参数含义
items
List[Dict]
设置记录列表
items[].setting_id
str
设置记录唯一标识 ID
items[].target_type
str
目标类型:instanceteamagent
items[].team_id
str
团队 ID。当 target_typeinstance 时返回 null
items[].agent_id
str
Agent ID。当 target_typeagent 时返回 null
items[].layer
str
设置的 Memory 层级
items[].memory_prompt_id
str
绑定的 Prompt ID
items[].updated_by
str
最后操作人用户 ID(可能为空)
items[].updated_at_ms
int
最后更新时间,Unix 时间戳,单位为毫秒

错误码

错误码
触发场景
处理建议
400
参数组合不合法(如 target_type 为 instance 但传了 team_id)
检查参数互斥约束
401
API Key 缺失或格式不正确
检查 Bearer Token 配置
503
Prompt 存储服务暂时不可用
稍后重试