trieve_ruby_client 0.8.2 → 0.10.7

data/docs/ChunkGroupApi.md

@@ -29,7 +29,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Add Chunk to Group
 
-Add Chunk to Group  Route to add a chunk to a group.
+Add Chunk to Group  Route to add a chunk to a group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -103,7 +103,7 @@ nil (empty response body)
 
 Add Chunk to Group by Tracking ID
 
-Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id.
+Add Chunk to Group by Tracking ID  Route to add a chunk to a group by tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -173,11 +173,11 @@ nil (empty response body)
 
 ## create_chunk_group
 
-> <ChunkGroup> create_chunk_group(tr_dataset, create_chunk_group_data)
+> <ChunkGroup> create_chunk_group(tr_dataset, create_chunk_group_req_payload)
 
 Create Chunk Group
 
-Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail.
+Create Chunk Group  Create a new chunk_group. This is a way to group chunks together. If you try to create a chunk_group with the same tracking_id as an existing chunk_group, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -194,11 +194,11 @@ end
 
 api_instance = TrieveRubyClient::ChunkGroupApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
-create_chunk_group_data = TrieveRubyClient::CreateChunkGroupData.new({name: 'name_example'}) # CreateChunkGroupData | JSON request payload to cretea a chunkGroup
+create_chunk_group_req_payload = TrieveRubyClient::CreateChunkGroupReqPayload.new # CreateChunkGroupReqPayload | JSON request payload to cretea a chunkGroup
 
 begin
   # Create Chunk Group
-  result = api_instance.create_chunk_group(tr_dataset, create_chunk_group_data)
+  result = api_instance.create_chunk_group(tr_dataset, create_chunk_group_req_payload)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->create_chunk_group: #{e}"
@@ -209,12 +209,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<ChunkGroup>, Integer, Hash)> create_chunk_group_with_http_info(tr_dataset, create_chunk_group_data)
+> <Array(<ChunkGroup>, Integer, Hash)> create_chunk_group_with_http_info(tr_dataset, create_chunk_group_req_payload)
 
 ```ruby
 begin
   # Create Chunk Group
-  data, status_code, headers = api_instance.create_chunk_group_with_http_info(tr_dataset, create_chunk_group_data)
+  data, status_code, headers = api_instance.create_chunk_group_with_http_info(tr_dataset, create_chunk_group_req_payload)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <ChunkGroup>
@@ -228,7 +228,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **create_chunk_group_data** | [**CreateChunkGroupData**](CreateChunkGroupData.md) | JSON request payload to cretea a chunkGroup |  |
+| **create_chunk_group_req_payload** | [**CreateChunkGroupReqPayload**](CreateChunkGroupReqPayload.md) | JSON request payload to cretea a chunkGroup |  |
 
 ### Return type
 
@@ -250,7 +250,7 @@ end
 
 Delete Group
 
-Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
+Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -320,11 +320,11 @@ nil (empty response body)
 
 ## delete_group_by_tracking_id
 
-> delete_group_by_tracking_id(tr_dataset, tracking_id)
+> delete_group_by_tracking_id(tr_dataset, tracking_id, delete_chunks)
 
 Delete Group by Tracking ID
 
-Delete Group by Tracking ID  Delete a chunk_group with the given tracking id.
+Delete Group by Tracking ID  Delete a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -342,10 +342,11 @@ end
 api_instance = TrieveRubyClient::ChunkGroupApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 tracking_id = 'tracking_id_example' # String | Tracking id of the chunk_group to delete
+delete_chunks = true # Boolean | Delete the chunks within the group
 
 begin
   # Delete Group by Tracking ID
-  api_instance.delete_group_by_tracking_id(tr_dataset, tracking_id)
+  api_instance.delete_group_by_tracking_id(tr_dataset, tracking_id, delete_chunks)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->delete_group_by_tracking_id: #{e}"
 end
@@ -355,12 +356,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id)
+> <Array(nil, Integer, Hash)> delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, delete_chunks)
 
 ```ruby
 begin
   # Delete Group by Tracking ID
