@docbrasil/api-systemmanager 1.1.86 → 1.1.89

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/doc/api.md CHANGED
@@ -1816,6 +1816,8 @@ Class for AI Session management
1816
1816
  * [.updateData(params, authorization)](#AISession+updateData) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>array.&lt;object&gt;</code> \| <code>object</code> \| <code>object</code>
1817
1817
  * [.create(params, authorization)](#AISession+create) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code>
1818
1818
  * [.execute(params, authorization)](#AISession+execute) ⇒ <code>Promise.&lt;object&gt;</code> \| <code>string</code> \| <code>string</code>
1819
+ * [.addDocuments(params, authorization)](#AISession+addDocuments) ⇒ <code>Promise.&lt;object&gt;</code>
1820
+ * [.removeDocuments(params, authorization)](#AISession+removeDocuments) ⇒ <code>Promise.&lt;object&gt;</code>
1819
1821
 
1820
1822
  <a name="AISession+getByDocument"></a>
1821
1823
 
@@ -1956,6 +1958,64 @@ const params = {
1956
1958
  };
1957
1959
  const retData = await api.ai.sessions.execute(params, authorization);
1958
1960
  ```
1961
+ <a name="AISession+addDocuments"></a>
1962
+
1963
+ ### aiSession.addDocuments(params, authorization) ⇒ <code>Promise.&lt;object&gt;</code>
1964
+ Add documents to an existing agent session.
1965
+ The agent will handle the documentIds accordingly.
1966
+
1967
+ **Kind**: instance method of [<code>AISession</code>](#AISession)
1968
+ **Returns**: <code>Promise.&lt;object&gt;</code> - data The result from the agent
1969
+ **Access**: public
1970
+ **Author**: Myndware <augusto.pissarra@myndware.com>
1971
+
1972
+ | Param | Type | Description |
1973
+ | --- | --- | --- |
1974
+ | params | <code>object</code> | Parameters |
1975
+ | params.sessionId | <code>string</code> | The session ID |
1976
+ | params.documentIds | <code>array.&lt;string&gt;</code> | Array of document IDs to add |
1977
+ | authorization | <code>string</code> | Authorization token |
1978
+
1979
+ **Example**
1980
+ ```js
1981
+ const API = require('@docbrasil/api-systemmanager');
1982
+ const api = new API();
1983
+ const authorization = '...';
1984
+ const params = {
1985
+ sessionId: 'session-abc-123',
1986
+ documentIds: ['doc-123', 'doc-456']
1987
+ };
1988
+ const retData = await api.ai.sessions.addDocuments(params, authorization);
1989
+ ```
1990
+ <a name="AISession+removeDocuments"></a>
1991
+
1992
+ ### aiSession.removeDocuments(params, authorization) ⇒ <code>Promise.&lt;object&gt;</code>
1993
+ Remove documents from an existing agent session.
1994
+ The agent will handle the documentIds accordingly.
1995
+
1996
+ **Kind**: instance method of [<code>AISession</code>](#AISession)
1997
+ **Returns**: <code>Promise.&lt;object&gt;</code> - data The result from the agent
1998
+ **Access**: public
1999
+ **Author**: Myndware <augusto.pissarra@myndware.com>
2000
+
2001
+ | Param | Type | Description |
2002
+ | --- | --- | --- |
2003
+ | params | <code>object</code> | Parameters |
2004
+ | params.sessionId | <code>string</code> | The session ID |
2005
+ | params.documentIds | <code>array.&lt;string&gt;</code> | Array of document IDs to remove |
2006
+ | authorization | <code>string</code> | Authorization token |
2007
+
2008
+ **Example**
2009
+ ```js
2010
+ const API = require('@docbrasil/api-systemmanager');
2011
+ const api = new API();
2012
+ const authorization = '...';
2013
+ const params = {
2014
+ sessionId: 'session-abc-123',
2015
+ documentIds: ['doc-123', 'doc-456']
2016
+ };
2017
+ const retData = await api.ai.sessions.removeDocuments(params, authorization);
2018
+ ```
1959
2019
  <a name="GeoLocation"></a>
1960
2020
 
1961
2021
  ## GeoLocation