trieve_ruby_client 0.3.4

data/docs/Topic.md

@@ -0,0 +1,30 @@
+# TrieveRubyClient::Topic
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **deleted** | **Boolean** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **updated_at** | **Time** |  |  |
+| **user_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::Topic.new(
+  created_at: null,
+  dataset_id: null,
+  deleted: null,
+  id: null,
+  name: null,
+  updated_at: null,
+  user_id: null
+)
+```
+

data/docs/TopicApi.md

@@ -0,0 +1,321 @@
+# TrieveRubyClient::TopicApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_topic**](TopicApi.md#create_topic) | **POST** /api/topic | create_topic |
+| [**delete_topic**](TopicApi.md#delete_topic) | **DELETE** /api/topic | delete_topic |
+| [**get_all_topics_for_user**](TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | get_all_topics_for_user |
+| [**update_topic**](TopicApi.md#update_topic) | **PUT** /api/topic | update_topic |
+
+
+## create_topic
+
+> <Topic> create_topic(tr_dataset, create_topic_data)
+
+create_topic
+
+create_topic  Create a new chat topic. Topics are attached to a user and act as a coordinator for memory of gen-AI chat sessions. We are considering refactoring this resource of the API soon.
+
+### 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::TopicApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+create_topic_data = TrieveRubyClient::CreateTopicData.new # CreateTopicData | JSON request payload to create chat topic
+
+begin
+  # create_topic
+  result = api_instance.create_topic(tr_dataset, create_topic_data)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->create_topic: #{e}"
+end
+```
+
+#### Using the create_topic_with_http_info variant
+
+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)
+
+```ruby
+begin
+  # create_topic
+  data, status_code, headers = api_instance.create_topic_with_http_info(tr_dataset, create_topic_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Topic>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->create_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| 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 |  |
+
+### Return type
+
+[**Topic**](Topic.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_topic
+
+> delete_topic(tr_dataset, delete_topic_data)
+
+delete_topic
+
+delete_topic  Delete an existing chat topic. When a topic is deleted, all associated chat messages are also deleted.
+
+### 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::TopicApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+delete_topic_data = TrieveRubyClient::DeleteTopicData.new({topic_id: 'topic_id_example'}) # DeleteTopicData | JSON request payload to delete a chat topic
+
+begin
+  # delete_topic
+  api_instance.delete_topic(tr_dataset, delete_topic_data)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->delete_topic: #{e}"
+end
+```
+
+#### Using the delete_topic_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_topic_with_http_info(tr_dataset, delete_topic_data)
+
+```ruby
+begin
+  # delete_topic
+  data, status_code, headers = api_instance.delete_topic_with_http_info(tr_dataset, delete_topic_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->delete_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+| **delete_topic_data** | [**DeleteTopicData**](DeleteTopicData.md) | JSON request payload to delete a chat topic |  |
+
+### 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_all_topics_for_user
+
+> <Array<Topic>> get_all_topics_for_user(user_id, tr_dataset)
+
+get_all_topics_for_user
+
+get_all_topics_for_user  Get all topics belonging to a the auth'ed user. Soon, we plan to allow specification of the user for this route and include pagination.
+
+### 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::TopicApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the user to get topics for
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
+
+begin
+  # get_all_topics_for_user
+  result = api_instance.get_all_topics_for_user(user_id, tr_dataset)
+  p result
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->get_all_topics_for_user: #{e}"
+end
+```
+
+#### Using the get_all_topics_for_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Topic>>, Integer, Hash)> get_all_topics_for_user_with_http_info(user_id, tr_dataset)
+
+```ruby
+begin
+  # get_all_topics_for_user
+  data, status_code, headers = api_instance.get_all_topics_for_user_with_http_info(user_id, tr_dataset)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Topic>>
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->get_all_topics_for_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The id of the user to get topics for |  |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
+
+### Return type
+
+[**Array&lt;Topic&gt;**](Topic.md)
+
+### Authorization
+
+[Cookie](../README.md#Cookie), [ApiKey](../README.md#ApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_topic
+
+> update_topic(tr_dataset, update_topic_data)
+
+update_topic
+
+update_topic  Update an existing chat topic. Currently, only the name of the topic can be updated.
+
+### 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::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
+
+begin
+  # update_topic
+  api_instance.update_topic(tr_dataset, update_topic_data)
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->update_topic: #{e}"
+end
+```
+
+#### Using the update_topic_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)> update_topic_with_http_info(tr_dataset, update_topic_data)
+
+```ruby
+begin
+  # update_topic
+  data, status_code, headers = api_instance.update_topic_with_http_info(tr_dataset, update_topic_data)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrieveRubyClient::ApiError => e
+  puts "Error when calling TopicApi->update_topic_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| 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 |  |
+
+### 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
+

data/docs/UpdateChunkByTrackingIdData.md

@@ -0,0 +1,32 @@
+# TrieveRubyClient::UpdateChunkByTrackingIdData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **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. |  |
+| **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::UpdateChunkByTrackingIdData.new(
+  chunk_html: null,
+  group_ids: null,
+  group_tracking_ids: null,
+  link: null,
+  metadata: null,
+  time_stamp: null,
+  tracking_id: null,
+  weight: null
+)
+```
+

