Class: TrieveRubyClient::DatasetApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/api/dataset_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DatasetApi

Returns a new instance of DatasetApi.



19
20
21
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_dataset(tr_organization, create_dataset_request, opts = {}) ⇒ Dataset

Create dataset Create dataset Create a new dataset. The auth’ed user must be an owner of the organization to create a dataset.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • create_dataset_request (CreateDatasetRequest) —

    JSON request payload to create a new dataset

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 28

def create_dataset(tr_organization, create_dataset_request, opts = {})
  data, _status_code, _headers = create_dataset_with_http_info(tr_organization, create_dataset_request, opts)
  data
end

#create_dataset_with_http_info(tr_organization, create_dataset_request, opts = {}) ⇒ Array<(Dataset, Integer, Hash)>

Create dataset Create dataset Create a new dataset. The auth&#39;ed user must be an owner of the organization to create a dataset.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • create_dataset_request (CreateDatasetRequest) —

    JSON request payload to create a new dataset

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

    the optional parameters

Returns:

  • (Array<(Dataset, Integer, Hash)>) —

    Dataset data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 39

def create_dataset_with_http_info(tr_organization, create_dataset_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatasetApi.create_dataset ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.create_dataset"
  end
  # verify the required parameter 'create_dataset_request' is set
  if @api_client.config.client_side_validation && create_dataset_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_dataset_request' when calling DatasetApi.create_dataset"
  end
  # resource path
  local_var_path = '/api/dataset'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Organization'] = tr_organization

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_dataset_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Dataset'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"DatasetApi.create_dataset",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DatasetApi#create_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_dataset(tr_dataset, dataset_id, opts = {}) ⇒ nil

Delete Dataset Delete Dataset Delete a dataset. The auth’ed user must be an owner of the organization to delete a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • dataset_id (String) —

    The id of the dataset you want to delete.

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

    the optional parameters

Returns:

  • (nil) 


103
104
105
106
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 103

def delete_dataset(tr_dataset, dataset_id, opts = {})
  delete_dataset_with_http_info(tr_dataset, dataset_id, opts)
  nil
end

#delete_dataset_with_http_info(tr_dataset, dataset_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete Dataset Delete Dataset Delete a dataset. The auth&#39;ed user must be an owner of the organization to delete a dataset.

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

  • dataset_id (String) —

    The id of the dataset you want to delete.

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

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 114

def delete_dataset_with_http_info(tr_dataset, dataset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatasetApi.delete_dataset ...'
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.delete_dataset"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.delete_dataset"
  end
  # resource path
  local_var_path = '/api/dataset/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"DatasetApi.delete_dataset",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DatasetApi#delete_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_client_dataset_config(tr_dataset, opts = {}) ⇒ ClientDatasetConfiguration

Get Client Configuration Get Client Configuration Get the client configuration for a dataset. Will use the TR-D

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

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

    the optional parameters

Returns:



172
173
174
175
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 172

def get_client_dataset_config(tr_dataset, opts = {})
  data, _status_code, _headers = get_client_dataset_config_with_http_info(tr_dataset, opts)
  data
end

#get_client_dataset_config_with_http_info(tr_dataset, opts = {}) ⇒ Array<(ClientDatasetConfiguration, Integer, Hash)>

Get Client Configuration Get Client Configuration Get the client configuration for a dataset. Will use the TR-D

Parameters:

  • tr_dataset (String) —

    The dataset id to use for the request

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

    the optional parameters

Returns:

  • (Array<(ClientDatasetConfiguration, Integer, Hash)>) —

    ClientDatasetConfiguration data, response status code and response headers



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 182

def get_client_dataset_config_with_http_info(tr_dataset, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatasetApi.get_client_dataset_config ...'
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_client_dataset_config"
  end
  # resource path
  local_var_path = '/api/dataset/envs'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ClientDatasetConfiguration'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"DatasetApi.get_client_dataset_config",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DatasetApi#get_client_dataset_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_dataset(tr_organization, tr_dataset, dataset_id, opts = {}) ⇒ Dataset

Get Dataset Get Dataset Get a dataset by id. The auth’ed user must be an admin or owner of the organization to get a dataset.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • tr_dataset (String) —

    The dataset id to use for the request

  • dataset_id (String) —

    The id of the dataset you want to retrieve.

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 238

def get_dataset(tr_organization, tr_dataset, dataset_id, opts = {})
  data, _status_code, _headers = get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id, opts)
  data
end

#get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id, opts = {}) ⇒ Array<(Dataset, Integer, Hash)>

Get Dataset Get Dataset Get a dataset by id. The auth&#39;ed user must be an admin or owner of the organization to get a dataset.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • tr_dataset (String) —

    The dataset id to use for the request

  • dataset_id (String) —

    The id of the dataset you want to retrieve.

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

    the optional parameters

Returns:

  • (Array<(Dataset, Integer, Hash)>) —

    Dataset data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 250

def get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatasetApi.get_dataset ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.get_dataset"
  end
  # verify the required parameter 'tr_dataset' is set
  if @api_client.config.client_side_validation && tr_dataset.nil?
    fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling DatasetApi.get_dataset"
  end
  # verify the required parameter 'dataset_id' is set
  if @api_client.config.client_side_validation && dataset_id.nil?
    fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.get_dataset"
  end
  # resource path
  local_var_path = '/api/dataset/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'TR-Organization'] = tr_organization
  header_params[:'TR-Dataset'] = tr_dataset

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Dataset'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"DatasetApi.get_dataset",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DatasetApi#get_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_datasets_from_organization(tr_organization, organization_id, opts = {}) ⇒ Array<DatasetAndUsage>

Get Datasets from Organization Get Datasets from Organization Get all datasets for an organization. The auth’ed user must be an admin or owner of the organization to get its datasets.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    id of the organization you want to retrieve datasets for

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

    the optional parameters

Returns:



314
315
316
317
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 314

def get_datasets_from_organization(tr_organization, organization_id, opts = {})
  data, _status_code, _headers = get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
  data
end

#get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts = {}) ⇒ Array<(Array<DatasetAndUsage>, Integer, Hash)>

Get Datasets from Organization Get Datasets from Organization Get all datasets for an organization. The auth&#39;ed user must be an admin or owner of the organization to get its datasets.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • organization_id (String) —

    id of the organization you want to retrieve datasets for

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

    the optional parameters

Returns:

  • (Array<(Array<DatasetAndUsage>, Integer, Hash)>) —

    Array<DatasetAndUsage> data, response status code and response headers



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 325

def get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatasetApi.get_datasets_from_organization ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.get_datasets_from_organization"
  end
  # verify the required parameter 'organization_id' is set
  if @api_client.config.client_side_validation && organization_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_id' when calling DatasetApi.get_datasets_from_organization"
  end
  # resource path
  local_var_path = '/api/dataset/organization/{organization_id}'.sub('{' + 'organization_id' + '}', CGI.escape(organization_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'TR-Organization'] = tr_organization

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<DatasetAndUsage>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"DatasetApi.get_datasets_from_organization",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DatasetApi#get_datasets_from_organization\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_dataset(tr_organization, update_dataset_request, opts = {}) ⇒ Dataset

Update Dataset Update Dataset Update a dataset. The auth’ed user must be an owner of the organization to update a dataset.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • update_dataset_request (UpdateDatasetRequest) —

    JSON request payload to update a dataset

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

    the optional parameters

Returns:



384
385
386
387
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 384

def update_dataset(tr_organization, update_dataset_request, opts = {})
  data, _status_code, _headers = update_dataset_with_http_info(tr_organization, update_dataset_request, opts)
  data
end

#update_dataset_with_http_info(tr_organization, update_dataset_request, opts = {}) ⇒ Array<(Dataset, Integer, Hash)>

Update Dataset Update Dataset Update a dataset. The auth&#39;ed user must be an owner of the organization to update a dataset.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • update_dataset_request (UpdateDatasetRequest) —

    JSON request payload to update a dataset

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

    the optional parameters

Returns:

  • (Array<(Dataset, Integer, Hash)>) —

    Dataset data, response status code and response headers



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
 
# File 'lib/trieve_ruby_client/api/dataset_api.rb', line 395

def update_dataset_with_http_info(tr_organization, update_dataset_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DatasetApi.update_dataset ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.update_dataset"
  end
  # verify the required parameter 'update_dataset_request' is set
  if @api_client.config.client_side_validation && update_dataset_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_dataset_request' when calling DatasetApi.update_dataset"
  end
  # resource path
  local_var_path = '/api/dataset'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Organization'] = tr_organization

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_dataset_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Dataset'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"DatasetApi.update_dataset",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DatasetApi#update_dataset\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end