trieve_ruby_client 0.3.4

data/docs/DatasetApi.md

@@ -0,0 +1,480 @@
+# TrieveRubyClient::DatasetApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | create_dataset |
+| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | delete_dataset |
+| [**get_client_dataset_config**](DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | get_client_dataset_config |
+| [**get_dataset**](DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | get_dataset |
+| [**get_datasets_from_organization**](DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | get_organization_datasets |
+| [**update_dataset**](DatasetApi.md#update_dataset) | **PUT** /api/dataset | update_dataset |
+
+
+## create_dataset
+
+> <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
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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(<Dataset>, Integer, Hash)> create_dataset_with_http_info(tr_organization, create_dataset_request)
+
+```ruby
+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**](CreateDatasetRequest.md) | JSON request payload to create a new dataset |  |
+
+### Return type
+
+[**Dataset**](Dataset.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#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
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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)
+
+```ruby
+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**](DeleteDatasetRequest.md) | JSON request payload to delete a dataset |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_client_dataset_config
+
+> <ClientDatasetConfiguration> get_client_dataset_config(tr_dataset)
+
+get_client_dataset_config
+
+get_client_dataset_config  Get the client configuration for a dataset. Will use the TR-D
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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_dataset_config
+  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(<ClientDatasetConfiguration>, Integer, Hash)> get_client_dataset_config_with_http_info(tr_dataset)
+
+```ruby
+begin
+  # get_client_dataset_config
+  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**](ClientDatasetConfiguration.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_dataset
+
+> <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
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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(<Dataset>, Integer, Hash)> get_dataset_with_http_info(tr_organization, tr_dataset, dataset_id)
+
+```ruby
+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 | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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**](Dataset.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_datasets_from_organization
+
+> <Array<DatasetAndUsage>> get_datasets_from_organization(tr_organization, organization_id)
+
+get_organization_datasets
+
+get_organization_datasets  Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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_organization_datasets
+  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<DatasetAndUsage>>, Integer, Hash)> get_datasets_from_organization_with_http_info(tr_organization, organization_id)
+
+```ruby
+begin
+  # get_organization_datasets
+  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&lt;DatasetAndUsage&gt;**](DatasetAndUsage.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_dataset
+
+> <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
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # Configure API key authorization: Cookie
+  config.api_key['Cookie'] = '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['Cookie'] = 'Bearer'
+
+  # 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(<Dataset>, Integer, Hash)> update_dataset_with_http_info(tr_organization, update_dataset_request)
+
+```ruby
+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**](UpdateDatasetRequest.md) | JSON request payload to update a dataset |  |
+
+### Return type
+
+[**Dataset**](Dataset.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DatasetDTO.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::DatasetDTO
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_configuration** | **Object** |  |  |
+| **created_at** | **Time** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **organization_id** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DatasetDTO.new(
+  client_configuration: null,
+  created_at: null,
+  id: null,
+  name: null,
+  organization_id: null,
+  updated_at: null
+)
+```
+

data/docs/DatasetUsageCount.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::DatasetUsageCount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_count** | **Integer** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DatasetUsageCount.new(
+  chunk_count: null,
+  dataset_id: null,
+  id: null
+)
+```
+

data/docs/DeleteDatasetRequest.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::DeleteDatasetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **dataset_id** | **String** | The id of the dataset you want to delete. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DeleteDatasetRequest.new(
+  dataset_id: null
+)
+```
+

data/docs/DeleteTopicData.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::DeleteTopicData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **topic_id** | **String** | The id of the topic to target. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DeleteTopicData.new(
+  topic_id: null
+)
+```
+

data/docs/DeleteUserApiKeyRequest.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::DeleteUserApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key_id** | **String** | The id of the api key to delete. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DeleteUserApiKeyRequest.new(
+  api_key_id: null
+)
+```
+

data/docs/EditMessageData.md

@@ -0,0 +1,30 @@
+# TrieveRubyClient::EditMessageData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **highlight_citations** | **Boolean** | Whether or not to highlight the citations in the response. If this is set to true or not included, the citations will be highlighted. If this is set to false, the citations will not be highlighted. Default is true. | [optional] |
+| **highlight_delimiters** | **Array<String>** | The delimiters to use for highlighting the citations. If this is not included, the default delimiters will be used. Default is `[\".\", \"!\", \"?\", \"\\n\", \"\\t\", \",\"]`. | [optional] |
+| **message_sort_order** | **Integer** | The sort order of the message to edit. |  |
+| **model** | **String** | The model to use for the assistant generative inferences. This can be any model from the openrouter model list. If no model is provided, the gpt-3.5-turbo will be used.~ | [optional] |
+| **new_message_content** | **String** | The new content of the message to replace the old content with. |  |
+| **stream_response** | **Boolean** | Whether or not to stream the response. If this is set to true or not included, the response will be a stream. If this is set to false, the response will be a normal JSON response. Default is true. | [optional] |
+| **topic_id** | **String** | The id of the topic to edit the message at the given sort order for. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::EditMessageData.new(
+  highlight_citations: null,
+  highlight_delimiters: null,
+  message_sort_order: null,
+  model: null,
+  new_message_content: null,
+  stream_response: null,
+  topic_id: null
+)
+```
+

data/docs/ErrorResponseBody.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::ErrorResponseBody
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ErrorResponseBody.new(
+  message: null
+)
+```
+

data/docs/Event.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::Event
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **event_data** | **Object** |  |  |
+| **event_type** | **String** |  |  |
+| **id** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::Event.new(
+  created_at: null,
+  dataset_id: null,
+  event_data: null,
+  event_type: null,
+  id: null,
+  updated_at: null
+)
+```
+

data/docs/EventReturn.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::EventReturn
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<Event>**](Event.md) |  |  |
+| **page_count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::EventReturn.new(
+  events: null,
+  page_count: null
+)
+```
+