TrieveRubyClient::DatasetApi

All URIs are relative to http://localhost:8090

Method	HTTP request	Description
create_dataset	POST /api/dataset	Create dataset
delete_dataset	DELETE /api/dataset	Delete Dataset
get_client_dataset_config	GET /api/dataset/envs	Get Client Configuration
get_dataset	GET /api/dataset/{dataset_id}	Get Dataset
get_datasets_from_organization	GET /api/dataset/organization/{organization_id}	Get Datasets from Organization
update_dataset	PUT /api/dataset	Update Dataset

create_dataset

create_dataset(tr_organization, create_dataset_request)

Create dataset

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

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::DatasetApi.new
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
create_dataset_request = TrieveRubyClient::CreateDatasetRequest.new({client_configuration: 3.56, dataset_name: 'dataset_name_example', organization_id: 'organization_id_example', server_configuration: 3.56}) # CreateDatasetRequest | JSON request payload to create a new dataset

begin
  # Create dataset
  result = api_instance.create_dataset(tr_organization, create_dataset_request)
  p result
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->create_dataset: #{e}"
end

Using the create_dataset_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> create_dataset_with_http_info(tr_organization, create_dataset_request)

begin
  # Create dataset
  data, status_code, headers = api_instance.create_dataset_with_http_info(tr_organization, create_dataset_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Dataset>
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->create_dataset_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
tr_organization	String	The organization id to use for the request
create_dataset_request	CreateDatasetRequest	JSON request payload to create a new dataset

Return type

Dataset

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_dataset

delete_dataset(tr_organization, delete_dataset_request)

Delete Dataset

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

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::DatasetApi.new
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
delete_dataset_request = TrieveRubyClient::DeleteDatasetRequest.new({dataset_id: 'dataset_id_example'}) # DeleteDatasetRequest | JSON request payload to delete a dataset

begin
  # Delete Dataset
  api_instance.delete_dataset(tr_organization, delete_dataset_request)
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->delete_dataset: #{e}"
end

Using the delete_dataset_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_dataset_with_http_info(tr_organization, delete_dataset_request)

begin
  # Delete Dataset
  data, status_code, headers = api_instance.delete_dataset_with_http_info(tr_organization, delete_dataset_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->delete_dataset_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
tr_organization	String	The organization id to use for the request
delete_dataset_request	DeleteDatasetRequest	JSON request payload to delete a dataset

Return type

nil (empty response body)

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

get_client_dataset_config

get_client_dataset_config(tr_dataset)

Get Client Configuration

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

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::DatasetApi.new
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request

begin
  # Get Client Configuration
  result = api_instance.get_client_dataset_config(tr_dataset)
  p result
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->get_client_dataset_config: #{e}"
end

Using the get_client_dataset_config_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_client_dataset_config_with_http_info(tr_dataset)

begin
  # Get Client Configuration
  data, status_code, headers = api_instance.get_client_dataset_config_with_http_info(tr_dataset)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ClientDatasetConfiguration>
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->get_client_dataset_config_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
tr_dataset	String	The dataset id to use for the request

Return type

ClientDatasetConfiguration

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_dataset

get_dataset(tr_organization, tr_dataset, dataset_id)

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.

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::DatasetApi.new
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to retrieve.

begin
  # Get Dataset
  result = api_instance.get_dataset(tr_organization, tr_dataset, dataset_id)
  p result
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->get_dataset: #{e}"
end

Using the get_dataset_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id)

begin
  # Get Dataset
  data, status_code, headers = api_instance.get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Dataset>
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->get_dataset_with_http_info: #{e}"
end

Parameters

Name	Type	Description
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.

Return type

Dataset

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_datasets_from_organization

<Array> get_datasets_from_organization(tr_organization, organization_id)

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.

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::DatasetApi.new
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | id of the organization you want to retrieve datasets for

begin
  # Get Datasets from Organization
  result = api_instance.get_datasets_from_organization(tr_organization, organization_id)
  p result
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->get_datasets_from_organization: #{e}"
end

Using the get_datasets_from_organization_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(<Array>, Integer, Hash)> get_datasets_from_organization_with_http_info(tr_organization, organization_id)

begin
  # Get Datasets from Organization
  data, status_code, headers = api_instance.get_datasets_from_organization_with_http_info(tr_organization, organization_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<DatasetAndUsage>>
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->get_datasets_from_organization_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
tr_organization	String	The organization id to use for the request
organization_id	String	id of the organization you want to retrieve datasets for

Return type

Array<DatasetAndUsage>

Authorization

ApiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_dataset

update_dataset(tr_organization, update_dataset_request)

Update Dataset

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

Examples

require 'time'
require 'trieve_ruby_client'
# setup authorization
TrieveRubyClient.configure do |config|
  # Configure API key authorization: ApiKey
  config.api_key['ApiKey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  # config.api_key_prefix['ApiKey'] = 'Bearer'
end

api_instance = TrieveRubyClient::DatasetApi.new
tr_organization = 'tr_organization_example' # String | The organization id to use for the request
update_dataset_request = TrieveRubyClient::UpdateDatasetRequest.new({dataset_id: 'dataset_id_example'}) # UpdateDatasetRequest | JSON request payload to update a dataset

begin
  # Update Dataset
  result = api_instance.update_dataset(tr_organization, update_dataset_request)
  p result
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->update_dataset: #{e}"
end

Using the update_dataset_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_dataset_with_http_info(tr_organization, update_dataset_request)

begin
  # Update Dataset
  data, status_code, headers = api_instance.update_dataset_with_http_info(tr_organization, update_dataset_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Dataset>
rescue TrieveRubyClient::ApiError => e
  puts "Error when calling DatasetApi->update_dataset_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
tr_organization	String	The organization id to use for the request
update_dataset_request	UpdateDatasetRequest	JSON request payload to update a dataset

Return type

Dataset

Authorization

ApiKey

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

DatasetApi.md

Latest commit

History

DatasetApi.md

File metadata and controls

TrieveRubyClient::DatasetApi

create_dataset

Examples

Using the create_dataset_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_dataset

Examples

Using the delete_dataset_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_client_dataset_config

Examples

Using the get_client_dataset_config_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_dataset

Examples

Using the get_dataset_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_datasets_from_organization

Examples

Using the get_datasets_from_organization_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

update_dataset

Examples

Using the update_dataset_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers