NewDiverseYouthNightSchool/addons/cardocr/library/TencentCloud/Ocr/V20181119/Models/IDCardOCRRequest.php

<?php
/*
 * Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

namespace TencentCloud\Ocr\V20181119\Models;

use TencentCloud\Common\AbstractModel;

/**
 * @method string getImageBase64() 获取图片的 Base64 值。
 * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
 * 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
 * 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
 * @method void setImageBase64(string $ImageBase64) 设置图片的 Base64 值。
 * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
 * 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
 * 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
 * @method string getImageUrl() 获取图片的 Url 地址。
 * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
 * 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
 * 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。
 * 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
 * @method void setImageUrl(string $ImageUrl) 设置图片的 Url 地址。
 * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
 * 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
 * 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。
 * 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
 * @method string getCardSide() 获取FRONT 为身份证有照片的一面（人像面），
 * BACK 为身份证有国徽的一面（国徽面）。
 * @method void setCardSide(string $CardSide) 设置FRONT 为身份证有照片的一面（人像面），
 * BACK 为身份证有国徽的一面（国徽面）。
 * @method string getConfig() 获取可选字段，根据需要选择是否请求对应字段。
 * 目前包含的字段为：
 * CropIdCard，身份证照片裁剪，bool 类型，默认false，
 * CropPortrait，人像照片裁剪，bool 类型，默认false，
 * CopyWarn，复印件告警，bool 类型，默认false，
 * BorderCheckWarn，边框和框内遮挡告警，bool 类型，默认false，
 * ReshootWarn，翻拍告警，bool 类型，默认false，
 * DetectPsWarn，PS检测告警，bool类型，默认false，
 * TempIdWarn，临时身份证告警，bool类型，默认false，
 * InvalidDateWarn，身份证有效日期不合法告警，bool类型，默认false。
 *
 * SDK 设置方式参考：
 * Config = Json.stringify({"CropIdCard":true,"CropPortrait":true})
 * API 3.0 Explorer 设置方式参考：
 * Config = {"CropIdCard":true,"CropPortrait":true}
 * @method void setConfig(string $Config) 设置可选字段，根据需要选择是否请求对应字段。
 * 目前包含的字段为：
 * CropIdCard，身份证照片裁剪，bool 类型，默认false，
 * CropPortrait，人像照片裁剪，bool 类型，默认false，
 * CopyWarn，复印件告警，bool 类型，默认false，
 * BorderCheckWarn，边框和框内遮挡告警，bool 类型，默认false，
 * ReshootWarn，翻拍告警，bool 类型，默认false，
 * DetectPsWarn，PS检测告警，bool类型，默认false，
 * TempIdWarn，临时身份证告警，bool类型，默认false，
 * InvalidDateWarn，身份证有效日期不合法告警，bool类型，默认false。
 *
 * SDK 设置方式参考：
 * Config = Json.stringify({"CropIdCard":true,"CropPortrait":true})
 * API 3.0 Explorer 设置方式参考：
 * Config = {"CropIdCard":true,"CropPortrait":true}
 */

/**
 *IDCardOCR请求参数结构体
 */
class IDCardOCRRequest extends AbstractModel
{
    /**
     * @var string 图片的 Base64 值。
     * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
     * 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
     * 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
     */
    public $ImageBase64;

    /**
     * @var string 图片的 Url 地址。
     * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
     * 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
     * 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。
     * 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
     */
    public $ImageUrl;

    /**
     * @var string FRONT 为身份证有照片的一面（人像面），
     * BACK 为身份证有国徽的一面（国徽面）。
     */
    public $CardSide;

    /**
     * @var string 可选字段，根据需要选择是否请求对应字段。
     * 目前包含的字段为：
     * CropIdCard，身份证照片裁剪，bool 类型，默认false，
     * CropPortrait，人像照片裁剪，bool 类型，默认false，
     * CopyWarn，复印件告警，bool 类型，默认false，
     * BorderCheckWarn，边框和框内遮挡告警，bool 类型，默认false，
     * ReshootWarn，翻拍告警，bool 类型，默认false，
     * DetectPsWarn，PS检测告警，bool类型，默认false，
     * TempIdWarn，临时身份证告警，bool类型，默认false，
     * InvalidDateWarn，身份证有效日期不合法告警，bool类型，默认false。
     *
     * SDK 设置方式参考：
     * Config = Json.stringify({"CropIdCard":true,"CropPortrait":true})
     * API 3.0 Explorer 设置方式参考：
     * Config = {"CropIdCard":true,"CropPortrait":true}
     */
    public $Config;

    /**
     * @param string $ImageBase64 图片的 Base64 值。
     * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
     * 支持的图片大小：所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
     * 图片的 ImageUrl、ImageBase64 必须提供一个，如果都提供，只使用 ImageUrl。
     * @param string $ImageUrl 图片的 Url 地址。
     * 支持的图片格式：PNG、JPG、JPEG，暂不支持 GIF 格式。
     * 支持的图片大小：所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
     * 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性，建议图片存储于腾讯云。
     * 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
     * @param string $CardSide FRONT 为身份证有照片的一面（人像面），
     * BACK 为身份证有国徽的一面（国徽面）。
     * @param string $Config 可选字段，根据需要选择是否请求对应字段。
     * 目前包含的字段为：
     * CropIdCard，身份证照片裁剪，bool 类型，默认false，
     * CropPortrait，人像照片裁剪，bool 类型，默认false，
     * CopyWarn，复印件告警，bool 类型，默认false，
     * BorderCheckWarn，边框和框内遮挡告警，bool 类型，默认false，
     * ReshootWarn，翻拍告警，bool 类型，默认false，
     * DetectPsWarn，PS检测告警，bool类型，默认false，
     * TempIdWarn，临时身份证告警，bool类型，默认false，
     * InvalidDateWarn，身份证有效日期不合法告警，bool类型，默认false。
     *
     * SDK 设置方式参考：
     * Config = Json.stringify({"CropIdCard":true,"CropPortrait":true})
     * API 3.0 Explorer 设置方式参考：
     * Config = {"CropIdCard":true,"CropPortrait":true}
     */
    public function __construct()
    {
    }

    /**
     * 内部实现，用户禁止调用
     */
    public function deserialize($param)
    {
        if ($param === null) {
            return;
        }
        if (array_key_exists("ImageBase64", $param) and $param["ImageBase64"] !== null) {
            $this->ImageBase64 = $param["ImageBase64"];
        }

        if (array_key_exists("ImageUrl", $param) and $param["ImageUrl"] !== null) {
            $this->ImageUrl = $param["ImageUrl"];
        }

        if (array_key_exists("CardSide", $param) and $param["CardSide"] !== null) {
            $this->CardSide = $param["CardSide"];
        }

        if (array_key_exists("Config", $param) and $param["Config"] !== null) {
            $this->Config = $param["Config"];
        }
    }
}