memori-client 0.1.1 → 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 (41) 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 +244 -80
  11. data/lib/memori_client/backend/v2/integration.rb +95 -47
  12. data/lib/memori_client/backend/v2/invitation.rb +127 -61
  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 +2 -3
  20. data/lib/memori_client/engine/v2/chat_log.rb +51 -13
  21. data/lib/memori_client/engine/v2/context_var.rb +20 -10
  22. data/lib/memori_client/engine/v2/correlation_pair.rb +48 -23
  23. data/lib/memori_client/engine/v2/custom_dictionary.rb +74 -35
  24. data/lib/memori_client/engine/v2/dialog.rb +107 -57
  25. data/lib/memori_client/engine/v2/event_log.rb +54 -13
  26. data/lib/memori_client/engine/v2/expert_reference.rb +92 -45
  27. data/lib/memori_client/engine/v2/function.rb +220 -0
  28. data/lib/memori_client/engine/v2/intent.rb +175 -85
  29. data/lib/memori_client/engine/v2/localization_key.rb +72 -36
  30. data/lib/memori_client/engine/v2/medium.rb +92 -43
  31. data/lib/memori_client/engine/v2/memory.rb +341 -89
  32. data/lib/memori_client/engine/v2/nlp.rb +65 -128
  33. data/lib/memori_client/engine/v2/person.rb +88 -43
  34. data/lib/memori_client/engine/v2/search.rb +240 -52
  35. data/lib/memori_client/engine/v2/session.rb +41 -22
  36. data/lib/memori_client/engine/v2/stat.rb +8 -40
  37. data/lib/memori_client/engine/v2/topic.rb +88 -0
  38. data/lib/memori_client/engine/v2/unanswered_question.rb +54 -26
  39. data/lib/memori_client/engine/v2/user.rb +114 -14
  40. data/lib/memori_client/engine/v2/web_hook.rb +80 -34
  41. metadata +7 -2
@@ -1,47 +1,71 @@
1
- # Generated on 2024-01-18 17:37:07 +0000
1
+ # Generated on 2025-01-27 16:56:16 +0000
2
2
  class MemoriClient::Engine::V2::UnansweredQuestion < MemoriClient::Engine::Resource
3
- # GET /memori/v2/UnansweredQuestions/{strSessionID}
3
+ # `GET /memori/v2/UnansweredQuestions/{strSessionID}`
4
+ #
4
5
  # Lists all Unanswered Question objects.
5
- # Params list:
6
+ #
7
+ #
6
8
  # @param [string] strSessionID The session ID. required
7
- # list_unanswered_questions(strSessionID:)
9
+ #
10
+ # `list_unanswered_questions(strSessionID:)`
8
11
  def self.list_unanswered_questions(strSessionID:)
9
12
  args = build_arguments(binding)
10
13
 
11
14
  exec_http_request('get', '/memori/v2/UnansweredQuestions/{strSessionID}', **args)
12
15
  end
13
16
 
14
- # GET /memori/v2/UnansweredQuestions/{strSessionID}/{from}/{howMany}
17
+ # `GET /memori/v2/UnansweredQuestions/{strSessionID}/{from}/{howMany}`
18
+ #
15
19
  # Lists Unanswered Question objects with pagination.
16
- # Params list:
20
+ #
21
+ #
17
22
  # @param [string] strSessionID The session ID. required
23
+ #
18
24
  # @param [integer] from The 0-based index of the first Unanswered Question object to list. required
25
+ #
19
26
  # @param [integer] howMany The number of the Unanswered Question objects to list. required
20
- # list_unanswered_questions_paginated(strSessionID:, from:, howMany:)
27
+ #
28
+ # `list_unanswered_questions_paginated(strSessionID:, from:, howMany:)`
21
29
  def self.list_unanswered_questions_paginated(strSessionID:, from:, howMany:)
22
30
  args = build_arguments(binding)
