# AI 面部色调分析器

# 概览
AI 面部色调分析器可检测脸部肤色，以及眼睛、眉毛、嘴唇和头发的颜色。这套包容性技术能让各种肤色的顾客都有量身定制的购物体验。
![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/img_Face_Ratio_sec_02_02_enu_21a3d8d423.jpg)
![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/shade_finder_s5_poster_2_8a8f9307d2.png)
## 接入指南
* AI 面部色调分析器怎么拍照
正脸自拍一张
  - 拍一张清楚的照片即可，正对镜头。头发散下放下来、垂到胸前，视线直视前方，做出正对镜头的角度。
  - 也可以用 JS Camera Kit 拍照。同样把头发散下放下来、垂到胸前，不要扎起来。
* 如何用 AI 检测肌肤问题

1. **调整源图尺寸**
把图片缩放到支持的尺寸范围，详见 **[文件规格与错误码](#section/overview/File-Specs-and-Errors)**
2. **用 File 接口上传文件**
通过 ***/s2s/v2.0/file*** 接口上传目标用户图片。
  - 图片要求
    - 详见
**[文件规格与错误码](#section/overview/File-Specs-and-Errors)**
。
  - ***重要***：只调用 File 接口并不等于上传了文件。您必须**手动把文件上传到 File 接口响应中给出的那个 URL**，那个 URL 就是您的上传目标，务必确认文件已成功传过去，再继续往下做。
调用 AI 接口之前，请确认文件已上传成功。先用 File 接口取到一个上传 URL，把文件上传到该位置。上传完成后，您会在响应中收到一个 ***file_id***，调用与该文件相关的 AI 功能时就用它。
> **警告：** 请注意，若未把文件上传到 File 接口响应中给出的 URL，调用 AI 接口时会得到 500 Server Error / unknown_internal_error 或 404 Not Found 错误。
3. **执行 AI 面部色调分析器任务**
上传完成后，AI 会用您的文件 ID 分析嘴唇、眼睛、眉毛、皮肤与头发的色调，详见 **[输入与输出](#section/overview/Inputs-and-Outputs)**。
随后用文件 ID 调用 POST 'task/skin-tone-analysis' 执行任务，
并取得 ***task_id***。
4. **轮询任务状态，直到成功或报错**
用这个 ***task_id*** 轮询 GET 'task/skin-tone-analysis' 监控任务状态，取得引擎当前的处理进度。引擎完成任务之前，状态会一直是 'running'，这一阶段不消耗点数。
**警告：** 请注意，**轮询**任务状态必须按任务保留期来执行，是强制要求。保留期内没有任何轮询请求，任务就会超时，即使任务已处理成功也一样（您的点数照样会被消耗）。
> **警告：** 若去查询已超时任务的状态，会收到 ***InvalidTaskId*** 错误。因此，执行 AI 任务之后，必须在保留期内持续**轮询**，直到状态变为 *success* 或 *error*。
5. **任务成功后取回结果**
引擎成功处理您的输入文件、生成出图后，任务状态会变为 'success'。您会得到处理后图片的 URL 以及一个 dst_id，可直接串联下一个 AI 任务，不必把结果图重新上传。
只有这种情况才会消耗点数。若引擎处理失败，任务状态会变为 'error'，不消耗点数。
扣除点数时，系统优先扣除临近到期的点数；到期日相同时，优先扣除最早取得的点数。

![](https://plugins-media.makeupar.com/smb/blog/post/2022-08-19/2a1af800-7c69-44a5-a94c-70a4a9c4d2b0.jpg)


---

## 输入与输出
* 输入

AI 会分析您皮肤的色调。您可以调整
`face_angle_strictness_level`
，控制对输入脸部角度的校验严格度，档位从严格、高、中、低到宽松。该严格度作用于脸部角度检测，包括俯仰角、偏航角与翻滚角。档位越严，脸部属性结果越准。默认设置为高。

![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/shade_finder_s4_poster_399f34c6ef.jpg)
* 输出


```json
{
  "status": 200,
  "data": {
    "task_status": "success",
    "results": {
      "color": {
        "eye_color": "#293F9B",
        "eye_color_name": "Blue",
        "lip_color": "#D23245",
        "eyebrow_color": "#5B2B31",
        "skin_color": "#b9947c",
        "hair_color": "#a0a0a0",
        "hair_color_name": "Auburn"
      }
    }
  }
}
```
| **结果参数** | **结果类型** |
|  --- | --- |
| `skin_color` | 十六进制色值 |
| `eye_color` | 十六进制色值 |
| `eye_color_name` | Amber、Brown、Green、Blue、Gray、Other |
| `lip_color` | 十六进制色值 |
| `eyebrow_color` | 十六进制色值 |
| `hair_color` | 十六进制色值 |
| `color.hair_color_name` | Auburn、Black、Blonde、Brown、Grey/White、Red |

* 拍摄建议：

![](https://bcw-media.s3.ap-northeast-1.amazonaws.com/strapi/assets/webp_AI%20Skin%20Analysis_camera_f93315b088.png)

> **警告：** 脸部宽度需大于图片宽度的 60%。



---

## 文件规格与错误码
* 支持的格式与尺寸

| AI 功能 | 支持尺寸 | 支持文件大小 | 支持格式 |
|  --- | --- | --- | --- |
| AI 面部色调分析器 | 长边 <= 4096，仅支持单人。任一维度超过 1080 像素的图片会自动缩放后进行分析。 | < 10MB | jpg/jpeg/png |

* 错误码

| 错误码 | 说明 |
|  --- | --- |
| error_below_min_image_size | 原图尺寸不得低于 320 像素。 |
| error_face_position_invalid | 人脸须完整可见、正对镜头，并位于画面中央。 |
| error_face_position_too_small | 检测到的人脸太小，无法分析。 |
| error_face_position_out_of_boundary | 人脸超出了画面边界。 |
| error_face_not_forward_facing | 人脸必须正对镜头。 |
| error_face_angle_upward | 脸部过度朝上——请把头略微低一点。 |
| error_face_angle_downward | 脸部过度朝下——请把头略微抬一点。 |
| error_face_angle_leftward | 脸部过度朝左——请把头略微向右转。 |
| error_face_angle_rightward | 脸部过度朝右——请把头略微向左转。 |
| error_face_angle_left_tilt | 脸部向左侧倾斜过多——请把头轻轻向右扶正。 |
| error_face_angle_right_tilt | 脸部向右侧倾斜过多——请把头轻轻向左扶正。 |

* 运行环境与依赖

| 示例代码语言 / 工具 | 建议运行时版本 |
|  --- | --- |
| cURL | - bash >= 3.2   - curl >= 7.58 (modern TLS/HTTP support)   - jq >= 1.6 (robust JSON parsing) |
| Node.js (JavaScript) | Node >= 18 (for global fetch) |
| JavaScript | - Chrome / Edge >= 80   - Firefox >= 74   - Safari >= 13.1 |
| PHP | PHP >= 7.4 (for modern TLS/compat), ext-curl (recommended) or allow_url_fopen=On + ext-openssl, ext-json |
| Python | Python >= 3.10 (for f-strings), requests >= 2.20.0 |
| Java | Java 11+ (for HttpClient), Jackson Databind >= 2.12.0 |



---

## JS Camera Kit


---

## 点数消耗
| AI 功能 | 消耗点数 |
|  --- | --- |
| AI 面部色调分析器 V1.0 | 20 |



---

License: Privacy policy

## Servers

```
https://yce-api-01.makeupar.com
```

## Security

### BearerAuthenticationV2

使用标准的 Bearer 鉴权。把您的 API 密钥放进请求头： `Authorization:Bearer YOUR_API_KEY`。请注意 'Bearer' 与 'YOUR_API_KEY' 之间有一个空格。

Type: http
Scheme: bearer

## Download OpenAPI description

 - [AI 面部色调分析器](https://docs.perfectcorp.com/_bundle/@l10n/zh-CN/reference/ai_skin_tone_analysis.yaml)

## V1.0

 - [POST /s2s/v2.0/task/skin-tone-analysis](https://docs.perfectcorp.com/zh-cn/reference/ai_skin_tone_analysis/v1.0/paths/~1s2s~1v2.0~1task~1skin-tone-analysis/post.md): 本接口用于发起 AI 面部色调分析器流程。您需要提供源文件（URL 或文件 ID），并可选指定脸部角度的严格程度。任务会异步处理，您可以使用本响应返回的 task_id 查询其状态。
 - [GET /s2s/v2.0/task/skin-tone-analysis/{task_id}](https://docs.perfectcorp.com/zh-cn/reference/ai_skin_tone_analysis/v1.0/paths/~1s2s~1v2.0~1task~1skin-tone-analysis~1%7Btask_id%7D/get.md)