人物图像检测API详情

本文档仅适用于华北2（北京）地域，且必须使用该地域的API Key。

人物图像检测

支持的领域 / 任务：aigc /facechain人物写真生成

对用户上传的人物图像进行检测，判断其中所包含的人脸是否符合facechain微调所需的标准，检测维度包括人脸数量、大小、角度、光照、清晰度等多维度，支持图像组输入，并返回每张图像对应的检测结果。该模型非任务流程强制环节，可以根据业务需要自行选择是否接入。

选择图像建议

人脸数量：1个人脸，不支持多人脸、不支持无人脸图像；
人脸质量：建议为正面人脸，面部大于128*128像素，无墨镜、手部等遮挡，不要有浓妆和过度美颜；
图像质量：图像分辨率大于256256，小于40964096，文件大小不超过5MB，图像清晰，没有复杂的光线和阴影关系；

模型概览

模型名	模型简介
facechain-facedetect	对用户上传的人物图像进行检测，判断其中所包含的人脸是否符合facechain微调所需的标准，检测维度包括人脸数量、大小、角度、光照、清晰度等多维度，支持图像组输入，并返回每张图像对应的检测结果。

HTTP调用接口

功能描述

本模型为同步接口，在提交任务后会返回对应的作业结果。

前提条件

已开通服务并获得API-KEY：获取与配置 API Key。

接口限制：对单账户（含主账号与RAM子账号）任务下发接口限制QPS为5。

作业提交接口调用

POST https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/vision/facedetection/detect 调用时请将{WorkspaceId}替换为真实的业务空间ID。

入参描述

传参方式	字段	类型	必选	描述	示例值
Header	Content-Type	String	是	请求类型：application/json	application/json
Header	Authorization	String	是	API-Key，例如：Bearer d1**2a	Bearer d1**2a
Body	model	String	是	指明需要调用的模型，固定值	facechain-facedetect
Body	input.images	Array	是	输入的图像 URL，分辨率不小于256256，不超过40964096，文件大小不超过5MB, 支持格式包括JPEG, PNG, JPG, WEBP。URL 需为公网可访问的地址，并支持 HTTP 或 HTTPS 协议。您也可在此获取临时公网URL。图片URL中如果包含非ASCII字符（如中文文件名），需要先进行URL编码（percent-encoding），否则可能导致 `InternalError.Algo` 错误。例如，在Python中使用 `urllib.parse.quote()` ，在JavaScript中使用 `encodeURI()` 对URL进行编码。	"images": [ "http://a/a.jpg","http://b/b.jpg","http://c/c.jpg",]

出参描述

字段	类型	描述	示例值
output.is_face	Array	客户提交的图像列表对应的检测结果，与输入图像顺序一一对应。 true：检测通过。 false：检测不通过。	"is_face":[ true, true, false, false ]
output.failed_reason	Array	图像检测不通过的原因。	no face detected
usage	Object	本次请求的计费用量统计信息。由于目前facechain-facedetect模型处于限时免费阶段，因此用量信息显示为空。	-
request_id	String	本次请求的系统唯一码。	7574ee8f-38a3-4b1e-9280-11c33ab46e51

请求示例

以下示例展示通过CURL命令来调用本模型的脚本

需要使用您的API-KEY替换示例中的your-dashscope-api-key，代码才能正常运行。

curl --location --request POST 'https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com/api/v1/services/vision/facedetection/detect' \
--header "Authorization: Bearer ${DASHSCOPE_API_KEY}" \
--header 'Content-Type: application/json' \
--data '{
  "model": "facechain-facedetect",
  "input": {
    "images": [
      "http://finetune-swap-wulanchabu.oss-cn-wulanchabu.aliyuncs.com/zhicheng/tmp/1E1D5AFA-3C3A-4B6F-ABD6-8742CA983C42.png",
      "http://finetune-swap-wulanchabu.oss-cn-wulanchabu.aliyuncs.com/zhicheng/tmp/3.JPG",
      "http://finetune-swap-wulanchabu.oss-cn-wulanchabu.aliyuncs.com/zhicheng/tmp/F2EA3984-6EE2-44CD-928F-109B7276BCB6.png"
    ]
  },
  "parameters": {
  }
}'

响应示例

{
  "output": {
    "is_face": [true, false, true],
    "failed_reason": ["", "no face detected", ""]
  },
  "usage": {},
  "request_id": "549e0573-f630-9c17-8df2-08f605b4a646"
}

异常响应示例

在提交作业请求出错的情况下，输出的结果中会通过 code 和 message 指明出错原因。

{
    "code":"InvalidApiKey",
    "message":"Invalid API-key provided.",
    "request_id":"fb53c4ec-1c12-4fc4-a580-cdb7c3261fc1"
}

状态码说明

大模型服务平台通用状态码请查阅：错误码

http 返回码*	错误码（code）	错误信息（message）	含义说明
400	InvalidParameter	Required parameter(s) missing or invalid, please check the request parameters.	接口调用参数不合法
500	InternalError.Algo	InternalError.Algo	服务内部算法执行异常。常见原因为输入的图片URL包含非ASCII字符（如中文），请对URL进行编码处理后重试。

​人物图像检测

​选择图像建议

​模型概览

​HTTP调用接口

​功能描述

​前提条件

​作业提交接口调用

​入参描述

​出参描述

​请求示例

​响应示例

​异常响应示例

​状态码说明

人物图像检测

选择图像建议

模型概览

HTTP调用接口

功能描述

前提条件

作业提交接口调用

入参描述

出参描述

请求示例

响应示例

异常响应示例

状态码说明