@baishuyun/chat-backend 0.0.18 → 0.0.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/config/default.ts +13 -5
  3. package/dist/config/default.js +12 -5
  4. package/dist/src/app/main.js +9 -0
  5. package/dist/src/config/hono.config.js +2 -1
  6. package/dist/src/const/error_code.js +3 -0
  7. package/dist/src/controllers/agent/bots.controller.js +1 -1
  8. package/dist/src/controllers/common/connect.controll.js +4 -2
  9. package/dist/src/controllers/common/model.js +2 -0
  10. package/dist/src/controllers/common/transformer-factory/agent-calling-listener.js +44 -0
  11. package/dist/src/controllers/form/attachment-upload.controller.js +15 -15
  12. package/dist/src/controllers/form/build/build.controller.js +3 -2
  13. package/dist/src/controllers/form/conversation/clear.controller.js +6 -6
  14. package/dist/src/controllers/form/fill/batch-fill.controller.js +3 -4
  15. package/dist/src/controllers/form/fill/createBatchFillingTransformStream.js +1 -17
  16. package/dist/src/controllers/form/fill/fill.controller.js +2 -1
  17. package/dist/src/controllers/form/fill/utils.js +16 -0
  18. package/dist/src/controllers/report/query/query.controller.js +1 -1
  19. package/dist/src/middleware/botRouter.js +34 -0
  20. package/dist/src/routes/common/common.route.js +2 -1
  21. package/dist/src/services/asr/asr-websocket.js +183 -0
  22. package/dist/src/services/asr/volc-protocol.js +143 -0
  23. package/dist/src/services/fetchCozeInfo.js +1 -1
  24. package/dist/src/utils/createFakeUIMessageStreamResponse.js +25 -0
  25. package/dist/src/utils/createJsonStreamTransformer.js +17 -2
  26. package/dist/src/utils/createSpecialPartMeta.js +5 -0
  27. package/package.json +7 -5
  28. package/src/app/main.ts +12 -0
  29. package/src/config/hono.config.ts +2 -1
  30. package/src/const/error_code.ts +3 -0
  31. package/src/controllers/agent/bots.controller.ts +1 -1
  32. package/src/controllers/common/connect.controll.ts +5 -2
  33. package/src/controllers/common/model.ts +2 -0
  34. package/src/controllers/common/transformer-factory/agent-calling-listener.ts +69 -0
  35. package/src/controllers/form/attachment-upload.controller.ts +16 -15
  36. package/src/controllers/form/build/build.controller.ts +5 -2
  37. package/src/controllers/form/conversation/clear.controller.ts +12 -15
  38. package/src/controllers/form/fill/batch-fill.controller.ts +3 -5
  39. package/src/controllers/form/fill/createBatchFillingTransformStream.ts +1 -20
  40. package/src/controllers/form/fill/fill.controller.ts +3 -1
  41. package/src/controllers/form/fill/utils.ts +18 -0
  42. package/src/controllers/report/query/query.controller.ts +1 -1
  43. package/src/middleware/botRouter.ts +41 -0
  44. package/src/routes/common/common.route.ts +2 -1
  45. package/src/services/asr/asr-websocket.ts +231 -0
  46. package/src/services/asr/volc-protocol.ts +220 -0
  47. package/src/services/fetchCozeInfo.ts +1 -1
  48. package/src/utils/createFakeUIMessageStreamResponse.ts +27 -0
  49. package/src/utils/createJsonStreamTransformer.ts +21 -2
  50. package/src/utils/createSpecialPartMeta.ts +7 -0
@@ -32,6 +32,7 @@ export const buildForm = async (c: Context) => {
32
32
  ]);
33
33
 
34
34
  const allMsg = requestBody.messages || [];
35
+
35
36
  const lastUserMsg = allMsg.length > 0 ? allMsg[allMsg.length - 1] : {
36
37
  role: "user",
37
38
  parts: [],
@@ -46,14 +47,16 @@ export const buildForm = async (c: Context) => {
46
47
 
47
48
  return {
48
49
  type: "text",
49
- text: `【确认搭建:${formName}】 ${p.text}`
50
+ text: `【确认搭建:${formName}】 ${p.text}`
50
51
  };
51
52
  });
