@alicloud/cloudauth20190307 3.9.5 → 3.10.0

package/src/models/DetectFaceAttributesResponseBody.ts

@@ -4,16 +4,25 @@ import * as $dara from '@darabonba/typescript';
 
 export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceAttributesHeadpose extends $dara.Model {
   /**
+   * @remarks
+   * Pitch angle, in degrees.
+   * 
    * @example
    * -1.5683923959732056
    */
   pitchAngle?: number;
   /**
+   * @remarks
+   * Roll angle, in degrees.
+   * 
    * @example
    * 7.163370132446289
    */
   rollAngle?: number;
   /**
+   * @remarks
+   * Yaw angle, in degrees.
+   * 
    * @example
    * -6.925303936004639
    */
@@ -45,11 +54,17 @@ export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectIn
 
 export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceAttributesSmiling extends $dara.Model {
   /**
+   * @remarks
+   * Smile threshold.
+   * 
    * @example
    * 95
    */
   threshold?: number;
   /**
+   * @remarks
+   * Smile score.
+   * 
    * @example
    * 97
    */
@@ -79,36 +94,75 @@ export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectIn
 
 export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceAttributes extends $dara.Model {
   /**
+   * @remarks
+   * Face blur level, with higher values indicating more blurriness. Typically, a value ≥2.0 is considered quite blurry. It is recommended to adjust based on actual business data testing.
+   * 
    * @example
    * 0.1419367790222168
    */
   blur?: number;
   /**
+   * @remarks
+   * A score ranging from 0 to 100. The higher the score, the better the quality. It is recommended to consider a score of 50 or above as acceptable quality.
+   * 
    * @example
    * 60
    */
   facequal?: number;
   /**
+   * @remarks
+   * Whether it is a human face. Values:
+   * 
+   * - **None**: Not a human face
+   * - **Face**: Human face
+   * - **Profile**: Profile (head turned left or right by more than 30°)
+   * 
+   * > If no face is detected, the `faceInfos` in the response will be empty; here, `None` means that a face was detected but is considered to be a cartoon, pet, etc.
+   * 
    * @example
    * Face
    */
   facetype?: string;
   /**
+   * @remarks
+   * Whether wearing glasses. Values:
+   * 
+   * - **None**: Not wearing glasses
+   * - **Wear**: Wearing regular glasses
+   * - **Sunglass**: Wearing sunglasses
+   * 
    * @example
    * None
    */
   glasses?: string;
+  /**
+   * @remarks
+   * Face pose.
+   */
   headpose?: DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceAttributesHeadpose;
   /**
+   * @remarks
+   * A score ranging from 0 to 100. The higher the score, the more complete the face. It is recommended to consider a score of 70 or above as acceptable completeness.
+   * 
    * @example
    * 70
    */
   integrity?: number;
   /**
+   * @remarks
+   * Whether wearing a mask. Values:
+   * 
+   * - Wear: Wearing a mask.
+   * - None: Not wearing a mask.
+   * 
    * @example
    * Wear
    */
   respirator?: string;
+  /**
+   * @remarks
+   * Whether smiling.
+   */
   smiling?: DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceAttributesSmiling;
   static names(): { [key: string]: string } {
     return {
@@ -153,21 +207,33 @@ export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectIn
 
 export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceRect extends $dara.Model {
   /**
+   * @remarks
+   * Height of the face rectangle.
+   * 
    * @example
    * 473
    */
   height?: number;
   /**
+   * @remarks
+   * Distance from the top-left corner of the face rectangle to the left edge of the original image, in pixels.
+   * 
    * @example
    * 354
    */
   left?: number;
   /**
+   * @remarks
+   * Distance from the top-left corner of the face rectangle to the top edge of the original image, in pixels.
+   * 
    * @example
    * 453
    */
   top?: number;
   /**
+   * @remarks
+   * Width of the face rectangle.
+   * 
    * @example
    * 473
    */
@@ -200,7 +266,15 @@ export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectIn
 }
 
 export class DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfo extends $dara.Model {
+  /**
+   * @remarks
+   * Face attributes.
+   */
   faceAttributes?: DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceAttributes;
+  /**
+   * @remarks
+   * Position of the face in the original image.
+   */
   faceRect?: DetectFaceAttributesResponseBodyDataFaceInfosFaceAttributesDetectInfoFaceRect;
   static names(): { [key: string]: string } {
     return {
@@ -258,13 +332,23 @@ export class DetectFaceAttributesResponseBodyDataFaceInfos extends $dara.Model {
 }
 
 export class DetectFaceAttributesResponseBodyData extends $dara.Model {
+  /**
+   * @remarks
+   * Face detection results.
+   */
   faceInfos?: DetectFaceAttributesResponseBodyDataFaceInfos;
   /**
+   * @remarks
+   * Original image height, in pixels.
+   * 
    * @example
    * 1920
    */
   imgHeight?: number;
   /**
+   * @remarks
+   * Original image width, in pixels.
+   * 
    * @example
    * 1080
    */
@@ -299,22 +383,38 @@ export class DetectFaceAttributesResponseBodyData extends $dara.Model {
 
 export class DetectFaceAttributesResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * HTTP status code.
+   * 
    * @example
    * 200
    */
   code?: string;
+  /**
+   * @remarks
+   * Returned data.
+   */
   data?: DetectFaceAttributesResponseBodyData;
   /**
+   * @remarks
+   * Error code.
+   * 
    * @example
    * Error.InternalError
    */
   message?: string;
   /**
+   * @remarks
+   * ID of this request.
+   * 
    * @example
    * 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
    */
   requestId?: string;
   /**
+   * @remarks
+   * Whether the response was successful.
+   * 
    * @example
    * true
    */

package/src/models/Id3metaVerifyAdvanceRequest.ts

@@ -0,0 +1,110 @@
+// This file is auto-generated, don't edit it
+import { Readable } from 'stream';
+import * as $dara from '@darabonba/typescript';
+
+
+export class Id3MetaVerifyAdvanceRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Whether to allow cropping of the face image, default is not allowed.
+   * - T: Allow cropping.
+   * - F: Do not allow cropping.
+   * 
+   * **Note**
+   * 
+   * If the image you request is not collected from a standard liveness detection SDK, it is recommended to allow cropping of the face image. After enabling this feature, the system will first crop and correct the requested image, then initiate the service request.
+   * 
+   * @example
+   * T
+   */
+  crop?: string;
+  /**
+   * @remarks
+   * Portrait side of the ID card image input stream.
+   * Choose one between `CertUrl` and `CertFile`.
+   * 
+   * @example
+   * 无
+   */
+  faceFileObject?: Readable;
+  /**
+   * @remarks
+   * Portrait side of the ID card image.
+   * Accessible HTTP or HTTPS link on the public network.
+   * Choose one between `CertUrl` and `CertFile`.
+   * 
+   * @example
+   * https://www.aliyun.com/cert.jpeg
+   */
+  faceUrl?: string;
+  /**
+   * @remarks
+   * ID number:
+   * - When `paramType` is `normal`: enter the plaintext ID number.
+   * - When `paramType` is `md5`:
+   * The first 6 digits (plaintext) + date of birth (ciphertext) + last 4 digits (plaintext).
+   * 
+   * @example
+   * ● 明文：429001********8211
+   * ● 密文：
+   * 42900132fa7bcd874161bea8ec8fd98f39****8211
+   */
+  identifyNum?: string;
+  /**
+   * @remarks
+   * Encryption method:
+   * - normal: plaintext without encryption
+   * - md5: MD5 encryption
+   * 
+   * **Important**
+   * 
+   * - All encrypted parameters should be in the form of a 32-character lowercase MD5 string.
+   * - The ciphertext generated by different MD5 tools may vary. If the interface works before encryption but not after, try changing the MD5 tool.
+   * 
+   * @example
+   * normal
+   */
+  paramType?: string;
+  /**
+   * @remarks
+   * Name:
+   * - When `paramType` is `normal`: enter the plaintext name.
+   * - When `paramType` is `md5`: the first character of the name (ciphertext) + the rest of the name (plaintext).
+   * 
+   * @example
+   * ● 明文：张三
+   * ● 密文：
+   * 6499fc7409049355527ef6a2ba5706b8三​
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crop: 'Crop',
+      faceFileObject: 'FaceFile',
+      faceUrl: 'FaceUrl',
+      identifyNum: 'IdentifyNum',
+      paramType: 'ParamType',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crop: 'string',
+      faceFileObject: 'Readable',
+      faceUrl: 'string',
+      identifyNum: 'string',
+      paramType: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/Id3metaVerifyRequest.ts

@@ -0,0 +1,109 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class Id3MetaVerifyRequest extends $dara.Model {
+  /**
+   * @remarks
+   * Whether to allow cropping of the face image, default is not allowed.
+   * - T: Allow cropping.
+   * - F: Do not allow cropping.
+   * 
+   * **Note**
+   * 
+   * If the image you request is not collected from a standard liveness detection SDK, it is recommended to allow cropping of the face image. After enabling this feature, the system will first crop and correct the requested image, then initiate the service request.
+   * 
+   * @example
+   * T
+   */
+  crop?: string;
+  /**
+   * @remarks
+   * Portrait side of the ID card image input stream.
+   * Choose one between `CertUrl` and `CertFile`.
+   * 
+   * @example
+   * 无
+   */
+  faceFile?: string;
+  /**
+   * @remarks
+   * Portrait side of the ID card image.
+   * Accessible HTTP or HTTPS link on the public network.
+   * Choose one between `CertUrl` and `CertFile`.
+   * 
+   * @example
+   * https://www.aliyun.com/cert.jpeg
+   */
+  faceUrl?: string;
+  /**
+   * @remarks
+   * ID number:
+   * - When `paramType` is `normal`: enter the plaintext ID number.
+   * - When `paramType` is `md5`:
+   * The first 6 digits (plaintext) + date of birth (ciphertext) + last 4 digits (plaintext).
+   * 
+   * @example
+   * ● 明文：429001********8211
+   * ● 密文：
+   * 42900132fa7bcd874161bea8ec8fd98f39****8211
+   */
+  identifyNum?: string;
+  /**
+   * @remarks
+   * Encryption method:
+   * - normal: plaintext without encryption
+   * - md5: MD5 encryption
+   * 
+   * **Important**
+   * 
+   * - All encrypted parameters should be in the form of a 32-character lowercase MD5 string.
+   * - The ciphertext generated by different MD5 tools may vary. If the interface works before encryption but not after, try changing the MD5 tool.
+   * 
+   * @example
+   * normal
+   */
+  paramType?: string;
+  /**
+   * @remarks
+   * Name:
+   * - When `paramType` is `normal`: enter the plaintext name.
+   * - When `paramType` is `md5`: the first character of the name (ciphertext) + the rest of the name (plaintext).
+   * 
+   * @example
+   * ● 明文：张三
+   * ● 密文：
+   * 6499fc7409049355527ef6a2ba5706b8三​
+   */
+  userName?: string;
+  static names(): { [key: string]: string } {
+    return {
+      crop: 'Crop',
+      faceFile: 'FaceFile',
+      faceUrl: 'FaceUrl',
+      identifyNum: 'IdentifyNum',
+      paramType: 'ParamType',
+      userName: 'UserName',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      crop: 'string',
+      faceFile: 'string',
+      faceUrl: 'string',
+      identifyNum: 'string',
+      paramType: 'string',
+      userName: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/Id3metaVerifyResponse.ts

@@ -0,0 +1,40 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+import { Id3MetaVerifyResponseBody } from "./Id3metaVerifyResponseBody";
+
+
+export class Id3MetaVerifyResponse extends $dara.Model {
+  headers?: { [key: string]: string };
+  statusCode?: number;
+  body?: Id3MetaVerifyResponseBody;
+  static names(): { [key: string]: string } {
+    return {
+      headers: 'headers',
+      statusCode: 'statusCode',
+      body: 'body',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      headers: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      statusCode: 'number',
+      body: Id3MetaVerifyResponseBody,
+    };
+  }
+
+  validate() {
+    if(this.headers) {
+      $dara.Model.validateMap(this.headers);
+    }
+    if(this.body && typeof (this.body as any).validate === 'function') {
+      (this.body as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+

package/src/models/Id3metaVerifyResponseBody.ts

@@ -0,0 +1,117 @@
+// This file is auto-generated, don't edit it
+import * as $dara from '@darabonba/typescript';
+
+
+export class Id3MetaVerifyResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Identity verification result:
+   * 
+   * - 1: Consistent
+   * - 2: Inconsistent
+   * - 3: No record found
+   * 
+   * @example
+   * 1
+   */
+  bizCode?: string;
+  /**
+   * @remarks
+   * Image comparison score.
+   * 
+   * @example
+   * {
+   *  "verifyScore": 50.28594166529785
+   * }
+   */
+  faceDetail?: string;
+  static names(): { [key: string]: string } {
+    return {
+      bizCode: 'BizCode',
+      faceDetail: 'FaceDetail',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      bizCode: 'string',
+      faceDetail: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class Id3MetaVerifyResponseBody extends $dara.Model {
+  /**
+   * @remarks
+   * Return code: 200 indicates success, others indicate failure.
+   * **Important**
+   * - This parameter indicates whether the interface was called correctly. For detailed return code explanations, please refer to the error codes.
+   * - Check the business verification result through the fields in `ResultObject`.
+   * 
+   * @example
+   * 200
+   */
+  code?: string;
+  /**
+   * @remarks
+   * Interface call return message.
+   * 
+   * **Important**
+   * 
+   * This parameter only indicates whether there was an exception with the interface.
+   * 
+   * @example
+   * success
+   */
+  message?: string;
+  /**
+   * @remarks
+   * Request ID.
+   * 
+   * @example
+   * 130A2C10-B9EE-4D84-88E3-5384FF03****
+   */
+  requestId?: string;
+  /**
+   * @remarks
+   * Result object.
+   */
+  resultObject?: Id3MetaVerifyResponseBodyResultObject;
+  static names(): { [key: string]: string } {
+    return {
+      code: 'Code',
+      message: 'Message',
+      requestId: 'RequestId',
+      resultObject: 'ResultObject',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      code: 'string',
+      message: 'string',
+      requestId: 'string',
+      resultObject: Id3MetaVerifyResponseBodyResultObject,
+    };
+  }
+
+  validate() {
+    if(this.resultObject && typeof (this.resultObject as any).validate === 'function') {
+      (this.resultObject as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+