memori-client 0.1.0 → 0.1.2

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 (44) hide show
  1. checksums.yaml +4 -4
  2. data/lib/memori_client/backend/resources.rb +3 -0
  3. data/lib/memori_client/backend/v1/asset.rb +51 -25
  4. data/lib/memori_client/backend/v2/action_log.rb +19 -7
  5. data/lib/memori_client/backend/v2/analysis.rb +54 -0
  6. data/lib/memori_client/backend/v2/asset.rb +79 -23
  7. data/lib/memori_client/backend/v2/badge.rb +34 -17
  8. data/lib/memori_client/backend/v2/completion_config.rb +202 -0
  9. data/lib/memori_client/backend/v2/consumption_log.rb +31 -10
  10. data/lib/memori_client/backend/v2/import_export.rb +246 -78
  11. data/lib/memori_client/backend/v2/integration.rb +95 -47
  12. data/lib/memori_client/backend/v2/invitation.rb +129 -59
  13. data/lib/memori_client/backend/v2/memori.rb +652 -313
  14. data/lib/memori_client/backend/v2/memori_list.rb +65 -31
  15. data/lib/memori_client/backend/v2/notification.rb +13 -7
  16. data/lib/memori_client/backend/v2/process.rb +70 -0
  17. data/lib/memori_client/backend/v2/tenant.rb +192 -102
  18. data/lib/memori_client/backend/v2/user.rb +1058 -547
  19. data/lib/memori_client/engine/resources.rb +4 -3
  20. data/lib/memori_client/engine/v2/chat_log.rb +51 -13
  21. data/lib/memori_client/engine/v2/completion_log.rb +1 -1
  22. data/lib/memori_client/engine/v2/context_var.rb +20 -10
  23. data/lib/memori_client/engine/v2/correlation_pair.rb +48 -23
  24. data/lib/memori_client/engine/v2/custom_dictionary.rb +76 -37
  25. data/lib/memori_client/engine/v2/dialog.rb +107 -57
  26. data/lib/memori_client/engine/v2/event_log.rb +54 -13
  27. data/lib/memori_client/engine/v2/expert_reference.rb +176 -0
  28. data/lib/memori_client/engine/v2/function.rb +220 -0
  29. data/lib/memori_client/engine/v2/intent.rb +175 -85
  30. data/lib/memori_client/engine/v2/localization_key.rb +72 -36
  31. data/lib/memori_client/engine/v2/medium.rb +92 -43
  32. data/lib/memori_client/engine/v2/memori.rb +7 -1
  33. data/lib/memori_client/engine/v2/memory.rb +343 -91
  34. data/lib/memori_client/engine/v2/nlp.rb +65 -128
  35. data/lib/memori_client/engine/v2/person.rb +88 -43
  36. data/lib/memori_client/engine/v2/prompted_question.rb +1 -1
  37. data/lib/memori_client/engine/v2/search.rb +240 -52
  38. data/lib/memori_client/engine/v2/session.rb +41 -22
  39. data/lib/memori_client/engine/v2/stat.rb +11 -42
  40. data/lib/memori_client/engine/v2/topic.rb +88 -0
  41. data/lib/memori_client/engine/v2/unanswered_question.rb +54 -26
  42. data/lib/memori_client/engine/v2/user.rb +152 -0
  43. data/lib/memori_client/engine/v2/web_hook.rb +80 -34
  44. metadata +9 -2
data/lib/memori_client/engine/v2/memory.rb CHANGED
@@ -1,82 +1,135 @@
1
- # Generated on 2023-10-20 07:44:40 +0000
1
+ # Generated on 2025-01-27 16:56:16 +0000
2
2
  class MemoriClient::Engine::V2::Memory < MemoriClient::Engine::Resource
3
- # GET /memori/v2/Memories/{strSessionID}/{type}
3
+ # `GET /memori/v2/Memories/{strSessionID}/{type}`
4
+ #
4
5
  # Lists all Memory objects.
5
- # Params list:
6
+ #
7
+ #
6
8
  # @param [string] strSessionID The session ID. required
