评论(Comments)

评论让团队能够直接在 Langfuse 内的 traces、observations、sessions 和提示词上添加上下文备注和讨论。此功能通过允许团队成员执行以下操作来促进协作:

• 标记特定 traces 中的问题或异常
• 分享关于特定模型输出的见解
• 记录边缘案例和调试备注
• 协调提示词改进
• 在开发和审阅周期中留下反馈

支持的对象类型

评论可以添加到以下 Langfuse 对象:

• Traces - 对完整的执行流进行评论
• Observations - 为特定 LLM 调用、spans 或事件添加备注
• Sessions - 讨论用户交互模式
• Prompts - 协作处理提示词版本和改进

添加评论

每个支持的对象页面都在界面中显示一个评论按钮。该按钮显示:

• 当前评论数(为可读性上限为 "99+")
• 如果你没有读权限,则为禁用状态
• 当评论可用或你可以创建评论时,则为活动状态

点击评论按钮会打开一个侧边抽屉,包含:

1. 评论线程 - 所有现有评论按时间顺序显示
2. 编写器 - 用于编写新评论的文本区域(如果你有写权限)
3. Markdown - 支持基本 markdown 格式
4. @提及 - 使用 @提及在评论中标记团队成员
5. 反应 - 为评论添加表情反应

评论作者只能删除自己的评论。项目管理员不能通过 UI 删除其他用户的评论。

Comments API 允许以编程方式创建和检索评论。所有端点遵循标准的 Langfuse API 模式。

GET /api/public/comments
GET /api/public/comments/{commentId}
POST /api/public/comments

API Reference

@提及

你可以使用 @提及在评论中标记团队成员,就重要发现或讨论通知他们。当你需要某人关注特定 trace、observation 或问题时,这尤其有用。

如何使用 @提及

1. 在评论编写器中开始输入 @
2. 出现一个自动完成菜单,显示所有项目成员
3. 从列表中选择团队成员,或继续输入以过滤
4. 该提及作为可点击的徽章插入你的评论

电子邮件通知

当你在评论中提及某人时:

• 他们会收到一封包含评论内容和上下文的电子邮件通知
• 电子邮件包含指向该对象(trace、observation、session 或提示词)的直接链接
• 用户可以按项目管理他们的通知偏好

管理通知偏好

团队成员可以控制何时收到提及的电子邮件通知:

• 导航到项目设置以配置通知偏好
• 选择按项目启用或禁用提及通知
• 偏好适用于该项目中所有未来的提及

只有项目成员才能在评论中被提及。自动完成菜单会自动过滤,仅显示有权访问当前项目的用户。

反应

为评论添加表情反应,无需编写完整回复即可快速确认。反应是一种轻量级的表达同意、赞赏或仅仅确认你已看到评论的方式。

如何添加反应

• 将鼠标悬停在任意评论上以显示反应按钮
• 点击从反应选择器中选择一个表情
• 你的反应会显示在评论旁边,带上你的名字
• 再次点击你现有的反应以移除它

反应有助于保持评论线程聚焦,同时仍允许团队成员提供快速反馈并展示对讨论的参与。

对特定文本评论

你也可以添加锚定到 trace 和 observation 输入、输出或元数据字段中特定文本的评论——类似于 Google Docs。

1. 使用 trace 或 observation 的 "JSON Beta" 视图
2. 选择你想评论的文本
3. 点击出现的评论按钮
4. 你的评论将锚定到该精确选择,并在悬停时显示

这使得讨论 LLM 响应的特定部分或向队友标记确切问题变得更容易。

注意:如果在创建评论后 trace 或 observation 数据被更新,该评论会变成"脱离"状态,并带有视觉指示器,表明引用可能已更改。