接口介绍
本接口(
/conversation/delete)用于批量删除原始对话消息。通过以下两种方式之一指定删除范围,二选其一:按 message id 批量删除:通过
message_ids 传入消息主键数组(非空),按主键精确删除一组消息。按 session 批量删除:通过
session_id 传入会话 ID,一次性删除该会话下的全部消息。说明:
message_ids 与 session_id 必须二选其一传入,全部缺省或同时传入均返回业务错误码 400,避免空筛选导致整个租户全量数据被删、或两者并用导致删除范围出现二义性。建议先用 query_conversation 预览将被命中的范围,再执行删除。Method 与 URL
POST https://{服务访问地址}/v2/conversation/delete
使用示例
示例 1:按 message id 批量删除
curl -i -k -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer ******************************' \\-H "x-tdai-service-id: mem-8i8t****" \\https://memory.tdai.tencentyun.com/v2/conversation/delete \\-d '{"message_ids": ["msg-aaaa", "msg-bbbb", "msg-cccc"]}'
示例 2:按 session 批量删除
curl -i -k -X POST \\-H 'Content-Type: application/json' \\-H 'Authorization: Bearer ******************************' \\-H "x-tdai-service-id: tdai-mem-8i8t****" \\https://memory.tdai.tencentyun.com/v2/conversation/delete \\-d '{"session_id": "session-trip-202604"}'
说明:
鉴权说明:所有接口都必须在请求头中携带
Authorization: Bearer <API Key> 与 x-tdai-service-id: <Service_ID>,否则将返回鉴权失败。请求参数
参数名 | 类型 | 必填 | 描述说明 |
message_ids | List[str] | 二选一 | 消息 ID 列表。 互斥规则:与 session_id 必须二选一传入,不可同时为空,也不建议同时传入。 约束条件:传入的数组必须包含至少 1 个有效的消息 ID(不可传空数组 [])。 |
session_id | str | 二选一 | 会话 ID。 互斥规则:与 message_ids 必须二选一传入。 应用场景:当需要直接指定整个会话、而不是筛选具体某几条消息时使用。 |
响应示例
{"code": 0,"message": "ok","request_id": "req-7fd3b2dd","data": {"deleted_count": 12}}
字段 | 类型 | 说明 |
deleted_count | int | 实际成功删除的消息总条数。 说明: 当使用 message_ids 列表进行批量删除时,如果传入了不存在、已被删除、或不属于当前用户/会话的无效 ID,系统将执行静默跳过(自动忽略)且不会报错。这些无效 ID 将不会被计入 deleted_count 中。 |