@blueking/chat-helper 0.0.1-beta.17 → 0.0.1-beta.18

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 (29) hide show
  1. package/dist/agent/index.d.ts +2 -0
  2. package/dist/agent/type.d.ts +103 -0
  3. package/dist/agent/use-agent.d.ts +599 -0
  4. package/dist/event/ag-ui.d.ts +153 -0
  5. package/dist/event/index.d.ts +2 -0
  6. package/dist/event/type.d.ts +252 -0
  7. package/dist/http/fetch/fetch.d.ts +88 -0
  8. package/dist/http/fetch/index.d.ts +7 -0
  9. package/dist/http/index.d.ts +46 -0
  10. package/dist/http/module/agent.d.ts +9 -0
  11. package/dist/http/module/index.d.ts +42 -0
  12. package/dist/http/module/message.d.ts +29 -0
  13. package/dist/http/module/session.d.ts +28 -0
  14. package/dist/http/transform/agent.d.ts +7 -0
  15. package/dist/http/transform/index.d.ts +3 -0
  16. package/dist/http/transform/message.d.ts +13 -0
  17. package/dist/http/transform/session.d.ts +37 -0
  18. package/dist/index.d.ts +3431 -0
  19. package/dist/mediator/index.d.ts +2 -0
  20. package/dist/mediator/type.d.ts +50 -0
  21. package/dist/mediator/use-mediator.d.ts +7 -0
  22. package/dist/message/index.d.ts +2 -0
  23. package/dist/message/type.d.ts +370 -0
  24. package/dist/message/use-message.d.ts +902 -0
  25. package/dist/session/index.d.ts +2 -0
  26. package/dist/session/type.d.ts +71 -0
  27. package/dist/session/use-session.d.ts +1906 -0
  28. package/dist/type.d.ts +14 -0
  29. package/package.json +1 -1