7
- # @param [string] type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS. optional
8
- # list_memories(strSessionID:, type: nil)
9
+ #
10
+ # @param [string] type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES. optional
11
+ #
12
+ # `list_memories(strSessionID:, type: nil)`
9
13
  def self.list_memories(strSessionID:, type: nil)
10
14
  args = build_arguments(binding)
11
15
 
12
16
  exec_http_request('get', '/memori/v2/Memories/{strSessionID}/{type}', **args)
13
17
  end
14
18
 
15
- # GET /memori/v2/Memories/{strSessionID}/{from}/{howMany}/{type}
19
+ # `GET /memori/v2/Memories/{strSessionID}/{from}/{howMany}/{type}`
20
+ #
16
21
  # Lists Memory objects with pagination.
17
- # Params list:
22
+ #
23
+ #
18
24
  # @param [string] strSessionID The session ID. required
25
+ #
19
26
  # @param [integer] from The 0-based index of the first Memory object to list. required
27
+ #
20
28
  # @param [integer] howMany The number of the Memory objects to list. required
21
- # @param [string] type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS. optional
22
- # list_memories_paginated(strSessionID:, from:, howMany:, type: nil)
29
+ #
30
+ # @param [string] type Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES. optional
31
+ #
32
+ # `list_memories_paginated(strSessionID:, from:, howMany:, type: nil)`
23
33
  def self.list_memories_paginated(strSessionID:, from:, howMany:, type: nil)
24
34
  args = build_arguments(binding)
25
35
 
26
36
  exec_http_request('get', '/memori/v2/Memories/{strSessionID}/{from}/{howMany}/{type}', **args)
27
37
  end
28
38
 
29
- # GET /memori/v2/Memory/{strSessionID}/{strMemoryID}
39
+ # `GET /memori/v2/Memory/{strSessionID}/{strMemoryID}`
40
+ #
30
41
  # Gets the details of a Memory object.
31
- # Params list:
42
+ #
43
+ #
32
44
  # @param [string] strSessionID The session ID. required
45
+ #
33
46
  # @param [string] strMemoryID The Memory object ID. required
34
- # get_memory(strSessionID:, strMemoryID:)
47
+ #
48
+ # `get_memory(strSessionID:, strMemoryID:)`
35
49
  def self.get_memory(strSessionID:, strMemoryID:)
36
50
  args = build_arguments(binding)
37
51
 
38
52
  exec_http_request('get', '/memori/v2/Memory/{strSessionID}/{strMemoryID}', **args)
39
53
  end
40
54
 
41
- # PATCH /memori/v2/Memory/{strSessionID}/{strMemoryID}
55
+ # `PATCH /memori/v2/Memory/{strSessionID}/{strMemoryID}`
56
+ #
42
57
  # Updates an existing Memory object.
43
- # Params list:
58
+ #
59
+ #
44
60
  # @param [string] strSessionID The session ID. required
61
+ #
45
62
  # @param [string] strMemoryID The Memory object ID. required
