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::Engine::V2::Memory.md ADDED
@@ -0,0 +1,244 @@
1
+ # Module `MemoriClient::Engine::V2::Memory`
2
+
3
+ ## list_memories
4
+
5
+ Summary:
6
+ Lists all Memory objects.
7
+
8
+ Signature: `list_memories(strSessionID:, type: nil)`
9
+ Invocation: `MemoriClient::Engine::V2::Memory.list_memories(strSessionID:, type: nil)`
10
+
11
+ HTTP API: GET /memori/v2/Memories/{strSessionID}/{type}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `type`: **string** Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES. optional
17
+
18
+ ## list_memories_paginated
19
+
20
+ Summary:
21
+ Lists Memory objects with pagination.
22
+
23
+ Signature: `list_memories_paginated(strSessionID:, from:, howMany:, type: nil)`
24
+ Invocation: `MemoriClient::Engine::V2::Memory.list_memories_paginated(strSessionID:, from:, howMany:, type: nil)`
25
+
26
+ HTTP API: GET /memori/v2/Memories/{strSessionID}/{from}/{howMany}/{type}`
27
+
28
+ Parameters:
29
+
30
+ - `strSessionID`: **string** The session ID. required
31
+ - `from`: **integer** The 0-based index of the first Memory object to list. required
32
+ - `howMany`: **integer** The number of the Memory objects to list. required
33
+ - `type`: **string** Optional type of the Memory objects to list: ALL, CONTENTS, DEFAULTS, DRAFTS, EXPERT_REFERENCES. optional
34
+
35
+ ## get_memory
36
+
37
+ Summary:
38
+ Gets the details of a Memory object.
39
+
40
+ Signature: `get_memory(strSessionID:, strMemoryID:)`
41
+ Invocation: `MemoriClient::Engine::V2::Memory.get_memory(strSessionID:, strMemoryID:)`
42
+
43
+ HTTP API: GET /memori/v2/Memory/{strSessionID}/{strMemoryID}`
44
+
45
+ Parameters:
46
+
47
+ - `strSessionID`: **string** The session ID. required
48
+ - `strMemoryID`: **string** The Memory object ID. required
49
+
50
+ ## update_memory
51
+
52
+ Summary:
53
+ Updates an existing Memory object.
54
+
55
+ Signature: `update_memory(strSessionID:, strMemoryID:, payload: {})`
56
+ Invocation: `MemoriClient::Engine::V2::Memory.update_memory(strSessionID:, strMemoryID:, payload: {})`
57
+
58
+ HTTP API: PATCH /memori/v2/Memory/{strSessionID}/{strMemoryID}`
59
+
60
+ Parameters:
61
+
62
+ - `strSessionID`: **string** The session ID. required
63
+ - `strMemoryID`: **string** The Memory object ID. required
64
+ - `payload`: **Hash** request payload. optional
65
+ - `payload.markAsRead`: **Boolean** . optional
66
+ - `payload.memoryID`: **String** . optional
67
+ - `payload.memoryType`: **String** . optional
68
+ - `payload.lastRead`: **String** . optional
69
+ - `payload.readOccurrences`: **Integer** . optional
70
+ - `payload.receiverID`: **String** . optional
71
+ - `payload.receiverTag`: **String** . optional
72
+ - `payload.receiverName`: **String** . optional
73
+ - `payload.media`: **Array** . optional
74
+ - `payload.title`: **String** . optional
75
+ - `payload.titleVariants`: **Array** . optional
76
+ - `payload.answers`: **Array** . optional
77
+ - `payload.date`: **String** . optional
78
+ - `payload.dateUncertaintyDays`: **Number** . optional
79
+ - `payload.placeName`: **String** . optional
80
+ - `payload.placeLatitude`: **Number** . optional
81
+ - `payload.placeLongitude`: **Number** . optional
82
+ - `payload.placeUncertaintyKm`: **Number** . optional
83
+ - `payload.conclusive`: **Boolean** . optional
84
+ - `payload.notPickable`: **Boolean** . optional
85
+ - `payload.help`: **Boolean** . optional
86
+ - `payload.hints`: **Array** . optional
87
+ - `payload.minTimeout`: **Number** . optional
88
+ - `payload.maxTimeout`: **Number** . optional
89
+ - `payload.contextVarsToSet`: **Object** . optional
90
+ - `payload.contextVarsToMatch`: **Object** . optional
91
+ - `payload.dcmOutcomeType`: **String** . optional
92
+ - `payload.dcmOutcomeCode`: **String** . optional
93
+ - `payload.tags`: **Array** . optional
94
+ - `payload.creationTimestamp`: **String** . optional
95
+ - `payload.creationSessionID`: **String** . optional
96
+ - `payload.lastChangeTimestamp`: **String** . optional
97
+ - `payload.lastChangeSessionID`: **String** . optional
98
+
99
+ ## remove_memory
100
+
101
+ Summary:
102
+ Removes an existing Memory object.
103
+
104
+ Signature: `remove_memory(strSessionID:, strMemoryID:)`
105
+ Invocation: `MemoriClient::Engine::V2::Memory.remove_memory(strSessionID:, strMemoryID:)`
106
+
107
+ HTTP API: DELETE /memori/v2/Memory/{strSessionID}/{strMemoryID}`
108
+
109
+ Parameters:
110
+
111
+ - `strSessionID`: **string** The session ID. required
112
+ - `strMemoryID`: **string** The Memory object ID. required
113
+
114
+ ## filter_memories
115
+
116
+ Summary:
117
+ Filters Memory objects.
118
+
119
+ Signature: `filter_memories(strSessionID:, payload: {})`
120
+ Invocation: `MemoriClient::Engine::V2::Memory.filter_memories(strSessionID:, payload: {})`
121
+
122
+ HTTP API: POST /memori/v2/FilterMemories/{strSessionID}`
123
+
124
+ Parameters:
125
+
126
+ - `strSessionID`: **string** The session ID. required
127
+ - `payload`: **Hash** request payload. optional
128
+ - `payload.text`: **String** . optional
129
+ - `payload.searchType`: **String** . optional
130
+ - `payload.date`: **String** . optional
131
+ - `payload.dateUncertaintyDays`: **Number** . optional
132
+ - `payload.placeName`: **String** . optional
133
+ - `payload.placeLatitude`: **Number** . optional
134
+ - `payload.placeLongitude`: **Number** . optional
135
+ - `payload.placeUncertaintyKm`: **Number** . optional
136
+ - `payload.tag`: **String** . optional
137
+ - `payload.ignoreLastRead`: **Boolean** . optional
138
+ - `payload.excludedMemoryIDs`: **Array** . optional
139
+ - `payload.contextVars`: **Object** . optional
140
+ - `payload.contextVarsToSet`: **Object** . optional
141
+ - `payload.memoryTags`: **Array** . optional
142
+ - `payload.numberOfResults`: **Integer** . optional
143
+ - `payload.startFrom`: **Integer** . optional
144
+ - `payload.memoryType`: **String** . optional
145
+ - `payload.withMediaOnly`: **Boolean** . optional
146
+
147
+ ## filter_memories_paginated
148
+
149
+ Summary:
150
+ Filters Memory objects, with pagination.
151
+
152
+ Signature: `filter_memories_paginated(strSessionID:, from:, howMany:, payload: {})`
153
+ Invocation: `MemoriClient::Engine::V2::Memory.filter_memories_paginated(strSessionID:, from:, howMany:, payload: {})`
154
+
155
+ HTTP API: POST /memori/v2/FilterMemories/{strSessionID}/{from}/{howMany}`
156
+
157
+ Parameters:
158
+
159
+ - `strSessionID`: **string** The session ID. required
160
+ - `from`: **integer** The 0-based index of the first Memory object to list. required
161
+ - `howMany`: **integer** The number of the Memory objects to list. required
162
+ - `payload`: **Hash** request payload. optional
163
+ - `payload.text`: **String** . optional
164
+ - `payload.searchType`: **String** . optional
165
+ - `payload.date`: **String** . optional
166
+ - `payload.dateUncertaintyDays`: **Number** . optional
167
+ - `payload.placeName`: **String** . optional
168
+ - `payload.placeLatitude`: **Number** . optional
169
+ - `payload.placeLongitude`: **Number** . optional
170
+ - `payload.placeUncertaintyKm`: **Number** . optional
171
+ - `payload.tag`: **String** . optional
172
+ - `payload.ignoreLastRead`: **Boolean** . optional
173
+ - `payload.excludedMemoryIDs`: **Array** . optional
174
+ - `payload.contextVars`: **Object** . optional
175
+ - `payload.contextVarsToSet`: **Object** . optional
176
+ - `payload.memoryTags`: **Array** . optional
177
+ - `payload.numberOfResults`: **Integer** . optional
178
+ - `payload.startFrom`: **Integer** . optional
179
+ - `payload.memoryType`: **String** . optional
180
+ - `payload.withMediaOnly`: **Boolean** . optional
181
+
182
+ ## add_memory
183
+
184
+ Summary:
185
+ Adds a new Memory object.
186
+
187
+ Signature: `add_memory(strSessionID:, payload: {})`
188
+ Invocation: `MemoriClient::Engine::V2::Memory.add_memory(strSessionID:, payload: {})`
189
+
190
+ HTTP API: POST /memori/v2/Memory/{strSessionID}`
191
+
192
+ Parameters:
193
+
194
+ - `strSessionID`: **string** The session ID. required
195
+ - `payload`: **Hash** request payload. optional
196
+ - `payload.memoryID`: **String** . optional
197
+ - `payload.memoryType`: **String** . optional
198
+ - `payload.lastRead`: **String** . optional
199
+ - `payload.readOccurrences`: **Integer** . optional
200
+ - `payload.receiverID`: **String** . optional
201
+ - `payload.receiverTag`: **String** . optional
202
+ - `payload.receiverName`: **String** . optional
203
+ - `payload.media`: **Array** . optional
204
+ - `payload.title`: **String** . optional
205
+ - `payload.titleVariants`: **Array** . optional
206
+ - `payload.answers`: **Array** . optional
207
+ - `payload.date`: **String** . optional
208
+ - `payload.dateUncertaintyDays`: **Number** . optional
209
+ - `payload.placeName`: **String** . optional
210
+ - `payload.placeLatitude`: **Number** . optional
211
+ - `payload.placeLongitude`: **Number** . optional
212
+ - `payload.placeUncertaintyKm`: **Number** . optional
213
+ - `payload.conclusive`: **Boolean** . optional
214
+ - `payload.notPickable`: **Boolean** . optional
215
+ - `payload.help`: **Boolean** . optional
216
+ - `payload.hints`: **Array** . optional
217
+ - `payload.minTimeout`: **Number** . optional
218
+ - `payload.maxTimeout`: **Number** . optional
219
+ - `payload.contextVarsToSet`: **Object** . optional
220
+ - `payload.contextVarsToMatch`: **Object** . optional
221
+ - `payload.dcmOutcomeType`: **String** . optional
222
+ - `payload.dcmOutcomeCode`: **String** . optional
223
+ - `payload.tags`: **Array** . optional
224
+ - `payload.creationTimestamp`: **String** . optional
225
+ - `payload.creationSessionID`: **String** . optional
226
+ - `payload.lastChangeTimestamp`: **String** . optional
227
+ - `payload.lastChangeSessionID`: **String** . optional
228
+
229
+ ## check_memory_access
230
+
231
+ Summary:
232
+ Checks if a Memory object is accessible from the specified session.
233
+
234
+ Signature: `check_memory_access(strSessionID:, strMemoryID:)`
235
+ Invocation: `MemoriClient::Engine::V2::Memory.check_memory_access(strSessionID:, strMemoryID:)`
236
+
237
+ HTTP API: GET /memori/v2/MemoryAccess/{strSessionID}/{strMemoryID}`
238
+
239
+ Parameters:
240
+
241
+ - `strSessionID`: **string** The session ID. required
242
+ - `strMemoryID`: **string** The Memory object ID. required
243
+
244
+
data/doc/MemoriClient::Engine::V2::NLP.md ADDED
@@ -0,0 +1,100 @@
1
+ # Module `MemoriClient::Engine::V2::NLP`
2
+
3
+ ## get_word_vector
4
+
5
+ Summary:
6
+ Looks up the vector definition for a word.
7
+
8
+ Signature: `get_word_vector(strSessionID:, word:)`
9
+ Invocation: `MemoriClient::Engine::V2::NLP.get_word_vector(strSessionID:, word:)`
10
+
11
+ HTTP API: GET /memori/v2/WordVector/{strSessionID}/{word}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `word`: **string** Word to be looked up. required
17
+
18
+ ## get_similar_words
19
+
20
+ Summary:
21
+ Searches for the 10 words most semantically similar words to the specified word.
22
+
23
+ Signature: `get_similar_words(strSessionID:, word:)`
24
+ Invocation: `MemoriClient::Engine::V2::NLP.get_similar_words(strSessionID:, word:)`
25
+
26
+ HTTP API: GET /memori/v2/SimilarWords/{strSessionID}/{word}`
27
+
28
+ Parameters:
29
+
30
+ - `strSessionID`: **string** The session ID. required
31
+ - `word`: **string** Word to be searcher for. required
32
+
33
+ ## guess_language
34
+
35
+ Summary:
36
+ Tries to guess the language of a sentence by analyzing keyword occurrences.
37
+
38
+ Signature: `guess_language(strSessionID:, payload: {})`
39
+ Invocation: `MemoriClient::Engine::V2::NLP.guess_language(strSessionID:, payload: {})`
40
+
41
+ HTTP API: POST /memori/v2/GuessLanguage/{strSessionID}`
42
+
43
+ Parameters:
44
+
45
+ - `strSessionID`: **string** The session ID. required
46
+ - `payload`: **Hash** request payload. optional
47
+ - `payload.text`: **String** . optional
48
+
49
+ ## compute_sentences_similarity
50
+
51
+ Summary:
52
+ Computes the similarity between a reference and a comparison sentences.
53
+
54
+ Signature: `compute_sentences_similarity(strSessionID:, payload: {})`
55
+ Invocation: `MemoriClient::Engine::V2::NLP.compute_sentences_similarity(strSessionID:, payload: {})`
56
+
57
+ HTTP API: POST /memori/v2/ComputeSimilarity/{strSessionID}`
58
+
59
+ Parameters:
60
+
61
+ - `strSessionID`: **string** The session ID. required
62
+ - `payload`: **Hash** request payload. optional
63
+ - `payload.referenceText`: **String** . optional
64
+ - `payload.referenceTextType`: **String** . optional
65
+ - `payload.comparisonText`: **String** . optional
66
+ - `payload.comparisonTextType`: **String** . optional
67
+
68
+ ## check_undefined_words
69
+
70
+ Summary:
71
+ Checks the words of a sentence for their definition in the word vector dictionary.
72
+
73
+ Signature: `check_undefined_words(strSessionID:, payload: {})`
74
+ Invocation: `MemoriClient::Engine::V2::NLP.check_undefined_words(strSessionID:, payload: {})`
75
+
76
+ HTTP API: POST /memori/v2/CheckWords/{strSessionID}`
77
+
78
+ Parameters:
79
+
80
+ - `strSessionID`: **string** The session ID. required
81
+ - `payload`: **Hash** request payload. optional
82
+ - `payload.text`: **String** . optional
83
+
84
+ ## check_nsfw
85
+
86
+ Summary:
87
+ Checks a sentence for NSFW content.
88
+
89
+ Signature: `check_nsfw(strSessionID:, payload: {})`
90
+ Invocation: `MemoriClient::Engine::V2::NLP.check_nsfw(strSessionID:, payload: {})`
91
+
92
+ HTTP API: POST /memori/v2/CheckNSFW/{strSessionID}`
93
+
94
+ Parameters:
95
+
96
+ - `strSessionID`: **string** The session ID. required
97
+ - `payload`: **Hash** request payload. optional
98
+ - `payload.text`: **String** . optional
99
+
100
+
data/doc/MemoriClient::Engine::V2::Person.md ADDED
@@ -0,0 +1,114 @@
1
+ # Module `MemoriClient::Engine::V2::Person`
2
+
3
+ ## list_people
4
+
5
+ Summary:
6
+ Lists all Person objects.
7
+
8
+ Signature: `list_people(strSessionID:)`
9
+ Invocation: `MemoriClient::Engine::V2::Person.list_people(strSessionID:)`
10
+
11
+ HTTP API: GET /memori/v2/People/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+
17
+ ## list_people_paginated
18
+
19
+ Summary:
20
+ Lists Person objects with pagination.
21
+
22
+ Signature: `list_people_paginated(strSessionID:, from:, howMany:)`
23
+ Invocation: `MemoriClient::Engine::V2::Person.list_people_paginated(strSessionID:, from:, howMany:)`
24
+
25
+ HTTP API: GET /memori/v2/People/{strSessionID}/{from}/{howMany}`
26
+
27
+ Parameters:
28
+
29
+ - `strSessionID`: **string** The session ID. required
30
+ - `from`: **integer** The 0-based index of the first Person object to list. required
31
+ - `howMany`: **integer** The number of the Person objects to list. required
32
+
33
+ ## get_person
34
+
35
+ Summary:
36
+ Gets the details of a Person object.
37
+
38
+ Signature: `get_person(strSessionID:, strPersonID:)`
39
+ Invocation: `MemoriClient::Engine::V2::Person.get_person(strSessionID:, strPersonID:)`
40
+
41
+ HTTP API: GET /memori/v2/Person/{strSessionID}/{strPersonID}`
42
+
43
+ Parameters:
44
+
45
+ - `strSessionID`: **string** The session ID. required
46
+ - `strPersonID`: **string** The Person object ID. required
47
+
48
+ ## update_person
49
+
50
+ Summary:
51
+ Updates an existing Person object.
52
+
53
+ Signature: `update_person(strSessionID:, strPersonID:, payload: {})`
54
+ Invocation: `MemoriClient::Engine::V2::Person.update_person(strSessionID:, strPersonID:, payload: {})`
55
+
56
+ HTTP API: PATCH /memori/v2/Person/{strSessionID}/{strPersonID}`
57
+
58
+ Parameters:
59
+
60
+ - `strSessionID`: **string** The session ID. required
61
+ - `strPersonID`: **string** The Person object ID. required
62
+ - `payload`: **Hash** request payload. optional
63
+ - `payload.personID`: **String** . optional
64
+ - `payload.personType`: **String** . optional
65
+ - `payload.name`: **String** . optional
66
+ - `payload.information`: **String** . optional
67
+ - `payload.pin`: **String** . optional
68
+ - `payload.tag`: **String** . optional
69
+ - `payload.creationTimestamp`: **String** . optional
70
+ - `payload.creationSessionID`: **String** . optional
71
+ - `payload.lastChangeTimestamp`: **String** . optional
72
+ - `payload.lastChangeSessionID`: **String** . optional
73
+
74
+ ## remove_person
75
+
76
+ Summary:
77
+ Removes an existing Person object.
78
+
79
+ Signature: `remove_person(strSessionID:, strPersonID:)`
80
+ Invocation: `MemoriClient::Engine::V2::Person.remove_person(strSessionID:, strPersonID:)`
81
+
82
+ HTTP API: DELETE /memori/v2/Person/{strSessionID}/{strPersonID}`
83
+
84
+ Parameters:
85
+
86
+ - `strSessionID`: **string** The session ID. required
87
+ - `strPersonID`: **string** The Person object ID. required
88
+
89
+ ## add_person
90
+
91
+ Summary:
92
+ Adds a new Person object.
93
+
94
+ Signature: `add_person(strSessionID:, payload: {})`
95
+ Invocation: `MemoriClient::Engine::V2::Person.add_person(strSessionID:, payload: {})`
96
+
97
+ HTTP API: POST /memori/v2/Person/{strSessionID}`
98
+
99
+ Parameters:
100
+
101
+ - `strSessionID`: **string** The session ID. required
102
+ - `payload`: **Hash** request payload. optional
103
+ - `payload.personID`: **String** . optional
104
+ - `payload.personType`: **String** . optional
105
+ - `payload.name`: **String** . optional
106
+ - `payload.information`: **String** . optional
107
+ - `payload.pin`: **String** . optional
108
+ - `payload.tag`: **String** . optional
109
+ - `payload.creationTimestamp`: **String** . optional
110
+ - `payload.creationSessionID`: **String** . optional
111
+ - `payload.lastChangeTimestamp`: **String** . optional
112
+ - `payload.lastChangeSessionID`: **String** . optional
113
+
114
+
data/doc/MemoriClient::Engine::V2::Search.md ADDED
@@ -0,0 +1,151 @@
1
+ # Module `MemoriClient::Engine::V2::Search`
2
+
3
+ ## search_memories
4
+
5
+ Summary:
6
+ Searches for matching Memory objects.
7
+
8
+ Signature: `search_memories(strSessionID:, payload: {})`
9
+ Invocation: `MemoriClient::Engine::V2::Search.search_memories(strSessionID:, payload: {})`
10
+
11
+ HTTP API: POST /memori/v2/Search/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `payload`: **Hash** request payload. optional
17
+ - `payload.text`: **String** . optional
18
+ - `payload.searchType`: **String** . optional
19
+ - `payload.date`: **String** . optional
20
+ - `payload.dateUncertaintyDays`: **Number** . optional
21
+ - `payload.placeName`: **String** . optional
22
+ - `payload.placeLatitude`: **Number** . optional
23
+ - `payload.placeLongitude`: **Number** . optional
24
+ - `payload.placeUncertaintyKm`: **Number** . optional
25
+ - `payload.tag`: **String** . optional
26
+ - `payload.ignoreLastRead`: **Boolean** . optional
27
+ - `payload.excludedMemoryIDs`: **Array** . optional
28
+ - `payload.contextVars`: **Object** . optional
29
+ - `payload.contextVarsToSet`: **Object** . optional
30
+ - `payload.memoryTags`: **Array** . optional
31
+ - `payload.numberOfResults`: **Integer** . optional
32
+ - `payload.startFrom`: **Integer** . optional
33
+ - `payload.memoryType`: **String** . optional
34
+ - `payload.withMediaOnly`: **Boolean** . optional
35
+
36
+ ## search_memories_paginated
37
+
38
+ Summary:
39
+ Searches for matching Memory objects, with pagination.
40
+
41
+ Signature: `search_memories_paginated(strSessionID:, from:, howMany:, payload: {})`
42
+ Invocation: `MemoriClient::Engine::V2::Search.search_memories_paginated(strSessionID:, from:, howMany:, payload: {})`
43
+
44
+ HTTP API: POST /memori/v2/Search/{strSessionID}/{from}/{howMany}`
45
+
46
+ Parameters:
47
+
48
+ - `strSessionID`: **string** The session ID. required
49
+ - `from`: **integer** The 0-based index of the first Memory object to list. required
50
+ - `howMany`: **integer** The number of the Memory objects to list. required
51
+ - `payload`: **Hash** request payload. optional
52
+ - `payload.text`: **String** . optional
53
+ - `payload.searchType`: **String** . optional
54
+ - `payload.date`: **String** . optional
55
+ - `payload.dateUncertaintyDays`: **Number** . optional
56
+ - `payload.placeName`: **String** . optional
57
+ - `payload.placeLatitude`: **Number** . optional
58
+ - `payload.placeLongitude`: **Number** . optional
59
+ - `payload.placeUncertaintyKm`: **Number** . optional
60
+ - `payload.tag`: **String** . optional
61
+ - `payload.ignoreLastRead`: **Boolean** . optional
62
+ - `payload.excludedMemoryIDs`: **Array** . optional
63
+ - `payload.contextVars`: **Object** . optional
64
+ - `payload.contextVarsToSet`: **Object** . optional
65
+ - `payload.memoryTags`: **Array** . optional
66
+ - `payload.numberOfResults`: **Integer** . optional
67
+ - `payload.startFrom`: **Integer** . optional
68
+ - `payload.memoryType`: **String** . optional
69
+ - `payload.withMediaOnly`: **Boolean** . optional
70
+
71
+ ## get_random_memories
72
+
73
+ Summary:
74
+ Picks up to 5 random Memory objects.
75
+
76
+ Signature: `get_random_memories(strSessionID:, payload: {})`
77
+ Invocation: `MemoriClient::Engine::V2::Search.get_random_memories(strSessionID:, payload: {})`
78
+
79
+ HTTP API: POST /memori/v2/Random/{strSessionID}`
80
+
81
+ Parameters:
82
+
83
+ - `strSessionID`: **string** The session ID. required
84
+ - `payload`: **Hash** request payload. optional
85
+ - `payload.text`: **String** . optional
86
+ - `payload.searchType`: **String** . optional
87
+ - `payload.date`: **String** . optional
88
+ - `payload.dateUncertaintyDays`: **Number** . optional
89
+ - `payload.placeName`: **String** . optional
90
+ - `payload.placeLatitude`: **Number** . optional
91
+ - `payload.placeLongitude`: **Number** . optional
92
+ - `payload.placeUncertaintyKm`: **Number** . optional
93
+ - `payload.tag`: **String** . optional
94
+ - `payload.ignoreLastRead`: **Boolean** . optional
95
+ - `payload.excludedMemoryIDs`: **Array** . optional
96
+ - `payload.contextVars`: **Object** . optional
97
+ - `payload.contextVarsToSet`: **Object** . optional
98
+ - `payload.memoryTags`: **Array** . optional
99
+ - `payload.numberOfResults`: **Integer** . optional
100
+ - `payload.startFrom`: **Integer** . optional
101
+ - `payload.memoryType`: **String** . optional
102
+ - `payload.withMediaOnly`: **Boolean** . optional
103
+
104
+ ## get_memory_hints
105
+
106
+ Summary:
107
+ Picks up to 20 Memory Hint objects.
108
+
109
+ Signature: `get_memory_hints(strSessionID:, payload: {})`
110
+ Invocation: `MemoriClient::Engine::V2::Search.get_memory_hints(strSessionID:, payload: {})`
111
+
112
+ HTTP API: POST /memori/v2/Hints/{strSessionID}`
113
+
114
+ Parameters:
115
+
116
+ - `strSessionID`: **string** The session ID. required
117
+ - `payload`: **Hash** request payload. optional
118
+ - `payload.text`: **String** . optional
119
+ - `payload.searchType`: **String** . optional
120
+ - `payload.date`: **String** . optional
121
+ - `payload.dateUncertaintyDays`: **Number** . optional
122
+ - `payload.placeName`: **String** . optional
123
+ - `payload.placeLatitude`: **Number** . optional
124
+ - `payload.placeLongitude`: **Number** . optional
125
+ - `payload.placeUncertaintyKm`: **Number** . optional
126
+ - `payload.tag`: **String** . optional
127
+ - `payload.ignoreLastRead`: **Boolean** . optional
128
+ - `payload.excludedMemoryIDs`: **Array** . optional
129
+ - `payload.contextVars`: **Object** . optional
130
+ - `payload.contextVarsToSet`: **Object** . optional
131
+ - `payload.memoryTags`: **Array** . optional
132
+ - `payload.numberOfResults`: **Integer** . optional
133
+ - `payload.startFrom`: **Integer** . optional
134
+ - `payload.memoryType`: **String** . optional
135
+ - `payload.withMediaOnly`: **Boolean** . optional
136
+
137
+ ## list_memory_tags
138
+
139
+ Summary:
140
+ Gets a list of all available memory tags.
141
+
142
+ Signature: `list_memory_tags(strSessionID:)`
143
+ Invocation: `MemoriClient::Engine::V2::Search.list_memory_tags(strSessionID:)`
144
+
145
+ HTTP API: GET /memori/v2/MemoryTags/{strSessionID}`
146
+
147
+ Parameters:
148
+
149
+ - `strSessionID`: **string** The session ID. required
150
+
151
+
data/doc/MemoriClient::Engine::V2::Session.md ADDED
@@ -0,0 +1,55 @@
1
+ # Module `MemoriClient::Engine::V2::Session`
2
+
3
+ ## open_session
4
+
5
+ Summary:
6
+ Initializes a new Dialog State Machine session for an existing Memori.
7
+
8
+ Signature: `open_session(payload: {})`
9
+ Invocation: `MemoriClient::Engine::V2::Session.open_session(payload: {})`
10
+
11
+ HTTP API: POST /memori/v2/Session`
12
+
13
+ Parameters:
14
+
15
+ - `payload`: **Hash** request payload. optional
16
+ - `payload.memoriID`: **String** . optional
17
+ - `payload.password`: **String** . optional
18
+ - `payload.recoveryTokens`: **Array** . optional
19
+ - `payload.tag`: **String** . optional
20
+ - `payload.pin`: **String** . optional
21
+ - `payload.initialContextVars`: **Object** . optional
22
+ - `payload.initialQuestion`: **String** . optional
23
+ - `payload.birthDate`: **String** . optional
24
+ - `payload.maintenanceCode`: **String** . optional
25
+ - `payload.additionalInfo`: **Object** . optional
26
+
27
+ ## get_current_state
28
+
29
+ Summary:
30
+ Returns the current state of a session's Dialog State Machine.
31
+
32
+ Signature: `get_current_state(strSessionID:)`
33
+ Invocation: `MemoriClient::Engine::V2::Session.get_current_state(strSessionID:)`
34
+
35
+ HTTP API: GET /memori/v2/Session/{strSessionID}`
36
+
37
+ Parameters:
38
+
39
+ - `strSessionID`: **string** The session ID. required
40
+
41
+ ## close_session
42
+
43
+ Summary:
44
+ Closes the session and disposes of its Dialog State Machine.
45
+
46
+ Signature: `close_session(strSessionID:)`
47
+ Invocation: `MemoriClient::Engine::V2::Session.close_session(strSessionID:)`
48
+
49
+ HTTP API: DELETE /memori/v2/Session/{strSessionID}`
50
+
51
+ Parameters:
52
+
53
+ - `strSessionID`: **string** The session ID. required
54
+
55
+
data/doc/MemoriClient::Engine::V2::Stat.md ADDED
@@ -0,0 +1,18 @@
1
+ # Module `MemoriClient::Engine::V2::Stat`
2
+
3
+ ## get_text_quality_indexes
4
+
5
+ Summary:
6
+ Computes text quality indexes for a Memori.
7
+
8
+ Signature: `get_text_quality_indexes(strSessionID:, strLatestUpdate: nil)`
9
+ Invocation: `MemoriClient::Engine::V2::Stat.get_text_quality_indexes(strSessionID:, strLatestUpdate: nil)`
10
+
11
+ HTTP API: GET /memori/v2/TextQualityIndexes/{strSessionID}/{strLatestUpdate}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `strLatestUpdate`: **string** The optional latest update timestamp, in UTC time, in the format yyyyMMddHHmmssfff. optional
17
+
18
+