tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1077__py2.py3-none-any.whl

tencentcloud/facefusion/v20220927/models.py

@@ -41,6 +41,9 @@ class FaceRect(AbstractModel):
 
     @property
     def X(self):
+        """Top-left X-axis coordinate of the face box
+        :rtype: int
+        """
         return self._X
 
     @X.setter
@@ -49,6 +52,9 @@ class FaceRect(AbstractModel):
 
     @property
     def Y(self):
+        """Top-left Y-axis coordinate of the face box
+        :rtype: int
+        """
         return self._Y
 
     @Y.setter
@@ -57,6 +63,9 @@ class FaceRect(AbstractModel):
 
     @property
     def Width(self):
+        """Face box width
+        :rtype: int
+        """
         return self._Width
 
     @Width.setter
@@ -65,6 +74,9 @@ class FaceRect(AbstractModel):
 
     @property
     def Height(self):
+        """Face box height
+        :rtype: int
+        """
         return self._Height
 
     @Height.setter
@@ -124,6 +136,9 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def ProjectId(self):
+        """Activity ID. Check the ID in the <a href="https://console.cloud.tencent.com/facefusion" target="_blank"> Face Fusion console</a>.
+        :rtype: str
+        """
         return self._ProjectId
 
     @ProjectId.setter
@@ -132,6 +147,9 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def ModelId(self):
+        """Material ID. Check the ID in the <a href="https://console.cloud.tencent.com/facefusion" target="_blank"> Face Fusion console</a>.
+        :rtype: str
+        """
         return self._ModelId
 
     @ModelId.setter
@@ -140,6 +158,9 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def RspImgType(self):
+        """Image return method (url or base64). You cannot use both methods at the same time. The URL is valid for 7 days.
+        :rtype: str
+        """
         return self._RspImgType
 
     @RspImgType.setter
@@ -148,6 +169,9 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def MergeInfos(self):
+        """Face position information on the user face image and material template image. No more than 6 entries.
+        :rtype: list of MergeInfo
+        """
         return self._MergeInfos
 
     @MergeInfos.setter
@@ -156,6 +180,13 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def LogoAdd(self):
+        """Switch indicating whether to add a synthesis logo to the fusion result image. Default value: 1.
+1: add logo
+0: do not add logo
+Other values: add logo
+It is recommended to use an obvious logo to indicate that the result image uses face fusion technology and is synthesized by AI.
+        :rtype: int
+        """
         return self._LogoAdd
 
     @LogoAdd.setter
@@ -164,6 +195,10 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def LogoParam(self):
+        """Logo content settings
+By default, the text "Synthesized by AI" is added to the bottom right corner of the fusion result image. You can also use other texts.
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.LogoParam`
+        """
         return self._LogoParam
 
     @LogoParam.setter
@@ -172,6 +207,9 @@ By default, the text "Synthesized by AI" is added to the bottom right corner of
 
     @property
     def FuseParam(self):
+        """Fusion parameter.
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.FuseParam`
+        """
         return self._FuseParam
 
     @FuseParam.setter
@@ -223,6 +261,9 @@ class FuseFaceResponse(AbstractModel):
 
     @property
     def FusedImage(self):
+        """When RspImgType is set to url, return the URL (valid for 7 days). When RspImgType is set to base64, return the Base64 code.
+        :rtype: str
+        """
         return self._FusedImage
 
     @FusedImage.setter
@@ -231,6 +272,9 @@ class FuseFaceResponse(AbstractModel):
 
     @property
     def RequestId(self):
+        """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -266,6 +310,9 @@ class FuseFaceReviewDetail(AbstractModel):
 
     @property
     def Field(self):
+        """
+        :rtype: str
+        """
         return self._Field
 
     @Field.setter
@@ -274,6 +321,9 @@ class FuseFaceReviewDetail(AbstractModel):
 
     @property
     def Label(self):
+        """
+        :rtype: str
+        """
         return self._Label
 
     @Label.setter
@@ -282,6 +332,9 @@ class FuseFaceReviewDetail(AbstractModel):
 
     @property
     def Confidence(self):
+        """
+        :rtype: float
+        """
         return self._Confidence
 
     @Confidence.setter
@@ -290,6 +343,9 @@ class FuseFaceReviewDetail(AbstractModel):
 
     @property
     def Suggestion(self):
+        """
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -341,6 +397,9 @@ class FuseFaceReviewResult(AbstractModel):
 
     @property
     def Category(self):