package/dist/agent/index.d.ts ADDED
@@ -0,0 +1,2 @@
1
+ export * from './type';
2
+ export * from './use-agent';
package/dist/agent/type.d.ts ADDED
@@ -0,0 +1,103 @@
1
+ import type { IMessage } from '../message/type';
2
+ export interface IAgentCommand {
3
+ agentId: number;
4
+ alias?: string;
5
+ components: IAgentCommandComponent[];
6
+ content: null | string;
7
+ icon?: string;
8
+ id: string;
9
+ name: string;
10
+ status: string;
11
+ }
12
+ export interface IAgentCommandApi {
13
+ agent_id: number;
14
+ alias?: string;
15
+ components: IAgentCommandComponentApi[];
16
+ content: null | string;
17
+ icon: string;
18
+ id: string;
19
+ name: string;
20
+ selectedText?: null | string;
21
+ status: string;
22
+ }
23
+ export interface IAgentCommandComponent {
24
+ default?: null | string;
25
+ fillBack?: boolean;
26
+ fillRegx?: null | string;
27
+ hide?: boolean;
28
+ key: string;
29
+ max?: null | number;
30
+ min?: null | number;
31
+ name: string;
32
+ options?: unknown;
33
+ placeholder?: null | string;
34
+ required?: boolean;
35
+ rows?: null | number;
36
+ selectedText?: null | string;
37
+ showSendButton?: boolean;
38
+ type: string;
39
+ }
40
+ export interface IAgentCommandComponentApi {
41
+ default: null | string;
42
+ fill_back: boolean;
43
+ fill_regx: null | string;
44
+ key: string;
45
+ max: null | number;
46
+ min: null | number;
47
+ name: string;
48
+ options: unknown;
49
+ placeholder: null | string;
50
+ required: boolean;
51
+ rows: null | number;
52
+ type: string;
53
+ }
54
+ export interface IAgentInfo {
55
+ agentName?: string;
56
+ resources?: IAgentResources;
57
+ saasUrl?: string;
58
+ chatGroup?: {
59
+ enabled: boolean;
60
+ staff: string[];
61
+ username: string;
62
+ };
63
+ conversationSettings?: {
64
+ commands?: IAgentCommand[];
65
+ enableChatSession?: boolean;
66
+ openingRemark?: string;
67
+ predefinedQuestions?: string[];
68
+ };
69
+ promptSetting?: {
70
+ content?: IMessage[];
71
+ };
72
+ }
73
+ export interface IAgentInfoApi {
74
+ agent_name: string;
75
+ resources?: IAgentResources;
76
+ saas_url?: string;
77
+ chat_group?: {
78
+ enabled: boolean;
79
+ staff: string[];
80
+ username: string;
81
+ };
82
+ conversation_settings?: {
83
+ commands?: IAgentCommandApi[];
84
+ enable_chat_session?: boolean;
85
+ opening_remark?: string;
86
+ predefined_questions?: string[];
87
+ };
88
+ prompt_setting?: {
89
+ content?: IMessage[];
90
+ };
91
+ }
92
+ export interface IAgentResourceItem {
93
+ code: string;
94
+ icon: null | string;
95
+ id: null | number;
96
+ name: string;
97
+ }
98
+ export interface IAgentResources {
99
+ command?: IAgentResourceItem[];
100
+ knowledgebase?: IAgentResourceItem[];
101
+ mcp?: IAgentResourceItem[];
102
+ tool?: IAgentResourceItem[];
103
+ }
package/dist/agent/use-agent.d.ts ADDED
@@ -0,0 +1,599 @@
1
+ import { MessageRole, MessageStatus } from '../message';
2
+ import type { IRequestConfig, ISSEProtocol } from '../http';
3
+ import type { IMediatorModule } from '../mediator';
4
+ import type { IMessageProperty, IUserMessage } from '../message/type';
5
+ import type { IAgentInfo } from './type';
6
+ /**
7
+ * Agent 模块
8
+ * @param options - 配置选项
9
+ * @param mediator - 中介者模块，用于获取其他模块的引用
10
+ */
11
+ export declare const useAgent: (mediator: IMediatorModule, protocol: ISSEProtocol) => {
12
+ info: import("vue").Ref<{
13
+ agentName?: string;
14
+ resources?: {
15
+ command?: {
16
+ code: string;
17
+ icon: null | string;
18
+ id: null | number;
19
+ name: string;
20
+ }[];
21
+ knowledgebase?: {
22
+ code: string;
23
+ icon: null | string;
24
+ id: null | number;
25
+ name: string;
26
+ }[];
27
+ mcp?: {
28
+ code: string;
29
+ icon: null | string;
30
+ id: null | number;
31
+ name: string;
32
+ }[];
33
+ tool?: {
34
+ code: string;
35
+ icon: null | string;
36
+ id: null | number;
37
+ name: string;
38
+ }[];
39
+ };
40
+ saasUrl?: string;
41
+ chatGroup?: {
42
+ enabled: boolean;
43
+ staff: string[];
44
+ username: string;
45
+ };
46
+ conversationSettings?: {
47
+ commands?: {
48
+ agentId: number;
49
+ alias?: string;
50
+ components: {
51
+ default?: null | string;
52
+ fillBack?: boolean;
53
+ fillRegx?: null | string;
54
+ hide?: boolean;
55
+ key: string;
56
+ max?: null | number;
57
+ min?: null | number;
58
+ name: string;
59
+ options?: unknown;
60
+ placeholder?: null | string;
61
+ required?: boolean;
62
+ rows?: null | number;
63
+ selectedText?: null | string;
64
+ showSendButton?: boolean;
65
+ type: string;
66
+ }[];
67
+ content: null | string;
68
+ icon?: string;
69
+ id: string;
70
+ name: string;
71
+ status: string;
72
+ }[];
73
+ enableChatSession?: boolean;
74
+ openingRemark?: string;
75
+ predefinedQuestions?: string[];
76
+ };
77
+ promptSetting?: {
78
+ content?: ({
79
+ activityType: import("../message").ActivityType;
80
+ content: {
81
+ content: string;
82
+ referenceDocument: {
83
+ name: string;
84
+ originFileUrl?: string;
85
+ url: string;
86
+ }[];
87
+ } | {
88
+ name: string;
89
+ originFileUrl?: string;
90
+ url: string;
91
+ }[];
92
+ role: MessageRole.Activity;
93
+ id?: string;
94
+ messageId?: string;
95
+ name?: string;
96
+ sessionCode?: string;
97
+ status: MessageStatus;
98
+ } | {
99
+ content?: string;
100
+ role: MessageRole.Assistant;
101
+ toolCalls?: {
102
+ function: {
103
+ arguments: string;
104
+ description?: string;
105
+ mcpName?: string;
106
+ name: string;
107
+ };
108
+ id: string;
109
+ type: import("../message").MessageType.Function;
110
+ }[];
111
+ id?: string;
112
+ messageId?: string;
113
+ name?: string;
114
+ sessionCode?: string;
115
+ status: MessageStatus;
116
+ } | {
117
+ content: string;
118
+ role: MessageRole.Developer;
119
+ id?: string;
120
+ messageId?: string;
121
+ name?: string;
122
+ sessionCode?: string;
123
+ status: MessageStatus;
124
+ } | {
125
+ content: string;
126
+ role: MessageRole.Guide;
127
+ id?: string;
128
+ messageId?: string;
129
+ name?: string;
130
+ sessionCode?: string;
131
+ status: MessageStatus;
132
+ } | {
133
+ content: string;
134
+ role: MessageRole.HiddenAssistant;
135
+ id?: string;
136
+ messageId?: string;
137
+ name?: string;
138
+ sessionCode?: string;
139
+ status: MessageStatus;
140
+ } | {
141
+ content: string;
142
+ role: MessageRole.HiddenGuide;
143
+ id?: string;
144
+ messageId?: string;
145
+ name?: string;
146
+ sessionCode?: string;
147
+ status: MessageStatus;
148
+ } | {
149
+ content: string;
150
+ role: MessageRole.Hidden;
151
+ id?: string;
152
+ messageId?: string;
153
+ name?: string;
154
+ sessionCode?: string;
155
+ status: MessageStatus;
156
+ } | {
157
+ content: string;
158
+ role: MessageRole.HiddenSystem;
159
+ id?: string;
160
+ messageId?: string;
161
+ name?: string;
162
+ sessionCode?: string;
163
+ status: MessageStatus;
164
+ } | {
165
+ content: string;
166
+ role: MessageRole.HiddenUser;
167
+ id?: string;
168
+ messageId?: string;
169
+ name?: string;
170
+ sessionCode?: string;
171
+ status: MessageStatus;
172
+ } | {
173
+ content: string;
174
+ role: MessageRole.Info;
175
+ id?: string;
176
+ messageId?: string;
177
+ name?: string;
178
+ sessionCode?: string;
179
+ status: MessageStatus;
180
+ } | {
181
+ content: string;
182
+ role: MessageRole.Pause;
183
+ id?: string;
184
+ messageId?: string;
185
+ name?: string;
186
+ sessionCode?: string;
187
+ status: MessageStatus;
188
+ } | {
189
+ content: string;
190
+ role: MessageRole.Placeholder;
191
+ id?: string;
192
+ messageId?: string;
193
+ name?: string;
194
+ sessionCode?: string;
195
+ status: MessageStatus;
196
+ } | {
197
+ content: string[];
198
+ duration?: number;
199
+ role: MessageRole.Reasoning;
200
+ id?: string;
201
+ messageId?: string;
202
+ name?: string;
203
+ sessionCode?: string;
204
+ status: MessageStatus;
205
+ } | {
206
+ content: string;
207
+ role: MessageRole.System;
208
+ id?: string;
209
+ messageId?: string;
210
+ name?: string;
211
+ sessionCode?: string;
212
+ status: MessageStatus;
213
+ } | {
214
+ content: string;
215
+ role: MessageRole.TemplateAssistant;
216
+ id?: string;
217
+ messageId?: string;
218
+ name?: string;
219
+ sessionCode?: string;
220
+ status: MessageStatus;
221
+ } | {
222
+ content: string;
223
+ role: MessageRole.TemplateGuide;
224
+ id?: string;
225
+ messageId?: string;
226
+ name?: string;
227
+ sessionCode?: string;
228
+ status: MessageStatus;
229
+ } | {
230
+ content: string;
231
+ role: MessageRole.TemplateHidden;
232
+ id?: string;
233
+ messageId?: string;
234
+ name?: string;
235
+ sessionCode?: string;
236
+ status: MessageStatus;
237
+ } | {
238
+ content: string;
239
+ role: MessageRole.TemplateSystem;
240
+ id?: string;
241
+ messageId?: string;
242
+ name?: string;
243
+ sessionCode?: string;
244
+ status: MessageStatus;
245
+ } | {
246
+ content: string;
247
+ role: MessageRole.TemplateUser;
248
+ id?: string;
249
+ messageId?: string;
250
+ name?: string;
251
+ sessionCode?: string;
252
+ status: MessageStatus;
253
+ } | {
254
+ content: string;
255
+ duration?: number;
256
+ error?: string;
257
+ role: MessageRole.Tool;
258
+ toolCallId: string;
259
+ id?: string;
260
+ messageId?: string;
261
+ name?: string;
262
+ sessionCode?: string;
263
+ status: MessageStatus;
264
+ } | {
265
+ content: string | ({
266
+ data?: string;
267
+ filename?: string;
268
+ id?: string;
269
+ mimeType: string;
270
+ type: import("../message").MessageType.Binary;
271
+ url?: string;
272
+ } | {
273
+ text: string;
274
+ type: import("../message").MessageType.Text;
275
+ })[];
276
+ property?: {
277
+ [x: string]: unknown;
278
+ extra?: {
279
+ [x: string]: unknown;
280
+ cite?: string | {
281
+ data: {
282
+ key: string;
283
+ value: string;
284
+ }[];
285
+ title: string;
286
+ type: string;
287
+ };
288
+ command?: string;
289
+ context?: Array<Record<string, unknown>>;
290
+ };
291
+ };
292
+ role: MessageRole.User;
293
+ id?: string;
294
+ messageId?: string;
295
+ name?: string;
296
+ sessionCode?: string;
297
+ status: MessageStatus;
298
+ })[];
299
+ };
300
+ }, IAgentInfo | {
301
+ agentName?: string;
302
+ resources?: {
303
+ command?: {
304
+ code: string;
305
+ icon: null | string;
306
+ id: null | number;
307
+ name: string;
308
+ }[];
309
+ knowledgebase?: {
310
+ code: string;
311
+ icon: null | string;
312
+ id: null | number;
313
+ name: string;
314
+ }[];
315
+ mcp?: {
316
+ code: string;
317
+ icon: null | string;
318
+ id: null | number;
319
+ name: string;
320
+ }[];
321
+ tool?: {
322
+ code: string;
323
+ icon: null | string;
324
+ id: null | number;
325
+ name: string;
326
+ }[];
327
+ };
328
+ saasUrl?: string;
329
+ chatGroup?: {
330
+ enabled: boolean;
331
+ staff: string[];
332
+ username: string;
333
+ };
334
+ conversationSettings?: {
335
+ commands?: {
336
+ agentId: number;
337
+ alias?: string;
338
+ components: {
339
+ default?: null | string;
340
+ fillBack?: boolean;
341
+ fillRegx?: null | string;
342
+ hide?: boolean;
343
+ key: string;
344
+ max?: null | number;
345
+ min?: null | number;
346
+ name: string;
347
+ options?: unknown;
348
+ placeholder?: null | string;
349
+ required?: boolean;
350
+ rows?: null | number;
351
+ selectedText?: null | string;
352
+ showSendButton?: boolean;
353
+ type: string;
354
+ }[];
355
+ content: null | string;
356
+ icon?: string;
357
+ id: string;
358
+ name: string;
359
+ status: string;
360
+ }[];
361
+ enableChatSession?: boolean;
362
+ openingRemark?: string;
363
+ predefinedQuestions?: string[];
364
+ };
365
+ promptSetting?: {
366
+ content?: ({
367
+ activityType: import("../message").ActivityType;
368
+ content: {
369
+ content: string;
370
+ referenceDocument: {
371
+ name: string;
372
+ originFileUrl?: string;
373
+ url: string;
374
+ }[];
375
+ } | {
376
+ name: string;
377
+ originFileUrl?: string;
378
+ url: string;
379
+ }[];
380
+ role: MessageRole.Activity;
381
+ id?: string;
382
+ messageId?: string;
383
+ name?: string;
384
+ sessionCode?: string;
385
+ status: MessageStatus;
386
+ } | {
387
+ content?: string;
388
+ role: MessageRole.Assistant;
389
+ toolCalls?: {
390
+ function: {
391
+ arguments: string;
392
+ description?: string;
393
+ mcpName?: string;
394
+ name: string;
395
+ };
396
+ id: string;
397
+ type: import("../message").MessageType.Function;
398
+ }[];
399
+ id?: string;
400
+ messageId?: string;
401
+ name?: string;
402
+ sessionCode?: string;
403
+ status: MessageStatus;
404
+ } | {
405
+ content: string;
406
+ role: MessageRole.Developer;
407
+ id?: string;
408
+ messageId?: string;
409
+ name?: string;
410
+ sessionCode?: string;
411
+ status: MessageStatus;
412
+ } | {
413
+ content: string;
414
+ role: MessageRole.Guide;
415
+ id?: string;
416
+ messageId?: string;
417
+ name?: string;
418
+ sessionCode?: string;
419
+ status: MessageStatus;
420
+ } | {
421
+ content: string;
422
+ role: MessageRole.HiddenAssistant;
423
+ id?: string;
424
+ messageId?: string;
425
+ name?: string;
426
+ sessionCode?: string;
427
+ status: MessageStatus;
428
+ } | {
429
+ content: string;
430
+ role: MessageRole.HiddenGuide;
431
+ id?: string;
432
+ messageId?: string;
433
+ name?: string;
434
+ sessionCode?: string;
435
+ status: MessageStatus;
436
+ } | {
437
+ content: string;
438
+ role: MessageRole.Hidden;
439
+ id?: string;
440
+ messageId?: string;
441
+ name?: string;
442
+ sessionCode?: string;
443
+ status: MessageStatus;
444
+ } | {
445
+ content: string;
446
+ role: MessageRole.HiddenSystem;
447
+ id?: string;
448
+ messageId?: string;
449
+ name?: string;
450
+ sessionCode?: string;
451
+ status: MessageStatus;
452
+ } | {
453
+ content: string;
454
+ role: MessageRole.HiddenUser;
455
+ id?: string;
456
+ messageId?: string;
457
+ name?: string;
458
+ sessionCode?: string;
459
+ status: MessageStatus;
460
+ } | {
461
+ content: string;
462
+ role: MessageRole.Info;
463
+ id?: string;
464
+ messageId?: string;
465
+ name?: string;
466
+ sessionCode?: string;
467
+ status: MessageStatus;
468
+ } | {
469
+ content: string;
470
+ role: MessageRole.Pause;
471
+ id?: string;
472
+ messageId?: string;
473
+ name?: string;
474
+ sessionCode?: string;
475
+ status: MessageStatus;
476
+ } | {
477
+ content: string;
478
+ role: MessageRole.Placeholder;
479
+ id?: string;
480
+ messageId?: string;
481
+ name?: string;
482
+ sessionCode?: string;
483
+ status: MessageStatus;
484
+ } | {
485
+ content: string[];
486
+ duration?: number;
487
+ role: MessageRole.Reasoning;
488
+ id?: string;
489
+ messageId?: string;
490
+ name?: string;
491
+ sessionCode?: string;
492
+ status: MessageStatus;
493
+ } | {
494
+ content: string;
495
+ role: MessageRole.System;
496
+ id?: string;
497
+ messageId?: string;
498
+ name?: string;
499
+ sessionCode?: string;
500
+ status: MessageStatus;
501
+ } | {
502
+ content: string;
503
+ role: MessageRole.TemplateAssistant;
504
+ id?: string;
505
+ messageId?: string;
506
+ name?: string;
507
+ sessionCode?: string;
508
+ status: MessageStatus;
509
+ } | {
510
+ content: string;
511
+ role: MessageRole.TemplateGuide;
512
+ id?: string;
513
+ messageId?: string;
514
+ name?: string;
515
+ sessionCode?: string;
516
+ status: MessageStatus;
517
+ } | {
518
+ content: string;
519
+ role: MessageRole.TemplateHidden;
520
+ id?: string;
521
+ messageId?: string;
522
+ name?: string;
523
+ sessionCode?: string;
524
+ status: MessageStatus;
525
+ } | {
526
+ content: string;
527
+ role: MessageRole.TemplateSystem;
528
+ id?: string;
529
+ messageId?: string;
530
+ name?: string;
531
+ sessionCode?: string;
532
+ status: MessageStatus;
533
+ } | {
534
+ content: string;
535
+ role: MessageRole.TemplateUser;
536
+ id?: string;
537
+ messageId?: string;
538
+ name?: string;
539
+ sessionCode?: string;
540
+ status: MessageStatus;
541
+ } | {
542
+ content: string;
543
+ duration?: number;
544
+ error?: string;
545
+ role: MessageRole.Tool;
546
+ toolCallId: string;
547
+ id?: string;
548
+ messageId?: string;
549
+ name?: string;
550
+ sessionCode?: string;
551
+ status: MessageStatus;
552
+ } | {
553
+ content: string | ({
554
+ data?: string;
555
+ filename?: string;
556
+ id?: string;
557
+ mimeType: string;
558
+ type: import("../message").MessageType.Binary;
559
+ url?: string;
560
+ } | {
561
+ text: string;
562
+ type: import("../message").MessageType.Text;
563
+ })[];
564
+ property?: {
565
+ [x: string]: unknown;
566
+ extra?: {
567
+ [x: string]: unknown;
568
+ cite?: string | {
569
+ data: {
570
+ key: string;
571
+ value: string;
572
+ }[];
573
+ title: string;
574
+ type: string;
575
+ };
576
+ command?: string;
577
+ context?: Array<Record<string, unknown>>;
578
+ };
579
+ };
580
+ role: MessageRole.User;
581
+ id?: string;
582
+ messageId?: string;
583
+ name?: string;
584
+ sessionCode?: string;
585
+ status: MessageStatus;
586
+ })[];
587
+ };
588
+ }>;
589
+ isInfoLoading: import("vue").Ref<boolean, boolean>;
590
+ isChatting: import("vue").Ref<boolean, boolean>;
591
+ chat: (userInput: IUserMessage["content"], sessionCode: string, url?: string, config?: IRequestConfig, property?: IMessageProperty) => Promise<void>;
592
+ resendMessage: (messageId: string, sessionCode: string, newContent?: IUserMessage["content"], url?: string, config?: IRequestConfig) => Promise<void>;
593
+ resumeStreamingChat: (sessionCode: string, url?: string, config?: IRequestConfig) => void;
594
+ abortChat: () => void;
595
+ stopChat: (sessionCode: string) => Promise<void>;
596
+ getAgentInfo: () => Promise<void>;
597
+ reset: (protocol: ISSEProtocol) => void;
598
+ };
599
+ export type IAgentModule = ReturnType<typeof useAgent>;