@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.
@@ -224,8 +224,8 @@
224
224
 
225
225
 
226
226
 
227
- <h4 class="name" id="create">
228
- <a class="href-link" href="#create">#</a>
227
+ <h4 class="name" id="addDocuments">
228
+ <a class="href-link" href="#addDocuments">#</a>
229
229
 
230
230
 
231
231
  <span class='tag'>async</span>
@@ -233,7 +233,7 @@
233
233
 
234
234
  <span class="code-name">
235
235
 
236
- create<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|string|string}</span>
236
+ addDocuments<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
237
237
 
238
238
  </span>
239
239
  </h4>
@@ -242,8 +242,8 @@
242
242
 
243
243
 
244
244
  <div class="description">
245
- Create a new agent session.
246
- Use this to create a session with full metadata before triggering execution.
245
+ Add documents to an existing agent session.
246
+ The agent will handle the documentIds accordingly.
247
247
  </div>
248
248
 
249
249
 
@@ -268,8 +268,6 @@ Use this to create a session with full metadata before triggering execution.
268
268
  <th>Type</th>
269
269
 
270
270
 
271
- <th>Attributes</th>
272
-
273
271
 
274
272
 
275
273
 
@@ -296,14 +294,6 @@ Use this to create a session with full metadata before triggering execution.
296
294
  </td>
297
295
 
298
296
 
299
- <td class="attributes">
300
-
301
-
302
-
303
-
304
-
305
- </td>
306
-
307
297
 
308
298
 
309
299
 
@@ -315,7 +305,7 @@ Use this to create a session with full metadata before triggering execution.
315
305
 
316
306
  <tr class="deep-level-1">
317
307
 
318
- <td class="name"><code>agentType</code></td>
308
+ <td class="name"><code>sessionId</code></td>
319
309
 
320
310
 
321
311
  <td class="type">
@@ -328,84 +318,33 @@ Use this to create a session with full metadata before triggering execution.
328
318
  </td>
329
319
 
330
320
 
331
- <td class="attributes">
332
-
333
-
334
-
335
-
336
-
337
- </td>
338
-
339
-
340
-
341
-
342
- <td class="description last">The agent type (e.g., 'doc-rlm-ingest')</td>
343
- </tr>
344
-
345
-
346
-
347
- <tr class="deep-level-1">
348
-
349
- <td class="name"><code>config</code></td>
350
-
351
-
352
- <td class="type">
353
-
354
-
355
- <code class="param-type">object</code>
356
-
357
-
358
-
359
- </td>
360
-
361
-
362
- <td class="attributes">
363
-
364
- &lt;optional><br>
365
-
366
-
367
-
368
-
369
-
370
- </td>
371
-
372
321
 
373
322
 
374
323
 
375
- <td class="description last">Agent configuration options</td>
324
+ <td class="description last">The session ID</td>
376
325
  </tr>
377
326
 
378
327
 
379
328
 
380
329
  <tr class="deep-level-1">
381
330
 
382
- <td class="name"><code>metadata</code></td>
331
+ <td class="name"><code>documentIds</code></td>
383
332
 
384
333
 
385
334
  <td class="type">
386
335
 
387
336
 
388
- <code class="param-type">object</code>
337
+ <code class="param-type">array.&lt;string></code>
389
338
 
390
339
 
391
340
 
392
341
  </td>
393
342
 
394
343
 
395
- <td class="attributes">
396
-
397
- &lt;optional><br>
398
-
399
-
400
-
401
-
402
-
403
- </td>
404
-
405
344
 
406
345
 
407
346
 
408
- <td class="description last">Session metadata (documentId, pipelineVariant, analysisMode, etc.)</td>
347
+ <td class="description last">Array of document IDs to add</td>
409
348
  </tr>
410
349
 
411
350
 
@@ -429,14 +368,6 @@ Use this to create a session with full metadata before triggering execution.
429
368
  </td>
430
369
 
431
370
 
432
- <td class="attributes">
433
-
434
-
435
-
436
-
437
-
438
- </td>
439
-
440
371
 
441
372
 
442
373
 
@@ -495,7 +426,7 @@ Use this to create a session with full metadata before triggering execution.
495
426
  <p class="tag-source">
496
427
  <a href="ai_sessions.js.html" class="button">View Source</a>
497
428
  <span>
498
- <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line183">line 183</a>
429
+ <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line270">line 270</a>
499
430
  </span>
500
431
  </p>
501
432
 
@@ -526,7 +457,7 @@ Use this to create a session with full metadata before triggering execution.
526
457
 
527
458
  <div class="columns">
528
459
 
529
- <div class='param-desc column is-7'>data The created session</div>
460
+ <div class='param-desc column is-7'>data The result from the agent</div>
530
461
 
531
462
 
532
463
  <div class='column is-5 has-text-left'>
@@ -540,42 +471,6 @@ Use this to create a session with full metadata before triggering execution.
540
471
  </div>
541
472
 
542
473
 
543
-
544
-
545
- <div class="columns">
546
-
547
- <div class='param-desc column is-7'>data.sessionId The session ID</div>
548
-
549
-
550
- <div class='column is-5 has-text-left'>
551
- <label>Type: </label>
552
-
553
- <code class="param-type">string</code>
554
-
555
-
556
- </div>
557
-
558
- </div>
559
-
560
-
561
-
562
-
563
- <div class="columns">
564
-
565
- <div class='param-desc column is-7'>data.status The session status</div>
566
-
567
-
568
- <div class='column is-5 has-text-left'>
569
- <label>Type: </label>
570
-
571
- <code class="param-type">string</code>
572
-
573
-
574
- </div>
575
-
576
- </div>
577
-
578
-
579
474
  </div>
580
475
  </div>
581
476
 
@@ -589,15 +484,10 @@ Use this to create a session with full metadata before triggering execution.
589
484
  const api = new API();
590
485
  const authorization = '...';
591
486
  const params = {
592
- agentType: 'doc-rlm-ingest',
593
- metadata: {
594
- documentId: 'doc-123',
595
- documentName: 'Patient Report.pdf',
596
- pipelineVariant: 'A',
597
- analysisMode: 'full'
598
- }
487
+ sessionId: 'session-abc-123',
488
+ documentIds: ['doc-123', 'doc-456']
599
489
  };
600
- const retData = await api.ai.sessions.create(params, authorization);</code></pre>
490
+ const retData = await api.ai.sessions.addDocuments(params, authorization);</code></pre>
601
491
 
602
492
 
603
493
 
@@ -607,8 +497,8 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
607
497
 
608
498
 
609
499
 
610
- <h4 class="name" id="execute">
611
- <a class="href-link" href="#execute">#</a>
500
+ <h4 class="name" id="create">
501
+ <a class="href-link" href="#create">#</a>
612
502
 
613
503
 
614
504
  <span class='tag'>async</span>
@@ -616,7 +506,7 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
616
506
 
617
507
  <span class="code-name">
618
508
 
619
- execute<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|string|string}</span>
509
+ create<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|string|string}</span>
620
510
 
621
511
  </span>
622
512
  </h4>
@@ -625,7 +515,8 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
625
515
 
626
516
 
627
517
  <div class="description">
628
- Start execution on an existing agent session.
518
+ Create a new agent session.
519
+ Use this to create a session with full metadata before triggering execution.
629
520
  </div>
630
521
 
631
522
 
@@ -697,7 +588,7 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
697
588
 
698
589
  <tr class="deep-level-1">
699
590
 
700
- <td class="name"><code>sessionId</code></td>
591
+ <td class="name"><code>agentType</code></td>
701
592
 
702
593
 
703
594
  <td class="type">
@@ -721,14 +612,14 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
721
612
 
722
613
 
723
614
 
724
- <td class="description last">The session ID to execute</td>
615
+ <td class="description last">The agent type (e.g., 'doc-rlm-ingest')</td>
725
616
  </tr>
726
617
 
727
618
 
728
619
 
729
620
  <tr class="deep-level-1">
730
621
 
731
- <td class="name"><code>input</code></td>
622
+ <td class="name"><code>config</code></td>
732
623
 
733
624
 
734
625
  <td class="type">
@@ -754,7 +645,40 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
754
645
 
755
646
 
756
647
 
