# frozen_string_literal: true
# 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.
module TencentCloud
module Vm
module V20201229
# 音频审核输出参数
class AudioResult < TencentCloud::Common::AbstractModel
# @param HitFlag: 该字段用于返回审核内容是否命中审核模型;取值:0(**未命中**)、1(**命中**)。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type HitFlag: Integer
# @param Label: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。
# 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Score: 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param Text: 该字段用于返回音频文件经ASR识别后的文本信息。最长可识别**5小时**的音频文件,若超出时长限制,接口将会报错。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Text: String
# @param Url: 该字段用于返回音频片段存储的链接地址,该地址有效期为1天。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Url: String
# @param Duration: 该字段用于返回音频文件的时长,单位为秒。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Duration: String
# @param Extra: 该字段用于返回输入参数中的额外附加信息(Extra),如未配置则默认返回值为空。
备注:不同客户或Biztype下返回信息不同,如需配置该字段请提交工单咨询或联系售后专员处理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Extra: String
# @param TextResults: 该字段用于返回音频文件经ASR识别后产生的文本的详细审核结果。具体结果内容请参见AudioResultDetailLanguageResult数据结构的细节描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type TextResults: Array
# @param MoanResults: 该字段用于返回音频文件呻吟检测的详细审核结果。具体结果内容请参见AudioResultDetailMoanResult数据结构的细节描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type MoanResults: Array
# @param LanguageResults: 该字段用于返回音频小语种检测的详细审核结果。具体结果内容请参见AudioResultDetailLanguageResult数据结构的细节描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type LanguageResults: Array
# @param SubLabel: 该字段用于返回当前标签(Lable)下的二级标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabel: String
# @param RecognitionResults: 识别类标签结果信息列表
# 注意:此字段可能返回 null,表示取不到有效值。
# @type RecognitionResults: Array
attr_accessor :HitFlag, :Label, :Suggestion, :Score, :Text, :Url, :Duration, :Extra, :TextResults, :MoanResults, :LanguageResults, :SubLabel, :RecognitionResults
def initialize(hitflag=nil, label=nil, suggestion=nil, score=nil, text=nil, url=nil, duration=nil, extra=nil, textresults=nil, moanresults=nil, languageresults=nil, sublabel=nil, recognitionresults=nil)
@HitFlag = hitflag
@Label = label
@Suggestion = suggestion
@Score = score
@Text = text
@Url = url
@Duration = duration
@Extra = extra
@TextResults = textresults
@MoanResults = moanresults
@LanguageResults = languageresults
@SubLabel = sublabel
@RecognitionResults = recognitionresults
end
def deserialize(params)
@HitFlag = params['HitFlag']
@Label = params['Label']
@Suggestion = params['Suggestion']
@Score = params['Score']
@Text = params['Text']
@Url = params['Url']
@Duration = params['Duration']
@Extra = params['Extra']
unless params['TextResults'].nil?
@TextResults = []
params['TextResults'].each do |i|
audioresultdetailtextresult_tmp = AudioResultDetailTextResult.new
audioresultdetailtextresult_tmp.deserialize(i)
@TextResults << audioresultdetailtextresult_tmp
end
end
unless params['MoanResults'].nil?
@MoanResults = []
params['MoanResults'].each do |i|
audioresultdetailmoanresult_tmp = AudioResultDetailMoanResult.new
audioresultdetailmoanresult_tmp.deserialize(i)
@MoanResults << audioresultdetailmoanresult_tmp
end
end
unless params['LanguageResults'].nil?
@LanguageResults = []
params['LanguageResults'].each do |i|
audioresultdetaillanguageresult_tmp = AudioResultDetailLanguageResult.new
audioresultdetaillanguageresult_tmp.deserialize(i)
@LanguageResults << audioresultdetaillanguageresult_tmp
end
end
@SubLabel = params['SubLabel']
unless params['RecognitionResults'].nil?
@RecognitionResults = []
params['RecognitionResults'].each do |i|
recognitionresult_tmp = RecognitionResult.new
recognitionresult_tmp.deserialize(i)
@RecognitionResults << recognitionresult_tmp
end
end
end
end
# 音频语言种类检测结果
class AudioResultDetailLanguageResult < TencentCloud::Common::AbstractModel
# @param Label: 该字段用于返回对应的语言种类信息。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Score: 该参数用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高**),越高代表音频越有可能属于当前返回的语种标签;
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param StartTime: 该参数用于返回对应语种标签的片段在音频文件内的开始时间,单位为毫秒。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type StartTime: Float
# @param EndTime: 该参数用于返回对应语种标签的片段在音频文件内的结束时间,单位为毫秒。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type EndTime: Float
# @param SubLabelCode: *内测中,敬请期待*
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabelCode: String
attr_accessor :Label, :Score, :StartTime, :EndTime, :SubLabelCode
def initialize(label=nil, score=nil, starttime=nil, endtime=nil, sublabelcode=nil)
@Label = label
@Score = score
@StartTime = starttime
@EndTime = endtime
@SubLabelCode = sublabelcode
end
def deserialize(params)
@Label = params['Label']
@Score = params['Score']
@StartTime = params['StartTime']
@EndTime = params['EndTime']
@SubLabelCode = params['SubLabelCode']
end
end
# 音频呻吟审核结果
class AudioResultDetailMoanResult < TencentCloud::Common::AbstractModel
# @param Label: 该字段用于返回检测结果需要检测的内容类型,此处固定为**Moan**(呻吟)以调用呻吟检测功能。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Score: 该字段用于返回呻吟检测的置信度,取值范围:0(**置信度最低**)-100(**置信度最高**),越高代表音频越有可能属于呻吟内容。
# @type Score: Integer
# @param StartTime: 该字段用于返回对应呻吟标签的片段在音频文件内的开始时间,单位为毫秒。
# @type StartTime: Float
# @param EndTime: 该字段用于返回对应呻吟标签的片段在音频文件内的结束时间,单位为毫秒。
# @type EndTime: Float
# @param SubLabelCode: *内测中,敬请期待*
# @type SubLabelCode: String
# @param SubLabel: 该字段用于返回当前标签(Lable)下的二级标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabel: String
# @param Suggestion: 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。
返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# @type Suggestion: String
attr_accessor :Label, :Score, :StartTime, :EndTime, :SubLabelCode, :SubLabel, :Suggestion
def initialize(label=nil, score=nil, starttime=nil, endtime=nil, sublabelcode=nil, sublabel=nil, suggestion=nil)
@Label = label
@Score = score
@StartTime = starttime
@EndTime = endtime
@SubLabelCode = sublabelcode
@SubLabel = sublabel
@Suggestion = suggestion
end
def deserialize(params)
@Label = params['Label']
@Score = params['Score']
@StartTime = params['StartTime']
@EndTime = params['EndTime']
@SubLabelCode = params['SubLabelCode']
@SubLabel = params['SubLabel']
@Suggestion = params['Suggestion']
end
end
# 音频ASR文本审核结果
class AudioResultDetailTextResult < TencentCloud::Common::AbstractModel
# @param Label: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Keywords: 该字段用于返回ASR识别出的文本内容命中的关键词信息,用于标注内容违规的具体原因(如:加我微信)。该参数可能会有多个返回值,代表命中的多个关键词;若返回值为空,Score不为空,则代表识别结果所对应的恶意标签(Label)来自于语义模型判断的返回值。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Keywords: Array
# @param LibId: 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的ID,以方便自定义库管理和配置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type LibId: String
# @param LibName: 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的名称,以方便自定义库管理和配置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type LibName: String
# @param Score: 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高**),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。
# 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param LibType: 该字段用于返回自定义关键词对应的词库类型,取值为**1**(黑白库)和**2**(自定义关键词库),若未配置自定义关键词库,则默认值为1(黑白库匹配)。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type LibType: Integer
# @param SubLabel: 该字段用于返回当前标签(Lable)下的二级标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabel: String
attr_accessor :Label, :Keywords, :LibId, :LibName, :Score, :Suggestion, :LibType, :SubLabel
def initialize(label=nil, keywords=nil, libid=nil, libname=nil, score=nil, suggestion=nil, libtype=nil, sublabel=nil)
@Label = label
@Keywords = keywords
@LibId = libid
@LibName = libname
@Score = score
@Suggestion = suggestion
@LibType = libtype
@SubLabel = sublabel
end
def deserialize(params)
@Label = params['Label']
@Keywords = params['Keywords']
@LibId = params['LibId']
@LibName = params['LibName']
@Score = params['Score']
@Suggestion = params['Suggestion']
@LibType = params['LibType']
@SubLabel = params['SubLabel']
end
end
# 用于返回音频片段的审核结果
class AudioSegments < TencentCloud::Common::AbstractModel
# @param OffsetTime: 该字段用于返回音频片段的开始时间,单位为秒。对于点播文件,该参数代表对应音频相对于完整音轨的偏移时间,如0(代表不偏移),5(音轨开始后5秒),10(音轨开始后10秒);对于直播文件,该参数则返回对应音频片段开始时的Unix时间戳,如:1594650717。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type OffsetTime: String
# @param Result: 该字段用于返回音频片段的具体审核结果,详细内容敬请参考AudioResult数据结构的描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Result: :class:`Tencentcloud::Vm.v20201229.models.AudioResult`
attr_accessor :OffsetTime, :Result
def initialize(offsettime=nil, result=nil)
@OffsetTime = offsettime
@Result = result
end
def deserialize(params)
@OffsetTime = params['OffsetTime']
unless params['Result'].nil?
@Result = AudioResult.new
@Result.deserialize(params['Result'])
end
end
end
# 文件桶信息
# 参考腾讯云存储相关说明 https://cloud.tencent.com/document/product/436/44352
class BucketInfo < TencentCloud::Common::AbstractModel
# @param Bucket: 该字段用于标识腾讯云对象存储的存储桶名称,关于文件桶的详细信息敬请参考 [腾讯云存储相关说明](https://cloud.tencent.com/document/product/436/44352)。
# @type Bucket: String
# @param Region: 该字段用于标识腾讯云对象存储的托管机房的分布地区,对象存储 COS 的数据存放在这些地域的存储桶中。
# @type Region: String
# @param Object: 该字段用于标识腾讯云对象存储的对象Key,对象z作为基本单元被存放在存储桶中;用户可以通过腾讯云控制台、API、SDK 等多种方式管理对象。有关对象的详细描述敬请参阅相应 [产品文档](https://cloud.tencent.com/document/product/436/13324)。
# @type Object: String
attr_accessor :Bucket, :Region, :Object
def initialize(bucket=nil, region=nil, object=nil)
@Bucket = bucket
@Region = region
@Object = object
end
def deserialize(params)
@Bucket = params['Bucket']
@Region = params['Region']
@Object = params['Object']
end
end
# CancelTask请求参数结构体
class CancelTaskRequest < TencentCloud::Common::AbstractModel
# @param TaskId: 该字段表示创建视频审核任务后返回的任务ID(在Results参数中),用于标识需要取消的审核任务。
# @type TaskId: String
attr_accessor :TaskId
def initialize(taskid=nil)
@TaskId = taskid
end
def deserialize(params)
@TaskId = params['TaskId']
end
end
# CancelTask返回参数结构体
class CancelTaskResponse < TencentCloud::Common::AbstractModel
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :RequestId
def initialize(requestid=nil)
@RequestId = requestid
end
def deserialize(params)
@RequestId = params['RequestId']
end
end
# CreateVideoModerationTask请求参数结构体
class CreateVideoModerationTaskRequest < TencentCloud::Common::AbstractModel
# @param Type: 该参数用于传入审核任务的任务类型,取值:**VIDEO**(点播视频),**LIVE_VIDEO**(直播视频)。
# @type Type: String
# @param Tasks: 该字段表示输入的视频审核任务信息,具体输入内容请参见TaskInput数据结构的详细描述。
备注:最多同时可创建**10个任务**。
# @type Tasks: Array
# @param BizType: 该字段表示策略的具体编号,用于接口调度,在内容安全控制台中可配置。若不传入Biztype参数(留空),则代表采用默认的识别策略;传入则会在审核时根据业务场景采取不同的审核策略。
备注:Biztype仅为数字、字母与下划线的组合,长度为3-32个字符;不同Biztype关联不同的业务场景与识别能力策略,调用前请确认正确的Biztype。
# @type BizType: String
# @param Seed: 可选参数,该字段表示回调签名的key信息,用于保证数据的安全性。 签名方法为在返回的HTTP头部添加 X-Signature 的字段,值为: seed + body 的 SHA256 编码和Hex字符串,在收到回调数据后,可以根据返回的body,用 **sha256(seed + body)**, 计算出 `X-Signature` 进行验证。
具体使用实例可参考 [回调签名示例](https://cloud.tencent.com/document/product/1265/51885)。
# @type Seed: String
# @param CallbackUrl: 可选参数,该字段表示接受审核信息回调的地址,格式为URL链接默认格式。配置成功后,审核过程中产生的违规音视频片段将通过此接口发送。回调返回内容格式请参考 [回调签名示例](https://cloud.tencent.com/document/product/1265/51879#.E7.A4.BA.E4.BE.8B2-.E5.9B.9E.E8.B0.83.E7.AD.BE.E5.90.8D.E7.A4.BA.E4.BE.8B)
备注:音频默认截取时长为**15秒**,视频截帧默认为**5秒**截取一张图片;若用户自行配置截取间隔,则按照用户配置返回相应片段。
# @type CallbackUrl: String
# @param Priority: 可选参数,该参数用于传入审核任务的优先级。当您有多个视频审核任务排队时,可以根据这个参数控制排队优先级,用于处理插队等逻辑;该参数**默认值为0**。
# @type Priority: Integer
attr_accessor :Type, :Tasks, :BizType, :Seed, :CallbackUrl, :Priority
def initialize(type=nil, tasks=nil, biztype=nil, seed=nil, callbackurl=nil, priority=nil)
@Type = type
@Tasks = tasks
@BizType = biztype
@Seed = seed
@CallbackUrl = callbackurl
@Priority = priority
end
def deserialize(params)
@Type = params['Type']
unless params['Tasks'].nil?
@Tasks = []
params['Tasks'].each do |i|
taskinput_tmp = TaskInput.new
taskinput_tmp.deserialize(i)
@Tasks << taskinput_tmp
end
end
@BizType = params['BizType']
@Seed = params['Seed']
@CallbackUrl = params['CallbackUrl']
@Priority = params['Priority']
end
end
# CreateVideoModerationTask返回参数结构体
class CreateVideoModerationTaskResponse < TencentCloud::Common::AbstractModel
# @param Results: 该字段用于返回任务创建的结果,具体输出内容请参见TaskResult数据结构的详细描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Results: Array
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :Results, :RequestId
def initialize(results=nil, requestid=nil)
@Results = results
@RequestId = requestid
end
def deserialize(params)
unless params['Results'].nil?
@Results = []
params['Results'].each do |i|
taskresult_tmp = TaskResult.new
taskresult_tmp.deserialize(i)
@Results << taskresult_tmp
end
end
@RequestId = params['RequestId']
end
end
# DescribeTaskDetail请求参数结构体
class DescribeTaskDetailRequest < TencentCloud::Common::AbstractModel
# @param TaskId: 该字段表示创建视频审核任务后返回的任务ID(在Results参数中),用于标识需要查询任务详情的审核任务。
#
备注:查询接口单次最大查询量为**20条每次**。
# @type TaskId: String
# @param ShowAllSegments: 该布尔字段表示是否展示全部的视频片段,取值:True(展示全部的视频分片)、False(只展示命中审核规则的视频分片);默认值为False。
# @type ShowAllSegments: Boolean
attr_accessor :TaskId, :ShowAllSegments
def initialize(taskid=nil, showallsegments=nil)
@TaskId = taskid
@ShowAllSegments = showallsegments
end
def deserialize(params)
@TaskId = params['TaskId']
@ShowAllSegments = params['ShowAllSegments']
end
end
# DescribeTaskDetail返回参数结构体
class DescribeTaskDetailResponse < TencentCloud::Common::AbstractModel
# @param TaskId: 该字段用于返回创建视频审核任务后返回的任务ID(在Results参数中),用于标识需要查询任务详情的审核任务。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type TaskId: String
# @param DataId: 该字段用于返回调用视频审核接口时传入的数据ID参数,方便数据的辨别和管理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type DataId: String
# @param BizType: 该字段用于返回调用视频审核接口时传入的BizType参数,方便数据的辨别和管理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type BizType: String
# @param Name: 该字段用于返回调用视频审核接口时传入的TaskInput参数中的任务名称,方便任务的识别与管理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Name: String
# @param Status: 该字段用于返回所查询内容的任务状态。
#
取值:**FINISH**(任务已完成)、**PENDING** (任务等待中)、**RUNNING** (任务进行中)、**ERROR** (任务出错)、**CANCELLED** (任务已取消)。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Status: String
# @param Type: 该字段用于返回调用视频审核接口时输入的视频审核类型,取值为:**VIDEO**(点播视频)和**LIVE_VIDEO**(直播视频),默认值为VIDEO。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Type: String
# @param Suggestion: 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。
返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Labels: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Labels: Array
# @param MediaInfo: 该字段用于返回输入媒体文件的详细信息,包括编解码格式、分片时长等信息。详细内容敬请参考MediaInfo数据结构的描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type MediaInfo: :class:`Tencentcloud::Vm.v20201229.models.MediaInfo`
# @param InputInfo: 该字段用于返回审核服务的媒体内容信息,主要包括传入文件类型和访问地址。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type InputInfo: :class:`Tencentcloud::Vm.v20201229.models.InputInfo`
# @param CreatedAt: 该字段用于返回被查询任务创建的时间,格式采用 ISO 8601标准。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type CreatedAt: String
# @param UpdatedAt: 该字段用于返回被查询任务最后更新时间,格式采用 ISO 8601标准。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type UpdatedAt: String
# @param ImageSegments: 该字段用于返回视频中截帧审核的结果,详细返回内容敬请参考ImageSegments数据结构的描述。
备注:数据有效期为24小时,如需要延长存储时间,请在已配置的COS储存桶中设置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type ImageSegments: Array
# @param AudioSegments: 该字段用于返回视频中音频审核的结果,详细返回内容敬请参考AudioSegments数据结构的描述。
备注:数据有效期为24小时,如需要延长存储时间,请在已配置的COS储存桶中设置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type AudioSegments: Array
# @param ErrorType: 当任务状态为Error时,返回对应错误的类型,取值:**DECODE_ERROR**: 解码失败。(输入资源中可能包含无法解码的视频)
# **URL_ERROR**:下载地址验证失败。
# **TIMEOUT_ERROR**:处理超时。任务状态非Error时默认返回为空。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type ErrorType: String
# @param ErrorDescription: 当任务状态为Error时,该字段用于返回对应错误的详细描述,任务状态非Error时默认返回为空。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type ErrorDescription: String
# @param Label: 该字段用于返回检测结果所对应的标签。如果未命中恶意,返回Normal,如果命中恶意,则返回Labels中优先级最高的标签
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :TaskId, :DataId, :BizType, :Name, :Status, :Type, :Suggestion, :Labels, :MediaInfo, :InputInfo, :CreatedAt, :UpdatedAt, :ImageSegments, :AudioSegments, :ErrorType, :ErrorDescription, :Label, :RequestId
def initialize(taskid=nil, dataid=nil, biztype=nil, name=nil, status=nil, type=nil, suggestion=nil, labels=nil, mediainfo=nil, inputinfo=nil, createdat=nil, updatedat=nil, imagesegments=nil, audiosegments=nil, errortype=nil, errordescription=nil, label=nil, requestid=nil)
@TaskId = taskid
@DataId = dataid
@BizType = biztype
@Name = name
@Status = status
@Type = type
@Suggestion = suggestion
@Labels = labels
@MediaInfo = mediainfo
@InputInfo = inputinfo
@CreatedAt = createdat
@UpdatedAt = updatedat
@ImageSegments = imagesegments
@AudioSegments = audiosegments
@ErrorType = errortype
@ErrorDescription = errordescription
@Label = label
@RequestId = requestid
end
def deserialize(params)
@TaskId = params['TaskId']
@DataId = params['DataId']
@BizType = params['BizType']
@Name = params['Name']
@Status = params['Status']
@Type = params['Type']
@Suggestion = params['Suggestion']
unless params['Labels'].nil?
@Labels = []
params['Labels'].each do |i|
tasklabel_tmp = TaskLabel.new
tasklabel_tmp.deserialize(i)
@Labels << tasklabel_tmp
end
end
unless params['MediaInfo'].nil?
@MediaInfo = MediaInfo.new
@MediaInfo.deserialize(params['MediaInfo'])
end
unless params['InputInfo'].nil?
@InputInfo = InputInfo.new
@InputInfo.deserialize(params['InputInfo'])
end
@CreatedAt = params['CreatedAt']
@UpdatedAt = params['UpdatedAt']
unless params['ImageSegments'].nil?
@ImageSegments = []
params['ImageSegments'].each do |i|
imagesegments_tmp = ImageSegments.new
imagesegments_tmp.deserialize(i)
@ImageSegments << imagesegments_tmp
end
end
unless params['AudioSegments'].nil?
@AudioSegments = []
params['AudioSegments'].each do |i|
audiosegments_tmp = AudioSegments.new
audiosegments_tmp.deserialize(i)
@AudioSegments << audiosegments_tmp
end
end
@ErrorType = params['ErrorType']
@ErrorDescription = params['ErrorDescription']
@Label = params['Label']
@RequestId = params['RequestId']
end
end
# DescribeTasks请求参数结构体
class DescribeTasksRequest < TencentCloud::Common::AbstractModel
# @param Limit: 该参数表示任务列表每页展示的任务条数,**默认值为10**(每页展示10条任务)。
# @type Limit: Integer
# @param Filter: 该参数表示任务筛选器的输入参数,可根据业务类型、审核文件类型、处理建议及任务状态筛选想要查看的审核任务,具体参数内容请参见TaskFilter数据结构的详细描述。
# @type Filter: :class:`Tencentcloud::Vm.v20201229.models.TaskFilter`
# @param PageToken: 该参数表示翻页时使用的Token信息,由系统自动生成,并在翻页时向下一个生成的页面传递此参数,以方便快速翻页功能的实现。当到最后一页时,该字段为空。
# @type PageToken: String
# @param StartTime: 该参数表示任务列表的开始时间,格式为ISO8601标准的时间戳。**默认值为最近3天**,若传入该参数,则在这一时间到EndTime之间的任务将会被筛选出来。
备注:该参数与Filter共同起到任务筛选作用,二者作用无先后顺序。
# @type StartTime: String
# @param EndTime: 该参数表示任务列表的结束时间,格式为ISO8601标准的时间戳。**默认值为空**,若传入该参数,则在这StartTime到这一时间之间的任务将会被筛选出来。
备注:该参数与Filter共同起到任务筛选作用,二者作用无先后顺序。
# @type EndTime: String
attr_accessor :Limit, :Filter, :PageToken, :StartTime, :EndTime
def initialize(limit=nil, filter=nil, pagetoken=nil, starttime=nil, endtime=nil)
@Limit = limit
@Filter = filter
@PageToken = pagetoken
@StartTime = starttime
@EndTime = endtime
end
def deserialize(params)
@Limit = params['Limit']
unless params['Filter'].nil?
@Filter = TaskFilter.new
@Filter.deserialize(params['Filter'])
end
@PageToken = params['PageToken']
@StartTime = params['StartTime']
@EndTime = params['EndTime']
end
end
# DescribeTasks返回参数结构体
class DescribeTasksResponse < TencentCloud::Common::AbstractModel
# @param Total: 该字段用于返回当前查询的任务总量,格式为int字符串。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Total: String
# @param Data: 该字段用于返回当前页的任务详细数据,具体输出内容请参见TaskData数据结构的详细描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Data: Array
# @param PageToken: 该字段用于返回翻页时使用的Token信息,由系统自动生成,并在翻页时向下一个生成的页面传递此参数,以方便快速翻页功能的实现。当到最后一页时,该字段为空。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type PageToken: String
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
# @type RequestId: String
attr_accessor :Total, :Data, :PageToken, :RequestId
def initialize(total=nil, data=nil, pagetoken=nil, requestid=nil)
@Total = total
@Data = data
@PageToken = pagetoken
@RequestId = requestid
end
def deserialize(params)
@Total = params['Total']
unless params['Data'].nil?
@Data = []
params['Data'].each do |i|
taskdata_tmp = TaskData.new
taskdata_tmp.deserialize(i)
@Data << taskdata_tmp
end
end
@PageToken = params['PageToken']
@RequestId = params['RequestId']
end
end
# Result结果详情
class ImageResult < TencentCloud::Common::AbstractModel
# @param HitFlag: 该参数用于标识审核内容是否命中恶意标签,取值:0(**未命中**)和1(**命中**)。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type HitFlag: Integer
# @param Label: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。
# 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Score: 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 -性行为 99*,则表明该文本非常有可能属于色情性行为内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param Results: 该字段用于返回图像审核结果的子结果,详细内容敬请参考ImageResultResult数据结构的描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Results: Array
# @param Url: 该字段用于返回审核结果的访问链接(URL),图片支持PNG、JPG、JPEG、BMP、GIF、WEBP格式。
备注:数据**默认有效期为12小时**。如您需要更长时间的保存,请在数据储存的COS桶中配置对应的储存时长。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Url: String
# @param Extra: 该字段用于返回输入参数中的额外附加信息(Extra),如未配置则默认返回值为空。
备注:不同客户或Biztype下返回信息不同,如需配置该字段请提交工单咨询或联系售后专员处理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Extra: String
# @param SubLabel: 该字段用于返回当前标签(Lable)下的二级标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabel: String
attr_accessor :HitFlag, :Label, :Suggestion, :Score, :Results, :Url, :Extra, :SubLabel
def initialize(hitflag=nil, label=nil, suggestion=nil, score=nil, results=nil, url=nil, extra=nil, sublabel=nil)
@HitFlag = hitflag
@Label = label
@Suggestion = suggestion
@Score = score
@Results = results
@Url = url
@Extra = extra
@SubLabel = sublabel
end
def deserialize(params)
@HitFlag = params['HitFlag']
@Label = params['Label']
@Suggestion = params['Suggestion']
@Score = params['Score']
unless params['Results'].nil?
@Results = []
params['Results'].each do |i|
imageresultresult_tmp = ImageResultResult.new
imageresultresult_tmp.deserialize(i)
@Results << imageresultresult_tmp
end
end
@Url = params['Url']
@Extra = params['Extra']
@SubLabel = params['SubLabel']
end
end
# 图片输出结果的子结果
class ImageResultResult < TencentCloud::Common::AbstractModel
# @param Scene: 该字段用于返回检测结果所对应的恶意场景。返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**AppLogo**:广告台标,**Custom**:自定义违规,以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Scene: String
# @param HitFlag: 该参数用于标识审核内容是否命中恶意标签,取值:0(**未命中**)和1(**命中**)。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type HitFlag: Integer
# @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。
# 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Label: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param SubLabel: 该字段用于返回恶意标签下对应的子标签的检测结果,如:*Porn-SexBehavior*等子标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabel: String
# @param Score: 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 -性行为 99*,则表明该文本非常有可能属于色情性行为内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param Names: 该字段用于返回审核图片在敏感场景下命中的特定对象名称列表。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Names: Array
# @param Text: 该字段用于返回图片OCR文本识别的检测结果,识别**上限在5000字节内**。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Text: String
# @param Details: 该字段用于返回图像审核子结果的其他详细信息,如文本位置、自定义库等。详细返回内容敬请参考ImageResultsResultDetail数据结构的描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Details: Array
attr_accessor :Scene, :HitFlag, :Suggestion, :Label, :SubLabel, :Score, :Names, :Text, :Details
def initialize(scene=nil, hitflag=nil, suggestion=nil, label=nil, sublabel=nil, score=nil, names=nil, text=nil, details=nil)
@Scene = scene
@HitFlag = hitflag
@Suggestion = suggestion
@Label = label
@SubLabel = sublabel
@Score = score
@Names = names
@Text = text
@Details = details
end
def deserialize(params)
@Scene = params['Scene']
@HitFlag = params['HitFlag']
@Suggestion = params['Suggestion']
@Label = params['Label']
@SubLabel = params['SubLabel']
@Score = params['Score']
@Names = params['Names']
@Text = params['Text']
unless params['Details'].nil?
@Details = []
params['Details'].each do |i|
imageresultsresultdetail_tmp = ImageResultsResultDetail.new
imageresultsresultdetail_tmp.deserialize(i)
@Details << imageresultsresultdetail_tmp
end
end
end
end
# 具体场景下的图片识别结果
class ImageResultsResultDetail < TencentCloud::Common::AbstractModel
# @param Name: 该字段用于返回调用视频审核接口时传入的TaskInput参数中的任务名称,方便任务的识别与管理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Name: String
# @param Text: 该字段用于返回图片OCR文本识别的检测结果,识别**上限在5000字节内**。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Text: String
# @param Location: 该字段用于返回图像审核子结果的详细位置信息,如坐标、大小、旋转角度等。详细返回内容敬请参考ImageResultsResultDetailLocation数据结构的描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Location: :class:`Tencentcloud::Vm.v20201229.models.ImageResultsResultDetailLocation`
# @param Label: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param LibId: 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的ID,以方便自定义库管理和配置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type LibId: String
# @param LibName: 该字段**仅当Label为Custom:自定义关键词时该参数有效**,用于返回自定义库的名称,以方便自定义库管理和配置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type LibName: String
# @param Keywords: 该字段用于返回检测文本命中的关键词信息,用于标注文本违规的具体原因(如:*加我微信*)。该参数可能会有多个返回值,代表命中的多个关键词;如返回值为空且Score不为空,则代表识别结果所对应的恶意标签(Label)是来自于语义模型判断的返回值。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Keywords: Array
# @param Suggestion: 该字段用于返回后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。
# 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Score: 该字段用于返回当前标签下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param SubLabelCode: 该字段用于返回恶意标签下对应的子标签的检测结果,如:*Porn-SexBehavior*等子标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabelCode: String
attr_accessor :Name, :Text, :Location, :Label, :LibId, :LibName, :Keywords, :Suggestion, :Score, :SubLabelCode
def initialize(name=nil, text=nil, location=nil, label=nil, libid=nil, libname=nil, keywords=nil, suggestion=nil, score=nil, sublabelcode=nil)
@Name = name
@Text = text
@Location = location
@Label = label
@LibId = libid
@LibName = libname
@Keywords = keywords
@Suggestion = suggestion
@Score = score
@SubLabelCode = sublabelcode
end
def deserialize(params)
@Name = params['Name']
@Text = params['Text']
unless params['Location'].nil?
@Location = ImageResultsResultDetailLocation.new
@Location.deserialize(params['Location'])
end
@Label = params['Label']
@LibId = params['LibId']
@LibName = params['LibName']
@Keywords = params['Keywords']
@Suggestion = params['Suggestion']
@Score = params['Score']
@SubLabelCode = params['SubLabelCode']
end
end
# 图片详情位置信息
class ImageResultsResultDetailLocation < TencentCloud::Common::AbstractModel
# @param X: 该参数用于标识OCR检测框左上角位置的**横坐标**(x)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type X: Float
# @param Y: 该参数用于标识OCR检测框左上角位置的**纵坐标**(y)所在的像素位置,结合剩余参数可唯一确定检测框的大小和位置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Y: Float
# @param Width: 该参数用于标识OCR检测框的宽度(**由左上角出发在x轴向右延伸的长度**)。结合剩余参数可唯一确定检测框的大小和位置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Width: Integer
# @param Height: 该参数用于标识OCR检测框的高度(**由左上角出发在y轴向下延伸的长度**)。结合剩余参数可唯一确定检测框的大小和位置。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Height: Integer
# @param Rotate: 该参数用于标识OCR检测框的旋转角度,该参数结合X和Y两个坐标参数可唯一确定检测框的具体位置;取值:0-360(**角度制**),方向为**逆时针旋**转。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Rotate: Float
attr_accessor :X, :Y, :Width, :Height, :Rotate
def initialize(x=nil, y=nil, width=nil, height=nil, rotate=nil)
@X = x
@Y = y
@Width = width
@Height = height
@Rotate = rotate
end
def deserialize(params)
@X = params['X']
@Y = params['Y']
@Width = params['Width']
@Height = params['Height']
@Rotate = params['Rotate']
end
end
# 图片段信息
class ImageSegments < TencentCloud::Common::AbstractModel
# @param OffsetTime: 该字段用于返回视频片段的截帧时间,单位为秒。对于点播文件,该参数代表对应截取图片相对于视频的偏移时间,如0(代表不偏移),5(视频开始后5秒),10(视频开始后10秒);对于直播文件,该参数则返回对应图片的Unix时间戳,如:1594650717。
# @type OffsetTime: String
# @param Result: 该字段用于返回视频片段的具体截帧审核结果,详细内容敬请参考ImageResult数据结构的描述。
# @type Result: :class:`Tencentcloud::Vm.v20201229.models.ImageResult`
attr_accessor :OffsetTime, :Result
def initialize(offsettime=nil, result=nil)
@OffsetTime = offsettime
@Result = result
end
def deserialize(params)
@OffsetTime = params['OffsetTime']
unless params['Result'].nil?
@Result = ImageResult.new
@Result.deserialize(params['Result'])
end
end
end
# 输入信息详情
class InputInfo < TencentCloud::Common::AbstractModel
# @param Type: 该字段表示文件访问类型,取值为**URL**(资源链接)和**COS** (腾讯云对象存储)。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Type: String
# @param Url: 该字段表示文件访问的链接地址,格式为标准URL格式。
备注:当Type为URL时此字段不为空。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Url: String
# @param BucketInfo: 该字段表示文件访问的腾讯云存储桶信息。
备注:当Type为COS时此字段不为空。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type BucketInfo: String
attr_accessor :Type, :Url, :BucketInfo
def initialize(type=nil, url=nil, bucketinfo=nil)
@Type = type
@Url = url
@BucketInfo = bucketinfo
end
def deserialize(params)
@Type = params['Type']
@Url = params['Url']
@BucketInfo = params['BucketInfo']
end
end
# 媒体类型
class MediaInfo < TencentCloud::Common::AbstractModel
# @param Duration: 该字段用于返回对传入的视频流进行分片的片段时长,单位为秒。**默认值为5秒**,支持用户自定义配置。
备注:仅在审核文件为流媒体时生效;此字段返回0则代表未取到有效值。
# @type Duration: Integer
attr_accessor :Duration
def initialize(duration=nil)
@Duration = duration
end
def deserialize(params)
@Duration = params['Duration']
end
end
# 识别类标签结果信息
class RecognitionResult < TencentCloud::Common::AbstractModel
# @param Label: 可能的取值有:Teenager 、Gender
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Tags: 识别标签列表
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Tags: Array
attr_accessor :Label, :Tags
def initialize(label=nil, tags=nil)
@Label = label
@Tags = tags
end
def deserialize(params)
@Label = params['Label']
unless params['Tags'].nil?
@Tags = []
params['Tags'].each do |i|
tag_tmp = Tag.new
tag_tmp.deserialize(i)
@Tags << tag_tmp
end
end
end
end
# 数据存储信息
class StorageInfo < TencentCloud::Common::AbstractModel
# @param Type: 该字段表示文件访问类型,取值为**URL**(资源链接)和**COS** (腾讯云对象存储);该字段应当与传入的访问类型相对应,可用于强校验并方便系统快速识别访问地址;若不传入此参数,则默认值为URL,此时系统将自动判定访问地址类型。
# @type Type: String
# @param Url: 该字段表示文件访问的链接地址,格式为标准URL格式。
备注:当Type为URL时此字段不为空,该参数与BucketInfo参数须传入其中之一
# @type Url: String
# @param BucketInfo: 该字段表示文件访问的腾讯云存储桶信息。
备注:当Type为COS时此字段不为空,该参数与Url参数须传入其中之一。
# @type BucketInfo: :class:`Tencentcloud::Vm.v20201229.models.BucketInfo`
attr_accessor :Type, :Url, :BucketInfo
def initialize(type=nil, url=nil, bucketinfo=nil)
@Type = type
@Url = url
@BucketInfo = bucketinfo
end
def deserialize(params)
@Type = params['Type']
@Url = params['Url']
unless params['BucketInfo'].nil?
@BucketInfo = BucketInfo.new
@BucketInfo.deserialize(params['BucketInfo'])
end
end
end
# 音频切片识别标签
class Tag < TencentCloud::Common::AbstractModel
# @param Name: 根据Label字段确定具体名称:
# 当Label 为Teenager 时 Name可能取值有:Teenager
# 当Label 为Gender 时 Name可能取值有:Male 、Female
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Name: String
# @param Score: 置信分:0~100,数值越大表示置信度越高
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param StartTime: 识别开始偏移时间,单位:毫秒
# 注意:此字段可能返回 null,表示取不到有效值。
# @type StartTime: Float
# @param EndTime: 识别结束偏移时间,单位:毫秒
# 注意:此字段可能返回 null,表示取不到有效值。
# @type EndTime: Float
attr_accessor :Name, :Score, :StartTime, :EndTime
def initialize(name=nil, score=nil, starttime=nil, endtime=nil)
@Name = name
@Score = score
@StartTime = starttime
@EndTime = endtime
end
def deserialize(params)
@Name = params['Name']
@Score = params['Score']
@StartTime = params['StartTime']
@EndTime = params['EndTime']
end
end
# 任务数据
class TaskData < TencentCloud::Common::AbstractModel
# @param DataId: 该字段用于返回视频审核任务数据所对应的数据ID,方便后续查询和管理审核任务。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type DataId: String
# @param TaskId: 该字段用于返回视频审核任务所生成的任务ID,用于标识具体审核任务,方便后续查询和管理。
# @type TaskId: String
# @param Status: 该字段用于返回所查询内容的任务状态。
#
取值:**FINISH**(任务已完成)、**PENDING** (任务等待中)、**RUNNING** (任务进行中)、**ERROR** (任务出错)、**CANCELLED** (任务已取消)。
# @type Status: String
# @param Name: 该字段用于返回视频审核任务所对应的任务名称,方便后续查询和管理审核任务。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Name: String
# @param BizType: 该字段用于返回调用视频审核接口时传入的BizType参数,方便数据的辨别和管理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type BizType: String
# @param Type: 该字段用于返回调用音频审核接口时输入的音频审核类型,取值为:**VIDEO**(点播视频)和**LIVE_VIDEO**(直播视频),默认值为VIDEO。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Type: String
# @param Suggestion: 该字段用于返回基于恶意标签的后续操作建议。当您获取到判定结果后,返回值表示具体的后续建议操作。
# 返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Labels: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# @type Labels: Array
# @param MediaInfo: 该字段用于返回输入媒体文件的详细信息,包括编码格式、分片时长等信息。详细内容敬请参考MediaInfo数据结构的描述。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type MediaInfo: :class:`Tencentcloud::Vm.v20201229.models.MediaInfo`
# @param CreatedAt: 该字段用于返回被查询任务创建的时间,格式采用 ISO 8601标准。
# @type CreatedAt: String
# @param UpdatedAt: 该字段用于返回被查询任务最后更新时间,格式采用 ISO 8601标准。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type UpdatedAt: String
# @param InputInfo: 该字段用于返回审核服务的媒体内容信息,主要包括传入文件类型和访问地址
# 注意:此字段可能返回 null,表示取不到有效值。
# @type InputInfo: :class:`Tencentcloud::Vm.v20201229.models.InputInfo`
attr_accessor :DataId, :TaskId, :Status, :Name, :BizType, :Type, :Suggestion, :Labels, :MediaInfo, :CreatedAt, :UpdatedAt, :InputInfo
def initialize(dataid=nil, taskid=nil, status=nil, name=nil, biztype=nil, type=nil, suggestion=nil, labels=nil, mediainfo=nil, createdat=nil, updatedat=nil, inputinfo=nil)
@DataId = dataid
@TaskId = taskid
@Status = status
@Name = name
@BizType = biztype
@Type = type
@Suggestion = suggestion
@Labels = labels
@MediaInfo = mediainfo
@CreatedAt = createdat
@UpdatedAt = updatedat
@InputInfo = inputinfo
end
def deserialize(params)
@DataId = params['DataId']
@TaskId = params['TaskId']
@Status = params['Status']
@Name = params['Name']
@BizType = params['BizType']
@Type = params['Type']
@Suggestion = params['Suggestion']
unless params['Labels'].nil?
@Labels = []
params['Labels'].each do |i|
tasklabel_tmp = TaskLabel.new
tasklabel_tmp.deserialize(i)
@Labels << tasklabel_tmp
end
end
unless params['MediaInfo'].nil?
@MediaInfo = MediaInfo.new
@MediaInfo.deserialize(params['MediaInfo'])
end
@CreatedAt = params['CreatedAt']
@UpdatedAt = params['UpdatedAt']
unless params['InputInfo'].nil?
@InputInfo = InputInfo.new
@InputInfo.deserialize(params['InputInfo'])
end
end
end
# 任务筛选器
class TaskFilter < TencentCloud::Common::AbstractModel
# @param BizType: 该字段用于传入任务对应的业务类型供筛选器进行筛选。Biztype为策略的具体的编号,用于接口调度,在内容安全控制台中可配置。不同Biztype关联不同的业务场景与审核策略,调用前请确认正确的Biztype。Biztype仅为**数字、字母与下划线的组合**,长度为3-32个字符。
备注:在不传入该参数时筛选器默认不筛选业务类型。
# @type BizType: Array
# @param Type: 该字段用于传入视频审核对应的任务类型供筛选器进行筛选,取值为:**VIDEO**(点播视频审核),**AUDIO**(点播音频审核), **LIVE_VIDEO**(直播视频审核), **LIVE_AUDIO**(直播音频审核)。
备注:在不传入该参数时筛选器默认不筛选任务类型。
# @type Type: String
# @param Suggestion: 该字段用于传入视频审核对应的建议操作供筛选器进行筛选,取值为:**Block**:建议屏蔽,**Review**:建议人工复审,**Pass**:建议通过。
备注:在不传入该参数时筛选器默认不筛选建议操作。
# @type Suggestion: String
# @param TaskStatus: 该字段用于传入审核任务的任务状态供筛选器进行筛选,取值为:**FINISH**(任务已完成)、**PENDING** (任务等待中)、**RUNNING** (任务进行中)、**ERROR** (任务出错)、**CANCELLED** (任务已取消)。
备注:在不传入该参数时筛选器默认不筛选任务状态。
# @type TaskStatus: String
attr_accessor :BizType, :Type, :Suggestion, :TaskStatus
def initialize(biztype=nil, type=nil, suggestion=nil, taskstatus=nil)
@BizType = biztype
@Type = type
@Suggestion = suggestion
@TaskStatus = taskstatus
end
def deserialize(params)
@BizType = params['BizType']
@Type = params['Type']
@Suggestion = params['Suggestion']
@TaskStatus = params['TaskStatus']
end
end
# 音视频任务结构
class TaskInput < TencentCloud::Common::AbstractModel
# @param DataId: 选填参数,该字段表示您为待检测对象分配的数据ID,传入后可方便您对文件进行标识和管理。
取值:由英文字母(大小写均可)、数字及四个特殊符号(_,-,@,#)组成,**长度不超过64个字符**。
# @type DataId: String
# @param Name: 选填参数,该字段表示审核任务所对应的任务名称,方便后续查询和管理审核任务。
# @type Name: String
# @param Input: 必填参数,该字段表示审核文件的访问参数,用于获取审核媒体文件,该参数内包括访问类型和访问地址。
# @type Input: :class:`Tencentcloud::Vm.v20201229.models.StorageInfo`
attr_accessor :DataId, :Name, :Input
def initialize(dataid=nil, name=nil, input=nil)
@DataId = dataid
@Name = name
@Input = input
end
def deserialize(params)
@DataId = params['DataId']
@Name = params['Name']
unless params['Input'].nil?
@Input = StorageInfo.new
@Input.deserialize(params['Input'])
end
end
end
# 任务输出标签
class TaskLabel < TencentCloud::Common::AbstractModel
# @param Label: 该字段用于返回检测结果所对应的恶意标签。
返回值:**Normal**:正常,**Porn**:色情,**Abuse**:谩骂,**Ad**:广告,**Custom**:自定义违规;以及其他令人反感、不安全或不适宜的内容类型。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Label: String
# @param Suggestion: 该字段用于返回当前标签(Label)下的后续操作建议。当您获取到判定结果后,返回值表示系统推荐的后续操作;建议您按照业务所需,对不同违规类型与建议值进行处理。
返回值:**Block**:建议屏蔽,**Review** :建议人工复审,**Pass**:建议通过
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Suggestion: String
# @param Score: 该字段用于返回当前标签(Label)下的置信度,取值范围:0(**置信度最低**)-100(**置信度最高** ),越高代表文本越有可能属于当前返回的标签;如:*色情 99*,则表明该文本非常有可能属于色情内容;*色情 0*,则表明该文本不属于色情内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Score: Integer
# @param SubLabel: 该字段用于返回当前标签(Lable)下的二级标签。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type SubLabel: String
attr_accessor :Label, :Suggestion, :Score, :SubLabel
def initialize(label=nil, suggestion=nil, score=nil, sublabel=nil)
@Label = label
@Suggestion = suggestion
@Score = score
@SubLabel = sublabel
end
def deserialize(params)
@Label = params['Label']
@Suggestion = params['Suggestion']
@Score = params['Score']
@SubLabel = params['SubLabel']
end
end
# 创建任务时的返回结果
class TaskResult < TencentCloud::Common::AbstractModel
# @param DataId: 该字段用于返回创建视频审核任务时在TaskInput结构内传入的DataId,用于标识具体审核任务。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type DataId: String
# @param TaskId: 该字段用于返回视频审核任务所生成的任务ID,用于标识具体审核任务,方便后续查询和管理。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type TaskId: String
# @param Code: 该字段用于返回任务创建的状态,如返回OK则代表任务创建成功,其他返回值可参考公共错误码。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Code: String
# @param Message: **仅在Code的返回值为错误码时生效**,用于返回错误的详情内容。
# 注意:此字段可能返回 null,表示取不到有效值。
# @type Message: String
attr_accessor :DataId, :TaskId, :Code, :Message
def initialize(dataid=nil, taskid=nil, code=nil, message=nil)
@DataId = dataid
@TaskId = taskid
@Code = code
@Message = message
end
def deserialize(params)
@DataId = params['DataId']
@TaskId = params['TaskId']
@Code = params['Code']
@Message = params['Message']
end
end
end
end
end