接口介绍
本接口(/memory/v1/state/delete)用于删除会话中指定的一个或多个状态键。
说明:
本接口仅删除指定的状态键,不会清空整个会话中的所有状态信息。
Method 与 URL
POST https://{服务访问地址}/memory/v1/state/delete
使用示例
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/memory/v1/state/delete \\-d '{"memory_id": "tdai-mem-8i8t****","actor_id": "user-test-001","session_id": "session-PTVM****","keys": ["notification_enabled", "天气查询"]}'
请求参数
参数 | 是否必选 | 参数含义 | 配置方法及要求 |
memory_id | 是 | 指定需删除会话状态的 Memory ID。 | |
actor_id | 是 | 指定需删除会话状态的用户 ID。 | 数据类型:String 长度限制:[1,20] 字符规则:任意字符 |
session_id | 是 | 指定需删除会话状态的会话 ID。 | |
keys | 是 | 指定需删除的状态键列表。 | 数据类型:String 数组。 示例:["user_preference_theme", "shopping_cart_items"] |
响应消息
执行成功,输出如下信息。
{"code": "0","message": "All states deleted successfully","data": {"affected_count": 2}}
参数名(一级) | 参数名(二级) | 参数含义 |
data | affected_count | 返回删除的状态键数量。 |