@docbrasil/api-systemmanager 1.1.29 → 1.1.31

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 (82) hide show
  1. package/api/ai.js +97 -0
  2. package/api/user/application.js +36 -0
  3. package/api/user/notification.js +38 -7
  4. package/dist/bundle.cjs +167 -7
  5. package/dist/bundle.mjs +1 -1
  6. package/doc/api.md +94 -1
  7. package/docs/Admin.html +1 -1
  8. package/docs/AdminDocuments.html +1 -1
  9. package/docs/AdminForm.html +1 -1
  10. package/docs/AdminLists.html +1 -1
  11. package/docs/AdminMessage.html +1 -1
  12. package/docs/AdminNotification.html +1 -1
  13. package/docs/AdminPlugin.html +1 -1
  14. package/docs/AdminPolicy.html +1 -1
  15. package/docs/AdminProcesses.html +1 -1
  16. package/docs/AdminTask.html +1 -1
  17. package/docs/AdminUser.html +1 -1
  18. package/docs/Application.html +247 -1
  19. package/docs/Chart.html +1 -1
  20. package/docs/Dashboard.html +1 -1
  21. package/docs/Datasource.html +1 -1
  22. package/docs/Dispatch.html +3 -3
  23. package/docs/Documents.html +1 -1
  24. package/docs/External.html +1 -1
  25. package/docs/GeoLocation.html +1 -1
  26. package/docs/Help.html +1 -1
  27. package/docs/Login.html +1 -1
  28. package/docs/MyTasks.html +1 -1
  29. package/docs/MyndAI.html +650 -0
  30. package/docs/Notification.html +195 -3
  31. package/docs/Organization.html +1 -1
  32. package/docs/Page.html +1 -1
  33. package/docs/Process.html +1 -1
  34. package/docs/Register.html +1 -1
  35. package/docs/Session.html +1 -1
  36. package/docs/Settings.html +1 -1
  37. package/docs/Task.html +1 -1
  38. package/docs/TaskAvailable.html +1 -1
  39. package/docs/Updates.html +1 -1
  40. package/docs/User.html +1 -1
  41. package/docs/Users.html +1 -1
  42. package/docs/admin_doctypes.js.html +1 -1
  43. package/docs/admin_document.js.html +1 -1
  44. package/docs/admin_form.js.html +1 -1
  45. package/docs/admin_index.js.html +1 -1
  46. package/docs/admin_list.js.html +1 -1
  47. package/docs/admin_message.js.html +1 -1
  48. package/docs/admin_notification.js.html +1 -1
  49. package/docs/admin_organization.js.html +1 -1
  50. package/docs/admin_plugin.js.html +1 -1
  51. package/docs/admin_policy.js.html +1 -1
  52. package/docs/admin_processes.js.html +1 -1
  53. package/docs/admin_task.js.html +1 -1
  54. package/docs/admin_user.js.html +1 -1
  55. package/docs/ai.js.html +214 -0
  56. package/docs/dispatch.js.html +7 -2
  57. package/docs/external.js.html +1 -1
  58. package/docs/general_geoLocation.js.html +1 -1
  59. package/docs/general_index.js.html +1 -1
  60. package/docs/index.html +1 -1
  61. package/docs/login.js.html +1 -1
  62. package/docs/session.js.html +1 -1
  63. package/docs/user_application.js.html +37 -1
  64. package/docs/user_dashboard.js.html +1 -1
  65. package/docs/user_datasource.js.html +1 -1
  66. package/docs/user_document.js.html +1 -1
  67. package/docs/user_help.js.html +1 -1
  68. package/docs/user_index.js.html +1 -1
  69. package/docs/user_my_tasks.js.html +1 -1
  70. package/docs/user_notification.js.html +39 -8
  71. package/docs/user_organization.js.html +1 -1
  72. package/docs/user_page.js.html +1 -1
  73. package/docs/user_process.js.html +1 -1
  74. package/docs/user_register.js.html +1 -1
  75. package/docs/user_settings.js.html +1 -1
  76. package/docs/user_task.js.html +1 -1
  77. package/docs/user_task_available.js.html +1 -1
  78. package/docs/user_updates.js.html +1 -1
  79. package/docs/user_user.js.html +1 -1
  80. package/docs/utils_promises.js.html +1 -1
  81. package/index.js +2 -0
  82. package/package.json +1 -1
