memori-client 0.1.9 → 0.2.1

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 (102) hide show
  1. checksums.yaml +4 -4
  2. data/backend_overrides.jsonc +4 -0
  3. data/engine_overrides.jsonc +3 -0
  4. data/lib/memori_client/client.rb +49 -0
  5. data/lib/memori_client/client_factory.rb +105 -0
  6. data/lib/memori_client/engine/hmac_helper.rb +1 -1
  7. data/lib/memori_client/http_client.rb +4 -17
  8. data/lib/memori_client/operation.rb +132 -0
  9. data/lib/memori_client/proxy/client.rb +115 -0
  10. data/lib/memori_client/resource.rb +174 -26
  11. data/lib/memori_client/resource_proxy.rb +25 -0
  12. data/lib/memori_client/response.rb +48 -0
  13. data/lib/memori_client/swagger/get_module_and_method.rb +44 -0
  14. data/lib/memori_client/swagger/process_specification.rb +127 -0
  15. data/lib/memori_client/swagger/schema_store.rb +26 -0
  16. data/lib/memori_client.rb +14 -42
  17. data/lib/tasks/memori_client.rake +0 -7
  18. metadata +17 -90
  19. data/doc/MemoriClient::Backend::V1::Asset.md +0 -117
  20. data/doc/MemoriClient::Backend::V2::ActionLog.md +0 -37
  21. data/doc/MemoriClient::Backend::V2::Analysis.md +0 -39
  22. data/doc/MemoriClient::Backend::V2::Asset.md +0 -102
  23. data/doc/MemoriClient::Backend::V2::Badge.md +0 -64
  24. data/doc/MemoriClient::Backend::V2::CompletionConfig.md +0 -115
  25. data/doc/MemoriClient::Backend::V2::ConsumptionLog.md +0 -57
  26. data/doc/MemoriClient::Backend::V2::ImportExport.md +0 -180
  27. data/doc/MemoriClient::Backend::V2::Integration.md +0 -117
  28. data/doc/MemoriClient::Backend::V2::Invitation.md +0 -179
  29. data/doc/MemoriClient::Backend::V2::Memori.md +0 -394
  30. data/doc/MemoriClient::Backend::V2::MemoriList.md +0 -147
  31. data/doc/MemoriClient::Backend::V2::Notification.md +0 -31
  32. data/doc/MemoriClient::Backend::V2::Process.md +0 -64
  33. data/doc/MemoriClient::Backend::V2::Tenant.md +0 -142
  34. data/doc/MemoriClient::Backend::V2::User.md +0 -647
  35. data/doc/MemoriClient::Engine::V2::ChatLog.md +0 -82
  36. data/doc/MemoriClient::Engine::V2::ContextVar.md +0 -46
  37. data/doc/MemoriClient::Engine::V2::CorrelationPair.md +0 -72
  38. data/doc/MemoriClient::Engine::V2::CustomDictionary.md +0 -108
  39. data/doc/MemoriClient::Engine::V2::Dialog.md +0 -152
  40. data/doc/MemoriClient::Engine::V2::EventLog.md +0 -85
  41. data/doc/MemoriClient::Engine::V2::ExpertReference.md +0 -116
  42. data/doc/MemoriClient::Engine::V2::Function.md +0 -140
  43. data/doc/MemoriClient::Engine::V2::Intent.md +0 -225
  44. data/doc/MemoriClient::Engine::V2::LocalizationKey.md +0 -105
  45. data/doc/MemoriClient::Engine::V2::Medium.md +0 -118
  46. data/doc/MemoriClient::Engine::V2::Memory.md +0 -244
  47. data/doc/MemoriClient::Engine::V2::NLP.md +0 -100
  48. data/doc/MemoriClient::Engine::V2::Person.md +0 -114
  49. data/doc/MemoriClient::Engine::V2::Search.md +0 -151
  50. data/doc/MemoriClient::Engine::V2::Session.md +0 -55
  51. data/doc/MemoriClient::Engine::V2::Stat.md +0 -18
  52. data/doc/MemoriClient::Engine::V2::Topic.md +0 -80
  53. data/doc/MemoriClient::Engine::V2::UnansweredQuestion.md +0 -75
  54. data/doc/MemoriClient::Engine::V2::User.md +0 -140
  55. data/doc/MemoriClient::Engine::V2::WebHook.md +0 -67
  56. data/lib/memori_client/backend/resource.rb +0 -39
  57. data/lib/memori_client/backend/resources.rb +0 -16
  58. data/lib/memori_client/backend/v1/asset.rb +0 -120
  59. data/lib/memori_client/backend/v2/action_log.rb +0 -44
  60. data/lib/memori_client/backend/v2/analysis.rb +0 -54
  61. data/lib/memori_client/backend/v2/asset.rb +0 -130
  62. data/lib/memori_client/backend/v2/badge.rb +0 -77
  63. data/lib/memori_client/backend/v2/completion_config.rb +0 -202
  64. data/lib/memori_client/backend/v2/consumption_log.rb +0 -70
  65. data/lib/memori_client/backend/v2/import_export.rb +0 -327
  66. data/lib/memori_client/backend/v2/integration.rb +0 -180
  67. data/lib/memori_client/backend/v2/invitation.rb +0 -252
  68. data/lib/memori_client/backend/v2/memori.rb +0 -954
  69. data/lib/memori_client/backend/v2/memori_list.rb +0 -152
  70. data/lib/memori_client/backend/v2/notification.rb +0 -32
  71. data/lib/memori_client/backend/v2/process.rb +0 -70
  72. data/lib/memori_client/backend/v2/tenant.rb +0 -293
  73. data/lib/memori_client/backend/v2/user.rb +0 -1520
  74. data/lib/memori_client/configuration.rb +0 -20
  75. data/lib/memori_client/engine/resource.rb +0 -13
  76. data/lib/memori_client/engine/resources.rb +0 -21
  77. data/lib/memori_client/engine/v2/chat_log.rb +0 -92
  78. data/lib/memori_client/engine/v2/completion_log.rb +0 -17
  79. data/lib/memori_client/engine/v2/context_var.rb +0 -48
  80. data/lib/memori_client/engine/v2/correlation_pair.rb +0 -99
  81. data/lib/memori_client/engine/v2/custom_dictionary.rb +0 -152
  82. data/lib/memori_client/engine/v2/dialog.rb +0 -223
  83. data/lib/memori_client/engine/v2/event_log.rb +0 -98
  84. data/lib/memori_client/engine/v2/expert_reference.rb +0 -176
  85. data/lib/memori_client/engine/v2/function.rb +0 -220
  86. data/lib/memori_client/engine/v2/intent.rb +0 -336
  87. data/lib/memori_client/engine/v2/localization_key.rb +0 -144
  88. data/lib/memori_client/engine/v2/medium.rb +0 -178
  89. data/lib/memori_client/engine/v2/memori.rb +0 -329
  90. data/lib/memori_client/engine/v2/memory.rb +0 -477
  91. data/lib/memori_client/engine/v2/nlp.rb +0 -137
  92. data/lib/memori_client/engine/v2/person.rb +0 -170
  93. data/lib/memori_client/engine/v2/private/memori.rb +0 -17
  94. data/lib/memori_client/engine/v2/private/memori_block.rb +0 -24
  95. data/lib/memori_client/engine/v2/prompted_question.rb +0 -121
  96. data/lib/memori_client/engine/v2/search.rb +0 -318
  97. data/lib/memori_client/engine/v2/session.rb +0 -80
  98. data/lib/memori_client/engine/v2/stat.rb +0 -20
  99. data/lib/memori_client/engine/v2/topic.rb +0 -88
  100. data/lib/memori_client/engine/v2/unanswered_question.rb +0 -108
  101. data/lib/memori_client/engine/v2/user.rb +0 -152
  102. data/lib/memori_client/engine/v2/web_hook.rb +0 -128
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.9
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Stefano Lampis
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-06-18 00:00:00.000000000 Z
11
+ date: 2025-10-20 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
@@ -16,102 +16,29 @@ executables: []
16
16
  extensions: []
