# 时序预测回归微调产物推理
#### 功能介绍
使用微调产物进行部署推理。微调使用历史数据对基模型进行微调，实现时序预测任务，最多支持128个未来时间点的预测。预测目标数据需要是连续数值，数据类型一般是数值类。
#### 授权信息
账号具备所有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 | **参数解释：** 时序数据请求的批处理队列。 **约束限制：** 盘古时序预测回归任务的输入数据内容，用字典承载。输入数据字典中，键对应特征列名，值为序列数据具体内容。 **取值范围：** 输入数据中的一组数据。 **默认取值：** 预测大模型在训练完成后，可以在训练日志页面，"模型训练"日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 ![](https://support.huaweicloud.com/api-pangulm/zh-cn_image_0000002727451494.png)                          |
| context_len      | 否  | int | **参数解释：** 时序任务的历史窗口大小，该参数主要服务于支持多尺度窗口的模型的推理。 **约束限制：** 填写时需要保证输入序列长度大于等于该值。 **取值范围：** - min：32  - max：与训练模型的历史窗口大小一致，最大不超过512。   **默认取值：** -1，-1为当前服务模型的默认大小。                                       |
| prediction_len | 否  | int  | **参数解释：** 时序预测输出的窗口长度。数值越大输出预测的时间范围越大，但相应的显存占用会增加以及模型预测精度可能会下降。 **约束限制：** 基于已发布模型的进行增量微调，输出窗口需要与其保持一致。 **取值范围：** - min：1  - max：与训练模型的预测目标窗口大小一致，最大不超过128。   **默认取值：** 与训练模型的预测目标窗口大小一致。 |
| auto_fill          | 否  | boolean | **参** **数解释：** 是否使用数据补齐功能，开启后将自动填充离散列缺失值和新类别。 **约束限制：** 只有经过类别特征列处理的列，才能进行数据补齐功能。 **取值范围：** true：填充 false：不填充 **默认取值：** false。                                                                                                                                                                            |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数       | 参数类型                | 描述                                                                                                                                                                                                                                                                                                                   |
|:---|:---|:---|
| data     | LIST\<OutputMeta\> | **参数解释：** 时序预测结果的列表。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                    |
| time_cost | JSON             | **参数解释：** 当启动服务时，本次请求服务各阶段耗时情况。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表5OutputMeta格式说明 
| 参数名称        | **参数类型** | **说明**                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| prediction | JSON      | **参数解释：** 时序分类的输出结果，具体见样例调用示例。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
**状态码： 400**
表6响应Body参数 
| 参数          | 参数类型  | 描述       |
|:---|:---|:---|
| error_code | String | 错误码。    |
| error_msg    | String  | 错误信息。 |
   
#### 请求示例
```
{
  "context_len": 256,
  "prediction_len": 96,
  "data": [
    {
      "context": {
        "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]
      }
    },
    {
      "context": {
        "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...],
        "feature_1": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]
      }
    }
  ]
}
```
#### 响应示例
```
{
  "data": [
    {
        "prediction":{
            "feature_0": [ 864.1618041992188, 493.91827392578125, 252.7724151611328,...]
            "feature_1": [ 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)。