757
- <td class="description last">Execution input (documentId, options, etc.)</td>
648
+ <td class="description last">Agent configuration options</td>
649
+ </tr>
650
+
651
+
652
+
653
+ <tr class="deep-level-1">
654
+
655
+ <td class="name"><code>metadata</code></td>
656
+
657
+
658
+ <td class="type">
659
+
660
+
661
+ <code class="param-type">object</code>
662
+
663
+
664
+
665
+ </td>
666
+
667
+
668
+ <td class="attributes">
669
+
670
+ &lt;optional><br>
671
+
672
+
673
+
674
+
675
+
676
+ </td>
677
+
678
+
679
+
680
+
681
+ <td class="description last">Session metadata (documentId, pipelineVariant, analysisMode, etc.)</td>
758
682
  </tr>
759
683
 
760
684
 
@@ -844,7 +768,7 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
844
768
  <p class="tag-source">
845
769
  <a href="ai_sessions.js.html" class="button">View Source</a>
846
770
  <span>
847
- <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line226">line 226</a>
771
+ <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line187">line 187</a>
848
772
  </span>
849
773
  </p>
850
774
 
@@ -875,7 +799,7 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
875
799
 
876
800
  <div class="columns">
877
801
 
878
- <div class='param-desc column is-7'>data The execution data</div>
802
+ <div class='param-desc column is-7'>data The created session</div>
879
803
 
880
804
 
881
805
  <div class='column is-5 has-text-left'>
@@ -893,7 +817,7 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
893
817
 
894
818
  <div class="columns">
895
819
 
896
- <div class='param-desc column is-7'>data.executionId The execution ID</div>
820
+ <div class='param-desc column is-7'>data.sessionId The session ID</div>
897
821
 
898
822
 
899
823
  <div class='column is-5 has-text-left'>
@@ -911,7 +835,7 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
911
835
 
912
836
  <div class="columns">
913
837
 
914
- <div class='param-desc column is-7'>data.status The execution status</div>
838
+ <div class='param-desc column is-7'>data.status The session status</div>
915
839
 
916
840
 
917
841
  <div class='column is-5 has-text-left'>
@@ -938,13 +862,15 @@ const retData = await api.ai.sessions.create(params, authorization);</code></pre
938
862
  const api = new API();
939
863
  const authorization = '...';
940
864
  const params = {
941
- sessionId: 'session-abc-123',
942
- input: {
865
+ agentType: 'doc-rlm-ingest',
866
+ metadata: {
943
867
  documentId: 'doc-123',
944
- options: { pipelineVariant: 'A', analysisMode: 'full' }
868
+ documentName: 'Patient Report.pdf',
869
+ pipelineVariant: 'A',
870
+ analysisMode: 'full'
945
871
  }
946
872
  };
947
- const retData = await api.ai.sessions.execute(params, authorization);</code></pre>
873
+ const retData = await api.ai.sessions.create(params, authorization);</code></pre>
948
874
 
949
875
 
950
876
 
@@ -954,8 +880,8 @@ const retData = await api.ai.sessions.execute(params, authorization);</code></pr
954
880
 
955
881
 
956
882
 
957
- <h4 class="name" id="getByDocument">
958
- <a class="href-link" href="#getByDocument">#</a>
883
+ <h4 class="name" id="execute">
884
+ <a class="href-link" href="#execute">#</a>
959
885
 
960
886
 
961
887
  <span class='tag'>async</span>
@@ -963,7 +889,7 @@ const retData = await api.ai.sessions.execute(params, authorization);</code></pr
963
889
 
964
890
  <span class="code-name">
965
891
 
966
- getByDocument<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|object|object|array.&lt;object>|array.&lt;object>|array.&lt;object>|object}</span>
892
+ execute<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|string|string}</span>
967
893
 
968
894
  </span>
969
895
  </h4>
@@ -972,8 +898,7 @@ const retData = await api.ai.sessions.execute(params, authorization);</code></pr
972
898
 
973
899
 
974
900
  <div class="description">
975
- Get full session data by document ID.
976
- Returns session, execution, activities, pages, triples and summary.
901
+ Start execution on an existing agent session.
977
902
  </div>
978
903
 
979
904
 
@@ -998,6 +923,8 @@ Returns session, execution, activities, pages, triples and summary.
998
923
  <th>Type</th>
999
924
 
1000
925
 
926
+ <th>Attributes</th>
927
+
1001
928
 
1002
929
 
1003
930
 
@@ -1024,6 +951,14 @@ Returns session, execution, activities, pages, triples and summary.
1024
951
  </td>
1025
952
 
1026
953
 
