反馈数据格式

推荐阅读

在深入阅读本文档之前，阅读以下内容可能会有所帮助

• 关于追踪和反馈的概念指南

反馈是 LangSmith 存储特定 trace 或中间 run（span）的评估标准和分数的方式。反馈可以通过多种方式生成，例如

1. 与来自 LLM 应用程序的 trace 一起发送
2. 由用户在应用程序中内联或在注释队列中生成
3. 在离线评估期间由自动评估器生成
4. 由在线评估器生成

反馈以简单格式存储，包含以下字段

字段名称	类型	描述
id	UUID	记录本身的唯一标识符
created_at	datetime	记录创建的时间戳
modified_at	datetime	记录上次修改的时间戳
session_id	UUID	实验或追踪项目的唯一标识符，run 是该项目的一部分
run_id	UUID	会话中特定 run 的唯一标识符
key	string	描述反馈标准的键，例如“正确性”
score	number	与反馈键关联的数值分数
value	string	保留用于存储与分数关联的值。对于分类反馈很有用。
comment	string	与记录关联的任何评论或注释。这可以是给定分数的理由。
correction	object	保留用于存储更正详情（如果有）
feedback_source	object	包含有关反馈来源信息的对象
feedback_source.type	string	反馈来源的类型，例如“api”、“app”、“evaluator”
feedback_source.metadata	object	保留用于其他元数据，目前
feedback_source.user_id	UUID	提供反馈的用户的唯一标识符

以下是上述格式的反馈记录的 JSON 表示例

{
  "created_at": "2024-05-05T23:23:11.077838",
  "modified_at": "2024-05-05T23:23:11.232962",
  "session_id": "c919298b-0af2-4517-97a2-0f98ed4a48f8",
  "run_id": "e26174e5-2190-4566-b970-7c3d9a621baa",
  "key": "correctness",
  "score": 1.0,
  "value": null,
  "comment": "I gave this score because the answer was correct.",
  "correction": null,
  "id": "62104630-c7f5-41dc-8ee2-0acee5c14224",
  "feedback_source": {
    "type": "app",
    "metadata": null,
    "user_id": "ad52b092-1346-42f4-a934-6e5521562fab"
  }
}