trieve_ruby_client 0.8.2 → 0.10.7

data/docs/CreateMessageReqPayload.md

@@ -0,0 +1,42 @@
+# TrieveRubyClient::CreateMessageReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completion_first** | **Boolean** | Completion first decides whether the stream should contain the stream of the completion response or the chunks first. Default is false. Keep in mind that || is used to separate the chunks from the completion response. If || is in the completion then you may want to split on ||{ instead. | [optional] |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **frequency_penalty** | **Float** | Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. Default is 0.7. | [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] |
+| **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>` tags to the chunk_html of the chunks to highlight matching splits and return the highlights on each scored chunk in the response. | [optional] |
+| **max_tokens** | **Integer** | The maximum number of tokens to generate in the chat completion. Default is None. | [optional] |
+| **new_message_content** | **String** | The content of the user message to attach to the topic and then generate an assistant message in response to. |  |
+| **presence_penalty** | **Float** | Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. Default is 0.7. | [optional] |
+| **search_type** | **String** | Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. Default is \"hybrid\". | [optional] |
+| **stop_tokens** | **Array<String>** | Stop tokens are up to 4 sequences where the API will stop generating further tokens. Default is None. | [optional] |
+| **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] |
+| **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.5. | [optional] |
+| **topic_id** | **String** | The ID of the topic to attach the message to. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateMessageReqPayload.new(
+  completion_first: null,
+  filters: null,
+  frequency_penalty: null,
+  highlight_delimiters: null,
+  highlight_results: null,
+  max_tokens: null,
+  new_message_content: null,
+  presence_penalty: null,
+  search_type: null,
+  stop_tokens: null,
+  stream_response: null,
+  temperature: null,
+  topic_id: null
+)
+```
+

