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::ChatLog.md ADDED
@@ -0,0 +1,82 @@
1
+ # Module `MemoriClient::Engine::V2::ChatLog`
2
+
3
+ ## list_memori_chat_logs
4
+
5
+ Summary:
6
+ Gets the Chat Log objects for the Memori of the current session record in a specific date interval.
7
+
8
+ Signature: `list_memori_chat_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
9
+ Invocation: `MemoriClient::Engine::V2::ChatLog.list_memori_chat_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
10
+
11
+ HTTP API: GET /memori/v2/ChatLogs/{strSessionID}/{strDateFrom}/{strDateTo}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
17
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
18
+
19
+ ## remove_chat_logs
20
+
21
+ Summary:
22
+ Removes all Chat Log objects in a specific date interval.
23
+
24
+ Signature: `remove_chat_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
25
+ Invocation: `MemoriClient::Engine::V2::ChatLog.remove_chat_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
26
+
27
+ HTTP API: DELETE /memori/v2/ChatLogs/{strSessionID}/{strDateFrom}/{strDateTo}`
28
+
29
+ Parameters:
30
+
31
+ - `strSessionID`: **string** The session ID. required
32
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
33
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
34
+
35
+ ## list_session_chat_logs
36
+
37
+ Summary:
38
+ Gets the Chat Log objects for the Memori of the current session recorded during a specific other session.
39
+
40
+ Signature: `list_session_chat_logs(strSessionID:, strChatLogSessionID:)`
41
+ Invocation: `MemoriClient::Engine::V2::ChatLog.list_session_chat_logs(strSessionID:, strChatLogSessionID:)`
42
+
43
+ HTTP API: GET /memori/v2/SessionChatLogs/{strSessionID}/{strChatLogSessionID}`
44
+
45
+ Parameters:
46
+
47
+ - `strSessionID`: **string** The session ID. required
48
+ - `strChatLogSessionID`: **string** The session ID for which Chat Log objects are being searched. required
49
+
50
+ ## list_user_chat_logs
51
+
52
+ Summary:
53
+ Gets the Chat Log objects for the Memori of the current session created by a specific User.
54
+
55
+ Signature: `list_user_chat_logs(strSessionID:, strUserID:, strDateFrom: nil, strDateTo: nil)`
56
+ Invocation: `MemoriClient::Engine::V2::ChatLog.list_user_chat_logs(strSessionID:, strUserID:, strDateFrom: nil, strDateTo: nil)`
57
+
58
+ HTTP API: GET /memori/v2/UserChatLogs/{strSessionID}/{strUserID}/{strDateFrom}/{strDateTo}`
59
+
60
+ Parameters:
61
+
62
+ - `strSessionID`: **string** The session ID. required
63
+ - `strUserID`: **string** The user ID for which Chat Log objects are being searched. required
64
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
65
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
66
+
67
+ ## remove_chat_log
68
+
69
+ Summary:
70
+ Removes an existing Chat Log object.
71
+
72
+ Signature: `remove_chat_log(strSessionID:, strChatLogID:)`
73
+ Invocation: `MemoriClient::Engine::V2::ChatLog.remove_chat_log(strSessionID:, strChatLogID:)`
74
+
75
+ HTTP API: DELETE /memori/v2/ChatLog/{strSessionID}/{strChatLogID}`
76
+
77
+ Parameters:
78
+
79
+ - `strSessionID`: **string** The session ID. required
80
+ - `strChatLogID`: **string** The Chat Log object ID. required
81
+
82
+
data/doc/MemoriClient::Engine::V2::ContextVar.md ADDED
@@ -0,0 +1,46 @@
1
+ # Module `MemoriClient::Engine::V2::ContextVar`
2
+
3
+ ## get_context_var_names
4
+
5
+ Summary:
6
+ Gets a list of currently known context variable names.
7
+
8
+ Signature: `get_context_var_names(strSessionID:)`
9
+ Invocation: `MemoriClient::Engine::V2::ContextVar.get_context_var_names(strSessionID:)`
10
+
11
+ HTTP API: GET /memori/v2/ContextVarNames/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+
17
+ ## get_context_var_values
18
+
19
+ Summary:
20
+ Gets a list of currently known values for a named context variable.
21
+
22
+ Signature: `get_context_var_values(strSessionID:, contextVarName:)`
23
+ Invocation: `MemoriClient::Engine::V2::ContextVar.get_context_var_values(strSessionID:, contextVarName:)`
24
+
25
+ HTTP API: GET /memori/v2/ContextVarValues/{strSessionID}/{contextVarName}`
26
+
27
+ Parameters:
28
+
29
+ - `strSessionID`: **string** The session ID. required
30
+ - `contextVarName`: **string** The name of the context variable. required
31
+
32
+ ## get_context_vars
33
+
34
+ Summary:
35
+ Gets a dictionary of all the known values of known context variables.
36
+
37
+ Signature: `get_context_vars(strSessionID:)`
38
+ Invocation: `MemoriClient::Engine::V2::ContextVar.get_context_vars(strSessionID:)`
39
+
40
+ HTTP API: GET /memori/v2/ContextVars/{strSessionID}`
41
+
42
+ Parameters:
43
+
44
+ - `strSessionID`: **string** The session ID. required
45
+
46
+
data/doc/MemoriClient::Engine::V2::CorrelationPair.md ADDED
@@ -0,0 +1,72 @@
1
+ # Module `MemoriClient::Engine::V2::CorrelationPair`
2
+
3
+ ## list_correlation_pairs
4
+
5
+ Summary:
6
+ Lists all Correlation Pair objects.
7
+
8
+ Signature: `list_correlation_pairs(strSessionID:)`
9
+ Invocation: `MemoriClient::Engine::V2::CorrelationPair.list_correlation_pairs(strSessionID:)`
10
+
11
+ HTTP API: GET /memori/v2/CorrelationPairs/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+
17
+ ## list_correlation_pairs_paginated
18
+
19
+ Summary:
20
+ Lists Correlation Pair objects with pagination.
21
+
22
+ Signature: `list_correlation_pairs_paginated(strSessionID:, from:, howMany:)`
23
+ Invocation: `MemoriClient::Engine::V2::CorrelationPair.list_correlation_pairs_paginated(strSessionID:, from:, howMany:)`
24
+
25
+ HTTP API: GET /memori/v2/CorrelationPairs/{strSessionID}/{from}/{howMany}`
26
+
27
+ Parameters:
28
+
29
+ - `strSessionID`: **string** The session ID. required
30
+ - `from`: **integer** The 0-based index of the first Correlation Pair object to list. required
31
+ - `howMany`: **integer** The number of the Correlation Pair objects to list. required
32
+
33
+ ## add_correlation_pair
34
+
35
+ Summary:
36
+ Adds a new Correlation Pair object.
37
+
38
+ Signature: `add_correlation_pair(strSessionID:, payload: {})`
39
+ Invocation: `MemoriClient::Engine::V2::CorrelationPair.add_correlation_pair(strSessionID:, payload: {})`
40
+
41
+ HTTP API: POST /memori/v2/CorrelationPair/{strSessionID}`
42
+
43
+ Parameters:
44
+
45
+ - `strSessionID`: **string** The session ID. required
46
+ - `payload`: **Hash** request payload. optional
47
+ - `payload.pairID`: **String** . optional
48
+ - `payload.text1`: **String** . optional
49
+ - `payload.text2`: **String** . optional
50
+ - `payload.correlated`: **Boolean** . optional
51
+ - `payload.occurrences`: **Integer** . optional
52
+ - `payload.creationTimestamp`: **String** . optional
53
+ - `payload.creationSessionID`: **String** . optional
54
+ - `payload.lastChangeTimestamp`: **String** . optional
55
+ - `payload.lastChangeSessionID`: **String** . optional
56
+
57
+ ## remove_correlation_pair
58
+
59
+ Summary:
60
+ Removes an existing Correlation Pair object.
61
+
62
+ Signature: `remove_correlation_pair(strSessionID:, strPairID:)`
63
+ Invocation: `MemoriClient::Engine::V2::CorrelationPair.remove_correlation_pair(strSessionID:, strPairID:)`
64
+
65
+ HTTP API: DELETE /memori/v2/CorrelationPair/{strSessionID}/{strPairID}`
66
+
67
+ Parameters:
68
+
69
+ - `strSessionID`: **string** The session ID. required
70
+ - `strPairID`: **string** The Correlation Pair object ID. required
71
+
72
+
data/doc/MemoriClient::Engine::V2::CustomDictionary.md ADDED
@@ -0,0 +1,108 @@
1
+ # Module `MemoriClient::Engine::V2::CustomDictionary`
2
+
3
+ ## list_custom_words
4
+
5
+ Summary:
6
+ Lists all Custom Word objects.
7
+
8
+ Signature: `list_custom_words(strSessionID:)`
9
+ Invocation: `MemoriClient::Engine::V2::CustomDictionary.list_custom_words(strSessionID:)`
10
+
11
+ HTTP API: GET /memori/v2/CustomWords/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+
17
+ ## list_custom_words_paginated
18
+
19
+ Summary:
20
+ Lists Custom Word objects with pagination.
21
+
22
+ Signature: `list_custom_words_paginated(strSessionID:, from:, howMany:)`
23
+ Invocation: `MemoriClient::Engine::V2::CustomDictionary.list_custom_words_paginated(strSessionID:, from:, howMany:)`
24
+
25
+ HTTP API: GET /memori/v2/CustomWords/{strSessionID}/{from}/{howMany}`
26
+
27
+ Parameters:
28
+
29
+ - `strSessionID`: **string** The session ID. required
30
+ - `from`: **integer** The 0-based index of the first Custom Word to list. required
31
+ - `howMany`: **integer** The number of the Custom Word to list. required
32
+
33
+ ## get_custom_word
34
+
35
+ Summary:
36
+ Gets the details of a Custom Word object.
37
+
38
+ Signature: `get_custom_word(strSessionID:, strCustomWordID:)`
39
+ Invocation: `MemoriClient::Engine::V2::CustomDictionary.get_custom_word(strSessionID:, strCustomWordID:)`
40
+
41
+ HTTP API: GET /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}`
42
+
43
+ Parameters:
44
+
45
+ - `strSessionID`: **string** The session ID. required
46
+ - `strCustomWordID`: **string** The Custom Word object ID. required
47
+
48
+ ## update_custom_word
49
+
50
+ Summary:
51
+ Updates an existing Custom Word object.
52
+
53
+ Signature: `update_custom_word(strSessionID:, strCustomWordID:, payload: {})`
54
+ Invocation: `MemoriClient::Engine::V2::CustomDictionary.update_custom_word(strSessionID:, strCustomWordID:, payload: {})`
55
+
56
+ HTTP API: PATCH /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}`
57
+
58
+ Parameters:
59
+
60
+ - `strSessionID`: **string** The session ID. required
61
+ - `strCustomWordID`: **string** The Custom Word object ID. required
62
+ - `payload`: **Hash** request payload. optional
63
+ - `payload.customWordID`: **String** . optional
64
+ - `payload.word`: **String** . optional
65
+ - `payload.definition`: **String** . optional
66
+ - `payload.creationTimestamp`: **String** . optional
67
+ - `payload.creationSessionID`: **String** . optional
68
+ - `payload.lastChangeTimestamp`: **String** . optional
69
+ - `payload.lastChangeSessionID`: **String** . optional
70
+
71
+ ## remove_custom_word
72
+
73
+ Summary:
74
+ Removes an existing Custom Word object.
75
+
76
+ Signature: `remove_custom_word(strSessionID:, strCustomWordID:)`
77
+ Invocation: `MemoriClient::Engine::V2::CustomDictionary.remove_custom_word(strSessionID:, strCustomWordID:)`
78
+
79
+ HTTP API: DELETE /memori/v2/CustomWord/{strSessionID}/{strCustomWordID}`
80
+
81
+ Parameters:
82
+
83
+ - `strSessionID`: **string** The session ID. required
84
+ - `strCustomWordID`: **string** The Custom Word object ID. required
85
+
86
+ ## add_custom_word
87
+
88
+ Summary:
89
+ Adds a new Custom Word object.
90
+
91
+ Signature: `add_custom_word(strSessionID:, payload: {})`
92
+ Invocation: `MemoriClient::Engine::V2::CustomDictionary.add_custom_word(strSessionID:, payload: {})`
93
+
94
+ HTTP API: POST /memori/v2/CustomWord/{strSessionID}`
95
+
96
+ Parameters:
97
+
98
+ - `strSessionID`: **string** The session ID. required
99
+ - `payload`: **Hash** request payload. optional
100
+ - `payload.customWordID`: **String** . optional
101
+ - `payload.word`: **String** . optional
102
+ - `payload.definition`: **String** . optional
103
+ - `payload.creationTimestamp`: **String** . optional
104
+ - `payload.creationSessionID`: **String** . optional
105
+ - `payload.lastChangeTimestamp`: **String** . optional
106
+ - `payload.lastChangeSessionID`: **String** . optional
107
+
108
+
data/doc/MemoriClient::Engine::V2::Dialog.md ADDED
@@ -0,0 +1,152 @@
1
+ # Module `MemoriClient::Engine::V2::Dialog`
2
+
3
+ ## enter_text
4
+
5
+ Summary:
6
+ Submits a Text Entered event to the session's Dialog State Machine.
7
+
8
+ Signature: `enter_text(strSessionID:, payload: {})`
9
+ Invocation: `MemoriClient::Engine::V2::Dialog.enter_text(strSessionID:, payload: {})`
10
+
11
+ HTTP API: POST /memori/v2/TextEnteredEvent/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `payload`: **Hash** request payload. optional
17
+ - `payload.text`: **String** . optional
18
+
19
+ ## change_date
20
+
21
+ Summary:
22
+ Submits a Date Changed event to the session's Dialog State Machine.
23
+
24
+ Signature: `change_date(strSessionID:, payload: {})`
25
+ Invocation: `MemoriClient::Engine::V2::Dialog.change_date(strSessionID:, payload: {})`
26
+
27
+ HTTP API: POST /memori/v2/DateChangedEvent/{strSessionID}`
28
+
29
+ Parameters:
30
+
31
+ - `strSessionID`: **string** The session ID. required
32
+ - `payload`: **Hash** request payload. optional
33
+ - `payload.date`: **String** . optional
34
+
35
+ ## change_place
36
+
37
+ Summary:
38
+ Submits a Place Changed event to the session's Dialog State Machine.
39
+
40
+ Signature: `change_place(strSessionID:, payload: {})`
41
+ Invocation: `MemoriClient::Engine::V2::Dialog.change_place(strSessionID:, payload: {})`
42
+
43
+ HTTP API: POST /memori/v2/PlaceChangedEvent/{strSessionID}`
44
+
45
+ Parameters:
46
+
47
+ - `strSessionID`: **string** The session ID. required
48
+ - `payload`: **Hash** request payload. optional
49
+ - `payload.placeName`: **String** . optional
50
+ - `payload.latitude`: **Number** . optional
51
+ - `payload.longitude`: **Number** . optional
52
+ - `payload.uncertaintyKm`: **Number** . optional
53
+
54
+ ## change_tag
55
+
56
+ Summary:
57
+ Submits a Tag Changed event to the session's Dialog State Machine.
58
+
59
+ Signature: `change_tag(strSessionID:, payload: {})`
60
+ Invocation: `MemoriClient::Engine::V2::Dialog.change_tag(strSessionID:, payload: {})`
61
+
62
+ HTTP API: POST /memori/v2/TagChangedEvent/{strSessionID}`
63
+
64
+ Parameters:
65
+
66
+ - `strSessionID`: **string** The session ID. required
67
+ - `payload`: **Hash** request payload. optional
68
+ - `payload.tag`: **String** . optional
69
+
70
+ ## timeout
71
+
72
+ Summary:
73
+ Submits a Timeout event to the session's Dialog State Machine.
74
+
75
+ Signature: `timeout(strSessionID:)`
76
+ Invocation: `MemoriClient::Engine::V2::Dialog.timeout(strSessionID:)`
77
+
78
+ HTTP API: POST /memori/v2/TimeoutEvent/{strSessionID}`
79
+
80
+ Parameters:
81
+
82
+ - `strSessionID`: **string** The session ID. required
83
+
84
+ ## select_medium
85
+
86
+ Summary:
87
+ Submits a Medium Selected event to the session's Dialog State Machine.
88
+
89
+ Signature: `select_medium(strSessionID:, payload: {})`
90
+ Invocation: `MemoriClient::Engine::V2::Dialog.select_medium(strSessionID:, payload: {})`
91
+
92
+ HTTP API: POST /memori/v2/MediumSelectedEvent/{strSessionID}`
93
+
94
+ Parameters:
95
+
96
+ - `strSessionID`: **string** The session ID. required
97
+ - `payload`: **Hash** request payload. optional
98
+ - `payload.medium`: **** . optional
99
+
100
+ ## select_date
101
+
102
+ Summary:
103
+ Submits a Date Selected event to the session's Dialog State Machine.
104
+
105
+ Signature: `select_date(strSessionID:, payload: {})`
106
+ Invocation: `MemoriClient::Engine::V2::Dialog.select_date(strSessionID:, payload: {})`
107
+
108
+ HTTP API: POST /memori/v2/DateSelectedEvent/{strSessionID}`
109
+
110
+ Parameters:
111
+
112
+ - `strSessionID`: **string** The session ID. required
113
+ - `payload`: **Hash** request payload. optional
114
+ - `payload.date`: **String** . optional
115
+ - `payload.uncertaintyDays`: **Number** . optional
116
+
117
+ ## select_place
118
+
119
+ Summary:
120
+ Submits a Place Selected event to the session's Dialog State Machine.
121
+
122
+ Signature: `select_place(strSessionID:, payload: {})`
123
+ Invocation: `MemoriClient::Engine::V2::Dialog.select_place(strSessionID:, payload: {})`
124
+
125
+ HTTP API: POST /memori/v2/PlaceSelectedEvent/{strSessionID}`
126
+
127
+ Parameters:
128
+
129
+ - `strSessionID`: **string** The session ID. required
130
+ - `payload`: **Hash** request payload. optional
131
+ - `payload.placeName`: **String** . optional
132
+ - `payload.latitude`: **Number** . optional
133
+ - `payload.longitude`: **Number** . optional
134
+ - `payload.uncertaintyKm`: **Number** . optional
135
+
136
+ ## select_tag
137
+
138
+ Summary:
139
+ Submits a Tag Selected event to the session's Dialog State Machine.
140
+
141
+ Signature: `select_tag(strSessionID:, payload: {})`
142
+ Invocation: `MemoriClient::Engine::V2::Dialog.select_tag(strSessionID:, payload: {})`
143
+
144
+ HTTP API: POST /memori/v2/TagSelectedEvent/{strSessionID}`
145
+
146
+ Parameters:
147
+
148
+ - `strSessionID`: **string** The session ID. required
149
+ - `payload`: **Hash** request payload. optional
150
+ - `payload.tag`: **String** . optional
151
+
152
+
data/doc/MemoriClient::Engine::V2::EventLog.md ADDED
@@ -0,0 +1,85 @@
1
+ # Module `MemoriClient::Engine::V2::EventLog`
2
+
3
+ ## list_memori_event_logs
4
+
5
+ Summary:
6
+ Gets the Event Log objects for the Memori of the current session in a specific date interval.
7
+
8
+ Signature: `list_memori_event_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
9
+ Invocation: `MemoriClient::Engine::V2::EventLog.list_memori_event_logs(strSessionID:, strDateFrom: nil, strDateTo: nil)`
10
+
11
+ HTTP API: GET /memori/v2/EventLogs/{strSessionID}/{strDateFrom}/{strDateTo}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
17
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
18
+
19
+ ## list_memory_event_logs
20
+
21
+ Summary:
22
+ Gets the Event Log objects for a specific Memory object in a specific date interval.
23
+
24
+ Signature: `list_memory_event_logs(strSessionID:, strMemoryID:, strDateFrom: nil, strDateTo: nil)`
25
+ Invocation: `MemoriClient::Engine::V2::EventLog.list_memory_event_logs(strSessionID:, strMemoryID:, strDateFrom: nil, strDateTo: nil)`
26
+
27
+ HTTP API: GET /memori/v2/MemoryEventLogs/{strSessionID}/{strMemoryID}/{strDateFrom}/{strDateTo}`
28
+
29
+ Parameters:
30
+
31
+ - `strSessionID`: **string** The session ID. required
32
+ - `strMemoryID`: **string** The Memory object ID. required
33
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
34
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
35
+
36
+ ## list_intent_event_logs
37
+
38
+ Summary:
39
+ Gets the Event Log objects for a specific Intent object in a specific date interval.
40
+
41
+ Signature: `list_intent_event_logs(strSessionID:, strIntentID:, strDateFrom: nil, strDateTo: nil)`
42
+ Invocation: `MemoriClient::Engine::V2::EventLog.list_intent_event_logs(strSessionID:, strIntentID:, strDateFrom: nil, strDateTo: nil)`
43
+
44
+ HTTP API: GET /memori/v2/IntentEventLogs/{strSessionID}/{strIntentID}/{strDateFrom}/{strDateTo}`
45
+
46
+ Parameters:
47
+
48
+ - `strSessionID`: **string** The session ID. required
49
+ - `strIntentID`: **string** The Intent object ID. required
50
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
51
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
52
+
53
+ ## list_session_event_logs
54
+
55
+ Summary:
56
+ Gets the Event Log objects for the Memori of the current session recorded during a specific other session.
57
+
58
+ Signature: `list_session_event_logs(strSessionID:, strEventLogSessionID:)`
59
+ Invocation: `MemoriClient::Engine::V2::EventLog.list_session_event_logs(strSessionID:, strEventLogSessionID:)`
60
+
61
+ HTTP API: GET /memori/v2/SessionEventLogs/{strSessionID}/{strEventLogSessionID}`
62
+
63
+ Parameters:
64
+
65
+ - `strSessionID`: **string** The session ID. required
66
+ - `strEventLogSessionID`: **string** The session ID for which Event Log objects are being searched. required
67
+
68
+ ## list_user_event_logs
69
+
70
+ Summary:
71
+ Gets the Event Log objects for the Memori of the current session created by a specific User.
72
+
73
+ Signature: `list_user_event_logs(strSessionID:, strUserID:, strDateFrom: nil, strDateTo: nil)`
74
+ Invocation: `MemoriClient::Engine::V2::EventLog.list_user_event_logs(strSessionID:, strUserID:, strDateFrom: nil, strDateTo: nil)`
75
+
76
+ HTTP API: GET /memori/v2/UserEventLogs/{strSessionID}/{strUserID}/{strDateFrom}/{strDateTo}`
77
+
78
+ Parameters:
79
+
80
+ - `strSessionID`: **string** The session ID. required
81
+ - `strUserID`: **string** The user ID for which Event Log objects are being searched. required
82
+ - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
83
+ - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
84
+
85
+
data/doc/MemoriClient::Engine::V2::ExpertReference.md ADDED
@@ -0,0 +1,116 @@
1
+ # Module `MemoriClient::Engine::V2::ExpertReference`
2
+
3
+ ## list_expert_references
4
+
5
+ Summary:
6
+ Lists all Expert Reference objects.
7
+
8
+ Signature: `list_expert_references(strSessionID:)`
9
+ Invocation: `MemoriClient::Engine::V2::ExpertReference.list_expert_references(strSessionID:)`
10
+
11
+ HTTP API: GET /memori/v2/ExpertReferences/{strSessionID}`
12
+
13
+ Parameters:
14
+
15
+ - `strSessionID`: **string** The session ID. required
16
+
17
+ ## list_expert_references_paginated
18
+
19
+ Summary:
20
+ Lists Expert Reference objects with pagination.
21
+
22
+ Signature: `list_expert_references_paginated(strSessionID:, from:, howMany:)`
23
+ Invocation: `MemoriClient::Engine::V2::ExpertReference.list_expert_references_paginated(strSessionID:, from:, howMany:)`
24
+
25
+ HTTP API: GET /memori/v2/ExpertReferences/{strSessionID}/{from}/{howMany}`
26
+
27
+ Parameters:
28
+
29
+ - `strSessionID`: **string** The session ID. required
30
+ - `from`: **integer** The 0-based index of the first Expert Reference object to list. required
31
+ - `howMany`: **integer** The number of the Expert Reference objects to list. required
32
+
33
+ ## get_expert_reference
34
+
35
+ Summary:
36
+ Gets the details of an Expert Reference object.
37
+
38
+ Signature: `get_expert_reference(strSessionID:, strExpertReferenceID:)`
39
+ Invocation: `MemoriClient::Engine::V2::ExpertReference.get_expert_reference(strSessionID:, strExpertReferenceID:)`
40
+
41
+ HTTP API: GET /memori/v2/ExpertReference/{strSessionID}/{strExpertReferenceID}`
42
+
43
+ Parameters:
44
+
45
+ - `strSessionID`: **string** The session ID. required
46
+ - `strExpertReferenceID`: **string** The Expert Reference object ID. required
47
+
48
+ ## update_expert_reference
49
+
50
+ Summary:
51
+ Updates an existing Expert Reference object.
52
+
53
+ Signature: `update_expert_reference(strSessionID:, strExpertReferenceID:, payload: {})`
54
+ Invocation: `MemoriClient::Engine::V2::ExpertReference.update_expert_reference(strSessionID:, strExpertReferenceID:, payload: {})`
55
+
56
+ HTTP API: PATCH /memori/v2/ExpertReference/{strSessionID}/{strExpertReferenceID}`
57
+
58
+ Parameters:
59
+
60
+ - `strSessionID`: **string** The session ID. required
61
+ - `strExpertReferenceID`: **string** The Expert Reference object ID. required
62
+ - `payload`: **Hash** request payload. optional
63
+ - `payload.expertID`: **String** . optional
64
+ - `payload.name`: **String** . optional
65
+ - `payload.description`: **String** . optional
66
+ - `payload.default`: **Boolean** . optional
67
+ - `payload.expertMemoriID`: **String** . optional
68
+ - `payload.expertPassword`: **String** . optional
69
+ - `payload.expertBaseURL`: **String** . optional
70
+ - `payload.creationTimestamp`: **String** . optional
71
+ - `payload.creationSessionID`: **String** . optional
72
+ - `payload.lastChangeTimestamp`: **String** . optional
73
+ - `payload.lastChangeSessionID`: **String** . optional
74
+
75
+ ## remove_expert_reference
76
+
77
+ Summary:
78
+ Removes an existing Expert Reference object.
79
+
80
+ Signature: `remove_expert_reference(strSessionID:, strExpertReferenceID:)`
81
+ Invocation: `MemoriClient::Engine::V2::ExpertReference.remove_expert_reference(strSessionID:, strExpertReferenceID:)`
82
+
83
+ HTTP API: DELETE /memori/v2/ExpertReference/{strSessionID}/{strExpertReferenceID}`
84
+
85
+ Parameters:
86
+
87
+ - `strSessionID`: **string** The session ID. required
88
+ - `strExpertReferenceID`: **string** The Expert Reference object ID. required
89
+
90
+ ## add_expert_reference
91
+
92
+ Summary:
93
+ Adds a new Expert Reference object.
94
+
95
+ Signature: `add_expert_reference(strSessionID:, payload: {})`
96
+ Invocation: `MemoriClient::Engine::V2::ExpertReference.add_expert_reference(strSessionID:, payload: {})`
97
+
98
+ HTTP API: POST /memori/v2/ExpertReference/{strSessionID}`
99
+
100
+ Parameters:
101
+
102
+ - `strSessionID`: **string** The session ID. required
103
+ - `payload`: **Hash** request payload. optional
104
+ - `payload.expertID`: **String** . optional
105
+ - `payload.name`: **String** . optional
106
+ - `payload.description`: **String** . optional
107
+ - `payload.default`: **Boolean** . optional
108
+ - `payload.expertMemoriID`: **String** . optional
109
+ - `payload.expertPassword`: **String** . optional
110
+ - `payload.expertBaseURL`: **String** . optional
111
+ - `payload.creationTimestamp`: **String** . optional
112
+ - `payload.creationSessionID`: **String** . optional
113
+ - `payload.lastChangeTimestamp`: **String** . optional
114
+ - `payload.lastChangeSessionID`: **String** . optional
115
+
116
+