# 盘古融合推荐异常检测大模型 #### 功能介绍 针对特定场景的异常检测任务，用户传入异常检测数据，使用模型对指定的预测目标进行异常检测预测。 #### 授权信息 账号具备所有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 | **参数解释：** 待进行预测的数据，从输入的特征数据中检测是否存在异常值。 **约束限制：** data为一个数组，数组中包含多个对象，每个对象是一组完整的特征数据。 待预测特征名需要与训练数据中的特征名保持一致。例如，训练数据中特征列按照feature_1、feature_2......进行命名，在调用推理接口时，特征名也需要保持相同。同时推理接口中特征数量需要与训练数据中的特征数保持一致。一组特征数据填写完成后再填写剩余待预测数据，格式详见请求示例。 **取值范围：** 输入数据中的一组数据。 **默认取值：** 预测大模型在训练完成后，可以在训练日志页面，"模型训练"日志节点中获取推理api所用的示例数据。填写请求Body时可以参考该示例填写。 ![](https://support.huaweicloud.com/api-pangulm/zh-cn_image_0000002727291734.png) | | predict_proba | 否 | boolean | **参数解释：** 是否输出置信度。 **约束限制：** 无 **取值范围：** - true：输出 - false：不输出 **默认取值：** false。 | | auto_fill | 否 | boolean | 参数解释： 是否使用数据补齐功能，开启后将自动填充离散列缺失值和新类别。 约束限制： 只有经过类别特征列处理的列，才能进行数据补齐功能。 取值范围： - true：填充 - false：不填充 默认取值： false。 | #### 响应参数 **状态码： 200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | result | Object | **参数解释：** 预测结果信息。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | pred_proba | Array | **参数解释：** 预测结果对应的置信度，每条结果为一个Dict，Dict的键值对分别表示预测结果、置信度。 **约束限制：** 请求字段predict_proba配置为true时，响应body才返回pred_proba子项，否则无该子项。 **取值范围：** 不涉及 **默认取值：** 不涉及 | **状态码： 400** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码。 | | error_msg | String | 错误信息。 | #### 请求示例 ``` { "data": [ { "feature_1": xx, "feature_2": xx, ... "feature_n": xx }, ... { "feature_1": xx, "feature_2": xx, ... "feature_n": xx } ], "predict_proba": true, "auto_fill": true } ``` #### 响应示例 ``` { "result": [ "0", "1", ... "0" ], "pred_proba": [ { “0”: 0.791, “1”: 0.209 }, { “0”: 0.103, “1”: 0.897 }, ... { “0”: 0.665, “1”: 0.335 } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0019.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0020.html)。