954
+ <td class="attributes">
955
+
956
+
957
+
958
+
959
+
960
+ </td>
961
+
1027
962
 
1028
963
 
1029
964
 
@@ -1035,7 +970,7 @@ Returns session, execution, activities, pages, triples and summary.
1035
970
 
1036
971
  <tr class="deep-level-1">
1037
972
 
1038
- <td class="name"><code>documentId</code></td>
973
+ <td class="name"><code>sessionId</code></td>
1039
974
 
1040
975
 
1041
976
  <td class="type">
@@ -1048,44 +983,93 @@ Returns session, execution, activities, pages, triples and summary.
1048
983
  </td>
1049
984
 
1050
985
 
986
+ <td class="attributes">
987
+
1051
988
 
1052
-
1053
-
1054
- <td class="description last">The document ID to look up the session for</td>
1055
- </tr>
989
+
1056
990
 
991
+
992
+ </td>
1057
993
 
1058
994
 
995
+
1059
996
 
1060
-
997
+ <td class="description last">The session ID to execute</td>
998
+ </tr>
1061
999
 
1062
-
1063
- <tr class="deep-level-0">
1064
1000
 
1065
- <td class="name"><code>authorization</code></td>
1001
+
1002
+ <tr class="deep-level-1">
1003
+
1004
+ <td class="name"><code>input</code></td>
1066
1005
 
1067
1006
 
1068
1007
  <td class="type">
1069
1008
 
1070
1009
 
1071
- <code class="param-type">string</code>
1010
+ <code class="param-type">object</code>
1072
1011
 
1073
1012
 
1074
1013
 
1075
1014
  </td>
1076
1015
 
1077
1016
 
1017
+ <td class="attributes">
1018
+
1019
+ &lt;optional><br>
1020
+
1078
1021
 
1079
-
1080
-
1081
- <td class="description last">Authorization token</td>
1082
- </tr>
1022
+
1083
1023
 
1024
+
1025
+ </td>
1026
+
1084
1027
 
1085
-
1086
- </tbody>
1087
- </table>
1088
- </div>
1028
+
1029
+
1030
+ <td class="description last">Execution input (documentId, options, etc.)</td>
1031
+ </tr>
1032
+
1033
+
1034
+
1035
+
1036
+
1037
+
1038
+
1039
+ <tr class="deep-level-0">
1040
+
1041
+ <td class="name"><code>authorization</code></td>
1042
+
1043
+
1044
+ <td class="type">
1045
+
1046
+
1047
+ <code class="param-type">string</code>
1048
+
1049
+
1050
+
1051
+ </td>
1052
+
1053
+
1054
+ <td class="attributes">
1055
+
1056
+
1057
+
1058
+
1059
+
1060
+ </td>
1061
+
1062
+
1063
+
1064
+
1065
+ <td class="description last">Authorization token</td>
1066
+ </tr>
1067
+
1068
+
1069
+
1070
+ </tbody>
1071
+ </table>
1072
+ </div>
1089
1073
 
1090
1074
 
1091
1075
 
@@ -1133,7 +1117,7 @@ Returns session, execution, activities, pages, triples and summary.
1133
1117
  <p class="tag-source">
1134
1118
  <a href="ai_sessions.js.html" class="button">View Source</a>
1135
1119
  <span>
1136
- <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line73">line 73</a>
1120
+ <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line230">line 230</a>
1137
1121
  </span>
1138
1122
  </p>
1139
1123
 
@@ -1164,7 +1148,7 @@ Returns session, execution, activities, pages, triples and summary.
1164
1148
 
1165
1149
  <div class="columns">
1166
1150
 
1167
- <div class='param-desc column is-7'>data The full session data</div>
1151
+ <div class='param-desc column is-7'>data The execution data</div>
1168
1152
 
1169
1153
 
1170
1154
  <div class='column is-5 has-text-left'>
@@ -1182,13 +1166,13 @@ Returns session, execution, activities, pages, triples and summary.
1182
1166
 
1183
1167
  <div class="columns">
1184
1168
 
1185
- <div class='param-desc column is-7'>data.session The session object</div>
1169
+ <div class='param-desc column is-7'>data.executionId The execution ID</div>
1186
1170
 
1187
1171
 
1188
1172
  <div class='column is-5 has-text-left'>
1189
1173
  <label>Type: </label>
1190
1174
 
