Paddle框架API调用文档
更新时间：2023-01-18
本文档主要说明使用Paddle框架训练的模型部署到公有云后获得的API如何使用，如有疑问可以通过以下方式联系我们：
接口描述
基于Paddle深度学习框架训练出的模型，模型训练完毕，发布到模型仓库并部署到公有云后可获得定制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": [{
"tensors": [{
"name": "", // tensor name
"type": "FLOAT/INT64/INT32",
// xxx_data必须与"type"相对应，一个tensor中只能出现一种数据类型的data.
"float_data": [],
"int64_data": [],
"int32_data": [],
"shape": []
}]
}]
}Body中放置请求参数，参数想详情如下：
请求参数：
| 参数 | 是否必选 | 类型 | 可选范围值 | 说明 |
|---|---|---|---|---|
| instances | 是 | array(object) | - | 用于预测的数据实例信息 |
| +tensors | 是 | array(object) | - | 模型输入对应的tensor数据 |
| ++name | 是 | string | - | tensor名称 |
| ++shape | 是 | array(number) | - | tensor的shape |
| ++type | 是 | string | FLOAT/INT64/INT32 |
tensor的数据类型 |
| ++float_data | 否 | array(number) | - | 浮点型数据；必须与”type”相对应，当type为FLOAT时传入 |
| ++int64_data | 否 | array(number) | - | 64位整形数据；必须与”type”相对应，当type为FLOAT时传入 |
| ++int32_data | 否 | array(number) | - | 32位整形数据；必须与”type”相对应，当type为FLOAT时传入 |
| ++lod_vector | 否 | array(object) | - | tensor的LoD向量信息。常在变长序列输入模型(如文本类)中使用，详情可参考LoD-Tensor使用说明，模型不存在lod时无须指定 |
| +++lod | 否 | array(number) | - | 各个level的LoD信息 |
返回说明
返回参数
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| log_id | 是 | number | - | 用于排查问题的log id |
| result | 否 | object | - | 模型的预测结果 |
| +predictions | 否 | array(object) | - | paddle模型预测结果 |
| ++tensors | 是 | array(object) | - | 模型预测输出对应的tensor信息 |
| +++name | 是 | string | - | tensor名称 |
| +++shape | 是 | array(number) | - | tensor的shape |
| +++type | 是 | string | FLOAT/INT64/INT32 |
tensor的数据类型 |
| +++float_data | 否 | array(number) | - | 浮点型预测值；与”type”相对应，当type为FLOAT时返回 |
| +++int64_data | 否 | array(number) | - | 64位整形数据；与”type”相对应，当type为INT64时返回 |
| +++int32_data | 否 | array(number) | - | 32位整形数据；与”type”相对应，当type为INT32时返回 |
| ++lod_vector | 否 | array(object) | - | 输出tensor的LoD向量信息。详情可参考LoD-Tensor使用说明 |
| +++lod | 否 | array(number) | - | 各个level的LoD信息 |