memori-client 0.1.6 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c10fc0d10bce1ed59b4958dbf180ea960feff117101b2c9376a2bb584db64fe
-  data.tar.gz: 8b6274442472d9c9a175df35e07668066a857de6a022761fbca766c15fae4d74
+  metadata.gz: 2514386c5093864c79a74f317030cf2ab058fbd41a3337decfc5415d8a3182b4
+  data.tar.gz: e33a09045201dbd2ceea70acf767e73037f368de5223a157b99c1959bd4b7406
 SHA512:
-  metadata.gz: e5e5b9e4607847f63fb0de2919799773187d50740c1554cb3466c797ffd2d82cfc8547b33ee6c6967f09aa4369671560cb13eeca14be0a3ca1989553ca43fe9d
-  data.tar.gz: 7115e5babdddb0b6e7448a60de84fc92875d5051011ad975e77ad40a45e6db4110362bcea2419aa0de7aa69fb9d601f89206ecbddb53ef92bbfadef398f97c1d
+  metadata.gz: 258e0813e4c0998df0e1f746d02984a55eb249de7adec552ccedec1b6eb3b906e0e7b43834659e099ec0268891adc6c6914bf7050737f021e7e84e8c3a0207a3
+  data.tar.gz: '0795c94a010caac4a6697eb1d8833b852eff369e00ee00dab0f2c74d95b8ed980d322f614fd655ee092e059499087d36a9312becefa749071c37ae0cf6f23f38'

data/doc/MemoriClient::Backend::V1::Asset.md