+        """
+        :rtype: str
+        """
         return self._Category
 
     @Category.setter
@@ -349,6 +408,9 @@ class FuseFaceReviewResult(AbstractModel):
 
     @property
     def Code(self):
+        """
+        :rtype: str
+        """
         return self._Code
 
     @Code.setter
@@ -357,6 +419,9 @@ class FuseFaceReviewResult(AbstractModel):
 
     @property
     def CodeDescription(self):
+        """
+        :rtype: str
+        """
         return self._CodeDescription
 
     @CodeDescription.setter
@@ -365,6 +430,9 @@ class FuseFaceReviewResult(AbstractModel):
 
     @property
     def Confidence(self):
+        """
+        :rtype: float
+        """
         return self._Confidence
 
     @Confidence.setter
@@ -373,6 +441,9 @@ class FuseFaceReviewResult(AbstractModel):
 
     @property
     def Suggestion(self):
+        """
+        :rtype: str
+        """
         return self._Suggestion
 
     @Suggestion.setter
@@ -381,6 +452,9 @@ class FuseFaceReviewResult(AbstractModel):
 
     @property
     def DetailSet(self):
+        """
+        :rtype: list of FuseFaceReviewDetail
+        """
         return self._DetailSet
 
     @DetailSet.setter
@@ -424,6 +498,9 @@ class FuseParam(AbstractModel):
 
     @property
     def ImageCodecParam(self):
+        """Image encoding parameter
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.ImageCodecParam`
+        """
         return self._ImageCodecParam
 
     @ImageCodecParam.setter
@@ -459,6 +536,9 @@ class ImageCodecParam(AbstractModel):
 
     @property
     def MetaData(self):
+        """Metadata. The number of metadata entries cannot exceed 1.
+        :rtype: list of MetaData
+        """
         return self._MetaData
 
     @MetaData.setter
@@ -507,6 +587,9 @@ class LogoParam(AbstractModel):
 
     @property
     def LogoRect(self):
+        """Coordinates of the logo image in the fusion result image. The logo image will be stretched according to the coordinates.
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.FaceRect`
+        """
         return self._LogoRect
 
     @LogoRect.setter
@@ -515,6 +598,11 @@ class LogoParam(AbstractModel):
 
     @property
     def LogoUrl(self):
+        """Logo image URL
+●Either the Base64 code or URL must be provided. If both are provided, URL prevails.
+●Supported image format: JPG or PNG
+        :rtype: str
+        """
         return self._LogoUrl
 
     @LogoUrl.setter
@@ -523,6 +611,11 @@ class LogoParam(AbstractModel):
 
     @property
     def LogoImage(self):
+        """Logo image Base64 code
+●Either the Base64 code or URL must be provided. If both are provided, URL prevails.
+●Supported image format: JPG or PNG
+        :rtype: str
+        """
         return self._LogoImage
 
     @LogoImage.setter
@@ -580,6 +673,12 @@ Width and height are no less than 30.
 
     @property
     def Image(self):
+        """Enter the image Base64 code.
+●Either the Base64 code or URL must be provided. If both are provided, URL prevails.
+●Material image limitation: face size in the image greater than 34×34 pixels; image size greater than 64×64 pixels. (After encoding, the image size may increase by about 30%. It is recommended to control the image size reasonably.)
+●Supported image format: JPG or PNG
+        :rtype: str
+        """
         return self._Image
 
     @Image.setter
@@ -588,6 +687,12 @@ Width and height are no less than 30.
 
     @property
     def Url(self):
