XGBoost框架API调用文档
更新时间:2023-01-18
本文档主要说明使用XGBoost框架训练的模型部署到公有云后获得的API如何使用,如有疑问可以通过以下方式联系我们:
接口描述
基于XGBoost机器学习框架训练出的模型,模型训练完毕,发布到模型仓库并部署到公有云后可获得定制API
接口鉴权
- 在BML-控制台创建应用
- 应用列表获取AK/SK
请求说明
HTTP 方法:POST
请求URL: 请首先进行自定义模型训练,完成训练后申请上线,上线成功后可在服务列表中查看并获取url。
URL参数:
参数 | 值 |
---|---|
access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下:
参数 | 值 |
---|---|
Content-Type | application/json |
Body请求示例:
{
"instances": [
{
"features": [10, 2, 0, 3,5]
}
]
}
请求参数:
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
instances | 是 | array(object) | - | 用于预测的数据实例信息 |
+features | 是 | array(number) | - | 单条特征数据,长度需和模型输入的特征总数相同 |
返回说明
返回body示例:
{
"log_id": xxx,
"result": {
"labels": [
{
"categories": [14.95627212524414]
}
]
}
}
返回参数:
参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
---|---|---|---|---|
log_id | 是 | number | - | 用于排查问题的log id |
result | 否 | object | - | 模型的预测结果 |
+labels | 否 | array(object) | - | 各个instances对应的分类标签或者回归预测值 |
++categories | 否 | array(number) | - | 单个instance对应的分类标签或者回归预测值 |
error_code | 否 | object | - | 错误码 |
error_msg | 否 | object | - | 错误信息 |