1191
- <code class="param-type">object</code>
1175
+ <code class="param-type">string</code>
1192
1176
 
1193
1177
 
1194
1178
  </div>
@@ -1200,13 +1184,13 @@ Returns session, execution, activities, pages, triples and summary.
1200
1184
 
1201
1185
  <div class="columns">
1202
1186
 
1203
- <div class='param-desc column is-7'>data.execution The latest execution or null</div>
1187
+ <div class='param-desc column is-7'>data.status The execution status</div>
1204
1188
 
1205
1189
 
1206
1190
  <div class='column is-5 has-text-left'>
1207
1191
  <label>Type: </label>
1208
1192
 
1209
- <code class="param-type">object</code>
1193
+ <code class="param-type">string</code>
1210
1194
 
1211
1195
 
1212
1196
  </div>
@@ -1214,95 +1198,657 @@ Returns session, execution, activities, pages, triples and summary.
1214
1198
  </div>
1215
1199
 
1216
1200
 
1217
-
1201
+ </div>
1202
+ </div>
1218
1203
 
1219
- <div class="columns">
1204
+
1205
+
1206
+
1207
+ <h5>Example</h5>
1220
1208
 
1221
- <div class='param-desc column is-7'>data.activities Activity log entries</div>
1222
1209
 
1210
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1211
+ const api = new API();
1212
+ const authorization = '...';
1213
+ const params = {
1214
+ sessionId: 'session-abc-123',
1215
+ input: {
1216
+ documentId: 'doc-123',
1217
+ options: { pipelineVariant: 'A', analysisMode: 'full' }
1218
+ }
1219
+ };
1220
+ const retData = await api.ai.sessions.execute(params, authorization);</code></pre>
1223
1221
 
1224
- <div class='column is-5 has-text-left'>
1225
- <label>Type: </label>
1226
-
1227
- <code class="param-type">array.&lt;object></code>
1228
1222
 
1229
1223
 
1230
- </div>
1231
-
1232
1224
  </div>
1225
+
1226
+ <div class="member">
1233
1227
 
1234
-
1235
-
1236
1228
 
1237
- <div class="columns">
1238
-
1239
- <div class='param-desc column is-7'>data.pages Extracted page objects</div>
1240
-
1241
1229
 
1242
- <div class='column is-5 has-text-left'>
1243
- <label>Type: </label>
1230
+ <h4 class="name" id="getByDocument">
1231
+ <a class="href-link" href="#getByDocument">#</a>
1244
1232
 
1245
- <code class="param-type">array.&lt;object></code>
1246
-
1233
+
1234
+ <span class='tag'>async</span>
1235
+
1236
+
1237
+ <span class="code-name">
1238
+
1239
+ getByDocument<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>|object|object|array.&lt;object>|array.&lt;object>|array.&lt;object>|object}</span>
1240
+
1241
+ </span>
1242
+ </h4>
1243
+
1247
1244
 
1245
+
1246
+
1247
+ <div class="description">
1248
+ Get full session data by document ID.
1249
+ Returns session, execution, activities, pages, triples and summary.
1248
1250
  </div>
1249
1251
 
1250
- </div>
1251
1252
 
1252
-
1253
-
1254
1253
 
1255
- <div class="columns">
1256
-
1257
- <div class='param-desc column is-7'>data.triples Ontology triple objects</div>
1258
-
1254
+
1255
+
1256
+
1257
+
1258
+
1259
+
1260
+
1261
+ <h5>Parameters:</h5>
1259
1262
 
1260
- <div class='column is-5 has-text-left'>
1261
- <label>Type: </label>
1263
+ <div class="table-container">
1264
+ <table class="params table">
1265
+ <thead>
1266
+ <tr>
1267
+
1268
+ <th>Name</th>
1269
+
1270
+
1271
+ <th>Type</th>
1272
+
1273
+
1274
+
1275
+
1276
+
1277
+ <th class="last">Description</th>
1278
+ </tr>
1279
+ </thead>
1280
+
1281
+ <tbody>
1262
1282
 
1263
- <code class="param-type">array.&lt;object></code>
1283
+
1284
+
1285
+ <tr class="deep-level-0">
1286
+
1287
+ <td class="name"><code>params</code></td>
1288
+
1289
+
1290
+ <td class="type">
1291
+
1292
+
1293
+ <code class="param-type">object</code>
1264
1294
 
