-
Notifications
You must be signed in to change notification settings - Fork 5
Expand file tree
/
Copy path__session_store_async_template.py
More file actions
770 lines (667 loc) · 24 KB
/
__session_store_async_template.py
File metadata and controls
770 lines (667 loc) · 24 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
"""SessionStore 核心业务逻辑层。
提供框架无关的统一会话管理接口,包括 Session、Event、State 的 CRUD,
以及级联删除和三级状态合并。
"""
from __future__ import annotations
import logging
from typing import Any, Optional
from agentrun.conversation_service.model import (
ConversationEvent,
ConversationSession,
StateScope,
)
from agentrun.conversation_service.ots_backend import OTSBackend
from agentrun.conversation_service.utils import nanoseconds_timestamp
logger = logging.getLogger(__name__)
class SessionStore:
"""核心业务逻辑层。
封装 OTSBackend,实现级联删除、状态合并等业务逻辑,
向上暴露框架无关的统一接口。
同时提供异步(_async 后缀)和同步方法。
Args:
ots_backend: OTS 存储后端实例。
"""
def __init__(self, ots_backend: OTSBackend) -> None:
self._backend = ots_backend
async def init_tables_async(self) -> None:
"""创建所有 OTS 表、二级索引和多元索引(异步)。
包括建表和创建搜索索引,无需再单独调用 init_search_index_async()。
"""
await self._backend.init_tables_async()
async def init_core_tables_async(self) -> None:
"""创建核心表(Conversation + Event)和二级索引(异步)。"""
await self._backend.init_core_tables_async()
async def init_state_tables_async(self) -> None:
"""创建三张 State 表(异步)。"""
await self._backend.init_state_tables_async()
async def init_search_index_async(self) -> None:
"""创建 Conversation 和 State 多元索引(异步)。
索引已存在时跳过,可重复调用。
"""
await self._backend.init_search_index_async()
# -------------------------------------------------------------------
# Session 管理(异步)/ Session management (async)
# -------------------------------------------------------------------
async def create_session_async(
self,
agent_id: str,
user_id: str,
session_id: str,
*,
is_pinned: bool = False,
summary: Optional[str] = None,
labels: Optional[str] = None,
framework: Optional[str] = None,
extensions: Optional[dict[str, Any]] = None,
) -> ConversationSession:
"""创建新 Session(异步)。
自动设置 created_at 和 updated_at 为当前纳秒时间戳。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
is_pinned: 是否置顶。
summary: 会话摘要。
labels: 会话标签。
framework: 框架标识。
extensions: 框架扩展数据。
Returns:
创建完成的 ConversationSession 对象。
"""
now = nanoseconds_timestamp()
session = ConversationSession(
agent_id=agent_id,
user_id=user_id,
session_id=session_id,
created_at=now,
updated_at=now,
is_pinned=is_pinned,
summary=summary,
labels=labels,
framework=framework,
extensions=extensions,
version=0,
)
await self._backend.put_session_async(session)
return session
async def get_session_async(
self,
agent_id: str,
user_id: str,
session_id: str,
) -> Optional[ConversationSession]:
"""获取单个 Session(异步)。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
Returns:
ConversationSession 对象,不存在时返回 None。
"""
return await self._backend.get_session_async(
agent_id, user_id, session_id
)
async def list_sessions_async(
self,
agent_id: str,
user_id: str,
limit: Optional[int] = None,
) -> list[ConversationSession]:
"""列出用户的 Session(按 updated_at 倒序)(异步)。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
limit: 最多返回条数,None 表示全部。
Returns:
ConversationSession 列表。
"""
return await self._backend.list_sessions_async(
agent_id, user_id, limit=limit, order_desc=True
)
async def list_all_sessions_async(
self,
agent_id: str,
limit: Optional[int] = None,
) -> list[ConversationSession]:
"""列出 agent_id 下所有用户的 Session(异步)。
不要求 user_id,扫描主表全量返回。
适用于 ADK list_sessions(user_id=None) 场景。
Args:
agent_id: 智能体 ID。
limit: 最多返回条数,None 表示全部。
Returns:
ConversationSession 列表。
"""
return await self._backend.list_all_sessions_async(
agent_id, limit=limit
)
async def search_sessions_async(
self,
agent_id: str,
*,
user_id: Optional[str] = None,
summary_keyword: Optional[str] = None,
labels: Optional[str] = None,
framework: Optional[str] = None,
updated_after: Optional[int] = None,
updated_before: Optional[int] = None,
is_pinned: Optional[bool] = None,
limit: int = 20,
offset: int = 0,
) -> tuple[list[ConversationSession], int]:
"""搜索会话(多元索引)(异步)。
通过多元索引实现全文搜索 summary、标签过滤、跨 user 查询等高级查询。
Args:
agent_id: 智能体 ID(必填)。
user_id: 用户 ID(可选,精确匹配)。
summary_keyword: summary 关键词(全文搜索)。
labels: 标签 JSON 字符串(精确匹配)。
framework: 框架标识(精确匹配)。
updated_after: 仅返回 updated_at >= 此值的记录。
updated_before: 仅返回 updated_at < 此值的记录。
is_pinned: 是否置顶过滤。
limit: 最多返回条数,默认 20。
offset: 分页偏移量,默认 0。
Returns:
(结果列表, 总匹配数) 二元组。
"""
return await self._backend.search_sessions_async(
agent_id,
user_id=user_id,
summary_keyword=summary_keyword,
labels=labels,
framework=framework,
updated_after=updated_after,
updated_before=updated_before,
is_pinned=is_pinned,
limit=limit,
offset=offset,
)
async def delete_events_async(
self,
agent_id: str,
user_id: str,
session_id: str,
) -> int:
"""只删除 Session 下所有 Event,不删 Session 本身(异步)。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
Returns:
删除的事件条数。
"""
deleted = await self._backend.delete_events_by_session_async(
agent_id, user_id, session_id
)
logger.debug(
"Deleted %d events for session %s/%s/%s",
deleted,
agent_id,
user_id,
session_id,
)
return deleted
async def delete_session_async(
self,
agent_id: str,
user_id: str,
session_id: str,
) -> None:
"""级联删除 Session(异步)。
删除顺序:Event → State → Session 行。
先删 Event(量最大),再删 State,最后删 Session 行。
如果中间失败,Session 行仍在,下次重试可继续清理(幂等安全)。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
"""
# 1. 删除所有 Event
deleted_events = await self._backend.delete_events_by_session_async(
agent_id, user_id, session_id
)
logger.debug(
"Deleted %d events for session %s/%s/%s",
deleted_events,
agent_id,
user_id,
session_id,
)
# 2. 删除 Session 级 State
await self._backend.delete_state_row_async(
StateScope.SESSION,
agent_id,
user_id,
session_id,
)
# 3. 删除 Session 行
await self._backend.delete_session_row_async(
agent_id, user_id, session_id
)
logger.info(
"Cascade deleted session %s/%s/%s",
agent_id,
user_id,
session_id,
)
async def update_session_async(
self,
agent_id: str,
user_id: str,
session_id: str,
*,
is_pinned: Optional[bool] = None,
summary: Optional[str] = None,
labels: Optional[str] = None,
extensions: Optional[dict[str, Any]] = None,
version: int,
) -> None:
"""更新 Session 属性(乐观锁)(异步)。
只更新提供的字段,未提供的字段不变。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
is_pinned: 是否置顶。
summary: 会话摘要。
labels: 会话标签。
extensions: 框架扩展数据。
version: 当前版本号(乐观锁校验)。
"""
columns_to_put: dict[str, Any] = {
"updated_at": nanoseconds_timestamp(),
"version": version + 1,
}
if is_pinned is not None:
columns_to_put["is_pinned"] = is_pinned
if summary is not None:
columns_to_put["summary"] = summary
if labels is not None:
columns_to_put["labels"] = labels
if extensions is not None:
import json
columns_to_put["extensions"] = json.dumps(
extensions, ensure_ascii=False
)
await self._backend.update_session_async(
agent_id,
user_id,
session_id,
columns_to_put,
version,
)
# -------------------------------------------------------------------
# Event 管理(异步)/ Event management (async)
# -------------------------------------------------------------------
async def append_event_async(
self,
agent_id: str,
user_id: str,
session_id: str,
event_type: str,
content: dict[str, Any],
raw_event: Optional[str] = None,
) -> ConversationEvent:
"""追加事件,同时更新 Session 的 updated_at(异步)。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
event_type: 事件类型。
content: 事件数据。
raw_event: 框架原生 Event 的完整 JSON 序列化(可选)。
用于精确还原框架特定的 Event 对象(如 ADK Event)。
Returns:
包含 OTS 生成的 seq_id 的 ConversationEvent 对象。
"""
now = nanoseconds_timestamp()
# 1. 写入 Event
seq_id = await self._backend.put_event_async(
agent_id,
user_id,
session_id,
event_type,
content,
created_at=now,
updated_at=now,
raw_event=raw_event,
)
# 2. 更新 Session 的 updated_at(保证二级索引排序正确)
# 先读取当前 Session 获取 version
session = await self._backend.get_session_async(
agent_id, user_id, session_id
)
if session is not None:
try:
await self._backend.update_session_async(
agent_id,
user_id,
session_id,
{
"updated_at": now,
"version": session.version + 1,
},
session.version,
)
except Exception:
# 更新 Session 时间戳失败不应阻断事件写入
logger.warning(
"Failed to update session updated_at "
"for %s/%s/%s, event was still written.",
agent_id,
user_id,
session_id,
exc_info=True,
)
return ConversationEvent(
agent_id=agent_id,
user_id=user_id,
session_id=session_id,
seq_id=seq_id,
type=event_type,
content=content,
created_at=now,
updated_at=now,
version=0,
raw_event=raw_event,
)
async def get_events_async(
self,
agent_id: str,
user_id: str,
session_id: str,
) -> list[ConversationEvent]:
"""获取 Session 全部事件(正序)(异步)。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
Returns:
按 seq_id 正序排列的事件列表。
"""
return await self._backend.get_events_async(
agent_id,
user_id,
session_id,
direction="FORWARD",
)
async def get_recent_events_async(
self,
agent_id: str,
user_id: str,
session_id: str,
n: int,
) -> list[ConversationEvent]:
"""获取最近 N 条事件(异步)。
倒序取 N 条,返回时翻转为正序。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
n: 需要获取的事件数量。
Returns:
按 seq_id 正序排列的最近 N 条事件。
"""
events = await self._backend.get_events_async(
agent_id,
user_id,
session_id,
direction="BACKWARD",
limit=n,
)
events.reverse()
return events
# -------------------------------------------------------------------
# State 管理(异步)/ State management (async)
# -------------------------------------------------------------------
async def get_session_state_async(
self,
agent_id: str,
user_id: str,
session_id: str,
) -> dict[str, Any]:
"""获取 session 级 state,不存在返回 {}(异步)。"""
state_data = await self._backend.get_state_async(
StateScope.SESSION,
agent_id,
user_id,
session_id,
)
return state_data.state if state_data else {}
async def update_session_state_async(
self,
agent_id: str,
user_id: str,
session_id: str,
delta: dict[str, Any],
) -> None:
"""增量更新 session state(异步)。
浅合并语义:top-level key 覆盖,值为 None 表示删除该 key。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
delta: 增量更新字典。
"""
await self._apply_delta_async(
StateScope.SESSION,
agent_id,
user_id,
session_id,
delta,
)
async def get_app_state_async(self, agent_id: str) -> dict[str, Any]:
"""获取 app 级 state,不存在返回 {}(异步)。"""
state_data = await self._backend.get_state_async(
StateScope.APP, agent_id, "", ""
)
return state_data.state if state_data else {}
async def update_app_state_async(
self,
agent_id: str,
delta: dict[str, Any],
) -> None:
"""增量更新 app state(异步)。
浅合并语义:top-level key 覆盖,值为 None 表示删除该 key。
"""
await self._apply_delta_async(StateScope.APP, agent_id, "", "", delta)
async def get_user_state_async(
self, agent_id: str, user_id: str
) -> dict[str, Any]:
"""获取 user 级 state,不存在返回 {}(异步)。"""
state_data = await self._backend.get_state_async(
StateScope.USER, agent_id, user_id, ""
)
return state_data.state if state_data else {}
async def update_user_state_async(
self,
agent_id: str,
user_id: str,
delta: dict[str, Any],
) -> None:
"""增量更新 user state(异步)。
浅合并语义:top-level key 覆盖,值为 None 表示删除该 key。
"""
await self._apply_delta_async(
StateScope.USER,
agent_id,
user_id,
"",
delta,
)
async def get_merged_state_async(
self,
agent_id: str,
user_id: str,
session_id: str,
) -> dict[str, Any]:
"""三级状态浅合并:app_state <- user_state <- session_state(异步)。
后者覆盖前者,任意层不存在视为空 dict。
Args:
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
Returns:
合并后的状态字典。
"""
merged: dict[str, Any] = {}
merged.update(await self.get_app_state_async(agent_id))
merged.update(await self.get_user_state_async(agent_id, user_id))
merged.update(
await self.get_session_state_async(agent_id, user_id, session_id)
)
return merged
# -------------------------------------------------------------------
# 内部辅助方法(异步)
# -------------------------------------------------------------------
async def _apply_delta_async(
self,
scope: StateScope,
agent_id: str,
user_id: str,
session_id: str,
delta: dict[str, Any],
) -> None:
"""增量更新 State(通用逻辑)(异步)。
- 首次写入:过滤 None 值后整体写入,version=0
- 后续更新:读取现有 state → 浅合并 delta(None 删除 key)→ 写回
Args:
scope: 状态作用域。
agent_id: 智能体 ID。
user_id: 用户 ID。
session_id: 会话 ID。
delta: 增量更新字典。
"""
existing = await self._backend.get_state_async(
scope, agent_id, user_id, session_id
)
if existing is None:
# 首次写入,过滤 None 值
new_state = {k: v for k, v in delta.items() if v is not None}
await self._backend.put_state_async(
scope,
agent_id,
user_id,
session_id,
state=new_state,
version=0,
)
else:
# 增量合并
merged = dict(existing.state)
for k, v in delta.items():
if v is None:
merged.pop(k, None) # None 表示删除
else:
merged[k] = v # 浅覆盖
await self._backend.put_state_async(
scope,
agent_id,
user_id,
session_id,
state=merged,
version=existing.version,
)
# -------------------------------------------------------------------
# 工厂方法(异步)/ Factory methods (async)
# -------------------------------------------------------------------
@classmethod
async def from_memory_collection_async(
cls,
memory_collection_name: str,
*,
config: Optional[Any] = None,
table_prefix: str = "",
) -> "SessionStore":
"""通过 MemoryCollection 名称创建 SessionStore(异步)。
从 AgentRun 平台获取 MemoryCollection 配置,自动提取 OTS 实例
的 endpoint 和 instance_name,结合 Config 中的 AK/SK 凭证,
构建 OTSClient 和 OTSBackend,返回即用的 SessionStore。
Args:
memory_collection_name: AgentRun 平台上的 MemoryCollection 名称。
config: agentrun Config 对象(可选)。
未提供时自动从环境变量读取凭证。
table_prefix: 表名前缀,用于多租户隔离,默认不添加。
Returns:
配置完成的 SessionStore 实例。
Raises:
ImportError: 未安装 agentrun 主包时抛出。
ValueError: MemoryCollection 缺少 OTS 配置或凭证为空时抛出。
Example::
store = await SessionStore.from_memory_collection_async(
"my-memory-collection",
)
await store.init_tables_async()
"""
# 延迟导入,避免 conversation_service 强依赖 agentrun 主包
try:
from agentrun.memory_collection import MemoryCollection
from agentrun.utils.config import Config
except ImportError as e:
raise ImportError(
"agentrun 主包未安装。请先安装: pip install agentrun"
) from e
from tablestore import AsyncOTSClient # type: ignore[import-untyped]
from tablestore import OTSClient # type: ignore[import-untyped]
from tablestore import WriteRetryPolicy
from agentrun.conversation_service.utils import (
convert_vpc_endpoint_to_public,
)
# 1. 获取 MemoryCollection 配置
mc = await MemoryCollection.get_by_name_async(
memory_collection_name, config=config
)
# 2. 提取 OTS 连接信息
if not mc.vector_store_config or not mc.vector_store_config.config:
raise ValueError(
f"MemoryCollection '{memory_collection_name}' 缺少 "
"vector_store_config 配置,无法获取 OTS 连接信息。"
)
vs_config = mc.vector_store_config.config
endpoint = convert_vpc_endpoint_to_public(vs_config.endpoint or "")
instance_name = vs_config.instance_name or ""
if not endpoint:
raise ValueError(
f"MemoryCollection '{memory_collection_name}' 的 "
"vector_store_config.endpoint 为空。"
)
if not instance_name:
raise ValueError(
f"MemoryCollection '{memory_collection_name}' 的 "
"vector_store_config.instance_name 为空。"
)
# 3. 获取凭证
effective_config = config if isinstance(config, Config) else Config()
access_key_id = effective_config.get_access_key_id()
access_key_secret = effective_config.get_access_key_secret()
if not access_key_id or not access_key_secret:
raise ValueError(
"AK/SK 凭证为空。请通过 Config 参数传入或设置环境变量 "
"AGENTRUN_ACCESS_KEY_ID / AGENTRUN_ACCESS_KEY_SECRET。"
)
security_token = effective_config.get_security_token()
sts_token = security_token if security_token else None
# 4. 构建 OTSClient + AsyncOTSClient 和 OTSBackend
ots_client = OTSClient(
endpoint,
access_key_id,
access_key_secret,
instance_name,
sts_token=sts_token,
retry_policy=WriteRetryPolicy(),
)
async_ots_client = AsyncOTSClient(
endpoint,
access_key_id,
access_key_secret,
instance_name,
sts_token=sts_token,
retry_policy=WriteRetryPolicy(),
)
backend = OTSBackend(
ots_client,
table_prefix=table_prefix,
async_ots_client=async_ots_client,
)
return cls(backend)