@docbrasil/api-systemmanager 1.1.38 → 1.1.40

package/api/ai.js

@@ -54,8 +54,13 @@ class MyndAI {
    * @param {string} params.model The model to use for the explain
    * @param {object} params.context The context to apply to a prompt
    * @param {string} params.text The text to add to the prompt
-   * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
+   * @param {array<object>} params.medias Medias to add (PDF, Image, Video, Audio)
+   * @param {string} params.medias.type can be base64 | document
+   * @param {string} params.medias.mime the mime type of the media
+   * @param {string} params.medias.base64 the base64 of the image (in the case the type is base64)
+   * @param {string} params.medias.document the document path for the image (in the case the type is document)
    * @param {string} params.prompt The actual prompt with context and text to apply to
+   * @param {boolean} params.json=false If we return in json format or not
    * @return {Promise<object>} data
    * @return {boolean} data.success true|false for success
    * @return {object} data.result the result of the AI call

package/dist/bundle.cjs

@@ -14110,8 +14110,13 @@ class MyndAI {
    * @param {string} params.model The model to use for the explain
    * @param {object} params.context The context to apply to a prompt
    * @param {string} params.text The text to add to the prompt
-   * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
+   * @param {array<object>} params.medias Medias to add (PDF, Image, Video, Audio)
+   * @param {string} params.medias.type can be base64 | document
+   * @param {string} params.medias.mime the mime type of the media
+   * @param {string} params.medias.base64 the base64 of the image (in the case the type is base64)
+   * @param {string} params.medias.document the document path for the image (in the case the type is document)
    * @param {string} params.prompt The actual prompt with context and text to apply to
+   * @param {boolean} params.json=false If we return in json format or not
    * @return {Promise<object>} data
    * @return {boolean} data.success true|false for success
    * @return {object} data.result the result of the AI call

package/doc/api.md

@@ -3914,14 +3914,19 @@ Create new document
 **Access**: public  
 **Author**: Myndware <augusto.pissarra@myndware.com>  
 
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | Object for add new document |
-| params.model | <code>string</code> | The model to use for the explain |
-| params.context | <code>object</code> | The context to apply to a prompt |
-| params.text | <code>string</code> | The text to add to the prompt |
-| params.medias | <code>array.&lt;base64&gt;</code> | Medias to add to the case in base64 (PDF, Image, Video, Audio) |
-| params.prompt | <code>string</code> | The actual prompt with context and text to apply to |
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| params | <code>object</code> |  | Object for add new document |
+| params.model | <code>string</code> |  | The model to use for the explain |
+| params.context | <code>object</code> |  | The context to apply to a prompt |
+| params.text | <code>string</code> |  | The text to add to the prompt |
+| params.medias | <code>array.&lt;object&gt;</code> |  | Medias to add (PDF, Image, Video, Audio) |
+| params.medias.type | <code>string</code> |  | can be base64 | document |
+| params.medias.mime | <code>string</code> |  | the mime type of the media |
+| params.medias.base64 | <code>string</code> |  | the base64 of the image (in the case the type is base64) |
+| params.medias.document | <code>string</code> |  | the document path for the image (in the case the type is document) |
+| params.prompt | <code>string</code> |  | The actual prompt with context and text to apply to |
+| params.json | <code>boolean</code> | <code>false</code> | If we return in json format or not |
 
 **Example**  
 ```js

package/docs/MyndAI.html

@@ -269,6 +269,8 @@
             
 
             
+            <th>Default</th>
+            
 
             <th class="last">Description</th>
         </tr>
@@ -295,6 +297,10 @@
   
 
   
+      <td class="default">
+      
+      </td>
+  
 
   <td class="description last">Object for add new document</td>
 </tr>
@@ -319,6 +325,10 @@
   
 
   
+      <td class="default">
+      
+      </td>
+  
 
   <td class="description last">The model to use for the explain</td>
 </tr>
@@ -342,6 +352,10 @@
   
 
   
+      <td class="default">
+      
+      </td>
+  
 
   <td class="description last">The context to apply to a prompt</td>
 </tr>
@@ -365,6 +379,10 @@
   
 
   
+      <td class="default">
+      
+      </td>
+  
 
   <td class="description last">The text to add to the prompt</td>
 </tr>
@@ -379,7 +397,7 @@
   <td class="type">
   
       
-<code class="param-type">array.&lt;base64></code>
+<code class="param-type">array.&lt;object></code>
 
 
   
@@ -388,8 +406,120 @@
   
 
   
+      <td class="default">
+      
+      </td>
+  
 
-  <td class="description last">Medias to add to the case in base64 (PDF, Image, Video, Audio)</td>
+  <td class="description last">Medias to add (PDF, Image, Video, Audio)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>medias.type</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last">can be base64 | document</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>medias.mime</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last">the mime type of the media</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>medias.base64</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last">the base64 of the image (in the case the type is base64)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>medias.document</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+      </td>
+  
+
+  <td class="description last">the document path for the image (in the case the type is document)</td>
 </tr>
 
   
@@ -411,11 +541,44 @@
   
 
   
+      <td class="default">
+      
+      </td>
+  
 
   <td class="description last">The actual prompt with context and text to apply to</td>
 </tr>
 
   
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>json</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">boolean</code>
+
+
+  
+  </td>
+
+  
+
+  
+      <td class="default">
+      
+          false
+      
+      </td>
+  
+
+  <td class="description last">If we return in json format or not</td>
+</tr>
+
+  
 
 
         
@@ -469,7 +632,7 @@
         <p class="tag-source">
             <a href="ai.js.html" class="button">View Source</a>
             <span>
-                <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line80">line 80</a>
+                <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line85">line 85</a>
             </span>
         </p>
     

package/docs/ai.js.html

@@ -141,8 +141,13 @@ class MyndAI {
    * @param {string} params.model The model to use for the explain
    * @param {object} params.context The context to apply to a prompt
    * @param {string} params.text The text to add to the prompt
-   * @param {array<base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
+   * @param {array<object>} params.medias Medias to add (PDF, Image, Video, Audio)
+   * @param {string} params.medias.type can be base64 | document
+   * @param {string} params.medias.mime the mime type of the media
+   * @param {string} params.medias.base64 the base64 of the image (in the case the type is base64)
+   * @param {string} params.medias.document the document path for the image (in the case the type is document)
    * @param {string} params.prompt The actual prompt with context and text to apply to
+   * @param {boolean} params.json=false If we return in json format or not
    * @return {Promise<object>} data
    * @return {boolean} data.success true|false for success
    * @return {object} data.result the result of the AI call

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.38",
+  "version": "1.1.40",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",

package/.vscode/settings.json

@@ -1 +0,0 @@
-{}