# Pangu-CV-物体检测-S-3.1.0 #### 功能介绍 盘古计算机视觉物体检测大模型，任务是找出图像中所有感兴趣的目标，确定它们的位置和类别。 ![](https://support.huaweicloud.com/api-pangulm/public_sys-resources/note_3.0-zh-cn.png) 服务调用方式： - 支持图片推理。 - 图片推理支持在线和边缘部署。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/productdesc-pangulm/pangulm_01_0020.html)。 #### URI POST /v1/{project_id}/infer-api/proxy/service/{deployment_id}/ 获取URI方式请参见[请求URI](https://support.huaweicloud.com/api-pangulm/pangulm_05_0004.html)。 表1推理接口路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 项目ID，获取方法请参见[获取项目ID](https://support.huaweicloud.com/api-pangulm/pangulm_05_0021.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | deployment_id | 是 | String | **参数解释：** 模型的部署ID，获取方法请参见[获取模型部署ID](https://support.huaweicloud.com/api-pangulm/pangulm_05_0023.html)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求参数 表2请求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 | 表3请求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 | 表4请求Body参数 | 参数 | 是否必选 | 参数类型 | 说明 | |:---|:---|:---|:---| | images | 是 | String | **参数解释：** 图片base64编码，图片限制大小为2K。默认只支持RGB三通道图片数据，其他通道的数据暂不支持。 **约束限制：** - 图片限制大小为2K。 - 建议使用JPG、PNG、JPEG、BMP格式的图片。 - 默认只支持RGB三通道图片数据，其他通道的数据暂不支持。 **取值范围：** 不涉及 **默认取值：** 不涉及 | | threshold | 否 | String | **参数解释：** 检测框置信度阈值。 使能逻辑： 1） 优先看是否存在ENABLE_ALL_OUTPUTS参数为true，如存在则优先输出所有结果，不使用输入threshold和默认最优阈值； 2） 如果传入threshold，且ENABLE_ALL_OUTPUTS=false，则优先使用传入的threshold进行结果筛选； 3） 如果不传入threshold，或threhold=-1， 且ENABLE_ALL_OUTPUTS=false， 则使用默认最优阈值进行推理。 **约束限制：** 不涉及 **取值范围：** 最小0.0，最大1.0 **默认取值：** -1 | #### 响应参数 表5响应Body | 参数 | 参数类型 | 说明 | |:---|:---|:---| | result | List | **参数解释：** 物体检测的识别结果。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | dataset_id | String | **参数解释：** 训练数据集ID。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | 表6result中各项结构 | 参数 | 参数类型 | 说明 | |:---|:---|:---| | RegisterMatrix | List | **参数解释：** 图片特征矩阵。 **参数解释：** 置信度。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 默认为\[\[1, 0, 0\], \[0, 1, 0\], \[0, 0, 1\]\] | | Label | String | **参数解释：** 预测类别，与训练数据中的类别名称相关。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | | Score | Float | **参数解释：** 置信度。 **约束限制：** 不涉及 **取值范围：** 0\~1 **默认取值：** 不涉及 | | Box | Dict | **参数解释：** 目标主体信息，格式为{"x":x1,"y":y1,"width":w,"height":h,"angle":r}。 - x：检测到的目标主体区域的左上角x坐标。 - y：检测到的目标主体区域的左上角y坐标。 - width：检测到的目标主体区域的宽度。 - height：检测到的目标主体区域的高度。 - angle：默认为0，检测区域角度。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 | #### 请求示例 有如下三种调用方式： 调用方式总结为如下三种： 1. form-data格式调用 ``` { "file":"xxx(base64 encode image data)" } ``` 2. base64 json调用 ``` { "Files": [{"ImageData":"xxx(base64 encode image data)"}] } ``` 3. base64 json调用（threshold非必须） ``` { "images":"xxx(base64 encode image data)", "threshold":"0.4" } ``` #### 响应示例 ``` { "dataset_id": "12345", "result": [ { "RegisterMatrix": [ [ 1, 0, 0 ], [ 0, 1, 0 ], [ 0, 0, 1 ] ] }, { "Box": { "X": 0, "Y": 0, "Width": 100, "Height": 100, "Angle": 0 }, "Score": 0.9, "label": "person" } ] } ``` #### 状态码 请参见[状态码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0019.html)。 #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0020.html)。