trieve_ruby_client 0.5.0 → 0.6.0

data/docs/FileApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::FileApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -16,7 +16,7 @@ All URIs are relative to *http://localhost:8090*
 
 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 will not delete the chunks. We plan to add support for deleting chunks in a release soon. Auth'ed user must be an admin or owner of the dataset's organization to upload 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 must be an admin or owner of the dataset's organization to delete a file.
 
 ### Examples
 
@@ -165,7 +165,7 @@ end
 
 Get File
 
-Get File  Download a file from S3 attached to the server based on its id. We plan to add support for getting signed S3 URLs to download from S3 directly in a release soon.
+Get File  Download a file based on its id.
 
 ### Examples
 

data/docs/GroupScoreChunkDTO.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **group_id** | **String** |  |  |
+| **group_tracking_id** | **String** |  | [optional] |
 | **metadata** | [**Array<ScoreChunkDTO>**](ScoreChunkDTO.md) |  |  |
 
 ## Example
@@ -14,6 +15,7 @@ require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::GroupScoreChunkDTO.new(
   group_id: null,
+  group_tracking_id: null,
   metadata: null
 )
 ```

data/docs/GroupSlimChunksDTO.md

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

data/docs/HealthApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::HealthApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/InvitationApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::InvitationApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/MessageApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::MessageApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/OrganizationApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::OrganizationApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |

data/docs/Range.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **gt** | **Float** |  | [optional] |
-| **gte** | **Float** |  | [optional] |
-| **lt** | **Float** |  | [optional] |
-| **lte** | **Float** |  | [optional] |
+| **gt** | [**RangeCondition**](RangeCondition.md) |  | [optional] |
+| **gte** | [**RangeCondition**](RangeCondition.md) |  | [optional] |
+| **lt** | [**RangeCondition**](RangeCondition.md) |  | [optional] |
+| **lte** | [**RangeCondition**](RangeCondition.md) |  | [optional] |
 
 ## Example
 

data/docs/RangeCondition.md

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

data/docs/ReccomendGroupChunksRequest.md

@@ -11,6 +11,7 @@
 | **negative_group_tracking_ids** | **Array<String>** | The  ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups. | [optional] |
 | **positive_group_ids** | **Array<String>** | The  ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
 | **positive_group_tracking_ids** | **Array<String>** | The  ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
+| **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
 
 ## Example
 
@@ -24,7 +25,8 @@ instance = TrieveRubyClient::ReccomendGroupChunksRequest.new(
   negative_group_ids: null,
   negative_group_tracking_ids: null,
   positive_group_ids: null,
-  positive_group_tracking_ids: null
+  positive_group_tracking_ids: null,
+  slim_chunks: null
 )
 ```
 

data/docs/RecommendChunksRequest.md

@@ -10,6 +10,8 @@
 | **negative_tracking_ids** | **Array<String>** | The tracking_ids of the chunks to be used as negative examples for the recommendation. The chunks in this array will be used to filter out similar chunks. | [optional] |
 | **positive_chunk_ids** | **Array<String>** | The ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] |
 | **positive_tracking_ids** | **Array<String>** | The tracking_ids of the chunks to be used as positive examples for the recommendation. The chunks in this array will be used to find similar chunks. | [optional] |
+| **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
+| **strategy** | **String** | Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives. | [optional] |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = TrieveRubyClient::RecommendChunksRequest.new(
   negative_chunk_ids: null,
   negative_tracking_ids: null,
   positive_chunk_ids: null,
-  positive_tracking_ids: null
+  positive_tracking_ids: null,
+  slim_chunks: null,
+  strategy: null
 )
 ```
 

data/docs/RecommendChunksResponseTypes.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::RecommendChunksResponseTypes
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::RecommendChunksResponseTypes.openapi_one_of
+# =>
+# [
+#   :'Array<ChunkMetadata>',
+#   :'Array<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::RecommendChunksResponseTypes.build(data)
+# => #<Array<ChunkMetadata>:0x00007fdd4aab02a0>
+
+TrieveRubyClient::RecommendChunksResponseTypes.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<ChunkMetadata>`
+- `Array<SlimChunkMetadata>`
+- `nil` (if no type matches)
+

