models.py 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
  1. """
  2. Trace 和 Message 数据模型
  3. Trace: 一次完整的 LLM 交互(单次调用或 Agent 任务)
  4. Message: Trace 中的 LLM 消息,对应 LLM API 格式
  5. """
  6. from dataclasses import dataclass, field
  7. from datetime import datetime
  8. from typing import Dict, Any, List, Optional, Literal, Union
  9. import uuid
  10. # ===== 消息线格式类型别名 =====
  11. # 轻量 wire-format 类型,用于工具参数和 runner/LLM API 接口。
  12. # 内部存储使用下方的 Message dataclass。
  13. ChatMessage = Dict[str, Any] # 单条 OpenAI 格式消息
  14. Messages = List[ChatMessage] # 消息列表
  15. MessageContent = Union[str, List[Dict[str, str]]] # content 字段(文本或多模态)
  16. # 导入 TokenUsage(延迟导入避免循环依赖)
  17. def _get_token_usage_class():
  18. from ..llm.usage import TokenUsage
  19. return TokenUsage
  20. @dataclass
  21. class Trace:
  22. """
  23. 执行轨迹 - 一次完整的 LLM 交互
  24. 单次调用: mode="call"
  25. Agent 模式: mode="agent"
  26. 主 Trace 和 Sub-Trace 使用相同的数据结构。
  27. Sub-Trace 通过 parent_trace_id 和 parent_goal_id 关联父 Trace。
  28. """
  29. trace_id: str
  30. mode: Literal["call", "agent"]
  31. # Prompt 标识(可选)
  32. prompt_name: Optional[str] = None
  33. # Agent 模式特有
  34. task: Optional[str] = None
  35. agent_type: Optional[str] = None
  36. # 父子关系(Sub-Trace 特有)
  37. parent_trace_id: Optional[str] = None # 父 Trace ID
  38. parent_goal_id: Optional[str] = None # 哪个 Goal 启动的
  39. # 状态
  40. status: Literal["running", "completed", "failed", "stopped"] = "running"
  41. # 统计
  42. total_messages: int = 0 # 消息总数(改名自 total_steps)
  43. total_tokens: int = 0 # 总 tokens(向后兼容,= prompt + completion)
  44. total_prompt_tokens: int = 0 # 总输入 tokens
  45. total_completion_tokens: int = 0 # 总输出 tokens
  46. total_reasoning_tokens: int = 0 # 总推理 tokens(o1/o3, DeepSeek R1, Gemini thinking)
  47. total_cache_creation_tokens: int = 0 # 总缓存创建 tokens(Claude)
  48. total_cache_read_tokens: int = 0 # 总缓存读取 tokens(Claude)
  49. total_cost: float = 0.0
  50. total_duration_ms: int = 0 # 总耗时(毫秒)
  51. # 进度追踪(head)
  52. last_sequence: int = 0 # 最新 message 的 sequence
  53. head_sequence: int = 0 # 当前主路径的头节点 sequence(用于 build_llm_messages)
  54. last_event_id: int = 0 # 最新事件 ID(用于 WS 续传)
  55. # 配置
  56. uid: Optional[str] = None
  57. model: Optional[str] = None # 默认模型
  58. tools: Optional[List[Dict]] = None # 工具定义(整个 trace 共享)
  59. llm_params: Dict[str, Any] = field(default_factory=dict) # LLM 参数(temperature 等)
  60. context: Dict[str, Any] = field(default_factory=dict) # 其他元数据
  61. # 当前焦点 goal
  62. current_goal_id: Optional[str] = None
  63. # 结果
  64. result_summary: Optional[str] = None # 执行结果摘要
  65. error_message: Optional[str] = None # 错误信息
  66. # 时间
  67. created_at: datetime = field(default_factory=datetime.now)
  68. completed_at: Optional[datetime] = None
  69. last_activity_at: datetime = field(default_factory=datetime.now) # 最后活动时间(用于判断是否真正运行中)
  70. @classmethod
  71. def create(
  72. cls,
  73. mode: Literal["call", "agent"],
  74. **kwargs
  75. ) -> "Trace":
  76. """创建新的 Trace"""
  77. return cls(
  78. trace_id=str(uuid.uuid4()),
  79. mode=mode,
  80. **kwargs
  81. )
  82. @classmethod
  83. def from_dict(cls, data: Dict[str, Any]) -> "Trace":
  84. """从字典创建 Trace(处理日期字段反序列化)"""
  85. from dateutil import parser
  86. # 处理日期字段
  87. if "created_at" in data and isinstance(data["created_at"], str):
  88. data["created_at"] = parser.isoparse(data["created_at"])
  89. if "completed_at" in data and isinstance(data["completed_at"], str):
  90. data["completed_at"] = parser.isoparse(data["completed_at"])
  91. if "last_activity_at" in data and isinstance(data["last_activity_at"], str):
  92. data["last_activity_at"] = parser.isoparse(data["last_activity_at"])
  93. return cls(**data)
  94. def to_dict(self) -> Dict[str, Any]:
  95. """转换为字典"""
  96. return {
  97. "trace_id": self.trace_id,
  98. "mode": self.mode,
  99. "prompt_name": self.prompt_name,
  100. "task": self.task,
  101. "agent_type": self.agent_type,
  102. "parent_trace_id": self.parent_trace_id,
  103. "parent_goal_id": self.parent_goal_id,
  104. "status": self.status,
  105. "total_messages": self.total_messages,
  106. "total_tokens": self.total_tokens,
  107. "total_prompt_tokens": self.total_prompt_tokens,
  108. "total_completion_tokens": self.total_completion_tokens,
  109. "total_reasoning_tokens": self.total_reasoning_tokens,
  110. "total_cache_creation_tokens": self.total_cache_creation_tokens,
  111. "total_cache_read_tokens": self.total_cache_read_tokens,
  112. "total_cost": self.total_cost,
  113. "total_duration_ms": self.total_duration_ms,
  114. "last_sequence": self.last_sequence,
  115. "head_sequence": self.head_sequence,
  116. "last_event_id": self.last_event_id,
  117. "uid": self.uid,
  118. "model": self.model,
  119. "tools": self.tools,
  120. "llm_params": self.llm_params,
  121. "context": self.context,
  122. "current_goal_id": self.current_goal_id,
  123. "result_summary": self.result_summary,
  124. "error_message": self.error_message,
  125. "created_at": self.created_at.isoformat() if self.created_at else None,
  126. "completed_at": self.completed_at.isoformat() if self.completed_at else None,
  127. "last_activity_at": self.last_activity_at.isoformat() if self.last_activity_at else None,
  128. }
  129. @dataclass
  130. class Message:
  131. """
  132. 执行消息 - Trace 中的 LLM 消息
  133. 对应 LLM API 消息格式(system/user/assistant/tool),通过 goal_id 关联 Goal。
  134. description 字段自动生成规则:
  135. - system: 取 content 前 200 字符
  136. - user: 取 content 前 200 字符
  137. - assistant: 优先取 content,若无 content 则生成 "tool call: XX, XX"
  138. - tool: 使用 tool name
  139. """
  140. message_id: str
  141. trace_id: str
  142. role: Literal["system", "user", "assistant", "tool"] # 和 LLM API 一致
  143. sequence: int # 全局顺序
  144. parent_sequence: Optional[int] = None # 父消息的 sequence(构成消息树)
  145. status: Literal["active", "abandoned"] = "active" # [已弃用] 由 parent_sequence 树结构替代
  146. goal_id: Optional[str] = None # 关联的 Goal 内部 ID(None = 还没有创建 Goal)
  147. description: str = "" # 消息描述(系统自动生成)
  148. tool_call_id: Optional[str] = None # tool 消息关联对应的 tool_call
  149. content: Any = None # 消息内容(和 LLM API 格式一致)
  150. # 元数据
  151. prompt_tokens: Optional[int] = None # 输入 tokens
  152. completion_tokens: Optional[int] = None # 输出 tokens
  153. reasoning_tokens: Optional[int] = None # 推理 tokens(o1/o3, DeepSeek R1, Gemini thinking)
  154. cache_creation_tokens: Optional[int] = None # 缓存创建 tokens(Claude)
  155. cache_read_tokens: Optional[int] = None # 缓存读取 tokens(Claude)
  156. cost: Optional[float] = None
  157. duration_ms: Optional[int] = None
  158. created_at: datetime = field(default_factory=datetime.now)
  159. abandoned_at: Optional[datetime] = None # [已弃用] 由 parent_sequence 树结构替代
  160. # LLM 响应信息(仅 role="assistant" 时使用)
  161. finish_reason: Optional[str] = None # stop, length, tool_calls, content_filter 等
  162. @property
  163. def tokens(self) -> int:
  164. """动态计算总 tokens(向后兼容,input + output)"""
  165. return (self.prompt_tokens or 0) + (self.completion_tokens or 0)
  166. @property
  167. def all_tokens(self) -> int:
  168. """所有 tokens(包括 reasoning)"""
  169. return self.tokens + (self.reasoning_tokens or 0)
  170. def get_usage(self):
  171. """获取 TokenUsage 对象"""
  172. TokenUsage = _get_token_usage_class()
  173. return TokenUsage(
  174. input_tokens=self.prompt_tokens or 0,
  175. output_tokens=self.completion_tokens or 0,
  176. reasoning_tokens=self.reasoning_tokens or 0,
  177. cache_creation_tokens=self.cache_creation_tokens or 0,
  178. cache_read_tokens=self.cache_read_tokens or 0,
  179. )
  180. def to_llm_dict(self) -> Dict[str, Any]:
  181. """转换为 OpenAI SDK 格式的消息字典(用于 LLM 调用)"""
  182. msg: Dict[str, Any] = {"role": self.role}
  183. if self.role == "tool":
  184. # tool message: tool_call_id + name + content
  185. if self.tool_call_id:
  186. msg["tool_call_id"] = self.tool_call_id
  187. msg["name"] = self.description or "unknown"
  188. if isinstance(self.content, dict):
  189. result = self.content.get("result", self.content)
  190. # result 可能是 list(含图片的多模态内容)或字符串
  191. msg["content"] = result if isinstance(result, list) else str(result)
  192. else:
  193. msg["content"] = str(self.content) if self.content is not None else ""
  194. elif self.role == "assistant":
  195. # assistant message: content(text) + tool_calls
  196. if isinstance(self.content, dict):
  197. msg["content"] = self.content.get("text", "") or ""
  198. if self.content.get("tool_calls"):
  199. msg["tool_calls"] = self.content["tool_calls"]
  200. elif isinstance(self.content, str):
  201. msg["content"] = self.content
  202. else:
  203. msg["content"] = ""
  204. else:
  205. # system / user message: content 直接传
  206. msg["content"] = self.content
  207. return msg
  208. @classmethod
  209. def from_llm_dict(
  210. cls,
  211. d: Dict[str, Any],
  212. trace_id: str,
  213. sequence: int,
  214. goal_id: Optional[str] = None,
  215. parent_sequence: Optional[int] = None,
  216. ) -> "Message":
  217. """从 OpenAI SDK 格式创建 Message"""
  218. role = d["role"]
  219. if role == "assistant":
  220. content = {"text": d.get("content", ""), "tool_calls": d.get("tool_calls")}
  221. elif role == "tool":
  222. content = {"tool_name": d.get("name", "unknown"), "result": d.get("content", "")}
  223. else:
  224. content = d.get("content", "")
  225. return cls.create(
  226. trace_id=trace_id,
  227. role=role,
  228. sequence=sequence,
  229. goal_id=goal_id,
  230. parent_sequence=parent_sequence,
  231. content=content,
  232. tool_call_id=d.get("tool_call_id"),
  233. )
  234. @classmethod
  235. def from_dict(cls, data: Dict[str, Any]) -> "Message":
  236. """从字典创建 Message(处理向后兼容)"""
  237. # 过滤掉已删除的字段
  238. filtered_data = {k: v for k, v in data.items() if k not in ["tokens", "available_tools"]}
  239. # 解析 datetime
  240. if filtered_data.get("created_at") and isinstance(filtered_data["created_at"], str):
  241. filtered_data["created_at"] = datetime.fromisoformat(filtered_data["created_at"])
  242. if filtered_data.get("abandoned_at") and isinstance(filtered_data["abandoned_at"], str):
  243. filtered_data["abandoned_at"] = datetime.fromisoformat(filtered_data["abandoned_at"])
  244. # 向后兼容:旧消息没有 status 字段,默认 active
  245. if "status" not in filtered_data:
  246. filtered_data["status"] = "active"
  247. # 向后兼容:旧消息没有 parent_sequence 字段
  248. if "parent_sequence" not in filtered_data:
  249. filtered_data["parent_sequence"] = None
  250. return cls(**filtered_data)
  251. @classmethod
  252. def create(
  253. cls,
  254. trace_id: str,
  255. role: Literal["system", "user", "assistant", "tool"],
  256. sequence: int,
  257. goal_id: Optional[str] = None,
  258. content: Any = None,
  259. tool_call_id: Optional[str] = None,
  260. parent_sequence: Optional[int] = None,
  261. prompt_tokens: Optional[int] = None,
  262. completion_tokens: Optional[int] = None,
  263. reasoning_tokens: Optional[int] = None,
  264. cache_creation_tokens: Optional[int] = None,
  265. cache_read_tokens: Optional[int] = None,
  266. cost: Optional[float] = None,
  267. duration_ms: Optional[int] = None,
  268. finish_reason: Optional[str] = None,
  269. ) -> "Message":
  270. """创建新的 Message,自动生成 description"""
  271. description = cls._generate_description(role, content)
  272. return cls(
  273. message_id=f"{trace_id}-{sequence:04d}",
  274. trace_id=trace_id,
  275. role=role,
  276. sequence=sequence,
  277. parent_sequence=parent_sequence,
  278. goal_id=goal_id,
  279. content=content,
  280. description=description,
  281. tool_call_id=tool_call_id,
  282. prompt_tokens=prompt_tokens,
  283. completion_tokens=completion_tokens,
  284. reasoning_tokens=reasoning_tokens,
  285. cache_creation_tokens=cache_creation_tokens,
  286. cache_read_tokens=cache_read_tokens,
  287. cost=cost,
  288. duration_ms=duration_ms,
  289. finish_reason=finish_reason,
  290. )
  291. @staticmethod
  292. def _generate_description(role: str, content: Any) -> str:
  293. """
  294. 自动生成 description
  295. - system: 取 content 前 200 字符
  296. - user: 取 content 前 200 字符
  297. - assistant: 优先取 content,若无 content 则生成 "tool call: XX, XX"
  298. - tool: 使用 tool name
  299. """
  300. if role == "system":
  301. # system 消息:直接截取文本
  302. if isinstance(content, str):
  303. return content[:200] + "..." if len(content) > 200 else content
  304. return "system prompt"
  305. elif role == "user":
  306. # user 消息:直接截取文本
  307. if isinstance(content, str):
  308. return content[:200] + "..." if len(content) > 200 else content
  309. return "user message"
  310. elif role == "assistant":
  311. # assistant 消息:content 是字典,可能包含 text 和 tool_calls
  312. if isinstance(content, dict):
  313. # 优先返回文本内容
  314. if content.get("text"):
  315. text = content["text"]
  316. # 截断过长的文本
  317. return text[:200] + "..." if len(text) > 200 else text
  318. # 如果没有文本,检查 tool_calls
  319. if content.get("tool_calls"):
  320. tool_calls = content["tool_calls"]
  321. if isinstance(tool_calls, list):
  322. tool_descriptions = []
  323. for tc in tool_calls:
  324. if isinstance(tc, dict) and tc.get("function", {}).get("name"):
  325. tool_name = tc["function"]["name"]
  326. # 提取参数并截断到 100 字符
  327. tool_args = tc["function"].get("arguments", "{}")
  328. if isinstance(tool_args, str):
  329. args_str = tool_args
  330. else:
  331. import json
  332. args_str = json.dumps(tool_args, ensure_ascii=False)
  333. args_display = args_str[:100] + "..." if len(args_str) > 100 else args_str
  334. tool_descriptions.append(f"{tool_name}({args_display})")
  335. if tool_descriptions:
  336. return "tool call: " + ", ".join(tool_descriptions)
  337. # 如果 content 是字符串
  338. if isinstance(content, str):
  339. return content[:200] + "..." if len(content) > 200 else content
  340. return "assistant message"
  341. elif role == "tool":
  342. # tool 消息:从 content 中提取 tool name
  343. if isinstance(content, dict):
  344. if content.get("tool_name"):
  345. return content["tool_name"]
  346. # 如果是字符串,尝试解析
  347. if isinstance(content, str):
  348. return content[:100] + "..." if len(content) > 100 else content
  349. return "tool result"
  350. return ""
  351. def to_dict(self) -> Dict[str, Any]:
  352. """转换为字典"""
  353. result = {
  354. "message_id": self.message_id,
  355. "trace_id": self.trace_id,
  356. "role": self.role,
  357. "sequence": self.sequence,
  358. "parent_sequence": self.parent_sequence,
  359. "status": self.status,
  360. "goal_id": self.goal_id,
  361. "tool_call_id": self.tool_call_id,
  362. "content": self.content,
  363. "description": self.description,
  364. "tokens": self.tokens, # 使用 @property 动态计算
  365. "prompt_tokens": self.prompt_tokens,
  366. "completion_tokens": self.completion_tokens,
  367. "cost": self.cost,
  368. "duration_ms": self.duration_ms,
  369. "finish_reason": self.finish_reason,
  370. "created_at": self.created_at.isoformat() if self.created_at else None,
  371. }
  372. # 只添加非空的可选字段
  373. if self.abandoned_at:
  374. result["abandoned_at"] = self.abandoned_at.isoformat()
  375. if self.reasoning_tokens is not None:
  376. result["reasoning_tokens"] = self.reasoning_tokens
  377. if self.cache_creation_tokens is not None:
  378. result["cache_creation_tokens"] = self.cache_creation_tokens
  379. if self.cache_read_tokens is not None:
  380. result["cache_read_tokens"] = self.cache_read_tokens
  381. return result
  382. # ===== 已弃用:Step 模型(保留用于向后兼容)=====
  383. # Step 类型
  384. StepType = Literal[
  385. "goal", "thought", "evaluation", "response",
  386. "action", "result", "memory_read", "memory_write",
  387. ]
  388. # Step 状态
  389. StepStatus = Literal[
  390. "planned", "in_progress", "awaiting_approval",
  391. "completed", "failed", "skipped",
  392. ]
  393. @dataclass
  394. class Step:
  395. """
  396. [已弃用] 执行步骤 - 使用 Message 模型替代
  397. 保留用于向后兼容
  398. """
  399. step_id: str
  400. trace_id: str
  401. step_type: StepType
  402. status: StepStatus
  403. sequence: int
  404. parent_id: Optional[str] = None
  405. description: str = ""
  406. data: Dict[str, Any] = field(default_factory=dict)
  407. summary: Optional[str] = None
  408. has_children: bool = False
  409. children_count: int = 0
  410. duration_ms: Optional[int] = None
  411. tokens: Optional[int] = None
  412. cost: Optional[float] = None
  413. created_at: datetime = field(default_factory=datetime.now)
  414. @classmethod
  415. def create(
  416. cls,
  417. trace_id: str,
  418. step_type: StepType,
  419. sequence: int,
  420. status: StepStatus = "completed",
  421. description: str = "",
  422. data: Dict[str, Any] = None,
  423. parent_id: Optional[str] = None,
  424. summary: Optional[str] = None,
  425. duration_ms: Optional[int] = None,
  426. tokens: Optional[int] = None,
  427. cost: Optional[float] = None,
  428. ) -> "Step":
  429. """创建新的 Step"""
  430. return cls(
  431. step_id=str(uuid.uuid4()),
  432. trace_id=trace_id,
  433. step_type=step_type,
  434. status=status,
  435. sequence=sequence,
  436. parent_id=parent_id,
  437. description=description,
  438. data=data or {},
  439. summary=summary,
  440. duration_ms=duration_ms,
  441. tokens=tokens,
  442. cost=cost,
  443. )
  444. def to_dict(self, view: str = "full") -> Dict[str, Any]:
  445. """
  446. 转换为字典
  447. Args:
  448. view: "compact" - 不返回大字段
  449. "full" - 返回完整数据
  450. """
  451. result = {
  452. "step_id": self.step_id,
  453. "trace_id": self.trace_id,
  454. "step_type": self.step_type,
  455. "status": self.status,
  456. "sequence": self.sequence,
  457. "parent_id": self.parent_id,
  458. "description": self.description,
  459. "summary": self.summary,
  460. "has_children": self.has_children,
  461. "children_count": self.children_count,
  462. "duration_ms": self.duration_ms,
  463. "tokens": self.tokens,
  464. "cost": self.cost,
  465. "created_at": self.created_at.isoformat() if self.created_at else None,
  466. }
  467. # 处理 data 字段
  468. if view == "compact":
  469. data_copy = self.data.copy()
  470. for key in ["output", "content", "full_output", "full_content"]:
  471. data_copy.pop(key, None)
  472. result["data"] = data_copy
  473. else:
  474. result["data"] = self.data
  475. return result