memori-client 0.1.6 → 0.1.9

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.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/doc/MemoriClient::Backend::V1::Asset.md +117 -0
  3. data/doc/MemoriClient::Backend::V2::ActionLog.md +37 -0
  4. data/doc/MemoriClient::Backend::V2::Analysis.md +39 -0
  5. data/doc/MemoriClient::Backend::V2::Asset.md +102 -0
  6. data/doc/MemoriClient::Backend::V2::Badge.md +64 -0
  7. data/doc/MemoriClient::Backend::V2::CompletionConfig.md +115 -0
  8. data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +57 -0
  9. data/doc/MemoriClient::Backend::V2::ImportExport.md +180 -0
  10. data/doc/MemoriClient::Backend::V2::Integration.md +117 -0
  11. data/doc/MemoriClient::Backend::V2::Invitation.md +179 -0
  12. data/doc/MemoriClient::Backend::V2::Memori.md +394 -0
  13. data/doc/MemoriClient::Backend::V2::MemoriList.md +147 -0
  14. data/doc/MemoriClient::Backend::V2::Notification.md +31 -0
  15. data/doc/MemoriClient::Backend::V2::Process.md +64 -0
  16. data/doc/MemoriClient::Backend::V2::Tenant.md +142 -0
  17. data/doc/MemoriClient::Backend::V2::User.md +647 -0
  18. data/doc/MemoriClient::Engine::V2::ChatLog.md +82 -0
  19. data/doc/MemoriClient::Engine::V2::ContextVar.md +46 -0
  20. data/doc/MemoriClient::Engine::V2::CorrelationPair.md +72 -0
  21. data/doc/MemoriClient::Engine::V2::CustomDictionary.md +108 -0
  22. data/doc/MemoriClient::Engine::V2::Dialog.md +152 -0
  23. data/doc/MemoriClient::Engine::V2::EventLog.md +85 -0
  24. data/doc/MemoriClient::Engine::V2::ExpertReference.md +116 -0
  25. data/doc/MemoriClient::Engine::V2::Function.md +140 -0
  26. data/doc/MemoriClient::Engine::V2::Intent.md +225 -0
  27. data/doc/MemoriClient::Engine::V2::LocalizationKey.md +105 -0
  28. data/doc/MemoriClient::Engine::V2::Medium.md +118 -0
  29. data/doc/MemoriClient::Engine::V2::Memory.md +244 -0
  30. data/doc/MemoriClient::Engine::V2::NLP.md +100 -0
  31. data/doc/MemoriClient::Engine::V2::Person.md +114 -0
  32. data/doc/MemoriClient::Engine::V2::Search.md +151 -0
  33. data/doc/MemoriClient::Engine::V2::Session.md +55 -0
  34. data/doc/MemoriClient::Engine::V2::Stat.md +18 -0
  35. data/doc/MemoriClient::Engine::V2::Topic.md +80 -0
  36. data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +75 -0
  37. data/doc/MemoriClient::Engine::V2::User.md +140 -0
  38. data/doc/MemoriClient::Engine::V2::WebHook.md +67 -0
  39. data/lib/memori_client/railtie.rb +12 -0
  40. data/lib/memori_client/utils/rails.rb +54 -0
  41. data/lib/memori_client.rb +7 -0
  42. data/lib/tasks/memori_client.rake +15 -0
  43. metadata +42 -2
