@docbrasil/api-systemmanager 1.1.79 → 1.1.81

package/doc/api.md

@@ -37,6 +37,12 @@
 <dt><a href="#AdminUser">AdminUser</a></dt>
 <dd><p>Admin Class for user, permission admin</p>
 </dd>
+<dt><a href="#MyndAI">MyndAI</a></dt>
+<dd><p>Class using AI</p>
+</dd>
+<dt><a href="#AISession">AISession</a></dt>
+<dd><p>Class for AI Session management</p>
+</dd>
 <dt><a href="#GeoLocation">GeoLocation</a></dt>
 <dd><p>General Class for user, permission organization</p>
 </dd>
@@ -103,9 +109,6 @@
 <dt><a href="#User">User</a></dt>
 <dd><p>Class for user, permission user</p>
 </dd>
-<dt><a href="#MyndAI">MyndAI</a></dt>
-<dd><p>Class using AI</p>
-</dd>
 <dt><a href="#Dispatch">Dispatch</a></dt>
 <dd><p>Api dispatch manager</p>
 </dd>
@@ -1757,6 +1760,134 @@ const params = { orgId: '5edd11c46b6ce9729c2c297c' };
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const users = await api.admin.user.getOrgUsers(params, session);
 ```
+<a name="MyndAI"></a>
+
+## MyndAI
+Class using AI
+
+**Kind**: global class  
+<a name="MyndAI+explain"></a>
+
+### myndAI.explain(params) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code> \| <code>number</code>
+Create new document
+
+**Kind**: instance method of [<code>MyndAI</code>](#MyndAI)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - data<code>boolean</code> - data.success true|false for success<code>object</code> - data.result the result of the AI call<code>string</code> - data.result.response The actual text response according the prompt<code>number</code> - data.result.tokens The quantity of token used in this request  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| 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
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const authorization = '...';
+const params = {
+ model: 'model-name',
+ context: { name: 'Some name' },
+ text: 'Say hello to the world',
+ medias: ['...'],
+ prompt: 'Write a story about {{name}} with the following theme: {{text}}',
+};
+const retData = await api.ai.explain(params, authorization);
+```
+<a name="AISession"></a>
+
+## AISession
+Class for AI Session management
+
+**Kind**: global class  
+
+* [AISession](#AISession)
+    * [.getByDocument(params, authorization)](#AISession+getByDocument) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code> \| <code>array.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>object</code>
+    * [.updateData(params, authorization)](#AISession+updateData) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
+
+<a name="AISession+getByDocument"></a>
+
+### aiSession.getByDocument(params, authorization) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code> \| <code>array.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>object</code>
+Get full session data by document ID.
+Returns session, execution, activities, pages, triples and summary.
+
+**Kind**: instance method of [<code>AISession</code>](#AISession)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - data The full session data<code>object</code> - data.session The session object<code>object</code> - data.execution The latest execution or null<code>array.&lt;object&gt;</code> - data.activities Activity log entries<code>array.&lt;object&gt;</code> - data.pages Extracted page objects<code>array.&lt;object&gt;</code> - data.triples Ontology triple objects<code>object</code> - data.summary Document summary or null  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Parameters |
+| params.documentId | <code>string</code> | The document ID to look up the session for |
+| authorization | <code>string</code> | Authorization token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const authorization = '...';
+const params = { documentId: 'doc-123' };
+const retData = await api.ai.sessions.getByDocument(params, authorization);
+```
+<a name="AISession+updateData"></a>
+
+### aiSession.updateData(params, authorization) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
+Update session document data (pages, triples, summary).
+Used by Scarface to push corrections or enrichments for a document.
+
+**Kind**: instance method of [<code>AISession</code>](#AISession)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - data The update results<code>array.&lt;object&gt;</code> - data.pages Page update results [{pageNumber, updated}]<code>object</code> - data.triples Triple insert results {added: number}<code>object</code> - data.summary Applied summary updates  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Parameters |
+| params.documentId | <code>string</code> | The document ID |
+| [params.pages] | <code>array.&lt;object&gt;</code> | Page updates |
+| params.pages.pageNumber | <code>number</code> | 1-based page number |
+| [params.pages.markdown] | <code>string</code> | Updated markdown text |
+| [params.pages.entities] | <code>array.&lt;object&gt;</code> | Updated entities |
+| [params.triples] | <code>array.&lt;object&gt;</code> | New triples to add |
+| params.triples.pageNumber | <code>number</code> | Source page number |
+| params.triples.subject | <code>string</code> | Subject entity text |
+| params.triples.predicate | <code>string</code> | Relationship predicate |
+| params.triples.object | <code>string</code> | Object entity text |
+| [params.summary] | <code>object</code> | Summary field updates |
+| [params.summary.documentName] | <code>string</code> | Document name |
+| [params.summary.entityCount] | <code>number</code> | Total entity count |
+| [params.summary.tripleCount] | <code>number</code> | Total triple count |
+| authorization | <code>string</code> | Authorization token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const authorization = '...';
+const params = {
+  documentId: 'doc-123',
+  pages: [
+    { pageNumber: 1, markdown: '# Updated page content' }
+  ],
+  summary: {
+    documentName: 'Patient Report.pdf',
+    entityCount: 42,
+    tripleCount: 15
+  }
+};
+const retData = await api.ai.sessions.updateData(params, authorization);
+```
 <a name="GeoLocation"></a>
 
 ## GeoLocation
@@ -5193,50 +5324,6 @@ const orgIds: ['616eccaaa9360a05293b10fe'];
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 const jwtToken = await api.user.getChartTags(orgIds, session);
 ```
-<a name="MyndAI"></a>
-
-## MyndAI
-Class using AI
-
-**Kind**: global class  
-<a name="MyndAI+explain"></a>
-
-### myndAI.explain(params) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code> \| <code>number</code>
-Create new document
-
-**Kind**: instance method of [<code>MyndAI</code>](#MyndAI)  
-**Returns**: <code>Promise.&lt;object&gt;</code> - data<code>boolean</code> - data.success true|false for success<code>object</code> - data.result the result of the AI call<code>string</code> - data.result.response The actual text response according the prompt<code>number</code> - data.result.tokens The quantity of token used in this request  
-**Access**: public  
-**Author**: Myndware <augusto.pissarra@myndware.com>  
-
-| 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
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const authorization = '...';
-const params = {
- model: 'model-name',
- context: { name: 'Some name' },
- text: 'Say hello to the world',
- medias: ['...'],
- prompt: 'Write a story about {{name}} with the following theme: {{text}}',
-};
-const retData = await api.ai.explain(params, authorization);
-```
 <a name="Dispatch"></a>
 
 ## Dispatch