数据评估 REST API

创建数据评估任务，获取时间序列质量评估结果。

接口信息

POST https://ai.timecho.com/ai/api/v1/quality/evaluate

支持完整性、可预测性、相关性三个维度，返回各序列的详细评分。

请求头参数

名称	必填	说明
Content-Type	是	固定值：application/json
Authorization	是	Bearer <API-Key>，替换为您的 API 密钥

请求参数

参数	类型	必填	说明
input	object	是	数据输入。支持 inline（直接传入数组）和 tsfile（文件路径）两种方式
dimensions	string[]	否	指定评估维度，如 ["integrity","pearson"]。省略则运行全部三个维度
params	object	否	各维度超参数，如 {"downtime": true}

完整性评估请求示例

{
  "input": {
    "inline": {
      "columns": ["time", "temperature", "humidity"],
      "data": [
        ["2024-01-01T00:00:00", 20.1, 65.0],
        ["2024-01-01T00:00:05", 20.3, 64.8],
        ["2024-01-01T01:00:00", 19.8, 66.2],
        ["2024-01-01T02:00:00", null, 63.5],
        ["2024-01-01T03:00:00", 21.2, 62.8]
      ],
      "time_col": "time"
    }
  },
  "dimensions": ["integrity"],
  "params": { "downtime": true }
}

相关性评估请求示例

{
  "input": {
    "inline": {
      "columns": ["time", "temperature", "humidity", "pressure"],
      "data": [
        ["2024-01-01T00:00:00", 20.1, 65.0, 1013.2],
        ["2024-01-01T01:00:00", 21.3, 63.2, 1013.5],
        ["2024-01-01T02:00:00", 22.5, 60.5, 1013.8]
      ],
      "time_col": "time"
    }
  },
  "dimensions": ["pearson"],
  "params": { "targets": ["temperature"] }
}

TsFile 输入示例

{
  "input": {
    "tsfile": {
      "tsfile_path": "/data/sensor_data.tsfile"
    }
  },
  "dimensions": ["integrity", "forecastability", "pearson"]
}

响应参数

参数	类型	说明
code	integer	状态码，200 表示成功
message	string	状态信息
data.overall_score	float	综合质量分（0–100），所有维度均值
data.dimension_scores	object	每个维度的汇总分
data.series_reports[]	array	每条序列的详细评分，含各维度明细
data.correlation_matrix	object	皮尔逊相关系数矩阵，仅请求 pearson 维度时返回

完整性评估响应示例

{
  "code": 200,
  "message": "Quality evaluation completed successfully",
  "data": {
    "overall_score": 95.83,
    "dimension_scores": { "integrity": 95.83 },
    "series_reports": [
      {
        "series_id": "temperature",
        "integrity": {
          "total_points": 12,
          "missing_count": 0,
          "invalid_count": 1,
          "redundancy_count": 1,
          "late_count": 0,
          "completeness": 91.67,
          "consistency": 91.67,
          "timeliness": 100.0,
          "score": 94.44
        }
      }
    ]
  }
}

相关性评估响应示例

{
  "code": 200,
  "message": "Quality evaluation completed successfully",
  "data": {
    "overall_score": 98.77,
    "dimension_scores": { "pearson": 98.77 },
    "series_reports": [
      {
        "series_id": "temperature",
        "pearson": {
          "mean_abs_corr": 0.9877,
          "max_abs_corr": 0.9973,
          "max_corr_with": "pressure",
          "score": 98.77
        }
      }
    ],
    "correlation_matrix": {
      "pearson": {
        "temperature": {
          "temperature": 100.0,
          "humidity": 97.82,
          "pressure": 99.73
        }
      }
    }
  }
}

查询可用维度

GET https://ai.timecho.com/ai/api/v1/quality/dimensions

列出所有可用的评估维度及其参数说明。

{
  "code": 200,
  "message": "Success",
  "data": [
    { "name": "integrity",        "description": "...", "supported_params": [{"name": "downtime"}] },
    { "name": "forecastability",  "description": "...", "supported_params": [] },
    { "name": "pearson",          "description": "...", "supported_params": [{"name": "targets"}] }
  ]
}