23
31
 
24
32
  exec_http_request('get', '/memori/v2/UnansweredQuestions/{strSessionID}/{from}/{howMany}', **args)
25
33
  end
26
34
 
27
- # POST /memori/v2/UnansweredQuestion/{strSessionID}
35
+ # `POST /memori/v2/UnansweredQuestion/{strSessionID}`
36
+ #
28
37
  # Adds a new Unanswered Question object.
29
- # Params list:
38
+ #
39
+ #
30
40
  # @param [string] strSessionID The session ID. required
31
- # @param [object] payload request payload. optional
32
- # @param [string] payload.unansweredQuestionID . optional
33
- # @param [string] payload.text . optional
34
- # @param [object] payload.contextVars . optional
35
- # @param [integer] payload.occurrences . optional
36
- # @param [string] payload.receiverID . optional
37
- # @param [string] payload.receiverTag . optional
38
- # @param [string] payload.receiverName . optional
39
- # @param [array] payload.suggestions . optional
40
- # @param [string] payload.creationTimestamp . optional
41
- # @param [string] payload.creationSessionID . optional
42
- # @param [string] payload.lastChangeTimestamp . optional
43
- # @param [string] payload.lastChangeSessionID . optional
44
- # add_unanswered_question(strSessionID:, payload: {})
41
+ #
42
+ # @param [Hash] payload request payload. optional
43
+ #
44
+ # @param [String] payload.unansweredQuestionID . optional
45
+ #
46
+ # @param [String] payload.text . optional
47
+ #
48
+ # @param [Object] payload.contextVars . optional
49
+ #
50
+ # @param [Integer] payload.occurrences . optional
51
+ #
52
+ # @param [String] payload.receiverID . optional
53
+ #
54
+ # @param [String] payload.receiverTag . optional
55
+ #
56
+ # @param [String] payload.receiverName . optional
57
+ #
58
+ # @param [Array] payload.suggestions . optional
59
+ #
60
+ # @param [String] payload.creationTimestamp . optional
61
+ #
62
+ # @param [String] payload.creationSessionID . optional
63
+ #
64
+ # @param [String] payload.lastChangeTimestamp . optional
65
+ #
66
+ # @param [String] payload.lastChangeSessionID . optional
67
+ #
68
+ # `add_unanswered_question(strSessionID:, payload: {})`
45
69
  def self.add_unanswered_question(strSessionID:, payload: {})
46
70
  args = build_arguments(binding)
