
# Pangu-CV-物体检测-N-2.1.0
#### 功能介绍
找出图像中所有感兴趣的目标，确定它们的位置和类别。物体检测-N模型特点是参数量适中，适合在资源有限的环境中使用，提供较快的检测速度和合理的精度。
![](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)。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
#### 请求参数
使用[Token认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section94702116509)方式的请求Header参数见[表3]。
表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                                                                                                                                                                       |
   
使用[API Key认证](https://support.huaweicloud.com/api-pangulm/pangulm_05_0009.html#pangulm_05_0009__section148602501261)方式的请求Header参数见[表2](https://support.huaweicloud.com/api-pangulm/pangulm_05_0073.html#pangulm_05_0073__table11660746103618)。
 表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编码。 **约束限制：** - 建议使用PNG、JPEG、BMP、JPG、WEBP格式的图片。  - 只支持单张图片输入，分辨率范围为1px-10000px，且长短边比例不能高于5。并且base64编码后的图片大小不超过10MB。  - 支持RGB三通道格式的图像。   **取值范围：** 不涉及 **默认取值：** 不涉及 |
| nms_iou_thr  | 是    | Float  | **参数解释：** 极大值抑制阈值。 **约束限制：** 不涉及 **取值范围：** 0.0\~1.0 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                   |
| agnositc_nms | 是    | Bool   | **参数解释：** 是否进行类间nms，是填写true，不是填写false。 **约束限制：** 不涉及 **取值范围：** true：进行类间nms **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                             |
   
#### 响应参数
**状态码： 200**
表5响应Body参数 
| 参数     | 参数类型 | 描述                                                                                                                                                                                                                                                                                                                                                                    |
|:---|:---|:---|
| result | List | **参数解释：** 物体检测的识别结果。物体检测的基本目标是在输入的图像或视频中找到感兴趣的目标物体，并确定它们的位置和类别，所以识别结果包含物体的类别和物体的位置。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表6响应Body参数 
| 参数             | 参数类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
|:---|:---|:---|
| RegisterMatrix | List   | **参数解释：** 默认为\[\[1, 0, 0\], \[0, 1, 0\], \[0, 0, 1\]\]，表示图片特征矩阵。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Label          | String | **参数解释：** 预测类别。物体检测中的预测类别是指模型对输入图像或视频中物体的分类结果。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| Score          | Float  | **参数解释：** 置信度。用于衡量模型对预测结果的准确性。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| Box            | Dict   | **参数解释：** 检测到的目标主体信息。 **约束限制：** 格式为{"x":x1,"y":y1,"width":w,"height":h，'Angle':angle}。 - x：检测到的目标主体区域的左上角x坐标。  - y：检测到的目标主体区域的左上角y坐标。  - width：检测到的目标主体区域的宽度。  - height：检测到的目标主体区域的高度。  - angle: 检测到的目标主体区域的角度。   **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
**状态码： 400**
表7响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误信息。 |
   
#### 请求示例
- 图片请求示例
  ```
  { 
    "nms_iou_thr":0.45,
    "agnositc_nms":false,
    "images": "/9j/4Vr2RXhpZgAASUkqAAgAAA....." 
  }
  ```
  
 
#### 响应示例
```
{ 
    "result": [ 
{ 
"RegisterMatrix": [ 
[ 
1, 
0, 
0 
], 
[ 
0, 
1, 
0 
], 
[ 
0, 
0, 
1 
] 
] 
}, 
{ 
"Box": { 
"Y": 0, 
"Width": 100, 
"Angle": 0, 
"X": 0, 
"Height": 100 
}, 
"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)。
