声音分类API调用文档
更新时间：2024-01-25
接口描述
声音分类模型完成模型发布后可以获得定制的声音分类API，实现基于定制的声音分类模型，调用API输入15s以内的音频数据，返回自定义的分类结果。
接口鉴权
创建应用
进入EasyDL控制台概览页，在已上线的定制接口下，可以看到已发布上线的声音分类API。在正式调用之前，首先点击创建应用，定义应用名称、应用类型、应用描述等信息，完成应用创建。
应用创建后，在应用详情页获取API Key、Secret Key。
请求说明
请求示例
HTTP 方法：POST
请求URL： 请在应用详情页面获取接口地址，与发布模型时定义的url一致。
URL参数：
| 参数 | 值 |
|---|---|
| access_token | 通过API Key和Secret Key获取的access_token,参考“Access Token获取” |
Header如下：
| 参数 | 值 |
|---|---|
| Content-Type | application/json |
Body请求示例：
Plain Text
1{
2 "sound": "<base64数据>",
3 "top_num": 6
4}Body中放置请求参数，参数详情如下：
请求参数
| 参数 | 是否必选 | 类型 | 可选值范围 | 说明 |
|---|---|---|---|---|
| sound | 是 | string | - | 音频，base64编码，要求base64编码后大小不超过4M，支持mp3、m4a、wav格式，单个文件时间长度不超过15s 注意需要去掉编码头后再进行urlencode。 |
| top_num | 否 | number | - | 返回分类数量，默认为6个 |
请求代码示例
提示一：使用示例代码前，请记得替换其中的示例Token、音频地址或Base64信息。
提示二：部分语言依赖的类或库，请在代码注释中查看下载地址。
PHP代码示例
Plain Text
1<?php
2/**
3 * 发起http post请求(REST API), 并获取REST请求的结果
4 * @param string $url
5 * @param string $param
6 * @return - http response body if succeeds, else false.
7 */
8function request_post($url = '', $param = '')
9{
10 if (empty($url) || empty($param)) {
11 return false;
12 }
13
14 $postUrl = $url;
15 $curlPost = $param;
16 // 初始化curl
17 $curl = curl_init();
18 curl_setopt($curl, CURLOPT_URL, $postUrl);
19 curl_setopt($curl, CURLOPT_HEADER, 0);
20 // 要求结果为字符串且输出到屏幕上
21 curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);
22 curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
23 // post提交方式
24 curl_setopt($curl, CURLOPT_POST, 1);
25 curl_setopt($curl, CURLOPT_POSTFIELDS, $curlPost);
26 // 运行curl
27 $data = curl_exec($curl);
28 curl_close($curl);
29
30 return $data;
31}
32
33$token = '[调用鉴权接口获取的token]';
34$url = '【接口地址】?access_token=' . $token;
35$bodys = "{\"sound\":\"sfasq35sadvsvqwr5q...\"}"
36$res = request_post($url, $bodys);
37
38var_dump($res);Python3代码示例
Python3
1"""
2EasyDL 声音分类 调用模型公有云API Python3实现
3"""
4
5import json
6import base64
7import requests
8"""
9使用 requests 库发送请求
10使用 pip（或者 pip3）检查我的 python3 环境是否安装了该库，执行命令
11 pip freeze | grep requests
12若返回值为空，则安装该库
13 pip install requests
14"""
15
16
17# 目标音频的 本地文件路径，支持mp3/m4a/wav格式
18SOUND_FILEPATH = "【您的测试音频地址，例如./example.mp3】"
19
20# 可选的请求参数
21# top_num: 返回的分类数量，不声明的话默认为 6 个
22PARAMS = {"top_num": 3}
23
24# 服务详情 中的 接口地址
25MODEL_API_URL = "【您的API地址】"
26
27# 调用 API 需要 ACCESS_TOKEN。若已有 ACCESS_TOKEN 则于下方填入该字符串
28# 否则，留空 ACCESS_TOKEN，于下方填入 该模型部署的 API_KEY 以及 SECRET_KEY，会自动申请并显示新 ACCESS_TOKEN
29ACCESS_TOKEN = "【您的ACCESS_TOKEN】"
30API_KEY = "【您的API_KEY】"
31SECRET_KEY = "【您的SECRET_KEY】"
32
33
34print("1. 读取目标音频 '{}'".format(SOUND_FILEPATH))
35with open(SOUND_FILEPATH, 'rb') as f:
36 base64_data = base64.b64encode(f.read())
37 base64_str = base64_data.decode('UTF8')
38print("将 BASE64 编码后音频的字符串填入 PARAMS 的 'sound' 字段")
39PARAMS["sound"] = base64_str
40
41
42if not ACCESS_TOKEN:
43 print("2. ACCESS_TOKEN 为空，调用鉴权接口获取TOKEN")
44 auth_url = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials"\
45 "&client_id={}&client_secret={}".format(API_KEY, SECRET_KEY)
46 auth_resp = requests.get(auth_url)
47 auth_resp_json = auth_resp.json()
48 ACCESS_TOKEN = auth_resp_json["access_token"]
49 print("新 ACCESS_TOKEN: {}".format(ACCESS_TOKEN))
50else:
51 print("2. 使用已有 ACCESS_TOKEN")
52
53
54print("3. 向模型接口 'MODEL_API_URL' 发送请求")
55request_url = "{}?access_token={}".format(MODEL_API_URL, ACCESS_TOKEN)
56response = requests.post(url=request_url, json=PARAMS)
57response_json = response.json()
58response_str = json.dumps(response_json, indent=4, ensure_ascii=False)
59print("结果:\n{}".format(response_str))JAVA代码示例
Plain Text
1package com.baidu.ai.aip;
2
3import com.baidu.ai.aip.utils.HttpUtil;
4import com.baidu.ai.aip.utils.GsonUtils;
5
6import java.util.*;
7
8/**
9* easydl声音分类
10*/
11public class EasydlSoundClassify {
12
13 /**
14 * 重要提示代码中所需工具类
15 * FileUtil,Base64Util,HttpUtil,GsonUtils请从
16 * https://ai.baidu.com/file/658A35ABAB2D404FBF903F64D47C1F72
17 * https://ai.baidu.com/file/C8D81F3301E24D2892968F09AE1AD6E2
18 * https://ai.baidu.com/file/544D677F5D4E4F17B4122FBD60DB82B3
19 * https://ai.baidu.com/file/470B3ACCA3FE43788B5A963BF0B625F3
20 * 下载
21 */
22 public static String easydlSoundClassify() {
23 // 请求url
24 String url = "【接口地址】";
25 try {
26 Map<String, Object> map = new HashMap<>();
27 map.put("sound", "sfasq35sadvsvqwr5q...");
28
29 String param = GsonUtils.toJson(map);
30
31 // 注意这里仅为了简化编码每一次请求都去获取access_token，线上环境access_token有过期时间， 客户端可自行缓存，过期后重新获取。
32 String accessToken = "[调用鉴权接口获取的token]";
33
34 String result = HttpUtil.post(url, accessToken, "application/json", param);
35 System.out.println(result);
36 return result;
37 } catch (Exception e) {
38 e.printStackTrace();
39 }
40 return null;
41 }
42
43 public static void main(String[] args) {
44 EasydlSoundClassify.easydlSoundClassify();
45 }
46}C++代码示例
Plain Text
1#include <iostream>
2#include <curl/curl.h>
3
4// libcurl库下载链接：https://curl.haxx.se/download.html
5// jsoncpp库下载链接：https://github.com/open-source-parsers/jsoncpp/
6const static std::string request_url = "【接口地址】";
7static std::string easydlSoundClassify_result;
8/**
9 * curl发送http请求调用的回调函数，回调函数中对返回的json格式的body进行了解析，解析结果储存在全局的静态变量当中
10 * @param 参数定义见libcurl文档
11 * @return 返回值定义见libcurl文档
12 */
13static size_t callback(void *ptr, size_t size, size_t nmemb, void *stream) {
14 // 获取到的body存放在ptr中，先将其转换为string格式
15 easydlSoundClassify_result = std::string((char *) ptr, size * nmemb);
16 return size * nmemb;
17}
18/**
19 * easydl声音分类
20 * @return 调用成功返回0，发生错误返回其他错误码
21 */
22int easydlSoundClassify(std::string &json_result, const std::string &access_token) {
23 std::string url = request_url + "?access_token=" + access_token;
24 CURL *curl = NULL;
25 CURLcode result_code;
26 int is_success;
27 curl = curl_easy_init();
28 if (curl) {
29 curl_easy_setopt(curl, CURLOPT_URL, url.data());
30 curl_easy_setopt(curl, CURLOPT_POST, 1);
31 curl_slist *headers = NULL;
32 headers = curl_slist_append(headers, "Content-Type:application/json;charset=UTF-8");
33 curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);
34 curl_easy_setopt(curl, CURLOPT_POSTFIELDS, "{\"sound\":\"sfasq35sadvsvqwr5q...\"}");
35 result_code = curl_easy_perform(curl);
36 if (result_code != CURLE_OK) {
37 fprintf(stderr, "curl_easy_perform() failed: %s\n",
38 curl_easy_strerror(result_code));
39 is_success = 1;
40 return is_success;
41 }
42 json_result = easydlSoundClassify_result;
43 curl_easy_cleanup(curl);
44 is_success = 0;
45 } else {
46 fprintf(stderr, "curl_easy_init() failed.");
47 is_success = 1;
48 }
49 return is_success;
50}返回说明
返回参数
| 字段 | 是否必选 | 类型 | 说明 |
|---|---|---|---|
| log_id | 是 | number | 唯一的log id，用于问题定位 |
| results | 否 | array(object) | 分类结果数组 |
| +name | 否 | string | 分类名称 |
| +score | 否 | number | 置信度 |
在线调试
EasyDL零基础开发平台提供了 示例代码中心(API调试平台)-示例代码 ，用于帮助开发者在线调试接口，查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用。
错误码
若请求错误，服务器将返回的JSON文本包含以下参数：
- error_code：错误码。
- error_msg：错误描述信息，帮助理解和解决发生的错误。
例如Access Token失效返回：
Plain Text
1{
2 "error_code": 110,
3 "error_msg": "Access token invalid or no longer valid"
4}需要重新获取新的Access Token再次请求即可。
| 错误码 | 错误信息 | 描述 |
|---|---|---|
| 1 | Unknown error | 服务器内部错误，请再次请求， 如果持续出现此类错误，请在百度云控制台内提交工单反馈。 |
| 2 | Service temporarily unavailable | 服务暂不可用，请再次请求， 如果持续出现此类错误，请在百度云控制台内提交工单反馈。 |
| 3 | Unsupported openapi method | 调用的API不存在，请检查后重新尝试 |
| 4 | Open api request limit reached | 集群超限额 |
| 6 | No permission to access data | 无权限访问该用户数据 |
| 13 | Get service token failed | 获取token失败 |
| 14 | IAM Certification failed | IAM鉴权失败 |
| 15 | app not exists or create failed | 应用不存在或者创建失败 |
| 17 | Open api daily request limit reached | 每天请求量超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请在百度云控制台内提交工单反馈 |
| 18 | Open api qps request limit reached | QPS超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请在百度云控制台内提交工单反馈 |
| 19 | Open api total request limit reached | 请求总量超限额，已上线计费的接口，请直接在控制台开通计费，调用量不受限制，按调用量阶梯计费；未上线计费的接口，请在百度云控制台内提交工单反馈 |
| 100 | Invalid parameter | 无效的access_token参数，请检查后重新尝试 |
| 110 | Access token invalid or no longer valid | access_token无效 |
| 111 | Access token expired | access token过期 |
| 336000 | Internal error | 服务器内部错误，请再次请求， 如果持续出现此类错误，请在百度云控制台内提交工单反馈 |
| 336001 | Invalid Argument | 入参格式有误，比如缺少必要参数、图片base64编码错误等等，可检查下图片编码、代码格式是否有误。有疑问请在百度云控制台内提交工单反馈 |
| 336002 | JSON不合法 | 入参格式或调用方式有误，比如缺少必要参数或代码格式有误。有疑问请在百度云控制台内提交工单反馈 |
| 336003 | Base64解码失败 | 图片/音频/文本格式有误或base64编码有误，请根据接口文档检查格式，base64编码请求时注意要去掉头部。有疑问请在百度云控制台内提交工单反馈 |
| 336004 | 输入文件大小不合法 | 音频大小超出限制，请根据接口文档检查入参格式，音频文件大小应控制在4M以内，有疑问请在百度云控制台内提交工单反馈 |
| 336005 | 音频解码失败 | 音频解码失败失败，音频文件非所限定的mp3, m4a, wav格式 |
| 336006 | 缺失必要参数 | 未上传音频文件，请补充必要参数后重新请求 |
| 336100 | model temporarily unavailable | 遇到该错误码请等待1分钟后再次请求，可恢复正常，若反复重试依然报错或有疑问请在百度云控制台内提交工单反馈 |