+        """Enter the image URL.
+●Either the Base64 code or URL must be provided. If both are provided, URL prevails.
+●Material image limitation: face size in the image greater than 34×34 pixels; image size greater than 64×64 pixels. (After encoding, the image size may increase by about 30%. It is recommended to control the image size reasonably.)
+●Supported image format: JPG or PNG
+        :rtype: str
+        """
         return self._Url
 
     @Url.setter
@@ -596,6 +701,10 @@ Width and height are no less than 30.
 
     @property
     def InputImageFaceRect(self):
+        """Face position information (face box) on the uploaded image
+Width and height are no less than 30.
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.FaceRect`
+        """
         return self._InputImageFaceRect
 
     @InputImageFaceRect.setter
@@ -604,6 +713,9 @@ Width and height are no less than 30.
 
     @property
     def TemplateFaceID(self):
+        """Material face ID. If this parameter is left blank, the largest face is used by default.
+        :rtype: str
+        """
         return self._TemplateFaceID
 
     @TemplateFaceID.setter
@@ -612,6 +724,10 @@ Width and height are no less than 30.
 
     @property
     def TemplateFaceRect(self):
+        """Face position information (face box) on the template. If this parameter is left blank, the largest face is used by default. This parameter applies to scenes where custom material templates are used for fusion.
+Width and height are no less than 30.
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.FaceRect`
+        """
         return self._TemplateFaceRect
 
     @TemplateFaceRect.setter
@@ -656,6 +772,9 @@ class MetaData(AbstractModel):
 
     @property
     def MetaKey(self):
+        """Metadata key
+        :rtype: str
+        """
         return self._MetaKey
 
     @MetaKey.setter
@@ -664,6 +783,9 @@ class MetaData(AbstractModel):
 
     @property
     def MetaValue(self):
+        """Metadata value
+        :rtype: str
+        """
         return self._MetaValue
 
     @MetaValue.setter
@@ -698,6 +820,9 @@ class QueryVideoFaceFusionJobRequest(AbstractModel):
 
     @property
     def JobId(self):
+        """Job ID of the video face fusion task
+        :rtype: str
+        """
         return self._JobId
 
     @JobId.setter
@@ -750,6 +875,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def JobStatus(self):
+        """Current task status: queuing, processing, processing failed, or processing completed
+        :rtype: str
+        """
         return self._JobStatus
 
     @JobStatus.setter
@@ -758,6 +886,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def VideoFaceFusionOutput(self):
+        """Video face fusion result
+Note: This field may return null, indicating that no valid values can be obtained.
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.VideoFaceFusionOutput`
+        """
         return self._VideoFaceFusionOutput
 
     @VideoFaceFusionOutput.setter
@@ -766,6 +898,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def JobStatusCode(self):
+        """Task status code. 1: queuing; 3: processing; 5: processing failed; 7: processing completed.
+Note: This field may return null, indicating that no valid values can be obtained.
+        :rtype: int
+        """
         return self._JobStatusCode
 
     @JobStatusCode.setter
@@ -774,6 +910,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def JobErrorCode(self):
+        """Task failure error code
+Note: This field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._JobErrorCode
 
     @JobErrorCode.setter
@@ -782,6 +922,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def JobErrorMsg(self):
+        """Task failure error message
+Note: This field may return null, indicating that no valid values can be obtained.
+        :rtype: str
+        """
         return self._JobErrorMsg
 
     @JobErrorMsg.setter
@@ -790,6 +934,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def RequestId(self):
+        """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -846,6 +993,9 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def ProjectId(self):
+        """Activity ID. Check it in the video face fusion console.
+        :rtype: str
+        """
         return self._ProjectId
 
     @ProjectId.setter
@@ -854,6 +1004,9 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def ModelId(self):
+        """Material ID. Check it in the video face fusion console.
+        :rtype: str
+        """
         return self._ModelId
 
     @ModelId.setter
@@ -862,6 +1015,9 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def MergeInfos(self):
+        """Face position information on the user face image and material template image. Only one entry is allowed.
+        :rtype: list of MergeInfo
+        """
         return self._MergeInfos
 
     @MergeInfos.setter