package/docs/MyndAI.html ADDED
@@ -0,0 +1,650 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+
4
+ <head>
5
+
6
+ <meta charset="utf-8">
7
+ <meta name="viewport" content="width=device-width, initial-scale=1">
8
+ <title> MyndAI</title>
9
+
10
+ <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
11
+ <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
12
+ <script src="./build/entry.js"></script>
13
+ <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
14
+ <!--[if lt IE 9]>
15
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
16
+ <![endif]-->
17
+ <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
18
+ <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
19
+ <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
20
+ <link type="text/css" rel="stylesheet" href="styles/app.min.css">
21
+ <link type="text/css" rel="stylesheet" href="styles/iframe.css">
22
+ <link type="text/css" rel="stylesheet" href="">
23
+ <script async defer src="https://buttons.github.io/buttons.js"></script>
24
+
25
+
26
+ </head>
27
+
28
+
29
+
30
+ <body class="layout small-header">
31
+ <div id="stickyNavbarOverlay"></div>
32
+
33
+
34
+ <div class="top-nav">
35
+ <div class="inner">
36
+ <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
37
+ <span aria-hidden="true"></span>
38
+ <span aria-hidden="true"></span>
39
+ <span aria-hidden="true"></span>
40
+ </a>
41
+ <div class="logo">
42
+
43
+
44
+ </div>
45
+ <div class="menu">
46
+
47
+ <div class="navigation">
48
+ <a
49
+ href="index.html"
50
+ class="link"
51
+ >
52
+ Documentation
53
+ </a>
54
+
55
+
56
+
57
+ </div>
58
+ </div>
59
+ </div>
60
+ </div>
61
+ <div id="main">
62
+ <div
63
+ class="sidebar "
64
+ id="sidebarNav"
65
+ >
66
+
67
+ <nav>
68
+
69
+ <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Application.html">Application</a></li><li><a href="Chart.html">Chart</a></li><li><a href="Dashboard.html">Dashboard</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Help.html">Help</a></li><li><a href="Login.html">Login</a></li><li><a href="MyTasks.html">MyTasks</a></li><li><a href="MyndAI.html">MyndAI</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Page.html">Page</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Settings.html">Settings</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="Updates.html">Updates</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
70
+
71
+ </nav>
72
+ </div>
73
+ <div class="core" id="main-content-wrapper">
74
+ <div class="content">
75
+ <header class="page-title">
76
+ <p>Class</p>
77
+ <h1>MyndAI</h1>
78
+ </header>
79
+
80
+
81
+
82
+
83
+
84
+ <section>
85
+
86
+ <header>
87
+
88
+ <h2><span class="attribs"><span class="type-signature"></span></span>MyndAI<span class="signature">()</span><span class="type-signature"></span></h2>
89
+
90
+ <div class="class-description">Class using AI</div>
91
+
92
+
93
+ </header>
94
+
95
+ <article>
96
+ <div class="container-overview">
97
+
98
+
99
+ <div class='vertical-section'>
100
+ <div class="members">
101
+ <div class="member">
102
+ <div class=name>
103
+ <span class="tag">Constructor</span>
104
+ </div>
105
+
106
+
107
+
108
+
109
+ <h4 class="name" id="MyndAI">
110
+ <a class="href-link" href="#MyndAI">#</a>
111
+
112
+ <span class="code-name">
113
+
114
+ new MyndAI<span class="signature">()</span><span class="type-signature"></span>
115
+
116
+ </span>
117
+ </h4>
118
+
119
+
120
+
121
+
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+ <dl class="details">
136
+
137
+
138
+
139
+
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+ <p class="tag-source">
168
+ <a href="ai.js.html" class="button">View Source</a>
169
+ <span>
170
+ <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line9">line 9</a>
171
+ </span>
172
+ </p>
173
+
174
+ </dl>
175
+
176
+
177
+
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+ </div>
198
+ </div>
199
+ </div>
200
+
201
+
202
+ </div>
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+
219
+ <div class='vertical-section'>
220
+ <h1>Methods</h1>
221
+ <div class="members">
222
+
223
+ <div class="member">
224
+
225
+
226
+
227
+ <h4 class="name" id="explain">
228
+ <a class="href-link" href="#explain">#</a>
229
+
230
+
231
+ <span class='tag'>async</span>
232
+
233
+
234
+ <span class="code-name">
235
+
236
+ explain<span class="signature">(params)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|boolean|object|string|number}</span>
237
+
238
+ </span>
239
+ </h4>
240
+
241
+
242
+
243
+
244
+ <div class="description">
245
+ Create new document
246
+ </div>
247
+
248
+
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+ <h5>Parameters:</h5>
258
+
259
+ <div class="table-container">
260
+ <table class="params table">
261
+ <thead>
262
+ <tr>
263
+
264
+ <th>Name</th>
265
+
266
+
267
+ <th>Type</th>
268
+
269
+
270
+
271
+
272
+
273
+ <th class="last">Description</th>
274
+ </tr>
275
+ </thead>
276
+
277
+ <tbody>
278
+
279
+
280
+
281
+ <tr class="deep-level-0">
282
+
283
+ <td class="name"><code>params</code></td>
284
+
285
+
286
+ <td class="type">
287
+
288
+
289
+ <code class="param-type">object</code>
290
+
291
+
292
+
293
+ </td>
294
+
295
+
296
+
297
+
298
+
299
+ <td class="description last">Object for add new document</td>
300
+ </tr>
301
+
302
+
303
+
304
+
305
+ <tr class="deep-level-1">
306
+
307
+ <td class="name"><code>model</code></td>
308
+
309
+
310
+ <td class="type">
311
+
312
+
313
+ <code class="param-type">string</code>
314
+
315
+
316
+
317
+ </td>
318
+
319
+
320
+
321
+
322
+
323
+ <td class="description last">The model to use for the explain</td>
324
+ </tr>
325
+
326
+
327
+
328
+ <tr class="deep-level-1">
329
+
330
+ <td class="name"><code>context</code></td>
331
+
332
+
333
+ <td class="type">
334
+
335
+
336
+ <code class="param-type">object</code>
337
+
338
+
339
+
340
+ </td>
341
+
342
+
343
+
344
+
345
+
346
+ <td class="description last">The context to apply to a prompt</td>
347
+ </tr>
348
+
349
+
350
+
351
+ <tr class="deep-level-1">
352
+
353
+ <td class="name"><code>text</code></td>
354
+
355
+
356
+ <td class="type">
357
+
358
+
359
+ <code class="param-type">string</code>
360
+
361
+
362
+
363
+ </td>
364
+
365
+
366
+
367
+
368
+
369
+ <td class="description last">The text to add to the prompt</td>
370
+ </tr>
371
+
372
+
373
+
374
+ <tr class="deep-level-1">
375
+
376
+ <td class="name"><code>medias</code></td>
377
+
378
+
379
+ <td class="type">
380
+
381
+
382
+ <code class="param-type">array.&lt;base64></code>
383
+
384
+
385
+
386
+ </td>
387
+
388
+
389
+
390
+
391
+
392
+ <td class="description last">Medias to add to the case in base64 (PDF, Image, Video, Audio)</td>
393
+ </tr>
394
+
395
+
396
+
397
+ <tr class="deep-level-1">
398
+
399
+ <td class="name"><code>propmpt</code></td>
400
+
401
+
402
+ <td class="type">
403
+
404
+
405
+ <code class="param-type">string</code>
406
+
407
+
408
+
409
+ </td>
410
+
411
+
412
+
413
+
414
+
415
+ <td class="description last">The actual prompt with context and text to apply to</td>
416
+ </tr>
417
+
418
+
419
+
420
+
421
+
422
+ </tbody>
423
+ </table>
424
+ </div>
425
+
426
+
427
+
428
+
429
+
430
+ <dl class="details">
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+ <dt class="tag-author">Author:</dt>
450
+ <dd class="tag-author">
451
+ <ul>
452
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
453
+ </ul>
454
+ </dd>
455
+
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+
467
+
468
+
469
+ <p class="tag-source">
470
+ <a href="ai.js.html" class="button">View Source</a>
471
+ <span>
472
+ <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line80">line 80</a>
473
+ </span>
474
+ </p>
475
+
476
+ </dl>
477
+
478
+
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+
489
+
490
+
491
+
492
+
493
+
494
+
495
+ <div class='columns method-parameter'>
496
+ <div class="column is-2"><label>Returns:</label></div>
497
+ <div class="column is-10">
498
+
499
+
500
+
501
+ <div class="columns">
502
+
503
+ <div class='param-desc column is-7'>data</div>
504
+
505
+
506
+ <div class='column is-5 has-text-left'>
507
+ <label>Type: </label>
508
+
509
+ <code class="param-type">Promise.&lt;object></code>
510
+
511
+
512
+ </div>
513
+
514
+ </div>
515
+
516
+
517
+
518
+
519
+ <div class="columns">
520
+
521
+ <div class='param-desc column is-7'>data.success true|false for success</div>
522
+
523
+
524
+ <div class='column is-5 has-text-left'>
525
+ <label>Type: </label>
526
+
527
+ <code class="param-type">boolean</code>
528
+
529
+
530
+ </div>
531
+
532
+ </div>
533
+
534
+
535
+
536
+
537
+ <div class="columns">
538
+
539
+ <div class='param-desc column is-7'>data.result the result of the AI call</div>
540
+
541
+
542
+ <div class='column is-5 has-text-left'>
543
+ <label>Type: </label>
544
+
545
+ <code class="param-type">object</code>
546
+
547
+
548
+ </div>
549
+
550
+ </div>
551
+
552
+
553
+
554
+
555
+ <div class="columns">
556
+
557
+ <div class='param-desc column is-7'>data.result.response The actual text response according the prompt</div>
558
+
559
+
560
+ <div class='column is-5 has-text-left'>
561
+ <label>Type: </label>
562
+
563
+ <code class="param-type">string</code>
564
+
565
+
566
+ </div>
567
+
568
+ </div>
569
+
570
+
571
+
572
+
573
+ <div class="columns">
574
+
575
+ <div class='param-desc column is-7'>data.result.tokens The quantity of token used in this request</div>
576
+
577
+
578
+ <div class='column is-5 has-text-left'>
579
+ <label>Type: </label>
580
+
581
+ <code class="param-type">number</code>
582
+
583
+
584
+ </div>
585
+
586
+ </div>
587
+
588
+
589
+ </div>
590
+ </div>
591
+
592
+
593
+
594
+
595
+ <h5>Example</h5>
596
+
597
+
598
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
599
+ const api = new API();
600
+ const authorization = '...';
601
+ const params = {
602
+ model: 'model-name',
603
+ context: { name: 'Some name' },
604
+ text: 'Say hello to the world',
605
+ medias: ['...'],
606
+ prompt: 'Write a story about {{name}} with the following theme: {{text}}',
607
+ };
608
+ const retData = await api.ai.explain(params, authorization);</code></pre>
609
+
610
+
611
+
612
+ </div>
613
+
614
+ </div>
615
+ </div>
616
+
617
+
618
+
619
+
620
+
621
+ </article>
622
+
623
+ </section>
624
+
625
+
626
+
627
+
628
+ </div>
629
+
630
+ <footer class="footer">
631
+ <div class="content has-text-centered">
632
+ <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
633
+ <p class="sidebar-created-by">
634
+ <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
635
+ <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
636
+ </p>
637
+ </div>
638
+ </footer>
639
+
640
+ </div>
641
+ <div id="side-nav" class="side-nav">
642
+ </div>
643
+ </div>
644
+ <script src="scripts/app.min.js"></script>
645
+ <script>PR.prettyPrint();</script>
646
+ <script src="scripts/linenumber.js"> </script>
647
+
648
+
649
+ </body>
650
+ </html>