17
17
  extra_rdoc_files: []
18
18
  files:
19
- - doc/MemoriClient::Backend::V1::Asset.md
20
- - doc/MemoriClient::Backend::V2::ActionLog.md
21
- - doc/MemoriClient::Backend::V2::Analysis.md
22
- - doc/MemoriClient::Backend::V2::Asset.md
23
- - doc/MemoriClient::Backend::V2::Badge.md
24
- - doc/MemoriClient::Backend::V2::CompletionConfig.md
25
- - doc/MemoriClient::Backend::V2::ConsumptionLog.md
26
- - doc/MemoriClient::Backend::V2::ImportExport.md
27
- - doc/MemoriClient::Backend::V2::Integration.md
28
- - doc/MemoriClient::Backend::V2::Invitation.md
29
- - doc/MemoriClient::Backend::V2::Memori.md
30
- - doc/MemoriClient::Backend::V2::MemoriList.md
31
- - doc/MemoriClient::Backend::V2::Notification.md
32
- - doc/MemoriClient::Backend::V2::Process.md
33
- - doc/MemoriClient::Backend::V2::Tenant.md
34
- - doc/MemoriClient::Backend::V2::User.md
35
- - doc/MemoriClient::Engine::V2::ChatLog.md
36
- - doc/MemoriClient::Engine::V2::ContextVar.md
37
- - doc/MemoriClient::Engine::V2::CorrelationPair.md
38
- - doc/MemoriClient::Engine::V2::CustomDictionary.md
39
- - doc/MemoriClient::Engine::V2::Dialog.md
40
- - doc/MemoriClient::Engine::V2::EventLog.md
41
- - doc/MemoriClient::Engine::V2::ExpertReference.md
42
- - doc/MemoriClient::Engine::V2::Function.md
43
- - doc/MemoriClient::Engine::V2::Intent.md
44
- - doc/MemoriClient::Engine::V2::LocalizationKey.md
45
- - doc/MemoriClient::Engine::V2::Medium.md
46
- - doc/MemoriClient::Engine::V2::Memory.md
47
- - doc/MemoriClient::Engine::V2::NLP.md
48
- - doc/MemoriClient::Engine::V2::Person.md
49
- - doc/MemoriClient::Engine::V2::Search.md
50
- - doc/MemoriClient::Engine::V2::Session.md
51
- - doc/MemoriClient::Engine::V2::Stat.md
52
- - doc/MemoriClient::Engine::V2::Topic.md
53
- - doc/MemoriClient::Engine::V2::UnansweredQuestion.md
54
- - doc/MemoriClient::Engine::V2::User.md
55
- - doc/MemoriClient::Engine::V2::WebHook.md
19
+ - backend_overrides.jsonc
20
+ - engine_overrides.jsonc
56
21
  - lib/memori_client.rb
