标准接口规范参考
更新时间：2023-01-18
脚本调参和Notebook训练方式产出的模型部署到公有云时，不同任务类型的应用接口的请求与响应均满足响应的标准规范。
图像分类-单图单标签
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| results | 否 | array(object) | 分类结果数组 |
| + name | 否 | string | 分类名称 |
| + score | 否 | number | 置信度 |
图像分类-单图多标签
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式 |
| threshold | 否 | number | 阈值，默认为当前模型推荐阈值（0-1之间），具体值可以在我的训练任务列表-模型效果查看 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| results | 否 | array(object) | 分类结果数组 |
| + name | 否 | string | 分类名称 |
| + score | 否 | number | 置信度 |
物体检测
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式 |
| threshold | 否 | number | 阈值，默认为当前模型推荐阈值（0-1之间），具体值可以在我的训练任务列表-模型效果查看 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| results | 否 | array(object) | 分类结果数组 |
| + name | 否 | string | 分类名称 |
| + score | 否 | number | 置信度 |
| + location | 否 | object | |
| ++ left | 否 | number | 目标定位位置的长方形左上顶点的水平坐标 |
| ++ top | 否 | number | 目标定位位置的长方形左上顶点的垂直坐标 |
| ++ width | 否 | number | 目标定位位置的长方形的宽度 |
| ++ height | 否 | number | 目标定位位置的长方形的高度 |
实例分割
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| image | 是 | string | 图像数据，base64编码，要求base64编码后大小不超过4M，最短边至少15px，最长边最大4096px,支持jpg/png/bmp格式 |
| threshold | 否 | number | 阈值，默认为当前模型推荐阈值（0-1之间），具体值可以在我的训练任务列表-模型效果查看 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| results | 否 | array(object) | 分类结果数组 |
| + name | 否 | string | 分类名称 |
| + score | 否 | number | 置信度 |
| + location | 否 | object | |
| ++ left | 否 | number | 目标定位位置的长方形左上顶点的水平坐标 |
| ++ top | 否 | number | 目标定位位置的长方形左上顶点的垂直坐标 |
| ++ width | 否 | number | 目标定位位置的长方形的宽度 |
| ++ height | 否 | number | 目标定位位置的长方形的高度 |
| + mask | 否 | array | 基于游程编码的字符串，编码内容为和原图宽高相同的布尔数组：若数组值为0，代表原图此位置像素点不属于检测目标，若为1，代表原图此位置像素点属于检测目标。查看解码示例 |
文本分类
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| text | 是 | string | 文本数据，UTF-8编码。最大长度4096汉字 |
| top_num | 否 | number | 返回分类数量，默认为6个 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| results | 否 | array(object) | 分类结果数组 |
| + name | 否 | string | 分类名称 |
| + score | 否 | number | 置信度 |
序列标注
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| text | 是 | string | 文本数据，UTF-8编码。最大长度4096汉字，空格分隔的字/词 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| raw_text | 是 | array(string) | 原始输入，按空格切分 |
| label | 是 | array(string) | 标注结果 |
文本实体抽取
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| text | 是 | string | 文本数据，UTF-8编码。最大长度512个字符（包括汉字和标点符号）内的文本，超出将被截断 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| results | 否 | array(object) | 实体类别识别结果数组 |
| + content | 是 | string | 预测的文本内容（最多仅支持512个字） |
| ++ span | 否 | string | 抽取的具体实体内容 |
| ++ offset | 否 | number | 具体实体内容的位置，从entity_content中，第一个字符记为0起算 |
| ++ tag | 否 | string | 识别对应span的实体类别 |
短文本相似度
标准接口请求参考说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| text_a | 是 | string | 文本数据，UTF-8编码。最大长度4096汉字 |
| text_b | 是 | string | 文本数据，UTF-8编码。最大长度4096汉字 |
标准接口响应字段说明：
| 字段名称 | 必须 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| error_code | 否 | number | 错误码，当请求错误时返回 |
| error_msg | 否 | string | 错误描述信息，当请求错误时返回 |
| score | 是 | number | 文本相似度 |