# Generated by ShowAPI OpenAPI generator
# source: market/2563
# generated-at: 2026-06-26T00:24:58.498Z
openapi: 3.0.3
info:
  title: 百度云-人脸识别
  description: 灵活应用于金融、泛安防、零售等行业场景，满足身份核验、人脸考勤、闸机通行等业务需求。
  termsOfService: https://www.showapi.com/helpcenter/view#/4019/2
  version: 1.0.0
servers:
  - url: https://route.showapi.com
paths:
  /2563-9:
    x-pointCode: 9
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸融合
      description: |-
        对两张人脸进行融合处理，生成的人脸同时具备两张人脸的外貌特征（并不是换脸），此服务具有如下三个业务功能：

        指定人脸：当图片中有多张人脸时，可以指定某一张人脸与模板图进行融合
        图像融合：将检测到的两张人脸图片进行融合，输出一张融合后的人脸
        黄反识别：利用图像识别能力，判断图片中是否存在色情、暴恐血腥场景、政治敏感人物。原接口订购地址：https://cloud.baidu.com/product/face/portrait_effects
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          timestamp:
                            type: number
                          result:
                            type: object
                            properties:
                              merge_image:
                                type: string
                                description: 融合图的BASE64值
                          cached:
                            type: number
                          ret_code:
                            type: number
                          error_code:
                            type: number
                          log_id:
                            type: number
                          error_msg:
                            type: string
                        description: 业务返回体
      operationId: 2563_9_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                version:
                  type: string
                  description: 服务版本 ，可选（1.0,2.0,3.0,4.0），如不传入该项则默认调用（1.0），2.0/3.0/4.0对merge_degree不生效，对融合效果要求较高可选择2.0（推荐版本），对融合结果的清晰度要求较高可选择3.0，4.0为最新版本，清晰度及融合效果均有提升，页面功能演示为2.0版本效果
                alpha:
                  type: number
                  description: 融合参数，可选范围 0-1浮点数,保留两位小数，默认(0), 只在version=4.0时才有效
                image1:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: 模板图信息 图片的分辨率要求在1920x1080以下
                image2:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: 目标图信息 图片的分辨率要求在1920x1080以下
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值;
                    URL:图片的 URL( 下载图片时可能由于网络等原因导致下载图片时间过长)
                    FACE_TOKEN: 人脸标识
                quality_control:
                  type: string
                  description: |-
                    质量控制
                    NONE: 不进行控制
                    LOW:较低的质量要求 NORMAL: 一般的质量要求
                    HIGH: 较高的质量要求
                    默认NONE
                face_location:
                  type: string
                  description: |-
                    指定模板图中进行人脸融合的人脸框位置 不指定时则默认使用最大的人脸
                    格式形如: {"left": 111.4,"top": 96.56,"width": 98,"height": 98,"rotation": 3}
                    当image_type为FACE_TOKEN时, 此参数无效, 会使用FACE_TOKEN对应的人脸
                merge_degree:
                  type: string
                  description: |-
                    融合度 关系到融合图与目标图的相似度 越高则越相似
                    LOW:较低的融合度
                    NORMAL: 一般的融合度
                    HIGH: 较高的融合度
                    COMPLETE: 完全融合，其效果类似于换脸
                    默认COMPLETE
                position:
                  type: number
                  description: |-
                    水印的位置，取值如下：
                    0-右下角
                    1-左下角
                    2-左上角
                    3-右上角
                    默认0
                language:
                  type: number
                  description: |-
                    水印的语言，取值如下：
                    0-中文（AI生成）
                    1-英文（Generated by AI）
                    默认0
              required:
                - ds_id
                - image1
                - image2
                - image_type
  /2563-8:
    x-pointCode: 8
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 在线图片活体检测
      description: |-
        人脸基础信息：包括人脸框位置，人脸空间旋转角度，人脸置信度等信息。
        人脸质量检测：判断人脸的遮挡、光照、模糊度、完整度等质量信息。可用于判断上传的人脸是否符合标准。
        基于图片的活体检测：基于单张图片，判断图片中的人脸是否为二次翻拍（举例：如用户A用手机拍摄了一张包含人脸的图片一，用户B翻拍了图片一得到了图片二，并用图片二伪造成用户A去进行识别操作，这种情况普遍发生在金融开户、实名认证等环节）以及是否为合成图攻击。此能力可用于H5场景下的一些人脸采集场景中，增加人脸注册的安全性和真实性。原接口订购地址：https://cloud.baidu.com/product/face/private
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          thresholds:
                            type: object
                            properties:
                              frr_1e-4:
                                type: number
                              frr_1e-3:
                                type: number
                              frr_1e-2:
                                type: number
                            description: 由服务端返回最新的阈值数据（随着模型的优化，阈值可能会变化），将此参数与返回的face_liveness进行比较，可以作为活体判断的依据。 frr_1e-4：万分之一误识率的阈值；frr_1e-3：千分之一误识率的阈值；frr_1e-2：百分之一误识率的阈值。误识率越低，准确率越高，相应的拒绝率也越高
                          face_liveness:
                            type: number
                            description: 活体分数值
                          face_list:
                            type: array
                            items:
                              type: object
                              properties:
                                "0":
                                  type: object
                                  properties:
                                    face_token:
                                      type: string
                                      description: 人脸图片的唯一标识
                                    location:
                                      type: object
                                      properties:
                                        left:
                                          type: number
                                          description: 人脸区域离左边界的距离
                                        top:
                                          type: number
                                          description: 人脸区域离上边界的距离
                                        width:
                                          type: number
                                          description: 人脸区域的宽度
                                        height:
                                          type: number
                                          description: 人脸区域的高度
                                        rotation:
                                          type: number
                                          description: 人脸框相对于竖直方向的顺时针旋转角，[-180,180]
                                      description: 人脸在图片中的位置
                                    face_probability:
                                      type: number
                                      description: 脸置信度，范围【0~1】，代表这是一张人脸的概率，0最小、1最大。
                                    angle:
                                      type: object
                                      properties:
                                        yaw:
                                          type: number
                                          description: 三维旋转之左右旋转角[-90(左), 90(右)]
                                        pitch:
                                          type: number
                                          description: 三维旋转之俯仰角度[-90(上), 90(下)]
                                        roll:
                                          type: number
                                          description: 平面内旋转角[-180(逆时针), 180(顺时针)]
                                      description: 人脸旋转角度参数
                                    age:
                                      type: number
                                      description: 年龄 ，当face_field包含age时返回
                                    beauty:
                                      type: number
                                      description: 美丑打分，范围0-100，越大表示越美。当face_fields包含beauty时返回
                            description: 每张图片的详细信息描述，如果只上传一张图片，则只返回一个结果。
                        description: 业务返回体
      operationId: 2563_8_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                image:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: base64编码后的图片数据，需urlencode，编码后的图片大小不超过2m
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值，base64编码后的图片数据，需urlencode，编码后的图片大小不超过2M；
                    URL:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)；
                    FACE_TOKEN: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个。
                option:
                  type: string
                  description: 场景信息，程序会视不同的场景选用相对应的模型。当前支持的场景有COMMON(通用场景)，GATE(闸机场景)，默认使用COMMON
                face_fields:
                  type: string
                  description: 包括age,beauty,expression,face_shape,gender,glasses,landmark,race,quality,face_type信息，逗号分隔，默认只返回face_token、活体数、人脸框、概率和旋转角度如果两个参数都需要选择，请使用半角逗号分隔。
              required:
                - ds_id
                - image
                - image_type
  /2563-7:
    x-pointCode: 7
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸库-用户信息查询
      description: 用于查询人脸库中某用户的详细信息。
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          user_list:
                            type: array
                            items:
                              type: object
                              properties:
                                "0":
                                  type: object
                                  properties:
                                    user_info:
                                      type: string
                                      description: 用户资料，被查询用户的资料
                                    group_id:
                                      type: string
                                      description: 用户组id，被查询用户的所在组
                            description: 查询到的用户列表
                        description: 业务返回体
      operationId: 2563_7_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                user_id:
                  type: string
                  description: 用户id（由数字、字母、下划线组成），长度限制128b
                group_id:
                  type: string
                  description: 选择指定group_id则只查找group列表下的uid内容，如果不指定则查找所有group下对应uid的信息
              required:
                - ds_id
                - user_id
                - group_id
  /2563-6:
    x-pointCode: 6
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸库-人脸删除
      description: 删除用户的某一张人脸，如果该用户只有一张人脸图片，则同时删除用户。
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          log_id:
                            type: number
                          error_code:
                            type: number
                            description: 错误码，出错时才返回这个字段
                          error_msg:
                            type: string
                            description: 错误信息，出错时才返回这个字段
                        description: 业务返回体
      operationId: 2563_6_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                log_id:
                  type: string
                  description: 请求标识码，随机数，唯一
                user_id:
                  type: string
                  description: 用户id（由数字、字母、下划线组成），长度限制128b
                group_id:
                  type: string
                  description: 删除指定group_id中的uid信息
                face_token:
                  type: string
                  description: 需要删除的人脸图片token，（由数字、字母、下划线组成）长度限制64B
              required:
                - ds_id
                - log_id
                - user_id
                - group_id
                - face_token
  /2563-5:
    x-pointCode: 5
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸库-人脸更新
      description: |-
        用于对人脸库中指定用户，更新其下的人脸图像。
        针对一个user_id执行更新操作，新上传的人脸图像将覆盖此user_id原有所有图像。
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          face_token:
                            type: string
                            description: 人脸图片的唯一标识
                          location:
                            type: object
                            properties:
                              left:
                                type: number
                                description: 人脸区域离左边界的距离
                              top:
                                type: number
                                description: 人脸区域离上边界的距离
                              width:
                                type: number
                                description: 人脸区域的宽度
                              height:
                                type: number
                                description: 人脸区域的高度
                              rotation:
                                type: number
                                description: 人脸框相对于竖直方向的顺时针旋转角，[-180,180]
                            description: 人脸在图片中的位置
                          log_id:
                            type: string
                            description: 请求标识码，随机数，唯一
                        description: 业务返回体
      operationId: 2563_5_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                image:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: base64编码后的图片数据，需urlencode，每次只支持单张图片，编码后的图片大小不超过10m
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值，base64编码后的图片数据，编码后的图片大小不超过2M；
                    URL:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)；
                    FACE_TOKEN: 人脸图片的唯一标识
                group_id:
                  type: string
                  description: 更新指定groupid下uid对应的信息
                user_id:
                  type: string
                  description: 用户id（由数字、字母、下划线组成），长度限制128b
                user_info:
                  type: string
                  description: 用户信息，长度限制256位
                quality_control:
                  type: string
                  description: |-
                    图片质量控制
                    NONE: 不进行控制
                    LOW:较低的质量要求
                    NORMAL: 一般的质量要求
                    HIGH: 较高的质量要求
                    默认 NONE
                    若图片质量不满足要求，则返回结果中会提示质量检测失败
                liveness_control:
                  type: string
                  description: |-
                    活体检测控制
                    NONE: 不进行控制
                    LOW:较低的活体要求(高通过率 低攻击拒绝率)
                    NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率)
                    HIGH: 较高的活体要求(高攻击拒绝率 低通过率)
                    默认NONE
                    若活体检测结果不满足要求，则返回结果中会提示活体检测失败
                action_type:
                  type: string
                  description: |-
                    操作方式
                    UPDATE: 会使用新图替换库中该user_id下所有图片, 若user_id不存在则会报错
                    REPLACE : 当user_id不存在时, 则会注册这个user_id的用户
                    默认使用UPDATE
              required:
                - ds_id
                - image
                - image_type
                - group_id
                - user_id
  /2563-4:
    x-pointCode: 4
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸库-人脸注册
      description: 用于从人脸库中新增用户，可以设定多个用户所在组，及组内用户的人脸图片，
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          face_token:
                            type: string
                            description: 人脸图片的唯一标识
                          location:
                            type: object
                            properties:
                              left:
                                type: number
                                description: 人脸区域离左边界的距离
                              top:
                                type: number
                                description: 人脸区域离上边界的距离
                              width:
                                type: number
                                description: 人脸区域的宽度
                              height:
                                type: number
                                description: 人脸区域的高度
                              rotation:
                                type: number
                                description: 人脸框相对于竖直方向的顺时针旋转角，[-180,180]
                          log_id:
                            type: string
                            description: 请求标识码，随机数，唯一
                        description: 业务返回体
      operationId: 2563_4_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                image:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: |-
                    图片信息(总数据大小应小于10M)，图片上传方式根据image_type来判断。
                    注：组内每个uid下的人脸图片数目上限为20张
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值，base64编码后的图片数据，编码后的图片大小不超过2M；
                    URL:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)；
                    FACE_TOKEN：人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个。
                group_id:
                  type: string
                  description: 用户组id，标识一组用户（由数字、字母、下划线组成），长度限制48B。产品建议：根据您的业务需求，可以将需要注册的用户，按照业务划分，分配到不同的group下，例如按照会员手机尾号作为groupid，用于刷脸支付、会员计费消费等，这样可以尽可能控制每个group下的用户数与人脸数，提升检索的准确率
                user_id:
                  type: string
                  description: 用户id（由数字、字母、下划线组成），长度限制128B
                user_info:
                  type: string
                  description: 用户资料，长度限制256B 默认空
                action_type:
                  type: string
                  description: |-
                    操作方式
                    APPEND: 当user_id在库中已经存在时，对此user_id重复注册时，新注册的图片默认会追加到该user_id下
                    REPLACE : 当对此user_id重复注册时,则会用新图替换库中该user_id下所有图片
                    默认使用APPEND
                quality_control:
                  type: string
                  description: |-
                    图片质量控制
                    NONE: 不进行控制
                    LOW:较低的质量要求
                    NORMAL: 一般的质量要求
                    HIGH: 较高的质量要求
                    默认 NONE
                    若图片质量不满足要求，则返回结果中会提示质量检测失败
                liveness_control:
                  type: string
                  description: |-
                    活体检测控制
                    NONE: 不进行控制
                    LOW:较低的活体要求(高通过率 低攻击拒绝率)
                    NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率)
                    HIGH: 较高的活体要求(高攻击拒绝率 低通过率)
                    默认NONE
                    若活体检测结果不满足要求，则返回结果中会提示活体检测失败
                face_sort_type:
                  type: number
                  description: |-
                    人脸检测排序类型
                    0:代表检测出的人脸按照人脸面积从大到小排列
                    1:代表检测出的人脸按照距离图片中心从近到远排列
                    默认为0
              required:
                - ds_id
                - image
                - image_type
                - group_id
                - user_id
  /2563-3:
    x-pointCode: 3
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸库-人脸搜索
      description: 也称为1：N识别，在指定人脸集合中，找到最相似的人脸。原接口订购地址：https://cloud.baidu.com/product/face/private
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          face_token:
                            type: string
                            description: 人脸标志
                          user_list:
                            type: array
                            items:
                              type: object
                              properties:
                                "0":
                                  type: object
                                  properties:
                                    group_id:
                                      type: string
                                      description: 用户所属的group_id
                                    user_id:
                                      type: string
                                      description: 用户的user_id
                                    user_info:
                                      type: string
                                      description: 注册用户时携带的user_info
                                    score:
                                      type: number
                                      description: 用户的匹配得分，推荐阈值80分
                            description: 匹配的用户信息列表
                        description: 业务返回体
      operationId: 2563_3_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                image:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: 图片信息，图片上传方式根据image_type来判断，为base64时，编码后图片大小不超过2M
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值，base64编码后的图片数据，编码后的图片大小不超过2M；
                    URL:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)；
                    FACE_TOKEN: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个。
                group_id_list:
                  type: string
                  description: 从指定的group中进行查找 用逗号分隔，上限10个
                quality_control:
                  type: string
                  description: |-
                    图片质量控制
                    NONE: 不进行控制
                    LOW:较低的质量要求
                    NORMAL: 一般的质量要求
                    HIGH: 较高的质量要求
                    默认 NONE
                    若图片质量不满足要求，则返回结果中会提示质量检测失败
                user_id:
                  type: string
                  description: 当需要对特定用户进行比对时，指定user_id进行比对。即人脸认证功能。
                max_user_num:
                  type: number
                  description: 查找后返回的用户数量。返回相似度最高的几个用户，默认为1，最多返回50个。
                liveness_control:
                  type: string
                  description: |-
                    活体检测控制
                    NONE: 不进行控制
                    LOW:较低的活体要求(高通过率 低攻击拒绝率)
                    NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率)
                    HIGH: 较高的活体要求(高攻击拒绝率 低通过率)
                    默认NONE
                    若活体检测结果不满足要求，则返回结果中会提示活体检测失败
                face_sort_type:
                  type: number
                  description: |-
                    人脸检测排序类型
                    0:代表检测出的人脸按照人脸面积从大到小排列
                    1:代表检测出的人脸按照距离图片中心从近到远排列
                    默认为0
                match_threshold:
                  type: number
                  description: |-
                    匹配阈值（设置阈值后，score低于此阈值的用户信息将不会返回） 最大100 最小0 默认0
                    此阈值设置得越高，检索速度将会越快，推荐使用默认阈值80
              required:
                - ds_id
                - image
                - image_type
                - group_id_list
  /2563-2:
    x-pointCode: 2
    x-mode: mapping
    x-read-timeout: 50
    x-connect-timeout: 50
    post:
      summary: 人脸对比
      description: 两张人脸进行 1：1 比对，得到人脸相似度。原接口订购地址：https://cloud.baidu.com/product/face/private
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          timestamp:
                            type: number
                          result:
                            type: object
                            properties:
                              face_list:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    face_token:
                                      type: string
                                      description: 人脸的唯一标志
                                description: 人脸信息列表
                              score:
                                type: number
                                description: 人脸相似度得分，推荐阈值80分
                          cached:
                            type: number
                          error_code:
                            type: number
                          log_id:
                            type: number
                          error_msg:
                            type: string
                          ret_code:
                            type: number
                        description: 业务返回体
      operationId: 2563_2_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                image1:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: 图片信息(总数据大小应小于10M，图片尺寸在1920x1080以下)，图片上传方式根据image_type来判断
                image2:
                  type: string
                  minLength: 0
                  maxLength: 10000000
                  description: 图片信息(总数据大小应小于10M，图片尺寸在1920x1080以下)，图片上传方式根据image_type来判断
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值，base64编码后的图片数据，编码后的图片大小不超过2M；
                    URL:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)；
                    FACE_TOKEN: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个。
                face_type:
                  type: string
                  description: |-
                    人脸的类型
                    LIVE：表示生活照：通常为手机、相机拍摄的人像图片、或从网络获取的人像图片等，
                    IDCARD：表示身份证芯片照：二代身份证内置芯片中的人像照片，
                    WATERMARK：表示带水印证件照：一般为带水印的小图，如公安网小图
                    CERT：表示证件照片：如拍摄的身份证、工卡、护照、学生证等证件图片
                    INFRARED 表示红外照片：使用红外相机拍摄的照片
                    HYBRID：表示混合类型，如果传递此值时会先对图片进行检测判断所属类型(生活照 or 证件照)（仅针对请求参数 image_type 为 BASE64 或 URL 时有效）
                    默认LIVE
                quality_control:
                  type: string
                  description: |-
                    图片质量控制
                    NONE: 不进行控制
                    LOW:较低的质量要求
                    NORMAL: 一般的质量要求
                    HIGH: 较高的质量要求
                    默认 NONE
                    若图片质量不满足要求，则返回结果中会提示质量检测失败
                liveness_control:
                  type: string
                  description: |-
                    活体检测控制
                    NONE: 不进行控制
                    LOW:较低的活体要求(高通过率 低攻击拒绝率)
                    NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率)
                    HIGH: 较高的活体要求(高攻击拒绝率 低通过率)
                    默认 NONE
                    若活体检测结果不满足要求，则返回结果中会提示活体检测失败
                face_sort_type:
                  type: number
                  description: |-
                    人脸检测排序类型
                    0:代表检测出的人脸按照人脸面积从大到小排列
                    1:代表检测出的人脸按照距离图片中心从近到远排列
                    默认为0
                spoofing_control:
                  type: string
                  description: |-
                    合成图控制参数
                    NONE: 不进行控制
                    LOW:较低的合成图阈值数值，由于合成图判定逻辑为大于阈值视为合成图攻击，该项代表低通过率、高攻击拒绝率
                    NORMAL: 一般的合成图阈值数值，由于合成图判定逻辑为大于阈值视为合成图攻击，该项代表平衡的攻击拒绝率, 通过率
                    HIGH: 较高的合成图阈值数值，由于合成图判定逻辑为大于阈值视为合成图攻击，该项代表高通过率、低攻击拒绝率
                    默认为NONE
              required:
                - ds_id
                - image1
                - image2
                - image_type
  /2563-1:
    x-pointCode: 1
    x-mode: mapping
    x-read-timeout: 120
    x-connect-timeout: 60
    post:
      summary: 人脸检测
      description: 检测图片中的人脸并标记出位置信息，展示人脸的核心关键点信息，及72个关键点信息。原接口订购地址：https://cloud.baidu.com/product/face/private
      responses:
        "200":
          description: 成功响应
          content:
            application/json:
              schema:
                allOf:
                  - $ref: "#/components/schemas/ShowapiResEnvelope"
                  - type: object
                    properties:
                      showapi_res_body:
                        type: object
                        properties:
                          timestamp:
                            type: number
                          result:
                            type: object
                            properties:
                              face_list:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    face_probability:
                                      type: number
                                      description: 人脸置信度，范围【0~1】，代表这是一张人脸的概率，0最小、1最大。其中返回0或1时，数据类型为Integer
                                    location:
                                      type: object
                                      properties: {}
                                      description: 人脸在图片中的位置
                                    face_token:
                                      type: string
                                      description: 人脸图片的唯一标识 （人脸检测face_token有效期为60min）
                                    angle:
                                      type: object
                                      properties: {}
                                      description: 人脸旋转角度参数
                                description: 人脸信息列表，具体包含的参数参考下面的列表。
                              face_num:
                                type: number
                                description: 检测到的图片中的人脸数量
                          cached:
                            type: number
                          ret_code:
                            type: number
                          error_code:
                            type: number
                          log_id:
                            type: number
                          error_msg:
                            type: string
                        description: 业务返回体
      operationId: 2563_1_POST
      parameters: []
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                ds_id:
                  type: string
                  description: 数据源
                image:
                  type: string
                  minLength: 0
                  maxLength: 100000000
                  description: 图片信息(总数据大小应小于10M)，图片上传方式根据image_type来判断
                image_type:
                  type: string
                  description: |-
                    图片类型
                    BASE64:图片的base64值，base64编码后的图片数据，编码后的图片大小不超过2M；
                    URL:图片的 URL地址( 可能由于网络等原因导致下载图片时间过长)；
                    FACE_TOKEN: 人脸图片的唯一标识，调用人脸检测接口时，会为每个人脸图片赋予一个唯一的FACE_TOKEN，同一张图片多次检测得到的FACE_TOKEN是同一个。
                face_fields:
                  type: string
                  description: |-
                    包括age,expression,face_shape,gender,glasses,landmark,landmark150,
                    quality,eye_status,emotion,face_type,mask,spoofing信息
                    逗号分隔. 默认只返回face_token、人脸框、概率和旋转角度
                max_face_num:
                  type: number
                  description: 最多处理人脸的数目，默认值为1，根据人脸检测排序类型检测图片中排序第一的人脸（默认为人脸面积最大的人脸），最大值120
                face_type:
                  type: string
                  description: |-
                    人脸的类型
                    LIVE表示生活照：通常为手机、相机拍摄的人像图片、或从网络获取的人像图片等
                    IDCARD表示身份证芯片照：二代身份证内置芯片中的人像照片
                    WATERMARK表示带水印证件照：一般为带水印的小图，如公安网小图
                    CERT表示证件照片：如拍摄的身份证、工卡、护照、学生证等证件图片
                    默认LIVE
                liveness_control:
                  type: string
                  description: |-
                    活体控制 检测结果中不符合要求的人脸会被过滤
                    NONE: 不进行控制
                    LOW:较低的活体要求(高通过率 低攻击拒绝率)
                    NORMAL: 一般的活体要求(平衡的攻击拒绝率, 通过率)
                    HIGH: 较高的活体要求(高攻击拒绝率 低通过率)
                    默认NONE
                face_sort_type:
                  type: number
                  description: |-
                    人脸检测排序类型
                    0:代表检测出的人脸按照人脸面积从大到小排列
                    1:代表检测出的人脸按照距离图片中心从近到远排列
                    默认为0
                display_corp_image:
                  type: number
                  description: |-
                    是否显示检测人脸的裁剪图base64值
                    0：不显示（默认）
                    1：显示
                    当取值为1时，max_face_num字段的取值上限按5计算，即最多可返回5张人脸的裁剪图
              required:
                - ds_id
                - image
                - image_type
components:
  securitySchemes:
    AppKeyAuth:
      type: apiKey
      in: query
      name: appKey
      description: 从 ShowAPI 控制台获取的 appKey，管理地址：https://www.showapi.com/console#/myApp
  schemas:
    ShowapiResEnvelope:
      type: object
      description: ShowAPI 统一返回包裹（业务数据位于 showapi_res_body）
      properties:
        showapi_res_code:
          type: integer
          description: API 返回的状态码
        showapi_res_error:
          type: string
          description: API 返回的错误信息
        showapi_res_id:
          type: string
          description: API 请求的唯一标识
        showapi_fee_num:
          type: integer
          description: API 调用计费次数
security:
  - AppKeyAuth: []
externalDocs:
  url: https://www.showapi.com/apiGateway/view/2563?tab=book
x-apiCode: "2563"
x-is-own: false
x-is-op: true