46
- # @param [object] payload request payload. optional
47
- # @param [boolean] payload.markAsRead . optional
48
- # @param [string] payload.memoryID . optional
49
- # @param [string] payload.memoryType . required
50
- # @param [string] payload.lastRead . optional
51
- # @param [integer] payload.readOccurrences . optional
52
- # @param [string] payload.receiverID . optional
53
- # @param [string] payload.receiverTag . optional
54
- # @param [string] payload.receiverName . optional
55
- # @param [array] payload.media . required
56
- # @param [string] payload.title . optional
57
- # @param [array] payload.titleVariants . optional
58
- # @param [array] payload.answers . optional
59
- # @param [string] payload.date . optional
60
- # @param [number] payload.dateUncertaintyDays . optional
61
- # @param [string] payload.placeName . optional
62
- # @param [number] payload.placeLatitude . optional
63
- # @param [number] payload.placeLongitude . optional
64
- # @param [number] payload.placeUncertaintyKm . optional
65
- # @param [boolean] payload.conclusive . optional
66
- # @param [boolean] payload.notPickable . optional
67
- # @param [boolean] payload.help . optional
68
- # @param [array] payload.hints . optional
69
- # @param [number] payload.minTimeout . optional
70
- # @param [number] payload.maxTimeout . optional
71
- # @param [object] payload.contextVarsToSet . optional
72
- # @param [object] payload.contextVarsToMatch . optional
73
- # @param [string] payload.dcmOutcomeType . optional
74
- # @param [string] payload.dcmOutcomeCode . optional
75
- # @param [string] payload.creationTimestamp . optional
76
- # @param [string] payload.creationSessionID . optional
77
- # @param [string] payload.lastChangeTimestamp . optional
78
- # @param [string] payload.lastChangeSessionID . optional
79
- # update_memory(strSessionID:, strMemoryID:, payload: {})
63
+ #
64
+ # @param [Hash] payload request payload. optional
65
+ #
66
+ # @param [Boolean] payload.markAsRead . optional
67
+ #
68
+ # @param [String] payload.memoryID . optional
69
+ #
70
+ # @param [String] payload.memoryType . optional
71
+ #
72
+ # @param [String] payload.lastRead . optional
73
+ #
74
+ # @param [Integer] payload.readOccurrences . optional
75
+ #
76
+ # @param [String] payload.receiverID . optional
77
+ #
78
+ # @param [String] payload.receiverTag . optional
79
+ #
80
+ # @param [String] payload.receiverName . optional
81
+ #
82
+ # @param [Array] payload.media . optional
83
+ #
84
+ # @param [String] payload.title . optional
85
+ #
86
+ # @param [Array] payload.titleVariants . optional
87
+ #
88
+ # @param [Array] payload.answers . optional
89
+ #
90
+ # @param [String] payload.date . optional
91
+ #
92
+ # @param [Number] payload.dateUncertaintyDays . optional
93
+ #
94
+ # @param [String] payload.placeName . optional
95
+ #
96
+ # @param [Number] payload.placeLatitude . optional
97
+ #
98
+ # @param [Number] payload.placeLongitude . optional
99
+ #
100
+ # @param [Number] payload.placeUncertaintyKm . optional
101
+ #
102
+ # @param [Boolean] payload.conclusive . optional
103
+ #
104
+ # @param [Boolean] payload.notPickable . optional
105
+ #
106
+ # @param [Boolean] payload.help . optional
107
+ #
108
+ # @param [Array] payload.hints . optional
109
+ #
110
+ # @param [Number] payload.minTimeout . optional
111
+ #
112
+ # @param [Number] payload.maxTimeout . optional
113
+ #
114
+ # @param [Object] payload.contextVarsToSet . optional
115
+ #
116
+ # @param [Object] payload.contextVarsToMatch . optional
117
+ #
118
+ # @param [String] payload.dcmOutcomeType . optional
119
+ #
120
+ # @param [String] payload.dcmOutcomeCode . optional
121
+ #
122
+ # @param [Array] payload.tags . optional
123
+ #
124
+ # @param [String] payload.creationTimestamp . optional
125
+ #
126
+ # @param [String] payload.creationSessionID . optional
127
+ #
128
+ # @param [String] payload.lastChangeTimestamp . optional
129
+ #
130
+ # @param [String] payload.lastChangeSessionID . optional
131
+ #
132
+ # `update_memory(strSessionID:, strMemoryID:, payload: {})`
80
133
  def self.update_memory(strSessionID:, strMemoryID:, payload: {})
81
134
  args = build_arguments(binding)
82
135
  payload_keys = [
@@ -110,64 +163,258 @@ class MemoriClient::Engine::V2::Memory < MemoriClient::Engine::Resource
110
163
  'receiverID',
111
164
  'receiverName',
112
165
  'receiverTag',
166
+ 'tags',
113
167
  'title',
114
168
  'titleVariants',
115
169
  ]
116
- payload_required_keys = %w[media memoryType]
170
+ payload_required_keys = %w[]
117
171
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
118
172
 
119
173
  exec_http_request('patch', '/memori/v2/Memory/{strSessionID}/{strMemoryID}', **args)
120
174
  end
121
175
 
122
- # DELETE /memori/v2/Memory/{strSessionID}/{strMemoryID}
176
+ # `DELETE /memori/v2/Memory/{strSessionID}/{strMemoryID}`
177
+ #
123
178
  # Removes an existing Memory object.
