langsmith_trace.py 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. import json
  2. import logging
  3. import os
  4. import uuid
  5. from datetime import datetime, timedelta
  6. from langsmith import Client
  7. from langsmith.schemas import RunBase
  8. from core.ops.base_trace_instance import BaseTraceInstance
  9. from core.ops.entities.config_entity import LangSmithConfig
  10. from core.ops.entities.trace_entity import (
  11. BaseTraceInfo,
  12. DatasetRetrievalTraceInfo,
  13. GenerateNameTraceInfo,
  14. MessageTraceInfo,
  15. ModerationTraceInfo,
  16. SuggestedQuestionTraceInfo,
  17. ToolTraceInfo,
  18. TraceTaskName,
  19. WorkflowTraceInfo,
  20. )
  21. from core.ops.langsmith_trace.entities.langsmith_trace_entity import (
  22. LangSmithRunModel,
  23. LangSmithRunType,
  24. LangSmithRunUpdateModel,
  25. )
  26. from core.ops.utils import filter_none_values, generate_dotted_order
  27. from extensions.ext_database import db
  28. from models.model import EndUser, MessageFile
  29. from models.workflow import WorkflowNodeExecution
  30. logger = logging.getLogger(__name__)
  31. class LangSmithDataTrace(BaseTraceInstance):
  32. def __init__(
  33. self,
  34. langsmith_config: LangSmithConfig,
  35. ):
  36. super().__init__(langsmith_config)
  37. self.langsmith_key = langsmith_config.api_key
  38. self.project_name = langsmith_config.project
  39. self.project_id = None
  40. self.langsmith_client = Client(api_key=langsmith_config.api_key, api_url=langsmith_config.endpoint)
  41. self.file_base_url = os.getenv("FILES_URL", "http://127.0.0.1:5001")
  42. def trace(self, trace_info: BaseTraceInfo):
  43. if isinstance(trace_info, WorkflowTraceInfo):
  44. self.workflow_trace(trace_info)
  45. if isinstance(trace_info, MessageTraceInfo):
  46. self.message_trace(trace_info)
  47. if isinstance(trace_info, ModerationTraceInfo):
  48. self.moderation_trace(trace_info)
  49. if isinstance(trace_info, SuggestedQuestionTraceInfo):
  50. self.suggested_question_trace(trace_info)
  51. if isinstance(trace_info, DatasetRetrievalTraceInfo):
  52. self.dataset_retrieval_trace(trace_info)
  53. if isinstance(trace_info, ToolTraceInfo):
  54. self.tool_trace(trace_info)
  55. if isinstance(trace_info, GenerateNameTraceInfo):
  56. self.generate_name_trace(trace_info)
  57. def workflow_trace(self, trace_info: WorkflowTraceInfo):
  58. trace_id = trace_info.message_id or trace_info.workflow_app_log_id or trace_info.workflow_run_id
  59. message_dotted_order = (
  60. generate_dotted_order(trace_info.message_id, trace_info.start_time) if trace_info.message_id else None
  61. )
  62. workflow_dotted_order = generate_dotted_order(
  63. trace_info.workflow_app_log_id or trace_info.workflow_run_id,
  64. trace_info.workflow_data.created_at,
  65. message_dotted_order,
  66. )
  67. if trace_info.message_id:
  68. message_run = LangSmithRunModel(
  69. id=trace_info.message_id,
  70. name=TraceTaskName.MESSAGE_TRACE.value,
  71. inputs=trace_info.workflow_run_inputs,
  72. outputs=trace_info.workflow_run_outputs,
  73. run_type=LangSmithRunType.chain,
  74. start_time=trace_info.start_time,
  75. end_time=trace_info.end_time,
  76. extra={
  77. "metadata": trace_info.metadata,
  78. },
  79. tags=["message", "workflow"],
  80. error=trace_info.error,
  81. trace_id=trace_id,
  82. dotted_order=message_dotted_order,
  83. )
  84. self.add_run(message_run)
  85. langsmith_run = LangSmithRunModel(
  86. file_list=trace_info.file_list,
  87. total_tokens=trace_info.total_tokens,
  88. id=trace_info.workflow_app_log_id or trace_info.workflow_run_id,
  89. name=TraceTaskName.WORKFLOW_TRACE.value,
  90. inputs=trace_info.workflow_run_inputs,
  91. run_type=LangSmithRunType.tool,
  92. start_time=trace_info.workflow_data.created_at,
  93. end_time=trace_info.workflow_data.finished_at,
  94. outputs=trace_info.workflow_run_outputs,
  95. extra={
  96. "metadata": trace_info.metadata,
  97. },
  98. error=trace_info.error,
  99. tags=["workflow"],
  100. parent_run_id=trace_info.message_id or None,
  101. trace_id=trace_id,
  102. dotted_order=workflow_dotted_order,
  103. )
  104. self.add_run(langsmith_run)
  105. # through workflow_run_id get all_nodes_execution
  106. workflow_nodes_execution_id_records = (
  107. db.session.query(WorkflowNodeExecution.id)
  108. .filter(WorkflowNodeExecution.workflow_run_id == trace_info.workflow_run_id)
  109. .all()
  110. )
  111. for node_execution_id_record in workflow_nodes_execution_id_records:
  112. node_execution = (
  113. db.session.query(
  114. WorkflowNodeExecution.id,
  115. WorkflowNodeExecution.tenant_id,
  116. WorkflowNodeExecution.app_id,
  117. WorkflowNodeExecution.title,
  118. WorkflowNodeExecution.node_type,
  119. WorkflowNodeExecution.status,
  120. WorkflowNodeExecution.inputs,
  121. WorkflowNodeExecution.outputs,
  122. WorkflowNodeExecution.created_at,
  123. WorkflowNodeExecution.elapsed_time,
  124. WorkflowNodeExecution.process_data,
  125. WorkflowNodeExecution.execution_metadata,
  126. )
  127. .filter(WorkflowNodeExecution.id == node_execution_id_record.id)
  128. .first()
  129. )
  130. if not node_execution:
  131. continue
  132. node_execution_id = node_execution.id
  133. tenant_id = node_execution.tenant_id
  134. app_id = node_execution.app_id
  135. node_name = node_execution.title
  136. node_type = node_execution.node_type
  137. status = node_execution.status
  138. if node_type == "llm":
  139. inputs = (
  140. json.loads(node_execution.process_data).get("prompts", {}) if node_execution.process_data else {}
  141. )
  142. else:
  143. inputs = json.loads(node_execution.inputs) if node_execution.inputs else {}
  144. outputs = json.loads(node_execution.outputs) if node_execution.outputs else {}
  145. created_at = node_execution.created_at or datetime.now()
  146. elapsed_time = node_execution.elapsed_time
  147. finished_at = created_at + timedelta(seconds=elapsed_time)
  148. execution_metadata = (
  149. json.loads(node_execution.execution_metadata) if node_execution.execution_metadata else {}
  150. )
  151. node_total_tokens = execution_metadata.get("total_tokens", 0)
  152. metadata = execution_metadata.copy()
  153. metadata.update(
  154. {
  155. "workflow_run_id": trace_info.workflow_run_id,
  156. "node_execution_id": node_execution_id,
  157. "tenant_id": tenant_id,
  158. "app_id": app_id,
  159. "app_name": node_name,
  160. "node_type": node_type,
  161. "status": status,
  162. }
  163. )
  164. process_data = json.loads(node_execution.process_data) if node_execution.process_data else {}
  165. if process_data and process_data.get("model_mode") == "chat":
  166. run_type = LangSmithRunType.llm
  167. metadata.update(
  168. {
  169. "ls_provider": process_data.get("model_provider", ""),
  170. "ls_model_name": process_data.get("model_name", ""),
  171. }
  172. )
  173. elif node_type == "knowledge-retrieval":
  174. run_type = LangSmithRunType.retriever
  175. else:
  176. run_type = LangSmithRunType.tool
  177. node_dotted_order = generate_dotted_order(node_execution_id, created_at, workflow_dotted_order)
  178. langsmith_run = LangSmithRunModel(
  179. total_tokens=node_total_tokens,
  180. name=node_type,
  181. inputs=inputs,
  182. run_type=run_type,
  183. start_time=created_at,
  184. end_time=finished_at,
  185. outputs=outputs,
  186. file_list=trace_info.file_list,
  187. extra={
  188. "metadata": metadata,
  189. },
  190. parent_run_id=trace_info.workflow_app_log_id or trace_info.workflow_run_id,
  191. tags=["node_execution"],
  192. id=node_execution_id,
  193. trace_id=trace_id,
  194. dotted_order=node_dotted_order,
  195. )
  196. self.add_run(langsmith_run)
  197. def message_trace(self, trace_info: MessageTraceInfo):
  198. # get message file data
  199. file_list = trace_info.file_list
  200. message_file_data: MessageFile = trace_info.message_file_data
  201. file_url = f"{self.file_base_url}/{message_file_data.url}" if message_file_data else ""
  202. file_list.append(file_url)
  203. metadata = trace_info.metadata
  204. message_data = trace_info.message_data
  205. message_id = message_data.id
  206. user_id = message_data.from_account_id
  207. metadata["user_id"] = user_id
  208. if message_data.from_end_user_id:
  209. end_user_data: EndUser = (
  210. db.session.query(EndUser).filter(EndUser.id == message_data.from_end_user_id).first()
  211. )
  212. if end_user_data is not None:
  213. end_user_id = end_user_data.session_id
  214. metadata["end_user_id"] = end_user_id
  215. message_run = LangSmithRunModel(
  216. input_tokens=trace_info.message_tokens,
  217. output_tokens=trace_info.answer_tokens,
  218. total_tokens=trace_info.total_tokens,
  219. id=message_id,
  220. name=TraceTaskName.MESSAGE_TRACE.value,
  221. inputs=trace_info.inputs,
  222. run_type=LangSmithRunType.chain,
  223. start_time=trace_info.start_time,
  224. end_time=trace_info.end_time,
  225. outputs=message_data.answer,
  226. extra={
  227. "metadata": metadata,
  228. },
  229. tags=["message", str(trace_info.conversation_mode)],
  230. error=trace_info.error,
  231. file_list=file_list,
  232. )
  233. self.add_run(message_run)
  234. # create llm run parented to message run
  235. llm_run = LangSmithRunModel(
  236. input_tokens=trace_info.message_tokens,
  237. output_tokens=trace_info.answer_tokens,
  238. total_tokens=trace_info.total_tokens,
  239. name="llm",
  240. inputs=trace_info.inputs,
  241. run_type=LangSmithRunType.llm,
  242. start_time=trace_info.start_time,
  243. end_time=trace_info.end_time,
  244. outputs=message_data.answer,
  245. extra={
  246. "metadata": metadata,
  247. },
  248. parent_run_id=message_id,
  249. tags=["llm", str(trace_info.conversation_mode)],
  250. error=trace_info.error,
  251. file_list=file_list,
  252. )
  253. self.add_run(llm_run)
  254. def moderation_trace(self, trace_info: ModerationTraceInfo):
  255. langsmith_run = LangSmithRunModel(
  256. name=TraceTaskName.MODERATION_TRACE.value,
  257. inputs=trace_info.inputs,
  258. outputs={
  259. "action": trace_info.action,
  260. "flagged": trace_info.flagged,
  261. "preset_response": trace_info.preset_response,
  262. "inputs": trace_info.inputs,
  263. },
  264. run_type=LangSmithRunType.tool,
  265. extra={
  266. "metadata": trace_info.metadata,
  267. },
  268. tags=["moderation"],
  269. parent_run_id=trace_info.message_id,
  270. start_time=trace_info.start_time or trace_info.message_data.created_at,
  271. end_time=trace_info.end_time or trace_info.message_data.updated_at,
  272. )
  273. self.add_run(langsmith_run)
  274. def suggested_question_trace(self, trace_info: SuggestedQuestionTraceInfo):
  275. message_data = trace_info.message_data
  276. suggested_question_run = LangSmithRunModel(
  277. name=TraceTaskName.SUGGESTED_QUESTION_TRACE.value,
  278. inputs=trace_info.inputs,
  279. outputs=trace_info.suggested_question,
  280. run_type=LangSmithRunType.tool,
  281. extra={
  282. "metadata": trace_info.metadata,
  283. },
  284. tags=["suggested_question"],
  285. parent_run_id=trace_info.message_id,
  286. start_time=trace_info.start_time or message_data.created_at,
  287. end_time=trace_info.end_time or message_data.updated_at,
  288. )
  289. self.add_run(suggested_question_run)
  290. def dataset_retrieval_trace(self, trace_info: DatasetRetrievalTraceInfo):
  291. dataset_retrieval_run = LangSmithRunModel(
  292. name=TraceTaskName.DATASET_RETRIEVAL_TRACE.value,
  293. inputs=trace_info.inputs,
  294. outputs={"documents": trace_info.documents},
  295. run_type=LangSmithRunType.retriever,
  296. extra={
  297. "metadata": trace_info.metadata,
  298. },
  299. tags=["dataset_retrieval"],
  300. parent_run_id=trace_info.message_id,
  301. start_time=trace_info.start_time or trace_info.message_data.created_at,
  302. end_time=trace_info.end_time or trace_info.message_data.updated_at,
  303. )
  304. self.add_run(dataset_retrieval_run)
  305. def tool_trace(self, trace_info: ToolTraceInfo):
  306. tool_run = LangSmithRunModel(
  307. name=trace_info.tool_name,
  308. inputs=trace_info.tool_inputs,
  309. outputs=trace_info.tool_outputs,
  310. run_type=LangSmithRunType.tool,
  311. extra={
  312. "metadata": trace_info.metadata,
  313. },
  314. tags=["tool", trace_info.tool_name],
  315. parent_run_id=trace_info.message_id,
  316. start_time=trace_info.start_time,
  317. end_time=trace_info.end_time,
  318. file_list=[trace_info.file_url],
  319. )
  320. self.add_run(tool_run)
  321. def generate_name_trace(self, trace_info: GenerateNameTraceInfo):
  322. name_run = LangSmithRunModel(
  323. name=TraceTaskName.GENERATE_NAME_TRACE.value,
  324. inputs=trace_info.inputs,
  325. outputs=trace_info.outputs,
  326. run_type=LangSmithRunType.tool,
  327. extra={
  328. "metadata": trace_info.metadata,
  329. },
  330. tags=["generate_name"],
  331. start_time=trace_info.start_time or datetime.now(),
  332. end_time=trace_info.end_time or datetime.now(),
  333. )
  334. self.add_run(name_run)
  335. def add_run(self, run_data: LangSmithRunModel):
  336. data = run_data.model_dump()
  337. if self.project_id:
  338. data["session_id"] = self.project_id
  339. elif self.project_name:
  340. data["session_name"] = self.project_name
  341. data = filter_none_values(data)
  342. try:
  343. self.langsmith_client.create_run(**data)
  344. logger.debug("LangSmith Run created successfully.")
  345. except Exception as e:
  346. raise ValueError(f"LangSmith Failed to create run: {str(e)}")
  347. def update_run(self, update_run_data: LangSmithRunUpdateModel):
  348. data = update_run_data.model_dump()
  349. data = filter_none_values(data)
  350. try:
  351. self.langsmith_client.update_run(**data)
  352. logger.debug("LangSmith Run updated successfully.")
  353. except Exception as e:
  354. raise ValueError(f"LangSmith Failed to update run: {str(e)}")
  355. def api_check(self):
  356. try:
  357. random_project_name = f"test_project_{datetime.now().strftime('%Y%m%d%H%M%S')}"
  358. self.langsmith_client.create_project(project_name=random_project_name)
  359. self.langsmith_client.delete_project(project_name=random_project_name)
  360. return True
  361. except Exception as e:
  362. logger.debug(f"LangSmith API check failed: {str(e)}")
  363. raise ValueError(f"LangSmith API check failed: {str(e)}")
  364. def get_project_url(self):
  365. try:
  366. run_data = RunBase(
  367. id=uuid.uuid4(),
  368. name="tool",
  369. inputs={"input": "test"},
  370. outputs={"output": "test"},
  371. run_type=LangSmithRunType.tool,
  372. start_time=datetime.now(),
  373. )
  374. project_url = self.langsmith_client.get_run_url(
  375. run=run_data, project_id=self.project_id, project_name=self.project_name
  376. )
  377. return project_url.split("/r/")[0]
  378. except Exception as e:
  379. logger.debug(f"LangSmith get run url failed: {str(e)}")
  380. raise ValueError(f"LangSmith get run url failed: {str(e)}")