1265
1295
 
1266
- </div>
1296
+
1297
+ </td>
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+ <td class="description last">Parameters</td>
1304
+ </tr>
1305
+
1306
+
1307
+
1267
1308
 
1309
+ <tr class="deep-level-1">
1310
+
1311
+ <td class="name"><code>documentId</code></td>
1312
+
1313
+
1314
+ <td class="type">
1315
+
1316
+
1317
+ <code class="param-type">string</code>
1318
+
1319
+
1320
+
1321
+ </td>
1322
+
1323
+
1324
+
1325
+
1326
+
1327
+ <td class="description last">The document ID to look up the session for</td>
1328
+ </tr>
1329
+
1330
+
1331
+
1332
+
1333
+
1334
+
1335
+
1336
+ <tr class="deep-level-0">
1337
+
1338
+ <td class="name"><code>authorization</code></td>
1339
+
1340
+
1341
+ <td class="type">
1342
+
1343
+
1344
+ <code class="param-type">string</code>
1345
+
1346
+
1347
+
1348
+ </td>
1349
+
1350
+
1351
+
1352
+
1353
+
1354
+ <td class="description last">Authorization token</td>
1355
+ </tr>
1356
+
1357
+
1358
+
1359
+ </tbody>
1360
+ </table>
1268
1361
  </div>
1269
1362
 
1270
-
1271
-
1272
1363
 
1273
- <div class="columns">
1364
+
1365
+
1366
+
1367
+ <dl class="details">
1368
+
1274
1369
 
1275
- <div class='param-desc column is-7'>data.summary Document summary or null</div>
1370
+
1276
1371
 
1372
+
1277
1373
 
1278
- <div class='column is-5 has-text-left'>
1279
- <label>Type: </label>
1280
-
1281
- <code class="param-type">object</code>
1282
1374
 
1375
+
1283
1376
 
1284
- </div>
1285
1377
 
1286
- </div>
1287
1378
 
1288
-
1289
- </div>
1290
- </div>
1379
+
1291
1380
 
1381
+
1292
1382
 
1383
+
1293
1384
 
1385
+
1386
+ <dt class="tag-author">Author:</dt>
1387
+ <dd class="tag-author">
1388
+ <ul>
1389
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1390
+ </ul>
1391
+ </dd>
1392
+
1294
1393
 
1295
- <h5>Example</h5>
1296
1394
 
1395
+
1297
1396
 