124
- # Params list:
179
+ #
180
+ #
125
181
  # @param [string] strSessionID The session ID. required
182
+ #
126
183
  # @param [string] strMemoryID The Memory object ID. required
127
- # remove_memory(strSessionID:, strMemoryID:)
184
+ #
185
+ # `remove_memory(strSessionID:, strMemoryID:)`
128
186
  def self.remove_memory(strSessionID:, strMemoryID:)
129
187
  args = build_arguments(binding)
130
188
 
131
189
  exec_http_request('delete', '/memori/v2/Memory/{strSessionID}/{strMemoryID}', **args)
132
190
  end
133
191
 
134
- # POST /memori/v2/Memory/{strSessionID}
192
+ # `POST /memori/v2/FilterMemories/{strSessionID}`
193
+ #
194
+ # Filters Memory objects.
195
+ #
196
+ #
197
+ # @param [string] strSessionID The session ID. required
198
+ #
199
+ # @param [Hash] payload request payload. optional
200
+ #
201
+ # @param [String] payload.text . optional
202
+ #
203
+ # @param [String] payload.searchType . optional
204
+ #
205
+ # @param [String] payload.date . optional
206
+ #
207
+ # @param [Number] payload.dateUncertaintyDays . optional
208
+ #
209
+ # @param [String] payload.placeName . optional
210
+ #
211
+ # @param [Number] payload.placeLatitude . optional
212
+ #
213
+ # @param [Number] payload.placeLongitude . optional
214
+ #
215
+ # @param [Number] payload.placeUncertaintyKm . optional
216
+ #
217
+ # @param [String] payload.tag . optional
218
+ #
219
+ # @param [Boolean] payload.ignoreLastRead . optional
220
+ #
221
+ # @param [Array] payload.excludedMemoryIDs . optional
222
+ #
223
+ # @param [Object] payload.contextVars . optional
224
+ #
225
+ # @param [Object] payload.contextVarsToSet . optional
226
+ #
227
+ # @param [Array] payload.memoryTags . optional
228
+ #
229
+ # @param [Integer] payload.numberOfResults . optional
230
+ #
231
+ # @param [Integer] payload.startFrom . optional
232
+ #
233
+ # @param [String] payload.memoryType . optional
234
+ #
235
+ # @param [Boolean] payload.withMediaOnly . optional
236
+ #
237
+ # `filter_memories(strSessionID:, payload: {})`
238
+ def self.filter_memories(strSessionID:, payload: {})
239
+ args = build_arguments(binding)
240
+ payload_keys = [
241
+ 'contextVars',
242
+ 'contextVarsToSet',
243
+ 'date',
244
+ 'dateUncertaintyDays',
245
+ 'excludedMemoryIDs',
246
+ 'ignoreLastRead',
247
+ 'memoryTags',
248
+ 'memoryType',
249
+ 'numberOfResults',
250
+ 'placeLatitude',
251
+ 'placeLongitude',
252
+ 'placeName',
253
+ 'placeUncertaintyKm',
254
+ 'searchType',
255
+ 'startFrom',
256
+ 'tag',
257
+ 'text',
258
+ 'withMediaOnly',
259
+ ]
260
+ payload_required_keys = %w[]
261
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
262
+
263
+ exec_http_request('post', '/memori/v2/FilterMemories/{strSessionID}', **args)
264
+ end
265
+
266
+ # `POST /memori/v2/FilterMemories/{strSessionID}/{from}/{howMany}`
267
+ #
268
+ # Filters Memory objects, with pagination.
269
+ #
270
+ #
271
+ # @param [string] strSessionID The session ID. required
272
+ #
273
+ # @param [integer] from The 0-based index of the first Memory object to list. required
274
+ #
275
+ # @param [integer] howMany The number of the Memory objects to list. required
276
+ #
277
+ # @param [Hash] payload request payload. optional
278
+ #
279
+ # @param [String] payload.text . optional
280
+ #
281
+ # @param [String] payload.searchType . optional
282
+ #
283
+ # @param [String] payload.date . optional
284
+ #
285
+ # @param [Number] payload.dateUncertaintyDays . optional
286
+ #
287
+ # @param [String] payload.placeName . optional
288
+ #
289
+ # @param [Number] payload.placeLatitude . optional
290
+ #
291
+ # @param [Number] payload.placeLongitude . optional
292
+ #
293
+ # @param [Number] payload.placeUncertaintyKm . optional
294
+ #
295
+ # @param [String] payload.tag . optional
296
+ #
297
+ # @param [Boolean] payload.ignoreLastRead . optional
298
+ #
299
+ # @param [Array] payload.excludedMemoryIDs . optional
300
+ #
301
+ # @param [Object] payload.contextVars . optional
302
+ #
303
+ # @param [Object] payload.contextVarsToSet . optional
304
+ #
305
+ # @param [Array] payload.memoryTags . optional
306
+ #
307
+ # @param [Integer] payload.numberOfResults . optional
308
+ #
309
+ # @param [Integer] payload.startFrom . optional
310
+ #
311
+ # @param [String] payload.memoryType . optional
312
+ #
313
+ # @param [Boolean] payload.withMediaOnly . optional
314
+ #
315
+ # `filter_memories_paginated(strSessionID:, from:, howMany:, payload: {})`
316
+ def self.filter_memories_paginated(strSessionID:, from:, howMany:, payload: {})
317
+ args = build_arguments(binding)
318
+ payload_keys = [
319
+ 'contextVars',
320
+ 'contextVarsToSet',
321
+ 'date',
322
+ 'dateUncertaintyDays',
323
+ 'excludedMemoryIDs',
324
+ 'ignoreLastRead',
325
+ 'memoryTags',
326
+ 'memoryType',
327
+ 'numberOfResults',
328
+ 'placeLatitude',
329
+ 'placeLongitude',
330
+ 'placeName',
331
+ 'placeUncertaintyKm',
332
+ 'searchType',
333
+ 'startFrom',
334
+ 'tag',
335
+ 'text',
336
+ 'withMediaOnly',
337
+ ]
338
+ payload_required_keys = %w[]
339
+ validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
340
+
341
+ exec_http_request('post', '/memori/v2/FilterMemories/{strSessionID}/{from}/{howMany}', **args)
342
+ end
343
+
344
+ # `POST /memori/v2/Memory/{strSessionID}`
345
+ #
135
346
  # Adds a new Memory object.
