models.py 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508
  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"] = "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. last_event_id: int = 0 # 最新事件 ID(用于 WS 续传)
  54. # 配置
  55. uid: Optional[str] = None
  56. model: Optional[str] = None # 默认模型
  57. tools: Optional[List[Dict]] = None # 工具定义(整个 trace 共享)
  58. llm_params: Dict[str, Any] = field(default_factory=dict) # LLM 参数(temperature 等)
  59. context: Dict[str, Any] = field(default_factory=dict) # 其他元数据
  60. # 当前焦点 goal
  61. current_goal_id: Optional[str] = None
  62. # 结果
  63. result_summary: Optional[str] = None # 执行结果摘要
  64. error_message: Optional[str] = None # 错误信息
  65. # 时间
  66. created_at: datetime = field(default_factory=datetime.now)
  67. completed_at: Optional[datetime] = None
  68. @classmethod
  69. def create(
  70. cls,
  71. mode: Literal["call", "agent"],
  72. **kwargs
  73. ) -> "Trace":
  74. """创建新的 Trace"""
  75. return cls(
  76. trace_id=str(uuid.uuid4()),
  77. mode=mode,
  78. **kwargs
  79. )
  80. def to_dict(self) -> Dict[str, Any]:
  81. """转换为字典"""
  82. return {
  83. "trace_id": self.trace_id,
  84. "mode": self.mode,
  85. "prompt_name": self.prompt_name,
  86. "task": self.task,
  87. "agent_type": self.agent_type,
  88. "parent_trace_id": self.parent_trace_id,
  89. "parent_goal_id": self.parent_goal_id,
  90. "status": self.status,
  91. "total_messages": self.total_messages,
  92. "total_tokens": self.total_tokens,
  93. "total_prompt_tokens": self.total_prompt_tokens,
  94. "total_completion_tokens": self.total_completion_tokens,
  95. "total_reasoning_tokens": self.total_reasoning_tokens,
  96. "total_cache_creation_tokens": self.total_cache_creation_tokens,
  97. "total_cache_read_tokens": self.total_cache_read_tokens,
  98. "total_cost": self.total_cost,
  99. "total_duration_ms": self.total_duration_ms,
  100. "last_sequence": self.last_sequence,
  101. "last_event_id": self.last_event_id,
  102. "uid": self.uid,
  103. "model": self.model,
  104. "tools": self.tools,
  105. "llm_params": self.llm_params,
  106. "context": self.context,
  107. "current_goal_id": self.current_goal_id,
  108. "result_summary": self.result_summary,
  109. "error_message": self.error_message,
  110. "created_at": self.created_at.isoformat() if self.created_at else None,
  111. "completed_at": self.completed_at.isoformat() if self.completed_at else None,
  112. }
  113. @dataclass
  114. class Message:
  115. """
  116. 执行消息 - Trace 中的 LLM 消息
  117. 对应 LLM API 消息格式(system/user/assistant/tool),通过 goal_id 关联 Goal。
  118. description 字段自动生成规则:
  119. - system: 取 content 前 200 字符
  120. - user: 取 content 前 200 字符
  121. - assistant: 优先取 content,若无 content 则生成 "tool call: XX, XX"
  122. - tool: 使用 tool name
  123. """
  124. message_id: str
  125. trace_id: str
  126. role: Literal["system", "user", "assistant", "tool"] # 和 LLM API 一致
  127. sequence: int # 全局顺序
  128. status: Literal["active", "abandoned"] = "active" # 回溯时后续消息标记为 abandoned
  129. goal_id: Optional[str] = None # 关联的 Goal 内部 ID(None = 还没有创建 Goal)
  130. description: str = "" # 消息描述(系统自动生成)
  131. tool_call_id: Optional[str] = None # tool 消息关联对应的 tool_call
  132. content: Any = None # 消息内容(和 LLM API 格式一致)
  133. # 元数据
  134. prompt_tokens: Optional[int] = None # 输入 tokens
  135. completion_tokens: Optional[int] = None # 输出 tokens
  136. reasoning_tokens: Optional[int] = None # 推理 tokens(o1/o3, DeepSeek R1, Gemini thinking)
  137. cache_creation_tokens: Optional[int] = None # 缓存创建 tokens(Claude)
  138. cache_read_tokens: Optional[int] = None # 缓存读取 tokens(Claude)
  139. cost: Optional[float] = None
  140. duration_ms: Optional[int] = None
  141. created_at: datetime = field(default_factory=datetime.now)
  142. abandoned_at: Optional[datetime] = None # 回溯标记时间
  143. # LLM 响应信息(仅 role="assistant" 时使用)
  144. finish_reason: Optional[str] = None # stop, length, tool_calls, content_filter 等
  145. @property
  146. def tokens(self) -> int:
  147. """动态计算总 tokens(向后兼容,input + output)"""
  148. return (self.prompt_tokens or 0) + (self.completion_tokens or 0)
  149. @property
  150. def all_tokens(self) -> int:
  151. """所有 tokens(包括 reasoning)"""
  152. return self.tokens + (self.reasoning_tokens or 0)
  153. def get_usage(self):
  154. """获取 TokenUsage 对象"""
  155. TokenUsage = _get_token_usage_class()
  156. return TokenUsage(
  157. input_tokens=self.prompt_tokens or 0,
  158. output_tokens=self.completion_tokens or 0,
  159. reasoning_tokens=self.reasoning_tokens or 0,
  160. cache_creation_tokens=self.cache_creation_tokens or 0,
  161. cache_read_tokens=self.cache_read_tokens or 0,
  162. )
  163. def to_llm_dict(self) -> Dict[str, Any]:
  164. """转换为 OpenAI SDK 格式的消息字典(用于 LLM 调用)"""
  165. msg: Dict[str, Any] = {"role": self.role}
  166. if self.role == "tool":
  167. # tool message: tool_call_id + name + content(string)
  168. if self.tool_call_id:
  169. msg["tool_call_id"] = self.tool_call_id
  170. msg["name"] = self.description or "unknown"
  171. if isinstance(self.content, dict):
  172. msg["content"] = str(self.content.get("result", self.content))
  173. else:
  174. msg["content"] = str(self.content) if self.content is not None else ""
  175. elif self.role == "assistant":
  176. # assistant message: content(text) + tool_calls
  177. if isinstance(self.content, dict):
  178. msg["content"] = self.content.get("text", "") or ""
  179. if self.content.get("tool_calls"):
  180. msg["tool_calls"] = self.content["tool_calls"]
  181. elif isinstance(self.content, str):
  182. msg["content"] = self.content
  183. else:
  184. msg["content"] = ""
  185. else:
  186. # system / user message: content 直接传
  187. msg["content"] = self.content
  188. return msg
  189. @classmethod
  190. def from_llm_dict(
  191. cls,
  192. d: Dict[str, Any],
  193. trace_id: str,
  194. sequence: int,
  195. goal_id: Optional[str] = None,
  196. ) -> "Message":
  197. """从 OpenAI SDK 格式创建 Message"""
  198. role = d["role"]
  199. if role == "assistant":
  200. content = {"text": d.get("content", ""), "tool_calls": d.get("tool_calls")}
  201. elif role == "tool":
  202. content = {"tool_name": d.get("name", "unknown"), "result": d.get("content", "")}
  203. else:
  204. content = d.get("content", "")
  205. return cls.create(
  206. trace_id=trace_id,
  207. role=role,
  208. sequence=sequence,
  209. goal_id=goal_id,
  210. content=content,
  211. tool_call_id=d.get("tool_call_id"),
  212. )
  213. @classmethod
  214. def from_dict(cls, data: Dict[str, Any]) -> "Message":
  215. """从字典创建 Message(处理向后兼容)"""
  216. # 过滤掉已删除的字段
  217. filtered_data = {k: v for k, v in data.items() if k not in ["tokens", "available_tools"]}
  218. # 解析 datetime
  219. if filtered_data.get("created_at") and isinstance(filtered_data["created_at"], str):
  220. filtered_data["created_at"] = datetime.fromisoformat(filtered_data["created_at"])
  221. if filtered_data.get("abandoned_at") and isinstance(filtered_data["abandoned_at"], str):
  222. filtered_data["abandoned_at"] = datetime.fromisoformat(filtered_data["abandoned_at"])
  223. # 向后兼容:旧消息没有 status 字段,默认 active
  224. if "status" not in filtered_data:
  225. filtered_data["status"] = "active"
  226. return cls(**filtered_data)
  227. @classmethod
  228. def create(
  229. cls,
  230. trace_id: str,
  231. role: Literal["system", "user", "assistant", "tool"],
  232. sequence: int,
  233. goal_id: Optional[str] = None,
  234. content: Any = None,
  235. tool_call_id: Optional[str] = None,
  236. prompt_tokens: Optional[int] = None,
  237. completion_tokens: Optional[int] = None,
  238. reasoning_tokens: Optional[int] = None,
  239. cache_creation_tokens: Optional[int] = None,
  240. cache_read_tokens: Optional[int] = None,
  241. cost: Optional[float] = None,
  242. duration_ms: Optional[int] = None,
  243. finish_reason: Optional[str] = None,
  244. ) -> "Message":
  245. """创建新的 Message,自动生成 description"""
  246. description = cls._generate_description(role, content)
  247. return cls(
  248. message_id=f"{trace_id}-{sequence:04d}",
  249. trace_id=trace_id,
  250. role=role,
  251. sequence=sequence,
  252. goal_id=goal_id,
  253. content=content,
  254. description=description,
  255. tool_call_id=tool_call_id,
  256. prompt_tokens=prompt_tokens,
  257. completion_tokens=completion_tokens,
  258. reasoning_tokens=reasoning_tokens,
  259. cache_creation_tokens=cache_creation_tokens,
  260. cache_read_tokens=cache_read_tokens,
  261. cost=cost,
  262. duration_ms=duration_ms,
  263. finish_reason=finish_reason,
  264. )
  265. @staticmethod
  266. def _generate_description(role: str, content: Any) -> str:
  267. """
  268. 自动生成 description
  269. - system: 取 content 前 200 字符
  270. - user: 取 content 前 200 字符
  271. - assistant: 优先取 content,若无 content 则生成 "tool call: XX, XX"
  272. - tool: 使用 tool name
  273. """
  274. if role == "system":
  275. # system 消息:直接截取文本
  276. if isinstance(content, str):
  277. return content[:200] + "..." if len(content) > 200 else content
  278. return "system prompt"
  279. elif role == "user":
  280. # user 消息:直接截取文本
  281. if isinstance(content, str):
  282. return content[:200] + "..." if len(content) > 200 else content
  283. return "user message"
  284. elif role == "assistant":
  285. # assistant 消息:content 是字典,可能包含 text 和 tool_calls
  286. if isinstance(content, dict):
  287. # 优先返回文本内容
  288. if content.get("text"):
  289. text = content["text"]
  290. # 截断过长的文本
  291. return text[:200] + "..." if len(text) > 200 else text
  292. # 如果没有文本,检查 tool_calls
  293. if content.get("tool_calls"):
  294. tool_calls = content["tool_calls"]
  295. if isinstance(tool_calls, list):
  296. tool_names = []
  297. for tc in tool_calls:
  298. if isinstance(tc, dict) and tc.get("function", {}).get("name"):
  299. tool_names.append(tc["function"]["name"])
  300. if tool_names:
  301. return f"tool call: {', '.join(tool_names)}"
  302. # 如果 content 是字符串
  303. if isinstance(content, str):
  304. return content[:200] + "..." if len(content) > 200 else content
  305. return "assistant message"
  306. elif role == "tool":
  307. # tool 消息:从 content 中提取 tool name
  308. if isinstance(content, dict):
  309. if content.get("tool_name"):
  310. return content["tool_name"]
  311. # 如果是字符串,尝试解析
  312. if isinstance(content, str):
  313. return content[:100] + "..." if len(content) > 100 else content
  314. return "tool result"
  315. return ""
  316. def to_dict(self) -> Dict[str, Any]:
  317. """转换为字典"""
  318. result = {
  319. "message_id": self.message_id,
  320. "trace_id": self.trace_id,
  321. "role": self.role,
  322. "sequence": self.sequence,
  323. "status": self.status,
  324. "goal_id": self.goal_id,
  325. "tool_call_id": self.tool_call_id,
  326. "content": self.content,
  327. "description": self.description,
  328. "tokens": self.tokens, # 使用 @property 动态计算
  329. "prompt_tokens": self.prompt_tokens,
  330. "completion_tokens": self.completion_tokens,
  331. "cost": self.cost,
  332. "duration_ms": self.duration_ms,
  333. "finish_reason": self.finish_reason,
  334. "created_at": self.created_at.isoformat() if self.created_at else None,
  335. }
  336. # 只添加非空的可选字段
  337. if self.abandoned_at:
  338. result["abandoned_at"] = self.abandoned_at.isoformat()
  339. if self.reasoning_tokens:
  340. result["reasoning_tokens"] = self.reasoning_tokens
  341. if self.cache_creation_tokens:
  342. result["cache_creation_tokens"] = self.cache_creation_tokens
  343. if self.cache_read_tokens:
  344. result["cache_read_tokens"] = self.cache_read_tokens
  345. return result
  346. # ===== 已弃用:Step 模型(保留用于向后兼容)=====
  347. # Step 类型
  348. StepType = Literal[
  349. "goal", "thought", "evaluation", "response",
  350. "action", "result", "memory_read", "memory_write",
  351. ]
  352. # Step 状态
  353. StepStatus = Literal[
  354. "planned", "in_progress", "awaiting_approval",
  355. "completed", "failed", "skipped",
  356. ]
  357. @dataclass
  358. class Step:
  359. """
  360. [已弃用] 执行步骤 - 使用 Message 模型替代
  361. 保留用于向后兼容
  362. """
  363. step_id: str
  364. trace_id: str
  365. step_type: StepType
  366. status: StepStatus
  367. sequence: int
  368. parent_id: Optional[str] = None
  369. description: str = ""
  370. data: Dict[str, Any] = field(default_factory=dict)
  371. summary: Optional[str] = None
  372. has_children: bool = False
  373. children_count: int = 0
  374. duration_ms: Optional[int] = None
  375. tokens: Optional[int] = None
  376. cost: Optional[float] = None
  377. created_at: datetime = field(default_factory=datetime.now)
  378. @classmethod
  379. def create(
  380. cls,
  381. trace_id: str,
  382. step_type: StepType,
  383. sequence: int,
  384. status: StepStatus = "completed",
  385. description: str = "",
  386. data: Dict[str, Any] = None,
  387. parent_id: Optional[str] = None,
  388. summary: Optional[str] = None,
  389. duration_ms: Optional[int] = None,
  390. tokens: Optional[int] = None,
  391. cost: Optional[float] = None,
  392. ) -> "Step":
  393. """创建新的 Step"""
  394. return cls(
  395. step_id=str(uuid.uuid4()),
  396. trace_id=trace_id,
  397. step_type=step_type,
  398. status=status,
  399. sequence=sequence,
  400. parent_id=parent_id,
  401. description=description,
  402. data=data or {},
  403. summary=summary,
  404. duration_ms=duration_ms,
  405. tokens=tokens,
  406. cost=cost,
  407. )
  408. def to_dict(self, view: str = "full") -> Dict[str, Any]:
  409. """
  410. 转换为字典
  411. Args:
  412. view: "compact" - 不返回大字段
  413. "full" - 返回完整数据
  414. """
  415. result = {
  416. "step_id": self.step_id,
  417. "trace_id": self.trace_id,
  418. "step_type": self.step_type,
  419. "status": self.status,
  420. "sequence": self.sequence,
  421. "parent_id": self.parent_id,
  422. "description": self.description,
  423. "summary": self.summary,
  424. "has_children": self.has_children,
  425. "children_count": self.children_count,
  426. "duration_ms": self.duration_ms,
  427. "tokens": self.tokens,
  428. "cost": self.cost,
  429. "created_at": self.created_at.isoformat() if self.created_at else None,
  430. }
  431. # 处理 data 字段
  432. if view == "compact":
  433. data_copy = self.data.copy()
  434. for key in ["output", "content", "full_output", "full_content"]:
  435. data_copy.pop(key, None)
  436. result["data"] = data_copy
  437. else:
  438. result["data"] = self.data
  439. return result