-  data, status_code, headers = api_instance.delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id)
+  data, status_code, headers = api_instance.delete_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, delete_chunks)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -375,6 +376,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
 | **tracking_id** | **String** | Tracking id of the chunk_group to delete |  |
+| **delete_chunks** | **Boolean** | Delete the chunks within the group |  |
 
 ### Return type
 
@@ -765,7 +767,7 @@ end
 
 Get Recommended Groups
 
-Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body.
+Get Recommended Groups  Route to get recommended groups. This route will return groups which are similar to the groups in the request body. You must provide at least one positive group id or group tracking id.
 
 ### Examples
 
@@ -909,11 +911,11 @@ end
 
 ## remove_chunk_from_group
 
-> remove_chunk_from_group(tr_dataset, group_id, create_chunk_group_data)
+> remove_chunk_from_group(tr_dataset, group_id, remove_chunk_from_group_req_payload)
 
 Remove Chunk from Group
 
-Remove Chunk from Group  Route to remove a chunk from a group.
+Remove Chunk from Group  Route to remove a chunk from a group. Auth'ed user or api key must be an admin or owner of the dataset's organization to remove a chunk from a group.
 
 ### Examples
 
@@ -930,12 +932,12 @@ end
 
 api_instance = TrieveRubyClient::ChunkGroupApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
-group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group to remove the bookmark'ed chunk from
-create_chunk_group_data = TrieveRubyClient::CreateChunkGroupData.new({name: 'name_example'}) # CreateChunkGroupData | JSON request payload to cretea a chunkGroup
+group_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the group you want to remove the chunk from.
+remove_chunk_from_group_req_payload = TrieveRubyClient::RemoveChunkFromGroupReqPayload.new({chunk_id: 'chunk_id_example'}) # RemoveChunkFromGroupReqPayload | JSON request payload to remove a chunk from a group
 
 begin
   # Remove Chunk from Group
-  api_instance.remove_chunk_from_group(tr_dataset, group_id, create_chunk_group_data)
+  api_instance.remove_chunk_from_group(tr_dataset, group_id, remove_chunk_from_group_req_payload)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->remove_chunk_from_group: #{e}"
 end
@@ -945,12 +947,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> remove_chunk_from_group_with_http_info(tr_dataset, group_id, create_chunk_group_data)
+> <Array(nil, Integer, Hash)> remove_chunk_from_group_with_http_info(tr_dataset, group_id, remove_chunk_from_group_req_payload)
 
 ```ruby
 begin
   # Remove Chunk from Group
-  data, status_code, headers = api_instance.remove_chunk_from_group_with_http_info(tr_dataset, group_id, create_chunk_group_data)
+  data, status_code, headers = api_instance.remove_chunk_from_group_with_http_info(tr_dataset, group_id, remove_chunk_from_group_req_payload)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -964,8 +966,8 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **group_id** | **String** | Id of the group to remove the bookmark&#39;ed chunk from |  |
-| **create_chunk_group_data** | [**CreateChunkGroupData**](CreateChunkGroupData.md) | JSON request payload to cretea a chunkGroup |  |
+| **group_id** | **String** | Id of the group you want to remove the chunk from. |  |
+| **remove_chunk_from_group_req_payload** | [**RemoveChunkFromGroupReqPayload**](RemoveChunkFromGroupReqPayload.md) | JSON request payload to remove a chunk from a group |  |
 
 ### Return type
 
@@ -1133,7 +1135,7 @@ end
 
 Update Group
 
-Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail.
+Update Group  Update a chunk_group. If you try to change the tracking_id to one that already exists, this operation will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -1201,11 +1203,11 @@ nil (empty response body)
 
 ## update_group_by_tracking_id
 
-> update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_data)
+> update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload)
 
 Update Group by Tracking ID
 
-Update Group by Tracking ID  Update a chunk_group with the given tracking id.
+Update Group by Tracking ID  Update a chunk_group with the given tracking id. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
 
 ### Examples
 
@@ -1223,11 +1225,11 @@ end
 api_instance = TrieveRubyClient::ChunkGroupApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 tracking_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Tracking id of the chunk_group to update
-update_group_by_tracking_id_data = TrieveRubyClient::UpdateGroupByTrackingIDData.new({tracking_id: 'tracking_id_example'}) # UpdateGroupByTrackingIDData | JSON request payload to update a chunkGroup
+update_group_by_tracking_id_req_payload = TrieveRubyClient::UpdateGroupByTrackingIDReqPayload.new({tracking_id: 'tracking_id_example'}) # UpdateGroupByTrackingIDReqPayload | JSON request payload to update a chunkGroup
 
 begin
   # Update Group by Tracking ID
-  api_instance.update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_data)
+  api_instance.update_group_by_tracking_id(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->update_group_by_tracking_id: #{e}"
 end
@@ -1237,12 +1239,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_data)
+> <Array(nil, Integer, Hash)> update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload)
 
 ```ruby
 begin
   # Update Group by Tracking ID