136
- # Params list:
347
+ #
348
+ #
137
349
  # @param [string] strSessionID The session ID. required
138
- # @param [object] payload request payload. optional
139
- # @param [string] payload.memoryID . optional
140
- # @param [string] payload.memoryType . required
141
- # @param [string] payload.lastRead . optional
142
- # @param [integer] payload.readOccurrences . optional
143
- # @param [string] payload.receiverID . optional
144
- # @param [string] payload.receiverTag . optional
145
- # @param [string] payload.receiverName . optional
146
- # @param [array] payload.media . required
147
- # @param [string] payload.title . optional
148
- # @param [array] payload.titleVariants . optional
149
- # @param [array] payload.answers . optional
150
- # @param [string] payload.date . optional
151
- # @param [number] payload.dateUncertaintyDays . optional
152
- # @param [string] payload.placeName . optional
153
- # @param [number] payload.placeLatitude . optional
154
- # @param [number] payload.placeLongitude . optional
155
- # @param [number] payload.placeUncertaintyKm . optional
156
- # @param [boolean] payload.conclusive . optional
157
- # @param [boolean] payload.notPickable . optional
158
- # @param [boolean] payload.help . optional
159
- # @param [array] payload.hints . optional
160
- # @param [number] payload.minTimeout . optional
161
- # @param [number] payload.maxTimeout . optional
162
- # @param [object] payload.contextVarsToSet . optional
163
- # @param [object] payload.contextVarsToMatch . optional
164
- # @param [string] payload.dcmOutcomeType . optional
165
- # @param [string] payload.dcmOutcomeCode . optional
166
- # @param [string] payload.creationTimestamp . optional
167
- # @param [string] payload.creationSessionID . optional
168
- # @param [string] payload.lastChangeTimestamp . optional
169
- # @param [string] payload.lastChangeSessionID . optional
170
- # add_memory(strSessionID:, payload: {})
350
+ #
351
+ # @param [Hash] payload request payload. optional
352
+ #
353
+ # @param [String] payload.memoryID . optional
354
+ #
355
+ # @param [String] payload.memoryType . optional
356
+ #
357
+ # @param [String] payload.lastRead . optional
358
+ #
359
+ # @param [Integer] payload.readOccurrences . optional
360
+ #
361
+ # @param [String] payload.receiverID . optional
362
+ #
363
+ # @param [String] payload.receiverTag . optional
364
+ #
365
+ # @param [String] payload.receiverName . optional
366
+ #
367
+ # @param [Array] payload.media . optional
368
+ #
369
+ # @param [String] payload.title . optional
370
+ #
371
+ # @param [Array] payload.titleVariants . optional
372
+ #
373
+ # @param [Array] payload.answers . optional
374
+ #
375
+ # @param [String] payload.date . optional
376
+ #
377
+ # @param [Number] payload.dateUncertaintyDays . optional
378
+ #
379
+ # @param [String] payload.placeName . optional
380
+ #
381
+ # @param [Number] payload.placeLatitude . optional
382
+ #
383
+ # @param [Number] payload.placeLongitude . optional
384
+ #
385
+ # @param [Number] payload.placeUncertaintyKm . optional
386
+ #
387
+ # @param [Boolean] payload.conclusive . optional
388
+ #
389
+ # @param [Boolean] payload.notPickable . optional
390
+ #
391
+ # @param [Boolean] payload.help . optional
392
+ #
393
+ # @param [Array] payload.hints . optional
394
+ #
395
+ # @param [Number] payload.minTimeout . optional
396
+ #
397
+ # @param [Number] payload.maxTimeout . optional
398
+ #
399
+ # @param [Object] payload.contextVarsToSet . optional
400
+ #
401
+ # @param [Object] payload.contextVarsToMatch . optional
402
+ #
403
+ # @param [String] payload.dcmOutcomeType . optional
404
+ #
405
+ # @param [String] payload.dcmOutcomeCode . optional
406
+ #
407
+ # @param [Array] payload.tags . optional
408
+ #
409
+ # @param [String] payload.creationTimestamp . optional
410
+ #
411
+ # @param [String] payload.creationSessionID . optional
412
+ #
413
+ # @param [String] payload.lastChangeTimestamp . optional
414
+ #
415
+ # @param [String] payload.lastChangeSessionID . optional
416
+ #
417
+ # `add_memory(strSessionID:, payload: {})`
171
418
  def self.add_memory(strSessionID:, payload: {})
