接口介绍
MetadataClient 提供以下团队成员管理接口,用于管理团队与用户之间的成员关系。
add_team_member:将用户添加为团队成员,并指定角色。
remove_team_member:从团队中移除指定成员。
list_team_members:分页查询团队下的全部成员。
get_team_member:查询单个成员在团队中的信息。
导入
from tencentdb_agent_memory.v3 import MetadataClient
方法签名
def add_team_member(self, p: Dict[str, Any]) -> Dict[str, Any]
def remove_team_member(self, team_id: str, user_id: str) -> Dict[str, Any]
def list_team_members(self,team_id_or_request: Union[str, Dict[str, Any], None] = None,*,pagination: Optional[Dict[str, Any]] = None,) -> Dict[str, Any]
def get_team_member(self, team_id: str, user_id: str) -> Dict[str, Any]
使用示例
add_team_member
from tencentdb_agent_memory.v3 import MetadataClientmetadata = MetadataClient(endpoint="https://memory.tdai.tencentyun.com",api_key="sk-xxxxxxxxxxxxxxxx",service_id="tdai-mem-xxxxxxxx",)resp = metadata.add_team_member({"team_id": "team-abc", # 必填,目标团队 ID"user_id": "user-123", # 必填,待添加的用户 ID"role": "member", # 可选,成员角色(owner/admin/member)})print(resp)
list_team_members
resp = metadata.list_team_members("team-abc", pagination={"limit": 50, "offset": 0})for m in resp["items"]:print(m["user_id"], m["role"])
get_team_member
resp = metadata.get_team_member("team-abc", "user-123")print(resp)
remove_team_member
resp = metadata.remove_team_member("team-abc", "user-123")print(resp)
请求参数
add_team_member
参数名 | 类型 | 必填 | 描述说明 |
team_id | str | 是 | 目标团队 ID |
user_id | str | 是 | 待添加的用户 ID |
role | str | 否 | 成员角色,如 owner、admin、member |
remove_team_member
参数名 | 类型 | 必填 | 描述说明 |
team_id | str | 是 | 团队 ID |
user_id | str | 是 | 待移除的用户 ID |
list_team_members
参数名 | 类型 | 必填 | 描述说明 |
team_id | str | 是 | 团队 ID |
pagination | Dict | 否 | 分页参数,含 limit 和 offset |
get_team_member
参数名 | 类型 | 必填 | 描述说明 |
team_id | str | 是 | 团队 ID |
user_id | str | 是 | 用户 ID |
响应示例
add_team_member
{"team_id": "team-abc","user_id": "user-123","role": "member","joined_at_ms": 1723968000000}
get_team_member
{"team_id": "team-abc","user_id": "user-123","role": "member","joined_at_ms": 1723900000000}
list_team_members
{"items": [{"user_id": "user-123","role": "member","joined_at_ms": 1723900000000},{"user_id": "user-456","role": "admin","joined_at_ms": 1723800000000}],"total": 2}
响应参数说明
参数名 | 类型 | 参数含义 |
team_id | str | 团队 ID |
user_id | str | 用户 ID |
role | str | 成员角色 |
joined_at_ms | int | 加入时间,Unix 时间戳,单位为毫秒 |
items | List[Dict] | 成员列表 |
total | int | 符合条件的成员总数 |
错误码
错误码 | 触发场景 | 处理建议 |
400 | 请求参数不合法 | 检查参数是否符合约束条件 |
401 | API Key 无效或缺失 | 检查 Bearer Token 配置 |
404 | 指定团队或用户不存在 | 确认 ID 是否正确 |
409 | 用户已是该团队成员 | 无需重复添加 |
500 | 服务内部错误 | 稍后重试 |