tencentcloud-sdk-nodejs/tencentcloud/services/ams/v20200608/ams_models.d.ts

腾讯云 API NODEJS SDK

/**
 * 图片段信息
 */
export interface ImageSegments {
    /**
     * 画面截帧结果详情
     */
    Result: ImageResult;
    /**
     * 截帧时间。
  点播文件：该值为相对于视频偏移时间，单位为秒，例如：0，5，10
  直播流：该值为时间戳，例如：1594650717
     */
    OffsetTime: string;
}
/**
 * 图片输出结果的子结果
 */
export interface ImageResultResult {
    /**
     * 场景
  Porn 色情
  Sexy 性感
  Abuse 谩骂
  Ad 广告
  等多个识别场景
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Scene: string;
    /**
     * 是否命中
  0 未命中
  1 命中
  注意：此字段可能返回 null，表示取不到有效值。
     */
    HitFlag: number;
    /**
     * 建议您拿到判断结果后的执行操作。
  建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Suggestion: string;
    /**
     * 标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 子标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SubLabel: string;
    /**
     * 分数
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score: number;
    /**
     * 如果命中场景为涉政，则该数据为人物姓名列表，否则null
     */
    Names: Array<string>;
    /**
     * 图片OCR文本
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Text: string;
    /**
     * 其他详情
     */
    Details: Array<ImageResultsResultDetail>;
}
/**
 * 输入信息详情
 */