47
71
  payload_keys = [
@@ -64,12 +88,16 @@ class MemoriClient::Engine::V2::UnansweredQuestion < MemoriClient::Engine::Resou
64
88
  exec_http_request('post', '/memori/v2/UnansweredQuestion/{strSessionID}', **args)
65
89
  end
66
90
 
67
- # DELETE /memori/v2/UnansweredQuestion/{strSessionID}/{strUnansweredQuestionID}
91
+ # `DELETE /memori/v2/UnansweredQuestion/{strSessionID}/{strUnansweredQuestionID}`
92
+ #
68
93
  # Removes an existing Unanswered Question object.
69
- # Params list:
94
+ #
95
+ #
70
96
  # @param [string] strSessionID The session ID. required
97
+ #
71
98
  # @param [string] strUnansweredQuestionID The Unanswered Question object ID. required
72
- # remove_unanswered_question(strSessionID:, strUnansweredQuestionID:)
99
+ #
100
+ # `remove_unanswered_question(strSessionID:, strUnansweredQuestionID:)`
73
101
  def self.remove_unanswered_question(strSessionID:, strUnansweredQuestionID:)
74
102
  args = build_arguments(binding)
75
103
 
@@ -1,47 +1,147 @@
1
- # Generated on 2024-01-18 17:37:07 +0000
1
+ # Generated on 2025-01-27 16:56:16 +0000
2
2
  class MemoriClient::Engine::V2::User < MemoriClient::Engine::Resource
3
- # GET /memori/v2/KnownFacts/{strSessionID}
3
+ # `GET /memori/v2/Users/{strSessionID}`
4
+ #
5
+ # Lists all User objects associated with the Memori of the current session.
6
+ #
7
+ #
8
+ # @param [string] strSessionID The session ID. required
9
+ #
10
+ # `list_users(strSessionID:)`
11
+ def self.list_users(strSessionID:)
12
+ args = build_arguments(binding)
13
+
14
+ exec_http_request('get', '/memori/v2/Users/{strSessionID}', **args)
15
+ end
16
+
17
+ # `GET /memori/v2/Users/{strSessionID}/{from}/{howMany}`
18
+ #
19
+ # Lists User objects associated with the Memori of the current session, with pagination.
20
+ #
21
+ #
22
+ # @param [string] strSessionID The session ID. required
23
+ #
24
+ # @param [integer] from The 0-based index of the first User to list. required
25
+ #
26
+ # @param [integer] howMany The number of User objects to list. required
27
+ #
28
+ # `list_users_paginated(strSessionID:, from:, howMany:)`
29
+ def self.list_users_paginated(strSessionID:, from:, howMany:)
30
+ args = build_arguments(binding)
31
+
32
+ exec_http_request('get', '/memori/v2/Users/{strSessionID}/{from}/{howMany}', **args)
33
+ end
34
+
35
+ # `GET /memori/v2/User/{strSessionID}/{strUserID}`
36
+ #
37
+ # Gets the details of a User object.
38
+ #
39
+ #
40
+ # @param [string] strSessionID The session ID. required
41
+ #
42
+ # @param [string] strUserID The User object ID. required
43
+ #
44
+ # `get_user(strSessionID:, strUserID:)`
45
+ def self.get_user(strSessionID:, strUserID:)
46
+ args = build_arguments(binding)
47
+
48
+ exec_http_request('get', '/memori/v2/User/{strSessionID}/{strUserID}', **args)
49
+ end
50
+
51
+ # `GET /memori/v2/UserTopics/{strSessionID}/{strUserID}`
52
+ #
53
+ # Lists all Topic objects referenced by a specified User object.
54
+ #
55
+ #
56
+ # @param [string] strSessionID The session ID. required
57
+ #
58
+ # @param [string] strUserID The User object ID. required
59
+ #
60
+ # `list_user_topics(strSessionID:, strUserID:)`
61
+ def self.list_user_topics(strSessionID:, strUserID:)
62
+ args = build_arguments(binding)
63
+
64
+ exec_http_request('get', '/memori/v2/UserTopics/{strSessionID}/{strUserID}', **args)
65
+ end
66
+
67
+ # `GET /memori/v2/UserTopics/{strSessionID}/{strUserID}/{from}/{howMany}`
68
+ #
69
+ # Lists Topic objects referenced by a specified User object, with pagination.
70
+ #
71
+ #
72
+ # @param [string] strSessionID The session ID. required
73
+ #
74
+ # @param [string] strUserID The User object ID. required
75
+ #
76
+ # @param [integer] from The 0-based index of the first Topic object to list. required
77
+ #
78
+ # @param [integer] howMany The number of Topic objects to list. required
79
+ #
80
+ # `list_user_topics_paginated(strSessionID:, strUserID:, from:, howMany:)`
81
+ def self.list_user_topics_paginated(strSessionID:, strUserID:, from:, howMany:)
82
+ args = build_arguments(binding)
83
+
84
+ exec_http_request('get', '/memori/v2/UserTopics/{strSessionID}/{strUserID}/{from}/{howMany}', **args)
85
+ end
86
+
87
+ # `GET /memori/v2/KnownFacts/{strSessionID}`
88
+ #
4
89
  # Lists all Known Facts objects associated with the current User.
5
- # Params list:
90
+ #
91
+ #
6
92
  # @param [string] strSessionID The session ID. required
7
- # list_known_facts(strSessionID:)
93
+ #
94
+ # `list_known_facts(strSessionID:)`
8
95
  def self.list_known_facts(strSessionID:)
9
96
  args = build_arguments(binding)
10
97
 
11
98
  exec_http_request('get', '/memori/v2/KnownFacts/{strSessionID}', **args)
12
99
  end
13
100
 
14
- # GET /memori/v2/KnownFacts/{strSessionID}/{from}/{howMany}
101
+ # `GET /memori/v2/KnownFacts/{strSessionID}/{from}/{howMany}`
102
+ #
15
103
  # Lists Known Facts objects associated with the current User, with pagination.
16
- # Params list:
104
+ #
105
+ #
17
106
  # @param [string] strSessionID The session ID. required
107
+ #
18
108
  # @param [integer] from The 0-based index of the first Known Fact to list. required
19
- # @param [integer] howMany The number of the Known Fact to list. required
20
- # list_known_facts_paginated(strSessionID:, from:, howMany:)
109
+ #
110
+ # @param [integer] howMany The number of Known Fact objects to list. required
111
+ #
112
+ # `list_known_facts_paginated(strSessionID:, from:, howMany:)`
21
113
  def self.list_known_facts_paginated(strSessionID:, from:, howMany:)
22
114
  args = build_arguments(binding)
23
115
 
24
116
  exec_http_request('get', '/memori/v2/KnownFacts/{strSessionID}/{from}/{howMany}', **args)
25
117
  end
26
118
 
27
- # GET /memori/v2/KnownFact/{strSessionID}/{strKnownFactID}
119
+ # `GET /memori/v2/KnownFact/{strSessionID}/{strKnownFactID}`
120
+ #
28
121
  # Gets the details of a Known Fact object.
29
- # Params list:
122
+ #
123
+ #
30
124
  # @param [string] strSessionID The session ID. required
125
+ #
31
126
  # @param [string] strKnownFactID The Known Fact object ID. required
32
- # get_known_fact(strSessionID:, strKnownFactID:)
127
+ #
128
+ # `get_known_fact(strSessionID:, strKnownFactID:)`
33
129
  def self.get_known_fact(strSessionID:, strKnownFactID:)
34
130
  args = build_arguments(binding)
35
131
 
36
132
  exec_http_request('get', '/memori/v2/KnownFact/{strSessionID}/{strKnownFactID}', **args)
37
133
  end
38
134
 
39
- # DELETE /memori/v2/KnownFact/{strSessionID}/{strKnownFactID}
135
+ # `DELETE /memori/v2/KnownFact/{strSessionID}/{strKnownFactID}`
136
+ #
40
137
  # Deletes an existing Known Fact object.
41
- # Params list:
138
+ #
139
+ #
42
140
  # @param [string] strSessionID The session ID. required
141
+ #
43
142
  # @param [string] strKnownFactID The Known Fact object ID. required
44
- # delete_known_fact(strSessionID:, strKnownFactID:)
143
+ #
144
+ # `delete_known_fact(strSessionID:, strKnownFactID:)`
45
145
  def self.delete_known_fact(strSessionID:, strKnownFactID:)
46
146
  args = build_arguments(binding)
47
147
 
@@ -1,16 +1,25 @@
1
- # Generated on 2024-01-18 17:37:07 +0000
1
+ # Generated on 2025-01-27 16:56:16 +0000
2
2
  class MemoriClient::Engine::V2::WebHook < MemoriClient::Engine::Resource
3
- # POST /memori/v2/TestSlot
3
+ # `POST /memori/v2/TestSlot`
4
+ #
4
5
  # Returns test slot values.
5
- # Params list:
6
- # @param [object] payload request payload. optional
7
- # @param [string] payload.slotName . required
8
- # @param [integer] payload.requestID . required
9
- # @param [string] payload.requestDateTime . required
10
- # @param [number] payload.requestValidityMinutes . required
11
- # @param [string] payload.memoriID . required
12
- # @param [string] payload.culture . required
13
- # test_slot(payload: {})
6
+ #
7
+ #
8
+ # @param [Hash] payload request payload. optional
9
+ #
10
+ # @param [String] payload.slotName . optional
11
+ #
12
+ # @param [Integer] payload.requestID . optional
13
+ #
14
+ # @param [String] payload.requestDateTime . optional
15
+ #
16
+ # @param [Number] payload.requestValidityMinutes . optional
17
+ #
18
+ # @param [String] payload.memoriID . optional
19
+ #
20
+ # @param [String] payload.culture . optional
21
+ #
22
+ # `test_slot(payload: {})`
14
23
  def self.test_slot(payload: {})
15
24
  args = build_arguments(binding)
16
25
  payload_keys = [
@@ -21,35 +30,58 @@ class MemoriClient::Engine::V2::WebHook < MemoriClient::Engine::Resource
21
30
  'requestValidityMinutes',
22
31
  'slotName',
23
32
  ]
24
- payload_required_keys = %w[culture memoriID requestDateTime requestID requestValidityMinutes slotName]
33
+ payload_required_keys = %w[]
25
34
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
26
35
 
27
36
  exec_http_request('post', '/memori/v2/TestSlot', **args)
28
37
  end
29
38
 
30
- # POST /memori/v2/TestIntent
39
+ # `POST /memori/v2/TestIntent`
40
+ #
31
41
  # Returns test intent results.
32
- # Params list:
33
- # @param [object] payload request payload. optional
34
- # @param [string] payload.intentName . required
35
- # @param [string] payload.utterance . optional
36
- # @param [object] payload.slotValues . required
37
- # @param [string] payload.sessionID . required
38
- # @param [string] payload.currentTag . optional
39
- # @param [boolean] payload.currentTagAuthenticated . optional
40
- # @param [string] payload.currentDateUTC . optional
42
+ #
43
+ #
44
+ # @param [Hash] payload request payload. optional
45
+ #
46
+ # @param [String] payload.intentName . optional
47
+ #
48
+ # @param [String] payload.utterance . optional
49
+ #
50
+ # @param [Object] payload.slotValues . optional
51
+ #
52
+ # @param [String] payload.sessionID . optional
53
+ #
54
+ # @param [String] payload.currentTag . optional
55
+ #
56
+ # @param [Boolean] payload.currentTagAuthenticated . optional
57
+ #
58
+ # @param [String] payload.currentDateUTC . optional
59
+ #
41
60
  # @param [] payload.currentPlace . optional
42
- # @param [string] payload.timeZone . required
43
- # @param [string] payload.beginUTC . required
44
- # @param [string] payload.endUTC . required
45
- # @param [object] payload.contextVars . required
46
- # @param [array] payload.transitionHistory . required
47
- # @param [integer] payload.requestID . required
48
- # @param [string] payload.requestDateTime . required
49
- # @param [number] payload.requestValidityMinutes . required
50
- # @param [string] payload.memoriID . required
51
- # @param [string] payload.culture . required
52
- # test_intent(payload: {})
61
+ #
62
+ # @param [String] payload.timeZone . optional
63
+ #
64
+ # @param [String] payload.beginUTC . optional
65
+ #
66
+ # @param [String] payload.endUTC . optional
67
+ #
68
+ # @param [Object] payload.contextVars . optional
69
+ #
70
+ # @param [Array] payload.transitionHistory . optional
71
+ #
72
+ # @param [String] payload.userEmail . optional
73
+ #
74
+ # @param [Integer] payload.requestID . optional
75
+ #
76
+ # @param [String] payload.requestDateTime . optional
77
+ #
78
+ # @param [Number] payload.requestValidityMinutes . optional
79
+ #
80
+ # @param [String] payload.memoriID . optional
81
+ #
82
+ # @param [String] payload.culture . optional
83
+ #
84
+ # `test_intent(payload: {})`
53
85
  def self.test_intent(payload: {})
54
86
  args = build_arguments(binding)
55
87
  payload_keys = [
@@ -70,13 +102,27 @@ class MemoriClient::Engine::V2::WebHook < MemoriClient::Engine::Resource
70
102
  'slotValues',
71
103
  'timeZone',
72
104
  'transitionHistory',
105
+ 'userEmail',
73
106
  'utterance',
74
107
  ]
75
- payload_required_keys = %w[beginUTC contextVars culture endUTC intentName memoriID requestDateTime requestID requestValidityMinutes sessionID slotValues timeZone transitionHistory]
108
+ payload_required_keys = %w[]
76
109
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)
77
110
 
