
# Pangu-CV-物体检测-S-2.1.0
#### 功能介绍
找出图像中所有感兴趣的目标，确定它们的位置和类别。物体检测-S模型特点是小参数量，适合在资源有限的环境中使用，提供较快的检测速度和合理的精度。
![](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参数见[表2]。
 表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参数见[表3]。
 表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编码。 **约束限制：** - 建议整个请求体大小不超过4M。  - 建议使用JPG、PNG、JPEG、BMP格式的图片。  - 默认只支持RGB三通道图片数据，其他通道的数据暂不支持。   **取值范围：** 不涉及 **默认取值：** 不涉及 |
| threshold | 否    | Float  | **参数解释：** 检测框置信度阈值。 **约束限制：** 不涉及 **取值范围：** 最小0.0，最大1.0 **默认取值：** 0.25                                                                                                                                                                                                                                                                                                |
   
#### 响应参数
**状态码： 200**
表5响应成功Body参数 
| 参数     | 参数类型             | 描述                                                                                                                                                                                                                                                                                                             |
|:---|:---|:---|
| result | Array of objects | **参数解释：** 识别结果信息。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及     |
| Score  | Float            | **参数解释：** 置信度。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及       |
| label  | String           | **参数解释：** 检测类别。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及      |
| Box    | Dict             | **参数解释：** 检测到的目标主体信息。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
表6Box 
| 参数     | 参数类型 | 描述                                                                                                                                                                                                                                                                                                                       |
|:---|:---|:---|
| X      | Int  | **参数解释：** 矩形框左上角横坐标。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及      |
| Y      | Int  | **参数解释：** 矩形框左上角纵坐标。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及        |
| width  | Int  | **参数解释：** 矩形框宽度。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                |
| Height | Int  | **参数解释：** 矩形框高度。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及                 |
| Angle  | Int  | **参数解释：** 检测到的目标主体区域的角度。 **约束限制：** 不涉及 **取值范围：** 不涉及 **默认取值：** 不涉及 |
   
**状态码： 400**
表7响应Body参数 
| 参数         | 参数类型   | 描述    |
|:---|:---|:---|
| error_code | String | 错误码。  |
| error_msg  | String | 错误信息。 |
   
#### 请求示例
```
{
  "images": "/9j/4Vr2RXhpZgAASUkqAAgAAA.....",
  "threshold": 0.3
}
```
#### 响应示例
```
{
    "result": [
        {
            "Box": {
                "Angle": 0,
                "Height": 60,
                "Width": 106,
                "X": 852,
                "Y": 182
            },
            "Score": 0.88427734375,
            "label": "car"
        },
        {
            "Box": {
                "Angle": 0,
                "Height": 114,
                "Width": 55,
                "X": 800,
                "Y": 170
            },
            "Score": 0.70556640625,
            "label": "person"
        }
    ]
}
```
#### 状态码
请参见[状态码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0019.html)。
#### 错误码
请参见[错误码](https://support.huaweicloud.com/api-pangulm/pangulm_05_0020.html)。