data/doc/MemoriClient::Backend::V2::Memori.md ADDED
@@ -0,0 +1,394 @@
1
+ # Module `MemoriClient::Backend::V2::Memori`
2
+
3
+ ## get_tenant_memori_by_name
4
+
5
+ Summary:
6
+ Gets the details of a Memori object by tenant, user and Memori names.
7
+
8
+ Signature: `get_tenant_memori_by_name(tenantName:, userName:, memoriName:, strToken: nil)`
9
+ Invocation: `MemoriClient::Backend::V2::Memori.get_tenant_memori_by_name(tenantName:, userName:, memoriName:, strToken: nil)`
10
+
11
+ HTTP API: GET /api/v2/Memori/{tenantName}/{userName}/{memoriName}/{strToken}`
12
+
13
+ Parameters:
14
+
15
+ - `tenantName`: **string** The name of the Tenant. required
16
+ - `userName`: **string** The name of the User. required
17
+ - `memoriName`: **string** The name of the Memori. required
18
+ - `strToken`: **string** Optional login token. optional
19
+
20
+ ## get_tenant_memori_by_id
21
+
22
+ Summary:
23
+ Gets the details of a Memori object by tenant name and user and Memori IDs.
24
+
25
+ Signature: `get_tenant_memori_by_id(tenantName:, strUserID:, strMemoriID:, strToken: nil)`
26
+ Invocation: `MemoriClient::Backend::V2::Memori.get_tenant_memori_by_id(tenantName:, strUserID:, strMemoriID:, strToken: nil)`
27
+
28
+ HTTP API: GET /api/v2/MemoriByID/{tenantName}/{strUserID}/{strMemoriID}/{strToken}`
29
+
30
+ Parameters:
31
+
32
+ - `tenantName`: **string** The name of the Tenant. required
33
+ - `strUserID`: **string** The ID of the User object. required
34
+ - `strMemoriID`: **string** The ID of the Memori object. required
35
+ - `strToken`: **string** Optional login token. optional
36
+
37
+ ## get_memori
38
+
39
+ Summary:
40
+ Gets the details of a Memori object of the currently logged in User.
41
+
42
+ Signature: `get_memori(strToken:, strMemoriID:)`
43
+ Invocation: `MemoriClient::Backend::V2::Memori.get_memori(strToken:, strMemoriID:)`
44
+
45
+ HTTP API: GET /api/v2/Memori/{strToken}/{strMemoriID}`
46
+
47
+ Parameters:
48
+
49
+ - `strToken`: **string** The login token. required
50
+ - `strMemoriID`: **string** The ID of the Memori object. required
51
+
52
+ ## update_memori
53
+
54
+ Summary:
55
+ Updates an existing Memori object.
56
+
57
+ Signature: `update_memori(strToken:, strMemoriID:, payload: {})`
58
+ Invocation: `MemoriClient::Backend::V2::Memori.update_memori(strToken:, strMemoriID:, payload: {})`
59
+
60
+ HTTP API: PATCH /api/v2/Memori/{strToken}/{strMemoriID}`
61
+
62
+ Parameters:
63
+
64
+ - `strToken`: **string** The login token. required
65
+ - `strMemoriID`: **string** The ID of the Memori object. required
66
+ - `payload`: **Hash** request payload. optional
67
+ - `payload.memoriID`: **String** . optional
68
+ - `payload.name`: **String** . optional
69
+ - `payload.password`: **String** . optional
70
+ - `payload.recoveryTokens`: **Array** . optional
71
+ - `payload.newPassword`: **String** . optional
72
+ - `payload.ownerUserID`: **String** . optional
73
+ - `payload.ownerUserName`: **String** . optional
74
+ - `payload.ownerTenantName`: **String** . optional
75
+ - `payload.memoriConfigurationID`: **String** . optional
76
+ - `payload.description`: **String** . optional
77
+ - `payload.completionDescription`: **String** . optional
78
+ - `payload.engineMemoriID`: **String** . optional
79
+ - `payload.isOwner`: **Boolean** . optional
80
+ - `payload.isGiver`: **Boolean** . optional
81
+ - `payload.isReceiver`: **Boolean** . optional
82
+ - `payload.giverTag`: **String** . optional
83
+ - `payload.giverPIN`: **String** . optional
84
+ - `payload.privacyType`: **String** . optional
85
+ - `payload.secretToken`: **String** . optional
86
+ - `payload.minimumNumberOfRecoveryTokens`: **Integer** . optional
87
+ - `payload.totalNumberOfRecoveryTokens`: **Integer** . optional
88
+ - `payload.sentInvitations`: **Array** . optional
89
+ - `payload.receivedInvitations`: **Array** . optional
90
+ - `payload.integrations`: **Array** . optional
91
+ - `payload.avatarURL`: **String** . optional
92
+ - `payload.coverURL`: **String** . optional
93
+ - `payload.avatar3DURL`: **String** . optional
94
+ - `payload.avatarOriginal3DURL`: **String** . optional
95
+ - `payload.needsPosition`: **Boolean** . optional
96
+ - `payload.needsDateTime`: **Boolean** . optional
97
+ - `payload.voiceType`: **String** . optional
98
+ - `payload.culture`: **String** . optional
99
+ - `payload.categories`: **Array** . optional
100
+ - `payload.nsfw`: **Boolean** . optional
101
+ - `payload.ageRestriction`: **Integer** . optional
102
+ - `payload.exposed`: **Boolean** . optional
103
+ - `payload.confidenceOffset`: **Number** . optional
104
+ - `payload.disableR2R3Loop`: **Boolean** . optional
105
+ - `payload.disableR4Loop`: **Boolean** . optional
106
+ - `payload.disableR5Loop`: **Boolean** . optional
107
+ - `payload.enableCompletions`: **Boolean** . optional
108
+ - `payload.enableDeepThought`: **Boolean** . optional
109
+ - `payload.alwaysAnswerWithCompletion`: **Boolean** . optional
110
+ - `payload.disableCompletionMediaExtraction`: **Boolean** . optional
111
+ - `payload.completionConfigNameForQuestionAnswering`: **String** . optional
112
+ - `payload.completionConfigForQuestionAnswering`: **** . optional
113
+ - `payload.completionConfigNameForImportExport`: **String** . optional
114
+ - `payload.completionConfigForImportExport`: **** . optional
115
+ - `payload.completionConfigNameForDeepThought`: **String** . optional
116
+ - `payload.completionConfigForDeepThought`: **** . optional
117
+ - `payload.completionTemperature`: **Number** . optional
118
+ - `payload.completionMaxTokens`: **Integer** . optional
119
+ - `payload.chainingMemoriID`: **String** . optional
120
+ - `payload.chainingBaseURL`: **String** . optional
121
+ - `payload.chainingPassword`: **String** . optional
122
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
123
+ - `payload.enableMacroFunctions`: **Array** . optional
124
+ - `payload.macroParameters`: **Object** . optional
125
+ - `payload.dcmUser`: **String** . optional
126
+ - `payload.dcmSecret`: **String** . optional
127
+ - `payload.dcmAppContext`: **String** . optional
128
+ - `payload.publishedInTheMetaverse`: **Boolean** . optional
129
+ - `payload.metaverseEnvironment`: **String** . optional
130
+ - `payload.blockedUntil`: **String** . optional
131
+ - `payload.creationTimestamp`: **String** . optional
132
+ - `payload.lastChangeTimestamp`: **String** . optional
133
+
134
+ ## get_memori_sessions
135
+
136
+ Summary:
137
+ Gets the statistics for sessions opened in a specified interval for the specified Memori object.
138
+
139
+ Signature: `get_memori_sessions(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
140
+ Invocation: `MemoriClient::Backend::V2::Memori.get_memori_sessions(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
141
+
142
+ HTTP API: GET /api/v2/MemoriSessions/{strToken}/{strMemoriID}/{strDateFrom}/{strDateTo}`
143
+
144
+ Parameters:
145
+
146
+ - `strToken`: **string** The login token. required
147
+ - `strMemoriID`: **string** The ID of the Memori object. required
148
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
149
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
150
+
151
+ ## register_memori
152
+
153
+ Summary:
154
+ Registers a new Memori object.
155
+
156
+ Signature: `register_memori(strToken:, payload: {})`
157
+ Invocation: `MemoriClient::Backend::V2::Memori.register_memori(strToken:, payload: {})`
158
+
159
+ HTTP API: POST /api/v2/Memori/{strToken}`
160
+
161
+ Parameters:
162
+
163
+ - `strToken`: **string** The login token. required
164
+ - `payload`: **Hash** request payload. optional
165
+ - `payload.memoriID`: **String** . optional
166
+ - `payload.name`: **String** . optional
167
+ - `payload.password`: **String** . optional
168
+ - `payload.recoveryTokens`: **Array** . optional
169
+ - `payload.newPassword`: **String** . optional
170
+ - `payload.ownerUserID`: **String** . optional
171
+ - `payload.ownerUserName`: **String** . optional
172
+ - `payload.ownerTenantName`: **String** . optional
173
+ - `payload.memoriConfigurationID`: **String** . optional
174
+ - `payload.description`: **String** . optional
175
+ - `payload.completionDescription`: **String** . optional
176
+ - `payload.engineMemoriID`: **String** . optional
177
+ - `payload.isOwner`: **Boolean** . optional
178
+ - `payload.isGiver`: **Boolean** . optional
179
+ - `payload.isReceiver`: **Boolean** . optional
180
+ - `payload.giverTag`: **String** . optional
181
+ - `payload.giverPIN`: **String** . optional
182
+ - `payload.privacyType`: **String** . optional
183
+ - `payload.secretToken`: **String** . optional
184
+ - `payload.minimumNumberOfRecoveryTokens`: **Integer** . optional
185
+ - `payload.totalNumberOfRecoveryTokens`: **Integer** . optional
186
+ - `payload.sentInvitations`: **Array** . optional
187
+ - `payload.receivedInvitations`: **Array** . optional
188
+ - `payload.integrations`: **Array** . optional
189
+ - `payload.avatarURL`: **String** . optional
190
+ - `payload.coverURL`: **String** . optional
191
+ - `payload.avatar3DURL`: **String** . optional
192
+ - `payload.avatarOriginal3DURL`: **String** . optional
193
+ - `payload.needsPosition`: **Boolean** . optional
194
+ - `payload.needsDateTime`: **Boolean** . optional
195
+ - `payload.voiceType`: **String** . optional
196
+ - `payload.culture`: **String** . optional
197
+ - `payload.categories`: **Array** . optional
198
+ - `payload.nsfw`: **Boolean** . optional
199
+ - `payload.ageRestriction`: **Integer** . optional
200
+ - `payload.exposed`: **Boolean** . optional
201
+ - `payload.confidenceOffset`: **Number** . optional
202
+ - `payload.disableR2R3Loop`: **Boolean** . optional
203
+ - `payload.disableR4Loop`: **Boolean** . optional
204
+ - `payload.disableR5Loop`: **Boolean** . optional
205
+ - `payload.enableCompletions`: **Boolean** . optional
206
+ - `payload.enableDeepThought`: **Boolean** . optional
207
+ - `payload.alwaysAnswerWithCompletion`: **Boolean** . optional
208
+ - `payload.disableCompletionMediaExtraction`: **Boolean** . optional
209
+ - `payload.completionConfigNameForQuestionAnswering`: **String** . optional
210
+ - `payload.completionConfigForQuestionAnswering`: **** . optional
211
+ - `payload.completionConfigNameForImportExport`: **String** . optional
212
+ - `payload.completionConfigForImportExport`: **** . optional
213
+ - `payload.completionConfigNameForDeepThought`: **String** . optional
214
+ - `payload.completionConfigForDeepThought`: **** . optional
215
+ - `payload.completionTemperature`: **Number** . optional
216
+ - `payload.completionMaxTokens`: **Integer** . optional
217
+ - `payload.chainingMemoriID`: **String** . optional
218
+ - `payload.chainingBaseURL`: **String** . optional
219
+ - `payload.chainingPassword`: **String** . optional
220
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
221
+ - `payload.enableMacroFunctions`: **Array** . optional
222
+ - `payload.macroParameters`: **Object** . optional
223
+ - `payload.dcmUser`: **String** . optional
224
+ - `payload.dcmSecret`: **String** . optional
225
+ - `payload.dcmAppContext`: **String** . optional
226
+ - `payload.publishedInTheMetaverse`: **Boolean** . optional
227
+ - `payload.metaverseEnvironment`: **String** . optional
228
+ - `payload.blockedUntil`: **String** . optional
229
+ - `payload.creationTimestamp`: **String** . optional
230
+ - `payload.lastChangeTimestamp`: **String** . optional
231
+
232
+ ## delete_memori
233
+
234
+ Summary:
235
+ Deletes an existing Memori object.
236
+
237
+ Signature: `delete_memori(strToken:, payload: {})`
238
+ Invocation: `MemoriClient::Backend::V2::Memori.delete_memori(strToken:, payload: {})`
239
+
240
+ HTTP API: DELETE /api/v2/Memori/{strToken}`
241
+
242
+ Parameters:
243
+
244
+ - `strToken`: **string** The login token. required
245
+ - `payload`: **Hash** request payload. optional
246
+ - `payload.memoriID`: **String** . optional
247
+ - `payload.name`: **String** . optional
248
+ - `payload.password`: **String** . optional
249
+ - `payload.recoveryTokens`: **Array** . optional
250
+ - `payload.newPassword`: **String** . optional
251
+ - `payload.ownerUserID`: **String** . optional
252
+ - `payload.ownerUserName`: **String** . optional
253
+ - `payload.ownerTenantName`: **String** . optional
254
+ - `payload.memoriConfigurationID`: **String** . optional
255
+ - `payload.description`: **String** . optional
256
+ - `payload.completionDescription`: **String** . optional
257
+ - `payload.engineMemoriID`: **String** . optional
258
+ - `payload.isOwner`: **Boolean** . optional
259
+ - `payload.isGiver`: **Boolean** . optional
260
+ - `payload.isReceiver`: **Boolean** . optional
261
+ - `payload.giverTag`: **String** . optional
262
+ - `payload.giverPIN`: **String** . optional
263
+ - `payload.privacyType`: **String** . optional
264
+ - `payload.secretToken`: **String** . optional
265
+ - `payload.minimumNumberOfRecoveryTokens`: **Integer** . optional
266
+ - `payload.totalNumberOfRecoveryTokens`: **Integer** . optional
267
+ - `payload.sentInvitations`: **Array** . optional
268
+ - `payload.receivedInvitations`: **Array** . optional
269
+ - `payload.integrations`: **Array** . optional
270
+ - `payload.avatarURL`: **String** . optional
271
+ - `payload.coverURL`: **String** . optional
272
+ - `payload.avatar3DURL`: **String** . optional
273
+ - `payload.avatarOriginal3DURL`: **String** . optional
274
+ - `payload.needsPosition`: **Boolean** . optional
275
+ - `payload.needsDateTime`: **Boolean** . optional
276
+ - `payload.voiceType`: **String** . optional
277
+ - `payload.culture`: **String** . optional
278
+ - `payload.categories`: **Array** . optional
279
+ - `payload.nsfw`: **Boolean** . optional
280
+ - `payload.ageRestriction`: **Integer** . optional
281
+ - `payload.exposed`: **Boolean** . optional
282
+ - `payload.confidenceOffset`: **Number** . optional
283
+ - `payload.disableR2R3Loop`: **Boolean** . optional
284
+ - `payload.disableR4Loop`: **Boolean** . optional
285
+ - `payload.disableR5Loop`: **Boolean** . optional
286
+ - `payload.enableCompletions`: **Boolean** . optional
287
+ - `payload.enableDeepThought`: **Boolean** . optional
288
+ - `payload.alwaysAnswerWithCompletion`: **Boolean** . optional
289
+ - `payload.disableCompletionMediaExtraction`: **Boolean** . optional
290
+ - `payload.completionConfigNameForQuestionAnswering`: **String** . optional
291
+ - `payload.completionConfigForQuestionAnswering`: **** . optional
292
+ - `payload.completionConfigNameForImportExport`: **String** . optional
293
+ - `payload.completionConfigForImportExport`: **** . optional
294
+ - `payload.completionConfigNameForDeepThought`: **String** . optional
295
+ - `payload.completionConfigForDeepThought`: **** . optional
296
+ - `payload.completionTemperature`: **Number** . optional
297
+ - `payload.completionMaxTokens`: **Integer** . optional
298
+ - `payload.chainingMemoriID`: **String** . optional
299
+ - `payload.chainingBaseURL`: **String** . optional
300
+ - `payload.chainingPassword`: **String** . optional
301
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
302
+ - `payload.enableMacroFunctions`: **Array** . optional
303
+ - `payload.macroParameters`: **Object** . optional
304
+ - `payload.dcmUser`: **String** . optional
305
+ - `payload.dcmSecret`: **String** . optional
306
+ - `payload.dcmAppContext`: **String** . optional
307
+ - `payload.publishedInTheMetaverse`: **Boolean** . optional
308
+ - `payload.metaverseEnvironment`: **String** . optional
309
+ - `payload.blockedUntil`: **String** . optional
310
+ - `payload.creationTimestamp`: **String** . optional
311
+ - `payload.lastChangeTimestamp`: **String** . optional
312
+
313
+ ## transfer_memori
314
+
315
+ Summary:
316
+ Transfers an existing Memori object to another User. The new owner must be specified by either a OwnerUserID or a OwnerUserName-OwnerTenantName pair. The OwnerUserName may also specify a user e-mail.
317
+
318
+ Signature: `transfer_memori(strToken:, payload: {})`
319
+ Invocation: `MemoriClient::Backend::V2::Memori.transfer_memori(strToken:, payload: {})`
320
+
321
+ HTTP API: POST /api/v2/TransferMemori/{strToken}`
322
+
323
+ Parameters:
324
+
325
+ - `strToken`: **string** The login token. required
326
+ - `payload`: **Hash** request payload. optional
327
+ - `payload.memoriID`: **String** . optional
328
+ - `payload.name`: **String** . optional
329
+ - `payload.password`: **String** . optional
330
+ - `payload.recoveryTokens`: **Array** . optional
331
+ - `payload.newPassword`: **String** . optional
332
+ - `payload.ownerUserID`: **String** . optional
333
+ - `payload.ownerUserName`: **String** . optional
334
+ - `payload.ownerTenantName`: **String** . optional
335
+ - `payload.memoriConfigurationID`: **String** . optional
336
+ - `payload.description`: **String** . optional
337
+ - `payload.completionDescription`: **String** . optional
338
+ - `payload.engineMemoriID`: **String** . optional
339
+ - `payload.isOwner`: **Boolean** . optional
340
+ - `payload.isGiver`: **Boolean** . optional
341
+ - `payload.isReceiver`: **Boolean** . optional
342
+ - `payload.giverTag`: **String** . optional
343
+ - `payload.giverPIN`: **String** . optional
344
+ - `payload.privacyType`: **String** . optional
345
+ - `payload.secretToken`: **String** . optional
346
+ - `payload.minimumNumberOfRecoveryTokens`: **Integer** . optional
347
+ - `payload.totalNumberOfRecoveryTokens`: **Integer** . optional
348
+ - `payload.sentInvitations`: **Array** . optional
349
+ - `payload.receivedInvitations`: **Array** . optional
350
+ - `payload.integrations`: **Array** . optional
351
+ - `payload.avatarURL`: **String** . optional
352
+ - `payload.coverURL`: **String** . optional
353
+ - `payload.avatar3DURL`: **String** . optional
354
+ - `payload.avatarOriginal3DURL`: **String** . optional
355
+ - `payload.needsPosition`: **Boolean** . optional
356
+ - `payload.needsDateTime`: **Boolean** . optional
357
+ - `payload.voiceType`: **String** . optional
358
+ - `payload.culture`: **String** . optional
359
+ - `payload.categories`: **Array** . optional
360
+ - `payload.nsfw`: **Boolean** . optional
361
+ - `payload.ageRestriction`: **Integer** . optional
362
+ - `payload.exposed`: **Boolean** . optional
363
+ - `payload.confidenceOffset`: **Number** . optional
364
+ - `payload.disableR2R3Loop`: **Boolean** . optional
365
+ - `payload.disableR4Loop`: **Boolean** . optional
366
+ - `payload.disableR5Loop`: **Boolean** . optional
367
+ - `payload.enableCompletions`: **Boolean** . optional
368
+ - `payload.enableDeepThought`: **Boolean** . optional
369
+ - `payload.alwaysAnswerWithCompletion`: **Boolean** . optional
370
+ - `payload.disableCompletionMediaExtraction`: **Boolean** . optional
371
+ - `payload.completionConfigNameForQuestionAnswering`: **String** . optional
372
+ - `payload.completionConfigForQuestionAnswering`: **** . optional
373
+ - `payload.completionConfigNameForImportExport`: **String** . optional
374
+ - `payload.completionConfigForImportExport`: **** . optional
375
+ - `payload.completionConfigNameForDeepThought`: **String** . optional
376
+ - `payload.completionConfigForDeepThought`: **** . optional
377
+ - `payload.completionTemperature`: **Number** . optional
378
+ - `payload.completionMaxTokens`: **Integer** . optional
379
+ - `payload.chainingMemoriID`: **String** . optional
380
+ - `payload.chainingBaseURL`: **String** . optional
381
+ - `payload.chainingPassword`: **String** . optional
382
+ - `payload.enableBoardOfExperts`: **Boolean** . optional
383
+ - `payload.enableMacroFunctions`: **Array** . optional
384
+ - `payload.macroParameters`: **Object** . optional
385
+ - `payload.dcmUser`: **String** . optional
386
+ - `payload.dcmSecret`: **String** . optional
387
+ - `payload.dcmAppContext`: **String** . optional
388
+ - `payload.publishedInTheMetaverse`: **Boolean** . optional
389
+ - `payload.metaverseEnvironment`: **String** . optional
390
+ - `payload.blockedUntil`: **String** . optional
391
+ - `payload.creationTimestamp`: **String** . optional
392
+ - `payload.lastChangeTimestamp`: **String** . optional
393
+
394
+
data/doc/MemoriClient::Backend::V2::MemoriList.md ADDED
@@ -0,0 +1,147 @@
1
+ # Module `MemoriClient::Backend::V2::MemoriList`
2
+
3
+ ## list_memori
4
+
5
+ Summary:
6
+ Gets a list of Memori objects owned by the currently logged in User.
7
+
8
+ Signature: `list_memori(strToken:)`
9
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_memori(strToken:)`
10
+
11
+ HTTP API: GET /api/v2/Memori/{strToken}`
12
+
13
+ Parameters:
14
+
15
+ - `strToken`: **string** The login token. required
16
+
17
+ ## list_memori_configs
18
+
19
+ Summary:
20
+ Gets a list of all the Memori Configuration objects.
21
+
22
+ Signature: `list_memori_configs(strToken:)`
23
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_memori_configs(strToken:)`
24
+
25
+ HTTP API: GET /api/v2/MemoriConfigs/{strToken}`
26
+
27
+ Parameters:
28
+
29
+ - `strToken`: **string** The login token. required
30
+
31
+ ## list_tenant_memori_categories
32
+
33
+ Summary:
34
+ Gets a list of all the known Memori categories (or tags).
35
+
36
+ Signature: `list_tenant_memori_categories(tenantName:)`
37
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_tenant_memori_categories(tenantName:)`
38
+
39
+ HTTP API: GET /api/v2/TenantMemoriCategories/{tenantName}`
40
+
41
+ Parameters:
42
+
43
+ - `tenantName`: **string** The name of Tenant. required
44
+
45
+ ## list_tenant_public_memori
46
+
47
+ Summary:
48
+ Gets a list of all the public Memori objects for a specific Tenant.
49
+
50
+ Signature: `list_tenant_public_memori(tenantName:)`
51
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_tenant_public_memori(tenantName:)`
52
+
53
+ HTTP API: GET /api/v2/TenantPublicMemori/{tenantName}`
54
+
55
+ Parameters:
56
+
57
+ - `tenantName`: **string** The name of Tenant. required
58
+
59
+ ## list_tenant_metaverse_memori
60
+
61
+ Summary:
62
+ Gets a list of all the Memori objects published on the Metaverse for a specific Tenant.
63
+
64
+ Signature: `list_tenant_metaverse_memori(tenantName:)`
65
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_tenant_metaverse_memori(tenantName:)`
66
+
67
+ HTTP API: GET /api/v2/TenantMetaverseMemori/{tenantName}`
68
+
69
+ Parameters:
70
+
71
+ - `tenantName`: **string** The name of Tenant. required
72
+
73
+ ## list_public_memori
74
+
75
+ Summary:
76
+ Gets a list of the public Memori objects for the currently logged in User.
77
+
78
+ Signature: `list_public_memori(strToken:)`
79
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_public_memori(strToken:)`
80
+
81
+ HTTP API: GET /api/v2/PublicMemori/{strToken}`
82
+
83
+ Parameters:
84
+
85
+ - `strToken`: **string** The login token. required
86
+
87
+ ## list_shared_memori
88
+
89
+ Summary:
90
+ Gets a list of Memori objects shared with the currently logged in User.
91
+
92
+ Signature: `list_shared_memori(strToken:)`
93
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_shared_memori(strToken:)`
94
+
95
+ HTTP API: GET /api/v2/SharedMemori/{strToken}`
96
+
97
+ Parameters:
98
+
99
+ - `strToken`: **string** The login token. required
100
+
101
+ ## list_user_memori_by_name
102
+
103
+ Summary:
104
+ Gets a list of Memori objects owned by the specified user.
105
+
106
+ Signature: `list_user_memori_by_name(tenantName:, userName:, strToken: nil)`
107
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_user_memori_by_name(tenantName:, userName:, strToken: nil)`
108
+
109
+ HTTP API: GET /api/v2/UserMemori/{tenantName}/{userName}/{strToken}`
110
+
111
+ Parameters:
112
+
113
+ - `tenantName`: **string** The name of Tenant. required
114
+ - `userName`: **string** The name of the User. required
115
+ - `strToken`: **string** The optional login token. optional
116
+
117
+ ## list_user_memori_by_id
118
+
119
+ Summary:
120
+ Gets a list of Memori objects owned by the specified user.
121
+
122
+ Signature: `list_user_memori_by_id(tenantName:, strUserID:, strToken: nil)`
123
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_user_memori_by_id(tenantName:, strUserID:, strToken: nil)`
124
+
125
+ HTTP API: GET /api/v2/UserMemoriByID/{tenantName}/{strUserID}/{strToken}`
126
+
127
+ Parameters:
128
+
129
+ - `tenantName`: **string** The name of Tenant. required
130
+ - `strUserID`: **string** The ID of the User object. required
131
+ - `strToken`: **string** The optional login token. optional
132
+
133
+ ## list_all_memori
134
+
135
+ Summary:
136
+ Gets a list of all Memori objects.
137
+
138
+ Signature: `list_all_memori(strToken:)`
139
+ Invocation: `MemoriClient::Backend::V2::MemoriList.list_all_memori(strToken:)`
140
+
141
+ HTTP API: GET /api/v2/AllMemori/{strToken}`
142
+
143
+ Parameters:
144
+
145
+ - `strToken`: **string** The login token. required
146
+
147
+
data/doc/MemoriClient::Backend::V2::Notification.md ADDED
@@ -0,0 +1,31 @@
1
+ # Module `MemoriClient::Backend::V2::Notification`
2
+
3
+ ## get_tenant_notifications
4
+
5
+ Summary:
6
+ Gets the Notification objects for a specific Tenant.
7
+
8
+ Signature: `get_tenant_notifications(tenantName:)`
9
+ Invocation: `MemoriClient::Backend::V2::Notification.get_tenant_notifications(tenantName:)`
10
+
11
+ HTTP API: GET /api/v2/TenantNotifications/{tenantName}`
12
+
13
+ Parameters:
14
+
15
+ - `tenantName`: **string** The name of the Tenant. required
16
+
17
+ ## get_user_notifications
18
+
19
+ Summary:
20
+ Gets the Notification objects for the currently logged in user.
21
+
22
+ Signature: `get_user_notifications(strToken:)`
23
+ Invocation: `MemoriClient::Backend::V2::Notification.get_user_notifications(strToken:)`
24
+
25
+ HTTP API: GET /api/v2/UserNotifications/{strToken}`
26
+
27
+ Parameters:
28
+
29
+ - `strToken`: **string** The login token. required
30
+
31
+
data/doc/MemoriClient::Backend::V2::Process.md ADDED
@@ -0,0 +1,64 @@
1
+ # Module `MemoriClient::Backend::V2::Process`
2
+
3
+ ## list_processes
4
+
5
+ Summary:
6
+ Gets a list of Process objects started by the currently logged in User.
7
+
8
+ Signature: `list_processes(strToken:, strType: nil)`
9
+ Invocation: `MemoriClient::Backend::V2::Process.list_processes(strToken:, strType: nil)`
10
+
11
+ HTTP API: GET /api/v2/Processes/{strToken}/{strType}`
12
+
13
+ Parameters:
14
+
15
+ - `strToken`: **string** The login token. required
16
+ - `strType`: **string** Optional filter for Process type. optional
17
+
18
+ ## list_memori_processes
19
+
20
+ Summary:
21
+ Gets a list of Process objects for the specified Memori.
22
+
23
+ Signature: `list_memori_processes(strToken:, strMemoriID:, strType: nil)`
24
+ Invocation: `MemoriClient::Backend::V2::Process.list_memori_processes(strToken:, strMemoriID:, strType: nil)`
25
+
26
+ HTTP API: GET /api/v2/MemoriProcesses/{strToken}/{strMemoriID}/{strType}`
27
+
28
+ Parameters:
29
+
30
+ - `strToken`: **string** The login token. required
31
+ - `strMemoriID`: **string** The ID of the Memori object. required
32
+ - `strType`: **string** Optional filter for Process type. optional
33
+
34
+ ## get_process_status
35
+
36
+ Summary:
37
+ Gets the status of an Process object.
38
+
39
+ Signature: `get_process_status(strToken:, strProcessID:)`
40
+ Invocation: `MemoriClient::Backend::V2::Process.get_process_status(strToken:, strProcessID:)`
41
+
42
+ HTTP API: GET /api/v2/ProcessStatus/{strToken}/{strProcessID}`
43
+
44
+ Parameters:
45
+
46
+ - `strToken`: **string** The login token. required
47
+ - `strProcessID`: **string** The Process object ID. required
48
+
49
+ ## stop_process
50
+
51
+ Summary:
52
+ Interrupts an ongoing Process object.
53
+
54
+ Signature: `stop_process(strToken:, strProcessID:)`
55
+ Invocation: `MemoriClient::Backend::V2::Process.stop_process(strToken:, strProcessID:)`
56
+
57
+ HTTP API: POST /api/v2/StopProcess/{strToken}/{strProcessID}`
58
+
59
+ Parameters:
60
+
61
+ - `strToken`: **string** The login token. required
62
+ - `strProcessID`: **string** The Process object ID. required
63
+
64
+