data/docs/RecommendGroupChunkResponseTypes.md

@@ -0,0 +1,49 @@
+# TrieveRubyClient::RecommendGroupChunkResponseTypes
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::RecommendGroupChunkResponseTypes.openapi_one_of
+# =>
+# [
+#   :'Array<GroupScoreChunkDTO>',
+#   :'Array<GroupSlimChunksDTO>'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'trieve_ruby_client'
+
+TrieveRubyClient::RecommendGroupChunkResponseTypes.build(data)
+# => #<Array<GroupScoreChunkDTO>:0x00007fdd4aab02a0>
+
+TrieveRubyClient::RecommendGroupChunkResponseTypes.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<GroupScoreChunkDTO>`
+- `Array<GroupSlimChunksDTO>`
+- `nil` (if no type matches)
+

data/docs/RecommendGroupChunksRequest.md

@@ -0,0 +1,34 @@
+# TrieveRubyClient::RecommendGroupChunksRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
+| **group_size** | **Integer** | The number of chunks to fetch for each group. This is the number of chunks which will be returned in the response for each group. The default is 3. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to reduce latency due to content download and serialization. | [optional] |
+| **limit** | **Integer** | The number of groups to return. This is the number of groups which will be returned in the response. The default is 10. | [optional] |
+| **negative_group_ids** | **Array<String>** | The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups. | [optional] |
+| **negative_group_tracking_ids** | **Array<String>** | The ids of the groups to be used as negative examples for the recommendation. The groups in this array will be used to filter out similar groups. | [optional] |
+| **positive_group_ids** | **Array<String>** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
+| **positive_group_tracking_ids** | **Array<String>** | The ids of the groups to be used as positive examples for the recommendation. The groups in this array will be used to find similar groups. | [optional] |
+| **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
+| **strategy** | **String** | Strategy to use for recommendations, either \"average_vector\" or \"best_score\". The default is \"average_vector\". The \"average_vector\" strategy will construct a single average vector from the positive and negative samples then use it to perform a pseudo-search. The \"best_score\" strategy is more advanced and navigates the HNSW with a heuristic of picking edges where the point is closer to the positive samples than it is the negatives. | [optional] |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::RecommendGroupChunksRequest.new(
+  filters: null,
+  group_size: null,
+  limit: null,
+  negative_group_ids: null,
+  negative_group_tracking_ids: null,
+  positive_group_ids: null,
+  positive_group_tracking_ids: null,
+  slim_chunks: null,
+  strategy: null
+)
+```
+

data/docs/ScoreSlimChunks.md

@@ -0,0 +1,20 @@
+# TrieveRubyClient::ScoreSlimChunks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | [**Array<SlimChunkMetadata>**](SlimChunkMetadata.md) |  |  |
+| **score** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::ScoreSlimChunks.new(
+  metadata: null,
+  score: null
+)
+```
+

data/docs/SearchChunkData.md

@@ -9,11 +9,12 @@
 | **get_collisions** | **Boolean** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional] |
 | **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
 | **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
-| **page** | **Integer** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
+| **page** | **Integer** | Page of chunks to fetch. Page is 1-indexed. | [optional] |
 | **page_size** | **Integer** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
 | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. |  |
 | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
 | **search_type** | **String** | 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. |  |
+| **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
 | **use_weights** | **Boolean** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] |
 
 ## Example
@@ -32,6 +33,7 @@ instance = TrieveRubyClient::SearchChunkData.new(
   query: null,
   score_threshold: null,
   search_type: null,
+  slim_chunks: null,
   use_weights: null
 )
 ```

data/docs/SearchChunkResponseTypes.md

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

data/docs/SearchGroupSlimChunksResult.md