1298
- <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1299
- const api = new API();
1300
- const authorization = '...';
1397
+
1398
+
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+
1405
+
1406
+ <p class="tag-source">
1407
+ <a href="ai_sessions.js.html" class="button">View Source</a>
1408
+ <span>
1409
+ <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line77">line 77</a>
1410
+ </span>
1411
+ </p>
1412
+
1413
+ </dl>
1414
+
1415
+
1416
+
1417
+
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+
1424
+
1425
+
1426
+
1427
+
1428
+
1429
+
1430
+
1431
+
1432
+ <div class='columns method-parameter'>
1433
+ <div class="column is-2"><label>Returns:</label></div>
1434
+ <div class="column is-10">
1435
+
1436
+
1437
+
1438
+ <div class="columns">
1439
+
1440
+ <div class='param-desc column is-7'>data The full session data</div>
1441
+
1442
+
1443
+ <div class='column is-5 has-text-left'>
1444
+ <label>Type: </label>
1445
+
1446
+ <code class="param-type">Promise.&lt;object></code>
1447
+
1448
+
1449
+ </div>
1450
+
1451
+ </div>
1452
+
1453
+
1454
+
1455
+
1456
+ <div class="columns">
1457
+
1458
+ <div class='param-desc column is-7'>data.session The session object</div>
1459
+
1460
+
1461
+ <div class='column is-5 has-text-left'>
1462
+ <label>Type: </label>
1463
+
1464
+ <code class="param-type">object</code>
1465
+
1466
+
1467
+ </div>
1468
+
1469
+ </div>
1470
+
1471
+
1472
+
1473
+
1474
+ <div class="columns">
1475
+
1476
+ <div class='param-desc column is-7'>data.execution The latest execution or null</div>
1477
+
1478
+
1479
+ <div class='column is-5 has-text-left'>
1480
+ <label>Type: </label>
1481
+
1482
+ <code class="param-type">object</code>
1483
+
1484
+
1485
+ </div>
1486
+
1487
+ </div>
1488
+
1489
+
1490
+
1491
+
1492
+ <div class="columns">
1493
+
1494
+ <div class='param-desc column is-7'>data.activities Activity log entries</div>
1495
+
1496
+
1497
+ <div class='column is-5 has-text-left'>
1498
+ <label>Type: </label>
1499
+
1500
+ <code class="param-type">array.&lt;object></code>
1501
+
1502
+
1503
+ </div>
1504
+
1505
+ </div>
1506
+
1507
+
1508
+
1509
+
1510
+ <div class="columns">
1511
+
1512
+ <div class='param-desc column is-7'>data.pages Extracted page objects</div>
1513
+
1514
+
1515
+ <div class='column is-5 has-text-left'>
1516
+ <label>Type: </label>
1517
+
1518
+ <code class="param-type">array.&lt;object></code>
1519
+
1520
+
1521
+ </div>
1522
+
1523
+ </div>
1524
+
1525
+
1526
+
1527
+
1528
+ <div class="columns">
1529
+
1530
+ <div class='param-desc column is-7'>data.triples Ontology triple objects</div>
1531
+
1532
+
1533
+ <div class='column is-5 has-text-left'>
1534
+ <label>Type: </label>
1535
+
1536
+ <code class="param-type">array.&lt;object></code>
1537
+
1538
+
1539
+ </div>
1540
+
1541
+ </div>
1542
+
1543
+
1544
+
1545
+
1546
+ <div class="columns">
1547
+
1548
+ <div class='param-desc column is-7'>data.summary Document summary or null</div>
1549
+
1550
+
1551
+ <div class='column is-5 has-text-left'>
1552
+ <label>Type: </label>
1553
+
1554
+ <code class="param-type">object</code>
1555
+
1556
+
1557
+ </div>
1558
+
1559
+ </div>
1560
+
1561
+
1562
+ </div>
1563
+ </div>
1564
+
1565
+
1566
+
1567
+
1568
+ <h5>Example</h5>
1569
+
1570
+
1571
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1572
+ const api = new API();
1573
+ const authorization = '...';
1301
1574
  const params = { documentId: 'doc-123' };
1302
1575
  const retData = await api.ai.sessions.getByDocument(params, authorization);</code></pre>
1303
1576
 
1304
1577
 
1305
1578
 
