客户端介绍
MetadataClient 是 V3 管理面的 Python 客户端,用于管理用户、团队、Agent、Task、资产、权限、知识库等元数据资源。共 59 个方法,覆盖 14 组资源类型。导入
from tencentdb_agent_memory.v3 import MetadataClient, AsyncMetadataClient
构造
from tencentdb_agent_memory.v3 import MetadataClientmetadata = MetadataClient(endpoint="https://memory.tdai.tencentyun.com",api_key="sk-xxxxxxxxxxxxxxxx",service_id="tdai-mem-xxxxxxxx",user_key="sk-mem-...",timeout=30,verify=False,)
构造参数
参数名 | 类型 | 必填 | 描述说明 |
endpoint | str | 是 | Memory 服务接入地址 |
api_key | str | 是 | API Key,格式 sk-... |
service_id | str | 是 | 实例 ID,如 tdai-mem-xxxxxxxx |
user_key | str | 否 | 用户密钥,部分接口的鉴权令牌 |
timeout | float | 否 | 请求超时时间(秒),默认 30 |
verify | bool | 否 | 是否验证 SSL 证书,默认 False |
stub | Stub | 否 | 自定义网络传输通道 |
异步版本
AsyncMetadataClient 的方法签名与 MetadataClient 完全一致,所有方法均为 async:import asynciofrom tencentdb_agent_memory.v3 import AsyncMetadataClientasync def main():async with AsyncMetadataClient(endpoint="https://memory.tdai.tencentyun.com",api_key="sk-...",service_id="tdai-mem-xxxxxxxx",) as metadata:user = await metadata.create_user(user_id="usr-001", name="Alice")print(user)asyncio.run(main())
上下文管理器
with MetadataClient(endpoint="https://memory.tdai.tencentyun.com",api_key="sk-xxxxxxxxxxxxxxxx",service_id="tdai-mem-xxxxxxxx",) as metadata:users = metadata.list_users(limit=20)
方法总览
用户管理
方法 | 说明 |
create_user | 创建用户 |
get_user | 获取用户信息 |
delete_users | 批量删除用户 |
list_users | 列出用户 |
用户密钥管理
方法 | 说明 |
create_user_key | 创建用户密钥 |
list_user_keys | 列出用户密钥 |
get_user_key | 获取密钥详情 |
revoke_user_key | 撤销密钥 |
update_user_key | 更新密钥 |
团队管理
方法 | 说明 |
create_team | 创建团队 |
get_team | 获取团队信息 |
update_team | 更新团队 |
delete_teams | 批量删除团队 |
list_teams | 列出团队 |
团队成员管理
方法 | 说明 |
add_team_member | 添加成员 |
remove_team_member | 移除成员 |
list_team_members | 列出成员 |
get_team_member | 获取成员信息 |
Agent 管理
方法 | 说明 |
create_agent | 创建 Agent |
get_agent | 获取 Agent 信息 |
update_agent | 更新 Agent |
delete_agents | 批量删除 Agent |
list_agents | 列出 Agent |
archive_agent | 归档 Agent |
Task 管理
方法 | 说明 |
create_task | 创建 Task |
get_task | 获取 Task 信息 |
update_task | 更新 Task |
delete_tasks | 批量删除 Task |
list_tasks | 列出 Task |
archive_task | 归档 Task |
Task-Agent 关联
方法 | 说明 |
link_task_agent | 关联 Task 和 Agent |
unlink_task_agent | 解除关联 |
list_task_agents | 列出 Task 下的 Agent |
参与日志
方法 | 说明 |
append_participation_log | 追加参与日志 |
list_participation_logs | 列出参与日志 |
资产管理
方法 | 说明 |
create_asset | 创建资产 |
get_asset | 获取资产信息 |
update_asset | 更新资产 |
delete_assets | 批量删除资产 |
list_assets | 列出资产 |
list_accessible_assets | 列出可访问的资产 |
touch_asset_usage | 更新资产使用记录 |
Agent 固定资产
方法 | 说明 |
set_agent_fixed_assets | 设置 Agent 固定资产 |
list_agent_fixed_assets | 列出 Agent 固定资产 |
list_agent_fixed_assets_with_detail | 列出 Agent 固定资产(含详情) |
summarize_agent_fixed_assets_by_agents | 按 Agent 汇总固定资产 |
访问控制(ACL)
方法 | 说明 |
grant_acl | 授予权限 |
revoke_acl | 撤销权限 |
list_acl | 列出权限 |
check_acl | 检查权限 |
鉴权
方法 | 说明 |
verify_auth | 验证鉴权信息 |
配置与配额
方法 | 说明 |
get_instance_quota | 获取实例配额 |
get_user_config | 获取用户配置 |
set_user_config | 设置用户配置 |
知识库管理
方法 | 说明 |
create_knowledge | 创建知识库 |
get_knowledge | 获取知识库 |
update_knowledge | 更新知识库 |
delete_knowledge | 删除知识库 |
list_knowledge | 列出知识库 |
详细文档
各资源组的接口详细说明请参考以下独立文档:
文档 | 内容 |
create_user, get_user, delete_users, list_users | |
create_user_key, list_user_keys, get_user_key, revoke_user_key, update_user_key | |
create_team, get_team, update_team, delete_teams, list_teams | |
add_team_member, remove_team_member, list_team_members, get_team_member | |
create_agent, get_agent, update_agent, delete_agents, list_agents, archive_agent | |
create_task, get_task, update_task, delete_tasks, list_tasks, archive_task | |
link_task_agent, unlink_task_agent, list_task_agents | |
append_participation_log, list_participation_logs | |
create_asset, get_asset, update_asset, delete_assets, list_assets, list_accessible_assets, touch_asset_usage | |
set_agent_fixed_assets, list_agent_fixed_assets, list_agent_fixed_assets_with_detail, summarize_agent_fixed_assets_by_agents | |
grant_acl, revoke_acl, list_acl, check_acl | |
verify_auth | |
get_instance_quota, get_user_config, set_user_config | |
create_knowledge, get_knowledge, update_knowledge, delete_knowledge, list_knowledge |