LivenessCompareRequest.php 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. <?php
  2. /*
  3. * Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. */
  17. namespace TencentCloud\Faceid\V20180301\Models;
  18. use TencentCloud\Common\AbstractModel;
  19. /**
  20. * LivenessCompare请求参数结构体
  21. *
  22. * @method string getLivenessType() 获取活体检测类型,取值:LIP/ACTION/SILENT。
  23. LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
  24. * @method void setLivenessType(string $LivenessType) 设置活体检测类型,取值:LIP/ACTION/SILENT。
  25. LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
  26. * @method string getImageBase64() 获取用于人脸比对的照片的Base64值;
  27. Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
  28. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  29. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  30. * @method void setImageBase64(string $ImageBase64) 设置用于人脸比对的照片的Base64值;
  31. Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
  32. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  33. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  34. * @method string getImageUrl() 获取用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
  35. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  36. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  37. * @method void setImageUrl(string $ImageUrl) 设置用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
  38. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  39. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  40. * @method string getValidateData() 获取数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
  41. 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
  42. 静默模式传参:空。
  43. * @method void setValidateData(string $ValidateData) 设置数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
  44. 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
  45. 静默模式传参:空。
  46. * @method string getOptional() 获取额外配置,传入JSON字符串。
  47. {
  48. "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
  49. }
  50. * @method void setOptional(string $Optional) 设置额外配置,传入JSON字符串。
  51. {
  52. "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
  53. }
  54. * @method string getVideoBase64() 获取用于活体检测的视频,视频的Base64值;
  55. Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
  56. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  57. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  58. * @method void setVideoBase64(string $VideoBase64) 设置用于活体检测的视频,视频的Base64值;
  59. Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
  60. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  61. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  62. * @method string getVideoUrl() 获取用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
  63. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  64. 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  65. * @method void setVideoUrl(string $VideoUrl) 设置用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
  66. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  67. 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  68. */
  69. class LivenessCompareRequest extends AbstractModel
  70. {
  71. /**
  72. * @var string 活体检测类型,取值:LIP/ACTION/SILENT。
  73. LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
  74. */
  75. public $LivenessType;
  76. /**
  77. * @var string 用于人脸比对的照片的Base64值;
  78. Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
  79. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  80. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  81. */
  82. public $ImageBase64;
  83. /**
  84. * @var string 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
  85. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  86. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  87. */
  88. public $ImageUrl;
  89. /**
  90. * @var string 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
  91. 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
  92. 静默模式传参:空。
  93. */
  94. public $ValidateData;
  95. /**
  96. * @var string 额外配置,传入JSON字符串。
  97. {
  98. "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
  99. }
  100. */
  101. public $Optional;
  102. /**
  103. * @var string 用于活体检测的视频,视频的Base64值;
  104. Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
  105. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  106. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  107. */
  108. public $VideoBase64;
  109. /**
  110. * @var string 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
  111. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  112. 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  113. */
  114. public $VideoUrl;
  115. /**
  116. * @param string $LivenessType 活体检测类型,取值:LIP/ACTION/SILENT。
  117. LIP为数字模式,ACTION为动作模式,SILENT为静默模式,三种模式选择一种传入。
  118. * @param string $ImageBase64 用于人脸比对的照片的Base64值;
  119. Base64编码后的图片数据大小不超过3M,仅支持jpg、png格式。
  120. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  121. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  122. * @param string $ImageUrl 用于人脸比对照片的URL地址;图片下载后经Base64编码后的数据大小不超过3M,仅支持jpg、png格式。
  123. 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageBase64。
  124. 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  125. * @param string $ValidateData 数字模式传参:传数字验证码,验证码需先调用<a href="https://cloud.tencent.com/document/product/1007/31821">获取数字验证码接口</a>得到;
  126. 动作模式传参:传动作顺序,动作顺序需先调用<a href="https://cloud.tencent.com/document/product/1007/31822">获取动作顺序接口</a>得到;
  127. 静默模式传参:空。
  128. * @param string $Optional 额外配置,传入JSON字符串。
  129. {
  130. "BestFrameNum": 2 //需要返回多张最佳截图,取值范围2-10
  131. }
  132. * @param string $VideoBase64 用于活体检测的视频,视频的Base64值;
  133. Base64编码后的大小不超过8M,支持mp4、avi、flv格式。
  134. 请使用标准的Base64编码方式(带=补位),编码规范参考RFC4648。
  135. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  136. * @param string $VideoUrl 用于活体检测的视频Url 地址。视频下载后经Base64编码后不超过 8M,视频下载耗时不超过4S,支持mp4、avi、flv格式。
  137. 视频的 VideoUrl、VideoBase64 必须提供一个,如果都提供,只使用 VideoBase64。
  138. 建议视频存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议视频存储于腾讯云。非腾讯云存储的 Url 速度和稳定性可能受一定影响。
  139. */
  140. function __construct()
  141. {
  142. }
  143. /**
  144. * For internal only. DO NOT USE IT.
  145. */
  146. public function deserialize($param)
  147. {
  148. if ($param === null) {
  149. return;
  150. }
  151. if (array_key_exists("LivenessType",$param) and $param["LivenessType"] !== null) {
  152. $this->LivenessType = $param["LivenessType"];
  153. }
  154. if (array_key_exists("ImageBase64",$param) and $param["ImageBase64"] !== null) {
  155. $this->ImageBase64 = $param["ImageBase64"];
  156. }
  157. if (array_key_exists("ImageUrl",$param) and $param["ImageUrl"] !== null) {
  158. $this->ImageUrl = $param["ImageUrl"];
  159. }
  160. if (array_key_exists("ValidateData",$param) and $param["ValidateData"] !== null) {
  161. $this->ValidateData = $param["ValidateData"];
  162. }
  163. if (array_key_exists("Optional",$param) and $param["Optional"] !== null) {
  164. $this->Optional = $param["Optional"];
  165. }
  166. if (array_key_exists("VideoBase64",$param) and $param["VideoBase64"] !== null) {
  167. $this->VideoBase64 = $param["VideoBase64"];
  168. }
  169. if (array_key_exists("VideoUrl",$param) and $param["VideoUrl"] !== null) {
  170. $this->VideoUrl = $param["VideoUrl"];
  171. }
  172. }
  173. }