{
  "name": "vrs",
  "display_name": "声音复刻",
  "description": "介绍如何使用声音复刻API进行音色训练",
  "domain": "other",
  "api_version": "2020-08-24",
  "endpoint": "vrs.tencentcloudapi.com",
  "actions": [
    {
      "name": "CancelVRSTask",
      "description": "声音复刻取消任务接口",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务ID",
          "example": "fe36c79-1c71-41d1-b541-04075fb3b9aa"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "CreateVRSTask",
      "description": "本接口服务对提交音频进行声音复刻任务创建接口，异步返回复刻结果。 • 请求方法为 HTTP POST , Content-Type为\"application/json; charset=utf-8\" • 签名方法参考 公共参数 中签名方法v3。",
      "status": "online",
      "parameters": [
        {
          "name": "SessionId",
          "type": "string",
          "required": true,
          "description": "唯一请求 ID",
          "example": "63f8xxx1897281d556df60b0"
        },
        {
          "name": "VoiceName",
          "type": "string",
          "required": true,
          "description": "音色名称",
          "example": "小娥"
        },
        {
          "name": "VoiceGender",
          "type": "integer",
          "required": true,
          "description": "音色性别: 1-male 2-female",
          "example": "1"
        },
        {
          "name": "VoiceLanguage",
          "type": "integer",
          "required": true,
          "description": "语言类型： 1-中文",
          "example": "1"
        },
        {
          "name": "AudioIdList",
          "type": "array",
          "required": true,
          "description": "音频ID集合。（一句话声音复刻仅需填写一个音质检测接口返回的AudioId）",
          "example": "[\"63f89bb\"]",
          "item_type": "string"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": false,
          "description": "音频采样率： 16000：16k",
          "example": "16000"
        },
        {
          "name": "Codec",
          "type": "string",
          "required": false,
          "description": "音频格式，音频类型(wav,mp3,aac,m4a)",
          "example": "wav"
        },
        {
          "name": "CallbackUrl",
          "type": "string",
          "required": false,
          "description": "回调 URL，用户自行搭建的用于接收结果的服务URL。如果用户使用轮询方式获取识别结果，则无需提交该参数。（注意：回调方式暂不支持一句话版声音复刻） 回调采用POST请求方式，Content-Type为application/json，回调数据格式如下:{\"TaskId\":\"xxxxxxxxxxxxxx\",\"Status\":2,\"StatusStr\":\"success\",\"VoiceType\":xxxxx,\"ErrorMsg\":\"\"}",
          "example": "http://example.com/callback"
        },
        {
          "name": "ModelType",
          "type": "integer",
          "required": false,
          "description": "模型类型 1:在线 2:离线 默认为1",
          "example": "1"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "复刻类型。 5 - 一句话声音复刻。",
          "example": "5"
        },
        {
          "name": "VPRAudioId",
          "type": "string",
          "required": false,
          "description": "校验音频ID。（仅基础版声音复刻使用）",
          "example": "63f89bb"
        },
        {
          "name": "EnableVoiceEnhance",
          "type": "integer",
          "required": false,
          "description": "是否开启语音增强，0 - 关闭，1 - 开启 。默认关闭 语音增强仅适用于一句话复刻场景",
          "example": "0"
        }
      ],
      "required": [
        "SessionId",
        "VoiceName",
        "VoiceGender",
        "VoiceLanguage",
        "AudioIdList"
      ]
    },
    {
      "name": "DescribeVRSTaskStatus",
      "description": "在调用声音复刻创建任务请求接口后，有回调和轮询两种方式获取识别结果。（注意：回调方式暂不支持一句话版声音复刻） • 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见 [“声音复刻任务创建接口”](https://cloud.tencent.com/document/product/1283/90064) CallbackUrl参数说明 。 • 当采用轮询方式时，需要主动提交任务ID来\ufffd\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务ID",
          "example": "ed461a019355c5cd1ce31ab4dfb8cb12"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DetectEnvAndSoundQuality",
      "description": "本接口用于检测音频的环境和音频质量。 对于一句话声音复刻，音频时长需大于5s，小于15s，文件大小不能超过2MB，音频需为单声道，位深为16bit。建议格式：wav、单声道、采样率48kHz或24kHz • 请求方法为 HTTP POST , Content-Type为\"application/json; charset=utf-8\" • 签名方法参考 公共参数 中签名方法v3。",
      "status": "online",
      "parameters": [
        {
          "name": "TextId",
          "type": "string",
          "required": true,
          "description": "标注文本信息 ID",
          "example": "00020"
        },
        {
          "name": "AudioData",
          "type": "string",
          "required": true,
          "description": "语音数据 要使用base64编码(采用python语言时注意读取文件时需要转成base64字符串编码，例如：str(base64.b64encode(open(\"input.aac\", mode=\"rb\").read()), encoding='utf-8') )。",
          "example": "UklGRgAAAABXQVZF..."
        },
        {
          "name": "TypeId",
          "type": "integer",
          "required": true,
          "description": "1:环境检测 2:音质检测",
          "example": "2"
        },
        {
          "name": "Codec",
          "type": "string",
          "required": false,
          "description": "音频格式，音频类型(wav,mp3,aac,m4a)",
          "example": "wav"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": false,
          "description": "音频采样率。 16000：16k（默认）； 24000：24k（仅一句话声音复刻支持）； 48000：48k（仅一句话声音复刻支持）。",
          "example": "16000"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "复刻类型。5 - 一句话声音复刻。",
          "example": "5"
        }
      ],
      "required": [
        "TextId",
        "AudioData",
        "TypeId"
      ]
    },
    {
      "name": "DownloadVRSModel",
      "description": "下载声音复刻离线模型",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "string",
          "required": true,
          "description": "任务ID",
          "example": "efe36c79-1c71-41d1-b541-04075fb3b9aa"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "GetTrainingText",
      "description": "本接口用于获取声音复刻训练文本信息。 请求方法为 HTTP POST , Content-Type为\"application/json; charset=utf-8\" • 签名方法参考 公共参数 中签名方法v3。 • 当复刻类型为一句话声音复刻时，生成的TextId有效期为7天，且在成功创建一次复刻任务后失效。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "复刻类型。 5 - 一句话声音复刻。",
          "example": "5"
        },
        {
          "name": "Domain",
          "type": "integer",
          "required": false,
          "description": "音色场景。（仅支持一句话声音复刻，其余复刻类型不生效） 0 - 通用场景（默认）； 1 - 聊天场景； 2 - 阅读场景； 3 - 资讯播报场景。",
          "example": "0"
        },
        {
          "name": "TextLanguage",
          "type": "integer",
          "required": false,
          "description": "文本语种。（仅支持一句话声音复刻，其余复刻类型不生效） 1 - 中文（默认）。",
          "example": "1"
        }
      ],
      "required": []
    },
    {
      "name": "GetVRSVoiceTypeInfo",
      "description": "该接口用于查询复刻音色详细信息。",
      "status": "online",
      "parameters": [
        {
          "name": "VoiceType",
          "type": "integer",
          "required": true,
          "description": "音色id。",
          "example": "200000000"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "0 - 除快速声音复刻外其他复刻类型（默认）； 5 - 快速声音复刻。 默认为0。",
          "example": "5"
        },
        {
          "name": "FastVoiceType",
          "type": "string",
          "required": false,
          "description": "快速复刻音色id。",
          "example": "c0be5744e9804c5fae5708fbd71db20d"
        }
      ],
      "required": [
        "VoiceType"
      ]
    },
    {
      "name": "GetVRSVoiceTypes",
      "description": "查询复刻音色",
      "status": "online",
      "parameters": [
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "复刻类型。 0 - 除快速声音复刻外其他复刻类型（默认）； 5 - 一句话声音复刻。",
          "example": "0"
        }
      ],
      "required": []
    }
  ]
}