{
  "name": "asr",
  "display_name": "语音识别",
  "description": "介绍如何使用API对语音识别进行操作，包括录音文件识别、实时语音识别等。",
  "domain": "ai",
  "api_version": "2019-06-14",
  "endpoint": "asr.tencentcloudapi.com",
  "actions": [
    {
      "name": "CloseAsyncRecognitionTask",
      "description": "本接口用于关闭语音流异步识别任务。",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "语音流异步识别任务的唯一标识，在创建任务时会返回",
          "example": "9000254964"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "CreateAsrKeyWordLib",
      "description": "用户通过本接口进行关键字词表的创建。 • 默认每个用户最多可创建30个关键字词表。 • 每个关键词词表最多可添加100个词，每个词最多5个汉字或15个字符。 • 词表通过本地文件形式上传。 • 本地文件必须为UTF-8编码格式，每行仅添加一个词且不能包含标点和特殊字符。",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "词表名称，长度在1-20之间 仅限中英文数字-_",
          "example": "测试词表"
        },
        {
          "name": "KeyWordFile",
          "type": "string",
          "required": true,
          "description": "词文件（纯文本文件）的二进制base64编码，以行分隔 格式要求：TXT 每行只有一个词，不满足格式则报错无法上传 每个词限制**5个汉字，15个字符**，单个词库最多不超过100个词 注意不要有空行，尤其是最后一行",
          "example": "避风港(进行base64编码)"
        }
      ],
      "required": [
        "Name",
        "KeyWordFile"
      ]
    },
    {
      "name": "CreateAsrVocab",
      "description": "用户通过本接口进行热词表的创建。 • 默认最多可创建30个热词表。 • 每个热词表最多可添加1000个词，每个词最长10个汉字或30个英文字符，不能超出限制。 • 热词表可以通过数组或者本地文件形式上传。 • 本地文件必须为UTF-8编码格式，每行仅添加一个热词且不能包含标点和特殊字符。 • 热词权重取值范围为[1,11]之间的整数或者100，权重越大代表该词被识别出来的概率\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "热词表名称，长度在1-255之间",
          "example": "避风港"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "热词表描述，长度在0-1000之间",
          "example": "热词"
        },
        {
          "name": "WordWeights",
          "type": "array",
          "required": false,
          "description": "词权重数组，包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符，权重为[1,11]之间整数或者100，数组长度不大于1000 注意: - 热词权重设置为11时，当前热词将升级为超级热词，建议仅将重要且必须生效的热词设置到11，设置过多权重为11的热词将影响整体字准率。 - 热词权重设置为100时，当前热词开启热词增强同音替换功能（仅支持8k_zh,16k_zh），举例\ufffd...",
          "example": "1",
          "item_type": "object",
          "children": [
            {
              "name": "Word",
              "type": "string",
              "required": true,
              "description": "热词 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "秘制"
            },
            {
              "name": "Weight",
              "type": "integer",
              "required": true,
              "description": "权重 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "10"
            }
          ]
        },
        {
          "name": "WordWeightStr",
          "type": "string",
          "required": false,
          "description": "词权重文件（纯文本文件）的二进制base64编码，以行分隔，每行的格式为word|weight，即以英文符号|为分割，左边为词，右边为权重，如：你好|5。 当用户传此参数（参数长度大于0），即以此参数解析词权重，WordWeights会被忽略",
          "example": "避风港|10 (进行bas64编码)"
        }
      ],
      "required": [
        "Name"
      ]
    },
    {
      "name": "CreateAsyncRecognitionTask",
      "description": "本接口用于对语音流进行准实时识别，通过异步回调来返回识别结果。适用于直播审核等场景。 • 支持rtmp、rtsp等流媒体协议，以及各类基于http协议的直播流(不支持hls) • 音频流时长无限制，服务会自动拉取音频流数据，若连续10分钟拉不到流或流数据无人声时，服务会终止识别任务 • 服务通过回调的方式来提供识别结果，用户需要提供CallbackUrl。回调时机为一小段话(最长1...",
      "status": "online",
      "parameters": [
        {
          "name": "EngineType",
          "type": "string",
          "required": true,
          "description": "引擎模型类型。 • 16k_zh：中文普通话通用； • 16k_en：英语； • 16k_id：印度尼西亚语； • 16k_fil：菲律宾语； • 16k_th：泰语； • 16k_pt：葡萄牙语； • 16k_tr：土耳其语； • 16k_ar：阿拉伯语； • 16k_es：西班牙语； • 16k_hi：印地语； • 16k_fr：法语； • 16k_de：德语；",
          "example": "16k_zh"
        },
        {
          "name": "Url",
          "type": "string",
          "required": true,
          "description": "语音流地址，支持rtmp、rtsp等流媒体协议，以及各类基于http协议的直播流(不支持hls, m3u8)",
          "example": "https://www.audio.com/audio.wav"
        },
        {
          "name": "CallbackUrl",
          "type": "string",
          "required": true,
          "description": "支持HTTP和HTTPS协议，用于接收识别结果，您需要自行搭建公网可调用的服务。回调格式\u0026内容详见：[语音流异步识别回调说明](https://cloud.tencent.com/document/product/1093/52633)",
          "example": "https://www.audio.com/callback"
        },
        {
          "name": "SignToken",
          "type": "string",
          "required": false,
          "description": "用于生成回调通知中的签名",
          "example": "xadjjfshjask******lksadlakd"
        },
        {
          "name": "FilterDirty",
          "type": "integer",
          "required": false,
          "description": "是否过滤脏词（目前支持中文普通话引擎）。0：不过滤脏词；1：过滤脏词；2：将脏词替换为 * 。默认值为 0",
          "example": "0"
        },
        {
          "name": "FilterModal",
          "type": "integer",
          "required": false,
          "description": "是否过滤语气词（目前支持中文普通话引擎）。0：不过滤语气词；1：部分过滤；2：严格过滤 。默认值为 0",
          "example": "0"
        },
        {
          "name": "FilterPunc",
          "type": "integer",
          "required": false,
          "description": "是否过滤标点符号（目前支持中文普通话引擎）。 0：不过滤，1：过滤句末标点，2：过滤所有标点。默认为0",
          "example": "0"
        },
        {
          "name": "ConvertNumMode",
          "type": "integer",
          "required": false,
          "description": "是否进行阿拉伯数字智能转换。0：不转换，直接输出中文数字，1：根据场景智能转换为阿拉伯数字。默认值为1",
          "example": "1"
        },
        {
          "name": "WordInfo",
          "type": "integer",
          "required": false,
          "description": "是否显示词级别时间戳。0：不显示；1：显示，不包含标点时间戳，2：显示，包含标点时间戳。默认为0",
          "example": "0"
        },
        {
          "name": "HotwordId",
          "type": "string",
          "required": false,
          "description": "热词id。用于调用对应的热词表，如果在调用语音识别服务时，不进行单独的热词id设置，自动生效默认热词；如果进行了单独的热词id设置，那么将生效单独设置的热词id。",
          "example": "sifhsadhuasjh*****djsahdsg"
        },
        {
          "name": "AudioData",
          "type": "boolean",
          "required": false,
          "description": "回调数据中，是否需要对应音频数据。",
          "example": "false"
        }
      ],
      "required": [
        "EngineType",
        "Url",
        "CallbackUrl"
      ]
    },
    {
      "name": "CreateCustomization",
      "description": "用户使用该接口可以创建自学习模型，以供识别调用。 注意：调用该接口后，模型会自动训练。新建模型成功后，调用ModifyCustomizationState接口修改为上线状态，即可在识别请求中使用对应模型ID。",
      "status": "online",
      "parameters": [
        {
          "name": "ModelName",
          "type": "string",
          "required": true,
          "description": "自学习模型名称，需在1-20字符之间",
          "example": "出行模型"
        },
        {
          "name": "TextUrl",
          "type": "string",
          "required": true,
          "description": "文本文件的下载地址，服务会从该地址下载文件，目前仅支持腾讯云cos",
          "example": "https://xxx.xx.com/text"
        },
        {
          "name": "ModelType",
          "type": "string",
          "required": true,
          "description": "自学习模型类型，填写8k或者16k",
          "example": "8k"
        }
      ],
      "required": [
        "ModelName",
        "TextUrl",
        "ModelType"
      ]
    },
    {
      "name": "CreateRecTask",
      "description": "本接口可对较长的录音文件进行识别。如希望直接使用带界面的语音识别产品，请访问[产品体验中心](https://console.cloud.tencent.com/asr/demonstrate)。产品计费标准请查阅 [计费概述（在线版）](https://cloud.tencent.com/document/product/1093/35686) • 接口默认限频：20次/秒。此处仅限制任务提交频次，与识别结果返回时效无关 • 返回时效：异步回调，非实时返回。最长3小时返回识别结果，**大\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "EngineModelType",
          "type": "string",
          "required": true,
          "description": "引擎模型类型识别引擎采用分级计费方案，标记为“大模型版”的引擎适用大模型计费方案，点击这里 查看产品计费说明电话通讯场景引擎：注意：电话通讯场景，请务必使用以下8k引擎• 8k_zh：中文电话通讯；• 8k_en：英文电话通讯；• 8k_zh_large：中文电话场景专用大模型引擎【大模型版】。当前模型同时支持中文、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑\ufffd\ufffd...",
          "example": "16k_zh"
        },
        {
          "name": "ChannelNum",
          "type": "integer",
          "required": true,
          "description": "识别声道数1：单声道（16k音频仅支持单声道，请勿设置为双声道）；2：双声道（仅支持8k电话音频，且双声道应分别为通话双方）注意：• 16k音频：仅支持单声道识别，需设置ChannelNum=1；• 8k电话音频：支持单声道、双声道识别，建议设置ChannelNum=2，即双声道。双声道能够物理区分说话人、避免说话双方重叠产生的识别错误，能达到最好的说话人分离效果和识别效果。设置双...",
          "example": "1"
        },
        {
          "name": "ResTextFormat",
          "type": "integer",
          "required": true,
          "description": "识别结果返回样式0：基础识别结果（仅包含有效人声时间戳，无词粒度的详细识别结果）；1：基础识别结果之上，增加词粒度的详细识别结果（包含词级别时间戳、语速值，不含标点）；2：基础识别结果之上，增加词粒度的详细识别结果（包含词级别时间戳、语速值和标点）；3：基础识别结果之上，增加词粒度的详细识别结果（包含词级别时间戳、语速值和标点），且识别\ufffd...",
          "example": "0"
        },
        {
          "name": "SourceType",
          "type": "integer",
          "required": true,
          "description": "音频数据来源0：音频URL；1：音频数据（post body）",
          "example": "0"
        },
        {
          "name": "Data",
          "type": "string",
          "required": false,
          "description": "音频数据base64编码当 SourceType 值为 1 时须填写该字段，为 0 时不需要填写注意：音频数据要小于5MB（含）",
          "example": "UklGRka1CQBXQVZFZm10zOjQzAABJU0ZUDgAAAE"
        },
        {
          "name": "DataLen",
          "type": "integer",
          "required": false,
          "description": "数据长度（此数据长度为数据未进行base64编码时的长度）",
          "example": "50"
        },
        {
          "name": "Url",
          "type": "string",
          "required": false,
          "description": "音频URL的地址（需要公网环境浏览器可下载）当 SourceType 值为 0 时须填写该字段，为 1 时不需要填写注意：请确保录音文件时长在5个小时（含）之内，否则可能识别失败；请保证文件的下载速度，否则可能下载失败",
          "example": "https://audio.cos.ap-guangzhou.myqcloud.com/example.wav"
        },
        {
          "name": "CallbackUrl",
          "type": "string",
          "required": false,
          "description": "回调 URL用户自行搭建的用于接收识别结果的服务URL回调格式和内容详见：录音识别回调说明注意：如果用户使用轮询方式获取识别结果，则无需提交该参数建议在回调URL中带上您的业务ID等信息，以便处理业务逻辑",
          "example": "https://xxxx.xxx.xxx/callback"
        },
        {
          "name": "SpeakerDiarization",
          "type": "integer",
          "required": false,
          "description": "是否开启说话人分离0：不开启；1：开启（仅支持以下引擎：8k_zh/8k_zh_large/16k_zh/16k_ms/16k_en/16k_id/16k_zh_large/16k_zh_dialect/16k_zh_en/16k_es/16k_fr/16k_ja/16k_ko，且ChannelNum=1时可用）；3: 开启角色分离，需配合SpeakerRoles参数使用（增值服务，仅支持16k_zh_en引擎，可支持传入声纹对录音文件内的说话人进行角色认证）默认值为 0注意：8k双声道电话音频请按 ChannelNum 识别声道数 的参数描述使用\ufffd...",
          "example": "0"
        },
        {
          "name": "SpeakerNumber",
          "type": "integer",
          "required": false,
          "description": "说话人分离人数需配合开启说话人分离使用，不开启无效，取值范围：0-100：自动分离（最多分离出20个人）；1-10：指定人数分离；默认值为 0注:16k引擎不支持指定人数分离",
          "example": "0"
        },
        {
          "name": "HotwordId",
          "type": "string",
          "required": false,
          "description": "热词表id如不设置该参数，将自动生效默认热词表；如设置该参数，将生效对应id的热词表；点击这里查看热词表配置方法",
          "example": "769762aexxxxxxxxxxec3cda3142e"
        },
        {
          "name": "CustomizationId",
          "type": "string",
          "required": false,
          "description": "自学习定制模型 id如设置了该参数，将生效对应id的自学习定制模型；点击这里查看自学习定制模型配置方法",
          "example": "769762aexxxxxxxxxxec3cda3142e"
        },
        {
          "name": "EmotionRecognition",
          "type": "integer",
          "required": false,
          "description": "【增值付费功能】情绪识别能力（目前仅支持 16k_zh , 16k_zh_en , 8k_zh ）0：不开启；1：开启情绪识别，但不在文本展示情绪标签；2：开启情绪识别，并且在文本展示情绪标签（该功能需要设置ResTextFormat 大于0）默认值为0支持的情绪分类为：高兴、伤心、愤怒注意：本功能为增值服务，需将参数设置为1或2时方可按对应方式生效；如果传入参数值1或2，需确保账号已购买情绪识别\ufffd\ufffd...",
          "example": "0"
        },
        {
          "name": "EmotionalEnergy",
          "type": "integer",
          "required": false,
          "description": "情绪能量值取值为音量分贝值/10，取值范围：[1,10]，值越高情绪越强烈0：不开启；1：开启；默认值为0",
          "example": "0"
        },
        {
          "name": "ConvertNumMode",
          "type": "integer",
          "required": false,
          "description": "阿拉伯数字智能转换（目前支持中文普通话引擎）0：不转换，直接输出中文数字；1：根据场景智能转换为阿拉伯数字；3：打开数学相关数字转换（如：阿尔法转写为α）；默认值为 1",
          "example": "0"
        },
        {
          "name": "FilterDirty",
          "type": "integer",
          "required": false,
          "description": "脏词过滤（目前支持中文普通话引擎）0：不过滤脏词；1：过滤脏词；2：将脏词替换为 * ；默认值为 0",
          "example": "0"
        },
        {
          "name": "FilterPunc",
          "type": "integer",
          "required": false,
          "description": "标点符号过滤（目前支持中文普通话引擎）0：不过滤标点；1：过滤句末标点；2：过滤所有标点；默认值为 0",
          "example": "0"
        },
        {
          "name": "FilterModal",
          "type": "integer",
          "required": false,
          "description": "语气词过滤（目前支持中文普通话引擎）0：不过滤语气词；1：过滤部分语气词；2：严格过滤语气词；默认值为 0",
          "example": "0"
        },
        {
          "name": "SentenceMaxLength",
          "type": "integer",
          "required": false,
          "description": "单标点最多字数（目前支持中文普通话引擎）可控制单行字幕最大字数，适用于字幕生成场景，取值范围：[6，40]0：不开启该功能；默认值为0注意：需设置ResTextFormat为3，解析返回的ResultDetail列表，通过结构中FinalSentence获取单个标点断句结果",
          "example": "0"
        },
        {
          "name": "Extra",
          "type": "string",
          "required": false,
          "description": "附加参数（该参数无意义，忽略即可）",
          "example": "无意义参数"
        },
        {
          "name": "HotwordList",
          "type": "string",
          "required": false,
          "description": "临时热词表：该参数用于提升识别准确率。单个热词限制：\u0026quot;热词|权重\u0026quot;，单个热词不超过30个字符（最多10个汉字），权重[1-11]或者100，如：“腾讯云|5” 或“ASR|11”；临时热词表限制：多个热词用英文逗号分割，最多支持128个热词，如：“腾讯云|10,语音识别|5,ASR|11”；参数 hotword_id（热词表） 与 hotword_list（临时热词表） 区别：hotword_id：热词表。需要先在控制台或接\ufffd\ufffd...",
          "example": "腾讯云|10,语音识别|5,ASR|11"
        },
        {
          "name": "KeyWordLibIdList",
          "type": "array",
          "required": false,
          "description": "关键词识别ID列表，默认空为不进行识别，最多10个",
          "example": "[\"sdsdasdasf\",\"asdfasdasd\"]",
          "item_type": "string"
        },
        {
          "name": "ReplaceTextId",
          "type": "string",
          "required": false,
          "description": "替换词汇表id, 适用于热词和自学习场景也无法解决的极端case词组, 会对识别结果强制替换。具体可参考配置控制台;强制替换功能可能会影响正常识别结果，请谨慎使用注意：本功能配置完成后，预计在10分钟后生效",
          "example": "26910027******d9fa530f9f39dcd35d8"
        },
        {
          "name": "SpeakerRoles",
          "type": "array",
          "required": false,
          "description": "开启角色分离能力配合SpeakerDiarization: 3 使用，ASR增值服务，仅可传入一组声纹信息进行角色认证，仅支持16k_zh_en引擎。需传入SpeakerRoleInfo数据组，确定说话人的角色信息，涉及RoleAudioUrl和RoleName两个参数。 RoleAudioUrl：需要认证角色的声纹音频地址，建议30s内的纯净人声，最长不能超过45s。 RoleName：需要认证角色的名称，若匹配成功，会替换话者分离中的SpeakerID。 示例： \u0026quot;{\"...",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "RoleAudioUrl",
              "type": "string",
              "required": true,
              "description": "音频url地址，建议不超过30秒，最大45秒",
              "example": "http://cosname.url"
            },
            {
              "name": "RoleName",
              "type": "string",
              "required": true,
              "description": "不超过30字节",
              "example": "角色名称"
            }
          ]
        }
      ],
      "required": [
        "EngineModelType",
        "ChannelNum",
        "ResTextFormat",
        "SourceType"
      ]
    },
    {
      "name": "DeleteAsrKeyWordLib",
      "description": "用户通过本接口进行关键词表的删除。",
      "status": "online",
      "parameters": [
        {
          "name": "KeyWordLibId",
          "type": "string",
          "required": true,
          "description": "关键词表ID",
          "example": "ed9d5b5a9fa14f4a86dc71360e6a3835"
        }
      ],
      "required": [
        "KeyWordLibId"
      ]
    },
    {
      "name": "DeleteAsrVocab",
      "description": "用户通过本接口进行热词表的删除。",
      "status": "online",
      "parameters": [
        {
          "name": "VocabId",
          "type": "string",
          "required": true,
          "description": "热词表Id",
          "example": "xcxdsada"
        }
      ],
      "required": [
        "VocabId"
      ]
    },
    {
      "name": "DeleteCustomization",
      "description": "用户通过该接口可以删除自学习模型",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "要删除的模型ID",
          "example": "sdsafjasj*****sdfasfjj"
        }
      ],
      "required": [
        "ModelId"
      ]
    },
    {
      "name": "DescribeAsyncRecognitionTasks",
      "description": "本接口用于查询当前在运行的语音流异步识别任务列表。 • 签名方法参考 [公共参数](https://cloud.tencent.com/document/api/1093/35640) 中签名方法v3。",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "DescribeTaskStatus",
      "description": "调用录音文件识别请求接口后，有回调和轮询两种方式获取识别结果。 • **注意任务有效期为24小时，超过24小时的任务请不要再查询，且不要依赖TaskId作为业务唯一ID，不同日期可能出现重复TaskId。** • 当采用回调方式时，识别完成后会将结果通过 POST 请求的形式通知到用户在请求时填写的回调 URL，具体请参见[ 录音识别结果回调 ](https://cloud.tencent.com/document/product/1093/52632)。...",
      "status": "online",
      "parameters": [
        {
          "name": "TaskId",
          "type": "integer",
          "required": true,
          "description": "从CreateRecTask接口获取的TaskId，用于获取任务状态与结果。 **注意：TaskId有效期为24小时，超过24小时的TaskId请不要再查询。**",
          "example": "4500055927"
        }
      ],
      "required": [
        "TaskId"
      ]
    },
    {
      "name": "DownloadAsrVocab",
      "description": "用户通过本接口进行热词表的下载，获得词表权重文件形式的 base64 值，文件形式为通过 “|” 分割的词和权重，即 word|weight 的形式。",
      "status": "online",
      "parameters": [
        {
          "name": "VocabId",
          "type": "string",
          "required": true,
          "description": "词表ID。",
          "example": "ssdasdasd"
        }
      ],
      "required": [
        "VocabId"
      ]
    },
    {
      "name": "DownloadCustomization",
      "description": "用户通过该接口可以下载自学习模型的语料",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "自学习模型ID",
          "example": "sdsafjasj*****sdfasfjj"
        }
      ],
      "required": [
        "ModelId"
      ]
    },
    {
      "name": "GetAsrKeyWordLibList",
      "description": "用户通过该接口，可获得所有的关键词表及其信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页Offset",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页Limit",
          "example": "10"
        },
        {
          "name": "SpecifyNames",
          "type": "array",
          "required": false,
          "description": "词库名称或者UIN检索",
          "example": "腾讯云",
          "item_type": "string"
        },
        {
          "name": "OnlySelf",
          "type": "boolean",
          "required": false,
          "description": "只看用户自己创建的",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "GetAsrVocab",
      "description": "用户根据词表的ID可以获取对应的热词表信息",
      "status": "online",
      "parameters": [
        {
          "name": "VocabId",
          "type": "string",
          "required": true,
          "description": "热词表ID",
          "example": "ashsdhsdshsjh"
        }
      ],
      "required": [
        "VocabId"
      ]
    },
    {
      "name": "GetAsrVocabList",
      "description": "用户通过该接口，可获得所有的热词表及其信息。",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页Offset",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页Limit",
          "example": "10"
        }
      ],
      "required": []
    },
    {
      "name": "GetCustomizationList",
      "description": "查询自学习模型列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页大小，默认1000",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页offset，默认0",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "GetModelInfo",
      "description": "通过自学习模型id获取自学习模型详细信息",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "模型id",
          "example": "sdsafjasj*****sdfasfjj"
        }
      ],
      "required": [
        "ModelId"
      ]
    },
    {
      "name": "GetUsageByDate",
      "description": "查询用户用量",
      "status": "online",
      "parameters": [
        {
          "name": "BizNameList",
          "type": "array",
          "required": true,
          "description": "需要查询的业务类型名字列表 - asr_rt 实时识别 - asr_rec 录音文件识别",
          "example": "[\"asr_rec\"]",
          "item_type": "string"
        },
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "查询开始时间 开始时间包含当天，支持 YYYY-MM-DD 日期以国内时区为准 开始时间到结束时间需要在3个月以内",
          "example": "2024-09-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "查询结束时间 结束时间包含当天，，支持 YYYY-MM-DD 日期以国内时区为准 开始时间到结束时间需要在3个月以内",
          "example": "2024-09-06"
        }
      ],
      "required": [
        "BizNameList",
        "StartDate",
        "EndDate"
      ]
    },
    {
      "name": "ModifyCustomization",
      "description": "用户通过该接口可以更新自学习模型，如模型名称、模型类型、模型语料。",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "要修改的模型ID",
          "example": "fsamdfiuh****xfdsgdsh"
        },
        {
          "name": "ModelName",
          "type": "string",
          "required": false,
          "description": "要修改的模型名称，长度需在1-20个字符之间",
          "example": "通用模型"
        },
        {
          "name": "ModelType",
          "type": "string",
          "required": false,
          "description": "要修改的模型类型，为8k或者16k",
          "example": "8k"
        },
        {
          "name": "TextUrl",
          "type": "string",
          "required": false,
          "description": "要修改的模型语料的下载地址，目前仅支持腾讯云cos",
          "example": "https://www.modle.com/model.txt"
        }
      ],
      "required": [
        "ModelId"
      ]
    },
    {
      "name": "ModifyCustomizationState",
      "description": "通过该接口，用户可以修改自学习模型状态，上下线自学习模型",
      "status": "online",
      "parameters": [
        {
          "name": "ModelId",
          "type": "string",
          "required": true,
          "description": "自学习模型ID",
          "example": "无"
        },
        {
          "name": "ToState",
          "type": "integer",
          "required": true,
          "description": "想要变换的模型状态，-1代表下线，1代表上线",
          "example": "无"
        }
      ],
      "required": [
        "ModelId",
        "ToState"
      ]
    },
    {
      "name": "SentenceRecognition",
      "description": "本接口用于对60秒之内的短音频文件进行识别。 • 支持中文普通话、英语、粤语、日语、越南语、马来语、印度尼西亚语、菲律宾语、泰语、葡萄牙语、土耳其语、阿拉伯语、印地语、法语、德语、上海话、四川话、武汉话、贵阳话、昆明话、西安话、郑州话、太原话、兰州话、银川话、西宁话、南京话、合肥话、南昌话、长沙话、苏州话、杭州话、济南话、天津话、石家庄\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "EngSerViceType",
          "type": "string",
          "required": true,
          "description": "引擎模型类型。 电话场景： • 8k_zh：中文电话通用； • 8k_en：英文电话通用； 非电话场景： • 16k_zh：中文通用； • 16k_zh-PY：中英粤; • 16k_zh_medical：中文医疗； • 16k_en：英语； • 16k_yue：粤语； • 16k_ja：日语； • 16k_ko：韩语； • 16k_vi：越南语； • 16k_ms：马来语； • 16k_id：印度尼西亚语； • 16k_fil：菲律宾语； • 16k_th：泰语； • 16k_pt：葡萄牙语； • 16k_tr：土耳\ufffd...",
          "example": "16k_en"
        },
        {
          "name": "SourceType",
          "type": "integer",
          "required": true,
          "description": "语音数据来源。0：语音 URL；1：语音数据（post body）。",
          "example": "1"
        },
        {
          "name": "VoiceFormat",
          "type": "string",
          "required": true,
          "description": "识别音频的音频格式，支持wav、pcm、ogg-opus、speex、silk、mp3、m4a、aac、amr。",
          "example": "wav"
        },
        {
          "name": "Url",
          "type": "string",
          "required": false,
          "description": "语音的URL地址，需要公网环境浏览器可下载。当 SourceType 值为 0时须填写该字段，为 1 时不填。音频时长不能超过60s，音频文件大小不能超过3MB。 注意：推荐使用 [腾讯云COS](https://cloud.tencent.com/document/product/436/38484) 来存储音频、生成URL并提交请求，此种方式会走内网下载音频，极大降低整体请求时延；并且不会产生外网和流量下行费用，可节约成本（COS桶权限需要设置公有读\ufffd...",
          "example": "http://test.voice.com/test.wav"
        },
        {
          "name": "Data",
          "type": "string",
          "required": false,
          "description": "语音数据，当SourceType 值为1（本地语音数据上传）时必须填写，当SourceType 值为0（语音 URL上传）可不写。要使用base64编码(采用python语言时注意读取文件应该为string而不是byte，以byte格式读取后要decode()。编码后的数据不可带有回车换行符)。音频时长不能超过60s，音频文件大小不能超过3MB（Base64后）。",
          "example": "dGVzdA=="
        },
        {
          "name": "DataLen",
          "type": "integer",
          "required": false,
          "description": "数据长度，单位为字节。当 SourceType 值为1（本地语音数据上传）时必须填写，当 SourceType 值为0（语音 URL上传）可不写（此数据长度为数据未进行base64编码时的数据长度）。",
          "example": "6400"
        },
        {
          "name": "WordInfo",
          "type": "integer",
          "required": false,
          "description": "是否显示词级别时间戳。0：不显示；1：显示，不包含标点时间戳，2：显示，包含标点时间戳。默认值为 0。",
          "example": "0"
        },
        {
          "name": "FilterDirty",
          "type": "integer",
          "required": false,
          "description": "是否过滤脏词（目前支持中文普通话引擎）。0：不过滤脏词；1：过滤脏词；2：将脏词替换为 * 。默认值为 0。",
          "example": "0"
        },
        {
          "name": "FilterModal",
          "type": "integer",
          "required": false,
          "description": "是否过滤语气词（目前支持中文普通话引擎）。0：不过滤语气词；1：部分过滤；2：严格过滤 。默认值为 0。",
          "example": "0"
        },
        {
          "name": "FilterPunc",
          "type": "integer",
          "required": false,
          "description": "是否过滤标点符号（目前支持中文普通话引擎）。 0：不过滤，1：过滤句末标点，2：过滤所有标点。默认值为 0。",
          "example": "0"
        },
        {
          "name": "ConvertNumMode",
          "type": "integer",
          "required": false,
          "description": "是否进行阿拉伯数字智能转换。0：不转换，直接输出中文数字，1：根据场景智能转换为阿拉伯数字。默认值为1。",
          "example": "0"
        },
        {
          "name": "HotwordId",
          "type": "string",
          "required": false,
          "description": "热词id。用于调用对应的热词表，如果在调用语音识别服务时，不进行单独的热词id设置，自动生效默认热词；如果进行了单独的热词id设置，那么将生效单独设置的热词id。",
          "example": "966ecea2a*****537c8"
        },
        {
          "name": "CustomizationId",
          "type": "string",
          "required": false,
          "description": "自学习模型 id。如设置了该参数，将生效对应的自学习模型。",
          "example": "966ecea******d537c8"
        },
        {
          "name": "HotwordList",
          "type": "string",
          "required": false,
          "description": "临时热词表：该参数用于提升识别准确率。 单个热词限制：\"热词|权重\"，单个热词不超过30个字符（最多10个汉字），权重1-11或者100，如：“腾讯云|5” 或 “ASR|11”； 临时热词表限制：多个热词用英文逗号分割，最多支持128个热词，如：“腾讯云|10,语音识别|5,ASR|11”； 参数 hotword_list（临时热词表） 与 hotword_id（热词表） 区别： hotword_id：热词表。需要先在控制台或接口创建...",
          "example": "腾讯云|10,语音识别|5,ASR|11"
        },
        {
          "name": "InputSampleRate",
          "type": "integer",
          "required": false,
          "description": "支持pcm格式的8k音频在与引擎采样率不匹配的情况下升采样到16k后识别，能有效提升识别准确率。仅支持：8000。如：传入 8000 ，则pcm音频采样率为8k，当引擎选用16k_zh， 那么该8k采样率的pcm音频可以在16k_zh引擎下正常识别。 注：此参数仅适用于pcm格式音频，不传入值将维持默认状态，即默认调用的引擎采样率等于pcm音频采样率。",
          "example": "0"
        },
        {
          "name": "ReplaceTextId",
          "type": "string",
          "required": false,
          "description": "替换词id。用于调用对应的替换词表。",
          "example": "976dfea2a*****537c8"
        }
      ],
      "required": [
        "EngSerViceType",
        "SourceType",
        "VoiceFormat"
      ]
    },
    {
      "name": "SetVocabState",
      "description": "用户通过该接口可以设置热词表的默认状态。初始状态为0，用户可设置状态为1，即为默认状态。默认状态表示用户在请求识别时，如不设置热词表ID，则默认使用状态为1的热词表。",
      "status": "online",
      "parameters": [
        {
          "name": "VocabId",
          "type": "string",
          "required": true,
          "description": "热词表ID。",
          "example": "dsadsdas"
        },
        {
          "name": "State",
          "type": "integer",
          "required": true,
          "description": "热词表状态，1：设为默认状态；0：设为非默认状态。",
          "example": "1"
        }
      ],
      "required": [
        "VocabId",
        "State"
      ]
    },
    {
      "name": "UpdateAsrKeyWordLib",
      "description": "用户通过本接口进行对应的关键词表信息更新。",
      "status": "online",
      "parameters": [
        {
          "name": "KeyWordLibId",
          "type": "string",
          "required": true,
          "description": "关键词表ID",
          "example": "aa6f402******2ea856fc81fbecfd0sd"
        },
        {
          "name": "Name",
          "type": "string",
          "required": true,
          "description": "词表名称，长度在1-20之间 仅限中英文数字-_",
          "example": "新的词表名称"
        },
        {
          "name": "KeyWordFile",
          "type": "string",
          "required": true,
          "description": "- 词文件（纯文本文件）以行分隔 ，进行二进制base64编码 - 格式要求：TXT 每行只有一个词，不满足格式则报错无法上传 - 每个词最多5个汉字或15个字符，单个词库最多不超过100个词 - 此参数为空则只更新词表名称",
          "example": "\u003c文件base64\u003e"
        }
      ],
      "required": [
        "KeyWordLibId",
        "Name",
        "KeyWordFile"
      ]
    },
    {
      "name": "UpdateAsrVocab",
      "description": "用户通过本接口进行对应的词表信息更新。",
      "status": "online",
      "parameters": [
        {
          "name": "VocabId",
          "type": "string",
          "required": true,
          "description": "热词表ID",
          "example": "aa6f402f263f12ea856fc81fbecfd0sd"
        },
        {
          "name": "Name",
          "type": "string",
          "required": false,
          "description": "热词表名称，长度在1-255之间",
          "example": "新的词表名称"
        },
        {
          "name": "WordWeights",
          "type": "array",
          "required": false,
          "description": "词权重数组，包含全部的热词和对应的权重。每个热词的长度不大于10个汉字或30个英文字符，权重为[1,11]之间整数或100，数组长度不大于1000 (注意：如果仅更新热词表名称或者描述字段，请求不用带本参数）",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Word",
              "type": "string",
              "required": true,
              "description": "热词 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "秘制"
            },
            {
              "name": "Weight",
              "type": "integer",
              "required": true,
              "description": "权重 注意：此字段可能返回 null，表示取不到有效值。",
              "example": "10"
            }
          ]
        },
        {
          "name": "WordWeightStr",
          "type": "string",
          "required": false,
          "description": "词权重文件（纯文本文件）的二进制base64编码，以行分隔，每行的格式为word|weight，即以英文符号|为分割，左边为词，右边为权重，如：你好|5。 当用户传此参数（参数长度大于0），即以此参数解析词权重，WordWeights会被忽略 (注意：如果仅更新热词表名称或者描述字段，请求不用带本参数）",
          "example": "蜜汁|10"
        },
        {
          "name": "Description",
          "type": "string",
          "required": false,
          "description": "热词表描述，长度在0-1000之间",
          "example": "新的词表描述"
        }
      ],
      "required": [
        "VocabId"
      ]
    },
    {
      "name": "VoicePrintCompare",
      "description": "通过比对两段音频内说话人的声纹，得到一个打分，可通过打分判断两段音频声纹相似度, 打分区间[0 - 100]。 音频要求：16k采样率， 16bit位深，pcm或者wav格式， 单声道，总时长不超过30秒的音频，base64编码数据大小不超过2M，音频内容只有一个说话人声音，并且尽可能清晰，这样结果更加准确。",
      "status": "online",
      "parameters": [
        {
          "name": "VoiceFormat",
          "type": "integer",
          "required": true,
          "description": "音频格式 0: pcm, 1: wav；pcm和wav音频无损压缩，识别准确度更高",
          "example": "0"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": true,
          "description": "音频采样率，目前仅支持16k，请填写16000",
          "example": "16000"
        },
        {
          "name": "SrcAudioData",
          "type": "string",
          "required": true,
          "description": "对比源音频数据, 音频要求：base64 编码,16k采样率， 16bit位深，pcm或者wav格式， 单声道，音频时长不超过30秒的音频，base64编码数据大小不超过2M",
          "example": "UklGRka1CQBXQVZFZm10zOjQzAABJU0ZUDgAAAE"
        },
        {
          "name": "DestAudioData",
          "type": "string",
          "required": true,
          "description": "对比目标音频数据, 音频要求：base64 编码,16k采样率， 16bit位深，pcm或者wav格式， 单声道，音频时长不超过30秒的音频，base64编码数据大小不超过2M",
          "example": "UklGRka1CQBXQVZFZm10zOjQzAABJU0ZUDgAAAE"
        }
      ],
      "required": [
        "VoiceFormat",
        "SampleRate",
        "SrcAudioData",
        "DestAudioData"
      ]
    },
    {
      "name": "VoicePrintCount",
      "description": "统计并返回注册的说话人id总数",
      "status": "online",
      "parameters": [
        {
          "name": "GroupId",
          "type": "string",
          "required": false,
          "description": "分组ID,仅支持大小写字母和下划线的组合，不超过128个字符",
          "example": "sdasf***dasdaffsasd"
        },
        {
          "name": "CountMod",
          "type": "integer",
          "required": false,
          "description": "统计模式 0: 统计所有声纹数量 1: 统计指定分组下的声纹数量",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "VoicePrintDelete",
      "description": "本接口用于以删除已经注册的说话人信息（删除之后，原有的说话人ID和说话人音频数据都会失效）",
      "status": "online",
      "parameters": [
        {
          "name": "VoicePrintId",
          "type": "string",
          "required": false,
          "description": "说话人id，说话人唯一标识",
          "example": "sdsafjasj*****sdfasfjj"
        },
        {
          "name": "GroupId",
          "type": "string",
          "required": false,
          "description": "说话人分组ID,仅支持大小写字母和下划线的组合，不超过128个字符",
          "example": "分组1"
        },
        {
          "name": "DelMod",
          "type": "integer",
          "required": false,
          "description": "删除模式: 0.默认值，删除该条声纹 1.从分组中删除该条声纹，声纹本身不删除 2.从声纹库中删除分组，仅删除分组信息，不会真正删除分组中的声纹",
          "example": "0"
        }
      ],
      "required": []
    },
    {
      "name": "VoicePrintEnroll",
      "description": "说话人注册接口用于注册一个指定音频，生成一个唯一的说话人id，后续可通过说话人验证接口验证其它音频和已有的说话人ID匹配度，注册时可指定说话人昵称，方便标识说话人ID， 说话人昵称可重复配置。 （注: 一个appid最多可以注册1000个说话人ID，一个说话人ID仅支持一条音频注册，后续可通过更新接口进行更新） 使用须知 支持的输入格式：编码文件(PCM, WAV)、16 bit采样位...",
      "status": "online",
      "parameters": [
        {
          "name": "VoiceFormat",
          "type": "integer",
          "required": true,
          "description": "音频格式 0: pcm, 1: wav",
          "example": "0"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": true,
          "description": "音频采样率，目前支持16000，单位：Hz，必填",
          "example": "16000"
        },
        {
          "name": "Data",
          "type": "string",
          "required": false,
          "description": "音频数据, base64 编码, 音频时长不能超过30s，数据大小不超过2M",
          "example": "UklGRka1CQBXQVZFZm10IBAAAAABAAEAgD4E"
        },
        {
          "name": "SpeakerNick",
          "type": "string",
          "required": false,
          "description": "说话人昵称 不超过32字节",
          "example": "李九州"
        },
        {
          "name": "GroupId",
          "type": "string",
          "required": false,
          "description": "分组id, 仅支持大小写字母和下划线的组合，不超过128个字符",
          "example": "group_A"
        },
        {
          "name": "AudioUrl",
          "type": "string",
          "required": false,
          "description": "声纹cos url 注意:仅支持腾讯云cos url 地址",
          "example": "\"https://xxx-test-xxx.cos.ap-nanjing.myqcloud.com/%E5%A3%Bxxxxx%E6%8D%AE/xxxx.mp3\""
        }
      ],
      "required": [
        "VoiceFormat",
        "SampleRate"
      ]
    },
    {
      "name": "VoicePrintGroupVerify",
      "description": "说话人验证1:N接口，可以通过传入一段说话人音频，并且指定已存在的groupId, 和返回topN, 接口返回groupId内所有声纹和传入音频声纹比对打分TopN的结果。",
      "status": "online",
      "parameters": [
        {
          "name": "VoiceFormat",
          "type": "integer",
          "required": true,
          "description": "音频格式 0: pcm, 1: wav",
          "example": "0"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": true,
          "description": "音频采样率，目前支持16000，单位：Hz，必填",
          "example": "16000"
        },
        {
          "name": "Data",
          "type": "string",
          "required": true,
          "description": "音频数据, base64 编码, 音频时长不能超过30s，数据大小不超过2M",
          "example": "UklGRka1CQBXQVZFZm10zOjQzAABJU0ZUDgAAAE*"
        },
        {
          "name": "GroupId",
          "type": "string",
          "required": true,
          "description": "分组id, 支持数字，字母，下划线，长度不超过128",
          "example": "home_group"
        },
        {
          "name": "TopN",
          "type": "integer",
          "required": true,
          "description": "返回打分结果降序排列topN, TopN大于0， 小于可创建声纹最大数量",
          "example": "1"
        }
      ],
      "required": [
        "VoiceFormat",
        "SampleRate",
        "Data",
        "GroupId",
        "TopN"
      ]
    },
    {
      "name": "VoicePrintUpdate",
      "description": "本接口用于更新和覆盖已注册的音频数据和说话人昵称，更新后原有的音频数据将失效。",
      "status": "online",
      "parameters": [
        {
          "name": "VoiceFormat",
          "type": "integer",
          "required": true,
          "description": "音频格式 0: pcm, 1: wav",
          "example": "0"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": true,
          "description": "音频采样率 目前仅支持16000 单位Hz",
          "example": "16000"
        },
        {
          "name": "VoicePrintId",
          "type": "string",
          "required": true,
          "description": "说话人id， 说话人唯一标识",
          "example": "sdsafjasj*****sdfasfjj"
        },
        {
          "name": "Data",
          "type": "string",
          "required": false,
          "description": "音频数据, base64 编码, 音频时长不能超过30s，数据大小不超过2M",
          "example": "ADDAFASAFASA"
        },
        {
          "name": "SpeakerNick",
          "type": "string",
          "required": false,
          "description": "说话人昵称 不超过32字节",
          "example": "小明"
        },
        {
          "name": "AudioUrl",
          "type": "string",
          "required": false,
          "description": "声纹cos url 注意:仅支持腾讯云cos url 地址",
          "example": "https://adison-testxxxx.cos.ap-nanjing.myqcloud.com/%E5%xx%B0%E7xxx%BA%B9%E6%95%B0%E6%8D%AE/xxxx.wav"
        }
      ],
      "required": [
        "VoiceFormat",
        "SampleRate",
        "VoicePrintId"
      ]
    },
    {
      "name": "VoicePrintVerify",
      "description": "本接口用于校验传入音频与已注册音频的匹配程度，通过指定说话人ID（VoicePrintId）和一段音频进行音频和说话人的匹配度判断",
      "status": "online",
      "parameters": [
        {
          "name": "VoiceFormat",
          "type": "integer",
          "required": true,
          "description": "音频格式 0: pcm, 1: wav",
          "example": "0"
        },
        {
          "name": "SampleRate",
          "type": "integer",
          "required": true,
          "description": "音频采样率，目前支持16000，单位：Hz，必填",
          "example": "16000"
        },
        {
          "name": "VoicePrintId",
          "type": "string",
          "required": true,
          "description": "说话人id, 说话人唯一标识",
          "example": "dasdagfd****sdsada"
        },
        {
          "name": "Data",
          "type": "string",
          "required": false,
          "description": "音频数据, base64 编码, 音频时长不能超过30s，数据大小不超过2M",
          "example": "ADKFG****ALDHASG"
        },
        {
          "name": "AudioUrl",
          "type": "string",
          "required": false,
          "description": "声纹cos url 注意:仅支持腾讯云cos url 地址",
          "example": "https://xxxxtest-xxxx.cos.ap-nanjing.myqcloud.com/%E5%A3%B0%E7%BA%B9%E6%95%xxxxxD%AE/test.wav"
        }
      ],
      "required": [
        "VoiceFormat",
        "SampleRate",
        "VoicePrintId"
      ]
    }
  ]
}