@@ -0,0 +1,22 @@
+# TrieveRubyClient::SearchGroupSlimChunksResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bookmarks** | [**Array<ScoreSlimChunks>**](ScoreSlimChunks.md) |  |  |
+| **group** | [**ChunkGroup**](ChunkGroup.md) |  |  |
+| **total_pages** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'trieve_ruby_client'
+
+instance = TrieveRubyClient::SearchGroupSlimChunksResult.new(
+  bookmarks: null,
+  group: null,
+  total_pages: null
+)
+```
+

data/docs/SearchOverGroupsData.md

@@ -6,14 +6,15 @@
 | ---- | ---- | ----------- | ----- |
 | **filters** | [**ChunkFilter**](ChunkFilter.md) |  | [optional] |
 | **get_collisions** | **Boolean** | Set get_collisions to true to get the collisions for each chunk. This will only apply if environment variable COLLISIONS_ENABLED is set to true. | [optional] |
-| **group_size** | **Integer** |  | [optional] |
+| **group_size** | **Integer** | Group_size is the number of chunks to fetch for each group. The default is 3. If a group has less than group_size chunks, all chunks will be returned. If this is set to a large number, we recommend setting slim_chunks to true to avoid returning the content and chunk_html of the chunks so as to lower the amount of time required for content download and serialization. | [optional] |
 | **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
 | **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
-| **page** | **Integer** | Page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
-| **page_size** | **Integer** | Page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
+| **page** | **Integer** | Page of group results to fetch. Page is 1-indexed. | [optional] |
+| **page_size** | **Integer** | Page size is the number of group results to fetch. The default is 10. | [optional] |
 | **query** | **String** | Query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. |  |
 | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [optional] |
 | **search_type** | **String** | 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. |  |
+| **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
 
 ## Example
 
@@ -30,7 +31,8 @@ instance = TrieveRubyClient::SearchOverGroupsData.new(
   page_size: null,
   query: null,
   score_threshold: null,
-  search_type: null
+  search_type: null,
+  slim_chunks: null
 )
 ```
 

data/docs/SearchOverGroupsResponseTypes.md

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

data/docs/SearchOverGroupsSlimChunksResponseBody.md

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

data/docs/SearchSlimChunkQueryResponseBody.md

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

data/docs/SearchWithinGroupData.md

@@ -10,11 +10,12 @@
 | **group_tracking_id** | **String** | Group_tracking_id specifies the group to search within by tracking id. Results will only consist of chunks which are bookmarks within the specified group. If both group_id and group_tracking_id are provided, group_id will be used. | [optional] |
 | **highlight_delimiters** | **Array<String>** | Set highlight_delimiters to a list of strings to use as delimiters for highlighting. If not specified, this defaults to [\"?\", \",\", \".\", \"!\"]. | [optional] |
 | **highlight_results** | **Boolean** | Set highlight_results to true to highlight the results. If not specified, this defaults to true. | [optional] |
-| **page** | **Integer** | The page of chunks to fetch. Each page is 10 chunks. Support for custom page size is coming soon. | [optional] |
+| **page** | **Integer** | The page of chunks to fetch. Page is 1-indexed. | [optional] |
 | **page_size** | **Integer** | The page size is the number of chunks to fetch. This can be used to fetch more than 10 chunks at a time. | [optional] |
 | **query** | **String** | The query is the search query. This can be any string. The query will be used to create an embedding vector and/or SPLADE vector which will be used to find the result set. |  |
 | **score_threshold** | **Float** | Set score_threshold to a float to filter out chunks with a score below the threshold. | [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. |  |
+| **slim_chunks** | **Boolean** | Set slim_chunks to true to avoid returning the content and chunk_html of the chunks. This is useful for when you want to reduce amount of data over the wire for latency improvement. Default is false. | [optional] |
 | **use_weights** | **Boolean** | Set use_weights to true to use the weights of the chunks in the result set in order to sort them. If not specified, this defaults to true. | [optional] |
 
 ## Example
@@ -34,6 +35,7 @@ instance = TrieveRubyClient::SearchWithinGroupData.new(
   query: null,
   score_threshold: null,
   search_type: null,
+  slim_chunks: null,
   use_weights: null
 )
 ```

data/docs/SearchWithinGroupResponseTypes.md

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