@alicloud/cloudauth20190307 3.9.1 → 3.9.3

package/src/models/CredentialVerifyV2request.ts

@@ -1,58 +1,207 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CredentialVerifyV2RequestMerchantDetail } from "./CredentialVerifyV2requestMerchantDetail";
 
 
+export class CredentialVerifyV2RequestMerchantDetail extends $dara.Model {
+  /**
+   * @remarks
+   * Keyword key.
+   * 
+   * @example
+   * MerchantName
+   */
+  key?: string;
+  /**
+   * @remarks
+   * Keyword value.
+   * 
+   * @example
+   * ***
+   */
+  value?: string;
+  static names(): { [key: string]: string } {
+    return {
+      key: 'Key',
+      value: 'Value',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      key: 'string',
+      value: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CredentialVerifyV2Request extends $dara.Model {
   /**
+   * @remarks
+   * Relevant certificate number.
+   * 
    * @example
    * 4601*****
    */
   certNum?: string;
   /**
+   * @remarks
+   * - 01: Personal ID cards
+   *   - 0101: ID card
+   *   - 0102: Bank card
+   *   - 0104: Teacher qualification certificate
+   *   - 0107: Student ID card
+   * - 02: Business scenario
+   *   - 0201: Storefront photo
+   *   - 0202: Counter photo
+   *   - 0203: Scene photo
+   * - 03: Corporate qualifications
+   *   - 0301: Business license
+   * 
    * @example
    * 0104
    */
   credName?: string;
   /**
+   * @remarks
+   * Credential type:
+   * 
+   * - 01: Personal ID cards
+   * - 02: Business scenario
+   * - 03: Corporate qualifications
+   * 
    * @example
    * 01
    */
   credType?: string;
   /**
+   * @remarks
+   * ID number.
+   * 
    * @example
    * 4****************1
    */
   identifyNum?: string;
+  /**
+   * @remarks
+   * Base64 encoded image, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
+   * @example
+   * base64
+   */
+  imageContext?: string;
+  /**
+   * @remarks
+   * Image input stream, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
+   * @example
+   * none
+   */
   imageFile?: string;
   /**
+   * @remarks
+   * Image URL, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
    * @example
    * http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg
    */
   imageUrl?: string;
   /**
+   * @remarks
+   * Whether to enable authoritative authentication
+   * 
+   * - ****0****: No
+   * - **1**: Yes
+   * 
    * @example
    * 0
    */
   isCheck?: string;
   /**
+   * @remarks
+   * Whether to use OCR
+   * 
    * @example
    * 0
    */
   isOcr?: string;
+  /**
+   * @remarks
+   * Merchant details:
+   * 
+   * MerchantName: Merchant name
+   * 
+   * BusinessType: Industry information
+   * 
+   * BusinessContent: Business content
+   * 
+   * This field is required when PromptModel is set to DEFAULT.
+   */
   merchantDetail?: CredentialVerifyV2RequestMerchantDetail[];
+  /**
+   * @remarks
+   * Merchant ID. This field is required when ****CredName**** is set to **02**.
+   * 
+   * @example
+   * none
+   */
   merchantId?: string;
   /**
+   * @remarks
+   * Invocation mode:
+   * 
+   * - ANTI_FAKE_CHECK: Image anti-forgery check
+   * 
+   * - ANTI_FAKE_VL: Image anti-forgery check and semantic understanding
+   * 
+   * - IMAGE_VL_COG: Image semantic understanding
+   * 
+   * Default value: ANTI_FAKE_CHECK
+   * 
+   * When CredType is set to 02, ProductCode can only be ANTI_FAKE_VL or IMAGE_VL_COG.
+   * 
    * @example
    * ANTI_FAKE_CHECK
    */
   productCode?: string;
+  /**
+   * @remarks
+   * Customer-defined prompt content for image semantic understanding.
+   * 
+   * This field is required when PromptModel is set to CUSTOM.
+   * 
+   * @example
+   * none
+   */
   prompt?: string;
   /**
+   * @remarks
+   * Prompt acquisition method for image semantic understanding:
+   * 
+   * - DEFAULT: System default
+   * 
+   * - CUSTOM: Customer-defined
+   * 
+   * Note: When ProductCode is set to ANTI_FAKE_VL or IMAGE_VL_COG, this parameter must be provided.
+   * 
    * @example
    * DEFAULT
    */
   promptModel?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * 张三
+   */
   userName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -60,6 +209,7 @@ export class CredentialVerifyV2Request extends $dara.Model {
       credName: 'CredName',
       credType: 'CredType',
       identifyNum: 'IdentifyNum',
+      imageContext: 'ImageContext',
       imageFile: 'ImageFile',
       imageUrl: 'ImageUrl',
       isCheck: 'IsCheck',
@@ -79,6 +229,7 @@ export class CredentialVerifyV2Request extends $dara.Model {
       credName: 'string',
       credType: 'string',
       identifyNum: 'string',
+      imageContext: 'string',
       imageFile: 'string',
       imageUrl: 'string',
       isCheck: 'string',

package/src/models/CredentialVerifyV2responseBody.ts

@@ -1,24 +1,223 @@
 // This file is auto-generated, don't edit it
 import * as $dara from '@darabonba/typescript';
-import { CredentialVerifyV2ResponseBodyResultObject } from "./CredentialVerifyV2responseBodyResultObject";
 
 
+export class CredentialVerifyV2ResponseBodyResultObjectVlResult extends $dara.Model {
+  /**
+   * @remarks
+   * Qwen interpretation success indicator
+   * 
+   * true: Success
+   * 
+   * false: Failure
+   * 
+   * @example
+   * true
+   */
+  success?: boolean;
+  /**
+   * @remarks
+   * Image understanding result:
+   * 
+   * - When PromptModel is DEFAULT, the output format refers to the example on the right.
+   * 
+   * - When PromptModel is CUSTOM, the output format follows the agreed format of the Prompt.
+   * 
+   * @example
+   * {
+   *  "CHK_DOOR_PHOTO":1, -- 是否门头照 1：是 0：否
+   *  "CHK_INTERIOR_PHOTO":0, -- 是否内景照 1：是 0：否
+   *  "CHK_COUNTER_PHOTO":0 -- 是否柜台照 1：是 0：否
+   * }
+   */
+  vlContent?: string;
+  static names(): { [key: string]: string } {
+    return {
+      success: 'Success',
+      vlContent: 'VlContent',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      success: 'boolean',
+      vlContent: 'string',
+    };
+  }
+
+  validate() {
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
+export class CredentialVerifyV2ResponseBodyResultObject extends $dara.Model {
+  /**
+   * @remarks
+   * Additional information in JSON format.
+   * 
+   * @example
+   * {
+   * 
+   * "sameBackgroundDetail": {
+   * 
+   * // 相似背景对于的原始图请求RequestId
+   * 
+   * "originalRequestId": "130A2C10-B9EE-4D84-88E3-5384FF03****";
+   * 
+   * // 相似背景对于的原始图请求商户ID
+   * 
+   * "originalMerchantId": "xxxxxxxx"
+   * 
+   * }
+   * 
+   * }
+   */
+  materialInfo?: string;
+  /**
+   * @remarks
+   * OCR recognition result.
+   * 
+   * @example
+   * {
+   *    "certNo":"20216*********",
+   *   "certType":"小学教师资格",
+   *    "gender":"男",
+   *    "subject":"美术",
+   *     "name":"李**",
+   *     "ext_info":"{}",
+   *     "birthDate":"1998-07-28",
+   *     "idNo":"620************",
+   *     "certOrg":""
+   * }
+   */
+  ocrInfo?: string;
+  /**
+   * @remarks
+   * Risk result
+   * 
+   * - 0: Low risk
+   * - 1: High risk
+   * - 2: Suspicious
+   * 
+   * @example
+   * 1
+   */
+  result?: string;
+  /**
+   * @remarks
+   * Risk score map.
+   */
+  riskScore?: { [key: string]: string };
+  /**
+   * @remarks
+   * Risk tags, separated by commas (,), including:
+   * 
+   * - PS: Image manipulation.
+   * - SCREEN_PHOTO: Screen recapture.
+   * - SCREENSHOT: Screenshot.
+   * - WATERMARK: Watermark.
+   * - SAME_BACKGROUND: Similar background.
+   * - ORIGINAL_PHOTO: Not the original image
+   * 
+   * @example
+   * PS,SCREEN_PHOTO
+   */
+  riskTag?: string;
+  /**
+   * @remarks
+   * Authority verification details.
+   * 
+   * @example
+   * **
+   */
+  verifyDetail?: string;
+  /**
+   * @remarks
+   * Authority verification result
+   * 
+   * @example
+   * *
+   */
+  verifyResult?: string;
+  /**
+   * @remarks
+   * Qwen interpretation.
+   */
+  vlResult?: CredentialVerifyV2ResponseBodyResultObjectVlResult;
+  static names(): { [key: string]: string } {
+    return {
+      materialInfo: 'MaterialInfo',
+      ocrInfo: 'OcrInfo',
+      result: 'Result',
+      riskScore: 'RiskScore',
+      riskTag: 'RiskTag',
+      verifyDetail: 'VerifyDetail',
+      verifyResult: 'VerifyResult',
+      vlResult: 'VlResult',
+    };
+  }
+
+  static types(): { [key: string]: any } {
+    return {
+      materialInfo: 'string',
+      ocrInfo: 'string',
+      result: 'string',
+      riskScore: { 'type': 'map', 'keyType': 'string', 'valueType': 'string' },
+      riskTag: 'string',
+      verifyDetail: 'string',
+      verifyResult: 'string',
+      vlResult: CredentialVerifyV2ResponseBodyResultObjectVlResult,
+    };
+  }
+
+  validate() {
+    if(this.riskScore) {
+      $dara.Model.validateMap(this.riskScore);
+    }
+    if(this.vlResult && typeof (this.vlResult as any).validate === 'function') {
+      (this.vlResult as any).validate();
+    }
+    super.validate();
+  }
+
+  constructor(map?: { [key: string]: any }) {
+    super(map);
+  }
+}
+
 export class CredentialVerifyV2ResponseBody extends $dara.Model {
   /**
+   * @remarks
+   * Return code: 200 for success, others for failure.
+   * 
    * @example
    * 200
    */
   code?: string;
   /**
+   * @remarks
+   * Return message.
+   * 
    * @example
    * success
    */
   message?: string;
   /**
+   * @remarks
+   * Request ID.
+   * 
    * @example
    * 04F0F334-1335-436C-A1D7-6C044FE73368
    */
   requestId?: string;
+  /**
+   * @remarks
+   * Returned result information.
+   */
   resultObject?: CredentialVerifyV2ResponseBodyResultObject;
   static names(): { [key: string]: string } {
     return {

package/src/models/CredentialVerifyV2shrinkRequest.ts

@@ -4,54 +4,164 @@ import * as $dara from '@darabonba/typescript';
 
 export class CredentialVerifyV2ShrinkRequest extends $dara.Model {
   /**
+   * @remarks
+   * Relevant certificate number.
+   * 
    * @example
    * 4601*****
    */
   certNum?: string;
   /**
+   * @remarks
+   * - 01: Personal ID cards
+   *   - 0101: ID card
+   *   - 0102: Bank card
+   *   - 0104: Teacher qualification certificate
+   *   - 0107: Student ID card
+   * - 02: Business scenario
+   *   - 0201: Storefront photo
+   *   - 0202: Counter photo
+   *   - 0203: Scene photo
+   * - 03: Corporate qualifications
+   *   - 0301: Business license
+   * 
    * @example
    * 0104
    */
   credName?: string;
   /**
+   * @remarks
+   * Credential type:
+   * 
+   * - 01: Personal ID cards
+   * - 02: Business scenario
+   * - 03: Corporate qualifications
+   * 
    * @example
    * 01
    */
   credType?: string;
   /**
+   * @remarks
+   * ID number.
+   * 
    * @example
    * 4****************1
    */
   identifyNum?: string;
+  /**
+   * @remarks
+   * Base64 encoded image, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
+   * @example
+   * base64
+   */
+  imageContext?: string;
+  /**
+   * @remarks
+   * Image input stream, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
+   * @example
+   * none
+   */
   imageFile?: string;
   /**
+   * @remarks
+   * Image URL, choose one from `imageUrl`, `imageFile`, or `imageContext`.
+   * 
    * @example
    * http://marry.momocdn.com/avatar/3B/B6/3BB6527E-7467-926E-1048-B43614F20CC420230803_L.jpg
    */
   imageUrl?: string;
   /**
+   * @remarks
+   * Whether to enable authoritative authentication
+   * 
+   * - ****0****: No
+   * - **1**: Yes
+   * 
    * @example
    * 0
    */
   isCheck?: string;
   /**
+   * @remarks
+   * Whether to use OCR
+   * 
    * @example
    * 0
    */
   isOcr?: string;
+  /**
+   * @remarks
+   * Merchant details:
+   * 
+   * MerchantName: Merchant name
+   * 
+   * BusinessType: Industry information
+   * 
+   * BusinessContent: Business content
+   * 
+   * This field is required when PromptModel is set to DEFAULT.
+   */
   merchantDetailShrink?: string;
+  /**
+   * @remarks
+   * Merchant ID. This field is required when ****CredName**** is set to **02**.
+   * 
+   * @example
+   * none
+   */
   merchantId?: string;
   /**
+   * @remarks
+   * Invocation mode:
+   * 
+   * - ANTI_FAKE_CHECK: Image anti-forgery check
+   * 
+   * - ANTI_FAKE_VL: Image anti-forgery check and semantic understanding
+   * 
+   * - IMAGE_VL_COG: Image semantic understanding
+   * 
+   * Default value: ANTI_FAKE_CHECK
+   * 
+   * When CredType is set to 02, ProductCode can only be ANTI_FAKE_VL or IMAGE_VL_COG.
+   * 
    * @example
    * ANTI_FAKE_CHECK
    */
   productCode?: string;
+  /**
+   * @remarks
+   * Customer-defined prompt content for image semantic understanding.
+   * 
+   * This field is required when PromptModel is set to CUSTOM.
+   * 
+   * @example
+   * none
+   */
   prompt?: string;
   /**
+   * @remarks
+   * Prompt acquisition method for image semantic understanding:
+   * 
+   * - DEFAULT: System default
+   * 
+   * - CUSTOM: Customer-defined
+   * 
+   * Note: When ProductCode is set to ANTI_FAKE_VL or IMAGE_VL_COG, this parameter must be provided.
+   * 
    * @example
    * DEFAULT
    */
   promptModel?: string;
+  /**
+   * @remarks
+   * Name.
+   * 
+   * @example
+   * 张三
+   */
   userName?: string;
   static names(): { [key: string]: string } {
     return {
@@ -59,6 +169,7 @@ export class CredentialVerifyV2ShrinkRequest extends $dara.Model {
       credName: 'CredName',
       credType: 'CredType',
       identifyNum: 'IdentifyNum',
+      imageContext: 'ImageContext',
       imageFile: 'ImageFile',
       imageUrl: 'ImageUrl',
       isCheck: 'IsCheck',
@@ -78,6 +189,7 @@ export class CredentialVerifyV2ShrinkRequest extends $dara.Model {
       credName: 'string',
       credType: 'string',
       identifyNum: 'string',
+      imageContext: 'string',
       imageFile: 'string',
       imageUrl: 'string',
       isCheck: 'string',

package/src/models/DeepfakeDetectRequest.ts

@@ -4,21 +4,35 @@ import * as $dara from '@darabonba/typescript';
 
 export class DeepfakeDetectRequest extends $dara.Model {
   /**
+   * @remarks
+   * Enter the Base64 encoded string of the face image.
+   * > Either FaceUrl or FaceBase64 must be provided.
+   * 
    * @example
    * /9j/4AAQSkZJRgABAQAASxxxxxxx
    */
   faceBase64?: string;
   /**
+   * @remarks
+   * Input **IMAGE** to indicate an image type.
+   * 
    * @example
    * IMAGE
    */
   faceInputType?: string;
   /**
+   * @remarks
+   * Enter the URL of the face image.
+   * > Either FaceUrl or FaceBase64 must be provided.
+   * 
    * @example
    * https://cn-shanghai-aliyun-cloudauth-xxxxxx.oss-cn-shanghai.aliyuncs.com/verify/xxxxx/xxxxx.jpeg
    */
   faceUrl?: string;
   /**
+   * @remarks
+   * A unique identifier for the merchant\\"s request, consisting of a 32-character alphanumeric combination. The first few characters can be a custom abbreviation defined by the merchant, the middle part may include a timestamp, and the latter part can use a random or incrementing sequence.
+   * 
    * @example
    * e0c34a77f5ac40a5aa5e6ed20c******
    */