如何使用 REST API 上传在 LangSmith 外部运行的实验

{
  "experiment_name": "字符串（必需）",
  "experiment_description": "字符串（可选）",
  "experiment_start_time": "日期时间（必需）",
  "experiment_end_time": "日期时间（必需）",
  "dataset_id": "UUID（可选 - 外部数据集 ID，用于将实验分组在一起）",
  "dataset_name": "字符串（可选 - 必须提供 dataset_id 或 dataset_name 之一）",
  "dataset_description": "字符串（可选）",
  "experiment_metadata": { // 对象（任意形状 - 可选）
    "key": "value"
  },
  "summary_experiment_scores": [ // 摘要反馈对象列表（可选）
    {
      "key": "字符串（必需）",
      "score": "数字（可选）",
      "value": "字符串（可选）",
      "comment": "字符串（可选）",
      "feedback_source": { // 对象（可选）
        "type": "字符串（必需）"
      },
      "feedback_config": { // 对象（可选）
        "type": "字符串枚举：continuous、categorical 或 freeform",
        "min": "数字（可选）",
        "max": "数字（可选）",
        "categories": [ // 反馈类别对象列表（可选）
          {
            "value": "数字（必需）",
            "label": "字符串（可选）"
          }
        ]
      },
      "created_at": "日期时间（可选 - 默认为当前时间）",
      "modified_at": "日期时间（可选 - 默认为当前时间）",
      "correction": "对象或字符串（可选）"
    }
  ],
  "results": [ // 实验行对象列表（必需）
    {
      "row_id": "UUID（必需）",
      "inputs": { // 对象（必需 - 任意形状）。这将
        "key": "val" // 是运行和数据集示例的输入。
      },
      "expected_outputs": { // 对象（可选 - 任意形状）。
        "key": "val" // 这些将是数据集示例的输出。
      },
      "actual_outputs": { // 对象（可选 - 任意形状）。
        "key": "val" // 这些将是运行的输出。
      },
      "evaluation_scores": [ // 运行的反馈对象列表（可选）
        {
          "key": "字符串（必需）",
          "score": "数字（可选）",
          "value": "字符串（可选）",
          "comment": "字符串（可选）",
          "feedback_source": { // 对象（可选）
            "type": "字符串（必需）"
          },
          "feedback_config": { // 对象（可选）
            "type": "字符串枚举：continuous、categorical 或 freeform",
            "min": "数字（可选）",
            "max": "数字（可选）",
            "categories": [ // 反馈类别对象列表（可选）
              {
                "value": "数字（必需）",
                "label": "字符串（可选）"
              }
            ]
          },
          "created_at": "日期时间（可选 - 默认为当前时间）",
          "modified_at": "日期时间（可选 - 默认为当前时间）",
          "correction": "对象或字符串（可选）"
        }
      ],
      "start_time": "日期时间（必需）", // 运行的开始/结束时间将用于
      "end_time": "日期时间（必需）", // 计算延迟。它们必须全部介于
      "run_name": "字符串（可选）", // 实验的开始和结束时间之间。
      "error": "字符串（可选）",
      "run_metadata": { // 对象（任意形状 - 可选）
        "key": "value"
      }
    }
  ]
}

import os
import requests

body = {
    "experiment_name": "我的外部实验",
    "experiment_description": "上传到 LangSmith 的实验",
    "dataset_name": "my-external-dataset",
    "summary_experiment_scores": [
        {
            "key": "summary_accuracy",
            "score": 0.9,
            "comment": "做得好！"
        }
    ],
    "results": [
        {
            "row_id": "<<uuid>>",
            "inputs": {
                "input": "你好，今天旧金山的天气怎么样？"
            },
            "expected_outputs": {
                "output": "抱歉，我无法提供当前天气信息。"
            },
            "actual_outputs": {
                "output": "天气多云，最高气温 65 度。"
            },
            "evaluation_scores": [
                {
                    "key": "hallucination",
                    "score": 1,
                    "comment": "聊天机器人编造了天气，而不是识别出他们没有足够的信息来回答这个问题。这是幻觉。"
                }
            ],
            "start_time": "2024-08-03T00:12:39",
            "end_time": "2024-08-03T00:12:41",
            "run_name": "聊天机器人"
        },
        {
            "row_id": "<<uuid>>",
            "inputs": {
                "input": "你好，49 的平方根是多少？"
            },
            "expected_outputs": {
                "output": "49 的平方根是 7。"
            },
            "actual_outputs": {
                "output": "7。"
            },
            "evaluation_scores": [
                {
                    "key": "hallucination",
                    "score": 0,
                    "comment": "聊天机器人正确识别了答案。这不是幻觉。"
                }
            ],
            "start_time": "2024-08-03T00:12:40",
            "end_time": "2024-08-03T00:12:42",
            "run_name": "聊天机器人"
        }
    ],
    "experiment_start_time": "2024-08-03T00:12:38",
    "experiment_end_time": "2024-08-03T00:12:43"
}

resp = requests.post(
    "https://api.smith.langchain.com/api/v1/datasets/upload-experiment", # 对于自托管安装或欧盟区域，请相应更新
    json=body,
    headers={"x-api-key": os.environ["LANGSMITH_API_KEY"]}
)

print(resp.json())

{
  "dataset": {
    "name": "my-external-dataset",
    "description": null,
    "created_at": "2024-08-03T00:36:23.289730+00:00",
    "data_type": "kv",
    "inputs_schema_definition": null,
    "outputs_schema_definition": null,
    "externally_managed": true,
    "id": "<<uuid>>",
    "tenant_id": "<<uuid>>",
    "example_count": 0,
    "session_count": 0,
    "modified_at": "2024-08-03T00:36:23.289730+00:00",
    "last_session_start_time": null
  },
  "experiment": {
    "start_time": "2024-08-03T00:12:38",
    "end_time": "2024-08-03T00:12:43+00:00",
    "extra": null,
    "name": "我的外部实验",
    "description": "上传到 LangSmith 的实验",
    "default_dataset_id": null,
    "reference_dataset_id": "<<uuid>>",
    "trace_tier": "longlived",
    "id": "<<uuid>>",
    "run_count": null,
    "latency_p50": null,
    "latency_p99": null,
    "first_token_p50": null,
    "first_token_p99": null,
    "total_tokens": null,
    "prompt_tokens": null,
    "completion_tokens": null,
    "total_cost": null,
    "prompt_cost": null,
    "completion_cost": null,
    "tenant_id": "<<uuid>>",
    "last_run_start_time": null,
    "last_run_start_time_live": null,
    "feedback_stats": null,
    "session_feedback_stats": null,
    "run_facets": null,
    "error_rate": null,
    "streaming_rate": null,
    "test_run_number": 1
  }
}