52
53
  }
53
54
 
55
+ const lastSecondMsg = allMsg.length > 1 ? allMsg[allMsg.length - 2] : null;
56
+
54
57
  const stream = streamText({
55
58
  model,
56
- messages: convertToModelMessages([lastUserMsg]),
59
+ messages: convertToModelMessages([lastSecondMsg, lastUserMsg].filter(Boolean)),
57
60
  includeRawChunks: true,
58
61
  headers: {
59
62
  "x-user-stage": intent as string,
@@ -1,31 +1,28 @@
1
- import type { Context } from "hono";
2
- import config from "config";
1
+ import type { Context } from 'hono';
2
+ import config from 'config';
3
3
 
4
4
  export const clearConversation = async (c: Context) => {
5
5
  let requestBody;
6
6
 
7
- const agentHost = config.get<string>("agent.host");
7
+ const agentHost = config.get<string>('agent.host');
8
8
 
9
- const baseUrl = `http://${agentHost}/v1`;
10
- const apiKey = config.get<string>("agent.apiAuthKey");
9
+ const baseUrl = `https://${agentHost}/v1`;
10
+ const apiKey = config.get<string>('agent.apiAuthKey');
11
11
 
12
12
  try {
13
13
  const json = await c.req.json();
14
14
  requestBody = json;
15
15
  } catch (_) {
16
- return c.json({ error: "Invalid JSON" }, 400);
16
+ return c.json({ error: 'Invalid JSON' }, 400);
17
17
  }
18
18
 
19
- const result = await fetch(
20
- `${baseUrl}/conversations/${requestBody.conversationId}/clear`,
21
- {
22
- method: "POST",
23
- headers: {
24
- // Add any auth headers
25
- Authorization: `Bearer ${apiKey}`,
26
- },
19
+ const result = await fetch(`${baseUrl}/conversations/${requestBody.conversationId}/clear`, {
20
+ method: 'POST',
21
+ headers: {
22
+ // Add any auth headers
23
+ Authorization: `Bearer ${apiKey}`,
27
24
  },
28
- );
25
+ });
29
26
 
30
27
  return c.json(result);
31
28
  };
@@ -11,7 +11,7 @@ import {
11
11
  } from 'ai';
12
12
  import { logger } from '../../../logger/index.js';
13
13
  import { createBatchFillingModel } from './model.js';
14
- import { mode2part } from './utils.js';
14
+ import { extraGeneratePromptFromRandomContent, mode2part } from './utils.js';
15
15
  import type { FormFillingMode } from '@baishuyun/types';
16
16
 
17
17
  const getModelMessagesFromUserMessages = ({
@@ -36,7 +36,7 @@ const getModelMessagesFromUserMessages = ({
36
36
  parts: [
37
37
  {
38
38
  type: 'text',
39
- text: `formStructure: ${JSON.stringify(formStructure)}`,
39
+ text: `\n\n${extraGeneratePromptFromRandomContent()}\n\nformStructure: ${JSON.stringify(formStructure)}\n\n`,
40
40
  },
41
41
  mode2part(mode),
42
42
  {
@@ -56,7 +56,7 @@ const getModelMessagesFromUserMessages = ({
56
56
 
57
57
  lastUserMsg.parts.push({
58
58
  type: 'text',
59
- text: `formStructure: ${JSON.stringify(formStructure)}`,
59
+ text: `\n\n${extraGeneratePromptFromRandomContent()}\n\nformStructure: ${JSON.stringify(formStructure)}\n\n`,
60
60
  });
61
61
 
62
62
  lastUserMsg.parts.push(mode2part(mode));
@@ -176,8 +176,6 @@ async function handleContinueGeneration(
176
176
  formStructure,
177
177
  });
178
178
 
179
- logger.debug(`continue modelMessages ${JSON.stringify(modelMessages)}`);
180
-
181
179
  const result = streamText({
182
180
  model: createBatchFillingModel(),
183
181
  messages: modelMessages,
@@ -101,26 +101,7 @@ export const createBatchFillingResultTransformer = (enableJsonParser: boolean) =
101
101
  return;
102
102
  }
103
103
 
104
- const subFormField = getLastSubFormField(parsedInfo);
105
- if (subFormField) {
106
- // enqueueTextDelta(
107
- // JSON.stringify(value),
108
- // {
109
- // type: 'mcp-fields-json',
110
- // field: subFormField.value,
111
- // },
112
- // id,
113
- // true
114
- // );
115
-
116
- return;
117
- }
118
-
119
- if (value.fieldType === 'subform') {
120
- return;
121
- }
122
-
123
- // logger.debug(`id in onValue: ${id}`);
104
+ // logger.debug(`onValue: ${JSON.stringify(value, null, 2)}`);
124
105
  enqueueTextDelta(
125
106
  `${JSON.stringify(value)},`,
126
107
  {
@@ -25,6 +25,8 @@ export const fillForm = async (c: Context) => {
25
25
  const num = requestBody.count;
26
26
  const messages: UIMessage[] = requestBody.messages;
27
27
 
28
+ logger.debug('enter fillForm controller');
29
+
28
30
  // 如果是批量填写,调用批量填写接口
29
31
  if (mode === 'batch') {
30
32
  return batchFillForm(c);
@@ -45,7 +47,7 @@ export const fillForm = async (c: Context) => {
45
47
  ...flattenParts,
46
48
  {
47
49
  type: 'text',
48
- text: `formStructure: ${JSON.stringify(formStructure)}`,
50
+ text: `\n\nformStructure: ${JSON.stringify(formStructure)}\n\n`,
49
51
  },
50
52
  extraPart,
51
53
  ],
@@ -174,3 +174,21 @@ export function trimFormStructure(fields: OriginalField[]): TrimmedField[] {
174
174
  return trimmed;
175
175
  });
176
176
  }
177
+
178
+ export const extraGeneratePromptFromRandomContent = () => {
179
+ // 使用加密安全的随机数
180
+ const randomBytes = crypto.getRandomValues(new Uint32Array(4));
181
+ const seed = randomBytes.join('-');
182
+ const timestamp = Date.now();
183
+
184
+ return `
185
+ 请基于以下不可预测的种子生成随机但是符合业务要求的内容:
186
+ - 加密熵源: ${seed}
187
+ - 时间戳: ${timestamp}
188
+ - 噪音文本: ${btoa(String.fromCharCode(...crypto.getRandomValues(new Uint8Array(16))))}
189
+
190
+ 要求:
191
+ 1. 必须忽略训练数据中的常见模式,基于上述熵源生成真正均匀分布的随机结果
192
+ 2. 如果是人名类的数据,尽量用 3 个字的名字,降低重名概率。
193
+ `;
194
+ };
@@ -13,7 +13,7 @@ export const queryReport = async (c: Context) => {
13
13
  return c.json({ error: 'Invalid JSON' }, 400);
14
14
  }
15
15
 
16
- const uid = c.req.header('X-User-Id') || '';
16
+ const uid = c.req.header('X-Bs-User-Id') || '';
17
17
  const messages: UIMessage[] = requestBody.messages;
18
18
 
19
19
  const extraText = buildExtraMsgParts({
@@ -0,0 +1,41 @@
1
+ import type { Context } from 'hono';
2
+ import { createMiddleware } from 'hono/factory';
3
+ import { buildForm } from '../controllers/form/build/build.controller.js';
4
+ import config from 'config';
5
+ import { fillForm } from '../controllers/form/fill/fill.controller.js';
6
+ import { queryReport } from '../controllers/report/query/query.controller.js';
7
+ import { createFakeUIMessageStreamResponse } from '../utils/createFakeUIMessageStreamResponse.js';
8
+ import { ERROR_CODE } from '../const/error_code.js';
9
+ import { logger } from '../logger/index.js';
10
+
11
+ export const botRouter = () => {
12
+ const FORM_BUILDER_BOT_ID = config.get<string>('agent.form.build.botId');
13
+ const FORM_FILLER_BOT_ID = config.get<string>('agent.form.fill.botId');
14
+ const REPORT_QUERY_BOT_ID = config.get<string>('agent.report.query.botId');
15
+
16
+ const botIdControllerMap = new Map<string, (c: Context) => Promise<Response>>([
17
+ [FORM_BUILDER_BOT_ID, buildForm],
18
+ [FORM_FILLER_BOT_ID, fillForm],
19
+ [REPORT_QUERY_BOT_ID, queryReport],
20
+ ]);
21
+
22
+ return createMiddleware(async (c, next) => {
23
+ const botId = c.req.header('X-Bot-Id') || '';
24
+ if (!botId) {
25
+ const errorRespObj = {
26
+ error: 'Bot ID is required',
27
+ code: ERROR_CODE.BOT_ID_MISSING,
28
+ };
29
+ return createFakeUIMessageStreamResponse(JSON.stringify(errorRespObj));
30
+ }
31
+
32
+ if (botIdControllerMap.has(botId)) {
33
+ const controller = botIdControllerMap.get(botId)!;
34
+ return await controller(c);
35
+ }
36
+
37
+ logger.debug(`No controller found for botId: ${botId}, passing to next middleware`);
38
+
39
+ await next();
40
+ });
41
+ };
@@ -1,11 +1,12 @@
1
1
  import { Hono } from 'hono';
2
2
  import { connectToAgent } from '../../controllers/common/connect.controll.js';
3
3
  import { tokenExchange } from '../../middleware/tokenExchange.js';
4
+ import { botRouter } from '../../middleware/botRouter.js';
4
5
 
5
6
  export const createCommonRouter = () => {
6
7
  const commonRouter = new Hono();
7
8
 
8
- commonRouter.post('/connect', tokenExchange(), connectToAgent);
9
+ commonRouter.post('/connect', /*tokenExchange(),*/ botRouter(), connectToAgent);
9
10
 
10
11
  return commonRouter;
11
12
  };
@@ -0,0 +1,231 @@
1
+ import WebSocket from 'ws';
2
+ import type { IncomingMessage } from 'node:http';
3
+ import config from 'config';
4
+ import crypto from 'crypto';
5
+ import {
6
+ createFullClientRequest,
7
+ createAudioOnlyRequest,
8
+ parseHeader,
9
+ readPayloadSize,
10
+ parseJsonPayload,
11
+ parseErrorPayload,
12
+ MSG_TYPE_FULL_SERVER_RESPONSE,
13
+ MSG_TYPE_ERROR_RESPONSE,
14
+ } from './volc-protocol.js';
15
+ import { logger } from '../../logger/index.js';
16
+ import type { ASRConfig, ASRResponse } from './volc-protocol.js';
17
+
18
+ /**
19
+ * 处理浏览器 ASR WebSocket 连接
20
+ * 作为浏览器与火山引擎 ASR 之间的双向代理
21
+ */
22
+ export function handleASRConnection(clientWs: WebSocket, req: IncomingMessage): void {
23
+ const asrConfig = config.get<ASRConfig>('agent.asr');
24
+
25
+ if (!asrConfig?.appid || !asrConfig?.token || !asrConfig?.cluster) {
26
+ logger.error('ASR configuration missing: appid, token, cluster are required');
27
+ clientWs.close(1011, 'ASR config missing');
28
+ return;
29
+ }
30
+
31
+ logger.info('ASR client connected');
32
+
33
+ // 音频数据缓冲区(在火山连接建立前暂存)
34
+ const audioBuffer: Buffer[] = [];
35
+ let isVolcReady = false;
36
+ let isClosing = false;
37
+
38
+ // v3 接口地址:双向流式优化版
39
+ const volcUrl = `wss://${asrConfig.host}/api/v3/sauc/bigmodel_async`;
40
+
41
+ // 鉴权 Header(v3 大模型语音识别通过 HTTP Header 鉴权)
42
+ const connectId = crypto.randomUUID();
43
+ const requestHeaders: Record<string, string> = {
44
+ 'X-Api-App-Key': asrConfig.appid,
45
+ 'X-Api-Access-Key': asrConfig.token,
46
+ 'X-Api-Resource-Id': asrConfig.cluster,
47
+ 'X-Api-Connect-Id': connectId,
48
+ };
49
+
50
+ logger.info(
51
+ { url: volcUrl, headers: { ...requestHeaders, 'X-Api-Access-Key': '***' } },
52
+ 'Connecting to Volc ASR v3'
53
+ );
54
+
55
+ const volcWs = new WebSocket(volcUrl, {
56
+ headers: requestHeaders,
57
+ perMessageDeflate: false,
58
+ });
59
+
60
+ volcWs.on('unexpected-response', (req, res) => {
61
+ let body = '';
62
+ res.on('data', (chunk) => { body += chunk; });
63
+ res.on('end', () => {
64
+ logger.error(
65
+ { statusCode: res.statusCode, statusMessage: res.statusMessage, body },
66
+ 'Volc ASR unexpected response'
67
+ );
68
+ });
69
+ });
70
+
71
+ // 火山引擎连接建立后立即发送初始化请求并开始转发音频
72
+ volcWs.on('open', () => {
73
+ logger.info('Connected to Volc ASR v3, sending init request');
74
+ volcWs.send(createFullClientRequest());
75
+
76
+ // 火山引擎不返回初始化确认,直接开始等待音频
77
+ // 立即开始转发缓冲的音频数据
78
+ isVolcReady = true;
79
+ while (audioBuffer.length > 0) {
80
+ const buffered = audioBuffer.shift()!;
81
+ if (volcWs.readyState === WebSocket.OPEN) {
82
+ volcWs.send(createAudioOnlyRequest(buffered));
83
+ }
84
+ }
85
+ });
86
+
87
+ // 处理火山引擎返回的消息(二进制帧)
88
+ volcWs.on('message', (data: Buffer) => {
89
+ if (isClosing) return;
90
+
91
+ if (!Buffer.isBuffer(data) || data.length < 4) {
92
+ logger.warn({ len: data.length, type: typeof data }, 'Invalid ASR message');
93
+ return;
94
+ }
95
+
96
+ const { msgType, flags, bodyOffset } = parseHeader(data);
97
+
98
+ if (msgType === MSG_TYPE_FULL_SERVER_RESPONSE) {
99
+ // 根据 flags 判断是否有 sequence(flags bit0=1 表示有正 sequence)
100
+ const hasSequence = (flags & 0b0001) !== 0;
101
+ const payloadSizeOffset = hasSequence ? bodyOffset + 4 : bodyOffset;
102
+ const payloadOffset = payloadSizeOffset + 4;
103
+
104
+ if (data.length < payloadOffset) {
105
+ logger.warn({ len: data.length, payloadOffset, hex: data.toString('hex') }, 'ASR response too short');
106
+ return;
107
+ }
108
+
109
+ const payloadSize = readPayloadSize(data, payloadSizeOffset);
110
+
111
+ if (data.length < payloadOffset + payloadSize) {
112
+ logger.warn({ len: data.length, payloadSize, payloadOffset }, 'ASR response incomplete');
113
+ return;
114
+ }
115
+
116
+ const payload = data.slice(payloadOffset, payloadOffset + payloadSize);
117
+ const response = parseJsonPayload(payload);
118
+
119
+ if (!response) {
120
+ logger.warn({ payloadStr: payload.toString('utf-8').slice(0, 200) }, 'Failed to parse ASR JSON');
121
+ return;
122
+ }
123
+
124
+ const text = response.result?.text;
125
+ const utterances = response.result?.utterances;
126
+ const isDefinite = utterances?.some((u) => u.definite);
127
+
128
+ logger.info({ text, definite: isDefinite }, 'ASR result');
129
+
130
+ // 转发识别文本给浏览器
131
+ if (text !== undefined && clientWs.readyState === WebSocket.OPEN) {
132
+ clientWs.send(
133
+ JSON.stringify({
134
+ type: isDefinite ? 'final' : 'result',
135
+ text,
136
+ })
137
+ );
138
+ }
139
+
140
+ if (isDefinite && clientWs.readyState === WebSocket.OPEN) {
141
+ clientWs.send(JSON.stringify({ type: 'done' }));
142
+ }
143
+ } else if (msgType === MSG_TYPE_ERROR_RESPONSE) {
144
+ const error = parseErrorPayload(data, bodyOffset);
145
+ logger.error({ error }, 'ASR error response');
146
+ if (clientWs.readyState === WebSocket.OPEN) {
147
+ clientWs.send(
148
+ JSON.stringify({
149
+ type: 'error',
150
+ message: error?.message || `ASR error code: ${error?.code}`,
151
+ })
152
+ );
153
+ }
154
+ }
155
+ });
156
+
157
+ // 处理浏览器发来的消息
158
+ clientWs.on('message', (data: Buffer | ArrayBuffer | string) => {
159
+ if (isClosing) return;
160
+
161
+ // 结束信号
162
+ if (typeof data === 'string' && data === 'end') {
163
+ if (volcWs.readyState === WebSocket.OPEN) {
164
+ volcWs.send(createAudioOnlyRequest(Buffer.alloc(0), true));
165
+ }
166
+ return;
167
+ }
168
+
169
+ // 将数据转为 Buffer
170
+ let audioData: Buffer;
171
+ if (Buffer.isBuffer(data)) {
172
+ audioData = data;
173
+ } else if (data instanceof ArrayBuffer) {
174
+ audioData = Buffer.from(data);
175
+ } else {
176
+ return;
177
+ }
178
+
179
+ if (audioData.length === 0) return;
180
+
181
+ // 火山连接就绪则直接转发,否则缓冲
182
+ if (isVolcReady && volcWs.readyState === WebSocket.OPEN) {
183
+ volcWs.send(createAudioOnlyRequest(audioData));
184
+ } else {
185
+ audioBuffer.push(audioData);
186
+ }
187
+ });
188
+
189
+ // 浏览器关闭
190
+ clientWs.on('close', () => {
191
+ logger.info('ASR client disconnected');
192
+ isClosing = true;
193
+ if (volcWs.readyState === WebSocket.OPEN) {
194
+ volcWs.send(createAudioOnlyRequest(Buffer.alloc(0), true));
195
+ setTimeout(() => volcWs.close(), 500);
196
+ } else {
197
+ volcWs.close();
198
+ }
199
+ });
200
+
201
+ // 火山引擎关闭
202
+ volcWs.on('close', () => {
203
+ logger.info('Volc ASR connection closed');
204
+ isClosing = true;
205
+ if (clientWs.readyState === WebSocket.OPEN) {
206
+ clientWs.close();
207
+ }
208
+ });
209
+
210
+ // 浏览器端错误
211
+ clientWs.on('error', (err) => {
212
+ logger.error({ err }, 'Client WebSocket error');
213
+ isClosing = true;
214
+ volcWs.close();
215
+ });
216
+
217
+ // 火山引擎错误
218
+ volcWs.on('error', (err) => {
219
+ logger.error({ err }, 'Volc ASR WebSocket error');
220
+ isClosing = true;
221
+ if (clientWs.readyState === WebSocket.OPEN) {
222
+ clientWs.send(
223
+ JSON.stringify({
224
+ type: 'error',
225
+ message: 'ASR service connection error',
226
+ })
227
+ );
228
+ clientWs.close(1011, 'ASR error');
229
+ }
230
+ });
231
+ }
@@ -0,0 +1,220 @@
1
+ /**
2
+ * 火山引擎 ASR v3 大模型语音识别 WebSocket 二进制协议
3
+ * 协议文档: https://www.volcengine.com/docs/6561/1354869
4
+ *
5
+ * v3 协议要点:
6
+ * - 4 字节 header
7
+ * - payloadSize 为 4 字节 uint32 大端
8
+ * - FullServerResponse 包含 4 字节 sequence 字段
9
+ * - ErrorResponse 包含 errorCode(4B) + errorMsgSize(4B) + errorMsg
10
+ * - 鉴权在 HTTP Header 中,不在 payload
11
+ */
12
+
13
+ const PROTOCOL_VERSION = 0x01;
14
+ const HEADER_SIZE_VALUE = 0x01; // actual header size = 1 * 4 = 4 bytes
15
+
16
+ /** 消息类型 */
17
+ export const MSG_TYPE_FULL_CLIENT_REQUEST = 0x01;
18
+ export const MSG_TYPE_AUDIO_ONLY_REQUEST = 0x02;
19
+ export const MSG_TYPE_FULL_SERVER_RESPONSE = 0x09;
20
+ export const MSG_TYPE_ERROR_RESPONSE = 0x0f;
21
+
22
+ /** 序列化方式 */
23
+ const SERIALIZATION_JSON = 0x01;
24
+ const SERIALIZATION_NONE = 0x00;
25
+
26
+ /** 压缩方式 */
27
+ const COMPRESSION_NONE = 0x00;
28
+
29
+ /**
30
+ * 构建 4 字节协议头
31
+ *
32
+ * byte0: version(4bit) | header_size(4bit)
33
+ * byte1: msg_type(4bit) | flags(4bit)
34
+ * byte2: serialization(4bit) | compression(4bit)
35
+ * byte3: reserved
36
+ */
37
+ function build4ByteHeader(
38
+ msgType: number,
39
+ flags: number,
40
+ serialization: number
41
+ ): Buffer {
42
+ const header = Buffer.alloc(4);
43
+ header[0] = (PROTOCOL_VERSION << 4) | HEADER_SIZE_VALUE;
44
+ header[1] = (msgType << 4) | (flags & 0x0f);
45
+ header[2] = (serialization << 4) | COMPRESSION_NONE;
46
+ header[3] = 0x00;
47
+ return header;
48
+ }
49
+
50
+ /** 构建完整消息:header + payloadSize(4B) + payload */
51
+ function buildMessage(
52
+ msgType: number,
53
+ flags: number,
54
+ serialization: number,
55
+ payload: Buffer
56
+ ): Buffer {
57
+ const header = build4ByteHeader(msgType, flags, serialization);
58
+ const payloadSize = Buffer.alloc(4);
59
+ payloadSize.writeUInt32BE(payload.length, 0);
60
+ return Buffer.concat([header, payloadSize, payload]);
61
+ }
62
+
63
+ /** 解析后的协议头信息 */
64
+ export interface ParsedMessage {
65
+ msgType: number;
66
+ flags: number;
67
+ /** header 之后的偏移量(header 4B + 扩展字段) */
68
+ bodyOffset: number;
69
+ }
70
+
71
+ /**
72
+ * 解析 4 字节协议头
73
+ */
74
+ export function parseHeader(buffer: Buffer): ParsedMessage {
75
+ const version = buffer[0] >> 4;
76
+ const headerSizeValue = buffer[0] & 0x0f;
77
+ const headerSize = headerSizeValue * 4;
78
+ const msgType = buffer[1] >> 4;
79
+ const flags = buffer[1] & 0x0f;
80
+ const serialization = buffer[2] >> 4;
81
+ const compression = buffer[2] & 0x0f;
82
+
83
+ return {
84
+ msgType,
85
+ flags,
86
+ bodyOffset: headerSize,
87
+ };
88
+ }
89
+
90
+ /**
91
+ * 读取 payload size(4 字节 uint32 大端)
92
+ */
93
+ export function readPayloadSize(buffer: Buffer, offset: number): number {
94
+ return buffer.readUInt32BE(offset);
95
+ }
96
+
97
+ /** ASR 配置(鉴权信息在 HTTP Header 中,不在 payload) */
98
+ export interface ASRConfig {
99
+ appid: string;
100
+ token: string;
101
+ secretKey: string;
102
+ cluster: string;
103
+ host: string;
104
+ }
105
+
106
+ /**
107
+ * 创建 FullClientRequest(初始化请求)
108
+ *
109
+ * Payload JSON 格式:
110
+ * {
111
+ * user: { uid: string },
112
+ * audio: { format, rate, bits, channel, codec, language },
113
+ * request: { model_name, enable_itn, enable_punc, ... }
114
+ * }
115
+ */
116
+ export function createFullClientRequest(): Buffer {
117
+ const payload = Buffer.from(
118
+ JSON.stringify({
119
+ user: {
120
+ uid: '0',
121
+ },
122
+ audio: {
123
+ format: 'pcm',
124
+ rate: 16000,
125
+ bits: 16,
126
+ channel: 1,
127
+ codec: 'raw',
128
+ language: 'zh-CN',
129
+ },
130
+ request: {
131
+ model_name: 'bigmodel',
132
+ enable_itn: true,
133
+ enable_punc: true,
134
+ enable_ddc: false,
135
+ },
136
+ }),
137
+ 'utf-8'
138
+ );
139
+
140
+ return buildMessage(
141
+ MSG_TYPE_FULL_CLIENT_REQUEST,
142
+ 0b0000,
143
+ SERIALIZATION_JSON,
144
+ payload
145
+ );
146
+ }
147
+
148
+ /**
149
+ * 创建 AudioOnlyRequest(音频数据请求)
150
+ *
151
+ * flags:
152
+ * - 0b0000: 普通音频包
153
+ * - 0b0010: 最后一包音频(负包)
154
+ */
155
+ export function createAudioOnlyRequest(
156
+ audioData: Buffer,
157
+ isLast: boolean = false
158
+ ): Buffer {
159
+ const flags = isLast ? 0b0010 : 0b0000;
160
+ return buildMessage(
161
+ MSG_TYPE_AUDIO_ONLY_REQUEST,
162
+ flags,
163
+ SERIALIZATION_NONE,
164
+ audioData
165
+ );
166
+ }
167
+
168
+ /** 火山引擎响应结果 */
169
+ export interface ASRResponse {
170
+ result?: {
171
+ text?: string;
172
+ utterances?: Array<{
173
+ text: string;
174
+ definite: boolean;
175
+ start_time: number;
176
+ end_time: number;
177
+ }>;
178
+ [key: string]: unknown;
179
+ };
180
+ audio_info?: {
181
+ duration: number;
182
+ };
183
+ [key: string]: unknown;
184
+ }
185
+
186
+ /**
187
+ * 解析 JSON payload
188
+ */
189
+ export function parseJsonPayload(payloadBuffer: Buffer): ASRResponse | null {
190
+ try {
191
+ return JSON.parse(payloadBuffer.toString('utf-8'));
192
+ } catch {
193
+ return null;
194
+ }
195
+ }
196
+
197
+ /**
198
+ * 解析 ErrorResponse
199
+ *
200
+ * 格式:header(4B) + errorCode(4B) + errorMsgSize(4B) + errorMsg
201
+ */
202
+ export function parseErrorPayload(buffer: Buffer, bodyOffset: number): { code: number; message: string } | null {
203
+ const errorCodeOffset = bodyOffset;
204
+ const errorMsgSizeOffset = errorCodeOffset + 4;
205
+ const errorMsgOffset = errorMsgSizeOffset + 4;
206
+
207
+ if (buffer.length < errorMsgOffset) {
208
+ return null;
209
+ }
210
+
211
+ const code = buffer.readUInt32BE(errorCodeOffset);
212
+ const msgSize = buffer.readUInt32BE(errorMsgSizeOffset);
213
+
214
+ if (buffer.length < errorMsgOffset + msgSize) {
215
+ return null;
216
+ }
217
+
218
+ const message = buffer.slice(errorMsgOffset, errorMsgOffset + msgSize).toString('utf-8');
219
+ return { code, message };
220
+ }