data/docs/UpdateChunkData.md

@@ -0,0 +1,34 @@
+# TrieveRubyClient::UpdateChunkData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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] |
+| **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] |
+| **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] |
+| **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] |
+| **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::UpdateChunkData.new(
+  chunk_html: null,
+  chunk_id: null,
+  group_ids: null,
+  group_tracking_ids: null,
+  link: null,
+  metadata: null,
+  time_stamp: null,
+  tracking_id: null,
+  weight: null
+)
+```
+

data/docs/UpdateChunkGroupData.md

@@ -0,0 +1,24 @@
+# TrieveRubyClient::UpdateChunkGroupData
+
+## 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] |
+| **group_id** | **String** | Id of the chunk_group to update. | [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] |
+| **tracking_id** | **String** | Tracking Id of the chunk_group to update. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateChunkGroupData.new(
+  description: null,
+  group_id: null,
+  name: null,
+  tracking_id: null
+)
+```
+

data/docs/UpdateDatasetRequest.md

@@ -0,0 +1,24 @@
+# TrieveRubyClient::UpdateDatasetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **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. |  |
+| **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] |
+| **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] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateDatasetRequest.new(
+  client_configuration: null,
+  dataset_id: null,
+  dataset_name: null,
+  server_configuration: null
+)
+```
+

data/docs/UpdateGroupByTrackingIDData.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::UpdateGroupByTrackingIDData
+
+## 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] |
+| **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] |
+| **tracking_id** | **String** | Tracking Id of the chunk_group to update. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateGroupByTrackingIDData.new(
+  description: null,
+  name: null,
+  tracking_id: null
+)
+```
+

data/docs/UpdateOrganizationData.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::UpdateOrganizationData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The new name of the organization. If not provided, the name will not be updated. | [optional] |
+| **organization_id** | **String** | The id of the organization to update. |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateOrganizationData.new(
+  name: null,
+  organization_id: null
+)
+```
+

data/docs/UpdateTopicData.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::UpdateTopicData
+
+## 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::UpdateTopicData.new(
+  name: null,
+  topic_id: null
+)
+```
+

data/docs/UpdateUserData.md

@@ -0,0 +1,30 @@
+# TrieveRubyClient::UpdateUserData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | In the sense of a legal name, not a username. The new name to assign to the user, if not provided, the current name will be used. | [optional] |
+| **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. | [optional] |
+| **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] |
+| **username** | **String** | The new username to assign to the user, if not provided, the current username will be used. | [optional] |
+| **visible_email** | **Boolean** | Determines if the user's email is visible to other users, if not provided, the current value will be used. | [optional] |
+| **website** | **String** | The new website to assign to the user, if not provided, the current website will be used. Used for linking to the user's personal or company website. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::UpdateUserData.new(
+  name: null,
+  organization_id: null,
+  role: null,
+  user_id: null,
+  username: null,
+  visible_email: null,
+  website: null
+)
+```
+

data/docs/UploadFileData.md

@@ -0,0 +1,34 @@
+# TrieveRubyClient::UploadFileData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **base64_file** | **String** | Base64 encoded file. Convert + to -, / to _, and remove the ending = if present. 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_mime_type** | **String** | MIME type of the file being uploaded. |  |
+| **file_name** | **String** | Name of the file being uploaded, including the extension. |  |
+| **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] |
+| **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] |
+| **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::UploadFileData.new(
+  base64_file: null,
+  create_chunks: null,
+  description: null,
+  file_mime_type: null,
+  file_name: null,
+  link: null,
+  metadata: null,
+  tag_set: null,
+  time_stamp: null
+)
+```
+

data/docs/UploadFileResult.md

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