57
- - lib/memori_client/backend/resource.rb
58
- - lib/memori_client/backend/resources.rb
59
- - lib/memori_client/backend/v1/asset.rb
60
- - lib/memori_client/backend/v2/action_log.rb
61
- - lib/memori_client/backend/v2/analysis.rb
62
- - lib/memori_client/backend/v2/asset.rb
63
- - lib/memori_client/backend/v2/badge.rb
64
- - lib/memori_client/backend/v2/completion_config.rb
65
- - lib/memori_client/backend/v2/consumption_log.rb
66
- - lib/memori_client/backend/v2/import_export.rb
67
- - lib/memori_client/backend/v2/integration.rb
68
- - lib/memori_client/backend/v2/invitation.rb
69
- - lib/memori_client/backend/v2/memori.rb
70
- - lib/memori_client/backend/v2/memori_list.rb
71
- - lib/memori_client/backend/v2/notification.rb
72
- - lib/memori_client/backend/v2/process.rb
73
- - lib/memori_client/backend/v2/tenant.rb
74
- - lib/memori_client/backend/v2/user.rb
75
- - lib/memori_client/configuration.rb
22
+ - lib/memori_client/client.rb
23
+ - lib/memori_client/client_factory.rb
76
24
  - lib/memori_client/engine/hmac_helper.rb
77
- - lib/memori_client/engine/resource.rb
78
- - lib/memori_client/engine/resources.rb
79
- - lib/memori_client/engine/v2/chat_log.rb
80
- - lib/memori_client/engine/v2/completion_log.rb
81
- - lib/memori_client/engine/v2/context_var.rb
82
- - lib/memori_client/engine/v2/correlation_pair.rb
83
- - lib/memori_client/engine/v2/custom_dictionary.rb
84
- - lib/memori_client/engine/v2/dialog.rb
85
- - lib/memori_client/engine/v2/event_log.rb
86
- - lib/memori_client/engine/v2/expert_reference.rb
87
- - lib/memori_client/engine/v2/function.rb
88
- - lib/memori_client/engine/v2/intent.rb
89
- - lib/memori_client/engine/v2/localization_key.rb
90
- - lib/memori_client/engine/v2/medium.rb
91
- - lib/memori_client/engine/v2/memori.rb
92
- - lib/memori_client/engine/v2/memory.rb
93
- - lib/memori_client/engine/v2/nlp.rb
94
- - lib/memori_client/engine/v2/person.rb
95
- - lib/memori_client/engine/v2/private/memori.rb
96
- - lib/memori_client/engine/v2/private/memori_block.rb
97
- - lib/memori_client/engine/v2/prompted_question.rb
98
- - lib/memori_client/engine/v2/search.rb
99
- - lib/memori_client/engine/v2/session.rb
100
- - lib/memori_client/engine/v2/stat.rb
101
- - lib/memori_client/engine/v2/topic.rb
102
- - lib/memori_client/engine/v2/unanswered_question.rb
103
- - lib/memori_client/engine/v2/user.rb
104
- - lib/memori_client/engine/v2/web_hook.rb
105
25
  - lib/memori_client/http_client.rb
26
+ - lib/memori_client/operation.rb
27
+ - lib/memori_client/proxy/client.rb
106
28
  - lib/memori_client/railtie.rb
107
29
  - lib/memori_client/resource.rb
30
+ - lib/memori_client/resource_proxy.rb
31
+ - lib/memori_client/response.rb
32
+ - lib/memori_client/swagger/get_module_and_method.rb
33
+ - lib/memori_client/swagger/process_specification.rb
34
+ - lib/memori_client/swagger/schema_store.rb
108
35
  - lib/memori_client/utils/rails.rb
109
36
  - lib/tasks/memori_client.rake
110
37
  homepage: https://rubygems.org/gems/memori_client-client
111
38
  licenses:
112
39
  - MIT
113
40
  metadata: {}
114
- post_install_message:
41
+ post_install_message:
115
42
  rdoc_options: []
116
43
  require_paths:
117
44
  - lib
@@ -126,8 +53,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
126
53
  - !ruby/object:Gem::Version
127
54
  version: '0'
128
55
  requirements: []
129
- rubygems_version: 3.3.7
130
- signing_key:
56
+ rubygems_version: 3.4.19
57
+ signing_key:
131
58
  specification_version: 4
132
59
  summary: Memori Client
133
60
  test_files: []
@@ -1,117 +0,0 @@
1
- # Module `MemoriClient::Backend::V1::Asset`
2
-
3
- ## download_old_guid_asset
4
-
5
- Summary:
6
- Downloads a file from an old Guid asset file URL, such as ```guid://<assetID>.<ext>```.
7
-
8
- Signature: `download_old_guid_asset(assetID:)`
9
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_guid_asset(assetID:)`
10
-
11
- HTTP API: GET /api/v1/GuidAsset/{assetID}`
12
-
13
- Parameters:
14
-
15
- - `assetID`: **string** ID of the old Guid asset file. required
16
-
17
- ## download_old_alternative_guid_asset
18
-
19
- Summary:
20
- Downloads a file from an old alternative Guid asset file URL, sucs as ```/api/v1/memoriai/memory/media/<assetID>.<ext>```.
21
-
22
- Signature: `download_old_alternative_guid_asset(assetID:)`
23
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_alternative_guid_asset(assetID:)`
24
-
25
- HTTP API: GET /api/v1/memoriai/memory/media/{assetID}`
26
-
27
- Parameters:
28
-
29
- - `assetID`: **string** ID of the old Guid asset file. required
30
-
31
- ## download_old_alternative_guid_asset_with_memory
32
-
33
- Summary:
34
- Downloads a file from an old alternative Guid asset file URL, sucs as ```/api/v1/memoriai/memory/<memoryID>/media/<assetID>.<ext>```.
35
-
36
- Signature: `download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)`
37
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)`
38
-
39
- HTTP API: GET /api/v1/memoriai/memory/{strMemoryID}/media/{assetID}`
40
-
41
- Parameters:
42
-
43
- - `strMemoryID`: **string** ID of the engine Memory object (ignored). required
44
- - `assetID`: **string** ID of the old Guid asset file. required
45
-
46
- ## download_old_cloud_asset
47
-
48
- Summary:
49
- Downloads a file from an old Cloud asset file URL, such as ```cloud://<path>/<assetID>.<ext>```.
50
-
51
- Signature: `download_old_cloud_asset(assetID:)`
52
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_cloud_asset(assetID:)`
53
-
54
- HTTP API: GET /api/v1/CloudAsset/{assetID}`
55
-
56
- Parameters:
57
-
58
- - `assetID`: **string** ID of the old Cloud asset file. required
59
-
60
- ## download_old_asset
61
-
62
- Summary:
63
- Downloads a file from an old asset file URL, such as ```/api/v1/memoriai/memory/media/cloud/<path>/<assetID>.<ext>```.
64
-
65
- Signature: `download_old_asset(assetID:)`
66
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_asset(assetID:)`
67
-
68
- HTTP API: GET /api/v1/memoriai/memory/media/cloud/{assetID}`
69
-
70
- Parameters:
71
-
72
- - `assetID`: **string** ID of the old asset file. required
73
-
74
- ## download_old_asset_with_memory_check
75
-
76
- Summary:
77
- Downloads a file from an old asset file URL, such as ```/api/v1/memoriai/memory/<memoryID>/media/cloud/<path>/<assetID>.<ext>```.
78
-
79
- Signature: `download_old_asset_with_memory_check(strMemoryID:, assetID:)`
80
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_asset_with_memory_check(strMemoryID:, assetID:)`
81
-
82
- HTTP API: GET /api/v1/memoriai/memory/{strMemoryID}/media/cloud/{assetID}`
83
-
84
- Parameters:
85
-
86
- - `strMemoryID`: **string** ID of the engine Memory object. required
87
- - `assetID`: **string** ID of the old asset file. required
88
-
89
- ## download_old_cover_asset
90
-
91
- Summary:
92
- Downloads the cover file from an old cover asset URL, sucs as ```/api/v1/memoriai/memori/cover/<memoriID>```.
93
-
94
- Signature: `download_old_cover_asset(strMemoriID:)`
95
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_cover_asset(strMemoriID:)`
96
-
97
- HTTP API: GET /api/v1/memoriai/memori/cover/{strMemoriID}`
98
-
99
- Parameters:
100
-
101
- - `strMemoriID`: **string** ID of the engine Memori object. required
102
-
103
- ## download_old_avatar_asset
104
-
105
- Summary:
106
- Downloads the avatar file from an old avatar asset URL, sucs as ```/api/v1/memoriai/memori/avatar/<memoriID>```.
107
-
108
- Signature: `download_old_avatar_asset(strMemoriID:)`
109
- Invocation: `MemoriClient::Backend::V1::Asset.download_old_avatar_asset(strMemoriID:)`
110
-
111
- HTTP API: GET /api/v1/memoriai/memori/avatar/{strMemoriID}`
112
-
113
- Parameters:
114
-
115
- - `strMemoriID`: **string** ID of the engine Memori object. required
116
-
117
-
@@ -1,37 +0,0 @@
1
- # Module `MemoriClient::Backend::V2::ActionLog`
2
-
3
- ## get_user_action_logs
4
-
5
- Summary:
6
- Gets the Action Log objects for a specific User in a specific date interval.
7
-
8
- Signature: `get_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)`
9
- Invocation: `MemoriClient::Backend::V2::ActionLog.get_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)`
10
-
11
- HTTP API: GET /api/v2/UserActionLogs/{strToken}/{strUserID}/{strDateFrom}/{strDateTo}`
12
-
13
- Parameters:
14
-
15
- - `strToken`: **string** The login token. required
16
- - `strUserID`: **string** The ID of the User object. required
17
- - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
18
- - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
19
-
20
- ## get_memori_action_logs
21
-
22
- Summary:
23
- Gets the Action Log objects for a specific Memori in a specific date interval.
24
-
25
- Signature: `get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
26
- Invocation: `MemoriClient::Backend::V2::ActionLog.get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
27
-
28
- HTTP API: GET /api/v2/MemoriActionLogs/{strToken}/{strMemoriID}/{strDateFrom}/{strDateTo}`
29
-
30
- Parameters:
31
-
32
- - `strToken`: **string** The login token. required
33
- - `strMemoriID`: **string** The ID of the Memori object. required
34
- - `strDateFrom`: **string** The optional begin of the date interval, in the format yyyyMMddHHmmssfff. optional
35
- - `strDateTo`: **string** The optional end of the date interval, in the format yyyyMMddHHmmssfff. optional
36
-
37
-
@@ -1,39 +0,0 @@
1
- # Module `MemoriClient::Backend::V2::Analysis`
2
-
3
- ## analyze_user_query
4
-
5
- Summary:
6
- Starts an Analysis process for User/query match on Deep Thought known facts.
7
-
8
- Signature: `analyze_user_query(strToken:, strMemoriID:, payload: {})`
9
- Invocation: `MemoriClient::Backend::V2::Analysis.analyze_user_query(strToken:, strMemoriID:, payload: {})`
10
-
11
- HTTP API: POST /api/v2/Analysis/AnalyzeUserQuery/{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.query`: **String** . optional
19
- - `payload.threshold`: **Number** . optional
20
-
21
- ## list_user_query_matches
22
-
23
- Summary:
24
- Lists Deep Thought User/query Match objects of the specified Analysis object, with pagination.
25
-
26
- Signature: `list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)`
27
- Invocation: `MemoriClient::Backend::V2::Analysis.list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)`
28
-
29
- HTTP API: GET /api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold}`
30
-
31
- Parameters:
32
-
33
- - `strToken`: **string** The login token. required
34
- - `strAnalysisID`: **string** The Analysis process ID. required
35
- - `from`: **integer** The 0-based index of the first Match object to list. required
36
- - `howMany`: **integer** The number of the Match objects to list. required
37
- - `threshold`: **number** Optional threshold between 0.0 and 1.0: Match objects below the threshold are excluded from the list. optional
38
-
39
-
@@ -1,102 +0,0 @@
1
- # Module `MemoriClient::Backend::V2::Asset`
2
-
3
- ## upload_asset
4
-
5
- Summary:
6
- Uploads a file and creates a new Asset object to access it.
7
-
8
- Signature: `upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)`
9
- Invocation: `MemoriClient::Backend::V2::Asset.upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)`
10
-
11
- HTTP API: POST /api/v2/Asset/{strToken}/{strMemoriID}/{strEngineMemoryID}`
12
-
13
- Parameters:
14
-
15
- - `strToken`: **string** The login token. required
16
- - `strMemoriID`: **string** The optional ID of a Memori object the Asset belongs to. optional
17
- - `strEngineMemoryID`: **string** The optional ID of an Engine Memory object the Asset belogs to. optional
18
-
19
- ## get_asset_details
20
-
21
- Summary:
22
- Gets the details of an Asset object.
23
-
24
- Signature: `get_asset_details(strToken:, fileName:)`
25
- Invocation: `MemoriClient::Backend::V2::Asset.get_asset_details(strToken:, fileName:)`
26
-
27
- HTTP API: GET /api/v2/AssetDetails/{strToken}/{fileName}`
28
-
29
- Parameters:
30
-
31
- - `strToken`: **string** The login token. required
32
- - `fileName`: **string** Name of the Asset file. required
33
-
34
- ## list_sent_invitations
35
-
36
- Summary:
37
- Gets a list of Asset objects owned the currently logged in User.
38
-
39
- Signature: `list_sent_invitations(strToken:)`
40
- Invocation: `MemoriClient::Backend::V2::Asset.list_sent_invitations(strToken:)`
41
-
42
- HTTP API: GET /api/v2/Assets/{strToken}`
43
-
44
- Parameters:
45
-
46
- - `strToken`: **string** The login token. required
47
-
48
- ## download_asset
49
-
50
- Summary:
51
- Downloads a file from an Asset object.
52
-
53
- Signature: `download_asset(fileName:, memoriSessionID: nil)`
54
- Invocation: `MemoriClient::Backend::V2::Asset.download_asset(fileName:, memoriSessionID: nil)`
55
-
56
- HTTP API: GET /api/v2/Asset/{fileName}/{memoriSessionID}`
57
-
58
- Parameters:
59
-
60
- - `fileName`: **string** Name of the Asset file. required
61
- - `memoriSessionID`: **string** Optional ID of an Engine Memori session. optional
62
-
63
- ## update_asset
64
-
65
- Summary:
66
- Updates an Asset object.
67
-
68
- Signature: `update_asset(strToken:, fileName:, payload: {})`
69
- Invocation: `MemoriClient::Backend::V2::Asset.update_asset(strToken:, fileName:, payload: {})`
70
-
71
- HTTP API: PATCH /api/v2/Asset/{strToken}/{fileName}`
72
-
73
- Parameters:
74
-
75
- - `strToken`: **string** The login token. required
76
- - `fileName`: **string** Name of the Asset file. required
77
- - `payload`: **Hash** request payload. optional
78
- - `payload.assetID`: **String** . optional
79
- - `payload.assetURL`: **String** . optional
80
- - `payload.mimeType`: **String** . optional
81
- - `payload.originalFileName`: **String** . optional
82
- - `payload.memoriID`: **String** . optional
83
- - `payload.engineMemoryID`: **String** . optional
84
- - `payload.creationTimestamp`: **String** . optional
85
- - `payload.lastChangeTimestamp`: **String** . optional
86
-
87
- ## delete_asset
88
-
89
- Summary:
90
- Deletes a file and its corresponding Asset object.
91
-
92
- Signature: `delete_asset(strToken:, fileName:)`
93
- Invocation: `MemoriClient::Backend::V2::Asset.delete_asset(strToken:, fileName:)`
94
-
95
- HTTP API: DELETE /api/v2/Asset/{strToken}/{fileName}`
96
-
97
- Parameters:
98
-
99
- - `strToken`: **string** The login token. required
100
- - `fileName`: **string** Name of the Asset file. required
101
-
102
-
@@ -1,64 +0,0 @@
1
- # Module `MemoriClient::Backend::V2::Badge`
2
-
3
- ## send_outcome
4
-
5
- Summary:
6
- Processes the specified outcome.
7
-
8
- Signature: `send_outcome(strToken:, outcomeCode:)`
9
- Invocation: `MemoriClient::Backend::V2::Badge.send_outcome(strToken:, outcomeCode:)`
10
-
11
- HTTP API: POST /api/v2/Outcome/{strToken}/{outcomeCode}`
12
-
13
- Parameters:
14
-
15
- - `strToken`: **string** The login token. required
16
- - `outcomeCode`: **string** The outcome code. required
17
-
18
- ## badge_assignment_callback
19
-
20
- Summary:
21
- Processes a badge assignment.
22
-
23
- Signature: `badge_assignment_callback(payload: {})`
24
- Invocation: `MemoriClient::Backend::V2::Badge.badge_assignment_callback(payload: {})`
25
-
26
- HTTP API: POST /api/v2/BadgeAssignment`
27
-
28
- Parameters:
29
-
30
- - `payload`: **Hash** request payload. optional
31
- - `payload.refId`: **String** . required
32
- - `payload.outcome`: **String** . required
33
- - `payload.badgeUrl`: **String** . required
34
-
35
- ## list_badges
36
-
37
- Summary:
38
- Gets a list of Badge objects assigned to the currently logged in User.
39
-
40
- Signature: `list_badges(strToken:)`
41
- Invocation: `MemoriClient::Backend::V2::Badge.list_badges(strToken:)`
42
-
43
- HTTP API: GET /api/v2/Badges/{strToken}`
44
-
45
- Parameters:
46
-
47
- - `strToken`: **string** The login token. required
48
-
49
- ## get_badge
50
-
51
- Summary:
52
- Gets a list of Badge objects assigned to the currently logged in User.
53
-
54
- Signature: `get_badge(strToken:, strBadgeID:)`
55
- Invocation: `MemoriClient::Backend::V2::Badge.get_badge(strToken:, strBadgeID:)`
56
-
57
- HTTP API: GET /api/v2/Badge/{strToken}/{strBadgeID}`
58
-
59
- Parameters:
60
-
61
- - `strToken`: **string** The login token. required
62
- - `strBadgeID`: **string** The ID of the Badge object. required
63
-
64
-
@@ -1,115 +0,0 @@
1
- # Module `MemoriClient::Backend::V2::CompletionConfig`
2
-
3
- ## list_completion_configs
4
-
5
- Summary:
6
- Gets a list of Completion Config objects allowed for the user.
7
-
8
- Signature: `list_completion_configs(strToken:, purpose: nil)`
9
- Invocation: `MemoriClient::Backend::V2::CompletionConfig.list_completion_configs(strToken:, purpose: nil)`
10
-
11
- HTTP API: GET /api/v2/CompletionConfigs/{strToken}/{purpose}`
12
-
13
- Parameters:
14
-
15
- - `strToken`: **string** The login token. required
16
- - `purpose`: **string** Optional filter on Completion Config purpose ("QA" for Question Answering, "IE" for Import/Export, "DT" for Deep Thought).. optional
17
-
18
- ## get_completion_config
19
-
20
- Summary:
21
- Gets the details of a Completion Config of a specific object
22
-
23
- Signature: `get_completion_config(strToken:, strConfigID:)`
24
- Invocation: `MemoriClient::Backend::V2::CompletionConfig.get_completion_config(strToken:, strConfigID:)`
25
-
26
- HTTP API: GET /api/v2/CompletionConfig/{strToken}/{strConfigID}`
27
-
28
- Parameters:
29
-
30
- - `strToken`: **string** The login token. required
31
- - `strConfigID`: **string** The Completion Config object ID. required
32
-
33
- ## update_completion_config
34
-
35
- Summary:
36
- Updates an existing Completion Config object. A user can only update a Completion Config object owned by him, unless it has administrative rights.
37
-
38
- Signature: `update_completion_config(strToken:, strConfigID:, payload: {})`
39
- Invocation: `MemoriClient::Backend::V2::CompletionConfig.update_completion_config(strToken:, strConfigID:, payload: {})`
40
-
41
- HTTP API: PATCH /api/v2/CompletionConfig/{strToken}/{strConfigID}`
42
-
43
- Parameters:
44
-
45
- - `strToken`: **string** The login token. required
46
- - `strConfigID`: **string** The ID of the Completion Config object. required
47
- - `payload`: **Hash** request payload. optional
48
- - `payload.completionConfigID`: **String** . optional
49
- - `payload.configName`: **String** . optional
50
- - `payload.description`: **String** . optional
51
- - `payload.provider`: **String** . optional
52
- - `payload.endPoint`: **String** . optional
53
- - `payload.apiKey`: **String** . optional
54
- - `payload.model`: **String** . optional
55
- - `payload.questionAnsweringEnabled`: **Boolean** . optional
56
- - `payload.importExportEnabled`: **Boolean** . optional
57
- - `payload.deepThoughtEnabled`: **Boolean** . optional
58
- - `payload.ownerUserID`: **String** . optional
59
- - `payload.ownerUserName`: **String** . optional
60
- - `payload.ownerTenantName`: **String** . optional
61
- - `payload.visibleToTenantUsers`: **Boolean** . optional
62
- - `payload.visibleToOtherUsers`: **Boolean** . optional
63
- - `payload.useAsDefault`: **Boolean** . optional
64
- - `payload.chargeable`: **Boolean** . optional
65
- - `payload.applyTo`: **String** . optional
66
-
67
- ## delete_completion_config
68
-
69
- Summary:
70
- Deletes an existing Completion Config object. A user can only delete a Completion Config object owned by him, unless it has administrative rights.
71
-
72
- Signature: `delete_completion_config(strToken:, strConfigID:)`
73
- Invocation: `MemoriClient::Backend::V2::CompletionConfig.delete_completion_config(strToken:, strConfigID:)`
74
-
75
- HTTP API: DELETE /api/v2/CompletionConfig/{strToken}/{strConfigID}`
76
-
77
- Parameters:
78
-
79
- - `strToken`: **string** The login token. required
80
- - `strConfigID`: **string** The ID of the Completion Config object. required
81
-
82
- ## add_completion_config
83
-
84
- Summary:
85
- Creates a new Completion Config object. The created Completion Config object is owned by the currently logged-in user.
86
-
87
- Signature: `add_completion_config(strToken:, payload: {})`
88
- Invocation: `MemoriClient::Backend::V2::CompletionConfig.add_completion_config(strToken:, payload: {})`
89
-
90
- HTTP API: POST /api/v2/CompletionConfig/{strToken}`
91
-
92
- Parameters:
93
-
94
- - `strToken`: **string** The login token. required
95
- - `payload`: **Hash** request payload. optional
96
- - `payload.completionConfigID`: **String** . optional
97
- - `payload.configName`: **String** . optional
98
- - `payload.description`: **String** . optional
99
- - `payload.provider`: **String** . optional
100
- - `payload.endPoint`: **String** . optional
101
- - `payload.apiKey`: **String** . optional
102
- - `payload.model`: **String** . optional
103
- - `payload.questionAnsweringEnabled`: **Boolean** . optional
104
- - `payload.importExportEnabled`: **Boolean** . optional
105
- - `payload.deepThoughtEnabled`: **Boolean** . optional
106
- - `payload.ownerUserID`: **String** . optional
107
- - `payload.ownerUserName`: **String** . optional
108
- - `payload.ownerTenantName`: **String** . optional
109
- - `payload.visibleToTenantUsers`: **Boolean** . optional
110
- - `payload.visibleToOtherUsers`: **Boolean** . optional
111
- - `payload.useAsDefault`: **Boolean** . optional
112
- - `payload.chargeable`: **Boolean** . optional
113
- - `payload.applyTo`: **String** . optional
114
-
115
-
@@ -1,57 +0,0 @@
1
- # Module `MemoriClient::Backend::V2::ConsumptionLog`
2
-
3
- ## get_tenant_consumption_logs
4
-
5
- Summary:
6
- Gets the Consumption Log objects for a specific Tenant in a specific date interval.
7
-
8
- Signature: `get_tenant_consumption_logs(strToken:, tenantName:, strType:, strDateFrom: nil, strDateTo: nil)`
9
- Invocation: `MemoriClient::Backend::V2::ConsumptionLog.get_tenant_consumption_logs(strToken:, tenantName:, strType:, strDateFrom: nil, strDateTo: nil)`
10
-
11
- HTTP API: GET /api/v2/TenantConsumptionLogs/{strToken}/{tenantName}/{strType}/{strDateFrom}/{strDateTo}`
12
-
13
- Parameters:
14
-
15
- - `strToken`: **string** The login token. required
16
- - `tenantName`: **string** The name of the Tenant. required
17
- - `strType`: **string** Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
18
- - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
19
- - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
20
-
21
- ## get_user_consumption_logs
22
-
23
- Summary:
24
- Gets the Consumption Log objects for a specific User in a specific date interval.
25
-
26
- Signature: `get_user_consumption_logs(strToken:, strUserID:, strType:, strDateFrom: nil, strDateTo: nil)`
27
- Invocation: `MemoriClient::Backend::V2::ConsumptionLog.get_user_consumption_logs(strToken:, strUserID:, strType:, strDateFrom: nil, strDateTo: nil)`
28
-
29
- HTTP API: GET /api/v2/UserConsumptionLogs/{strToken}/{strUserID}/{strType}/{strDateFrom}/{strDateTo}`
30
-
31
- Parameters:
32
-
33
- - `strToken`: **string** The login token. required
34
- - `strUserID`: **string** The ID of the User object. required
35
- - `strType`: **string** Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
36
- - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
37
- - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
38
-
39
- ## get_memori_consumption_logs
40
-
41
- Summary:
42
- Gets the Consumption Log objects for a specific Memori in a specific date interval.
43
-
44
- Signature: `get_memori_consumption_logs(strToken:, strMemoriID:, strType:, strDateFrom: nil, strDateTo: nil)`
45
- Invocation: `MemoriClient::Backend::V2::ConsumptionLog.get_memori_consumption_logs(strToken:, strMemoriID:, strType:, strDateFrom: nil, strDateTo: nil)`
46
-
47
- HTTP API: GET /api/v2/MemoriConsumptionLogs/{strToken}/{strMemoriID}/{strType}/{strDateFrom}/{strDateTo}`
48
-
49
- Parameters:
50
-
51
- - `strToken`: **string** The login token. required
52
- - `strMemoriID`: **string** The ID of the Memori object. required
53
- - `strType`: **string** Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
54
- - `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
55
- - `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
56
-
57
-