export interface InputInfo {
    /**
     * 传入的类型可选：URL，COS
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Type: string;
    /**
     * Url地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Url: string;
    /**
     * 桶信息。当输入当时COS时，该字段不为空
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BucketInfo: BucketInfo;
}
/**
 *  数据存储信息
 */
export interface StorageInfo {
    /**
     * 类型 可选：
  URL 资源链接类型
  COS 腾讯云对象存储类型
     */
    Type?: string;
    /**
     * 资源链接
     */
    Url?: string;
    /**
     * 腾讯云存储桶信息
     */
    BucketInfo?: BucketInfo;
}
/**
 * 文件桶信息
参考腾讯云存储相关说明 https://cloud.tencent.com/document/product/436/44352
 */
export interface BucketInfo {
    /**
     * 腾讯云对象存储，存储桶名称
     */
    Bucket: string;
    /**
     * 地域
     */
    Region: string;
    /**
     * 对象Key
     */
    Object: string;
}
/**
 * CreateAudioModerationTask返回参数结构体
 */
export interface CreateAudioModerationTaskResponse {
    /**
     * 任务创建结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Results?: Array<TaskResult>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateBizConfig请求参数结构体
 */
export interface CreateBizConfigRequest {
    /**
     * 业务类型，仅限英文字母、数字和下划线（_）组成，长度不超过8位
     */
    BizType: string;
    /**
     * 配置信息，
     */
    MediaModeration: MediaModerationConfig;
    /**
     * 业务名称，用于标识业务场景，长度不超过32位
     */
    BizName?: string;
    /**
     * 审核内容，可选：Polity (政治); Porn (色情); Illegal(违法);Abuse (谩骂); Terror (暴恐); Ad (广告);
     */
    ModerationCategories?: Array<string>;
}
/**
 * DescribeBizConfig请求参数结构体
 */
export interface DescribeBizConfigRequest {
    /**
     * 审核业务类类型
     */
    BizType: string;
}
/**
 * 创建任务时的返回结果
 */
export interface TaskResult {
    /**
     * 请求时传入的DataId
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DataId: string;
    /**
     * TaskId，任务ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskId: string;
    /**
     * 错误码。如果code为OK，则表示创建成功，其他则参考公共错误码
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Code: string;
    /**
     * 如果错误，该字段表示错误详情
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Message: string;
}
/**
 * CancelTask请求参数结构体
 */
export interface CancelTaskRequest {
    /**
     * 任务ID
     */
    TaskId: string;
}
/**
 * DescribeTaskDetail返回参数结构体
 */
export interface DescribeTaskDetailResponse {
    /**
     * 任务ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskId?: string;
    /**
     * 审核时传入的数据Id
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DataId?: string;
    /**
     * 业务类型，用于调用识别策略模板；
  （暂未发布功能，敬请期待）
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BizType?: string;
    /**
     * 任务名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Name?: string;
    /**
     * 查询内容审核任务的状态，可选值：
  FINISH 已完成
  PENDING 等待中
  RUNNING 进行中
  ERROR 出错
  CANCELLED 已取消
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Status?: string;
    /**
     * 任务类型：可选AUDIO（点播音频），LIVE_AUDIO（直播音频）
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Type?: string;
    /**
     * 智能审核服务对于内容违规类型的等级，可选值：
  Pass 建议通过；
  Reveiw 建议复审；
  Block 建议屏蔽；
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Suggestion?: string;
    /**
     * 智能审核服务对于内容违规类型的判断，详见返回值列表
  如：Label：Porn（色情）；
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Labels?: Array<TaskLabel>;
    /**
     * 传入媒体的解码信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaInfo?: MediaInfo;
    /**
     * 审核任务的信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    InputInfo?: InputInfo;
    /**
     * 审核任务的创建时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    CreatedAt?: string;
    /**
     * 审核任务的更新时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    UpdatedAt?: string;
    /**
     * 在N秒后重试
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TryInSeconds?: number;
    /**
     * 视频/音频审核中的音频结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioSegments?: Array<AudioSegments>;
    /**
     * 视频审核中的图片结果
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ImageSegments?: Array<ImageSegments>;
    /**
     * 音频识别总文本
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioText?: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateAudioModerationTask请求参数结构体
 */
export interface CreateAudioModerationTaskRequest {
    /**
     * 业务类型, 定义 模版策略，输出存储配置。如果没有BizType，可以先参考 【创建业务配置】接口进行创建
     */
    BizType?: string;
    /**
     * 审核类型，这里可选：AUDIO (点播音频)和 LIVE_AUDIO（直播音频）
     */
    Type?: string;
    /**
     * 回调签名key，具体可以查看签名文档。
     */
    Seed?: string;
    /**
     * 接收审核信息回调地址，如果设置，则审核过程中产生的违规音频片段和画面截帧发送此接口
     */
    CallbackUrl?: string;
    /**
     * 输入的任务信息，最多可以同时创建10个任务
     */
    Tasks?: Array<TaskInput>;
}
/**
 * CreateBizConfig返回参数结构体
 */
export interface CreateBizConfigResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 音视频任务结构
 */
export interface TaskInput {
    /**
     * 数据ID
     */
    DataId?: string;
    /**
     * 任务名
     */
    Name?: string;
    /**
     * 任务输入
     */
    Input?: StorageInfo;
}
/**
 * DescribeTaskDetail请求参数结构体
 */
export interface DescribeTaskDetailRequest {
    /**
     * 任务ID，创建任务后返回的TaskId字段
     */
    TaskId: string;
    /**
     * 是否展示所有分片，默认只展示命中规则的分片
     */
    ShowAllSegments?: boolean;
}
/**
 * CancelTask返回参数结构体
 */
export interface CancelTaskResponse {
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 任务输出标签
 */
export interface TaskLabel {
    /**
     * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
  以及令人反感、不安全或不适宜的内容类型。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 建议您拿到判断结果后的执行操作。
  建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Suggestion: string;
    /**
     * 得分，分数是 0 ～ 100
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score: number;
}
/**
 * 具体场景下的图片识别结果
 */
export interface ImageResultsResultDetail {
    /**
     * 位置信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Location: Array<ImageResultsResultDetailLocation>;
    /**
     * 任务名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Name: string;
    /**
     * OCR识别文本
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Text: string;
    /**
     * 标签
     */
    Label: string;
    /**
     * 库ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LibId: string;
    /**
     * 库名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LibName: string;
    /**
     * 命中的关键词
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Keywords: Array<string>;
    /**
     * 建议
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Suggestion: string;
    /**
     * 得分
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score: number;
    /**
     * 子标签码
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SubLabelCode: string;
}
/**
 * DescribeAmsList请求参数结构体
 */
export interface DescribeAmsListRequest {
    /**
     * 页码
     */
    PageToken: string;
    /**
     * 过滤条件
     */
    Limit: number;
    /**
     * 查询方向
     */
    PageDirection: string;
    /**
     * 过滤条件
     */
    Filters?: Array<Filter>;
}
/**
 * 音频过滤条件
 */
export interface Filters {
    /**
     * 查询字段：
  策略BizType
  子账号SubUin
  日期区间DateRange
     */
    Name: string;
    /**
     * 查询值
     */
    Values: Array<string>;
}
/**
 * 机器审核详情列表数据项
 */
export interface AmsDetailInfo {
    /**
     * 标签
     */
    Label: Array<string>;
    /**
     * 时长(秒/s)
     */
    Duration: number;
    /**
     * 任务名
     */
    Name: string;
    /**
     * 任务ID，创建任务后返回的TaskId字段
     */
    TaskID: string;
    /**
     * 插入时间
     */
    InsertTime: string;
    /**
     * 数据来源 0机审，其他为自主审核
     */
    DataForm: number;
    /**
     * 操作人
     */
    Operator: string;
    /**
     * 原始命中标签
     */
    OriginalLabel: Array<string>;
    /**
     * 操作时间
     */
    OperateTime: string;
    /**
     * 视频原始地址
     */
    Url: string;
    /**
     * 封面图地址
     */
    Thumbnail: string;
    /**
     * 短音频内容
     */
    Content: string;
    /**
     * 短音频个数
     */
    DetailCount: number;
    /**
     * 音频审核的请求 id
     */
    RequestId: string;
    /**
     * 音频机审状态
     */
    Status: string;
}
/**
 * 音频小语种检测结果
 */
export interface AudioResultDetailLanguageResult {
    /**
     * 语言信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 得分
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score: number;
    /**
     * 开始时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StartTime: number;
    /**
     * 结束时间
  注意：此字段可能返回 null，表示取不到有效值。
     */
    EndTime: number;
    /**
     * 子标签码
  注意：此字段可能返回 null，表示取不到有效值。
     */
    SubLabelCode: string;
}
/**
 * Cos FileOutput
 */
export interface FileOutput {
    /**
     * 存储的Bucket
     */
    Bucket: string;
    /**
     * Cos Region
     */
    Region: string;
    /**
     * 对象前缀
     */
    ObjectPrefix: string;
}
/**
 * 描述键值对过滤器，用于条件过滤查询。例如过滤ID、名称、状态等
 */
export interface Filter {
    /**
     * 过滤键的名称。
     */
    Name: string;
    /**
     * 一个或者多个过滤值。
     */
    Values: Array<string>;
}
/**
 * DescribeAudioStat返回参数结构体
 */
export interface DescribeAudioStatResponse {
    /**
     * 识别结果统计
     */
    Overview?: Overview;
    /**
     * 识别量统计
     */
    TrendCount?: Array<TrendCount>;
    /**
     * 违规数据分布
     */
    EvilCount?: Array<EvilCount>;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeAmsList返回参数结构体
 */
export interface DescribeAmsListResponse {
    /**
     * 返回列表数据----非必选，该参数暂未对外开放
     */
    AmsDetailSet?: Array<AmsDetailInfo>;
    /**
     * 总条数
     */
    Total?: number;
    /**
     * 分页 token
     */
    PageToken?: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 识别量统计
 */
export interface TrendCount {
    /**
     * 总调用量
     */
    TotalCount: number;
    /**
     * 总调用时长
     */
    TotalHour: number;
    /**
     * 通过量
     */
    PassCount: number;
    /**
     * 通过时长
     */
    PassHour: number;
    /**
     * 违规量
     */
    EvilCount: number;
    /**
     * 违规时长
     */
    EvilHour: number;
    /**
     * 疑似违规量
     */
    SuspectCount: number;
    /**
     * 疑似违规时长
     */
    SuspectHour: number;
    /**
     * 日期
     */
    Date: string;
}
/**
 * 音频ASR文本审核结果
 */
export interface AudioResultDetailTextResult {
    /**
     * 标签
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 命中的关键词
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Keywords: Array<string>;
    /**
     * 命中的LibId
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LibId: string;
    /**
     * 命中的LibName
  注意：此字段可能返回 null，表示取不到有效值。
     */
    LibName: string;
    /**
     * 得分
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score: number;
    /**
     * 审核建议
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Suggestion: string;
    /**
     * 词库类型 1 黑白库 2 自定义库
     */
    LibType: number;
}
/**
 * DescribeAudioStat请求参数结构体
 */
export interface DescribeAudioStatRequest {
    /**
     * 审核类型 1: 机器审核; 2: 人工审核
     */
    AuditType: number;
    /**
     * 查询条件
     */
    Filters: Array<Filters>;
}
/**
 * 识别结果统计
 */
export interface Overview {
    /**
     * 总调用量
     */
    TotalCount: number;
    /**
     * 总调用时长
     */
    TotalHour: number;
    /**
     * 通过量
     */
    PassCount: number;
    /**
     * 通过时长
     */
    PassHour: number;
    /**
     * 违规量
     */
    EvilCount: number;
    /**
     * 违规时长
     */
    EvilHour: number;
    /**
     * 疑似违规量
     */
    SuspectCount: number;
    /**
     * 疑似违规时长
     */
    SuspectHour: number;
}
/**
 * 音频输出参数
 */
export interface AudioResult {
    /**
     * 是否命中
  0 未命中
  1 命中
  注意：此字段可能返回 null，表示取不到有效值。
     */
    HitFlag: number;
    /**
     * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
  以及令人反感、不安全或不适宜的内容类型。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 建议您拿到判断结果后的执行操作。
  建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Suggestion: string;
    /**
     * 得分，0-100
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Score: number;
    /**
     * 音频ASR文本
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Text: string;
    /**
     * 音频片段存储URL，有效期为1天
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Url: string;
    /**
     * 音频时长
     */
    Duration: string;
    /**
     * 拓展字段
     */
    Extra: string;
    /**
     * 文本识别结果
     */
    TextResults: Array<AudioResultDetailTextResult>;
    /**
     * 音频呻吟检测结果
     */
    MoanResults: Array<AudioResultDetailMoanResult>;
    /**
     * 音频语言检测结果
     */
    LanguageResults: Array<AudioResultDetailLanguageResult>;
}
/**
 * 音频呻吟审核结果
 */
export interface AudioResultDetailMoanResult {
    /**
     * 固定为Moan（呻吟）
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 分数
     */
    Score: number;
    /**
     * 开始时间
     */
    StartTime: number;
    /**
     * 结束时间
     */
    EndTime: number;
    /**
     * 子标签码
     */
    SubLabelCode: string;
}
/**
 * DescribeBizConfig返回参数结构体
 */
export interface DescribeBizConfigResponse {
    /**
     * 业务类型
     */
    BizType?: string;
    /**
     * 业务名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    BizName?: string;
    /**
     * 审核范围
     */
    ModerationCategories?: Array<string>;
    /**
     * 多媒体审核配置
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MediaModeration?: MediaModerationConfig;
    /**
     * 创建时间
     */
    CreatedAt?: string;
    /**
     * 更新时间
     */
    UpdatedAt?: string;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 媒体类型
 */
export interface MediaInfo {
    /**
     * 编码格式
     */
    Codecs: string;
    /**
     * 流检测时分片时长
  注意：此字段可能返回 0，表示取不到有效值。
     */
    Duration: number;
    /**
     * 宽，单位为像素
     */
    Width: number;
    /**
     * 高，单位为像素
     */
    Height: number;
    /**
     * 缩略图
     */
    Thumbnail: string;
}
/**
 * 媒体审核配置
 */
export interface MediaModerationConfig {
    /**
     * 音频截帧频率。默认一分钟
     */
    AudioFrequency: number;
    /**
     * 图片取帧频率, 单位（秒/帧），默认 5， 可选 1 ～ 300
     */
    ImageFrequency?: number;
    /**
     * 异步回调地址。
     */
    CallbackUrl?: string;
    /**
     * 临时文件存储位置
     */
    SegmentOutput?: FileOutput;
    /**
     * 是否使用OCR，默认为true
     */
    UseOCR?: boolean;
    /**
     * 是否使用音频。（音频场景下，该值永远为true）
     */
    UseAudio?: boolean;
}
/**
 * 声音段信息
 */
export interface AudioSegments {
    /**
     * 截帧时间。
  点播文件：该值为相对于视频偏移时间，单位为秒，例如：0，5，10
  直播流：该值为时间戳，例如：1594650717
  注意：此字段可能返回 null，表示取不到有效值。
     */
    OffsetTime: string;
    /**
     * 结果集
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Result: AudioResult;
}
/**
 * 违规数据分布
 */
export interface EvilCount {
    /**
     * ----非必选，该参数功能暂未对外开放
     */
    EvilType: string;
    /**
     * 分布类型总量
     */
    Count: number;
}
/**
 * 图片详情位置信息
 */
export interface ImageResultsResultDetailLocation {
    /**
     * x坐标
  注意：此字段可能返回 null，表示取不到有效值。
     */
    X: number;
    /**
     * y坐标
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Y: number;
    /**
     * 宽度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Width: number;
    /**
     * 高度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Height: number;
    /**
     * 旋转角度
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Rotate: number;
}
/**
 * Result结果详情
 */
export interface ImageResult {
    /**
     * 违规标志
  0 未命中
  1 命中
  注意：此字段可能返回 null，表示取不到有效值。
     */
    HitFlag: number;
    /**
     * 建议您拿到判断结果后的执行操作。
  建议值，Block：建议屏蔽，Review：建议复审，Pass：建议通过
     */
    Suggestion: string;
    /**
     * 恶意标签，Normal：正常，Porn：色情，Abuse：谩骂，Ad：广告，Custom：自定义词库。
  以及令人反感、不安全或不适宜的内容类型。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Label: string;
    /**
     * 得分
     */
    Score: number;
    /**
     * 画面截帧图片结果集
     */
    Results: Array<ImageResultResult>;
    /**
     * 图片URL地址
     */
    Url: string;
    /**
     * 附加字段
     */
    Extra: string;
}