@or-sdk/knowledge-models 0.24.3 → 0.25.0-beta.598.0

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.
@@ -1,23 +1,3 @@
1
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
2
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
3
- return new (P || (P = Promise))(function (resolve, reject) {
4
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
5
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
6
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
7
- step((generator = generator.apply(thisArg, _arguments || [])).next());
8
- });
9
- };
10
- var __rest = (this && this.__rest) || function (s, e) {
11
- var t = {};
12
- for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
13
- t[p] = s[p];
14
- if (s != null && typeof Object.getOwnPropertySymbols === "function")
15
- for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
16
- if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
17
- t[p[i]] = s[p[i]];
18
- }
19
- return t;
20
- };
21
1
  import { Base, makeList } from '@or-sdk/base';
22
2
  import { getEntityBody } from './utils';
23
3
  import { SERVICE_KEY } from './constants';
@@ -31,830 +11,723 @@ export class KnowledgeModels extends Base {
31
11
  serviceUrl: nluUrl,
32
12
  });
33
13
  }
34
- getFullList(method, route, queryParams = {}) {
35
- return __awaiter(this, void 0, void 0, function* () {
36
- const params = Object.assign(Object.assign({}, queryParams), { last: undefined });
37
- let result;
38
- let list = [];
39
- do {
40
- result = yield this.callApi({
41
- method,
42
- route,
43
- params,
44
- });
45
- list = [...list, ...result.items];
46
- params.last = result.last;
47
- } while (result.last && result.items.length);
48
- return makeList(list);
49
- });
50
- }
51
- listKnowledgeModels() {
52
- return __awaiter(this, void 0, void 0, function* () {
53
- return this.getFullList('GET', '/knowledge-base');
54
- });
55
- }
56
- getKnowledgeModel(id) {
57
- return __awaiter(this, void 0, void 0, function* () {
58
- const list = yield this.listKnowledgeModels();
59
- return list.items.find(km => km.id === id);
60
- });
61
- }
62
- createKnowledgeModel({ name, desc, imageSrc, config, culture, extensions }) {
63
- return __awaiter(this, void 0, void 0, function* () {
64
- const data = {
65
- name,
66
- desc,
67
- imageSrc,
68
- culture,
69
- config,
70
- extensions,
71
- };
72
- return this.callApi({
73
- method: 'POST',
74
- route: '/knowledge-base',
75
- data,
76
- });
77
- });
78
- }
79
- updateKnowledgeModel(knowledgeModel) {
80
- return __awaiter(this, void 0, void 0, function* () {
81
- return this.callApi({
82
- method: 'PUT',
83
- route: '/knowledge-base',
84
- data: knowledgeModel,
85
- });
86
- });
87
- }
88
- getLimitsIndex() {
89
- return __awaiter(this, void 0, void 0, function* () {
90
- return this.callApi({
91
- method: 'GET',
92
- route: '/administration/limits/index',
93
- });
94
- });
95
- }
96
- getLimits(path) {
97
- return __awaiter(this, void 0, void 0, function* () {
98
- const params = {
99
- path,
100
- };
101
- return this.callApi({
102
- method: 'GET',
103
- route: '/administration/limits',
104
- params,
105
- });
106
- });
107
- }
108
- postLimits({ accountId, limits }) {
109
- return __awaiter(this, void 0, void 0, function* () {
110
- const data = {
111
- accountId,
112
- limits,
113
- };
114
- yield this.callApi({
115
- method: 'POST',
116
- route: '/administration/limits',
117
- data,
118
- });
119
- });
120
- }
121
- listPrebuiltEntities({ language } = {}) {
122
- return __awaiter(this, void 0, void 0, function* () {
123
- const params = {
124
- language,
125
- };
126
- const result = yield this.callApi({
127
- method: 'GET',
128
- route: '/kb/entities/prebuilt/all',
129
- params,
130
- });
131
- return makeList(result);
132
- });
133
- }
134
- listEntities({ type, kbId, versionId, limit }) {
135
- return __awaiter(this, void 0, void 0, function* () {
136
- const params = {
137
- kbId,
138
- versionId,
139
- limit,
140
- };
141
- return this.getFullList('GET', `/kb/entities/${type}`, params);
142
- });
143
- }
144
- listFeatures({ kbId, versionId, limit }) {
145
- return __awaiter(this, void 0, void 0, function* () {
146
- const params = {
147
- kbId,
148
- versionId,
149
- limit,
150
- };
151
- return this.getFullList('GET', '/phraselists', params);
152
- });
153
- }
154
- listApplications({ kbId, text, pattern, versionId, limit, projection }) {
155
- return __awaiter(this, void 0, void 0, function* () {
156
- const params = {
157
- kbId,
158
- limit,
159
- text,
160
- pattern,
161
- versionId,
162
- projection,
163
- };
164
- return this.getFullList('GET', '/applications', params);
165
- });
166
- }
167
- listIntentsLabels({ appId, kbId }) {
168
- return __awaiter(this, void 0, void 0, function* () {
169
- const params = {
170
- appId,
171
- kbId,
172
- };
173
- return this.callApi({
174
- method: 'GET',
175
- route: '/intents/labels',
176
- params,
177
- });
178
- });
179
- }
180
- listUtterances(_a) {
181
- var { kbId, limit } = _a, query = __rest(_a, ["kbId", "limit"]);
182
- return __awaiter(this, void 0, void 0, function* () {
183
- const params = Object.assign({ kbId,
184
- limit }, query);
185
- return this.getFullList('GET', '/utterances', params);
186
- });
187
- }
188
- listPatterns(_a) {
189
- var { kbId, limit } = _a, query = __rest(_a, ["kbId", "limit"]);
190
- return __awaiter(this, void 0, void 0, function* () {
191
- const params = Object.assign({ kbId,
192
- limit }, query);
193
- return this.getFullList('GET', '/patterns', params);
194
- });
195
- }
196
- listPrebuiltModels(_a = {}) {
197
- var { limit } = _a, query = __rest(_a, ["limit"]);
198
- return __awaiter(this, void 0, void 0, function* () {
199
- const params = Object.assign({ limit }, query);
200
- return this.getFullList('GET', '/prebuilt-models', params);
201
- });
202
- }
203
- removePrebuiltModelFromKM({ prebuiltModelId, kbId }) {
204
- return __awaiter(this, void 0, void 0, function* () {
205
- const params = {
206
- prebuiltModelId,
207
- kbId,
208
- };
209
- yield this.callApi({
210
- method: 'DELETE',
211
- route: '/knowledge-base/prebuilt-model',
212
- params,
213
- });
214
- });
215
- }
216
- addPrebuiltModelToKM({ kbId, prebuiltModelId, appId, appName, shouldCreateNewApplication, responses, entities, }) {
217
- return __awaiter(this, void 0, void 0, function* () {
218
- const data = {
219
- kbId,
220
- appId,
221
- prebuiltModelId,
222
- appName,
223
- shouldCreateNewApplication,
224
- responses,
225
- entities,
226
- };
227
- return this.callApi({
228
- method: 'POST',
229
- route: '/knowledge-base/prebuilt-model',
230
- data,
231
- });
232
- });
233
- }
234
- getPrebuiltModelDetails({ kbId, prebuiltModelId }) {
235
- return __awaiter(this, void 0, void 0, function* () {
236
- const params = {
237
- kbId,
238
- prebuiltModelId,
239
- };
240
- return this.callApi({
241
- method: 'GET',
242
- route: '/knowledge-base/prebuilt-model',
243
- params,
244
- });
245
- });
246
- }
247
- createApplication({ kbId, name, desc, culture, model_features }) {
248
- return __awaiter(this, void 0, void 0, function* () {
249
- const data = {
250
- kbId,
251
- name,
252
- desc,
253
- culture,
254
- model_features,
255
- };
256
- return this.callApi({
257
- method: 'POST',
258
- route: '/applications',
259
- data,
260
- });
261
- });
262
- }
263
- createIntent({ name, type, kbId, appId, postprocessFlows, customData, features }) {
264
- return __awaiter(this, void 0, void 0, function* () {
265
- const data = {
266
- name,
267
- type,
268
- postprocessFlows,
269
- customData,
270
- features,
271
- };
272
- const params = {
273
- kbId,
274
- appId,
275
- };
276
- return this.callApi({
277
- method: 'POST',
278
- route: '/intents',
279
- data,
280
- params,
281
- });
282
- });
283
- }
284
- createUtterance({ appId, kbId, autoGenerated, text, intent, entities }) {
285
- return __awaiter(this, void 0, void 0, function* () {
286
- const data = {
287
- autoGenerated,
288
- text,
289
- intent,
290
- entities,
291
- };
292
- const params = {
293
- kbId,
294
- appId,
295
- };
296
- return this.callApi({
297
- method: 'POST',
298
- route: '/utterances',
299
- data,
300
- params,
301
- });
302
- });
303
- }
304
- createPattern({ appId, kbId, pattern, intent, entities }) {
305
- return __awaiter(this, void 0, void 0, function* () {
306
- const data = {
307
- pattern,
308
- intent,
309
- entities,
310
- };
311
- const params = {
312
- kbId,
313
- appId,
314
- };
315
- return this.callApi({
316
- method: 'POST',
317
- route: '/patterns',
318
- data,
319
- params,
320
- });
321
- });
322
- }
323
- createPair({ kbId, applicationName, intentName, intentType, utteranceText }) {
324
- return __awaiter(this, void 0, void 0, function* () {
325
- const data = {
326
- kbId,
327
- applicationName,
328
- intentName,
329
- intentType,
330
- utteranceText,
331
- };
332
- return this.callApi({
333
- method: 'POST',
334
- route: '/knowledge-base/pair',
335
- data,
336
- });
337
- });
338
- }
339
- batchCreatePairs({ kbId, utterances }) {
340
- return __awaiter(this, void 0, void 0, function* () {
341
- const data = {
342
- kbId,
343
- utterances,
344
- };
345
- return this.callApi({
346
- method: 'POST',
347
- route: '/knowledge-base/pairs',
348
- data,
349
- });
350
- });
351
- }
352
- batchCreatePairsFile({ kbId, fileUrl }) {
353
- return __awaiter(this, void 0, void 0, function* () {
354
- const data = {
355
- kbId,
356
- fileUrl,
357
- };
358
- return this.callApi({
359
- method: 'POST',
360
- route: '/knowledge-base/pairs/file',
361
- data,
362
- });
363
- });
364
- }
365
- createPatternPair({ kbId, applicationName, intentName, intentType, patternText, patternEntities }) {
366
- return __awaiter(this, void 0, void 0, function* () {
367
- const data = {
368
- kbId,
369
- applicationName,
370
- intentName,
371
- intentType,
372
- patternText,
373
- patternEntities,
374
- };
375
- return this.callApi({
376
- method: 'POST',
377
- route: '/knowledge-base/patterns/pair',
378
- data,
379
- });
380
- });
381
- }
382
- createPairsCsv({ kbId, fileUrl, applicationName, delimiter }) {
383
- return __awaiter(this, void 0, void 0, function* () {
384
- const data = {
385
- kbId,
386
- applicationName,
387
- fileUrl,
388
- delimiter,
389
- };
390
- return this.callApi({
391
- method: 'POST',
392
- route: '/knowledge-base/pair/csv',
393
- data,
394
- });
395
- });
396
- }
397
- createEntity(_a) {
398
- var { type, kbId, name, roles } = _a, rest = __rest(_a, ["type", "kbId", "name", "roles"]);
399
- return __awaiter(this, void 0, void 0, function* () {
400
- const data = getEntityBody(type, Object.assign({ name,
401
- roles }, rest));
402
- const params = {
403
- kbId,
404
- };
405
- return this.callApi({
406
- method: 'POST',
407
- route: `/kb/entities/${type}`,
408
- data,
409
- params,
410
- });
411
- });
412
- }
413
- createFeature({ kbId, name, mode, words, enabledForAllModels }) {
414
- return __awaiter(this, void 0, void 0, function* () {
415
- const data = {
416
- name,
417
- mode,
418
- words,
419
- enabledForAllModels,
420
- };
421
- const params = {
422
- kbId,
423
- };
424
- return this.callApi({
425
- method: 'POST',
426
- route: '/phraselists',
427
- data,
428
- params,
429
- });
430
- });
431
- }
432
- updateApplication({ kbId, id, name, desc, model_features }) {
433
- return __awaiter(this, void 0, void 0, function* () {
434
- const data = {
435
- kbId,
436
- id,
437
- name,
438
- desc,
439
- model_features,
440
- };
441
- return this.callApi({
442
- method: 'PUT',
443
- route: '/applications',
444
- data: data,
445
- });
446
- });
447
- }
448
- updateIntent({ name, type, id, appId, kbId, postprocessFlows, customData, features }) {
449
- return __awaiter(this, void 0, void 0, function* () {
450
- const data = {
451
- name,
452
- type,
453
- postprocessFlows,
454
- customData,
455
- features,
456
- };
457
- const params = {
458
- id,
459
- kbId,
460
- appId,
461
- };
462
- return this.callApi({
463
- method: 'PUT',
464
- route: '/intents',
465
- data,
466
- params,
467
- });
468
- });
469
- }
470
- updateUtterance({ appId, kbId, utterance }) {
471
- return __awaiter(this, void 0, void 0, function* () {
472
- const params = {
473
- kbId,
474
- appId,
475
- };
476
- return this.callApi({
477
- method: 'PUT',
478
- route: '/utterances',
479
- data: utterance,
480
- params,
481
- });
482
- });
483
- }
484
- updatePattern({ appId, kbId, pattern }) {
485
- return __awaiter(this, void 0, void 0, function* () {
486
- const params = {
487
- kbId,
488
- appId,
489
- };
490
- return this.callApi({
491
- method: 'PUT',
492
- route: '/patterns',
493
- data: pattern,
494
- params,
495
- });
496
- });
497
- }
498
- updatePair({ kbId, applicationName, intentName, intentType, utterance }) {
499
- return __awaiter(this, void 0, void 0, function* () {
500
- const data = {
501
- kbId,
502
- applicationName,
503
- intentName,
504
- intentType,
505
- utterance,
506
- };
507
- yield this.callApi({
508
- method: 'PUT',
509
- route: '/knowledge-base/pair',
510
- data,
511
- });
512
- });
513
- }
514
- batchUpdatePairs({ kbId, utterances }) {
515
- return __awaiter(this, void 0, void 0, function* () {
516
- const params = {
517
- kbId,
518
- };
519
- return this.callApi({
520
- method: 'PUT',
521
- route: '/knowledge-base/pairs',
522
- data: utterances,
523
- params,
524
- });
525
- });
526
- }
527
- updateEntity(_a) {
528
- var { type, id, kbId, name, roles } = _a, rest = __rest(_a, ["type", "id", "kbId", "name", "roles"]);
529
- return __awaiter(this, void 0, void 0, function* () {
530
- const data = getEntityBody(type, Object.assign({ name,
531
- roles }, rest));
532
- const params = {
533
- id,
534
- kbId,
535
- };
536
- return this.callApi({
537
- method: 'PUT',
538
- route: `/kb/entities/${type}`,
539
- data,
540
- params,
541
- });
542
- });
543
- }
544
- updateFeature({ kbId, id, name, mode, words, enabledForAllModels, activated = true }) {
545
- return __awaiter(this, void 0, void 0, function* () {
546
- const data = {
547
- name,
548
- mode,
549
- words,
550
- enabledForAllModels,
551
- activated,
552
- };
553
- const params = {
554
- id,
555
- kbId,
556
- };
557
- return this.callApi({
558
- method: 'PUT',
559
- route: '/phraselists',
560
- data,
561
- params,
562
- });
563
- });
564
- }
565
- updatePrebuiltEntities({ kbId, id, entity }) {
566
- return __awaiter(this, void 0, void 0, function* () {
567
- const params = {
568
- kbId,
569
- id,
570
- };
571
- return this.callApi({
572
- method: 'PUT',
573
- route: '/kb/entities/prebuilt',
574
- data: entity,
575
- params,
576
- });
577
- });
578
- }
579
- deleteKnowledgeBase({ id }) {
580
- return __awaiter(this, void 0, void 0, function* () {
581
- const params = {
582
- id,
583
- };
584
- yield this.callApi({
585
- method: 'DELETE',
586
- route: '/knowledge-base',
587
- params,
588
- });
589
- });
590
- }
591
- deleteApplication({ kbId, appId }) {
592
- return __awaiter(this, void 0, void 0, function* () {
593
- const params = {
594
- kbId,
595
- appId,
596
- };
597
- yield this.callApi({
598
- method: 'DELETE',
599
- route: '/applications',
600
- params,
601
- });
602
- });
603
- }
604
- deleteIntent({ id, appId, kbId }) {
605
- return __awaiter(this, void 0, void 0, function* () {
606
- const params = {
607
- id,
608
- kbId,
609
- appId,
610
- deleteUtterances: true,
611
- };
612
- yield this.callApi({
613
- method: 'DELETE',
614
- route: '/intents',
615
- params,
616
- });
617
- });
618
- }
619
- deleteUtterance({ id, kbId }) {
620
- return __awaiter(this, void 0, void 0, function* () {
621
- const params = {
622
- id,
623
- kbId,
624
- };
625
- yield this.callApi({
626
- method: 'DELETE',
627
- route: '/utterances',
628
- params,
629
- });
630
- });
631
- }
632
- batchDeleteUtterances({ ids, kbId }) {
633
- return __awaiter(this, void 0, void 0, function* () {
634
- const params = {
635
- kbId,
636
- };
637
- yield this.callApi({
638
- method: 'POST',
639
- route: '/utterances/bulk/delete',
640
- params,
641
- data: ids,
642
- });
643
- });
644
- }
645
- deletePattern({ id, kbId }) {
646
- return __awaiter(this, void 0, void 0, function* () {
647
- const params = {
648
- id,
649
- kbId,
650
- };
651
- yield this.callApi({
652
- method: 'DELETE',
653
- route: '/patterns',
654
- params,
655
- });
656
- });
657
- }
658
- deleteEntity({ type, id, kbId }) {
659
- return __awaiter(this, void 0, void 0, function* () {
660
- const params = {
661
- id,
662
- kbId,
663
- };
664
- yield this.callApi({
665
- method: 'DELETE',
666
- route: `/kb/entities/${type}`,
667
- params,
668
- });
669
- });
670
- }
671
- deleteFeature({ id, kbId }) {
672
- return __awaiter(this, void 0, void 0, function* () {
673
- const params = {
674
- id,
675
- kbId,
676
- };
677
- yield this.callApi({
678
- method: 'DELETE',
679
- route: '/phraselists',
680
- params,
681
- });
682
- });
683
- }
684
- getTrainStatus({ kbId, versionId = null }) {
685
- return __awaiter(this, void 0, void 0, function* () {
686
- const params = {
687
- kbId,
688
- versionId,
689
- };
690
- return this.callApi({
691
- method: 'GET',
692
- route: '/train/status',
693
- params,
694
- });
695
- });
696
- }
697
- train({ kbId, flowId, phraseId, sessionId, autoPublish }) {
698
- return __awaiter(this, void 0, void 0, function* () {
699
- const params = {
700
- kbId,
701
- flowId,
702
- phraseId,
703
- sessionId,
704
- autoPublish,
705
- };
706
- return this.callApi({
707
- method: 'POST',
708
- route: '/kb/train',
709
- params,
710
- data: null,
711
- });
712
- });
713
- }
714
- trainForTest({ kbId, flowId, phraseId, sessionId }) {
715
- return __awaiter(this, void 0, void 0, function* () {
716
- const params = {
717
- kbId,
718
- flowId,
719
- phraseId,
720
- sessionId,
721
- };
722
- return this.callApi({
723
- method: 'POST',
724
- route: '/kb/train/test',
725
- params,
726
- data: null,
727
- });
728
- });
729
- }
730
- publish({ kbId, versionId = null }) {
731
- return __awaiter(this, void 0, void 0, function* () {
732
- const params = {
733
- kbId,
734
- versionId,
735
- };
736
- return this.callApi({
737
- method: 'POST',
738
- route: '/kb/publish',
739
- params,
740
- data: null,
741
- });
742
- });
743
- }
744
- recover({ kbId, versionId }) {
745
- return __awaiter(this, void 0, void 0, function* () {
746
- const params = {
747
- kbId,
748
- versionId,
749
- };
750
- yield this.callApi({
751
- method: 'POST',
752
- route: '/kb/recover',
753
- params,
754
- data: null,
755
- });
756
- });
757
- }
758
- deleteVersion({ kbId, versionId }) {
759
- return __awaiter(this, void 0, void 0, function* () {
760
- const params = {
761
- kbId,
762
- versionId,
763
- };
764
- yield this.callApi({
765
- method: 'DELETE',
766
- route: '/kb/versions',
767
- params,
768
- });
769
- });
770
- }
771
- clone({ kbId, newName }) {
772
- return __awaiter(this, void 0, void 0, function* () {
773
- const data = {
774
- newName,
775
- };
776
- const params = {
777
- id: kbId,
778
- };
779
- return this.callApi({
780
- method: 'POST',
781
- route: '/knowledge-base/clone',
782
- params,
783
- data,
784
- });
785
- });
786
- }
787
- export({ kbId, isPublic }) {
788
- return __awaiter(this, void 0, void 0, function* () {
789
- const params = {
790
- id: kbId,
791
- isPublic,
792
- };
793
- return this.callApi({
794
- method: 'GET',
795
- route: '/knowledge-base/export',
796
- params,
797
- });
798
- });
799
- }
800
- import({ fileUrl, knowledgeBase }) {
801
- return __awaiter(this, void 0, void 0, function* () {
802
- const data = {
803
- fileUrl,
804
- knowledgeBase,
805
- };
806
- return this.callApi({
807
- method: 'POST',
808
- route: '/knowledge-base/import',
809
- data,
810
- });
811
- });
812
- }
813
- importJson(data) {
814
- return __awaiter(this, void 0, void 0, function* () {
815
- return this.callApi({
816
- method: 'POST',
817
- route: '/knowledge-base/import/json',
818
- data,
819
- });
820
- });
821
- }
822
- importCsv({ fileUrl, knowledgeBase, applicationName, delimiter }) {
823
- return __awaiter(this, void 0, void 0, function* () {
824
- const data = {
825
- fileUrl,
826
- knowledgeBase,
827
- applicationName,
828
- delimiter,
829
- };
830
- return this.callApi({
831
- method: 'POST',
832
- route: '/knowledge-base/import/csv',
833
- data,
834
- });
835
- });
836
- }
837
- meaning(data) {
838
- return __awaiter(this, void 0, void 0, function* () {
839
- return this.callApi({
840
- method: 'POST',
841
- route: '/meaning',
842
- data,
843
- });
844
- });
845
- }
846
- testMeaning({ q, appId, kbId }) {
847
- return __awaiter(this, void 0, void 0, function* () {
848
- const data = {
849
- q,
850
- appId,
851
- kbId,
852
- };
853
- return this.callApi({
854
- method: 'POST',
855
- route: '/meaning/test',
856
- data,
857
- });
14
+ async getFullList(method, route, queryParams = {}) {
15
+ const params = {
16
+ ...queryParams,
17
+ last: undefined,
18
+ };
19
+ let result;
20
+ let list = [];
21
+ do {
22
+ result = await this.callApi({
23
+ method,
24
+ route,
25
+ params,
26
+ });
27
+ list = [...list, ...result.items];
28
+ params.last = result.last;
29
+ } while (result.last && result.items.length);
30
+ return makeList(list);
31
+ }
32
+ async listKnowledgeModels() {
33
+ return this.getFullList('GET', '/knowledge-base');
34
+ }
35
+ async getKnowledgeModel(id) {
36
+ const list = await this.listKnowledgeModels();
37
+ return list.items.find(km => km.id === id);
38
+ }
39
+ async createKnowledgeModel({ name, desc, imageSrc, config, culture, extensions }) {
40
+ const data = {
41
+ name,
42
+ desc,
43
+ imageSrc,
44
+ culture,
45
+ config,
46
+ extensions,
47
+ };
48
+ return this.callApi({
49
+ method: 'POST',
50
+ route: '/knowledge-base',
51
+ data,
52
+ });
53
+ }
54
+ async updateKnowledgeModel(knowledgeModel) {
55
+ return this.callApi({
56
+ method: 'PUT',
57
+ route: '/knowledge-base',
58
+ data: knowledgeModel,
59
+ });
60
+ }
61
+ async getLimitsIndex() {
62
+ return this.callApi({
63
+ method: 'GET',
64
+ route: '/administration/limits/index',
65
+ });
66
+ }
67
+ async getLimits(path) {
68
+ const params = {
69
+ path,
70
+ };
71
+ return this.callApi({
72
+ method: 'GET',
73
+ route: '/administration/limits',
74
+ params,
75
+ });
76
+ }
77
+ async postLimits({ accountId, limits }) {
78
+ const data = {
79
+ accountId,
80
+ limits,
81
+ };
82
+ await this.callApi({
83
+ method: 'POST',
84
+ route: '/administration/limits',
85
+ data,
86
+ });
87
+ }
88
+ async listPrebuiltEntities({ language } = {}) {
89
+ const params = {
90
+ language,
91
+ };
92
+ const result = await this.callApi({
93
+ method: 'GET',
94
+ route: '/kb/entities/prebuilt/all',
95
+ params,
96
+ });
97
+ return makeList(result);
98
+ }
99
+ async listEntities({ type, kbId, versionId, limit }) {
100
+ const params = {
101
+ kbId,
102
+ versionId,
103
+ limit,
104
+ };
105
+ return this.getFullList('GET', `/kb/entities/${type}`, params);
106
+ }
107
+ async listFeatures({ kbId, versionId, limit }) {
108
+ const params = {
109
+ kbId,
110
+ versionId,
111
+ limit,
112
+ };
113
+ return this.getFullList('GET', '/phraselists', params);
114
+ }
115
+ async listApplications({ kbId, text, pattern, versionId, limit, projection }) {
116
+ const params = {
117
+ kbId,
118
+ limit,
119
+ text,
120
+ pattern,
121
+ versionId,
122
+ projection,
123
+ };
124
+ return this.getFullList('GET', '/applications', params);
125
+ }
126
+ async listIntentsLabels({ appId, kbId }) {
127
+ const params = {
128
+ appId,
129
+ kbId,
130
+ };
131
+ return this.callApi({
132
+ method: 'GET',
133
+ route: '/intents/labels',
134
+ params,
135
+ });
136
+ }
137
+ async listUtterances({ kbId, limit, ...query }) {
138
+ const params = {
139
+ kbId,
140
+ limit,
141
+ ...query,
142
+ };
143
+ return this.getFullList('GET', '/utterances', params);
144
+ }
145
+ async listPatterns({ kbId, limit, ...query }) {
146
+ const params = {
147
+ kbId,
148
+ limit,
149
+ ...query,
150
+ };
151
+ return this.getFullList('GET', '/patterns', params);
152
+ }
153
+ async listPrebuiltModels({ limit, ...query } = {}) {
154
+ const params = {
155
+ limit,
156
+ ...query,
157
+ };
158
+ return this.getFullList('GET', '/prebuilt-models', params);
159
+ }
160
+ async removePrebuiltModelFromKM({ prebuiltModelId, kbId }) {
161
+ const params = {
162
+ prebuiltModelId,
163
+ kbId,
164
+ };
165
+ await this.callApi({
166
+ method: 'DELETE',
167
+ route: '/knowledge-base/prebuilt-model',
168
+ params,
169
+ });
170
+ }
171
+ async addPrebuiltModelToKM({ kbId, prebuiltModelId, appId, appName, shouldCreateNewApplication, responses, entities, }) {
172
+ const data = {
173
+ kbId,
174
+ appId,
175
+ prebuiltModelId,
176
+ appName,
177
+ shouldCreateNewApplication,
178
+ responses,
179
+ entities,
180
+ };
181
+ return this.callApi({
182
+ method: 'POST',
183
+ route: '/knowledge-base/prebuilt-model',
184
+ data,
185
+ });
186
+ }
187
+ async getPrebuiltModelDetails({ kbId, prebuiltModelId }) {
188
+ const params = {
189
+ kbId,
190
+ prebuiltModelId,
191
+ };
192
+ return this.callApi({
193
+ method: 'GET',
194
+ route: '/knowledge-base/prebuilt-model',
195
+ params,
196
+ });
197
+ }
198
+ async createApplication({ kbId, name, desc, culture, model_features }) {
199
+ const data = {
200
+ kbId,
201
+ name,
202
+ desc,
203
+ culture,
204
+ model_features,
205
+ };
206
+ return this.callApi({
207
+ method: 'POST',
208
+ route: '/applications',
209
+ data,
210
+ });
211
+ }
212
+ async createIntent({ name, type, kbId, appId, postprocessFlows, customData, features }) {
213
+ const data = {
214
+ name,
215
+ type,
216
+ postprocessFlows,
217
+ customData,
218
+ features,
219
+ };
220
+ const params = {
221
+ kbId,
222
+ appId,
223
+ };
224
+ return this.callApi({
225
+ method: 'POST',
226
+ route: '/intents',
227
+ data,
228
+ params,
229
+ });
230
+ }
231
+ async createUtterance({ appId, kbId, autoGenerated, text, intent, entities }) {
232
+ const data = {
233
+ autoGenerated,
234
+ text,
235
+ intent,
236
+ entities,
237
+ };
238
+ const params = {
239
+ kbId,
240
+ appId,
241
+ };
242
+ return this.callApi({
243
+ method: 'POST',
244
+ route: '/utterances',
245
+ data,
246
+ params,
247
+ });
248
+ }
249
+ async createPattern({ appId, kbId, pattern, intent, entities }) {
250
+ const data = {
251
+ pattern,
252
+ intent,
253
+ entities,
254
+ };
255
+ const params = {
256
+ kbId,
257
+ appId,
258
+ };
259
+ return this.callApi({
260
+ method: 'POST',
261
+ route: '/patterns',
262
+ data,
263
+ params,
264
+ });
265
+ }
266
+ async createPair({ kbId, applicationName, intentName, intentType, utteranceText }) {
267
+ const data = {
268
+ kbId,
269
+ applicationName,
270
+ intentName,
271
+ intentType,
272
+ utteranceText,
273
+ };
274
+ return this.callApi({
275
+ method: 'POST',
276
+ route: '/knowledge-base/pair',
277
+ data,
278
+ });
279
+ }
280
+ async batchCreatePairs({ kbId, utterances }) {
281
+ const data = {
282
+ kbId,
283
+ utterances,
284
+ };
285
+ return this.callApi({
286
+ method: 'POST',
287
+ route: '/knowledge-base/pairs',
288
+ data,
289
+ });
290
+ }
291
+ async batchCreatePairsFile({ kbId, fileUrl }) {
292
+ const data = {
293
+ kbId,
294
+ fileUrl,
295
+ };
296
+ return this.callApi({
297
+ method: 'POST',
298
+ route: '/knowledge-base/pairs/file',
299
+ data,
300
+ });
301
+ }
302
+ async createPatternPair({ kbId, applicationName, intentName, intentType, patternText, patternEntities }) {
303
+ const data = {
304
+ kbId,
305
+ applicationName,
306
+ intentName,
307
+ intentType,
308
+ patternText,
309
+ patternEntities,
310
+ };
311
+ return this.callApi({
312
+ method: 'POST',
313
+ route: '/knowledge-base/patterns/pair',
314
+ data,
315
+ });
316
+ }
317
+ async createPairsCsv({ kbId, fileUrl, applicationName, delimiter }) {
318
+ const data = {
319
+ kbId,
320
+ applicationName,
321
+ fileUrl,
322
+ delimiter,
323
+ };
324
+ return this.callApi({
325
+ method: 'POST',
326
+ route: '/knowledge-base/pair/csv',
327
+ data,
328
+ });
329
+ }
330
+ async createEntity({ type, kbId, name, roles, ...rest }) {
331
+ const data = getEntityBody(type, {
332
+ name,
333
+ roles,
334
+ ...rest,
335
+ });
336
+ const params = {
337
+ kbId,
338
+ };
339
+ return this.callApi({
340
+ method: 'POST',
341
+ route: `/kb/entities/${type}`,
342
+ data,
343
+ params,
344
+ });
345
+ }
346
+ async createFeature({ kbId, name, mode, words, enabledForAllModels }) {
347
+ const data = {
348
+ name,
349
+ mode,
350
+ words,
351
+ enabledForAllModels,
352
+ };
353
+ const params = {
354
+ kbId,
355
+ };
356
+ return this.callApi({
357
+ method: 'POST',
358
+ route: '/phraselists',
359
+ data,
360
+ params,
361
+ });
362
+ }
363
+ async updateApplication({ kbId, id, name, desc, model_features }) {
364
+ const data = {
365
+ kbId,
366
+ id,
367
+ name,
368
+ desc,
369
+ model_features,
370
+ };
371
+ return this.callApi({
372
+ method: 'PUT',
373
+ route: '/applications',
374
+ data: data,
375
+ });
376
+ }
377
+ async updateIntent({ name, type, id, appId, kbId, postprocessFlows, customData, features }) {
378
+ const data = {
379
+ name,
380
+ type,
381
+ postprocessFlows,
382
+ customData,
383
+ features,
384
+ };
385
+ const params = {
386
+ id,
387
+ kbId,
388
+ appId,
389
+ };
390
+ return this.callApi({
391
+ method: 'PUT',
392
+ route: '/intents',
393
+ data,
394
+ params,
395
+ });
396
+ }
397
+ async updateUtterance({ appId, kbId, utterance }) {
398
+ const params = {
399
+ kbId,
400
+ appId,
401
+ };
402
+ return this.callApi({
403
+ method: 'PUT',
404
+ route: '/utterances',
405
+ data: utterance,
406
+ params,
407
+ });
408
+ }
409
+ async updatePattern({ appId, kbId, pattern }) {
410
+ const params = {
411
+ kbId,
412
+ appId,
413
+ };
414
+ return this.callApi({
415
+ method: 'PUT',
416
+ route: '/patterns',
417
+ data: pattern,
418
+ params,
419
+ });
420
+ }
421
+ async updatePair({ kbId, applicationName, intentName, intentType, utterance }) {
422
+ const data = {
423
+ kbId,
424
+ applicationName,
425
+ intentName,
426
+ intentType,
427
+ utterance,
428
+ };
429
+ await this.callApi({
430
+ method: 'PUT',
431
+ route: '/knowledge-base/pair',
432
+ data,
433
+ });
434
+ }
435
+ async batchUpdatePairs({ kbId, utterances }) {
436
+ const params = {
437
+ kbId,
438
+ };
439
+ return this.callApi({
440
+ method: 'PUT',
441
+ route: '/knowledge-base/pairs',
442
+ data: utterances,
443
+ params,
444
+ });
445
+ }
446
+ async updateEntity({ type, id, kbId, name, roles, ...rest }) {
447
+ const data = getEntityBody(type, {
448
+ name,
449
+ roles,
450
+ ...rest,
451
+ });
452
+ const params = {
453
+ id,
454
+ kbId,
455
+ };
456
+ return this.callApi({
457
+ method: 'PUT',
458
+ route: `/kb/entities/${type}`,
459
+ data,
460
+ params,
461
+ });
462
+ }
463
+ async updateFeature({ kbId, id, name, mode, words, enabledForAllModels, activated = true }) {
464
+ const data = {
465
+ name,
466
+ mode,
467
+ words,
468
+ enabledForAllModels,
469
+ activated,
470
+ };
471
+ const params = {
472
+ id,
473
+ kbId,
474
+ };
475
+ return this.callApi({
476
+ method: 'PUT',
477
+ route: '/phraselists',
478
+ data,
479
+ params,
480
+ });
481
+ }
482
+ async updatePrebuiltEntities({ kbId, id, entity }) {
483
+ const params = {
484
+ kbId,
485
+ id,
486
+ };
487
+ return this.callApi({
488
+ method: 'PUT',
489
+ route: '/kb/entities/prebuilt',
490
+ data: entity,
491
+ params,
492
+ });
493
+ }
494
+ async deleteKnowledgeBase({ id }) {
495
+ const params = {
496
+ id,
497
+ };
498
+ await this.callApi({
499
+ method: 'DELETE',
500
+ route: '/knowledge-base',
501
+ params,
502
+ });
503
+ }
504
+ async deleteApplication({ kbId, appId }) {
505
+ const params = {
506
+ kbId,
507
+ appId,
508
+ };
509
+ await this.callApi({
510
+ method: 'DELETE',
511
+ route: '/applications',
512
+ params,
513
+ });
514
+ }
515
+ async deleteIntent({ id, appId, kbId }) {
516
+ const params = {
517
+ id,
518
+ kbId,
519
+ appId,
520
+ deleteUtterances: true,
521
+ };
522
+ await this.callApi({
523
+ method: 'DELETE',
524
+ route: '/intents',
525
+ params,
526
+ });
527
+ }
528
+ async deleteUtterance({ id, kbId }) {
529
+ const params = {
530
+ id,
531
+ kbId,
532
+ };
533
+ await this.callApi({
534
+ method: 'DELETE',
535
+ route: '/utterances',
536
+ params,
537
+ });
538
+ }
539
+ async batchDeleteUtterances({ ids, kbId }) {
540
+ const params = {
541
+ kbId,
542
+ };
543
+ await this.callApi({
544
+ method: 'POST',
545
+ route: '/utterances/bulk/delete',
546
+ params,
547
+ data: ids,
548
+ });
549
+ }
550
+ async deletePattern({ id, kbId }) {
551
+ const params = {
552
+ id,
553
+ kbId,
554
+ };
555
+ await this.callApi({
556
+ method: 'DELETE',
557
+ route: '/patterns',
558
+ params,
559
+ });
560
+ }
561
+ async deleteEntity({ type, id, kbId }) {
562
+ const params = {
563
+ id,
564
+ kbId,
565
+ };
566
+ await this.callApi({
567
+ method: 'DELETE',
568
+ route: `/kb/entities/${type}`,
569
+ params,
570
+ });
571
+ }
572
+ async deleteFeature({ id, kbId }) {
573
+ const params = {
574
+ id,
575
+ kbId,
576
+ };
577
+ await this.callApi({
578
+ method: 'DELETE',
579
+ route: '/phraselists',
580
+ params,
581
+ });
582
+ }
583
+ async getTrainStatus({ kbId, versionId = null }) {
584
+ const params = {
585
+ kbId,
586
+ versionId,
587
+ };
588
+ return this.callApi({
589
+ method: 'GET',
590
+ route: '/train/status',
591
+ params,
592
+ });
593
+ }
594
+ async train({ kbId, flowId, phraseId, sessionId, autoPublish }) {
595
+ const params = {
596
+ kbId,
597
+ flowId,
598
+ phraseId,
599
+ sessionId,
600
+ autoPublish,
601
+ };
602
+ return this.callApi({
603
+ method: 'POST',
604
+ route: '/kb/train',
605
+ params,
606
+ data: null,
607
+ });
608
+ }
609
+ async trainForTest({ kbId, flowId, phraseId, sessionId }) {
610
+ const params = {
611
+ kbId,
612
+ flowId,
613
+ phraseId,
614
+ sessionId,
615
+ };
616
+ return this.callApi({
617
+ method: 'POST',
618
+ route: '/kb/train/test',
619
+ params,
620
+ data: null,
621
+ });
622
+ }
623
+ async publish({ kbId, versionId = null }) {
624
+ const params = {
625
+ kbId,
626
+ versionId,
627
+ };
628
+ return this.callApi({
629
+ method: 'POST',
630
+ route: '/kb/publish',
631
+ params,
632
+ data: null,
633
+ });
634
+ }
635
+ async recover({ kbId, versionId }) {
636
+ const params = {
637
+ kbId,
638
+ versionId,
639
+ };
640
+ await this.callApi({
641
+ method: 'POST',
642
+ route: '/kb/recover',
643
+ params,
644
+ data: null,
645
+ });
646
+ }
647
+ async deleteVersion({ kbId, versionId }) {
648
+ const params = {
649
+ kbId,
650
+ versionId,
651
+ };
652
+ await this.callApi({
653
+ method: 'DELETE',
654
+ route: '/kb/versions',
655
+ params,
656
+ });
657
+ }
658
+ async clone({ kbId, newName }) {
659
+ const data = {
660
+ newName,
661
+ };
662
+ const params = {
663
+ id: kbId,
664
+ };
665
+ return this.callApi({
666
+ method: 'POST',
667
+ route: '/knowledge-base/clone',
668
+ params,
669
+ data,
670
+ });
671
+ }
672
+ async export({ kbId, isPublic }) {
673
+ const params = {
674
+ id: kbId,
675
+ isPublic,
676
+ };
677
+ return this.callApi({
678
+ method: 'GET',
679
+ route: '/knowledge-base/export',
680
+ params,
681
+ });
682
+ }
683
+ async import({ fileUrl, knowledgeBase }) {
684
+ const data = {
685
+ fileUrl,
686
+ knowledgeBase,
687
+ };
688
+ return this.callApi({
689
+ method: 'POST',
690
+ route: '/knowledge-base/import',
691
+ data,
692
+ });
693
+ }
694
+ async importJson(data) {
695
+ return this.callApi({
696
+ method: 'POST',
697
+ route: '/knowledge-base/import/json',
698
+ data,
699
+ });
700
+ }
701
+ async importCsv({ fileUrl, knowledgeBase, applicationName, delimiter }) {
702
+ const data = {
703
+ fileUrl,
704
+ knowledgeBase,
705
+ applicationName,
706
+ delimiter,
707
+ };
708
+ return this.callApi({
709
+ method: 'POST',
710
+ route: '/knowledge-base/import/csv',
711
+ data,
712
+ });
713
+ }
714
+ async meaning(data) {
715
+ return this.callApi({
716
+ method: 'POST',
717
+ route: '/meaning',
718
+ data,
719
+ });
720
+ }
721
+ async testMeaning({ q, appId, kbId }) {
722
+ const data = {
723
+ q,
724
+ appId,
725
+ kbId,
726
+ };
727
+ return this.callApi({
728
+ method: 'POST',
729
+ route: '/meaning/test',
730
+ data,
858
731
  });
859
732
  }
860
733
  }