172
419
  args = build_arguments(binding)
173
420
  payload_keys = [
@@ -200,21 +447,26 @@ class MemoriClient::Engine::V2::Memory < MemoriClient::Engine::Resource
200
447
  'receiverID',
201
448
  'receiverName',
202
449
  'receiverTag',
450
+ 'tags',
203
451
  'title',
204
452
  'titleVariants',
205
453
  ]
206
- payload_required_keys = %w[media memoryType]
454
+ payload_required_keys = %w[]
207
455
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
208
456
 
209
457
  exec_http_request('post', '/memori/v2/Memory/{strSessionID}', **args)
210
458
  end
211
459
 
212
- # GET /memori/v2/MemoryAccess/{strSessionID}/{strMemoryID}
460
+ # `GET /memori/v2/MemoryAccess/{strSessionID}/{strMemoryID}`
461
+ #
213
462
  # Checks if a Memory object is accessible from the specified session.
214
- # Params list:
463
+ #
464
+ #
215
465
  # @param [string] strSessionID The session ID. required
466
+ #
216
467
  # @param [string] strMemoryID The Memory object ID. required
217
- # check_memory_access(strSessionID:, strMemoryID:)
468
+ #
469
+ # `check_memory_access(strSessionID:, strMemoryID:)`
218
470
  def self.check_memory_access(strSessionID:, strMemoryID:)
219
471
  args = build_arguments(binding)
220
472