@docbrasil/api-systemmanager 1.1.37 → 1.1.39

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.
package/api/ai.js CHANGED
@@ -55,7 +55,9 @@ class MyndAI {
55
55
  * @param {object} params.context The context to apply to a prompt
56
56
  * @param {string} params.text The text to add to the prompt
57
57
  * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
58
+ * @param {array<string>} params.mediaIds Media Ids to add - id of an internal document (PDF, Image, Video, Audio)
58
59
  * @param {string} params.prompt The actual prompt with context and text to apply to
60
+ * @param {boolean} params.json=false If we return in json format or not
59
61
  * @return {Promise<object>} data
60
62
  * @return {boolean} data.success true|false for success
61
63
  * @return {object} data.result the result of the AI call
package/dist/bundle.cjs CHANGED
@@ -14111,7 +14111,9 @@ class MyndAI {
14111
14111
  * @param {object} params.context The context to apply to a prompt
14112
14112
  * @param {string} params.text The text to add to the prompt
14113
14113
  * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
14114
+ * @param {array<string>} params.mediaIds Media Ids to add - id of an internal document (PDF, Image, Video, Audio)
14114
14115
  * @param {string} params.prompt The actual prompt with context and text to apply to
14116
+ * @param {boolean} params.json=false If we return in json format or not
14115
14117
  * @return {Promise<object>} data
14116
14118
  * @return {boolean} data.success true|false for success
14117
14119
  * @return {object} data.result the result of the AI call
package/doc/api.md CHANGED
@@ -3914,14 +3914,16 @@ Create new document
3914
3914
  **Access**: public
3915
3915
  **Author**: Myndware <augusto.pissarra@myndware.com>
3916
3916
 
3917
- | Param | Type | Description |
3918
- | --- | --- | --- |
3919
- | params | <code>object</code> | Object for add new document |
3920
- | params.model | <code>string</code> | The model to use for the explain |
3921
- | params.context | <code>object</code> | The context to apply to a prompt |
3922
- | params.text | <code>string</code> | The text to add to the prompt |
3923
- | params.medias | <code>array.&lt;base64&gt;</code> | Medias to add to the case in base64 (PDF, Image, Video, Audio) |
3924
- | params.prompt | <code>string</code> | The actual prompt with context and text to apply to |
3917
+ | Param | Type | Default | Description |
3918
+ | --- | --- | --- | --- |
3919
+ | params | <code>object</code> | | Object for add new document |
3920
+ | params.model | <code>string</code> | | The model to use for the explain |
3921
+ | params.context | <code>object</code> | | The context to apply to a prompt |
3922
+ | params.text | <code>string</code> | | The text to add to the prompt |
3923
+ | params.medias | <code>array.&lt;base64&gt;</code> | | Medias to add to the case in base64 (PDF, Image, Video, Audio) |
3924
+ | params.mediaIds | <code>array.&lt;string&gt;</code> | | Media Ids to add - id of an internal document (PDF, Image, Video, Audio) |
3925
+ | params.prompt | <code>string</code> | | The actual prompt with context and text to apply to |
3926
+ | params.json | <code>boolean</code> | <code>false</code> | If we return in json format or not |
3925
3927
 
3926
3928
  **Example**
3927
3929
  ```js
package/docs/MyndAI.html CHANGED
@@ -269,6 +269,8 @@
269
269
 
270
270
 
271
271
 
272
+ <th>Default</th>
273
+
272
274
 
273
275
  <th class="last">Description</th>
274
276
  </tr>
@@ -295,6 +297,10 @@
295
297
 
296
298
 
297
299
 
300
+ <td class="default">
301
+
302
+ </td>
303
+
298
304
 
299
305
  <td class="description last">Object for add new document</td>
300
306
  </tr>
@@ -319,6 +325,10 @@
319
325
 
320
326
 
321
327
 
328
+ <td class="default">
329
+
330
+ </td>
331
+
322
332
 
323
333
  <td class="description last">The model to use for the explain</td>
324
334
  </tr>
@@ -342,6 +352,10 @@
342
352
 
343
353
 
344
354
 
355
+ <td class="default">
356
+
357
+ </td>
358
+
345
359
 
346
360
  <td class="description last">The context to apply to a prompt</td>
347
361
  </tr>
@@ -365,6 +379,10 @@
365
379
 
366
380
 
367
381
 
382
+ <td class="default">
383
+
384
+ </td>
385
+
368
386
 
369
387
  <td class="description last">The text to add to the prompt</td>
370
388
  </tr>
@@ -388,12 +406,43 @@
388
406
 
389
407
 
390
408
 
409
+ <td class="default">
410
+
411
+ </td>
412
+
391
413
 
392
414
  <td class="description last">Medias to add to the case in base64 (PDF, Image, Video, Audio)</td>
393
415
  </tr>
394
416
 
395
417
 
396
418
 
419
+ <tr class="deep-level-1">
420
+
421
+ <td class="name"><code>mediaIds</code></td>
422
+
423
+
424
+ <td class="type">
425
+
426
+
427
+ <code class="param-type">array.&lt;string></code>
428
+
429
+
430
+
431
+ </td>
432
+
433
+
434
+
435
+
436
+ <td class="default">
437
+
438
+ </td>
439
+
440
+
441
+ <td class="description last">Media Ids to add - id of an internal document (PDF, Image, Video, Audio)</td>
442
+ </tr>
443
+
444
+
445
+
397
446
  <tr class="deep-level-1">
398
447
 
399
448
  <td class="name"><code>prompt</code></td>
@@ -411,11 +460,44 @@
411
460
 
412
461
 
413
462
 
463
+ <td class="default">
464
+
465
+ </td>
466
+
414
467
 
415
468
  <td class="description last">The actual prompt with context and text to apply to</td>
416
469
  </tr>
417
470
 
418
471
 
472
+
473
+ <tr class="deep-level-1">
474
+
475
+ <td class="name"><code>json</code></td>
476
+
477
+
478
+ <td class="type">
479
+
480
+
481
+ <code class="param-type">boolean</code>
482
+
483
+
484
+
485
+ </td>
486
+
487
+
488
+
489
+
490
+ <td class="default">
491
+
492
+ false
493
+
494
+ </td>
495
+
496
+
497
+ <td class="description last">If we return in json format or not</td>
498
+ </tr>
499
+
500
+
419
501
 
420
502
 
421
503
 
@@ -469,7 +551,7 @@
469
551
  <p class="tag-source">
470
552
  <a href="ai.js.html" class="button">View Source</a>
471
553
  <span>
472
- <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line80">line 80</a>
554
+ <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line82">line 82</a>
473
555
  </span>
474
556
  </p>
475
557
 
package/docs/ai.js.html CHANGED
@@ -142,7 +142,9 @@ class MyndAI {
142
142
  * @param {object} params.context The context to apply to a prompt
143
143
  * @param {string} params.text The text to add to the prompt
144
144
  * @param {array&lt;base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
145
+ * @param {array&lt;string>} params.mediaIds Media Ids to add - id of an internal document (PDF, Image, Video, Audio)
145
146
  * @param {string} params.prompt The actual prompt with context and text to apply to
147
+ * @param {boolean} params.json=false If we return in json format or not
146
148
  * @return {Promise&lt;object>} data
147
149
  * @return {boolean} data.success true|false for success
148
150
  * @return {object} data.result the result of the AI call
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@docbrasil/api-systemmanager",
3
3
  "description": "Module API System Manager",
4
- "version": "1.1.37",
4
+ "version": "1.1.39",
5
5
  "scripts": {
6
6
  "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
7
7
  "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",
@@ -1 +0,0 @@
1
- {}