78
111
  exec_http_request('post', '/memori/v2/TestIntent', **args)
79
112
  end
80
113
 
114
+ # `GET /memori/v2/TestFunctions/RandomNumber`
115
+ #
116
+ # Test function: returns a random number between 0 and 999999.
117
+ #
118
+
119
+ #
120
+ # `test_function_random_number()`
121
+ def self.test_function_random_number()
122
+ args = build_arguments(binding)
123
+
124
+ exec_http_request('get', '/memori/v2/TestFunctions/RandomNumber', **args)
125
+ end
126
+
81
127
 
82
128
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: memori-client
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stefano Lampis
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-01-18 00:00:00.000000000 Z
11
+ date: 2025-01-27 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Memori Client to interact with Memori backend and engine API
14
14
  email: me@stefanolampis.com
@@ -21,8 +21,10 @@ files:
21
21
  - lib/memori_client/backend/resources.rb
22
22
  - lib/memori_client/backend/v1/asset.rb
23
23
  - lib/memori_client/backend/v2/action_log.rb
24
+ - lib/memori_client/backend/v2/analysis.rb
24
25
  - lib/memori_client/backend/v2/asset.rb
25
26
  - lib/memori_client/backend/v2/badge.rb
27
+ - lib/memori_client/backend/v2/completion_config.rb
26
28
  - lib/memori_client/backend/v2/consumption_log.rb
27
29
  - lib/memori_client/backend/v2/import_export.rb
28
30
  - lib/memori_client/backend/v2/integration.rb
@@ -30,6 +32,7 @@ files:
30
32
  - lib/memori_client/backend/v2/memori.rb
31
33
  - lib/memori_client/backend/v2/memori_list.rb
32
34
  - lib/memori_client/backend/v2/notification.rb
35
+ - lib/memori_client/backend/v2/process.rb
33
36
  - lib/memori_client/backend/v2/tenant.rb
34
37
  - lib/memori_client/backend/v2/user.rb
35
38
  - lib/memori_client/configuration.rb
@@ -43,6 +46,7 @@ files:
43
46
  - lib/memori_client/engine/v2/dialog.rb
44
47
  - lib/memori_client/engine/v2/event_log.rb
45
48
  - lib/memori_client/engine/v2/expert_reference.rb
49
+ - lib/memori_client/engine/v2/function.rb
46
50
  - lib/memori_client/engine/v2/intent.rb
47
51
  - lib/memori_client/engine/v2/localization_key.rb
48
52
  - lib/memori_client/engine/v2/medium.rb
@@ -54,6 +58,7 @@ files:
54
58
  - lib/memori_client/engine/v2/search.rb
55
59
  - lib/memori_client/engine/v2/session.rb
56
60
  - lib/memori_client/engine/v2/stat.rb
61
+ - lib/memori_client/engine/v2/topic.rb
57
62
  - lib/memori_client/engine/v2/unanswered_question.rb
58
63
  - lib/memori_client/engine/v2/user.rb
59
64
  - lib/memori_client/engine/v2/web_hook.rb