1579
+ </div>
1580
+
1581
+ <div class="member">
1582
+
1583
+
1584
+
1585
+ <h4 class="name" id="removeDocuments">
1586
+ <a class="href-link" href="#removeDocuments">#</a>
1587
+
1588
+
1589
+ <span class='tag'>async</span>
1590
+
1591
+
1592
+ <span class="code-name">
1593
+
1594
+ removeDocuments<span class="signature">(params, authorization)</span><span class="type-signature"> &rarr; {Promise.&lt;object>}</span>
1595
+
1596
+ </span>
1597
+ </h4>
1598
+
1599
+
1600
+
1601
+
1602
+ <div class="description">
1603
+ Remove documents from an existing agent session.
1604
+ The agent will handle the documentIds accordingly.
1605
+ </div>
1606
+
1607
+
1608
+
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+
1615
+
1616
+ <h5>Parameters:</h5>
1617
+
1618
+ <div class="table-container">
1619
+ <table class="params table">
1620
+ <thead>
1621
+ <tr>
1622
+
1623
+ <th>Name</th>
1624
+
1625
+
1626
+ <th>Type</th>
1627
+
1628
+
1629
+
1630
+
1631
+
1632
+ <th class="last">Description</th>
1633
+ </tr>
1634
+ </thead>
1635
+
1636
+ <tbody>
1637
+
1638
+
1639
+
1640
+ <tr class="deep-level-0">
1641
+
1642
+ <td class="name"><code>params</code></td>
1643
+
1644
+
1645
+ <td class="type">
1646
+
1647
+
1648
+ <code class="param-type">object</code>
1649
+
1650
+
1651
+
1652
+ </td>
1653
+
1654
+
1655
+
1656
+
1657
+
1658
+ <td class="description last">Parameters</td>
1659
+ </tr>
1660
+
1661
+
1662
+
1663
+
1664
+ <tr class="deep-level-1">
1665
+
1666
+ <td class="name"><code>sessionId</code></td>
1667
+
1668
+
1669
+ <td class="type">
1670
+
1671
+
1672
+ <code class="param-type">string</code>
1673
+
1674
+
1675
+
1676
+ </td>
1677
+
1678
+
1679
+
1680
+
1681
+
1682
+ <td class="description last">The session ID</td>
1683
+ </tr>
1684
+
1685
+
1686
+
1687
+ <tr class="deep-level-1">
1688
+
1689
+ <td class="name"><code>documentIds</code></td>
1690
+
1691
+
1692
+ <td class="type">
1693
+
1694
+
1695
+ <code class="param-type">array.&lt;string></code>
1696
+
1697
+
1698
+
1699
+ </td>
1700
+
1701
+
1702
+
1703
+
1704
+
1705
+ <td class="description last">Array of document IDs to remove</td>
1706
+ </tr>
1707
+
1708
+
1709
+
1710
+
1711
+
1712
+
1713
+
1714
+ <tr class="deep-level-0">
1715
+
1716
+ <td class="name"><code>authorization</code></td>
1717
+
1718
+
1719
+ <td class="type">
1720
+
1721
+
1722
+ <code class="param-type">string</code>
1723
+
1724
+
1725
+
1726
+ </td>
1727
+
1728
+
1729
+
1730
+
1731
+
1732
+ <td class="description last">Authorization token</td>
1733
+ </tr>
1734
+
1735
+
1736
+
1737
+ </tbody>
1738
+ </table>
1739
+ </div>
1740
+
1741
+
1742
+
1743
+
1744
+
1745
+ <dl class="details">
1746
+
1747
+
1748
+
1749
+
1750
+
1751
+
1752
+
1753
+
1754
+
1755
+
1756
+
1757
+
1758
+
1759
+
1760
+
1761
+
1762
+
1763
+
1764
+ <dt class="tag-author">Author:</dt>
1765
+ <dd class="tag-author">
1766
+ <ul>
1767
+ <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
1768
+ </ul>
1769
+ </dd>
1770
+
1771
+
1772
+
1773
+
1774
+
1775
+
1776
+
1777
+
1778
+
1779
+
1780
+
1781
+
1782
+
1783
+
1784
+ <p class="tag-source">
1785
+ <a href="ai_sessions.js.html" class="button">View Source</a>
1786
+ <span>
1787
+ <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line312">line 312</a>
1788
+ </span>
1789
+ </p>
1790
+
1791
+ </dl>
1792
+
1793
+
1794
+
1795
+
1796
+
1797
+
1798
+
1799
+
1800
+
1801
+
1802
+
1803
+
1804
+
1805
+
1806
+
1807
+
1808
+
1809
+
1810
+ <div class='columns method-parameter'>
1811
+ <div class="column is-2"><label>Returns:</label></div>
1812
+ <div class="column is-10">
1813
+
1814
+
1815
+
1816
+ <div class="columns">
1817
+
1818
+ <div class='param-desc column is-7'>data The result from the agent</div>
1819
+
1820
+
1821
+ <div class='column is-5 has-text-left'>
1822
+ <label>Type: </label>
1823
+
1824
+ <code class="param-type">Promise.&lt;object></code>
1825
+
1826
+
1827
+ </div>
1828
+
1829
+ </div>
1830
+
1831
+
1832
+ </div>
1833
+ </div>
1834
+
1835
+
1836
+
1837
+
1838
+ <h5>Example</h5>
1839
+
1840
+
1841
+ <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
1842
+ const api = new API();
1843
+ const authorization = '...';
1844
+ const params = {
1845
+ sessionId: 'session-abc-123',
1846
+ documentIds: ['doc-123', 'doc-456']
1847
+ };
1848
+ const retData = await api.ai.sessions.removeDocuments(params, authorization);</code></pre>
1849
+
1850
+
1851
+
1306
1852
  </div>
1307
1853
 
1308
1854
  <div class="member">
@@ -1933,7 +2479,7 @@ Used by Scarface to push corrections or enrichments for a document.
1933
2479
  <p class="tag-source">
1934
2480
  <a href="ai_sessions.js.html" class="button">View Source</a>
1935
2481
  <span>
1936
- <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line134">line 134</a>
2482
+ <a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line138">line 138</a>
1937
2483
  </span>
1938
2484
  </p>
1939
2485