设置 State

最近更新时间:2025-09-12 21:41:52

我的收藏

接口定义

本接口set_state()用于设置当前会话中的状态数据。
def set_state(
session_id: str,
state: Dict[str, Any],
memory_id: str | None = None,
actor_id: str | None = None
) -> Dict[str, Any]


使用示例

import json
from tdaimemory import MemoryClient

set_state_result = client.set_state(
session_id="session-Y5oi****",
state={
"user_language": "en-US",
"notification_enabled": True,
"环境偏好": "安静、人少",
},
)
print(json.dumps(set_state_result, ensure_ascii=False))

请求参数

参数
是否必选
参数含义
配置方法及要求
memory_id
指定需设置当前会话状态的 Memory ID。
登录 Memory 智能体控制台,可在 Memory 服务概览页面复制 Memory ID。具体可以参见 查看 Memory
actor_id
指定需设置当前会话状态的用户 ID。
数据类型:String
长度限制:[1,20]
字符规则:任意字符
session_id
指定需设置当前会话状态的会话 ID。
获取会话 ID,请参见 查询 Session
state
指定需设置的状态数据,对于已存在的更新,不存在的新增。
允许包含一个或多个任意类型的键值对,如字符串、数字、布尔值、数组、对象等。示例如下所示。
{
"user_preference_theme": "light", // 字符串值
"shopping_cart_items": ["laptop", "headphones"], // 数组/列表值
"user_language": "zh-CN", // 字符串值
"notification_enabled": true // 布尔值
}

响应消息

执行成功,输出如下信息。
>>> print(json.dumps(set_state_result, ensure_ascii=False))
{"affected_count": 3}
参数名
参数含义
affected_count
设置成功的状态数量。