
# AllParam
#### 功能介绍
涉及到的所有参数类型的详细说明。
#### 参数说明
表1结果格式说明表 
| 名称                | 类型      | 说明                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
|:---|:---|:---|
| project_id        | String  | 项目ID，获取方法请参见[获取项目ID/账号名/AK/SK](https://support.huaweicloud.com/api-face/face_02_0056.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| image_url         | String  | 图片的URL路径，目前仅支持华为云上OBS的URL，且人脸识别服务有权限读取该OBS桶的数据。开通读取权限的操作请参见[服务授权](https://support.huaweicloud.com/api-face/face_02_0006.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| image_file        | File    | 本地图片文件，图片不能超过8MB，建议**小于1MB**。上传文件时，请求格式为multipart。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| image_base64      | String  | 图像数据，Base64编码，要求： - Base64编码后大小不超过8MB，建议。  - 图片为JPG/JPEG/BMP/PNG格式。                                                                                                                                                                                                                                                                                                                                                                                                                       |
| similarity        | Double  | 人脸相似度，1表示最大，0表示最小，值越大表示越相似。一般情况下超过0.93即可认为是同一个人。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| face_set_name     | String  | 人脸库名称，1位到64位之间，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| face_set_capacity | Integer | 人脸库最大的容量，填写1万整数倍的数字，例如30000。默认为100000，最大值为100000，可通过创建新的人脸库进行扩容，每个用户可使用10个人脸库，每个人脸库容量为10万个人脸特征。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| face_id           | String  | 导入人脸时，系统返回的人脸编号，为8个随机生成的大小写字母组成。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| external_image_id | String  | 用户指定的图片外部ID，与当前图像绑定。用户没提供，系统会生成一个。该ID长度范围为1～36位，可以包含字母、数字、中划线或者下划线，不包含其他的特殊字符。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| external_fields   | Json    | 根据用户自定义数据类型，填入相应的数值。创建人脸库时，定义该字段。具体参见[自定义字段](https://support.huaweicloud.com/api-face/face_02_0012.html)。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| top_n             | Integer | 返回查询到最相似的N张人脸，N默认为10。如果返回前5个，则该变量N的值为5。 取值范围1～1000。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| threshold         | Double  | 人脸相似度阈值，低于这个阈值则不返回，取值范围\[0,1\]，一般情况下建议取值0.93，默认为0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| offset            | Integer | 从第几条数据读起，默认为0。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| limit             | Integer | 读取多少条，默认为5。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| video_url         | String  | 视频的URL路径，目前仅支持华为云上OBS的URL，且人脸识别服务有权限读取该OBS桶的数据。开通读取权限的操作请参见[服务授权](https://support.huaweicloud.com/api-face/face_02_0006.html)。视频要求： - 视频Base64编码后大小不超过8MB。  - 限制视频时长1～15秒。  - 建议帧率10fps～30fps。  - 封装格式：mp4、avi、flv、webm、asf、mov。  - 视频编码格式： h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。   |
| video_file        | File    | 本地视频文件。上传文件时，请求格式为multipart。视频要求： - 视频文件大小不超过8MB，建议客户端压缩到**200KB\~2MB**。  - 限制视频时长1～15秒。  - 建议帧率10fps～30fps。  - 封装格式：mp4、avi、flv、webm、asf、mov。  - 视频编码格式： h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。                                                                                                    |
| video_base64      | String  | 视频数据，Base64编码，要求： - Base64编码后大小不超过8MB，建议客户端压缩到**200KB\~2MB**。  - 限制视频时长1～15秒。  - 建议帧率10fps～30fps。  - 封装格式：mp4、avi、flv、webm、asf、mov。  - 视频编码格式： h261、h263、h264、hevc、vc1、vp8、vp9、wmv3。                                                                                                                      |
| actions           | String  | 动作代码顺序列表，英文逗号（,）分隔。建议单动作，目前支持的动作有： - 1：左摇头  - 2：右摇头  - 3：点头  - 4：嘴部动作                                                                                                                                                                                                                                                                                                     |
| action_time       | String  | 该参数为动作时间数组拼接的字符串，数组的长度和actions的数量一致，每一项代表了对应次序动作的起始时间和结束时间，单位为距视频开始的毫秒数。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| error_code        | String  | 调用失败时的错误码。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| error_msg         | String  | 调用失败时的错误信息。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| attributes        | String  | 是否返回人脸属性，希望获取的属性列表，多个属性用逗号隔开。目前支持的属性有： - 0：人脸姿态  - 2：年龄  - 3：人脸关键点  - 4：装束（帽子、眼镜）  - 5：笑脸                                                                                                                                                                         |
   