data/docs/CreateTopicReqPayload.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::CreateTopicReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_user_message** | **String** | The first message which will belong to the topic. The topic name is generated based on this message similar to how it works in the OpenAI chat UX if a name is not explicitly provided on the name request body key. | [optional] |
+| **name** | **String** | The name of the topic. If this is not provided, the topic name is generated from the first_user_message. | [optional] |
+| **owner_id** | **String** | The owner_id of the topic. This is typically a browser fingerprint or your user's id. It is used to group topics together for a user. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateTopicReqPayload.new(
+  first_user_message: null,
+  name: null,
+  owner_id: null
+)
+```
+

data/docs/Dataset.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **client_configuration** | **Object** |  |  |
 | **created_at** | **Time** |  |  |
+| **deleted** | **Integer** |  |  |
 | **id** | **String** |  |  |
 | **name** | **String** |  |  |
 | **organization_id** | **String** |  |  |
@@ -21,6 +22,7 @@ require 'trieve_ruby_client'
 instance = TrieveRubyClient::Dataset.new(
   client_configuration: null,
   created_at: null,
+  deleted: null,
   id: null,
   name: null,
   organization_id: null,

data/docs/DatasetApi.md

@@ -4,14 +4,89 @@ All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**clear_dataset**](DatasetApi.md#clear_dataset) | **PUT** /api/dataset/clear/{dataset_id} | Clear Dataset |
 | [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset |
 | [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset |
+| [**delete_dataset_by_tracking_id**](DatasetApi.md#delete_dataset_by_tracking_id) | **DELETE** /api/dataset/tracking_id/{tracking_id} | Delete Dataset by Tracking ID |
 | [**get_client_dataset_config**](DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration |
 | [**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 Datasets from Organization |
+| [**get_usage_by_dataset_id**](DatasetApi.md#get_usage_by_dataset_id) | **GET** /api/dataset/usage/{dataset_id} | Get Usage By Dataset ID |
 | [**update_dataset**](DatasetApi.md#update_dataset) | **PUT** /api/dataset | Update Dataset |
 
 
+## clear_dataset
+
+> clear_dataset(tr_dataset, dataset_id)
+
+Clear Dataset
+
+Clear Dataset  Clears a dataset. The auth'ed user must be an owner of the organization to clear a dataset.
+
+### Examples
+
+```ruby
+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
+dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to clear.
+
+begin
+  # Clear Dataset
+  api_instance.clear_dataset(tr_dataset, dataset_id)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling DatasetApi->clear_dataset: #{e}"
+end
+```
+
+#### Using the clear_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)> clear_dataset_with_http_info(tr_dataset, dataset_id)
+
+```ruby
+begin
+  # Clear Dataset
+  data, status_code, headers = api_instance.clear_dataset_with_http_info(tr_dataset, dataset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling DatasetApi->clear_dataset_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **dataset_id** | **String** | The id of the dataset you want to clear. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## create_dataset
 
 > <Dataset> create_dataset(tr_organization, create_dataset_request)
@@ -157,6 +232,78 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## delete_dataset_by_tracking_id
+
+> delete_dataset_by_tracking_id(tr_dataset, tracking_id)
+
+Delete Dataset by Tracking ID
+
+Delete Dataset by Tracking ID  Delete a dataset by its tracking id. 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: 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
+tracking_id = 'tracking_id_example' # String | The tracking id of the dataset you want to delete.
+
+begin
+  # Delete Dataset by Tracking ID
+  api_instance.delete_dataset_by_tracking_id(tr_dataset, tracking_id)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling DatasetApi->delete_dataset_by_tracking_id: #{e}"
+end
+```
+
+#### Using the delete_dataset_by_tracking_id_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_by_tracking_id_with_http_info(tr_dataset, tracking_id)
+
+```ruby
+begin
+  # Delete Dataset by Tracking ID
+  data, status_code, headers = api_instance.delete_dataset_by_tracking_id_with_http_info(tr_dataset, tracking_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling DatasetApi->delete_dataset_by_tracking_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **tracking_id** | **String** | The tracking id of the dataset you want to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_client_dataset_config
 
 > <ClientDatasetConfiguration> get_client_dataset_config(tr_dataset)
@@ -230,11 +377,11 @@ end
 
 ## get_dataset
 
-> <Dataset> get_dataset(tr_organization, tr_dataset, dataset_id)
+> <Dataset> get_dataset(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.
+Get Dataset  Get a dataset by id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -250,13 +397,12 @@ TrieveRubyClient.configure do |config|
 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)
+  result = api_instance.get_dataset(tr_dataset, dataset_id)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling DatasetApi->get_dataset: #{e}"
@@ -267,12 +413,12 @@ end
 
 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)
+> <Array(<Dataset>, Integer, Hash)> get_dataset_with_http_info(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)
+  data, status_code, headers = api_instance.get_dataset_with_http_info(tr_dataset, dataset_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Dataset>
@@ -285,7 +431,6 @@ end
 
 | 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. |  |
 
@@ -305,11 +450,11 @@ end
 
 ## get_datasets_from_organization
 
-> <Array<DatasetAndUsage>> get_datasets_from_organization(tr_organization, organization_id)
+> <Array<DatasetAndUsage>> get_datasets_from_organization(tr_organization, organization_id, opts)
 
 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.
+Get Datasets from Organization  Get all datasets for an organization. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -327,10 +472,14 @@ 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
+opts = {
+  limit: 789, # Integer | The number of records to return
+  offset: 789 # Integer | The number of records to skip
+}
 
 begin
   # Get Datasets from Organization
-  result = api_instance.get_datasets_from_organization(tr_organization, organization_id)
+  result = api_instance.get_datasets_from_organization(tr_organization, organization_id, opts)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling DatasetApi->get_datasets_from_organization: #{e}"
@@ -341,12 +490,12 @@ end
 
 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)
+> <Array(<Array<DatasetAndUsage>>, Integer, Hash)> get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
 
 ```ruby
 begin
   # Get Datasets from Organization
-  data, status_code, headers = api_instance.get_datasets_from_organization_with_http_info(tr_organization, organization_id)
+  data, status_code, headers = api_instance.get_datasets_from_organization_with_http_info(tr_organization, organization_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<DatasetAndUsage>>
@@ -361,6 +510,8 @@ end
 | ---- | ---- | ----------- | ----- |
 | **tr_organization** | **String** | The organization id to use for the request |  |
 | **organization_id** | **String** | id of the organization you want to retrieve datasets for |  |
+| **limit** | **Integer** | The number of records to return | [optional] |
+| **offset** | **Integer** | The number of records to skip | [optional] |
 
 ### Return type
 
@@ -376,6 +527,79 @@ end
 - **Accept**: application/json
 
 
+## get_usage_by_dataset_id
+
+> <DatasetUsageCount> get_usage_by_dataset_id(tr_dataset, dataset_id)
+
+Get Usage By Dataset ID
+
+Get Usage By Dataset ID  Get the usage for a dataset by its id.
+
+### Examples
+
+```ruby
+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
+dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to retrieve usage for.
+
+begin
+  # Get Usage By Dataset ID
+  result = api_instance.get_usage_by_dataset_id(tr_dataset, dataset_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling DatasetApi->get_usage_by_dataset_id: #{e}"
+end
+```
+
+#### Using the get_usage_by_dataset_id_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DatasetUsageCount>, Integer, Hash)> get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id)
+
+```ruby
+begin
+  # Get Usage By Dataset ID
+  data, status_code, headers = api_instance.get_usage_by_dataset_id_with_http_info(tr_dataset, dataset_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DatasetUsageCount>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling DatasetApi->get_usage_by_dataset_id_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **dataset_id** | **String** | The id of the dataset you want to retrieve usage for. |  |
+
+### Return type
+
+[**DatasetUsageCount**](DatasetUsageCount.md)
+
+### Authorization
+
+[ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## update_dataset
 
 > <Dataset> update_dataset(tr_organization, update_dataset_request)

data/docs/DateRange.md

@@ -0,0 +1,24 @@
+# TrieveRubyClient::DateRange
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **gt** | **String** |  | [optional] |
+| **gte** | **String** |  | [optional] |
+| **lt** | **String** |  | [optional] |
+| **lte** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::DateRange.new(
+  gt: null,
+  gte: null,
+  lt: null,
+  lte: null
+)
+```
+

data/docs/EditMessageReqPayload.md

@@ -0,0 +1,44 @@
+# TrieveRubyClient::EditMessageReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completion_first** | **Boolean** | Completion first decides whether the stream should contain the stream of the completion response or the chunks first. Default is false. Keep in mind that || is used to separate the chunks from the completion response. If || is in the completion then you may want to split on ||{ instead. | [optional] |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **frequency_penalty** | **Float** | Frequency penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. Default is 0.7. | [optional] |
+| **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] |
+| **max_tokens** | **Integer** | The maximum number of tokens to generate in the chat completion. | [optional] |
+| **message_sort_order** | **Integer** | The sort order of the message to edit. |  |
+| **new_message_content** | **String** | The new content of the message to replace the old content with. |  |
+| **presence_penalty** | **Float** | Presence penalty is a number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics. | [optional] |
+| **search_type** | **String** | Search_type can be either \"semantic\", \"fulltext\", or \"hybrid\". \"hybrid\" will pull in one page (10 chunks) of both semantic and full-text results then re-rank them using BAAI/bge-reranker-large. \"semantic\" will pull in one page (10 chunks) of the nearest cosine distant vectors. \"fulltext\" will pull in one page (10 chunks) of full-text results based on SPLADE. | [optional] |
+| **stop_tokens** | **Array<String>** | Stop tokens are up to 4 sequences where the API will stop generating further tokens. | [optional] |
+| **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] |
+| **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. Default is 0.7. | [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::EditMessageReqPayload.new(
+  completion_first: null,
+  filters: null,
+  frequency_penalty: null,
+  highlight_citations: null,
+  highlight_delimiters: null,
+  max_tokens: null,
+  message_sort_order: null,
+  new_message_content: null,
+  presence_penalty: null,
+  search_type: null,
+  stop_tokens: null,
+  stream_response: null,
+  temperature: null,
+  topic_id: null
+)
+```
+

data/docs/FieldCondition.md

@@ -4,6 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **date_range** | [**DateRange**](DateRange.md) |  | [optional] |
 | **field** | **String** | Field is the name of the field to filter on. The field value will be used to check for an exact substring match on the metadata values for each existing chunk. This is useful for when you want to filter chunks by arbitrary metadata. To access fields inside of the metadata that you provide with the card, prefix the field name with `metadata.`. |  |
 | **geo_bounding_box** | [**LocationBoundingBox**](LocationBoundingBox.md) |  | [optional] |
 | **geo_polygon** | [**LocationPolygon**](LocationPolygon.md) |  | [optional] |
@@ -17,6 +18,7 @@
 require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::FieldCondition.new(
+  date_range: null,
   field: null,
   geo_bounding_box: null,
   geo_polygon: null,

data/docs/File.md

@@ -11,7 +11,7 @@
 | **link** | **String** |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
 | **size** | **Integer** |  |  |
-| **tag_set** | **String** |  | [optional] |
+| **tag_set** | **Array<String>** |  | [optional] |
 | **time_stamp** | **Time** |  | [optional] |
 | **updated_at** | **Time** |  |  |
 

data/docs/FileApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Delete File
 
-Delete File  Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user must be an admin or owner of the dataset's organization to delete a file.
+Delete File  Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but only delete them all together if you specify delete_chunks to be true. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -232,7 +232,7 @@ end
 
 ## upload_file_handler
 
-> <UploadFileResult> upload_file_handler(tr_dataset, upload_file_data)
+> <UploadFileResult> upload_file_handler(tr_dataset, upload_file_req_payload)
 
 Upload File
 
@@ -253,11 +253,11 @@ end
 
 api_instance = TrieveRubyClient::FileApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
-upload_file_data = TrieveRubyClient::UploadFileData.new({base64_file: 'base64_file_example', file_name: 'file_name_example'}) # UploadFileData | JSON request payload to upload a file
+upload_file_req_payload = TrieveRubyClient::UploadFileReqPayload.new({base64_file: 'base64_file_example', file_name: 'file_name_example'}) # UploadFileReqPayload | JSON request payload to upload a file
 
 begin
   # Upload File
-  result = api_instance.upload_file_handler(tr_dataset, upload_file_data)
+  result = api_instance.upload_file_handler(tr_dataset, upload_file_req_payload)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling FileApi->upload_file_handler: #{e}"
@@ -268,12 +268,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UploadFileResult>, Integer, Hash)> upload_file_handler_with_http_info(tr_dataset, upload_file_data)
+> <Array(<UploadFileResult>, Integer, Hash)> upload_file_handler_with_http_info(tr_dataset, upload_file_req_payload)
 
 ```ruby
 begin
   # Upload File
-  data, status_code, headers = api_instance.upload_file_handler_with_http_info(tr_dataset, upload_file_data)
+  data, status_code, headers = api_instance.upload_file_handler_with_http_info(tr_dataset, upload_file_req_payload)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UploadFileResult>
@@ -287,7 +287,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **upload_file_data** | [**UploadFileData**](UploadFileData.md) | JSON request payload to upload a file |  |
+| **upload_file_req_payload** | [**UploadFileReqPayload**](UploadFileReqPayload.md) | JSON request payload to upload a file |  |
 
 ### Return type
 

data/docs/GenerateChunksRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **chunk_ids** | **Array<String>** | The ids of the chunks to be retrieved and injected into the context window for RAG. |  |
+| **highlight_results** | **Boolean** | Set highlight_results to false for a slight latency improvement (1-10ms). If not specified, this defaults to true. This will add `<b><mark>`` tags to the chunk_html of the chunks to highlight matching splits. | [optional] |
 | **prev_messages** | [**Array<ChatMessageProxy>**](ChatMessageProxy.md) | The previous messages to be placed into the chat history. The last message in this array will be the prompt for the model to inference on. The length of this array must be at least 1. |  |
 | **prompt** | **String** | Prompt for the last message in the prev_messages array. This will be used to generate the next message in the chat. The default is 'Respond to the instruction and include the doc numbers that you used in square brackets at the end of the sentences that you used the docs for:'. You can also specify an empty string to leave the final message alone such that your user's final message can be used as the prompt. See docs.trieve.ai or contact us for more information. | [optional] |
 | **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] |
@@ -16,6 +17,7 @@ require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::GenerateChunksRequest.new(
   chunk_ids: null,
+  highlight_results: null,
   prev_messages: null,
   prompt: null,
   stream_response: null

data/docs/GetDatasetsPagination.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::GetDatasetsPagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional] |
+| **offset** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::GetDatasetsPagination.new(
+  limit: null,
+  offset: null
+)
+```
+

data/docs/HasIDCondition.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::HasIDCondition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ids** | **Array<String>** |  | [optional] |
+| **tracking_ids** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::HasIDCondition.new(
+  ids: null,
+  tracking_ids: null
+)
+```
+

data/docs/InvitationApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Send Invitation
 
-Send Invitation  Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their.
+Send Invitation  Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples