memori-client 0.1.6 → 0.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. checksums.yaml +4 -4
  2. data/doc/MemoriClient::Backend::V1::Asset.md +117 -0
  3. data/doc/MemoriClient::Backend::V2::ActionLog.md +37 -0
  4. data/doc/MemoriClient::Backend::V2::Analysis.md +39 -0
  5. data/doc/MemoriClient::Backend::V2::Asset.md +102 -0
  6. data/doc/MemoriClient::Backend::V2::Badge.md +64 -0
  7. data/doc/MemoriClient::Backend::V2::CompletionConfig.md +115 -0
  8. data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +57 -0
  9. data/doc/MemoriClient::Backend::V2::ImportExport.md +180 -0
  10. data/doc/MemoriClient::Backend::V2::Integration.md +117 -0
  11. data/doc/MemoriClient::Backend::V2::Invitation.md +179 -0
  12. data/doc/MemoriClient::Backend::V2::Memori.md +394 -0
  13. data/doc/MemoriClient::Backend::V2::MemoriList.md +147 -0
  14. data/doc/MemoriClient::Backend::V2::Notification.md +31 -0
  15. data/doc/MemoriClient::Backend::V2::Process.md +64 -0
  16. data/doc/MemoriClient::Backend::V2::Tenant.md +142 -0
  17. data/doc/MemoriClient::Backend::V2::User.md +647 -0
  18. data/doc/MemoriClient::Engine::V2::ChatLog.md +82 -0
  19. data/doc/MemoriClient::Engine::V2::ContextVar.md +46 -0
  20. data/doc/MemoriClient::Engine::V2::CorrelationPair.md +72 -0
  21. data/doc/MemoriClient::Engine::V2::CustomDictionary.md +108 -0
  22. data/doc/MemoriClient::Engine::V2::Dialog.md +152 -0
  23. data/doc/MemoriClient::Engine::V2::EventLog.md +85 -0
  24. data/doc/MemoriClient::Engine::V2::ExpertReference.md +116 -0
  25. data/doc/MemoriClient::Engine::V2::Function.md +140 -0
  26. data/doc/MemoriClient::Engine::V2::Intent.md +225 -0
  27. data/doc/MemoriClient::Engine::V2::LocalizationKey.md +105 -0
  28. data/doc/MemoriClient::Engine::V2::Medium.md +118 -0
  29. data/doc/MemoriClient::Engine::V2::Memory.md +244 -0
  30. data/doc/MemoriClient::Engine::V2::NLP.md +100 -0
  31. data/doc/MemoriClient::Engine::V2::Person.md +114 -0
  32. data/doc/MemoriClient::Engine::V2::Search.md +151 -0
  33. data/doc/MemoriClient::Engine::V2::Session.md +55 -0
  34. data/doc/MemoriClient::Engine::V2::Stat.md +18 -0
  35. data/doc/MemoriClient::Engine::V2::Topic.md +80 -0
  36. data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +75 -0
  37. data/doc/MemoriClient::Engine::V2::User.md +140 -0
  38. data/doc/MemoriClient::Engine::V2::WebHook.md +67 -0
  39. data/lib/memori_client/railtie.rb +12 -0
  40. data/lib/memori_client/utils/rails.rb +54 -0
  41. data/lib/memori_client.rb +7 -0
  42. data/lib/tasks/memori_client.rake +15 -0
  43. metadata +42 -2
data/doc/MemoriClient::Backend::V2::ImportExport.md ADDED
@@ -0,0 +1,180 @@
1
+ # Module `MemoriClient::Backend::V2::ImportExport`
2
+
3
+ ## import_csv
4
+
5
+ Summary:
6
+ Starts an Import process for memories from a CSV file.
7
+
8
+ Signature: `import_csv(strToken:, strMemoriID:, payload: {})`
9
+ Invocation: `MemoriClient::Backend::V2::ImportExport.import_csv(strToken:, strMemoriID:, payload: {})`
10
+
11
+ HTTP API: POST /api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}`
12
+
13
+ Parameters:
14
+
15
+ - `strToken`: **string** The login token. required
16
+ - `strMemoriID`: **string** The ID of the Memori object. required
17
+ - `payload`: **Hash** request payload. optional
18
+ - `payload.csvSpecs`: **** . optional
19
+ - `payload.conclusive`: **Boolean** . optional
20
+ - `payload.notPickable`: **Boolean** . optional
21
+ - `payload.contextVarsToSet`: **Object** . optional
22
+ - `payload.contextVarsToMatch`: **Object** . optional
23
+ - `payload.memoryTags`: **Array** . optional
24
+ - `payload.receiverID`: **String** . optional
25
+ - `payload.addMediaLink`: **String** . optional
26
+ - `payload.linkTitleHandling`: **String** . optional
27
+ - `payload.linkTitle`: **String** . optional
28
+ - `payload.rows`: **Array** . optional
29
+ - `payload.importName`: **String** . optional
30
+ - `payload.forceImport`: **Boolean** . optional
31
+ - `payload.notes`: **String** . optional
32
+
33
+ ## import_txt
34
+
35
+ Summary:
36
+ Starts an Import process for memories from a TXT file.
37
+
38
+ Signature: `import_txt(strToken:, strMemoriID:, payload: {})`
39
+ Invocation: `MemoriClient::Backend::V2::ImportExport.import_txt(strToken:, strMemoriID:, payload: {})`
40
+
41
+ HTTP API: POST /api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}`
42
+
43
+ Parameters:
44
+
45
+ - `strToken`: **string** The login token. required
46
+ - `strMemoriID`: **string** The ID of the Memori object. required
47
+ - `payload`: **Hash** request payload. optional
48
+ - `payload.txtSpecs`: **** . optional
49
+ - `payload.conclusive`: **Boolean** . optional
50
+ - `payload.notPickable`: **Boolean** . optional
51
+ - `payload.contextVarsToSet`: **Object** . optional
52
+ - `payload.contextVarsToMatch`: **Object** . optional
53
+ - `payload.memoryTags`: **Array** . optional
54
+ - `payload.receiverID`: **String** . optional
55
+ - `payload.addMediaLink`: **String** . optional
56
+ - `payload.linkTitleHandling`: **String** . optional
57
+ - `payload.linkTitle`: **String** . optional
58
+ - `payload.rows`: **Array** . optional
59
+ - `payload.importName`: **String** . optional
60
+ - `payload.forceImport`: **Boolean** . optional
61
+ - `payload.notes`: **String** . optional
62
+
63
+ ## import_functions_intents
64
+
65
+ Summary:
66
+ Starts an Import process for functions and intents from a jsonl file.
67
+
68
+ Signature: `import_functions_intents(strToken:, strMemoriID:, payload: {})`
69
+ Invocation: `MemoriClient::Backend::V2::ImportExport.import_functions_intents(strToken:, strMemoriID:, payload: {})`
70
+
71
+ HTTP API: POST /api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID}`
72
+
73
+ Parameters:
74
+
75
+ - `strToken`: **string** The login token. required
76
+ - `strMemoriID`: **string** The ID of the Memori object. required
77
+ - `payload`: **Hash** request payload. optional
78
+ - `payload.rows`: **Array** . optional
79
+ - `payload.importName`: **String** . optional
80
+ - `payload.forceImport`: **Boolean** . optional
81
+ - `payload.notes`: **String** . optional
82
+
83
+ ## export_csv
84
+
85
+ Summary:
86
+ Exports contents of a Memori object to a CSV file.
87
+
88
+ Signature: `export_csv(strToken:, strMemoriID:, payload: {})`
89
+ Invocation: `MemoriClient::Backend::V2::ImportExport.export_csv(strToken:, strMemoriID:, payload: {})`
90
+
91
+ HTTP API: POST /api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}`
92
+
93
+ Parameters:
94
+
95
+ - `strToken`: **string** The login token. required
96
+ - `strMemoriID`: **string** The ID of the Memori object. required
97
+ - `payload`: **Hash** request payload. optional
98
+ - `payload.csvSpecs`: **** . optional
99
+ - `payload.password`: **String** . optional
100
+
101
+ ## export_jsonl
102
+
103
+ Summary:
104
+ Exports contents of a Memori object to a JSONL file, suitable for fine-tuning with generative AI platforms.
105
+
106
+ Signature: `export_jsonl(strToken:, strMemoriID:, payload: {})`
107
+ Invocation: `MemoriClient::Backend::V2::ImportExport.export_jsonl(strToken:, strMemoriID:, payload: {})`
108
+
109
+ HTTP API: POST /api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}`
110
+
111
+ Parameters:
112
+
113
+ - `strToken`: **string** The login token. required
114
+ - `strMemoriID`: **string** The ID of the Memori object. required
115
+ - `payload`: **Hash** request payload. optional
116
+ - `payload.jsonlSpecs`: **** . optional
117
+ - `payload.password`: **String** . optional
118
+
119
+ ## export_functions_intents
120
+
121
+ Summary:
122
+ Exports functions, intents and intentSlots of a Memori object to a JSONL file
123
+
124
+ Signature: `export_functions_intents(strToken:, strMemoriID:, payload: {})`
125
+ Invocation: `MemoriClient::Backend::V2::ImportExport.export_functions_intents(strToken:, strMemoriID:, payload: {})`
126
+
127
+ HTTP API: POST /api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID}`
128
+
129
+ Parameters:
130
+
131
+ - `strToken`: **string** The login token. required
132
+ - `strMemoriID`: **string** The ID of the Memori object. required
133
+ - `payload`: **Hash** request payload. optional
134
+ - `payload.exportFunctions`: **Boolean** . optional
135
+ - `payload.exportIntents`: **Boolean** . optional
136
+ - `payload.exportIntentSlots`: **Boolean** . optional
137
+ - `payload.functionsIds`: **Array** . optional
138
+ - `payload.intentsIds`: **Array** . optional
139
+ - `payload.intentSlotsIds`: **Array** . optional
140
+ - `payload.password`: **String** . optional
141
+
142
+ ## import_dictionary
143
+
144
+ Summary:
145
+ Imports a dictionary to a Memori object.
146
+
147
+ Signature: `import_dictionary(strToken:, strMemoriID:, payload: {})`
148
+ Invocation: `MemoriClient::Backend::V2::ImportExport.import_dictionary(strToken:, strMemoriID:, payload: {})`
149
+
150
+ HTTP API: POST /api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID}`
151
+
152
+ Parameters:
153
+
154
+ - `strToken`: **string** . required
155
+ - `strMemoriID`: **string** . required
156
+ - `payload`: **Hash** request payload. optional
157
+ - `payload.rows`: **Array** . optional
158
+ - `payload.importName`: **String** . optional
159
+ - `payload.forceImport`: **Boolean** . optional
160
+ - `payload.notes`: **String** . optional
161
+
162
+ ## export_dictionary
163
+
164
+ Summary:
165
+ Exports the dictionary of a Memori object to a JSONL file.
166
+
167
+ Signature: `export_dictionary(strToken:, strMemoriID:, payload: {})`
168
+ Invocation: `MemoriClient::Backend::V2::ImportExport.export_dictionary(strToken:, strMemoriID:, payload: {})`
169
+
170
+ HTTP API: POST /api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID}`
171
+
172
+ Parameters:
173
+
174
+ - `strToken`: **string** The login token. required
175
+ - `strMemoriID`: **string** The ID of the Memori object. required
176
+ - `payload`: **Hash** request payload. optional
177
+ - `payload.dictionarySpecs`: **** . optional
178
+ - `payload.password`: **String** . optional
179
+
180
+
data/doc/MemoriClient::Backend::V2::Integration.md ADDED
@@ -0,0 +1,117 @@
1
+ # Module `MemoriClient::Backend::V2::Integration`
2
+
3
+ ## list_integrations
4
+
5
+ Summary:
6
+ Gets a list of Integration objects for a specified Memori object.
7
+
8
+ Signature: `list_integrations(strToken:, strMemoriID:)`
9
+ Invocation: `MemoriClient::Backend::V2::Integration.list_integrations(strToken:, strMemoriID:)`
10
+
11
+ HTTP API: GET /api/v2/Integrations/{strToken}/{strMemoriID}`
12
+
13
+ Parameters:
14
+
15
+ - `strToken`: **string** The login token. required
16
+ - `strMemoriID`: **string** The ID of the Memori object. required
17
+
18
+ ## list_all_integrations
19
+
20
+ Summary:
21
+ Gets a list of all Integration objects.
22
+
23
+ Signature: `list_all_integrations(strToken:)`
24
+ Invocation: `MemoriClient::Backend::V2::Integration.list_all_integrations(strToken:)`
25
+
26
+ HTTP API: GET /api/v2/AllIntegrations/{strToken}`
27
+
28
+ Parameters:
29
+
30
+ - `strToken`: **string** The login token. required
31
+
32
+ ## get_integration
33
+
34
+ Summary:
35
+ Gets the details of an Integration object of the currently logged in User.
36
+
37
+ Signature: `get_integration(strToken:, strIntegrationID:)`
38
+ Invocation: `MemoriClient::Backend::V2::Integration.get_integration(strToken:, strIntegrationID:)`
39
+
40
+ HTTP API: GET /api/v2/Integration/{strToken}/{strIntegrationID}`
41
+
42
+ Parameters:
43
+
44
+ - `strToken`: **string** The login token. required
45
+ - `strIntegrationID`: **string** The ID of the Integration object. required
46
+
47
+ ## update_integration
48
+
49
+ Summary:
50
+ Updates an existing Integration object.
51
+
52
+ Signature: `update_integration(strToken:, strIntegrationID:, payload: {})`
53
+ Invocation: `MemoriClient::Backend::V2::Integration.update_integration(strToken:, strIntegrationID:, payload: {})`
54
+
55
+ HTTP API: PATCH /api/v2/Integration/{strToken}/{strIntegrationID}`
56
+
57
+ Parameters:
58
+
59
+ - `strToken`: **string** The login token. required
60
+ - `strIntegrationID`: **string** The Integration object ID. required
61
+ - `payload`: **Hash** request payload. optional
62
+ - `payload.integrationID`: **String** . optional
63
+ - `payload.memoriID`: **String** . optional
64
+ - `payload.type`: **String** . optional
65
+ - `payload.state`: **String** . optional
66
+ - `payload.deviceEmails`: **Array** . optional
67
+ - `payload.invocationText`: **String** . optional
68
+ - `payload.jobID`: **String** . optional
69
+ - `payload.customData`: **String** . optional
70
+ - `payload.resources`: **Array** . optional
71
+ - `payload.publish`: **Boolean** . optional
72
+ - `payload.creationTimestamp`: **String** . optional
73
+ - `payload.lastChangeTimestamp`: **String** . optional
74
+
75
+ ## delete_integration
76
+
77
+ Summary:
78
+ Deletes an existing Integration object.
79
+
80
+ Signature: `delete_integration(strToken:, strIntegrationID:)`
81
+ Invocation: `MemoriClient::Backend::V2::Integration.delete_integration(strToken:, strIntegrationID:)`
82
+
83
+ HTTP API: DELETE /api/v2/Integration/{strToken}/{strIntegrationID}`
84
+
85
+ Parameters:
86
+
87
+ - `strToken`: **string** The login token. required
88
+ - `strIntegrationID`: **string** The Integration object ID. required
89
+
90
+ ## register_integration
91
+
92
+ Summary:
93
+ Registers a new Integration object.
94
+
95
+ Signature: `register_integration(strToken:, payload: {})`
96
+ Invocation: `MemoriClient::Backend::V2::Integration.register_integration(strToken:, payload: {})`
97
+
98
+ HTTP API: POST /api/v2/Integration/{strToken}`
99
+
100
+ Parameters:
101
+
102
+ - `strToken`: **string** The login token. required
103
+ - `payload`: **Hash** request payload. optional
104
+ - `payload.integrationID`: **String** . optional
105
+ - `payload.memoriID`: **String** . optional
106
+ - `payload.type`: **String** . optional
107
+ - `payload.state`: **String** . optional
108
+ - `payload.deviceEmails`: **Array** . optional
109
+ - `payload.invocationText`: **String** . optional
110
+ - `payload.jobID`: **String** . optional
111
+ - `payload.customData`: **String** . optional
112
+ - `payload.resources`: **Array** . optional
113
+ - `payload.publish`: **Boolean** . optional
114
+ - `payload.creationTimestamp`: **String** . optional
115
+ - `payload.lastChangeTimestamp`: **String** . optional
116
+
117
+
data/doc/MemoriClient::Backend::V2::Invitation.md ADDED
@@ -0,0 +1,179 @@
1
+ # Module `MemoriClient::Backend::V2::Invitation`
2
+
3
+ ## list_sent_invitations
4
+
5
+ Summary:
6
+ Gets a list of invitations sent by the currently logged in User.
7
+
8
+ Signature: `list_sent_invitations(strToken:)`
9
+ Invocation: `MemoriClient::Backend::V2::Invitation.list_sent_invitations(strToken:)`
10
+
11
+ HTTP API: GET /api/v2/SentInvitations/{strToken}`
12
+
13
+ Parameters:
14
+
15
+ - `strToken`: **string** The login token. required
16
+
17
+ ## list_received_invitations
18
+
19
+ Summary:
20
+ Gets a list of invitations received by the currently logged in User.
21
+
22
+ Signature: `list_received_invitations(strToken:)`
23
+ Invocation: `MemoriClient::Backend::V2::Invitation.list_received_invitations(strToken:)`
24
+
25
+ HTTP API: GET /api/v2/ReceivedInvitations/{strToken}`
26
+
27
+ Parameters:
28
+
29
+ - `strToken`: **string** The login token. required
30
+
31
+ ## list_memori_invitations
32
+
33
+ Summary:
34
+ Gets a list of invitations sent for the specified Memori object.
35
+
36
+ Signature: `list_memori_invitations(strToken:, strMemoriID:)`
37
+ Invocation: `MemoriClient::Backend::V2::Invitation.list_memori_invitations(strToken:, strMemoriID:)`
38
+
39
+ HTTP API: GET /api/v2/MemoriInvitations/{strToken}/{strMemoriID}`
40
+
41
+ Parameters:
42
+
43
+ - `strToken`: **string** The login token. required
44
+ - `strMemoriID`: **string** The ID of the Memori object. required
45
+
46
+ ## list_all_invitations
47
+
48
+ Summary:
49
+ Gets a list of all Invitation objects.
50
+
51
+ Signature: `list_all_invitations(strToken:)`
52
+ Invocation: `MemoriClient::Backend::V2::Invitation.list_all_invitations(strToken:)`
53
+
54
+ HTTP API: GET /api/v2/AllInvitations/{strToken}`
55
+
56
+ Parameters:
57
+
58
+ - `strToken`: **string** The login token. required
59
+
60
+ ## get_invitation
61
+
62
+ Summary:
63
+ Gets the details of an Invitation object of the currently logged in User.
64
+
65
+ Signature: `get_invitation(strToken:, strInvitationID:)`
66
+ Invocation: `MemoriClient::Backend::V2::Invitation.get_invitation(strToken:, strInvitationID:)`
67
+
68
+ HTTP API: GET /api/v2/Invitation/{strToken}/{strInvitationID}`
69
+
70
+ Parameters:
71
+
72
+ - `strToken`: **string** The login token. required
73
+ - `strInvitationID`: **string** The ID of the Invitation object. required
74
+
75
+ ## update_invitation
76
+
77
+ Summary:
78
+ Updates an existing Invitation object sent by the currently logged in User.
79
+
80
+ Signature: `update_invitation(strToken:, strInvitationID:, payload: {})`
81
+ Invocation: `MemoriClient::Backend::V2::Invitation.update_invitation(strToken:, strInvitationID:, payload: {})`
82
+
83
+ HTTP API: PATCH /api/v2/Invitation/{strToken}/{strInvitationID}`
84
+
85
+ Parameters:
86
+
87
+ - `strToken`: **string** The login token. required
88
+ - `strInvitationID`: **string** The Invitation object ID. required
89
+ - `payload`: **Hash** request payload. optional
90
+ - `payload.invitationID`: **String** . optional
91
+ - `payload.memoriID`: **String** . optional
92
+ - `payload.engineMemoriID`: **String** . optional
93
+ - `payload.isInviter`: **Boolean** . optional
94
+ - `payload.isInvitee`: **Boolean** . optional
95
+ - `payload.text`: **String** . optional
96
+ - `payload.destinationName`: **String** . optional
97
+ - `payload.destinationEMail`: **String** . optional
98
+ - `payload.tag`: **String** . optional
99
+ - `payload.pin`: **String** . optional
100
+ - `payload.type`: **String** . optional
101
+ - `payload.state`: **String** . optional
102
+ - `payload.creationTimestamp`: **String** . optional
103
+ - `payload.lastChangeTimestamp`: **String** . optional
104
+
105
+ ## delete_invitation
106
+
107
+ Summary:
108
+ Deletes an existing Invitation object.
109
+
110
+ Signature: `delete_invitation(strToken:, strInvitationID:)`
111
+ Invocation: `MemoriClient::Backend::V2::Invitation.delete_invitation(strToken:, strInvitationID:)`
112
+
113
+ HTTP API: DELETE /api/v2/Invitation/{strToken}/{strInvitationID}`
114
+
115
+ Parameters:
116
+
117
+ - `strToken`: **string** The login token. required
118
+ - `strInvitationID`: **string** The Invitation object ID. required
119
+
120
+ ## accept_invitation
121
+
122
+ Summary:
123
+ Accepts an Invitation object.
124
+
125
+ Signature: `accept_invitation(strToken:, strInvitationID:)`
126
+ Invocation: `MemoriClient::Backend::V2::Invitation.accept_invitation(strToken:, strInvitationID:)`
127
+
128
+ HTTP API: POST /api/v2/AcceptInvitation/{strToken}/{strInvitationID}`
129
+
130
+ Parameters:
131
+
132
+ - `strToken`: **string** The login token. required
133
+ - `strInvitationID`: **string** The ID of the Invitation object. required
134
+
135
+ ## reject_invitation
136
+
137
+ Summary:
138
+ Rejects an Invitation object.
139
+
140
+ Signature: `reject_invitation(strToken:, strInvitationID:)`
141
+ Invocation: `MemoriClient::Backend::V2::Invitation.reject_invitation(strToken:, strInvitationID:)`
142
+
143
+ HTTP API: POST /api/v2/RejectInvitation/{strToken}/{strInvitationID}`
144
+
145
+ Parameters:
146
+
147
+ - `strToken`: **string** The login token. required
148
+ - `strInvitationID`: **string** The ID of the Invitation object. required
149
+
150
+ ## send_invitation
151
+
152
+ Summary:
153
+ Sends a new Invitation object.
154
+
155
+ Signature: `send_invitation(strToken:, payload: {})`
156
+ Invocation: `MemoriClient::Backend::V2::Invitation.send_invitation(strToken:, payload: {})`
157
+
158
+ HTTP API: POST /api/v2/SendInvitation/{strToken}`
159
+
160
+ Parameters:
161
+
162
+ - `strToken`: **string** The login token. required
163
+ - `payload`: **Hash** request payload. optional
164
+ - `payload.invitationID`: **String** . optional
165
+ - `payload.memoriID`: **String** . optional
166
+ - `payload.engineMemoriID`: **String** . optional
167
+ - `payload.isInviter`: **Boolean** . optional
168
+ - `payload.isInvitee`: **Boolean** . optional
169
+ - `payload.text`: **String** . optional
170
+ - `payload.destinationName`: **String** . optional
171
+ - `payload.destinationEMail`: **String** . optional
172
+ - `payload.tag`: **String** . optional
173
+ - `payload.pin`: **String** . optional
174
+ - `payload.type`: **String** . optional
175
+ - `payload.state`: **String** . optional
176
+ - `payload.creationTimestamp`: **String** . optional
177
+ - `payload.lastChangeTimestamp`: **String** . optional
178
+
179
+