Music ASR

功能介绍

歌词识别，可以识别出演唱音频中被唱的歌词。输入音频（推荐 MP3、WAV），输出歌词文本及其出现的时间

接口说明

请求方式： POST（HTTP）

请求地址： http://service-mqk0mc83-1257411467.bj.apigw.tencentcs.com/release/job

请求头： Content-Type: application/json

请求流程： 接口包括‘创建任务’，‘查询任务’。创建任务后，用户可以主动查询任务来知晓任务结果，也可以在创建任务时输入回调地址（callback），则任务在完成后会自动回调该地址

创建任务

参数说明

参数	是否必选	类型	说明
action	是	string	公共参数，此处为 CreateJob
secretId	是	string	公共参数，用户 SecretId
secretKey	是	string	公共参数，用户 secretKey
createJobRequest	是	object
- inputs	是	Array of Input	Input，输入结构体数组
- outputs	是	Array of Output	Output，输出结构体数组
- callback	否	string	回调地址，默认：不开启回调
- customId	否	string	用户自定义任务 ID，小于 64 字符
- timeout	否	int	任务超时时间，单位秒。超过超时时间后任务会被置为 ERROR

Input

参数	是否必选	类型	说明
url	否	string	源 url 地址，与 source 字段二选一填写
source	否	object	仓库源设置，与 url 字段二选一填写
- contentId	是	string	仓库 ID
- path	是	string	源路径

Output

参数	是否必选	类型	说明
inputSelectors	是	Array of int	该输出的输入源
smartContentDescriptor	是	SmartContentDescriptor	智能能力的描述，默认：空
- musicASR	是	object	歌词识别
-- confidence	是	float	置信度，范围 0~1。模型输出置信度大于这个阈值才会输出结果

请求示例：

{
  "action": "CreateJob",
  "secretId": "{secretId}",
  "secretKey": "{secretKey}",
  "createJobRequest": {
    "customId": "{customId}",
    "callback": "{callback}",
    "inputs": [
      {
        "url": "{url}"
      }
    ],
    "outputs": [
      {
        "inputSelectors": [0],
        "smartContentDescriptor": {
          "musicASR": {
            "confidence": 0.2
          }
        }
      }
    ]
  }
}

返回示例：

{
  "requestId": "ac004192-110b-46e3-ade8-4e449df84d60",
  "createJobResponse": {
    "job": {
      "id": "13f342e4-6866-450e-b44e-3151431c578b",
      "state": 1, // 见下方state说明
      "customId": "{customId}",
      "callback": "{callback}",
      "inputs": [{ "url": "{url}" }],
      "outputs": [
        {
          "inputSelectors": [0],
          "smartContentDescriptor": {
            "musicASR": {
              "confidence": 0.20000000298023224
            }
          }
        }
      ],
      "timing": {
        "createdAt": "1603432763000",
        "startedAt": "0",
        "completedAt": "0"
      }
    }
  }
}

State

值	含义
1	SUBMITTED
2	PROCESSING
3	COMPLETED
4	ERROR
5	CANCELED

获取任务信息

获取方式：分为主动获取和被动回调。

主动获取按照 id 的类别有两种查询接口，一种是根据用户自定义 id 查询，由于平台无法保证该 id 的唯一性，故返回 Job 数组（见 1）；另一种是通过创建任务后的回包中的 id 查询（见 2）
被动回调需要在创建任务时填写 callback 字段，平台在任务进入完成态（COMPLETED/ERROR）后会将 Job 结构体发送给 callback 所指的地址（见 3），平台方推荐使用被动回调的方式获取任务结果。

在歌词识别能力中，如果查询到的任务成功（state=3），则任务的 Output 中会携带 smartContentResult 结构体，其中的 musicASR 为结果数组。数组中每个元素即算法识别出的文字信息

返回 musicASR 字段说明

参数	类型	说明
text	string	识别出的文字内容
startTime	string	开始时间
endTime	string	结束时间
conf	string	置信度

1. 主动查询，根据用户在新建任务时传入的自定义 customId 请求示例：

{
  "action": "ListJobs",
  "secretId": "{secretId}",
  "secretKey": "{secretKey}",
  "listJobsRequest": {
    "customId": "{customId}"
  }
}

返回示例：

{
  "requestId": "c9845a99-34e3-4b0f-80f5-f0a2a0ee8896",
  "listJobsResponse": {
    "jobs": [
        {
            "id": "a95e9d74-6602-4405-a3fc-6408a76bcc98",
            "state": 3,
            "customId": "{customId}",
            "callback": "{callback}",
            "timing": {
                "createdAt": "1610513575000",
                "startedAt": "1610513575000",
                "completedAt": "1610513618000"
            },
            "inputs": [ { "url": "{url}" } ],
            "outputs": [
                {
                  "inputSelectors": [ 0 ],
                  "smartContentDescriptor": {
                      "musicASR": {
                        "confidence": 0.20000000298023224
                      }
                  },
                  "smartContentResult": {
                      "musicASR": [
                        {
                          "text": "天空",
                          "startTime": "25.2",
                          "endTime": "28.8"
                          "conf": "0.8"
                        }
                      ]
                  }
                }
            ]
        }
    ],
    "total": 1
  }
}

2. 主动查询，根据新建任务时回包带的 id 请求示例：

{
  "action": "GetJob",
  "secretId": "{secretId}",
  "secretKey": "{secretKey}",
  "getJobRequest": {
    "id": "{id}"
  }
}

返回示例：

{
  "requestId": "c9845a99-34e3-4b0f-80f5-f0a2a0ee8896",
  "getJobResponse": {
    "job": {
        "id": "a95e9d74-6602-4405-a3fc-6408a76bcc98",
        "state": 3,
        "customId": "{customId}",
        "callback": "{callback}",
        "timing": {
          "createdAt": "1610513575000",
          "startedAt": "1610513575000",
          "completedAt": "1610513618000"
        },
        "inputs": [ { "url": "{url}" } ],
        "outputs": [
            {
              "inputSelectors": [ 0 ],
              "smartContentDescriptor": {
                  "musicASR": {
                    "confidence": 0.20000000298023224
                  }
              },
              "smartContentResult": {
                  "musicASR": [
                      {
                        "text": "天空",
                        "startTime": "25.2",
                        "endTime": "28.8"
                        "conf": "0.8"
                      }
                  ]
                }
            }
        ]
    }
  }
}

3. 被动回调

会将进入完成态（COMPLETED/ERROR）的任务的整个 Job 结构体发送到用户在创建任务时指定的 callback 字段对应的地址，Job 结构体见主动查询的示例（getJobResponse 下）