# 盘古表格直推预测大模型
#### 功能介绍
可实现免微调直推表格预测，面对有限样本条件下，基于上下文关联推理技术，免微调自适应数据分布，可以实现开箱即用的效果。
#### 授权信息
账号具备所有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参数 
| 参数        | 是否必选 | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                              |
|:---|:---|:---|:---|
| target    | 是    | string | **参数解释：** 指定要预测的目标列名。 **约束限制：** 仅支持单个目标。 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                |
| sample    | 是    | json   | **参数解释：** 预测所需的样例数据（few shot）, sample是json格式， json的key对应特征列名，value是一个Array，对应该特征列的数据。格式详见请求示例。 **约束限制：** 1\<sample行数 \<= 20000行 特征数 \<= 500 sample \* 特征数 \<= 1000000 云上部署数据量 \< 12MB                              |
| data      | 是    | Array  | **参数解释：** 待进行预测的数据，data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 **约束限制：** 待预测特征名需要与sample中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2......进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 data行数 \<= 1000行 特征数 \<= 500 |
| task_type | 是    | string | **参数解释：** 任务类型。 **约束限制：** 支持的类型包括regression和classification，分别对应回归和分类任务。                                                                                                                                                                                                                                                      |
   
#### 响应参数
**状态码： 200**
表4响应Body参数 
| 参数        | 参数类型 | 描述                                                                                                                                                                                                                                                                                                                  |
|:---|:---|:---|
| results   | LIST | **参数解释：** 预测结果的列表。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                      |
| time_cost | JSON | **参数解释：** 当启动服务时，本次请求服务各阶段耗时情况。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
**状态码： 400**
表5响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误信息。 |
   
#### 请求示例
```
{
    "target": "feature_0",
    "task_type": "regression",
    "sample": {
        "feature_0": [
            9,
            0
        ],
        "feature_1": [
            252.71994790753982,
            0
        ],
        "feature_2": [
            584.8740678212971,
            0
        ],
        "feature_3": [
            507.5732435552864,
            0
        ],
        "feature_4": [
            75.7524144068944,
            0
        ]
    },
    "data": [
        {
            "feature_1": 6.4533336224,
            "feature_2": 677.3766556825,
            "feature_3": 923.0984447151,
            "feature_4": 837.6293168679
        },
        {
            "feature_1": 712.3825532408,
            "feature_2": 373.0545721447,
            "feature_3": 393.8145421256,
            "feature_4": 597.3197447678
        }
    ]
}
```
#### 响应示例
```
{
  "results": [
      0,
      1,
       ...
      0
  ],
  "time_cost": {
      "infer_cost_time": 233, 
      "postprocess_cost_time": 13, 
      "preprocess_cost_time": 12, 
      "service_cost_total_time": 258
    } 
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0019.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0020.html)。