trieve_ruby_client 0.8.2 → 0.11.0

data/docs/StripeApi.md

@@ -5,7 +5,9 @@ All URIs are relative to *https://api.trieve.ai*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**cancel_subscription**](StripeApi.md#cancel_subscription) | **DELETE** /api/stripe/subscription/{subscription_id} | Cancel Subscription |
+| [**create_setup_checkout_session**](StripeApi.md#create_setup_checkout_session) | **POST** /api/stripe/checkout/setup/{organization_id} | Create checkout session setup |
 | [**direct_to_payment_link**](StripeApi.md#direct_to_payment_link) | **GET** /api/stripe/payment_link/{plan_id}/{organization_id} | Checkout |
+| [**get_all_invoices**](StripeApi.md#get_all_invoices) | **GET** /api/stripe/invoices/{organization_id} | Get All Invoices |
 | [**get_all_plans**](StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans |
 | [**update_subscription_plan**](StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan |
 
@@ -16,7 +18,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Cancel Subscription
 
-Cancel Subscription  Cancel a subscription by its id
+Cancel a subscription by its id
 
 ### Examples
 
@@ -82,13 +84,77 @@ nil (empty response body)
 - **Accept**: application/json
 
 
+## create_setup_checkout_session
+
+> <CreateSetupCheckoutSessionResPayload> create_setup_checkout_session(organization_id)
+
+Create checkout session setup
+
+Create a checkout session (setup)
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::StripeApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization to create setup checkout session for.
+
+begin
+  # Create checkout session setup
+  result = api_instance.create_setup_checkout_session(organization_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->create_setup_checkout_session: #{e}"
+end
+```
+
+#### Using the create_setup_checkout_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSetupCheckoutSessionResPayload>, Integer, Hash)> create_setup_checkout_session_with_http_info(organization_id)
+
+```ruby
+begin
+  # Create checkout session setup
+  data, status_code, headers = api_instance.create_setup_checkout_session_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSetupCheckoutSessionResPayload>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->create_setup_checkout_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** | The id of the organization to create setup checkout session for. |  |
+
+### Return type
+
+[**CreateSetupCheckoutSessionResPayload**](CreateSetupCheckoutSessionResPayload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## direct_to_payment_link
 
 > direct_to_payment_link(plan_id, organization_id)
 
 Checkout
 
-Checkout  Get a direct link to the stripe checkout page for the plan and organization
+Get a 303 SeeOther redirect link to the stripe checkout page for the plan and organization
 
 ### Examples
 
@@ -147,13 +213,77 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_all_invoices
+
+> <Array<StripeInvoice>> get_all_invoices(organization_id)
+
+Get All Invoices
+
+Get a list of all invoices
+
+### Examples
+
+```ruby
+require 'time'
+require 'trieve_ruby_client'
+
+api_instance = TrieveRubyClient::StripeApi.new
+organization_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the organization to get invoices for.
+
+begin
+  # Get All Invoices
+  result = api_instance.get_all_invoices(organization_id)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->get_all_invoices: #{e}"
+end
+```
+
+#### Using the get_all_invoices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<StripeInvoice>>, Integer, Hash)> get_all_invoices_with_http_info(organization_id)
+
+```ruby
+begin
+  # Get All Invoices
+  data, status_code, headers = api_instance.get_all_invoices_with_http_info(organization_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<StripeInvoice>>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling StripeApi->get_all_invoices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** | The id of the organization to get invoices for. |  |
+
+### Return type
+
+[**Array&lt;StripeInvoice&gt;**](StripeInvoice.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_all_plans
 
 > <Array<StripePlan>> get_all_plans
 
 Get All Plans
 
-Get All Plans  Get a list of all plans
+Get a list of all plans
 
 ### Examples
 
@@ -214,7 +344,7 @@ No authorization required
 
 Update Subscription Plan
 
-Update Subscription Plan  Update a subscription to a new plan
+Update a subscription to a new plan
 
 ### Examples
 

data/docs/StripeInvoice.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::StripeInvoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **hosted_invoice_url** | **String** |  |  |
+| **id** | **String** |  |  |
+| **org_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **total** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::StripeInvoice.new(
+  created_at: null,
+  hosted_invoice_url: null,
+  id: null,
+  org_id: null,
+  status: null,
+  total: null
+)
+```
+

data/docs/SuggestedQueriesReqPayload.md

@@ -0,0 +1,18 @@
+# TrieveRubyClient::SuggestedQueriesReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | The query to base the generated suggested queries off of using RAG. A hybrid search for 10 chunks from your dataset using this query will be performed and the context of the chunks will be used to generate the suggested queries. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SuggestedQueriesReqPayload.new(
+  query: null
+)
+```
+

data/docs/TopicApi.md

@@ -12,11 +12,11 @@ All URIs are relative to *https://api.trieve.ai*
 
 ## create_topic
 
-> <Topic> create_topic(tr_dataset, create_topic_data)
+> <Topic> create_topic(tr_dataset, create_topic_req_payload)
 
 Create Topic
 
-Create Topic  Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions.
+Create a new chat topic. Topics are attached to a owner_id's and act as a coordinator for conversation message history of gen-AI chat sessions. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -33,11 +33,11 @@ end
 
 api_instance = TrieveRubyClient::TopicApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
-create_topic_data = TrieveRubyClient::CreateTopicData.new({owner_id: 'owner_id_example'}) # CreateTopicData | JSON request payload to create chat topic
+create_topic_req_payload = TrieveRubyClient::CreateTopicReqPayload.new({owner_id: 'owner_id_example'}) # CreateTopicReqPayload | JSON request payload to create chat topic
 
 begin
   # Create Topic
-  result = api_instance.create_topic(tr_dataset, create_topic_data)
+  result = api_instance.create_topic(tr_dataset, create_topic_req_payload)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling TopicApi->create_topic: #{e}"
@@ -48,12 +48,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Topic>, Integer, Hash)> create_topic_with_http_info(tr_dataset, create_topic_data)
+> <Array(<Topic>, Integer, Hash)> create_topic_with_http_info(tr_dataset, create_topic_req_payload)
 
 ```ruby
 begin
   # Create Topic
-  data, status_code, headers = api_instance.create_topic_with_http_info(tr_dataset, create_topic_data)
+  data, status_code, headers = api_instance.create_topic_with_http_info(tr_dataset, create_topic_req_payload)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Topic>
@@ -67,7 +67,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **create_topic_data** | [**CreateTopicData**](CreateTopicData.md) | JSON request payload to create chat topic |  |
+| **create_topic_req_payload** | [**CreateTopicReqPayload**](CreateTopicReqPayload.md) | JSON request payload to create chat topic |  |
 
 ### Return type
 
@@ -89,7 +89,7 @@ end
 
 Delete Topic
 
-Delete Topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
+Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -161,7 +161,7 @@ nil (empty response body)
 
 Get All Topics for Owner ID
 
-Get All Topics for Owner ID  Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id.
+Get all topics belonging to an arbitary owner_id. This is useful for managing message history and chat sessions. It is common to use a browser fingerprint or your user's id as the owner_id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -230,11 +230,11 @@ end
 
 ## update_topic
 
-> update_topic(tr_dataset, update_topic_data)
+> update_topic(tr_dataset, update_topic_req_payload)
 
 Update Topic
 
-Update Topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
+Update an existing chat topic. Currently, only the name of the topic can be updated. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -251,11 +251,11 @@ end
 
 api_instance = TrieveRubyClient::TopicApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
-update_topic_data = TrieveRubyClient::UpdateTopicData.new({name: 'name_example', topic_id: 'topic_id_example'}) # UpdateTopicData | JSON request payload to update a chat topic
+update_topic_req_payload = TrieveRubyClient::UpdateTopicReqPayload.new({name: 'name_example', topic_id: 'topic_id_example'}) # UpdateTopicReqPayload | JSON request payload to update a chat topic
 
 begin
   # Update Topic
-  api_instance.update_topic(tr_dataset, update_topic_data)
+  api_instance.update_topic(tr_dataset, update_topic_req_payload)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling TopicApi->update_topic: #{e}"
 end
@@ -265,12 +265,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> update_topic_with_http_info(tr_dataset, update_topic_data)
+> <Array(nil, Integer, Hash)> update_topic_with_http_info(tr_dataset, update_topic_req_payload)
 
 ```ruby
 begin
   # Update Topic
-  data, status_code, headers = api_instance.update_topic_with_http_info(tr_dataset, update_topic_data)
+  data, status_code, headers = api_instance.update_topic_with_http_info(tr_dataset, update_topic_req_payload)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -284,7 +284,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **update_topic_data** | [**UpdateTopicData**](UpdateTopicData.md) | JSON request payload to update a chat topic |  |
+| **update_topic_req_payload** | [**UpdateTopicReqPayload**](UpdateTopicReqPayload.md) | JSON request payload to update a chat topic |  |
 
 ### Return type
 

data/docs/UpdateChunkData.md

@@ -9,6 +9,7 @@
 | **convert_html_to_text** | **Boolean** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] |
 | **group_ids** | **Array<String>** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
 | **group_tracking_ids** | **Array<String>** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
+| **image_urls** | **Array<String>** | Image urls are a list of urls to images that are associated with the chunk. This is useful for when you want to associate images with a chunk. If no image_urls are provided, the existing image_urls will be used. | [optional] |
 | **link** | **String** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] |
 | **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
 | **metadata** | **Object** | The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used. | [optional] |
@@ -28,6 +29,7 @@ instance = TrieveRubyClient::UpdateChunkData.new(
   convert_html_to_text: null,
   group_ids: null,
   group_tracking_ids: null,
+  image_urls: null,
   link: null,
   location: null,
   metadata: null,

data/docs/UpdateChunkGroupData.md

@@ -10,6 +10,7 @@
 | **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated. | [optional] |
 | **tag_set** | **Array<String>** | Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group. | [optional] |
 | **tracking_id** | **String** | Tracking Id of the chunk_group to update. | [optional] |
+| **update_chunks** | **Boolean** | Flag to update the chunks in the group. If true, each chunk in the group will be updated by appending the group's tags to the chunk's tags. Default is false. | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = TrieveRubyClient::UpdateChunkGroupData.new(
   metadata: null,
   name: null,
   tag_set: null,
-  tracking_id: null
+  tracking_id: null,
+  update_chunks: null
 )
 ```
 

data/docs/UpdateChunkReqPayload.md

@@ -0,0 +1,48 @@
+# TrieveRubyClient::UpdateChunkReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **boost_phrase** | [**BoostPhrase**](BoostPhrase.md) |  | [optional] |
+| **chunk_html** | **String** | HTML content of the chunk you want to update. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. If no chunk_html is provided, the existing chunk_html will be used. | [optional] |
+| **chunk_id** | **String** | Id of the chunk you want to update. You can provide either the chunk_id or the tracking_id. If both are provided, the chunk_id will be used. | [optional] |
+| **convert_html_to_text** | **Boolean** | Convert HTML to raw text before processing to avoid adding noise to the vector embeddings. By default this is true. If you are using HTML content that you want to be included in the vector embeddings, set this to false. | [optional] |
+| **distance_phrase** | [**DistancePhrase**](DistancePhrase.md) |  | [optional] |
+| **group_ids** | **Array<String>** | Group ids are the ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
+| **group_tracking_ids** | **Array<String>** | Group tracking_ids are the tracking_ids of the groups that the chunk should be placed into. This is useful for when you want to update a chunk and add it to a group or multiple groups in one request. | [optional] |
+| **image_urls** | **Array<String>** | Image urls are a list of urls to images that are associated with the chunk. This is useful for when you want to associate images with a chunk. If no image_urls are provided, the existing image_urls will be used. | [optional] |
+| **link** | **String** | Link of the chunk you want to update. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. If no link is provided, the existing link will be used. | [optional] |
+| **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
+| **metadata** | **Object** | The metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. If no metadata is provided, the existing metadata will be used. | [optional] |
+| **num_value** | **Float** | Num value is an arbitrary numerical value that can be used to filter chunks. This is useful for when you want to filter chunks by numerical value. If no num_value is provided, the existing num_value will be used. | [optional] |
+| **tag_set** | **Array<String>** | Tag set is a list of tags. This can be used to filter chunks by tag. Unlike with metadata filtering, HNSW indices will exist for each tag such that there is not a performance hit for filtering on them. If no tag_set is provided, the existing tag_set will be used. | [optional] |
+| **time_stamp** | **String** | Time_stamp should be an ISO 8601 combined date and time without timezone. It is used for time window filtering and recency-biasing search results. If no time_stamp is provided, the existing time_stamp will be used. | [optional] |
+| **tracking_id** | **String** | Tracking_id of the chunk you want to update. This is required to match an existing chunk. | [optional] |
+| **weight** | **Float** | Weight is a float which can be used to bias search results. This is useful for when you want to bias search results for a chunk. The magnitude only matters relative to other chunks in the chunk's dataset dataset. If no weight is provided, the existing weight will be used. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateChunkReqPayload.new(
+  boost_phrase: null,
+  chunk_html: null,
+  chunk_id: null,
+  convert_html_to_text: null,
+  distance_phrase: null,
+  group_ids: null,
+  group_tracking_ids: null,
+  image_urls: null,
+  link: null,
+  location: null,
+  metadata: null,
+  num_value: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  weight: null
+)
+```
+

data/docs/UpdateDatasetRequest.md

@@ -7,6 +7,7 @@
 | **client_configuration** | **Object** | The new client configuration of the dataset, can be arbitrary JSON. See docs.trieve.ai for more information. If not provided, the client configuration will not be updated. | [optional] |
 | **dataset_id** | **String** | The id of the dataset you want to update. | [optional] |
 | **dataset_name** | **String** | The new name of the dataset. Must be unique within the organization. If not provided, the name will not be updated. | [optional] |
+| **new_tracking_id** | **String** | Optional new tracking ID for the dataset. Can be used to track the dataset in external systems. Must be unique within the organization. If not provided, the tracking ID will not be updated. | [optional] |
 | **server_configuration** | **Object** | The new server configuration of the dataset, can be arbitrary JSON. See docs.trieve.ai for more information. If not provided, the server configuration will not be updated. | [optional] |
 | **tracking_id** | **String** | tracking ID for the dataset. Can be used to track the dataset in external systems. | [optional] |
 
@@ -19,6 +20,7 @@ instance = TrieveRubyClient::UpdateDatasetRequest.new(
   client_configuration: null,
   dataset_id: null,
   dataset_name: null,
+  new_tracking_id: null,
   server_configuration: null,
   tracking_id: null
 )

data/docs/UpdateGroupByTrackingIDReqPayload.md

@@ -0,0 +1,26 @@
+# TrieveRubyClient::UpdateGroupByTrackingIDReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** | Description to assign to the chunk_group. Convenience field for you to avoid having to remember what the group is for. If not provided, the description will not be updated. | [optional] |
+| **metadata** | **Object** | Optional metadata to assign to the chunk_group. This is a JSON object that can store any additional information you want to associate with the chunks inside of the chunk_group. | [optional] |
+| **name** | **String** | Name to assign to the chunk_group. Does not need to be unique. If not provided, the name will not be updated. | [optional] |
+| **tag_set** | **Array<String>** | Optional tags to assign to the chunk_group. This is a list of strings that can be used to categorize the chunks inside the chunk_group. | [optional] |
+| **tracking_id** | **String** | Tracking Id of the chunk_group to update. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateGroupByTrackingIDReqPayload.new(
+  description: null,
+  metadata: null,
+  name: null,
+  tag_set: null,
+  tracking_id: null
+)
+```
+

data/docs/UpdateTopicReqPayload.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::UpdateTopicReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The new name of the topic. A name is not generated from this field, it is used as-is. |  |
+| **topic_id** | **String** | The id of the topic to target. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateTopicReqPayload.new(
+  name: null,
+  topic_id: null
+)
+```
+

data/docs/UpdateUserOrgRoleData.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **organization_id** | **String** | The id of the organization to update the user for. |  |
 | **role** | **Integer** | Either 0 (user), 1 (admin), or 2 (owner). If not provided, the current role will be used. The auth'ed user must have a role greater than or equal to the role being assigned. |  |
-| **user_id** | **String** | The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the auth'ed user must be an admin (1) or owner (2) of the organization. | [optional] |
+| **user_id** | **String** | The id of the user to update, if not provided, the auth'ed user will be updated. If provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization. | [optional] |
 
 ## Example
 

data/docs/UploadFileReqPayload.md

@@ -0,0 +1,40 @@
+# TrieveRubyClient::UploadFileReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base64_file** | **String** | Base64 encoded file. This is the standard base64url encoding. |  |
+| **create_chunks** | **Boolean** | Create chunks is a boolean which determines whether or not to create chunks from the file. If false, you can manually chunk the file and send the chunks to the create_chunk endpoint with the file_id to associate chunks with the file. Meant mostly for advanced users. | [optional] |
+| **description** | **String** | Description is an optional convience field so you do not have to remember what the file contains or is about. It will be included on the group resulting from the file which will hold its chunk. | [optional] |
+| **file_name** | **String** | Name of the file being uploaded, including the extension. |  |
+| **group_tracking_id** | **String** | Group tracking id is an optional field which allows you to specify the tracking id of the group that is created from the file. Chunks created will be created with the tracking id of `group_tracking_id|<index of chunk>` | [optional] |
+| **link** | **String** | Link to the file. This can also be any string. This can be used to filter when searching for the file's resulting chunks. The link value will not affect embedding creation. | [optional] |
+| **metadata** | **Object** | Metadata is a JSON object which can be used to filter chunks. This is useful for when you want to filter chunks by arbitrary metadata. Unlike with tag filtering, there is a performance hit for filtering on metadata. Will be passed down to the file's chunks. | [optional] |
+| **rebalance_chunks** | **Boolean** | Rebalance chunks is an optional field which allows you to specify whether or not to rebalance the chunks created from the file. If not specified, the default true is used. If true, Trieve will evenly distribute remainder splits across chunks such that 66 splits with a `target_splits_per_chunk` of 20 will result in 3 chunks with 22 splits each. | [optional] |
+| **split_delimiters** | **Array<String>** | Split delimiters is an optional field which allows you to specify the delimiters to use when splitting the file before chunking the text. If not specified, the default [.!?\\n] are used to split into sentences. However, you may want to use spaces or other delimiters. | [optional] |
+| **tag_set** | **Array<String>** | Tag set is a comma separated list of tags which will be passed down to the chunks made from the file. Tags are used to filter chunks when searching. HNSW indices are created for each tag such that there is no performance loss when filtering on them. | [optional] |
+| **target_splits_per_chunk** | **Integer** | Target splits per chunk. This is an optional field which allows you to specify the number of splits you want per chunk. If not specified, the default 20 is used. However, you may want to use a different number. | [optional] |
+| **time_stamp** | **String** | Time stamp should be an ISO 8601 combined date and time without timezone. Time_stamp is used for time window filtering and recency-biasing search results. Will be passed down to the file's chunks. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UploadFileReqPayload.new(
+  base64_file: null,
+  create_chunks: null,
+  description: null,
+  file_name: null,
+  group_tracking_id: null,
+  link: null,
+  metadata: null,
+  rebalance_chunks: null,
+  split_delimiters: null,
+  tag_set: null,
+  target_splits_per_chunk: null,
+  time_stamp: null
+)
+```
+

data/docs/UserApi.md

@@ -11,11 +11,11 @@ All URIs are relative to *https://api.trieve.ai*
 
 ## delete_user_api_key
 
-> <Array<ApiKeyDTO>> delete_user_api_key(api_key_id)
+> delete_user_api_key(api_key_id)
 
 Delete User Api Key
 
-Delete User Api Key  Delete an api key for the auth'ed user.
+Delete an api key for the auth'ed user.
 
 ### Examples
 
@@ -35,8 +35,7 @@ api_key_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the api
 
 begin
   # Delete User Api Key
-  result = api_instance.delete_user_api_key(api_key_id)
-  p result
+  api_instance.delete_user_api_key(api_key_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling UserApi->delete_user_api_key: #{e}"
 end
@@ -44,9 +43,9 @@ end
 
 #### Using the delete_user_api_key_with_http_info variant
 
-This returns an Array which contains the response data, status code and headers.
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(<Array<ApiKeyDTO>>, Integer, Hash)> delete_user_api_key_with_http_info(api_key_id)
+> <Array(nil, Integer, Hash)> delete_user_api_key_with_http_info(api_key_id)
 
 ```ruby
 begin
@@ -54,7 +53,7 @@ begin
   data, status_code, headers = api_instance.delete_user_api_key_with_http_info(api_key_id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<ApiKeyDTO>>
+  p data # => nil
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling UserApi->delete_user_api_key_with_http_info: #{e}"
 end
@@ -68,7 +67,7 @@ end
 
 ### Return type
 
-[**Array&lt;ApiKeyDTO&gt;**](ApiKeyDTO.md)
+nil (empty response body)
 
 ### Authorization
 
@@ -86,7 +85,7 @@ end
 
 Set User Api Key
 
-Set User Api Key  Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
+Create a new api key for the auth'ed user. Successful response will contain the newly created api key. If a write role is assigned the api key will have permission level of the auth'ed user who calls this endpoint.
 
 ### Examples
 
@@ -157,7 +156,7 @@ end
 
 Update User
 
-Update User  Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the auth'ed user must be an admin (1) or owner (2) of the organization.
+Update a user's information. If the user_id is not provided, the auth'ed user will be updated. If the user_id is provided, the role of the auth'ed user or api key must be an admin (1) or owner (2) of the organization.
 
 ### Examples