体验中心
体验中国电信星辰大模型效果
API Path
/aipaas/voice/v1/keywordcqfy/detection
请求协议
WS
建立连接时的请求参数(websocket open):
请求头部:
| 头部标签 | 必填 | 说明 | 类型 | 数据字典 | 限制 | 头部内容 | 示例 |
|---|---|---|---|---|---|---|---|
| Content-Type | 是 | application/json | [string] | application/json | application/json | ||
| X-APP-ID | 是 | 买家中心-已购能力-【X-APP-ID】 | [string] | ||||
| Device-Uuid | 否 | 设备管理-设备uuid | [string] | ||||
| Authorization | 是 | 鉴权信息 | [string] |
请求参数 Json:
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| req_id | 请求ID,记录该值便于排查问题,建议传入 | 否 | [string] | det_status 为0 传递 | ||
| det_status | 0:开始检测 1 :发送语音数据 2:结束发送语音数据 | 是 | [int] | det_status 为2 只传递该参数 | ||
| kw_list | 关键词列表,格式:["keyword1", "keyword2", ...]" | 是 | [array] | det_status 为0 传递 | ||
| sample_rate | 音频采样率,默认值16000Hz,支持常见音频采样率:8000 Hz、16000 Hz、24000 Hz、32000 Hz、44100 Hz、48000 Hz | 否 | [int] | det_status 为0 传递 | ||
| num_channels | 输入音频数据的通道数,默认值是 1,当前仅支持单通道音 | 否 | [int] | det_status 为0 传递 | ||
| audio_stream | 语⾳数据,经过 base64 编码 | 是 | [string] | det_status 为1 传递 | ||
| threshold | 阈值,默认使用yaml中配置,取值[-10, 0],建议[-2.3, -1.2],值越小,越容易出关键字 | 否 | [float] |
返回结果
> 成功 (200)
> Json
> Object
| 参数名 | 说明 | 必填 | 类型 | 数据字典 | 限制 | 示例 |
|---|---|---|---|---|---|---|
| status | 状态码,⻅服务码说明 | 是 | [int] | |||
| status_msg | 状态说明,⻅服务码说明 | 是 | [string] | |||
| code | 状态码,见服务码说明 | 是 | [int] | |||
| message | 状态说明,见服务码说明 | 是 | [string] | |||
| sid | 会话全局唯⼀ id,⽤于记录本次会话 | 是 | [string] | |||
| result | det_status传0时类型为object,det_status传1时类型为List | 是 | [object] | |||
| result>>status | 0:开始检测,2:结束检测 | 否 | [int] | |||
| result>>end_time | 关键词结束时间戳,单位:ms ,det_status传1时返回 | 否 | [int] | |||
| result>>begin_time | 关键词开始时间戳,单位:ms,det_status传1时返回 | 否 | [int] | |||
| result>>kw | 关键词,det_status传1时返回 | 否 | [string] |
关键词检测主要任务是检测⾳频中的关键词,并标注出关键词的起⽌时间,支持单通道 pcm_s16le编码的音频识别。
服务接口调用时需要严格遵循服务鉴权规则,服务调用鉴权规则请参见:开发指南 - 签名认证方式。
| 返回码 | 解释 | 说明 | 解决⽅法 |
|---|---|---|---|
| 10301 | Required parametermiss | 必填参数缺失 | 检查请求体是否符合接⼝协议 |
| 10302 | Too many requests | 并发请求过多 | 联系商务,增加并发 |
| 10304 | Parse request body fail | 请求格式错误 | 查看请求的 URL body 格式是否正确,参考接⼝⽂档 |
| 10503 | Server connection timeout | 服务连接超时 | 联系技术⼈员 |
| 10903 | Detect failed | 检测失败 | 联系技术⼈员 |
| 10002 | Session not found | 会话id查询失败 | 检查客户端发送的请求,通常是因为没有发送开始识别请求 |
| 10004 | Duplicated session id | 会话id重复 | 检查客户端发送的请求,通常是因为发送2之后发送0导致 |
| 10006 | unknown error | 未知错误 | 联系研发人员进行排查 |
| 10000 | Success | 成功 | 执⾏下⼀步操作 |
通用状态码请参考【状态码】中的【网关认证】
(1) 开始检测请求(det_status =0 )
{
"req_id": "YXBpX2tleT0ia2V5eHh4eHh",
"det_status": 0,
"kw_list": ["查询话费 ", "查询套餐 "]
}
(2) 发送语音数据(det_status =1 )
{
"det_status": 1,
"audio_stream": ""
}
(3)结束发送语音数据(det_status =2 )
{
"det_status": 2,
}
import com.alibaba.fastjson.JSONObject;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.handshake.ServerHandshake;
import org.springframework.http.HttpMethod;
import java.net.URI;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.*;
/**
* 为保证示例可以正常运行,请确认maven中是否存在以下依赖:
*
* org.java-websocket
* Java-WebSocket
* 1.5.3
*
*
* com.alibaba
* fastjson
* 2.0.49
*
*/
public class WebSocketExample extends WebSocketClient {
public WebSocketExample(URI serverUri, Map headers) {
super(serverUri, headers);
}
public static void main(String[] args) {
try {
// 创建WebSocket客户端
URI uri = new URI("算法调用地址");
Map headers = new HashMap();
//调用鉴权
headers.put("Content-Type", "application/json");
headers.put("X-APP-ID", "yourAppId");
headers.put("Authorization", "yourAuthorization");
WebSocketExample client = new WebSocketExample(uri, headers);
client.connect();
// 等待一段时间后关闭连接
Thread.sleep(5000);
client.close();
} catch (URISyntaxException | InterruptedException e) {
e.printStackTrace();
System.out.println("WebSocket error: " + e.getMessage());
}
}
@Override
public void onOpen(ServerHandshake handshakedata) {
System.out.println("WebSocket connection opened");
// 发送消息
try {
// 初始化连接消息
JSONObject initSend = new JSONObject();
initSend.put("req_id", "abe36140-bc13-441f-81f9-6700fe7a5e96");
initSend.put("det_status", 0);
initSend.put("kw_list", Arrays.asList("查询话费","查询套餐"));
send(initSend.toJSONString());
// 发送音频文件base64
JSONObject audioSend = new JSONObject();
String audioFilePath = "音频文件路径";
// 读取音频文件的字节
byte[] audioBytes = Files.readAllBytes(Paths.get(audioFilePath));
List chunkedList = chunkByteArray(audioBytes, 400);
// 将字节转换为Base64编码的字符串
for (byte[] chunked : chunkedList) {
String base64 = Base64.getEncoder().encodeToString(chunked);
audioSend.put("rec_status", 1);
audioSend.put("audio_stream", base64);
send(audioSend.toJSONString());
}
// 发送结束消息
JSONObject endSend = new JSONObject();
endSend.put("rec_status", 2);
send(endSend.toJSONString());
} catch (Exception e) {
e.printStackTrace();
}
}
@Override
public void onMessage(String message) {
System.out.println("Received message: " + message);
}
@Override
public void onClose(int code, String reason, boolean remote) {
System.out.println("WebSocket connection closed: " + reason);
}
@Override
public void onError(Exception ex) {
System.err.println("WebSocket error: " + ex.getMessage());
}
/**
* 将byte数组按照指定长度截断并存放在list中
*
* @param originalArray 原始byte数组
* @param chunkSize 每个截断部分的长度
* @return 包含截断后byte数组的list
*/
public static List chunkByteArray(byte[] originalArray, int chunkSize) {
List chunkedList = new ArrayList();
if (originalArray == null || chunkSize