@docbrasil/api-systemmanager 1.1.80 → 1.1.82
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 → ai/index.js} +3 -0
- package/api/ai/sessions.js +243 -0
- package/dist/bundle.cjs +240 -0
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +202 -47
- package/docs/AISession.html +2100 -0
- package/docs/Admin.html +1 -1
- package/docs/AdminDocuments.html +1 -1
- package/docs/AdminForm.html +1 -1
- package/docs/AdminLists.html +1 -1
- package/docs/AdminMessage.html +1 -1
- package/docs/AdminNotification.html +1 -1
- package/docs/AdminPlugin.html +1 -1
- package/docs/AdminPolicy.html +1 -1
- package/docs/AdminProcesses.html +1 -1
- package/docs/AdminTask.html +1 -1
- package/docs/AdminUser.html +1 -1
- package/docs/Application.html +1 -1
- package/docs/Chart.html +1 -1
- package/docs/Dashboard.html +1 -1
- package/docs/Datasource.html +1 -1
- package/docs/Dispatch.html +1 -1
- package/docs/Documents.html +1 -1
- package/docs/External.html +1 -1
- package/docs/GeoLocation.html +1 -1
- package/docs/Help.html +1 -1
- package/docs/Kanban.html +1 -1
- package/docs/Login.html +1 -1
- package/docs/MyTasks.html +1 -1
- package/docs/MyndAI.html +5 -5
- package/docs/Notification.html +1 -1
- package/docs/Organization.html +1 -1
- package/docs/Page.html +1 -1
- package/docs/Process.html +1 -1
- package/docs/Register.html +1 -1
- package/docs/Report.html +1 -1
- package/docs/Session.html +1 -1
- package/docs/Settings.html +1 -1
- package/docs/Task.html +1 -1
- package/docs/TaskAvailable.html +1 -1
- package/docs/Updates.html +1 -1
- package/docs/User.html +1 -1
- package/docs/Users.html +1 -1
- package/docs/admin_doctypes.js.html +1 -1
- package/docs/admin_document.js.html +1 -1
- package/docs/admin_form.js.html +1 -1
- package/docs/admin_index.js.html +1 -1
- package/docs/admin_list.js.html +1 -1
- package/docs/admin_message.js.html +1 -1
- package/docs/admin_notification.js.html +1 -1
- package/docs/admin_organization.js.html +1 -1
- package/docs/admin_plugin.js.html +1 -1
- package/docs/admin_policy.js.html +1 -1
- package/docs/admin_processes.js.html +1 -1
- package/docs/admin_task.js.html +1 -1
- package/docs/admin_user.js.html +1 -1
- package/docs/{ai.js.html → ai_index.js.html} +6 -3
- package/docs/ai_sessions.js.html +360 -0
- package/docs/dispatch.js.html +1 -1
- package/docs/external.js.html +1 -1
- package/docs/general_geoLocation.js.html +1 -1
- package/docs/general_index.js.html +1 -1
- package/docs/index.html +1 -1
- package/docs/login.js.html +1 -1
- package/docs/session.js.html +1 -1
- package/docs/user_application.js.html +1 -1
- package/docs/user_dashboard.js.html +1 -1
- package/docs/user_datasource.js.html +1 -1
- package/docs/user_document.js.html +1 -1
- package/docs/user_help.js.html +1 -1
- package/docs/user_index.js.html +1 -1
- package/docs/user_kanban.js.html +1 -1
- package/docs/user_my_tasks.js.html +1 -1
- package/docs/user_notification.js.html +1 -1
- package/docs/user_organization.js.html +1 -1
- package/docs/user_page.js.html +1 -1
- package/docs/user_process.js.html +1 -1
- package/docs/user_register.js.html +1 -1
- package/docs/user_settings.js.html +1 -1
- package/docs/user_task.js.html +1 -1
- package/docs/user_task_available.js.html +1 -1
- package/docs/user_updates.js.html +1 -1
- package/docs/user_user.js.html +1 -1
- package/docs/utils_promises.js.html +1 -1
- package/index.js +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,2100 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html lang="en">
|
|
3
|
+
|
|
4
|
+
<head>
|
|
5
|
+
|
|
6
|
+
<meta charset="utf-8">
|
|
7
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
8
|
+
<title> AISession</title>
|
|
9
|
+
|
|
10
|
+
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
|
|
11
|
+
<script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
|
|
12
|
+
<script src="./build/entry.js"></script>
|
|
13
|
+
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
|
|
14
|
+
<!--[if lt IE 9]>
|
|
15
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
16
|
+
<![endif]-->
|
|
17
|
+
<link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
|
|
18
|
+
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
|
|
19
|
+
<link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
|
|
20
|
+
<link type="text/css" rel="stylesheet" href="styles/app.min.css">
|
|
21
|
+
<link type="text/css" rel="stylesheet" href="styles/iframe.css">
|
|
22
|
+
<link type="text/css" rel="stylesheet" href="">
|
|
23
|
+
<script async defer src="https://buttons.github.io/buttons.js"></script>
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
</head>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
<body class="layout small-header">
|
|
31
|
+
<div id="stickyNavbarOverlay"></div>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<div class="top-nav">
|
|
35
|
+
<div class="inner">
|
|
36
|
+
<a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
|
|
37
|
+
<span aria-hidden="true"></span>
|
|
38
|
+
<span aria-hidden="true"></span>
|
|
39
|
+
<span aria-hidden="true"></span>
|
|
40
|
+
</a>
|
|
41
|
+
<div class="logo">
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
<div class="menu">
|
|
46
|
+
|
|
47
|
+
<div class="navigation">
|
|
48
|
+
<a
|
|
49
|
+
href="index.html"
|
|
50
|
+
class="link"
|
|
51
|
+
>
|
|
52
|
+
Documentation
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
</div>
|
|
58
|
+
</div>
|
|
59
|
+
</div>
|
|
60
|
+
</div>
|
|
61
|
+
<div id="main">
|
|
62
|
+
<div
|
|
63
|
+
class="sidebar "
|
|
64
|
+
id="sidebarNav"
|
|
65
|
+
>
|
|
66
|
+
|
|
67
|
+
<nav>
|
|
68
|
+
|
|
69
|
+
<h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="AISession.html">AISession</a></li><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Application.html">Application</a></li><li><a href="Chart.html">Chart</a></li><li><a href="Dashboard.html">Dashboard</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Help.html">Help</a></li><li><a href="Kanban.html">Kanban</a></li><li><a href="Login.html">Login</a></li><li><a href="MyTasks.html">MyTasks</a></li><li><a href="MyndAI.html">MyndAI</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Page.html">Page</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Report.html">Report</a></li><li><a href="Session.html">Session</a></li><li><a href="Settings.html">Settings</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="Updates.html">Updates</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
|
|
70
|
+
|
|
71
|
+
</nav>
|
|
72
|
+
</div>
|
|
73
|
+
<div class="core" id="main-content-wrapper">
|
|
74
|
+
<div class="content">
|
|
75
|
+
<header class="page-title">
|
|
76
|
+
<p>Class</p>
|
|
77
|
+
<h1>AISession</h1>
|
|
78
|
+
</header>
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<section>
|
|
85
|
+
|
|
86
|
+
<header>
|
|
87
|
+
|
|
88
|
+
<h2><span class="attribs"><span class="type-signature"></span></span>AISession<span class="signature">()</span><span class="type-signature"></span></h2>
|
|
89
|
+
|
|
90
|
+
<div class="class-description">Class for AI Session management</div>
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
</header>
|
|
94
|
+
|
|
95
|
+
<article>
|
|
96
|
+
<div class="container-overview">
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<div class='vertical-section'>
|
|
100
|
+
<div class="members">
|
|
101
|
+
<div class="member">
|
|
102
|
+
<div class=name>
|
|
103
|
+
<span class="tag">Constructor</span>
|
|
104
|
+
</div>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<h4 class="name" id="AISession">
|
|
110
|
+
<a class="href-link" href="#AISession">#</a>
|
|
111
|
+
|
|
112
|
+
<span class="code-name">
|
|
113
|
+
|
|
114
|
+
new AISession<span class="signature">()</span><span class="type-signature"></span>
|
|
115
|
+
|
|
116
|
+
</span>
|
|
117
|
+
</h4>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
<dl class="details">
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<p class="tag-source">
|
|
168
|
+
<a href="ai_sessions.js.html" class="button">View Source</a>
|
|
169
|
+
<span>
|
|
170
|
+
<a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line9">line 9</a>
|
|
171
|
+
</span>
|
|
172
|
+
</p>
|
|
173
|
+
|
|
174
|
+
</dl>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
</div>
|
|
198
|
+
</div>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
<div class='vertical-section'>
|
|
220
|
+
<h1>Methods</h1>
|
|
221
|
+
<div class="members">
|
|
222
|
+
|
|
223
|
+
<div class="member">
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<h4 class="name" id="create">
|
|
228
|
+
<a class="href-link" href="#create">#</a>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<span class='tag'>async</span>
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
<span class="code-name">
|
|
235
|
+
|
|
236
|
+
create<span class="signature">(params, authorization)</span><span class="type-signature"> → {Promise.<object>|string|string}</span>
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
</h4>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="description">
|
|
245
|
+
Create a new agent session.
|
|
246
|
+
Use this to create a session with full metadata before triggering execution.
|
|
247
|
+
</div>
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
<h5>Parameters:</h5>
|
|
259
|
+
|
|
260
|
+
<div class="table-container">
|
|
261
|
+
<table class="params table">
|
|
262
|
+
<thead>
|
|
263
|
+
<tr>
|
|
264
|
+
|
|
265
|
+
<th>Name</th>
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
<th>Type</th>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
<th>Attributes</th>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<th class="last">Description</th>
|
|
277
|
+
</tr>
|
|
278
|
+
</thead>
|
|
279
|
+
|
|
280
|
+
<tbody>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<tr class="deep-level-0">
|
|
285
|
+
|
|
286
|
+
<td class="name"><code>params</code></td>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
<td class="type">
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<code class="param-type">object</code>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
</td>
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
<td class="attributes">
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
</td>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
<td class="description last">Parameters</td>
|
|
311
|
+
</tr>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
<tr class="deep-level-1">
|
|
317
|
+
|
|
318
|
+
<td class="name"><code>agentType</code></td>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<td class="type">
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<code class="param-type">string</code>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
</td>
|
|
329
|
+
|
|
330
|
+
|
|
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
|
+
<optional><br>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
</td>
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<td class="description last">Agent configuration options</td>
|
|
376
|
+
</tr>
|
|
377
|
+
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
<tr class="deep-level-1">
|
|
381
|
+
|
|
382
|
+
<td class="name"><code>metadata</code></td>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<td class="type">
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
<code class="param-type">object</code>
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
</td>
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
<td class="attributes">
|
|
396
|
+
|
|
397
|
+
<optional><br>
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
|
|
402
|
+
|
|
403
|
+
</td>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<td class="description last">Session metadata (documentId, pipelineVariant, analysisMode, etc.)</td>
|
|
409
|
+
</tr>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
<tr class="deep-level-0">
|
|
418
|
+
|
|
419
|
+
<td class="name"><code>authorization</code></td>
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
<td class="type">
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<code class="param-type">string</code>
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
</td>
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
<td class="attributes">
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
</td>
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<td class="description last">Authorization token</td>
|
|
444
|
+
</tr>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
</tbody>
|
|
449
|
+
</table>
|
|
450
|
+
</div>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
<dl class="details">
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
<dt class="tag-author">Author:</dt>
|
|
476
|
+
<dd class="tag-author">
|
|
477
|
+
<ul>
|
|
478
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
479
|
+
</ul>
|
|
480
|
+
</dd>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
<p class="tag-source">
|
|
496
|
+
<a href="ai_sessions.js.html" class="button">View Source</a>
|
|
497
|
+
<span>
|
|
498
|
+
<a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line182">line 182</a>
|
|
499
|
+
</span>
|
|
500
|
+
</p>
|
|
501
|
+
|
|
502
|
+
</dl>
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<div class='columns method-parameter'>
|
|
522
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
523
|
+
<div class="column is-10">
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
<div class="columns">
|
|
528
|
+
|
|
529
|
+
<div class='param-desc column is-7'>data The created session</div>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<div class='column is-5 has-text-left'>
|
|
533
|
+
<label>Type: </label>
|
|
534
|
+
|
|
535
|
+
<code class="param-type">Promise.<object></code>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
</div>
|
|
539
|
+
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
|
|
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
|
+
</div>
|
|
580
|
+
</div>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
<h5>Example</h5>
|
|
586
|
+
|
|
587
|
+
|
|
588
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
589
|
+
const api = new API();
|
|
590
|
+
const authorization = '...';
|
|
591
|
+
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
|
+
}
|
|
599
|
+
};
|
|
600
|
+
const retData = await api.ai.sessions.create(params, authorization);</code></pre>
|
|
601
|
+
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
<div class="member">
|
|
607
|
+
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
<h4 class="name" id="execute">
|
|
611
|
+
<a class="href-link" href="#execute">#</a>
|
|
612
|
+
|
|
613
|
+
|
|
614
|
+
<span class='tag'>async</span>
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
<span class="code-name">
|
|
618
|
+
|
|
619
|
+
execute<span class="signature">(params, authorization)</span><span class="type-signature"> → {Promise.<object>|string|string}</span>
|
|
620
|
+
|
|
621
|
+
</span>
|
|
622
|
+
</h4>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<div class="description">
|
|
628
|
+
Start execution on an existing agent session.
|
|
629
|
+
</div>
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
<h5>Parameters:</h5>
|
|
641
|
+
|
|
642
|
+
<div class="table-container">
|
|
643
|
+
<table class="params table">
|
|
644
|
+
<thead>
|
|
645
|
+
<tr>
|
|
646
|
+
|
|
647
|
+
<th>Name</th>
|
|
648
|
+
|
|
649
|
+
|
|
650
|
+
<th>Type</th>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
<th>Attributes</th>
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
<th class="last">Description</th>
|
|
659
|
+
</tr>
|
|
660
|
+
</thead>
|
|
661
|
+
|
|
662
|
+
<tbody>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<tr class="deep-level-0">
|
|
667
|
+
|
|
668
|
+
<td class="name"><code>params</code></td>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
<td class="type">
|
|
672
|
+
|
|
673
|
+
|
|
674
|
+
<code class="param-type">object</code>
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</td>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<td class="attributes">
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
</td>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
<td class="description last">Parameters</td>
|
|
693
|
+
</tr>
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
<tr class="deep-level-1">
|
|
699
|
+
|
|
700
|
+
<td class="name"><code>sessionId</code></td>
|
|
701
|
+
|
|
702
|
+
|
|
703
|
+
<td class="type">
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
<code class="param-type">string</code>
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
</td>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
<td class="attributes">
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
|
|
719
|
+
</td>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
<td class="description last">The session ID to execute</td>
|
|
725
|
+
</tr>
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
|
|
729
|
+
<tr class="deep-level-1">
|
|
730
|
+
|
|
731
|
+
<td class="name"><code>input</code></td>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
<td class="type">
|
|
735
|
+
|
|
736
|
+
|
|
737
|
+
<code class="param-type">object</code>
|
|
738
|
+
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
</td>
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
<td class="attributes">
|
|
745
|
+
|
|
746
|
+
<optional><br>
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
</td>
|
|
753
|
+
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
<td class="description last">Execution input (documentId, options, etc.)</td>
|
|
758
|
+
</tr>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
<tr class="deep-level-0">
|
|
767
|
+
|
|
768
|
+
<td class="name"><code>authorization</code></td>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
<td class="type">
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
<code class="param-type">string</code>
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</td>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
<td class="attributes">
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</td>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
|
|
791
|
+
|
|
792
|
+
<td class="description last">Authorization token</td>
|
|
793
|
+
</tr>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
</tbody>
|
|
798
|
+
</table>
|
|
799
|
+
</div>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
|
|
805
|
+
<dl class="details">
|
|
806
|
+
|
|
807
|
+
|
|
808
|
+
|
|
809
|
+
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<dt class="tag-author">Author:</dt>
|
|
825
|
+
<dd class="tag-author">
|
|
826
|
+
<ul>
|
|
827
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
828
|
+
</ul>
|
|
829
|
+
</dd>
|
|
830
|
+
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
<p class="tag-source">
|
|
845
|
+
<a href="ai_sessions.js.html" class="button">View Source</a>
|
|
846
|
+
<span>
|
|
847
|
+
<a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line224">line 224</a>
|
|
848
|
+
</span>
|
|
849
|
+
</p>
|
|
850
|
+
|
|
851
|
+
</dl>
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
<div class='columns method-parameter'>
|
|
871
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
872
|
+
<div class="column is-10">
|
|
873
|
+
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<div class="columns">
|
|
877
|
+
|
|
878
|
+
<div class='param-desc column is-7'>data The execution data</div>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
<div class='column is-5 has-text-left'>
|
|
882
|
+
<label>Type: </label>
|
|
883
|
+
|
|
884
|
+
<code class="param-type">Promise.<object></code>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
</div>
|
|
888
|
+
|
|
889
|
+
</div>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
<div class="columns">
|
|
895
|
+
|
|
896
|
+
<div class='param-desc column is-7'>data.executionId The execution ID</div>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
<div class='column is-5 has-text-left'>
|
|
900
|
+
<label>Type: </label>
|
|
901
|
+
|
|
902
|
+
<code class="param-type">string</code>
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
</div>
|
|
906
|
+
|
|
907
|
+
</div>
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
<div class="columns">
|
|
913
|
+
|
|
914
|
+
<div class='param-desc column is-7'>data.status The execution status</div>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
<div class='column is-5 has-text-left'>
|
|
918
|
+
<label>Type: </label>
|
|
919
|
+
|
|
920
|
+
<code class="param-type">string</code>
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
</div>
|
|
924
|
+
|
|
925
|
+
</div>
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
</div>
|
|
929
|
+
</div>
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
<h5>Example</h5>
|
|
935
|
+
|
|
936
|
+
|
|
937
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
938
|
+
const api = new API();
|
|
939
|
+
const authorization = '...';
|
|
940
|
+
const params = {
|
|
941
|
+
sessionId: 'session-abc-123',
|
|
942
|
+
input: {
|
|
943
|
+
documentId: 'doc-123',
|
|
944
|
+
options: { pipelineVariant: 'A', analysisMode: 'full' }
|
|
945
|
+
}
|
|
946
|
+
};
|
|
947
|
+
const retData = await api.ai.sessions.execute(params, authorization);</code></pre>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
</div>
|
|
952
|
+
|
|
953
|
+
<div class="member">
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
<h4 class="name" id="getByDocument">
|
|
958
|
+
<a class="href-link" href="#getByDocument">#</a>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
<span class='tag'>async</span>
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<span class="code-name">
|
|
965
|
+
|
|
966
|
+
getByDocument<span class="signature">(params, authorization)</span><span class="type-signature"> → {Promise.<object>|object|object|array.<object>|array.<object>|array.<object>|object}</span>
|
|
967
|
+
|
|
968
|
+
</span>
|
|
969
|
+
</h4>
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
<div class="description">
|
|
975
|
+
Get full session data by document ID.
|
|
976
|
+
Returns session, execution, activities, pages, triples and summary.
|
|
977
|
+
</div>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
|
|
982
|
+
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
<h5>Parameters:</h5>
|
|
989
|
+
|
|
990
|
+
<div class="table-container">
|
|
991
|
+
<table class="params table">
|
|
992
|
+
<thead>
|
|
993
|
+
<tr>
|
|
994
|
+
|
|
995
|
+
<th>Name</th>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
<th>Type</th>
|
|
999
|
+
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
<th class="last">Description</th>
|
|
1005
|
+
</tr>
|
|
1006
|
+
</thead>
|
|
1007
|
+
|
|
1008
|
+
<tbody>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<tr class="deep-level-0">
|
|
1013
|
+
|
|
1014
|
+
<td class="name"><code>params</code></td>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
<td class="type">
|
|
1018
|
+
|
|
1019
|
+
|
|
1020
|
+
<code class="param-type">object</code>
|
|
1021
|
+
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
</td>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
<td class="description last">Parameters</td>
|
|
1031
|
+
</tr>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
<tr class="deep-level-1">
|
|
1037
|
+
|
|
1038
|
+
<td class="name"><code>documentId</code></td>
|
|
1039
|
+
|
|
1040
|
+
|
|
1041
|
+
<td class="type">
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
<code class="param-type">string</code>
|
|
1045
|
+
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
</td>
|
|
1049
|
+
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
<td class="description last">The document ID to look up the session for</td>
|
|
1055
|
+
</tr>
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
<tr class="deep-level-0">
|
|
1064
|
+
|
|
1065
|
+
<td class="name"><code>authorization</code></td>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
<td class="type">
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
<code class="param-type">string</code>
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
</td>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
<td class="description last">Authorization token</td>
|
|
1082
|
+
</tr>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
</tbody>
|
|
1087
|
+
</table>
|
|
1088
|
+
</div>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
|
|
1094
|
+
<dl class="details">
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
<dt class="tag-author">Author:</dt>
|
|
1114
|
+
<dd class="tag-author">
|
|
1115
|
+
<ul>
|
|
1116
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
1117
|
+
</ul>
|
|
1118
|
+
</dd>
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
<p class="tag-source">
|
|
1134
|
+
<a href="ai_sessions.js.html" class="button">View Source</a>
|
|
1135
|
+
<span>
|
|
1136
|
+
<a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line74">line 74</a>
|
|
1137
|
+
</span>
|
|
1138
|
+
</p>
|
|
1139
|
+
|
|
1140
|
+
</dl>
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
<div class='columns method-parameter'>
|
|
1160
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1161
|
+
<div class="column is-10">
|
|
1162
|
+
|
|
1163
|
+
|
|
1164
|
+
|
|
1165
|
+
<div class="columns">
|
|
1166
|
+
|
|
1167
|
+
<div class='param-desc column is-7'>data The full session data</div>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
<div class='column is-5 has-text-left'>
|
|
1171
|
+
<label>Type: </label>
|
|
1172
|
+
|
|
1173
|
+
<code class="param-type">Promise.<object></code>
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
</div>
|
|
1177
|
+
|
|
1178
|
+
</div>
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
<div class="columns">
|
|
1184
|
+
|
|
1185
|
+
<div class='param-desc column is-7'>data.session The session object</div>
|
|
1186
|
+
|
|
1187
|
+
|
|
1188
|
+
<div class='column is-5 has-text-left'>
|
|
1189
|
+
<label>Type: </label>
|
|
1190
|
+
|
|
1191
|
+
<code class="param-type">object</code>
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
</div>
|
|
1195
|
+
|
|
1196
|
+
</div>
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
<div class="columns">
|
|
1202
|
+
|
|
1203
|
+
<div class='param-desc column is-7'>data.execution The latest execution or null</div>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
<div class='column is-5 has-text-left'>
|
|
1207
|
+
<label>Type: </label>
|
|
1208
|
+
|
|
1209
|
+
<code class="param-type">object</code>
|
|
1210
|
+
|
|
1211
|
+
|
|
1212
|
+
</div>
|
|
1213
|
+
|
|
1214
|
+
</div>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
<div class="columns">
|
|
1220
|
+
|
|
1221
|
+
<div class='param-desc column is-7'>data.activities Activity log entries</div>
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
<div class='column is-5 has-text-left'>
|
|
1225
|
+
<label>Type: </label>
|
|
1226
|
+
|
|
1227
|
+
<code class="param-type">array.<object></code>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
</div>
|
|
1231
|
+
|
|
1232
|
+
</div>
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
<div class="columns">
|
|
1238
|
+
|
|
1239
|
+
<div class='param-desc column is-7'>data.pages Extracted page objects</div>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<div class='column is-5 has-text-left'>
|
|
1243
|
+
<label>Type: </label>
|
|
1244
|
+
|
|
1245
|
+
<code class="param-type">array.<object></code>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
</div>
|
|
1249
|
+
|
|
1250
|
+
</div>
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<div class="columns">
|
|
1256
|
+
|
|
1257
|
+
<div class='param-desc column is-7'>data.triples Ontology triple objects</div>
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
<div class='column is-5 has-text-left'>
|
|
1261
|
+
<label>Type: </label>
|
|
1262
|
+
|
|
1263
|
+
<code class="param-type">array.<object></code>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
</div>
|
|
1267
|
+
|
|
1268
|
+
</div>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
<div class="columns">
|
|
1274
|
+
|
|
1275
|
+
<div class='param-desc column is-7'>data.summary Document summary or null</div>
|
|
1276
|
+
|
|
1277
|
+
|
|
1278
|
+
<div class='column is-5 has-text-left'>
|
|
1279
|
+
<label>Type: </label>
|
|
1280
|
+
|
|
1281
|
+
<code class="param-type">object</code>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
</div>
|
|
1285
|
+
|
|
1286
|
+
</div>
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
</div>
|
|
1290
|
+
</div>
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
<h5>Example</h5>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
1299
|
+
const api = new API();
|
|
1300
|
+
const authorization = '...';
|
|
1301
|
+
const params = { documentId: 'doc-123' };
|
|
1302
|
+
const retData = await api.ai.sessions.getByDocument(params, authorization);</code></pre>
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
</div>
|
|
1307
|
+
|
|
1308
|
+
<div class="member">
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
|
|
1312
|
+
<h4 class="name" id="updateData">
|
|
1313
|
+
<a class="href-link" href="#updateData">#</a>
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
<span class='tag'>async</span>
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
<span class="code-name">
|
|
1320
|
+
|
|
1321
|
+
updateData<span class="signature">(params, authorization)</span><span class="type-signature"> → {Promise.<object>|array.<object>|object|object}</span>
|
|
1322
|
+
|
|
1323
|
+
</span>
|
|
1324
|
+
</h4>
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
<div class="description">
|
|
1330
|
+
Update session document data (pages, triples, summary).
|
|
1331
|
+
Used by Scarface to push corrections or enrichments for a document.
|
|
1332
|
+
</div>
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
<h5>Parameters:</h5>
|
|
1344
|
+
|
|
1345
|
+
<div class="table-container">
|
|
1346
|
+
<table class="params table">
|
|
1347
|
+
<thead>
|
|
1348
|
+
<tr>
|
|
1349
|
+
|
|
1350
|
+
<th>Name</th>
|
|
1351
|
+
|
|
1352
|
+
|
|
1353
|
+
<th>Type</th>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
<th>Attributes</th>
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
<th class="last">Description</th>
|
|
1362
|
+
</tr>
|
|
1363
|
+
</thead>
|
|
1364
|
+
|
|
1365
|
+
<tbody>
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<tr class="deep-level-0">
|
|
1370
|
+
|
|
1371
|
+
<td class="name"><code>params</code></td>
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
<td class="type">
|
|
1375
|
+
|
|
1376
|
+
|
|
1377
|
+
<code class="param-type">object</code>
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
</td>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
<td class="attributes">
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
</td>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
|
|
1394
|
+
|
|
1395
|
+
<td class="description last">Parameters</td>
|
|
1396
|
+
</tr>
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
<tr class="deep-level-1">
|
|
1402
|
+
|
|
1403
|
+
<td class="name"><code>documentId</code></td>
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
<td class="type">
|
|
1407
|
+
|
|
1408
|
+
|
|
1409
|
+
<code class="param-type">string</code>
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
|
|
1413
|
+
</td>
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
<td class="attributes">
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
</td>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
<td class="description last">The document ID</td>
|
|
1428
|
+
</tr>
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<tr class="deep-level-1">
|
|
1433
|
+
|
|
1434
|
+
<td class="name"><code>pages</code></td>
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
<td class="type">
|
|
1438
|
+
|
|
1439
|
+
|
|
1440
|
+
<code class="param-type">array.<object></code>
|
|
1441
|
+
|
|
1442
|
+
|
|
1443
|
+
|
|
1444
|
+
</td>
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
<td class="attributes">
|
|
1448
|
+
|
|
1449
|
+
<optional><br>
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
</td>
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
<td class="description last">Page updates</td>
|
|
1461
|
+
</tr>
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
<tr class="deep-level-1">
|
|
1466
|
+
|
|
1467
|
+
<td class="name"><code>pages.pageNumber</code></td>
|
|
1468
|
+
|
|
1469
|
+
|
|
1470
|
+
<td class="type">
|
|
1471
|
+
|
|
1472
|
+
|
|
1473
|
+
<code class="param-type">number</code>
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
</td>
|
|
1478
|
+
|
|
1479
|
+
|
|
1480
|
+
<td class="attributes">
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
</td>
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
<td class="description last">1-based page number</td>
|
|
1492
|
+
</tr>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
<tr class="deep-level-1">
|
|
1497
|
+
|
|
1498
|
+
<td class="name"><code>pages.markdown</code></td>
|
|
1499
|
+
|
|
1500
|
+
|
|
1501
|
+
<td class="type">
|
|
1502
|
+
|
|
1503
|
+
|
|
1504
|
+
<code class="param-type">string</code>
|
|
1505
|
+
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
</td>
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<td class="attributes">
|
|
1512
|
+
|
|
1513
|
+
<optional><br>
|
|
1514
|
+
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
|
|
1519
|
+
</td>
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
|
|
1524
|
+
<td class="description last">Updated markdown text</td>
|
|
1525
|
+
</tr>
|
|
1526
|
+
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
<tr class="deep-level-1">
|
|
1530
|
+
|
|
1531
|
+
<td class="name"><code>pages.entities</code></td>
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
<td class="type">
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
<code class="param-type">array.<object></code>
|
|
1538
|
+
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
</td>
|
|
1542
|
+
|
|
1543
|
+
|
|
1544
|
+
<td class="attributes">
|
|
1545
|
+
|
|
1546
|
+
<optional><br>
|
|
1547
|
+
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
|
|
1551
|
+
|
|
1552
|
+
</td>
|
|
1553
|
+
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
<td class="description last">Updated entities</td>
|
|
1558
|
+
</tr>
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
<tr class="deep-level-1">
|
|
1563
|
+
|
|
1564
|
+
<td class="name"><code>triples</code></td>
|
|
1565
|
+
|
|
1566
|
+
|
|
1567
|
+
<td class="type">
|
|
1568
|
+
|
|
1569
|
+
|
|
1570
|
+
<code class="param-type">array.<object></code>
|
|
1571
|
+
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
</td>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
<td class="attributes">
|
|
1578
|
+
|
|
1579
|
+
<optional><br>
|
|
1580
|
+
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
|
|
1584
|
+
|
|
1585
|
+
</td>
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
<td class="description last">New triples to add</td>
|
|
1591
|
+
</tr>
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
<tr class="deep-level-1">
|
|
1596
|
+
|
|
1597
|
+
<td class="name"><code>triples.pageNumber</code></td>
|
|
1598
|
+
|
|
1599
|
+
|
|
1600
|
+
<td class="type">
|
|
1601
|
+
|
|
1602
|
+
|
|
1603
|
+
<code class="param-type">number</code>
|
|
1604
|
+
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
</td>
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
<td class="attributes">
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
</td>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
|
|
1620
|
+
|
|
1621
|
+
<td class="description last">Source page number</td>
|
|
1622
|
+
</tr>
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
<tr class="deep-level-1">
|
|
1627
|
+
|
|
1628
|
+
<td class="name"><code>triples.subject</code></td>
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
<td class="type">
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
<code class="param-type">string</code>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
|
|
1638
|
+
</td>
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
<td class="attributes">
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
</td>
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
<td class="description last">Subject entity text</td>
|
|
1653
|
+
</tr>
|
|
1654
|
+
|
|
1655
|
+
|
|
1656
|
+
|
|
1657
|
+
<tr class="deep-level-1">
|
|
1658
|
+
|
|
1659
|
+
<td class="name"><code>triples.predicate</code></td>
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
<td class="type">
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
<code class="param-type">string</code>
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
|
|
1669
|
+
</td>
|
|
1670
|
+
|
|
1671
|
+
|
|
1672
|
+
<td class="attributes">
|
|
1673
|
+
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
|
|
1677
|
+
|
|
1678
|
+
</td>
|
|
1679
|
+
|
|
1680
|
+
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
<td class="description last">Relationship predicate</td>
|
|
1684
|
+
</tr>
|
|
1685
|
+
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
<tr class="deep-level-1">
|
|
1689
|
+
|
|
1690
|
+
<td class="name"><code>triples.object</code></td>
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
<td class="type">
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
<code class="param-type">string</code>
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
|
|
1700
|
+
</td>
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
<td class="attributes">
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
</td>
|
|
1710
|
+
|
|
1711
|
+
|
|
1712
|
+
|
|
1713
|
+
|
|
1714
|
+
<td class="description last">Object entity text</td>
|
|
1715
|
+
</tr>
|
|
1716
|
+
|
|
1717
|
+
|
|
1718
|
+
|
|
1719
|
+
<tr class="deep-level-1">
|
|
1720
|
+
|
|
1721
|
+
<td class="name"><code>summary</code></td>
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
<td class="type">
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
<code class="param-type">object</code>
|
|
1728
|
+
|
|
1729
|
+
|
|
1730
|
+
|
|
1731
|
+
</td>
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
<td class="attributes">
|
|
1735
|
+
|
|
1736
|
+
<optional><br>
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
|
|
1742
|
+
</td>
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
|
|
1746
|
+
|
|
1747
|
+
<td class="description last">Summary field updates</td>
|
|
1748
|
+
</tr>
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
|
|
1752
|
+
<tr class="deep-level-1">
|
|
1753
|
+
|
|
1754
|
+
<td class="name"><code>summary.documentName</code></td>
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
<td class="type">
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
<code class="param-type">string</code>
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
|
|
1764
|
+
</td>
|
|
1765
|
+
|
|
1766
|
+
|
|
1767
|
+
<td class="attributes">
|
|
1768
|
+
|
|
1769
|
+
<optional><br>
|
|
1770
|
+
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
|
|
1774
|
+
|
|
1775
|
+
</td>
|
|
1776
|
+
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
|
|
1780
|
+
<td class="description last">Document name</td>
|
|
1781
|
+
</tr>
|
|
1782
|
+
|
|
1783
|
+
|
|
1784
|
+
|
|
1785
|
+
<tr class="deep-level-1">
|
|
1786
|
+
|
|
1787
|
+
<td class="name"><code>summary.entityCount</code></td>
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
<td class="type">
|
|
1791
|
+
|
|
1792
|
+
|
|
1793
|
+
<code class="param-type">number</code>
|
|
1794
|
+
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
</td>
|
|
1798
|
+
|
|
1799
|
+
|
|
1800
|
+
<td class="attributes">
|
|
1801
|
+
|
|
1802
|
+
<optional><br>
|
|
1803
|
+
|
|
1804
|
+
|
|
1805
|
+
|
|
1806
|
+
|
|
1807
|
+
|
|
1808
|
+
</td>
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
|
|
1813
|
+
<td class="description last">Total entity count</td>
|
|
1814
|
+
</tr>
|
|
1815
|
+
|
|
1816
|
+
|
|
1817
|
+
|
|
1818
|
+
<tr class="deep-level-1">
|
|
1819
|
+
|
|
1820
|
+
<td class="name"><code>summary.tripleCount</code></td>
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
<td class="type">
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
<code class="param-type">number</code>
|
|
1827
|
+
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
</td>
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
<td class="attributes">
|
|
1834
|
+
|
|
1835
|
+
<optional><br>
|
|
1836
|
+
|
|
1837
|
+
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
|
|
1841
|
+
</td>
|
|
1842
|
+
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
|
|
1846
|
+
<td class="description last">Total triple count</td>
|
|
1847
|
+
</tr>
|
|
1848
|
+
|
|
1849
|
+
|
|
1850
|
+
|
|
1851
|
+
|
|
1852
|
+
|
|
1853
|
+
|
|
1854
|
+
|
|
1855
|
+
<tr class="deep-level-0">
|
|
1856
|
+
|
|
1857
|
+
<td class="name"><code>authorization</code></td>
|
|
1858
|
+
|
|
1859
|
+
|
|
1860
|
+
<td class="type">
|
|
1861
|
+
|
|
1862
|
+
|
|
1863
|
+
<code class="param-type">string</code>
|
|
1864
|
+
|
|
1865
|
+
|
|
1866
|
+
|
|
1867
|
+
</td>
|
|
1868
|
+
|
|
1869
|
+
|
|
1870
|
+
<td class="attributes">
|
|
1871
|
+
|
|
1872
|
+
|
|
1873
|
+
|
|
1874
|
+
|
|
1875
|
+
|
|
1876
|
+
</td>
|
|
1877
|
+
|
|
1878
|
+
|
|
1879
|
+
|
|
1880
|
+
|
|
1881
|
+
<td class="description last">Authorization token</td>
|
|
1882
|
+
</tr>
|
|
1883
|
+
|
|
1884
|
+
|
|
1885
|
+
|
|
1886
|
+
</tbody>
|
|
1887
|
+
</table>
|
|
1888
|
+
</div>
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
|
|
1893
|
+
|
|
1894
|
+
<dl class="details">
|
|
1895
|
+
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
|
|
1900
|
+
|
|
1901
|
+
|
|
1902
|
+
|
|
1903
|
+
|
|
1904
|
+
|
|
1905
|
+
|
|
1906
|
+
|
|
1907
|
+
|
|
1908
|
+
|
|
1909
|
+
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
|
|
1913
|
+
<dt class="tag-author">Author:</dt>
|
|
1914
|
+
<dd class="tag-author">
|
|
1915
|
+
<ul>
|
|
1916
|
+
<li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
|
|
1917
|
+
</ul>
|
|
1918
|
+
</dd>
|
|
1919
|
+
|
|
1920
|
+
|
|
1921
|
+
|
|
1922
|
+
|
|
1923
|
+
|
|
1924
|
+
|
|
1925
|
+
|
|
1926
|
+
|
|
1927
|
+
|
|
1928
|
+
|
|
1929
|
+
|
|
1930
|
+
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
<p class="tag-source">
|
|
1934
|
+
<a href="ai_sessions.js.html" class="button">View Source</a>
|
|
1935
|
+
<span>
|
|
1936
|
+
<a href="ai_sessions.js.html">ai/sessions.js</a>, <a href="ai_sessions.js.html#line134">line 134</a>
|
|
1937
|
+
</span>
|
|
1938
|
+
</p>
|
|
1939
|
+
|
|
1940
|
+
</dl>
|
|
1941
|
+
|
|
1942
|
+
|
|
1943
|
+
|
|
1944
|
+
|
|
1945
|
+
|
|
1946
|
+
|
|
1947
|
+
|
|
1948
|
+
|
|
1949
|
+
|
|
1950
|
+
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
|
|
1954
|
+
|
|
1955
|
+
|
|
1956
|
+
|
|
1957
|
+
|
|
1958
|
+
|
|
1959
|
+
<div class='columns method-parameter'>
|
|
1960
|
+
<div class="column is-2"><label>Returns:</label></div>
|
|
1961
|
+
<div class="column is-10">
|
|
1962
|
+
|
|
1963
|
+
|
|
1964
|
+
|
|
1965
|
+
<div class="columns">
|
|
1966
|
+
|
|
1967
|
+
<div class='param-desc column is-7'>data The update results</div>
|
|
1968
|
+
|
|
1969
|
+
|
|
1970
|
+
<div class='column is-5 has-text-left'>
|
|
1971
|
+
<label>Type: </label>
|
|
1972
|
+
|
|
1973
|
+
<code class="param-type">Promise.<object></code>
|
|
1974
|
+
|
|
1975
|
+
|
|
1976
|
+
</div>
|
|
1977
|
+
|
|
1978
|
+
</div>
|
|
1979
|
+
|
|
1980
|
+
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
<div class="columns">
|
|
1984
|
+
|
|
1985
|
+
<div class='param-desc column is-7'>data.pages Page update results [{pageNumber, updated}]</div>
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
<div class='column is-5 has-text-left'>
|
|
1989
|
+
<label>Type: </label>
|
|
1990
|
+
|
|
1991
|
+
<code class="param-type">array.<object></code>
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
</div>
|
|
1995
|
+
|
|
1996
|
+
</div>
|
|
1997
|
+
|
|
1998
|
+
|
|
1999
|
+
|
|
2000
|
+
|
|
2001
|
+
<div class="columns">
|
|
2002
|
+
|
|
2003
|
+
<div class='param-desc column is-7'>data.triples Triple insert results {added: number}</div>
|
|
2004
|
+
|
|
2005
|
+
|
|
2006
|
+
<div class='column is-5 has-text-left'>
|
|
2007
|
+
<label>Type: </label>
|
|
2008
|
+
|
|
2009
|
+
<code class="param-type">object</code>
|
|
2010
|
+
|
|
2011
|
+
|
|
2012
|
+
</div>
|
|
2013
|
+
|
|
2014
|
+
</div>
|
|
2015
|
+
|
|
2016
|
+
|
|
2017
|
+
|
|
2018
|
+
|
|
2019
|
+
<div class="columns">
|
|
2020
|
+
|
|
2021
|
+
<div class='param-desc column is-7'>data.summary Applied summary updates</div>
|
|
2022
|
+
|
|
2023
|
+
|
|
2024
|
+
<div class='column is-5 has-text-left'>
|
|
2025
|
+
<label>Type: </label>
|
|
2026
|
+
|
|
2027
|
+
<code class="param-type">object</code>
|
|
2028
|
+
|
|
2029
|
+
|
|
2030
|
+
</div>
|
|
2031
|
+
|
|
2032
|
+
</div>
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
</div>
|
|
2036
|
+
</div>
|
|
2037
|
+
|
|
2038
|
+
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
<h5>Example</h5>
|
|
2042
|
+
|
|
2043
|
+
|
|
2044
|
+
<pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
|
|
2045
|
+
const api = new API();
|
|
2046
|
+
const authorization = '...';
|
|
2047
|
+
const params = {
|
|
2048
|
+
documentId: 'doc-123',
|
|
2049
|
+
pages: [
|
|
2050
|
+
{ pageNumber: 1, markdown: '# Updated page content' }
|
|
2051
|
+
],
|
|
2052
|
+
summary: {
|
|
2053
|
+
documentName: 'Patient Report.pdf',
|
|
2054
|
+
entityCount: 42,
|
|
2055
|
+
tripleCount: 15
|
|
2056
|
+
}
|
|
2057
|
+
};
|
|
2058
|
+
const retData = await api.ai.sessions.updateData(params, authorization);</code></pre>
|
|
2059
|
+
|
|
2060
|
+
|
|
2061
|
+
|
|
2062
|
+
</div>
|
|
2063
|
+
|
|
2064
|
+
</div>
|
|
2065
|
+
</div>
|
|
2066
|
+
|
|
2067
|
+
|
|
2068
|
+
|
|
2069
|
+
|
|
2070
|
+
|
|
2071
|
+
</article>
|
|
2072
|
+
|
|
2073
|
+
</section>
|
|
2074
|
+
|
|
2075
|
+
|
|
2076
|
+
|
|
2077
|
+
|
|
2078
|
+
</div>
|
|
2079
|
+
|
|
2080
|
+
<footer class="footer">
|
|
2081
|
+
<div class="content has-text-centered">
|
|
2082
|
+
<p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
|
|
2083
|
+
<p class="sidebar-created-by">
|
|
2084
|
+
<a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
|
|
2085
|
+
<a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
|
|
2086
|
+
</p>
|
|
2087
|
+
</div>
|
|
2088
|
+
</footer>
|
|
2089
|
+
|
|
2090
|
+
</div>
|
|
2091
|
+
<div id="side-nav" class="side-nav">
|
|
2092
|
+
</div>
|
|
2093
|
+
</div>
|
|
2094
|
+
<script src="scripts/app.min.js"></script>
|
|
2095
|
+
<script>PR.prettyPrint();</script>
|
|
2096
|
+
<script src="scripts/linenumber.js"> </script>
|
|
2097
|
+
|
|
2098
|
+
|
|
2099
|
+
</body>
|
|
2100
|
+
</html>
|