@@ -0,0 +1,117 @@
+# Module `MemoriClient::Backend::V1::Asset`
+
+## download_old_guid_asset
+
+Summary:
+Downloads a file from an old Guid asset file URL, such as  ```guid://<assetID>.<ext>```.
+
+Signature: `download_old_guid_asset(assetID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_guid_asset(assetID:)`
+
+HTTP API: GET /api/v1/GuidAsset/{assetID}`
+
+Parameters:
+
+- `assetID`: **string** ID of the old Guid asset file. required
+
+## download_old_alternative_guid_asset
+
+Summary:
+Downloads a file from an old alternative Guid asset file URL, sucs as  ```/api/v1/memoriai/memory/media/<assetID>.<ext>```.
+
+Signature: `download_old_alternative_guid_asset(assetID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_alternative_guid_asset(assetID:)`
+
+HTTP API: GET /api/v1/memoriai/memory/media/{assetID}`
+
+Parameters:
+
+- `assetID`: **string** ID of the old Guid asset file. required
+
+## download_old_alternative_guid_asset_with_memory
+
+Summary:
+Downloads a file from an old alternative Guid asset file URL, sucs as  ```/api/v1/memoriai/memory/<memoryID>/media/<assetID>.<ext>```.
+
+Signature: `download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_alternative_guid_asset_with_memory(strMemoryID:, assetID:)`
+
+HTTP API: GET /api/v1/memoriai/memory/{strMemoryID}/media/{assetID}`
+
+Parameters:
+
+- `strMemoryID`: **string** ID of the engine Memory object (ignored). required
+- `assetID`: **string** ID of the old Guid asset file. required
+
+## download_old_cloud_asset
+
+Summary:
+Downloads a file from an old Cloud asset file URL, such as  ```cloud://<path>/<assetID>.<ext>```.
+
+Signature: `download_old_cloud_asset(assetID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_cloud_asset(assetID:)`
+
+HTTP API: GET /api/v1/CloudAsset/{assetID}`
+
+Parameters:
+
+- `assetID`: **string** ID of the old Cloud asset file. required
+
+## download_old_asset
+
+Summary:
+Downloads a file from an old asset file URL, such as  ```/api/v1/memoriai/memory/media/cloud/<path>/<assetID>.<ext>```.
+
+Signature: `download_old_asset(assetID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_asset(assetID:)`
+
+HTTP API: GET /api/v1/memoriai/memory/media/cloud/{assetID}`
+
+Parameters:
+
+- `assetID`: **string** ID of the old asset file. required
+
+## download_old_asset_with_memory_check
+
+Summary:
+Downloads a file from an old asset file URL, such as  ```/api/v1/memoriai/memory/<memoryID>/media/cloud/<path>/<assetID>.<ext>```.
+
+Signature: `download_old_asset_with_memory_check(strMemoryID:, assetID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_asset_with_memory_check(strMemoryID:, assetID:)`
+
+HTTP API: GET /api/v1/memoriai/memory/{strMemoryID}/media/cloud/{assetID}`
+
+Parameters:
+
+- `strMemoryID`: **string** ID of the engine Memory object. required
+- `assetID`: **string** ID of the old asset file. required
+
+## download_old_cover_asset
+
+Summary:
+Downloads the cover file from an old cover asset URL, sucs as  ```/api/v1/memoriai/memori/cover/<memoriID>```.
+
+Signature: `download_old_cover_asset(strMemoriID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_cover_asset(strMemoriID:)`
+
+HTTP API: GET /api/v1/memoriai/memori/cover/{strMemoriID}`
+
+Parameters:
+
+- `strMemoriID`: **string** ID of the engine Memori object. required
+
+## download_old_avatar_asset
+
+Summary:
+Downloads the avatar file from an old avatar asset URL, sucs as  ```/api/v1/memoriai/memori/avatar/<memoriID>```.
+
+Signature: `download_old_avatar_asset(strMemoriID:)`
+Invocation: `MemoriClient::Backend::V1::Asset.download_old_avatar_asset(strMemoriID:)`
+
+HTTP API: GET /api/v1/memoriai/memori/avatar/{strMemoriID}`
+
+Parameters:
+
+- `strMemoriID`: **string** ID of the engine Memori object. required
+
+

data/doc/MemoriClient::Backend::V2::ActionLog.md

@@ -0,0 +1,37 @@
+# Module `MemoriClient::Backend::V2::ActionLog`
+
+## get_user_action_logs
+
+Summary:
+Gets the Action Log objects for a specific User in a specific date interval.
+
+Signature: `get_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)`
+Invocation: `MemoriClient::Backend::V2::ActionLog.get_user_action_logs(strToken:, strUserID:, strDateFrom: nil, strDateTo: nil)`
+
+HTTP API: GET /api/v2/UserActionLogs/{strToken}/{strUserID}/{strDateFrom}/{strDateTo}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strUserID`: **string** The ID of the User object. required
+- `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+- `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMddHHmmssfff. optional
+
+## get_memori_action_logs
+
+Summary:
+Gets the Action Log objects for a specific Memori in a specific date interval.
+
+Signature: `get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
+Invocation: `MemoriClient::Backend::V2::ActionLog.get_memori_action_logs(strToken:, strMemoriID:, strDateFrom: nil, strDateTo: nil)`
+
+HTTP API: GET /api/v2/MemoriActionLogs/{strToken}/{strMemoriID}/{strDateFrom}/{strDateTo}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strMemoriID`: **string** The ID of the Memori object. required
+- `strDateFrom`: **string** The optional begin of the date interval, in the format yyyyMMddHHmmssfff. optional
+- `strDateTo`: **string** The optional end of the date interval, in the format yyyyMMddHHmmssfff. optional
+
+

data/doc/MemoriClient::Backend::V2::Analysis.md

@@ -0,0 +1,39 @@
+# Module `MemoriClient::Backend::V2::Analysis`
+
+## analyze_user_query
+
+Summary:
+Starts an Analysis process for User/query match on Deep Thought known facts.
+
+Signature: `analyze_user_query(strToken:, strMemoriID:, payload: {})`
+Invocation: `MemoriClient::Backend::V2::Analysis.analyze_user_query(strToken:, strMemoriID:, payload: {})`
+
+HTTP API: POST /api/v2/Analysis/AnalyzeUserQuery/{strToken}/{strMemoriID}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strMemoriID`: **string** The ID of the Memori object. required
+- `payload`: **Hash** request payload. optional
+  - `payload.query`: **String** . optional
+  - `payload.threshold`: **Number** . optional
+
+## list_user_query_matches
+
+Summary:
+Lists Deep Thought User/query Match objects of the specified Analysis object, with pagination.
+
+Signature: `list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)`
+Invocation: `MemoriClient::Backend::V2::Analysis.list_user_query_matches(strToken:, strAnalysisID:, from:, howMany:, threshold: nil)`
+
+HTTP API: GET /api/v2/Analysis/UserQueryMatches/{strToken}/{strAnalysisID}/{from}/{howMany}/{threshold}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strAnalysisID`: **string** The Analysis process ID. required
+- `from`: **integer** The 0-based index of the first Match object to list. required
+- `howMany`: **integer** The number of the Match objects to list. required
+- `threshold`: **number** Optional threshold between 0.0 and 1.0: Match objects below the threshold are excluded from the list. optional
+
+

data/doc/MemoriClient::Backend::V2::Asset.md

@@ -0,0 +1,102 @@
+# Module `MemoriClient::Backend::V2::Asset`
+
+## upload_asset
+
+Summary:
+Uploads a file and creates a new Asset object to access it.
+
+Signature: `upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)`
+Invocation: `MemoriClient::Backend::V2::Asset.upload_asset(strToken:, strMemoriID: nil, strEngineMemoryID: nil)`
+
+HTTP API: POST /api/v2/Asset/{strToken}/{strMemoriID}/{strEngineMemoryID}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strMemoriID`: **string** The optional ID of a Memori object the Asset belongs to. optional
+- `strEngineMemoryID`: **string** The optional ID of an Engine Memory object the Asset belogs to. optional
+
+## get_asset_details
+
+Summary:
+Gets the details of an Asset object.
+
+Signature: `get_asset_details(strToken:, fileName:)`
+Invocation: `MemoriClient::Backend::V2::Asset.get_asset_details(strToken:, fileName:)`
+
+HTTP API: GET /api/v2/AssetDetails/{strToken}/{fileName}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `fileName`: **string** Name of the Asset file. required
+
+## list_sent_invitations
+
+Summary:
+Gets a list of Asset objects owned the currently logged in User.
+
+Signature: `list_sent_invitations(strToken:)`
+Invocation: `MemoriClient::Backend::V2::Asset.list_sent_invitations(strToken:)`
+
+HTTP API: GET /api/v2/Assets/{strToken}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+
+## download_asset
+
+Summary:
+Downloads a file from an Asset object.
+
+Signature: `download_asset(fileName:, memoriSessionID: nil)`
+Invocation: `MemoriClient::Backend::V2::Asset.download_asset(fileName:, memoriSessionID: nil)`
+
+HTTP API: GET /api/v2/Asset/{fileName}/{memoriSessionID}`
+
+Parameters:
+
+- `fileName`: **string** Name of the Asset file. required
+- `memoriSessionID`: **string** Optional ID of an Engine Memori session. optional
+
+## update_asset
+
+Summary:
+Updates an Asset object.
+
+Signature: `update_asset(strToken:, fileName:, payload: {})`
+Invocation: `MemoriClient::Backend::V2::Asset.update_asset(strToken:, fileName:, payload: {})`
+
+HTTP API: PATCH /api/v2/Asset/{strToken}/{fileName}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `fileName`: **string** Name of the Asset file. required
+- `payload`: **Hash** request payload. optional
+  - `payload.assetID`: **String** . optional
+  - `payload.assetURL`: **String** . optional
+  - `payload.mimeType`: **String** . optional
+  - `payload.originalFileName`: **String** . optional
+  - `payload.memoriID`: **String** . optional
+  - `payload.engineMemoryID`: **String** . optional
+  - `payload.creationTimestamp`: **String** . optional
+  - `payload.lastChangeTimestamp`: **String** . optional
+
+## delete_asset
+
+Summary:
+Deletes a file and its corresponding Asset object.
+
+Signature: `delete_asset(strToken:, fileName:)`
+Invocation: `MemoriClient::Backend::V2::Asset.delete_asset(strToken:, fileName:)`
+
+HTTP API: DELETE /api/v2/Asset/{strToken}/{fileName}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `fileName`: **string** Name of the Asset file. required
+
+

data/doc/MemoriClient::Backend::V2::Badge.md

@@ -0,0 +1,64 @@
+# Module `MemoriClient::Backend::V2::Badge`
+
+## send_outcome
+
+Summary:
+Processes the specified outcome.
+
+Signature: `send_outcome(strToken:, outcomeCode:)`
+Invocation: `MemoriClient::Backend::V2::Badge.send_outcome(strToken:, outcomeCode:)`
+
+HTTP API: POST /api/v2/Outcome/{strToken}/{outcomeCode}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `outcomeCode`: **string** The outcome code. required
+
+## badge_assignment_callback
+
+Summary:
+Processes a badge assignment.
+
+Signature: `badge_assignment_callback(payload: {})`
+Invocation: `MemoriClient::Backend::V2::Badge.badge_assignment_callback(payload: {})`
+
+HTTP API: POST /api/v2/BadgeAssignment`
+
+Parameters:
+
+- `payload`: **Hash** request payload. optional
+  - `payload.refId`: **String** . required
+  - `payload.outcome`: **String** . required
+  - `payload.badgeUrl`: **String** . required
+
+## list_badges
+
+Summary:
+Gets a list of Badge objects assigned to the currently logged in User.
+
+Signature: `list_badges(strToken:)`
+Invocation: `MemoriClient::Backend::V2::Badge.list_badges(strToken:)`
+
+HTTP API: GET /api/v2/Badges/{strToken}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+
+## get_badge
+
+Summary:
+Gets a list of Badge objects assigned to the currently logged in User.
+
+Signature: `get_badge(strToken:, strBadgeID:)`
+Invocation: `MemoriClient::Backend::V2::Badge.get_badge(strToken:, strBadgeID:)`
+
+HTTP API: GET /api/v2/Badge/{strToken}/{strBadgeID}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strBadgeID`: **string** The ID of the Badge object. required
+
+

data/doc/MemoriClient::Backend::V2::CompletionConfig.md

@@ -0,0 +1,115 @@
+# Module `MemoriClient::Backend::V2::CompletionConfig`
+
+## list_completion_configs
+
+Summary:
+Gets a list of Completion Config objects allowed for the user.
+
+Signature: `list_completion_configs(strToken:, purpose: nil)`
+Invocation: `MemoriClient::Backend::V2::CompletionConfig.list_completion_configs(strToken:, purpose: nil)`
+
+HTTP API: GET /api/v2/CompletionConfigs/{strToken}/{purpose}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `purpose`: **string** Optional filter on Completion Config purpose ("QA" for Question Answering, "IE" for Import/Export, "DT" for Deep Thought).. optional
+
+## get_completion_config
+
+Summary:
+Gets the details of a Completion Config of a specific object
+
+Signature: `get_completion_config(strToken:, strConfigID:)`
+Invocation: `MemoriClient::Backend::V2::CompletionConfig.get_completion_config(strToken:, strConfigID:)`
+
+HTTP API: GET /api/v2/CompletionConfig/{strToken}/{strConfigID}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strConfigID`: **string** The Completion Config object ID. required
+
+## update_completion_config
+
+Summary:
+Updates an existing Completion Config object.  A user can only update a Completion Config object owned by him,  unless it has administrative rights.
+
+Signature: `update_completion_config(strToken:, strConfigID:, payload: {})`
+Invocation: `MemoriClient::Backend::V2::CompletionConfig.update_completion_config(strToken:, strConfigID:, payload: {})`
+
+HTTP API: PATCH /api/v2/CompletionConfig/{strToken}/{strConfigID}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strConfigID`: **string** The ID of the Completion Config object. required
+- `payload`: **Hash** request payload. optional
+  - `payload.completionConfigID`: **String** . optional
+  - `payload.configName`: **String** . optional
+  - `payload.description`: **String** . optional
+  - `payload.provider`: **String** . optional
+  - `payload.endPoint`: **String** . optional
+  - `payload.apiKey`: **String** . optional
+  - `payload.model`: **String** . optional
+  - `payload.questionAnsweringEnabled`: **Boolean** . optional
+  - `payload.importExportEnabled`: **Boolean** . optional
+  - `payload.deepThoughtEnabled`: **Boolean** . optional
+  - `payload.ownerUserID`: **String** . optional
+  - `payload.ownerUserName`: **String** . optional
+  - `payload.ownerTenantName`: **String** . optional
+  - `payload.visibleToTenantUsers`: **Boolean** . optional
+  - `payload.visibleToOtherUsers`: **Boolean** . optional
+  - `payload.useAsDefault`: **Boolean** . optional
+  - `payload.chargeable`: **Boolean** . optional
+  - `payload.applyTo`: **String** . optional
+
+## delete_completion_config
+
+Summary:
+Deletes an existing Completion Config object.  A user can only delete a Completion Config object owned by him,  unless it has administrative rights.
+
+Signature: `delete_completion_config(strToken:, strConfigID:)`
+Invocation: `MemoriClient::Backend::V2::CompletionConfig.delete_completion_config(strToken:, strConfigID:)`
+
+HTTP API: DELETE /api/v2/CompletionConfig/{strToken}/{strConfigID}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strConfigID`: **string** The ID of the Completion Config object. required
+
+## add_completion_config
+
+Summary:
+Creates a new Completion Config object.  The created Completion Config object is owned by the currently logged-in user.
+
+Signature: `add_completion_config(strToken:, payload: {})`
+Invocation: `MemoriClient::Backend::V2::CompletionConfig.add_completion_config(strToken:, payload: {})`
+
+HTTP API: POST /api/v2/CompletionConfig/{strToken}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `payload`: **Hash** request payload. optional
+  - `payload.completionConfigID`: **String** . optional
+  - `payload.configName`: **String** . optional
+  - `payload.description`: **String** . optional
+  - `payload.provider`: **String** . optional
+  - `payload.endPoint`: **String** . optional
+  - `payload.apiKey`: **String** . optional
+  - `payload.model`: **String** . optional
+  - `payload.questionAnsweringEnabled`: **Boolean** . optional
+  - `payload.importExportEnabled`: **Boolean** . optional
+  - `payload.deepThoughtEnabled`: **Boolean** . optional
+  - `payload.ownerUserID`: **String** . optional
+  - `payload.ownerUserName`: **String** . optional
+  - `payload.ownerTenantName`: **String** . optional
+  - `payload.visibleToTenantUsers`: **Boolean** . optional
+  - `payload.visibleToOtherUsers`: **Boolean** . optional
+  - `payload.useAsDefault`: **Boolean** . optional
+  - `payload.chargeable`: **Boolean** . optional
+  - `payload.applyTo`: **String** . optional
+
+

data/doc/MemoriClient::Backend::V2::ConsumptionLog.md

@@ -0,0 +1,57 @@
+# Module `MemoriClient::Backend::V2::ConsumptionLog`
+
+## get_tenant_consumption_logs
+
+Summary:
+Gets the Consumption Log objects for a specific Tenant in a specific date interval.
+
+Signature: `get_tenant_consumption_logs(strToken:, tenantName:, strType:, strDateFrom: nil, strDateTo: nil)`
+Invocation: `MemoriClient::Backend::V2::ConsumptionLog.get_tenant_consumption_logs(strToken:, tenantName:, strType:, strDateFrom: nil, strDateTo: nil)`
+
+HTTP API: GET /api/v2/TenantConsumptionLogs/{strToken}/{tenantName}/{strType}/{strDateFrom}/{strDateTo}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `tenantName`: **string** The name of the Tenant. required
+- `strType`: **string** Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
+- `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
+- `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
+
+## get_user_consumption_logs
+
+Summary:
+Gets the Consumption Log objects for a specific User in a specific date interval.
+
+Signature: `get_user_consumption_logs(strToken:, strUserID:, strType:, strDateFrom: nil, strDateTo: nil)`
+Invocation: `MemoriClient::Backend::V2::ConsumptionLog.get_user_consumption_logs(strToken:, strUserID:, strType:, strDateFrom: nil, strDateTo: nil)`
+
+HTTP API: GET /api/v2/UserConsumptionLogs/{strToken}/{strUserID}/{strType}/{strDateFrom}/{strDateTo}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strUserID`: **string** The ID of the User object. required
+- `strType`: **string** Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
+- `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
+- `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
+
+## get_memori_consumption_logs
+
+Summary:
+Gets the Consumption Log objects for a specific Memori in a specific date interval.
+
+Signature: `get_memori_consumption_logs(strToken:, strMemoriID:, strType:, strDateFrom: nil, strDateTo: nil)`
+Invocation: `MemoriClient::Backend::V2::ConsumptionLog.get_memori_consumption_logs(strToken:, strMemoriID:, strType:, strDateFrom: nil, strDateTo: nil)`
+
+HTTP API: GET /api/v2/MemoriConsumptionLogs/{strToken}/{strMemoriID}/{strType}/{strDateFrom}/{strDateTo}`
+
+Parameters:
+
+- `strToken`: **string** The login token. required
+- `strMemoriID`: **string** The ID of the Memori object. required
+- `strType`: **string** Type of consumption (i.e. granularity), it may either be Daily or Monthly. required
+- `strDateFrom`: **string** The optional begin of the date interval, in UTC time, in the format yyyyMMdd. optional
+- `strDateTo`: **string** The optional end of the date interval, in UTC time, in the format yyyyMMdd. optional
+
+