@@ -870,6 +1026,11 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def CelebrityIdentify(self):
+        """0: inappropriate content recognition not required; 1: inappropriate content recognition required. Default value: 0.
+Note: Once the inappropriate content recognition service is enabled, you need to decide whether to adjust your business logic based on the returned results. For example, you need to replace the image if the system informs you that the image does not meet the requirements.
+**<font color=#1E90FF>Note: This field will be deprecated later due to business adjustments. It is not recommended for use.</font>**
+        :rtype: int
+        """
         return self._CelebrityIdentify
 
     @CelebrityIdentify.setter
@@ -878,6 +1039,9 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def LogoParam(self):
+        """Video watermark logo parameter
+        :rtype: :class:`tencentcloud.facefusion.v20220927.models.LogoParam`
+        """
         return self._LogoParam
 
     @LogoParam.setter
@@ -886,6 +1050,10 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def UserDesignatedUrl(self):
+        """COS pre-signed URL (PUT method). If this parameter is specified, the video after fusion will be uploaded to this URL.
+**<font color=#1E90FF>Note: If upload to this URL fails, the video will be uploaded to the default address of Tencent Cloud.</font>**
+        :rtype: str
+        """
         return self._UserDesignatedUrl
 
     @UserDesignatedUrl.setter
@@ -894,6 +1062,9 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def UserIp(self):
+        """User IP address
+        :rtype: str
+        """
         return self._UserIp
 
     @UserIp.setter
@@ -902,6 +1073,9 @@ Note: Once the inappropriate content recognition service is enabled, you need to
 
     @property
     def MetaData(self):
+        """Video metadata field
+        :rtype: list of MetaData
+        """
         return self._MetaData
 
     @MetaData.setter
@@ -967,6 +1141,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def JobId(self):
+        """Job ID of the video face fusion task
+        :rtype: str
+        """
         return self._JobId
 
     @JobId.setter
@@ -975,6 +1152,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def EstimatedProcessTime(self):
+        """Estimated processing time of the video face fusion task, in seconds
+        :rtype: float
+        """
         return self._EstimatedProcessTime
 
     @EstimatedProcessTime.setter
@@ -983,6 +1163,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def JobQueueLength(self):
+        """Estimated processing time of the video face fusion task, in seconds
+        :rtype: int
+        """
         return self._JobQueueLength
 
     @JobQueueLength.setter
@@ -991,6 +1174,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def ReviewResultSet(self):
+        """Inappropriate content recognition result. The element order of this array is the same as that of mergeinfo in the request, with a one-to-one relationship.
+Note: This field may return null, indicating that no valid values can be obtained.
+        :rtype: list of FuseFaceReviewResult
+        """
         return self._ReviewResultSet
 
     @ReviewResultSet.setter
@@ -999,6 +1186,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
 
     @property
     def RequestId(self):
+        """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
+        :rtype: str
+        """
         return self._RequestId
 
     @RequestId.setter
@@ -1051,6 +1241,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def VideoUrl(self):
+        """URL of the video output after video face fusion
+        :rtype: str
+        """
         return self._VideoUrl
 
     @VideoUrl.setter
@@ -1059,6 +1252,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def VideoMD5(self):
+        """MD5 value of the video output after video face fusion, which is used for verification
+        :rtype: str
+        """
         return self._VideoMD5
 
     @VideoMD5.setter
@@ -1067,6 +1263,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def Width(self):
+        """Video width
+        :rtype: int
+        """
         return self._Width
 
     @Width.setter
@@ -1075,6 +1274,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def Height(self):
+        """Video height
+        :rtype: int
+        """
         return self._Height
 
     @Height.setter
@@ -1083,6 +1285,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def FPS(self):
+        """Frames per second
+        :rtype: int
+        """
         return self._FPS
 
     @FPS.setter
@@ -1091,6 +1296,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def DurationInSec(self):
+        """Video duration, in seconds
+        :rtype: float
+        """
         return self._DurationInSec
 
     @DurationInSec.setter
@@ -1099,6 +1307,9 @@ class VideoFaceFusionOutput(AbstractModel):
 
     @property
     def Frame(self):
+        """Number of frames
+        :rtype: int
+        """
         return self._Frame
 
     @Frame.setter