-  data, status_code, headers = api_instance.update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_data)
+  data, status_code, headers = api_instance.update_group_by_tracking_id_with_http_info(tr_dataset, tracking_id, update_group_by_tracking_id_req_payload)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -1257,7 +1259,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
 | **tracking_id** | **String** | Tracking id of the chunk_group to update |  |
-| **update_group_by_tracking_id_data** | [**UpdateGroupByTrackingIDData**](UpdateGroupByTrackingIDData.md) | JSON request payload to update a chunkGroup |  |
+| **update_group_by_tracking_id_req_payload** | [**UpdateGroupByTrackingIDReqPayload**](UpdateGroupByTrackingIDReqPayload.md) | JSON request payload to update a chunkGroup |  |
 
 ### Return type
 

data/docs/ChunkMetadata.md

@@ -8,11 +8,13 @@
 | **created_at** | **Time** |  |  |
 | **dataset_id** | **String** |  |  |
 | **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
 | **link** | **String** |  | [optional] |
 | **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
 | **metadata** | **Object** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
 | **qdrant_point_id** | **String** |  | [optional] |
-| **tag_set** | **String** |  | [optional] |
+| **tag_set** | **Array<String>** |  | [optional] |
 | **time_stamp** | **Time** |  | [optional] |
 | **tracking_id** | **String** |  | [optional] |
 | **updated_at** | **Time** |  |  |
