@nocobase/plugin-verification/dist/node_modules/tencentcloud-sdk-nodejs/tencentcloud/services/vrs/v20200824/vrs_models.d.ts

User identity verification management, including SMS, TOTP authenticator, with extensibility.

/**
 * CancelVRSTask请求参数结构体
 */
export interface CancelVRSTaskRequest {
    /**
     * 任务ID
     */
    TaskId: string;
}
/**
 * DescribeVRSTaskStatus返回参数结构体
 */
export interface DescribeVRSTaskStatusResponse {
    /**
     * 声音复刻任务结果
     */
    Data?: DescribeVRSTaskStatusRespData;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetTrainingText请求参数结构体
 */
export declare type GetTrainingTextRequest = null;
/**
 * DownloadVRSModel请求参数结构体
 */
export interface DownloadVRSModelRequest {
    /**
     * 任务ID
     */
    TaskId: string;
}
/**
 * DownloadVRSModel返回参数结构体
 */
export interface DownloadVRSModelResponse {
    /**
     * 响应
     */
    Data?: DownloadVRSModelRsp;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetVRSVoiceTypes返回参数结构体
 */
export interface GetVRSVoiceTypesResponse {
    /**
     * 复刻音色信息
     */
    Data?: VoiceTypeListData;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CancelVRSTask返回参数结构体
 */
export interface CancelVRSTaskResponse {
    /**
     * 任务ID
     */
    Data?: CancelVRSTaskRsp;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * CreateVRSTask返回参数结构体
 */
export interface CreateVRSTaskResponse {
    /**
     * 创建任务结果
     */
    Data?: CreateVRSTaskRespData;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * GetVRSVoiceTypes请求参数结构体
 */
export declare type GetVRSVoiceTypesRequest = null;
/**
 * 任务结果
 */
export interface DescribeVRSTaskStatusRespData {
    /**
     * 任务ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskId?: string;
    /**
     * 任务状态码，0：任务等待，1：任务执行中，2：任务成功，3：任务失败。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Status?: number;
    /**
     * 任务状态，waiting：任务等待，doing：任务执行中，success：任务成功，failed：任务失败。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    StatusStr?: string;
    /**
     * 音色id
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VoiceType?: number;
    /**
     * 失败原因说明。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ErrorMsg?: string;
}
/**
 * 音色信息列表
 */
export interface VoiceTypeListData {
    /**
     * 音色信息列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VoiceTypeList?: Array<VoiceTypeInfo>;
}
/**
 * 音频检测提示信息：
1.检测字是否存在多读、 少读、 错读等
2.检测准确度和流畅度
 */
export interface Words {
    /**
     * 准确度 (<75则认为不合格)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PronAccuracy?: number;
    /**
     * 流畅度 (<0.95则认为不合格)
  注意：此字段可能返回 null，表示取不到有效值。
     */
    PronFluency?: number;
    /**
     * tag:
  0: match  匹配
  1: insert   多读
  2: delete  少读
  3: replace 错读
  4: oov  待评估字不在发音评估的词库
  5: unknown 未知错误
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Tag?: number;
    /**
     * 字
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Word?: string;
}
/**
 * 声音复刻任务创建响应
 */
export interface CreateVRSTaskRespData {
    /**
     * 任务ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TaskId?: string;
}
/**
 * GetTrainingText返回参数结构体
 */
export interface GetTrainingTextResponse {
    /**
     * 文本列表
     */
    Data?: TrainingTexts;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeVRSTaskStatus请求参数结构体
 */
export interface DescribeVRSTaskStatusRequest {
    /**
     * 任务ID
     */
    TaskId: string;
}
/**
 * 离线声音复刻模型下载响应
 */
export interface DownloadVRSModelRsp {
    /**
     * 模型cos地址
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Model?: string;
    /**
     * 音色名称
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VoiceName?: string;
    /**
     * 音色性别:
  1-male
  2-female
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VoiceGender?: number;
    /**
     * 语言类型：
  1-中文
  注意：此字段可能返回 null，表示取不到有效值。
     */
    VoiceLanguage?: number;
    /**
     * 任务ID
     */
    TaskId?: string;
}
/**
 * CreateVRSTask请求参数结构体
 */
export interface CreateVRSTaskRequest {
    /**
     * 唯一请求 ID
     */
    SessionId: string;
    /**
     * 音色名称
     */
    VoiceName: string;
    /**
     * 音频采样率：
  
  16000：16k
     */
    SampleRate: number;
    /**
     * 音色性别:
  
  1-male
  
  2-female
     */
    VoiceGender: number;
    /**
     * 语言类型：
  
  1-中文
     */
    VoiceLanguage: number;
    /**
     * 音频格式，音频类型(wav,mp3,aac,m4a)
     */
    Codec: string;
    /**
     * 音频ID集合
     */
    AudioIdList: Array<string>;
    /**
     * 回调 URL，用户自行搭建的用于接收结果的服务URL。如果用户使用轮询方式获取识别结果，则无需提交该参数。
  回调采用POST请求方式，Content-Type为application/json，回调数据格式如下:{"TaskId":"xxxxxxxxxxxxxx","Status":2,"StatusStr":"success","VoiceType":xxxxx,"ErrorMsg":""}
     */
    CallbackUrl?: string;
    /**
     * 模型类型 1:在线 2:离线  默认为1
     */
    ModelType?: number;
    /**
     * 任务类型 0:轻量版复刻
  默认为0
     */
    TaskType?: number;
    /**
     * 校验音频ID
     */
    VPRAudioId?: string;
}
/**
 * 训练文本
 */
export interface TrainingText {
    /**
     * 文本ID
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TextId?: string;
    /**
     * 文本
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Text?: string;
}
/**
 * DetectEnvAndSoundQuality返回参数结构体
 */
export interface DetectEnvAndSoundQualityResponse {
    /**
     * 检测结果
     */
    Data?: DetectionEnvAndSoundQualityRespData;
    /**
     * 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 环境检测和音频检测响应
 */
export interface DetectionEnvAndSoundQualityRespData {
    /**
     * 音频ID （用于创建任务接口AudioIds）,环境检测该值为空，仅在音质检测情况下返回
  注意：此字段可能返回 null，表示取不到有效值。
     */
    AudioId?: string;
    /**
     * 检测code
  
  0 表示当前语音通过
  -1 表示检测失败，需要重试
  -2 表示语音检测不通过，提示用户再重新录制一下（通常漏读，错读，或多读）
  -3 表示语音中噪声较大，不通过
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DetectionCode?: number;
    /**
     * 检测提示信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DetectionMsg?: string;
    /**
     * 检测提示信息
  注意：此字段可能返回 null，表示取不到有效值。
     */
    DetectionTip?: Array<Words>;
}
/**
 * 复刻音色详情
 */
export interface VoiceTypeInfo {
    /**
     * 音色id
     */
    VoiceType?: number;
    /**
     * 音色名称
     */
    VoiceName?: string;
    /**
     * 音色性别: 1-male 2-female
     */
    VoiceGender?: number;
    /**
     * 复刻类型: 0-轻量版复刻 1-基础版复刻
     */
    TaskType?: number;
    /**
     * 复刻任务 ID
     */
    TaskID?: string;
    /**
     * 创建时间
     */
    DateCreated?: string;
    /**
     * 部署状态。若已部署，则可通过语音合成接口调用该音色
     */
    IsDeployed?: boolean;
}
/**
 * DetectEnvAndSoundQuality请求参数结构体
 */
export interface DetectEnvAndSoundQualityRequest {
    /**
     * 标注文本信息 ID
     */
    TextId: string;
    /**
     * 语音数据 要使用base64编码(采用python语言时注意读取文件时需要转成base64字符串编码，例如：str(base64.b64encode(open("input.aac", mode="rb").read()), encoding='utf-8') )。
     */
    AudioData: string;
    /**
     * 音频格式，音频类型(wav,mp3,aac,m4a)
     */
    Codec: string;
    /**
     * 1:环境检测 2:音质检测
     */
    TypeId: number;
    /**
     * 音频采样率：
  
  16000：16k（默认）
     */
    SampleRate?: number;
}
/**
 * 训练文本列表
 */
export interface TrainingTexts {
    /**
     * 训练文本列表
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TrainingTextList?: Array<TrainingText>;
}
/**
 * 取消任务响应
 */
export declare type CancelVRSTaskRsp = null;