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

listing

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

方法介绍

listing 用于为 Agent 生成可用 Skill 的 XML 格式描述块。功能说明如下:
用途:生成的 XML 块可直接嵌入 Agent prompt 中的 <available_skills> 区块,使 Agent 知晓当前可用的 Skill。
筛选:通过 query 参数检索和筛选 Skill,仅将相关的 Skill 渲染到描述块中。
字符预算:通过 char_budget 控制返回的 XML 块最大字符数,避免超出 prompt 长度限制。

导入

from tencentdb_agent_memory.v3 import SkillClient

方法签名

def listing(
self,
*,
query: Optional[str] = None,
char_budget: Optional[int] = None,
team_id: Optional[str] = None,
agent_id: Optional[str] = None,
user_id: Optional[str] = None,
task_id: Optional[str] = None,
) -> Dict[str, Any]

使用示例

from tencentdb_agent_memory.v3 import SkillClient

with SkillClient(
endpoint="https://memory.tdai.tencentyun.com",
api_key="sk-xxxxxxxxxxxxxxxx",
service_id="tdai-mem-xxxxxxxx",
team_id="team-abc123",
agent_id="agt-xyz789",
user_id="usr-456",
) as client:
result = client.listing(
query="coding helper", # 可选,检索和筛选查询文本
char_budget=2000, # 可选,XML 块最大字符数
)
print(result["block"])

请求参数

参数名
类型
必填
描述说明
query
str
用于检索和筛选 Skill 的查询文本
char_budget
int
返回的 XML 块最大字符数
team_id
str
团队 ID,覆盖构造时的默认值
agent_id
str
Agent ID,覆盖构造时的默认值
user_id
str
用户 ID,覆盖构造时的默认值
task_id
str
Task ID,覆盖构造时的默认值

响应示例

{
"block": "<available_skills>\\n<skill>\\n<name>python-tips</name>\\n<description>Python coding tips and best practices</description>\\n</skill>\\n</available_skills>",
"count": 5,
"truncated": False
}

Running Environment

Operating System: Ubuntu 24.04.3 LTS / x86_64

Runtime Version: Python 3.11.1

响应参数说明

参数名
类型
参数含义
block
str
XML 格式的 Skill 描述块,可直接嵌入 Agent prompt
count
int
返回的 Skill 数量
truncated
bool
是否因字符预算限制而截断

错误码

错误码
触发场景
处理建议
401
API Key 无效或过期
检查 api_key 配置
422
构造参数缺失
确保构造时传入必填参数
500
服务内部错误
可有限重试