# 时序异常检测零样本直推
#### 功能介绍
已使用行业大规模时序数据进行预训练，获得可捕获正常时序模式的预置模型。在推理阶段，使用该预置模型对输入的重构误差作为异常判别依据。
若为零样本直推模型或预训练工作流产物（正常数据学习）模型，根据指定异常分计算方式返回异常分+重构值，共有以下三种计算方式：
1. 重构误差：计算多次重构的均值，计算与真实值的偏差值记作异常分。
2. 重构方差（推荐）：计算多次重构的方差，记作异常分。
3. 重构误差+方差：异常分计算方式a)+b)，记作异常分。
 
#### 授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/productdesc-pangulm/pangulm_01_0020.html)。
#### URI
POST /
获取URI方式请参见[请求URI](https://support.huaweicloud.com/api-pangulm/pangulm_05_0004.html)。
#### 请求参数
使用[Token认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section94702116509)方式的请求Header参数见[表1]。
 表1请求Header参数（Token认证） 
| 参数           | 是否必选 | 参数类型  | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
|:---|:---|:---|:---|
| X-Auth-Token | 是     | String | **参数解释：** 用户Token。 用于获取操作API的权限。如[图4](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__fig10797003103)中响应消息头中X-Subject-Token的值即为Token。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| Content-Type   | 是      | String   | **参数解释：** 发送的实体的MIME类型。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json                                                                                                                                                                       |
   
使用[API Key认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section148602501261)方式的请求Header参数见[表2] 。
 表2请求Header参数（API Key认证） 
| 参数            | 是否必选 | 参数类型     | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
|:---|:---|:---|:---|
| X-Apig-AppCode | 是    | String | **参数解释：** API Key值。 用于获取操作API的权限。[API Key认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section148602501261)响应消息头中X-Apig-AppCode的值即为API Key。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| Content-Type  | 是      | String   | **参数解释：** 发送的实体的MIME类型。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** application/json                                                                                                                                                                                  |
   
表3请求Body参数 
| 参数    | 是否必选 | 参数类型    | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|:---|
| data | 是   | Array    | **参数解释：** 时序异常检测批处理数据。 **约束限制：** 盘古时序预测分类任务的输入数据内容，用字典承载。输入数据字典中，键对应特征列名，值为列表承载的序列数据具体内容，单条时序数据窗口长度需大于等于100。 **取值范围：** 输入数据中的一组数据。 **默认取值：** 预测大模型在训练完成后，可以在训练日志页面，"模型训练"日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 ![](https://support.huaweicloud.com/api-pangulm/zh-cn_image_0000002727451636.png)                                                                                                                                                                                                    |
| option | 否  | String | **参数解释：** 选择异常分计算模式，可选择模式包括\["err"，"var", "mix"\]，分别代表\["重构误差"，"重构方差", "重构误差+方差"\]三种计算模式，推荐使用重构方差("var")： 1. 重构误差("err")：计算多次重构的均值，计算与真实值的偏差值记作异常分。  2. 重构方差("var")：计算多次重构的方差，记作异常分。  3. 重构误差+方差("mix")：异常分计算方式a)+b)，记作异常分。   **约束限制：** 无 **取值范围：** {"err", "var", "mix"} **默认取值：** var |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数         | 参数类型                 | 描述                                                                                                                                                                                                                                                                                                                                                            |
|:---|:---|:---|
| data       | LIST\<OutputMeta\> | **参数解释：** 时序预测结果的列表。同时返回各个特征的异常分以及重构值，分别以"anomaly_score"以及"reconstruction"两个键值承载。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
| time_cost | JSON               | **参数解释：** 当启动服务时，本次请求服务各阶段耗时情况。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                          |
   
**状态码： 400**
表5响应Body参数 
| 参数          | 参数类型  | 描述       |
|:---|:---|:---|
| error_code | String | 错误码。    |
| error_msg    | String  | 错误信息。 |
   
#### 请求示例
```
{
  "option": "var", #可选模式包括["err"，"var", "mix"]
  "data": [
    {
      "context": {
        "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_2": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_3": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]   
      }
    },
    {
      "context": {
        "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_2": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_3": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]
      }
    },
    {...},
    {...}
  ]
}
```
#### 响应示例
```
{
  "data": [
    {
        # 异常分
        "anomaly_score":{
            "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
            "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
            "feature_2": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
            "feature_3": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]   
        },
        # 重构结果
        "reconstruction":{
            "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
            "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
            "feature_2": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
            "feature_3": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]   
        }
    },
    {...},
    {...},
    {...}
  ],
  "time_cost": {
    "infer_cost_time": "82.609 ms",
    "postprocess_cost_time": "0.29 ms",
    "preprocess_cost_time": "0.1332 ms",
    "service_cost_total_time": "84.965 ms"
  }
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0019.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0020.html)。