@@ -28,9 +30,11 @@ instance = TrieveRubyClient::ChunkMetadata.new(
   created_at: null,
   dataset_id: null,
   id: null,
+  image_urls: null,
   link: null,
   location: null,
   metadata: null,
+  num_value: null,
   qdrant_point_id: null,
   tag_set: null,
   time_stamp: null,

data/docs/ChunkMetadataStringTagSet.md

@@ -0,0 +1,46 @@
+# TrieveRubyClient::ChunkMetadataStringTagSet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_html** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **dataset_id** | **String** |  |  |
+| **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
+| **link** | **String** |  | [optional] |
+| **location** | [**GeoInfo**](GeoInfo.md) |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
+| **qdrant_point_id** | **String** |  | [optional] |
+| **tag_set** | **String** |  | [optional] |
+| **time_stamp** | **Time** |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **updated_at** | **Time** |  |  |
+| **weight** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ChunkMetadataStringTagSet.new(
+  chunk_html: null,
+  created_at: null,
+  dataset_id: null,
+  id: null,
+  image_urls: null,
+  link: null,
+  location: null,
+  metadata: null,
+  num_value: null,
+  qdrant_point_id: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  updated_at: null,
+  weight: null
+)
+```
+

data/docs/ChunkMetadataTypes.md

@@ -0,0 +1,51 @@
+# TrieveRubyClient::ChunkMetadataTypes
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ChunkMetadataTypes.openapi_one_of
+# =>
+# [
+#   :'ChunkMetadataStringTagSet',
+#   :'ContentChunkMetadata',
+#   :'SlimChunkMetadata'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ChunkMetadataTypes.build(data)
+# => #<ChunkMetadataStringTagSet:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ChunkMetadataTypes.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ChunkMetadataStringTagSet`
+- `ContentChunkMetadata`
+- `SlimChunkMetadata`
+- `nil` (if no type matches)
+

data/docs/ChunkReqPayload.md

@@ -0,0 +1,50 @@
+# TrieveRubyClient::ChunkReqPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **boost_phrase** | [**BoostPhrase**](BoostPhrase.md) |  | [optional] |
+| **chunk_html** | **String** | HTML content of the chunk. 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. | [optional] |
+| **chunk_vector** | **Array<Float>** | Chunk_vector is a vector of floats which can be used instead of generating a new embedding. This is useful for when you are using a pre-embedded dataset. If this is not provided, the innerText of the chunk_html will be used to create the embedding. | [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] |
+| **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 create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [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 create a chunk and add it to a group or multiple groups in one request. Necessary because this route queues the chunk for ingestion and the chunk may not exist yet immediately after response. | [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. | [optional] |
+| **link** | **String** | Link to the chunk. 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. | [optional] |
+| **location** | [**GeoInfo**](GeoInfo.md) |  | [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. | [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. There is no performance hit for filtering on num_value. | [optional] |
+| **split_avg** | **Boolean** | Split avg is a boolean which tells the server to split the text in the chunk_html into smaller chunks and average their resulting vectors. This is useful for when you want to create a chunk from a large piece of text and want to split it into smaller chunks to create a more fuzzy average dense vector. The sparse vector will be generated normally with no averaging. By default this is false. | [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. | [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. | [optional] |
+| **tracking_id** | **String** | Tracking_id is a string which can be used to identify a chunk. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. | [optional] |
+| **upsert_by_tracking_id** | **Boolean** | Upsert when a chunk with the same tracking_id exists. By default this is false, and the request will fail if a chunk with the same tracking_id exists. If this is true, the chunk will be updated if a chunk with the same tracking_id exists. | [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. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ChunkReqPayload.new(
+  boost_phrase: null,
+  chunk_html: null,
+  chunk_vector: null,
+  convert_html_to_text: null,
+  group_ids: null,
+  group_tracking_ids: null,
+  image_urls: null,
+  link: null,
+  location: null,
+  metadata: null,
+  num_value: null,
+  split_avg: null,
+  tag_set: null,
+  time_stamp: null,
+  tracking_id: null,
+  upsert_by_tracking_id: null,
+  weight: null
+)
+```
+

data/docs/ClientDatasetConfiguration.md

@@ -10,7 +10,6 @@
 | **file_name_key** | **String** |  |  |
 | **filter_items** | **Object** |  | [optional] |
 | **frontmatter_vals** | **String** |  | [optional] |
-| **image_metadata_key** | **String** |  |  |
 | **image_range_end_key** | **String** |  | [optional] |
 | **image_range_start_key** | **String** |  | [optional] |
 | **lines_before_show_more** | **Integer** |  | [optional] |
@@ -29,7 +28,6 @@ instance = TrieveRubyClient::ClientDatasetConfiguration.new(
   file_name_key: null,
   filter_items: null,
   frontmatter_vals: null,
-  image_metadata_key: null,
   image_range_end_key: null,
   image_range_start_key: null,
   lines_before_show_more: null,

data/docs/ConditionType.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::ConditionType
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ConditionType.openapi_one_of
+# =>
+# [
+#   :'FieldCondition',
+#   :'HasIDCondition'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::ConditionType.build(data)
+# => #<FieldCondition:0x00007fdd4aab02a0>
+
+TrieveRubyClient::ConditionType.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `FieldCondition`
+- `HasIDCondition`
+- `nil` (if no type matches)
+

data/docs/ContentChunkMetadata.md

@@ -0,0 +1,32 @@
+# TrieveRubyClient::ContentChunkMetadata
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **chunk_html** | **String** |  | [optional] |
+| **id** | **String** |  |  |
+| **image_urls** | **Array<String>** |  | [optional] |
+| **num_value** | **Float** |  | [optional] |
+| **qdrant_point_id** | **String** |  | [optional] |
+| **time_stamp** | **Time** |  | [optional] |
+| **tracking_id** | **String** |  | [optional] |
+| **weight** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ContentChunkMetadata.new(
+  chunk_html: null,
+  id: null,
+  image_urls: null,
+  num_value: null,
+  qdrant_point_id: null,
+  time_stamp: null,
+  tracking_id: null,
+  weight: null
+)
+```
+

data/docs/CreateChunkGroupReqPayload.md

@@ -0,0 +1,28 @@
+# TrieveRubyClient::CreateChunkGroupReqPayload
+
+## 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. | [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. | [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** | Optional tracking id to assign to the chunk_group. This is a unique identifier for the chunk_group. | [optional] |
+| **upsert_by_tracking_id** | **Boolean** | Upsert when a chunk_group with the same tracking_id exists. By default this is false, and the request will fail if a chunk_group with the same tracking_id exists. If this is true, the chunk_group will be updated if a chunk_group with the same tracking_id exists. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::CreateChunkGroupReqPayload.new(
+  description: null,
+  metadata: null,
+  name: null,
+  tag_set: null,
+  tracking_id: null,
+  upsert_by_tracking_id: null
+)
+```
+

data/docs/CreateChunkReqPayloadEnum.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::CreateChunkReqPayloadEnum
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::CreateChunkReqPayloadEnum.openapi_one_of
+# =>
+# [
+#   :'Array<ChunkReqPayload>',
+#   :'ChunkReqPayload'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::CreateChunkReqPayloadEnum.build(data)
+# => #<Array<ChunkReqPayload>:0x00007fdd4aab02a0>
+
+TrieveRubyClient::CreateChunkReqPayloadEnum.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Array<ChunkReqPayload>`
+- `ChunkReqPayload`
+- `nil` (if no type matches)
+

data/docs/CreateDatasetRequest.md

@@ -5,10 +5,10 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **client_configuration** | **Object** | Client configuration for the dataset, can be arbitrary JSON. We recommend setting to `{}` to start. See docs.trieve.ai for more information or adjust with the admin dashboard. |  |
-| **dataset_name** | **String** | Name of the dataset. Must be unique within the organization. |  |
+| **dataset_name** | **String** | Name of the dataset. |  |
 | **organization_id** | **String** | Organization ID that the dataset will belong to. |  |
 | **server_configuration** | **Object** | Server configuration for the dataset, can be arbitrary JSON. We recommend setting to `{}` to start. See docs.trieve.ai for more information or adjust with the admin dashboard. |  |
-| **tracking_id** | **String** | Optional tracking ID for the dataset. Can be used to track the dataset in external systems. | [optional] |
+| **tracking_id** | **String** | Optional tracking ID for the dataset. Can be used to track the dataset in external systems. Must be unique within the organization. | [optional] |
 
 ## Example
 

data/docs/CreateMessageData.md

@@ -4,8 +4,8 @@
 
 | 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] |
+| **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 sub-sentences. | [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. |  |
 | **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 attach the message to. |  |
@@ -16,8 +16,8 @@
 require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::CreateMessageData.new(
-  highlight_citations: null,
   highlight_delimiters: null,
+  highlight_results: null,
   new_message_content: null,
   stream_response: null,
   topic_id: null