Class: MemoriClient::Backend::V2::ImportExport

Inherits:
Resource show all
Defined in:
lib/memori_client/backend/v2/import_export.rb

Overview

Generated on 2025-01-27 16:56:15 +0000

Class Method Summary collapse

Methods inherited from Resource

build_url

Methods inherited from Resource

build_arguments, build_url, exec_http_request, validate_payload!

Class Method Details

.export_csv(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ExportCSV/strToken/strMemoriID`

Exports contents of a Memori object to a CSV file.

‘export_csv(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • [] —

    payload.csvSpecs . optional

  • payload.password (String) —

    . optional



181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 181

def self.export_csv(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'csvSpecs',
    'password',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ExportCSV/{strToken}/{strMemoriID}', **args)
end

.export_dictionary(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ExportDictionary/strToken/strMemoriID`

Exports the dictionary of a Memori object to a JSONL file.

‘export_dictionary(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • [] —

    payload.dictionarySpecs . optional

  • payload.password (String) —

    . optional



314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 314

def self.export_dictionary(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'dictionarySpecs',
    'password',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ExportDictionary/{strToken}/{strMemoriID}', **args)
end

.export_functions_intents(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ExportFunctionsIntents/strToken/strMemoriID`

Exports functions, intents and intentSlots of a Memori object to a JSONL file

‘export_functions_intents(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.exportFunctions (Boolean) —

    . optional

  • payload.exportIntents (Boolean) —

    . optional

  • payload.exportIntentSlots (Boolean) —

    . optional

  • payload.functionsIds (Array) —

    . optional

  • payload.intentsIds (Array) —

    . optional

  • payload.intentSlotsIds (Array) —

    . optional

  • payload.password (String) —

    . optional



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 247

def self.export_functions_intents(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'exportFunctions',
    'exportIntentSlots',
    'exportIntents',
    'functionsIds',
    'intentSlotsIds',
    'intentsIds',
    'password',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ExportFunctionsIntents/{strToken}/{strMemoriID}', **args)
end

.export_jsonl(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ExportJSONL/strToken/strMemoriID`

Exports contents of a Memori object to a JSONL file, suitable for fine-tuning with generative AI platforms.

‘export_jsonl(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • [] —

    payload.jsonlSpecs . optional

  • payload.password (String) —

    . optional



209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 209

def self.export_jsonl(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'jsonlSpecs',
    'password',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ExportJSONL/{strToken}/{strMemoriID}', **args)
end

.import_csv(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ImportCSV/strToken/strMemoriID`

Starts an Import process for memories from a CSV file.

‘import_csv(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • [] —

    payload.csvSpecs . optional

  • payload.conclusive (Boolean) —

    . optional

  • payload.notPickable (Boolean) —

    . optional

  • payload.contextVarsToSet (Object) —

    . optional

  • payload.contextVarsToMatch (Object) —

    . optional

  • payload.memoryTags (Array) —

    . optional

  • payload.receiverID (String) —

    . optional

  • payload.addMediaLink (String) —

    . optional

  • payload.linkTitleHandling (String) —

    . optional

  • payload.linkTitle (String) —

    . optional

  • payload.rows (Array) —

    . optional

  • payload.importName (String) —

    . optional

  • payload.forceImport (Boolean) —

    . optional

  • payload.notes (String) —

    . optional



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 43

def self.import_csv(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'addMediaLink',
    'conclusive',
    'contextVarsToMatch',
    'contextVarsToSet',
    'csvSpecs',
    'forceImport',
    'importName',
    'linkTitle',
    'linkTitleHandling',
    'memoryTags',
    'notPickable',
    'notes',
    'receiverID',
    'rows',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ImportCSV/{strToken}/{strMemoriID}', **args)
end

.import_dictionary(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ImportDictionary/strToken/strMemoriID`

Imports a dictionary to a Memori object.

‘import_dictionary(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    . required

  • strMemoriID (string) —

    . required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.rows (Array) —

    . optional

  • payload.importName (String) —

    . optional

  • payload.forceImport (Boolean) —

    . optional

  • payload.notes (String) —

    . optional



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 284

def self.import_dictionary(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'forceImport',
    'importName',
    'notes',
    'rows',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ImportDictionary/{strToken}/{strMemoriID}', **args)
end

.import_functions_intents(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ImportFunctionsIntents/strToken/strMemoriID`

Starts an Import process for functions and intents from a jsonl file.

‘import_functions_intents(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • payload.rows (Array) —

    . optional

  • payload.importName (String) —

    . optional

  • payload.forceImport (Boolean) —

    . optional

  • payload.notes (String) —

    . optional



151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 151

def self.import_functions_intents(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'forceImport',
    'importName',
    'notes',
    'rows',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ImportFunctionsIntents/{strToken}/{strMemoriID}', **args)
end

.import_txt(strToken:, strMemoriID:, payload: {}) ⇒ Object

‘POST /api/v2/ImportExport/ImportTXT/strToken/strMemoriID`

Starts an Import process for memories from a TXT file.

‘import_txt(strToken:, strMemoriID:, payload: {})`

Parameters:

  • strToken (string) —

    The login token. required

  • strMemoriID (string) —

    The ID of the Memori object. required

  • payload (Hash) (defaults to: {}) —

    request payload. optional

  • [] —

    payload.txtSpecs . optional

  • payload.conclusive (Boolean) —

    . optional

  • payload.notPickable (Boolean) —

    . optional

  • payload.contextVarsToSet (Object) —

    . optional

  • payload.contextVarsToMatch (Object) —

    . optional

  • payload.memoryTags (Array) —

    . optional

  • payload.receiverID (String) —

    . optional

  • payload.addMediaLink (String) —

    . optional

  • payload.linkTitleHandling (String) —

    . optional

  • payload.linkTitle (String) —

    . optional

  • payload.rows (Array) —

    . optional

  • payload.importName (String) —

    . optional

  • payload.forceImport (Boolean) —

    . optional

  • payload.notes (String) —

    . optional



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/memori_client/backend/v2/import_export.rb', line 107

def self.import_txt(strToken:, strMemoriID:, payload: {})
  args = build_arguments(binding)
  payload_keys = [
    'addMediaLink',
    'conclusive',
    'contextVarsToMatch',
    'contextVarsToSet',
    'forceImport',
    'importName',
    'linkTitle',
    'linkTitleHandling',
    'memoryTags',
    'notPickable',
    'notes',
    'receiverID',
    'rows',
    'txtSpecs',
  ]
  payload_required_keys = %w[]
  validate_payload!(args[:payload], keys: payload_keys, required: payload_required_keys)

  exec_http_request('post', '/api/v2/ImportExport/ImportTXT/{strToken}/{strMemoriID}', **args)
end