tencentcloud-sdk-nodejs 4.0.972 → 4.0.974

package/tencentcloud/services/iai/v20200303/iai_models.d.ts

@@ -140,7 +140,7 @@ export interface Hat {
  */
 export interface CreatePersonRequest {
     /**
-     * 待加入的人员库ID，取值为创建人员库接口中的GroupId
+     * 待加入的人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
     /**
@@ -148,11 +148,14 @@ export interface CreatePersonRequest {
      */
     PersonName: string;
     /**
-     * 人员ID，单个腾讯云账号下不可修改，不可重复。支持英文、数字、-%@#&_，长度限制64B。
+     * 人员ID。
+  - 单个腾讯云账号下不可修改，不可重复。
+  - 支持英文、数字、-%@#&_，长度限制64B。
      */
     PersonId: string;
     /**
-     * 0代表未填写，1代表男性，2代表女性。
+     * 性别。
+  - 取值范围：0代表未填写，1代表男性，2代表女性。
      */
     Gender?: number;
     /**
@@ -160,46 +163,54 @@ export interface CreatePersonRequest {
      */
     PersonExDescriptionInfos?: Array<PersonExDescriptionInfo>;
     /**
-     * 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Image?: string;
     /**
-     * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Url?: string;
     /**
      * 此参数用于控制判断 Image 或 Url 中图片包含的人脸，是否在人员库中已有疑似的同一人。
-  如果判断为已有相同人在人员库中，则不会创建新的人员，返回疑似同一人的人员信息。
-  如果判断没有，则完成创建人员。
+  - 如果判断为已有相同人在人员库中，则不会创建新的人员，返回疑似同一人的人员信息。
+  - 如果判断没有，则完成创建人员。
+  - 取值范围：
   0: 不进行判断，无论是否有疑似同一人在库中均完成入库；
   1:较低的同一人判断要求（百一误识别率）；
   2: 一般的同一人判断要求（千一误识别率）；
   3: 较高的同一人判断要求（万一误识别率）；
   4: 很高的同一人判断要求（十万一误识别率）。
-  默认 0。
-  注： 要求越高，则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值，您可以根据实际情况调整。
+  - 默认 0。
+  - 注： 要求越高，则疑似同一人的概率越小。不同要求对应的误识别率仅为参考值，您可以根据实际情况调整。
      */
     UniquePersonControl?: number;
     /**
      * 图片质量控制。
+  - 取值范围：
   0: 不进行控制；
   1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
   2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
   3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
   4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -208,23 +219,28 @@ export interface CreatePersonRequest {
  */
 export interface CreateFaceResponse {
     /**
-     * 加入成功的人脸数量
+     * 加入成功的人脸数量。
      */
     SucFaceNum?: number;
     /**
-     * 加入成功的人脸ID列表
+     * 加入成功的人脸ID列表。
      */
     SucFaceIds?: Array<string>;
     /**
-     * 每张人脸图片添加结果，-1101 代表未检测到人脸，-1102 代表图片解码失败，-1109 代表图片尺寸过大或者过小，
-  -1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
-  其他非 0 值代表算法服务异常。
-  RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
+     * 每张人脸图片添加结果。
+  - 其他非 0 值代表算法服务异常，取值范围：
+  -1101 代表未检测到人脸。
+  -1102 代表图片解码失败。
+  -1109 代表图片尺寸过大或者过小。
+  -1601代表不符合图片质量控制要求。
+  -1604 代表人脸相似度没有超过FaceMatchThreshold。
+  - RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
      */
     RetCode?: Array<number | bigint>;
     /**
-     * 加入成功的人脸索引。索引顺序和入参中 Images 或 Urls 的顺序一致。
-  例如， Urls 中 有 3 个 url，第二个 url 失败，则 SucIndexes 值为 [0,2] 。
+     * 加入成功的人脸索引。
+  - 索引顺序和入参中 Images 或 Urls 的顺序一致。
+  - 例如， Urls 中 有 3 个 url，第二个 url 失败，则 SucIndexes 值为 [0,2] 。
      */
     SucIndexes?: Array<number | bigint>;
     /**
@@ -265,46 +281,54 @@ export interface FaceHairAttributesInfo {
  */
 export interface CreateFaceRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  人员人脸总数量不可超过5张。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - 人员人脸总数量不可超过5张。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Images?: Array<string>;
     /**
-     * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
-  人员人脸总数量不可超过5张。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+     * 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+  - 人员人脸总数量不可超过5张。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
      */
     Urls?: Array<string>;
     /**
      * 只有和该人员已有的人脸相似度超过FaceMatchThreshold值的人脸，才能增加人脸成功。
-  默认值60分。取值范围[0,100] 。
+  - 默认值60分。
+  - 取值范围：[0,100] 。
      */
     FaceMatchThreshold?: number;
     /**
      * 图片质量控制。
+  - 取值范围：
   0: 不进行控制；
   1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
   2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
   3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
   4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -322,12 +346,10 @@ export interface CreateGroupRequest {
     GroupId: string;
     /**
      * 人员库自定义描述字段，用于描述人员库中人员属性，该人员库下所有人员将拥有此描述字段。
-  最多可以创建5个。
-  每个自定义描述字段支持[1,30]个字符。
-  在同一人员库中自定义描述字段不可重复。
-  例： 设置某人员库“自定义描述字段”为["学号","工号","手机号"]，
-  则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段，
-  可在对应人员描述字段中填写内容，登记该人员的学号、工号、手机号等信息。
+  - 最多可以创建5个。
+  - 每个自定义描述字段支持[1,30]个字符。
+  - 在同一人员库中自定义描述字段不可重复。
+  - 例： 设置某人员库“自定义描述字段”为["学号","工号","手机号"]， 则该人员库下所有人员将拥有名为“学号”、“工号”、“手机号”的描述字段， 可在对应人员描述字段中填写内容，登记该人员的学号、工号、手机号等信息。
      */
     GroupExDescriptions?: Array<string>;
     /**
@@ -336,10 +358,10 @@ export interface CreateGroupRequest {
     Tag?: string;
     /**
      * 人脸识别服务所用的算法模型版本。
-  目前入参支持 “2.0”和“3.0“ 两个输入。
-  2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
-  2020年11月26日后开通服务的账号仅支持输入“3.0”。
-  不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
+  - 目前入参支持 “2.0”和“3.0“ 两个输入。
+  - 2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
+  - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
+  - 不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
      */
     FaceModelVersion?: string;
 }
@@ -348,15 +370,15 @@ export interface CreateGroupRequest {
  */
 export interface GetPersonGroupInfoRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 起始序号，默认值为0
+     * 起始序号，默认值为0。
      */
     Offset?: number;
     /**
-     * 返回数量，默认值为10，最大值为100
+     * 返回数量，默认值为10，最大值为100。
      */
     Limit?: number;
 }
@@ -613,7 +635,7 @@ export interface CreatePersonResponse {
     FaceRect?: FaceRect;
     /**
      * 疑似同一人的PersonId。
-  当 UniquePersonControl 参数不为0且人员库中有疑似的同一人，此参数才有意义。
+  - 当 UniquePersonControl 参数不为0且人员库中有疑似的同一人，此参数才有意义。
      */
     SimilarPersonId?: string;
     /**
@@ -651,11 +673,11 @@ export interface SearchFacesResponse {
  */
 export interface CopyPersonResponse {
     /**
-     * 成功加入的人员库数量
+     * 成功加入的人员库数量。
      */
     SucGroupNum?: number;
     /**
-     * 成功加入的人员库列表
+     * 成功加入的人员库列表。
      */
     SucGroupIds?: Array<string>;
     /**
@@ -681,11 +703,11 @@ export interface GroupCandidate {
  */
 export interface DeleteFaceResponse {
     /**
-     * 删除成功的人脸数量
+     * 删除成功的人脸数量.
      */
     SucDeletedNum?: number;
     /**
-     * 删除成功的人脸ID列表
+     * 删除成功的人脸ID列表。
      */
     SucFaceIds?: Array<string>;
     /**
@@ -698,7 +720,7 @@ export interface DeleteFaceResponse {
  */
 export interface DeletePersonRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
 }
@@ -730,11 +752,11 @@ export interface DetectLiveFaceResponse {
  */
 export interface DeleteFaceRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 待删除的人脸ID列表，数组元素取值为增加人脸接口返回的FaceId
+     * 待删除的人脸ID列表，数组元素取值为增加人脸接口返回的FaceId。
      */
     FaceIds: Array<string>;
 }
@@ -743,19 +765,19 @@ export interface DeleteFaceRequest {
  */
 export interface ModifyGroupRequest {
     /**
-     * 人员库ID，取值为创建人员库接口中的GroupId
+     * 人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
     /**
-     * 人员库名称
+     * 人员库名称。
      */
     GroupName?: string;
     /**
-     * 需要修改的人员库自定义描述字段，key-value
+     * 需要修改的人员库自定义描述字段，key-value。
      */
     GroupExDescriptionInfos?: Array<GroupExDescriptionInfo>;
     /**
-     * 人员库信息备注
+     * 人员库信息备注。
      */
     Tag?: string;
 }
@@ -764,7 +786,7 @@ export interface ModifyGroupRequest {
  */
 export interface DeleteGroupRequest {
     /**
-     * 人员库ID，取值为创建人员库接口中的GroupId
+     * 人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
 }
@@ -819,15 +841,16 @@ export interface DetectLiveFaceRequest {
  */
 export interface GetPersonBaseInfoResponse {
     /**
-     * 人员名称
+     * 人员名称。
      */
     PersonName?: string;
     /**
-     * 人员性别，0代表未填写，1代表男性，2代表女性
+     * 人员性别。
+  - 取值范围：0代表未填写，1代表男性，2代表女性。
      */
     Gender?: number;
     /**
-     * 包含的人脸 ID 列表
+     * 包含的人脸 ID 列表。
      */
     FaceIds?: Array<string>;
     /**
@@ -963,11 +986,11 @@ export interface SearchFacesReturnsByGroupResponse {
  */
 export interface CopyPersonRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 待加入的人员库列表，数组元素取值为创建人员库接口中的GroupId
+     * 待加入的人员库列表，数组元素取值为创建人员库接口中的GroupId。
      */
     GroupIds: Array<string>;
 }
@@ -976,48 +999,58 @@ export interface CopyPersonRequest {
  */
 export interface SearchPersonsReturnsByGroupRequest {
     /**
-     * 希望搜索的人员库列表，上限60个。数组元素取值为创建人员库接口中的GroupId
+     * 希望搜索的人员库列表，上限60个。数组元素取值为创建人员库接口中的GroupId。
      */
     GroupIds: Array<string>;
     /**
-     * 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Image?: string;
     /**
-     * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Url?: string;
     /**
-     * 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
-  MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
-  例：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
+     * 最多识别的人脸数目。
+  - 默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
+  - MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
+  - 例：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
      */
     MaxFaceNum?: number;
     /**
-     * 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
+     * 人脸长和宽的最小尺寸，单位为像素。
+  - 默认为34。
+  - 低于34将影响搜索精度。
+  - 建议设置为80。
      */
     MinFaceSize?: number;
     /**
-     * 被检测到的人脸，对应最多返回的最相似人员数目。默认值为5，最大值为10。
-  例，设MaxFaceNum为3，MaxPersonNumPerGroup为5，GroupIds长度为3，则最多可能返回3*5*3=45个人员。
+     * 被检测到的人脸，对应最多返回的最相似人员数目。
+  - 默认值为5，最大值为10。
+  - 例，设MaxFaceNum为3，MaxPersonNumPerGroup为5，GroupIds长度为3，则最多可能返回3*5*3=45个人员。
      */
     MaxPersonNumPerGroup?: number;
     /**
      * 图片质量控制。
-  0: 不进行控制；
-  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
-  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
-  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
-  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 取值范围：
+  0: 不进行控制。
+  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
+  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况。
+  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况。
+  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
@@ -1025,11 +1058,18 @@ export interface SearchPersonsReturnsByGroupRequest {
      */
     FaceMatchThreshold?: number;
     /**
-     * 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
+     * 是否返回人员具体信息。
+  - 取值范围：0 为关闭，1 为开启。
+  - 默认为 0。
+  - 其他非0非1值默认为0。
      */
     NeedPersonInfo?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -1156,11 +1196,11 @@ export interface Point {
  */
 export interface GetPersonListNumResponse {
     /**
-     * 人员数量
+     * 人员数量。
      */
     PersonNum?: number;
     /**
-     * 人脸数量
+     * 人脸数量。
      */
     FaceNum?: number;
     /**
@@ -1173,11 +1213,11 @@ export interface GetPersonListNumResponse {
  */
 export interface DeletePersonFromGroupRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 人员库ID，取值为创建人员库接口中的GroupId
+     * 人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
 }
@@ -1236,16 +1276,16 @@ export interface VerifyFaceRequest {
  */
 export interface GetPersonListResponse {
     /**
-     * 返回的人员信息
+     * 返回的人员信息。
      */
     PersonInfos?: Array<PersonInfo>;
     /**
-     * 该人员库的人员数量
+     * 该人员库的人员数量。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     PersonNum?: number;
     /**
-     * 该人员库的人脸数量
+     * 该人员库的人脸数量。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     FaceNum?: number;
@@ -1303,11 +1343,11 @@ export interface Result {
  */
 export interface GetPersonGroupInfoResponse {
     /**
-     * 包含此人员的人员库及描述字段内容列表
+     * 包含此人员的人员库及描述字段内容列表。
      */
     PersonGroupInfos?: Array<PersonGroupInfo>;
     /**
-     * 人员库总数量
+     * 人员库总数量。
   注意：此字段可能返回 null，表示取不到有效值。
      */
     GroupNum?: number;
@@ -1339,63 +1379,81 @@ export interface UpgradeGroupFaceModelVersionResponse {
  */
 export interface SearchFacesReturnsByGroupRequest {
     /**
-     * 希望搜索的人员库列表，上限60个。数组元素取值为创建人员库接口中的GroupId。
-  不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
+     * 希望搜索的人员库列表，上限60个。
+  - 数组元素取值为创建人员库接口中的GroupId。
+  - 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
      */
     GroupIds: Array<string>;
     /**
-     * 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Image?: string;
     /**
-     * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Url?: string;
     /**
-     * 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
-  MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
-  例：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
+     * 最多识别的人脸数目。
+  - 默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
+  - MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
+  - 例：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
      */
     MaxFaceNum?: number;
     /**
-     * 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
+     * 人脸长和宽的最小尺寸，单位为像素。
+  - 默认为34。
+  - 低于34将影响搜索精度。
+  - 建议设置为80。
      */
     MinFaceSize?: number;
     /**
-     * 被检测到的人脸，对应最多返回的最相似人员数目。默认值为5，最大值为10。
-  例，设MaxFaceNum为3，MaxPersonNumPerGroup为5，GroupIds长度为3，则最多可能返回3*5*3=45个人员。
+     * 被检测到的人脸，对应最多返回的最相似人员数目。
+  - 默认值为5，最大值为10。
+  - 例，设MaxFaceNum为3，MaxPersonNumPerGroup为5，GroupIds长度为3，则最多可能返回3*5*3=45个人员。
      */
     MaxPersonNumPerGroup?: number;
     /**
-     * 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
+     * 是否返回人员具体信息。
+  - 取值范围：0 为关闭，1 为开启。
+  - 默认为 0。
+  - 其他非0非1值默认为0
      */
     NeedPersonInfo?: number;
     /**
      * 图片质量控制。
-  0: 不进行控制；
-  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
-  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
-  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
-  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 取值范围：
+  0: 不进行控制。
+  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
+  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况。
+  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况。
+  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
      * 出参Score中，只有大于等于FaceMatchThreshold值的结果才会返回。
-  默认为0。
-  取值范围[0.0,100.0) 。
+  - 默认为0。
+  - 取值范围：[0.0,100.0) 。
      */
     FaceMatchThreshold?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -1438,15 +1496,15 @@ export interface ModifyPersonBaseInfoResponse {
  */
 export interface ModifyPersonGroupInfoRequest {
     /**
-     * 人员库ID，取值为创建人员库接口中的GroupId
+     * 人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 需要修改的人员描述字段内容，key-value
+     * 需要修改的人员描述字段内容，key-value。
      */
     PersonExDescriptionInfos: Array<PersonExDescriptionInfo>;
 }
@@ -1645,10 +1703,10 @@ export interface VerifyPersonRequest {
 export interface CompareMaskFaceResponse {
     /**
      * 两张图片中人脸的相似度分数。
-  不同算法版本返回的相似度分数不同。
-  若需要验证两张图片中人脸是否为同一人，3.0版本误识率千分之一对应分数为40分，误识率万分之一对应分数为50分，误识率十万分之一对应分数为60分。  一般超过50分则可认定为同一人。
-  2.0版本误识率千分之一对应分数为70分，误识率万分之一对应分数为80分，误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
-  若需要验证两张图片中的人脸是否为同一人，建议使用人脸验证接口。
+  - 不同算法版本返回的相似度分数不同。
+  - 若需要验证两张图片中人脸是否为同一人，3.0版本误识率千分之一对应分数为40分，误识率万分之一对应分数为50分，误识率十万分之一对应分数为60分。  一般超过50分则可认定为同一人。
+  - 2.0版本误识率千分之一对应分数为70分，误识率万分之一对应分数为80分，误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
+  - 若需要验证两张图片中的人脸是否为同一人，建议使用人脸验证接口。
      */
     Score?: number;
     /**
@@ -1665,15 +1723,15 @@ export interface CompareMaskFaceResponse {
  */
 export interface ModifyPersonBaseInfoRequest {
     /**
-     * 人员ID，取值为创建人员接口中的PersonId
+     * 人员ID，取值为创建人员接口中的PersonId。
      */
     PersonId: string;
     /**
-     * 需要修改的人员名称
+     * 需要修改的人员名称。
      */
     PersonName?: string;
     /**
-     * 需要修改的人员性别，1代表男性，2代表女性
+     * 需要修改的人员性别，1代表男性，2代表女性。
      */
     Gender?: number;
 }
@@ -1752,54 +1810,69 @@ export interface FaceDetailInfo {
  */
 export interface SearchFacesRequest {
     /**
-     * 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。
-  不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
+     * 希望搜索的人员库列表，上限100个。
+  - 数组元素取值为创建人员库接口中的GroupId。
+  - 不可同时搜索不同算法模型版本（FaceModelVersion）的人员库。
      */
     GroupIds: Array<string>;
     /**
-     * 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Image?: string;
     /**
-     * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Url?: string;
     /**
-     * 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
-  MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
-  例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
+     * 最多识别的人脸数目。
+  - 默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
+  - MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
+  - 例如：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
      */
     MaxFaceNum?: number;
     /**
-     * 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34的人脸图片无法被识别。建议设置为80。
+     * 人脸长和宽的最小尺寸，单位为像素。
+  - 默认为34。
+  - 低于34的人脸图片无法被识别。
+  - 建议设置为80。
      */
     MinFaceSize?: number;
     /**
-     * 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。
-  例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。
-  值越大，需要处理的时间越长。建议不要超过10。
+     * 单张被识别的人脸返回的最相似人员数量。
+  - 默认值为5，最大值为100。
+  - 例如，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。
+  - 值越大，需要处理的时间越长。
+  - 建议不要超过10。
      */
     MaxPersonNum?: number;
     /**
-     * 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
+     * 是否返回人员具体信息。
+  - 取值范围：0 为关闭，1 为开启。
+  - 默认为 0。
+  - 其他非0非1值默认为0。
      */
     NeedPersonInfo?: number;
     /**
      * 图片质量控制。
-  0: 不进行控制；
-  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
-  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
-  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
-  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 取值范围：
+  0: 不进行控制。
+  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
+  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况。
+  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况。
+  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
@@ -1807,7 +1880,11 @@ export interface SearchFacesRequest {
      */
     FaceMatchThreshold?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -1816,62 +1893,81 @@ export interface SearchFacesRequest {
  */
 export interface SearchPersonsRequest {
     /**
-     * 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId
+     * 希望搜索的人员库列表，上限100个。数组元素取值为创建人员库接口中的GroupId。
      */
     GroupIds: Array<string>;
     /**
-     * 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Image?: string;
     /**
-     * 图片的 Url 。对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。
+  - 所有格式的图片短边像素不小于64。
+  - Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     Url?: string;
     /**
-     * 最多识别的人脸数目。默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
-  MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
-  例：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
+     * 最多识别的人脸数目。
+  - 默认值为1（仅检测图片中面积最大的那张人脸），最大值为10。
+  - MaxFaceNum用于，当输入的待识别图片包含多张人脸时，设定要搜索的人脸的数量。
+  - 例：输入的Image或Url中的图片包含多张人脸，设MaxFaceNum=5，则会识别图片中面积最大的5张人脸。
      */
     MaxFaceNum?: number;
     /**
-     * 人脸长和宽的最小尺寸，单位为像素。默认为34。低于34将影响搜索精度。建议设置为80。
+     * 人脸长和宽的最小尺寸，单位为像素。
+  - 默认为34。
+  - 低于34将影响搜索精度。
+  - 建议设置为80。
      */
     MinFaceSize?: number;
     /**
-     * 单张被识别的人脸返回的最相似人员数量。默认值为5，最大值为100。
-  例，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。
-  值越大，需要处理的时间越长。建议不要超过10。
+     * 单张被识别的人脸返回的最相似人员数量。
+  - 默认值为5，最大值为100。
+  - 例，设MaxFaceNum为1，MaxPersonNum为8，则返回Top8相似的人员信息。
+  - 值越大，需要处理的时间越长。建议不要超过10。
      */
     MaxPersonNum?: number;
     /**
      * 图片质量控制。
-  0: 不进行控制；
-  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
-  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
-  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
-  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 取值范围：
+  0: 不进行控制。
+  1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况。
+  2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况。
+  3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况。
+  4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
-     * 出参Score中，只有大于等于FaceMatchThreshold值的结果才会返回。默认为0。取值范围[0.0,100.0) 。
+     * 出参Score中，只有大于等于FaceMatchThreshold值的结果才会返回。
+  - 默认为0。
+  - 取值范围：[0.0,100.0) 。
      */
     FaceMatchThreshold?: number;
     /**
-     * 是否返回人员具体信息。0 为关闭，1 为开启。默认为 0。其他非0非1值默认为0
+     * 是否返回人员具体信息。
+  - 取值范围：0 为关闭，1 为开启。
+  - 默认为 0。
+  - 其他非0非1值默认为0
      */
     NeedPersonInfo?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -1925,37 +2021,41 @@ export interface GroupExDescriptionInfo {
  */
 export interface CompareMaskFaceRequest {
     /**
-     * A 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * A 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     ImageA?: string;
     /**
-     * B 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * B 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     ImageB?: string;
     /**
-     * A 图片的 Url ，对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  A 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * A 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - A 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     UrlA?: string;
     /**
-     * B 图片的 Url ，对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  B 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * B 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - B 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     UrlB?: string;
     /**
@@ -1964,13 +2064,14 @@ export interface CompareMaskFaceRequest {
     FaceModelVersion?: string;
     /**
      * 图片质量控制。
+  - 取值范围：
   0: 不进行控制；
   1:较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
   2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
   3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
   4: 很高的质量要求，各个维度均为最好或最多在某一维度上存在轻微问题；
-  默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  - 默认 0。
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
 }
@@ -2073,7 +2174,7 @@ export interface DetectFaceRequest {
  */
 export interface GetPersonBaseInfoRequest {
     /**
-     * 人员ID，创建人员接口中的PersonId
+     * 人员ID，创建人员接口中的PersonId。
      */
     PersonId: string;
 }
@@ -2207,19 +2308,19 @@ export interface DetectFaceAttributesRequest {
  */
 export interface GetGroupInfoResponse {
     /**
-     * 人员库名称
+     * 人员库名称。
      */
     GroupName?: string;
     /**
-     * 人员库ID
+     * 人员库ID。
      */
     GroupId?: string;
     /**
-     * 人员库自定义描述字段
+     * 人员库自定义描述字段。
      */
     GroupExDescriptions?: Array<string>;
     /**
-     * 人员库信息备注
+     * 人员库信息备注。
      */
     Tag?: string;
     /**
@@ -2241,10 +2342,10 @@ export interface GetGroupInfoResponse {
 export interface CompareFaceResponse {
     /**
      * 两张图片中人脸的相似度分数。
-  不同算法版本返回的相似度分数不同。
-  若需要验证两张图片中人脸是否为同一人，3.0版本误识率千分之一对应分数为40分，误识率万分之一对应分数为50分，误识率十万分之一对应分数为60分。  一般超过50分则可认定为同一人。
-  2.0版本误识率千分之一对应分数为70分，误识率万分之一对应分数为80分，误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
-  若需要验证两张图片中的人脸是否为同一人，建议使用人脸验证接口。
+  - 不同算法版本返回的相似度分数不同。
+  - 若需要验证两张图片中人脸是否为同一人，3.0版本误识率千分之一对应分数为40分，误识率万分之一对应分数为50分，误识率十万分之一对应分数为60分。  一般超过50分则可认定为同一人。
+  - 2.0版本误识率千分之一对应分数为70分，误识率万分之一对应分数为80分，误识率十万分之一对应分数为90分。 一般超过80分则可认定为同一人。
+  - 若需要验证两张图片中的人脸是否为同一人，建议使用人脸验证接口。
      */
     Score?: number;
     /**
@@ -2330,64 +2431,70 @@ export interface FaceShape {
  */
 export interface CompareFaceRequest {
     /**
-     * A 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  若图片中包含多张人脸，只选取其中置信度最高的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * A 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - 若图片中包含多张人脸，只选取其中置信度最高的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     ImageA?: string;
     /**
-     * B 图片 base64 数据，base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  若图片中包含多张人脸，只选取其中置信度最高的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * B 图片 base64 数据。
+  - base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - 若图片中包含多张人脸，只选取其中置信度最高的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     ImageB?: string;
     /**
-     * A 图片的 Url ，对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  A 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * A 图片的 Url。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - A 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     UrlA?: string;
     /**
-     * B 图片的 Url ，对应图片 base64 编码后大小不可超过5M。
-  jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
-  B 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
-  图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
-  非腾讯云存储的Url速度和稳定性可能受一定影响。
-  若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
-  支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
+     * B 图片的 Url 。
+  - 对应图片 base64 编码后大小不可超过5M。
+  - jpg格式长边像素不可超过4000，其他格式图片长边像素不可超2000。所有格式的图片短边像素不小于64。
+  - B 图片的 Url、Image必须提供一个，如果都提供，只使用 Url。
+  - 图片存储于腾讯云的Url可保障更高下载速度和稳定性，建议图片存储于腾讯云。
+  - 非腾讯云存储的Url速度和稳定性可能受一定影响。
+  - 若图片中包含多张人脸，只选取其中人脸面积最大的人脸。
+  - 支持PNG、JPG、JPEG、BMP，不支持 GIF 图片。
      */
     UrlB?: string;
     /**
      * 人脸识别服务所用的算法模型版本。
-  
-  目前入参支持 “2.0”和“3.0“ 两个输入。
-  
-  2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
-  
-  2020年11月26日后开通服务的账号仅支持输入“3.0”。
-  
-  不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
+  - 目前入参支持 “2.0”和“3.0“ 两个输入。
+  - 2020年4月2日开始，默认为“3.0”，之前使用过本接口的账号若未填写本参数默认为“2.0”。
+  - 2020年11月26日后开通服务的账号仅支持输入“3.0”。
+  - 不同算法模型版本对应的人脸识别算法不同，新版本的整体效果会优于旧版本，建议使用“3.0”版本。
      */
     FaceModelVersion?: string;
     /**
      * 图片质量控制。
+  - 取值范围：
   0: 不进行控制；
   1: 较低的质量要求，图像存在非常模糊，眼睛鼻子嘴巴遮挡至少其中一种或多种的情况；
   2: 一般的质量要求，图像存在偏亮，偏暗，模糊或一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，至少其中三种的情况；
   3: 较高的质量要求，图像存在偏亮，偏暗，一般模糊，眉毛遮挡，脸颊遮挡，下巴遮挡，其中一到两种的情况；
   4: 很高的质量要求，各个维度均为最好或最多，在某一维度上存在轻微问题；
   默认 0。
-  若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
+  
+  - 若图片质量不满足要求，则返回结果中会提示图片质量检测不符要求。
      */
     QualityControl?: number;
     /**
-     * 是否开启图片旋转识别支持。0为不开启，1为开启。默认为0。本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
+     * 是否开启图片旋转识别支持。
+  - 取值范围：0为不开启，1为开启。
+  - 默认为0。
+  - 本参数的作用为，当图片中的人脸被旋转且图片没有exif信息时，如果不开启图片旋转识别支持则无法正确检测、识别图片中的人脸。
+  - 若您确认图片包含exif信息或者您确认输入图中人脸不会出现被旋转情况，请不要开启本参数。开启后，整体耗时将可能增加数百毫秒。
      */
     NeedRotateDetection?: number;
 }
@@ -2444,7 +2551,7 @@ export interface DetectFaceResponse {
  */
 export interface GetPersonListNumRequest {
     /**
-     * 人员库ID，取值为创建人员库接口中的GroupId
+     * 人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
 }
@@ -2453,7 +2560,7 @@ export interface GetPersonListNumRequest {
  */
 export interface GetGroupInfoRequest {
     /**
-     * 人员库 ID，取值为创建人员库接口中的GroupId
+     * 人员库 ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
 }
@@ -2503,15 +2610,15 @@ export interface ModifyGroupResponse {
  */
 export interface GetPersonListRequest {
     /**
-     * 人员库ID，取值为创建人员库接口中的GroupId
+     * 人员库ID，取值为创建人员库接口中的GroupId。
      */
     GroupId: string;
     /**
-     * 起始序号，默认值为0
+     * 起始序号，默认值为0。
      */
     Offset?: number;
     /**
-     * 返回数量，默认值为10，最大值为1000
+     * 返回数量，默认值为10，最大值为1000。
      */
     Limit?: number;
 }