trieve_ruby_client 0.5.7 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 18478b254543ca42dcece001a1e8993304e962dca71bd8ecd9a9ff2565f6848d
-  data.tar.gz: bcd91779a266e6c098011f911d1bb4455f9d17abbc2772d2988ce8a0aaa5f0b3
+  metadata.gz: 2bd762d8a89b0815c978e406a8abb5f797697ae3f39a90c5b57631ddd287e46c
+  data.tar.gz: eef6e62b91d2025556ede8aa043c2195b6ad6ecf5b2656079af9bf78bc8ff6e3
 SHA512:
-  metadata.gz: bc80bd7b9875a1efc352842c6069e5c240c70df26360725f93ce0ca317af4f0097fbffbcd5e93130e21d988287485e468f59eba030d9d2099b8bcf29e141c144
-  data.tar.gz: 4865cc754d50322018810aed7cb5a9d6b0f331e6aa40f7d4aab0f903b598cc51b022634aed8640227e06938cd29d1feb4caf333f673c741cbbd2a3ce22f32705
+  metadata.gz: d2f07ed812c2f6724e55ee0c60ca18b322e8473e52135bdcfb46df405277483916f9ef1555ff4c9414b3ec20575d7aad26ff10dac22a1767b977ef37804c562e
+  data.tar.gz: 32c9b6ba5c2878e054fb2b2b223d0468e2e3dc7c911eb05f30e57f42127b30dc4ed5157ad73c76113fff81911ad0503ce447b782fec8d423de73e5db8c5b46d3

data/README.md

@@ -6,8 +6,8 @@ Trieve OpenAPI Specification. This document describes all of the operations avai
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: 0.5.7
-- Package version: 0.5.7
+- API version: 0.6.0
+- Package version: 0.6.0
 - Generator version: 7.4.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://trieve.ai](https://trieve.ai)
@@ -25,16 +25,16 @@ gem build trieve_ruby_client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./trieve_ruby_client-0.5.7.gem
+gem install ./trieve_ruby_client-0.6.0.gem
 ```
 
-(for development, run `gem install --dev ./trieve_ruby_client-0.5.7.gem` to install the development dependencies)
+(for development, run `gem install --dev ./trieve_ruby_client-0.6.0.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'trieve_ruby_client', '~> 0.5.7'
+    gem 'trieve_ruby_client', '~> 0.6.0'
 
 ### Install from Git
 
@@ -192,10 +192,10 @@ Class | Method | HTTP request | Description
  - [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
  - [TrieveRubyClient::Range](docs/Range.md)
  - [TrieveRubyClient::RangeCondition](docs/RangeCondition.md)
- - [TrieveRubyClient::ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md)
  - [TrieveRubyClient::RecommendChunksRequest](docs/RecommendChunksRequest.md)
  - [TrieveRubyClient::RecommendChunksResponseTypes](docs/RecommendChunksResponseTypes.md)
  - [TrieveRubyClient::RecommendGroupChunkResponseTypes](docs/RecommendGroupChunkResponseTypes.md)
+ - [TrieveRubyClient::RecommendGroupChunksRequest](docs/RecommendGroupChunksRequest.md)
  - [TrieveRubyClient::RegenerateMessageData](docs/RegenerateMessageData.md)
  - [TrieveRubyClient::ReturnQueuedChunk](docs/ReturnQueuedChunk.md)
  - [TrieveRubyClient::ScoreChunkDTO](docs/ScoreChunkDTO.md)

data/docs/AddChunkToGroupData.md

@@ -4,7 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **chunk_id** | **String** | Id of the chunk to make a member of the group. |  |
+| **chunk_id** | **String** | Id of the chunk to make a member of the group. | [optional] |
+| **tracking_id** | **String** | Tracking Id of the chunk to make a member of the group. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::AddChunkToGroupData.new(
-  chunk_id: null
+  chunk_id: null,
+  tracking_id: null
 )
 ```
 

data/docs/AuthApi.md

@@ -141,7 +141,7 @@ This endpoint does not need any parameter.
 
 ## login
 
-> login(content)
+> login(opts)
 
 Login
 
@@ -154,11 +154,15 @@ require 'time'
 require 'trieve_ruby_client'
 
 api_instance = TrieveRubyClient::AuthApi.new
-content = TrieveRubyClient::AuthQuery.new # AuthQuery | Query parameters for login to be included as kv pairs after ? on the request URL.
+opts = {
+  organization_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | ID of organization to authenticate into
+  redirect_uri: 'redirect_uri_example', # String | URL to redirect to after successful login
+  inv_code: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Code sent via email as a result of successful call to send_invitation
+}
 
 begin
   # Login
-  api_instance.login(content)
+  api_instance.login(opts)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling AuthApi->login: #{e}"
 end
@@ -168,12 +172,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> login_with_http_info(content)
+> <Array(nil, Integer, Hash)> login_with_http_info(opts)
 
 ```ruby
 begin
   # Login
-  data, status_code, headers = api_instance.login_with_http_info(content)
+  data, status_code, headers = api_instance.login_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -186,7 +190,9 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **content** | [**AuthQuery**](.md) | Query parameters for login to be included as kv pairs after ? on the request URL. |  |
+| **organization_id** | **String** | ID of organization to authenticate into | [optional] |
+| **redirect_uri** | **String** | URL to redirect to after successful login | [optional] |
+| **inv_code** | **String** | Code sent via email as a result of successful call to send_invitation | [optional] |
 
 ### Return type
 

data/docs/ChunkGroup.md

@@ -8,7 +8,9 @@
 | **dataset_id** | **String** |  |  |
 | **description** | **String** |  |  |
 | **id** | **String** |  |  |
+| **metadata** | **Object** |  | [optional] |
 | **name** | **String** |  |  |
+| **tag_set** | **String** |  | [optional] |
 | **tracking_id** | **String** |  | [optional] |
 | **updated_at** | **Time** |  |  |
 
@@ -22,7 +24,9 @@ instance = TrieveRubyClient::ChunkGroup.new(
   dataset_id: null,
   description: null,
   id: null,
+  metadata: null,
   name: null,
+  tag_set: null,
   tracking_id: null,
   updated_at: null
 )

data/docs/ChunkGroupApi.md

@@ -47,7 +47,7 @@ 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 add the chunk to as a bookmark
-add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new({chunk_id: 'chunk_id_example'}) # AddChunkToGroupData | JSON request payload to add a chunk to a group (bookmark it)
+add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new # AddChunkToGroupData | JSON request payload to add a chunk to a group (bookmark it)
 
 begin
   # Add Chunk to Group
@@ -121,7 +121,7 @@ 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 | Id of the group to add the chunk to as a bookmark
-add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new({chunk_id: 'chunk_id_example'}) # AddChunkToGroupData | JSON request payload to add a chunk to a group (bookmark it)
+add_chunk_to_group_data = TrieveRubyClient::AddChunkToGroupData.new # AddChunkToGroupData | JSON request payload to add a chunk to a group (bookmark it)
 
 begin
   # Add Chunk to Group by Tracking ID
@@ -250,7 +250,7 @@ end
 
 Delete Group
 
-Delete Group  This will delete a chunk_group. This will not delete the chunks that are in the group. We will soon support deleting a chunk_group along with its member chunks.
+Delete Group  This will delete a chunk_group. If you set delete_chunks to true, it will also delete the chunks within the group.
 
 ### Examples
 
@@ -469,7 +469,7 @@ end
 
 Get Chunks in Group
 
-Get Chunks in Group  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
+Get Chunks in Group  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Page is 1-indexed.
 
 ### Examples
 
@@ -544,7 +544,7 @@ end
 
 Get Chunks in Group by Tracking ID
 
-Get Chunks in Group by Tracking ID  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon.
+Get Chunks in Group by Tracking ID  Route to get all chunks for a group. The response is paginated, with each page containing 10 chunks. Support for custom page size is coming soon. Page is 1-indexed.
 
 ### Examples
 
@@ -761,7 +761,7 @@ end
 
 ## get_recommended_groups
 
-> <RecommendGroupChunkResponseTypes> get_recommended_groups(tr_dataset, reccomend_group_chunks_request)
+> <RecommendGroupChunkResponseTypes> get_recommended_groups(tr_dataset, recommend_group_chunks_request)
 
 Get Recommended Groups
 
@@ -782,11 +782,11 @@ end
 
 api_instance = TrieveRubyClient::ChunkGroupApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
-reccomend_group_chunks_request = TrieveRubyClient::ReccomendGroupChunksRequest.new # ReccomendGroupChunksRequest | JSON request payload to get recommendations of chunks similar to the chunks in the request
+recommend_group_chunks_request = TrieveRubyClient::RecommendGroupChunksRequest.new # RecommendGroupChunksRequest | JSON request payload to get recommendations of chunks similar to the chunks in the request
 
 begin
   # Get Recommended Groups
-  result = api_instance.get_recommended_groups(tr_dataset, reccomend_group_chunks_request)
+  result = api_instance.get_recommended_groups(tr_dataset, recommend_group_chunks_request)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->get_recommended_groups: #{e}"
@@ -797,12 +797,12 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<RecommendGroupChunkResponseTypes>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request)
+> <Array(<RecommendGroupChunkResponseTypes>, Integer, Hash)> get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request)
 
 ```ruby
 begin
   # Get Recommended Groups
-  data, status_code, headers = api_instance.get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request)
+  data, status_code, headers = api_instance.get_recommended_groups_with_http_info(tr_dataset, recommend_group_chunks_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <RecommendGroupChunkResponseTypes>
@@ -816,7 +816,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
-| **reccomend_group_chunks_request** | [**ReccomendGroupChunksRequest**](ReccomendGroupChunksRequest.md) | JSON request payload to get recommendations of chunks similar to the chunks in the request |  |
+| **recommend_group_chunks_request** | [**RecommendGroupChunksRequest**](RecommendGroupChunksRequest.md) | JSON request payload to get recommendations of chunks similar to the chunks in the request |  |
 
 ### Return type
 
@@ -856,7 +856,7 @@ end
 api_instance = TrieveRubyClient::ChunkGroupApi.new
 tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset to fetch groups for.
-page = 789 # Integer | The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
+page = 789 # Integer | The page of groups to fetch. Page is 1-indexed.
 
 begin
   # Get Groups for Dataset
@@ -891,7 +891,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **tr_dataset** | **String** | The dataset id to use for the request |  |
 | **dataset_id** | **String** | The id of the dataset to fetch groups for. |  |
-| **page** | **Integer** | The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon. |  |
+| **page** | **Integer** | The page of groups to fetch. Page is 1-indexed. |  |
 
 ### Return type
 

data/docs/CreateChunkGroupData.md

@@ -5,7 +5,9 @@
 | 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. |  |
+| **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. |  |
+| **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] |
 
 ## Example
@@ -15,7 +17,9 @@ require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::CreateChunkGroupData.new(
   description: null,
+  metadata: null,
   name: null,
+  tag_set: null,
   tracking_id: null
 )
 ```

data/docs/DatasetApi.md

@@ -87,7 +87,7 @@ end
 
 ## delete_dataset
 
-> delete_dataset(tr_organization, dataset_id)
+> delete_dataset(tr_dataset, dataset_id)
 
 Delete Dataset
 
@@ -107,12 +107,12 @@ TrieveRubyClient.configure do |config|
 end
 
 api_instance = TrieveRubyClient::DatasetApi.new
-tr_organization = 'tr_organization_example' # String | The organization id to use for the request
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 dataset_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the dataset you want to delete.
 
 begin
   # Delete Dataset
-  api_instance.delete_dataset(tr_organization, dataset_id)
+  api_instance.delete_dataset(tr_dataset, dataset_id)
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling DatasetApi->delete_dataset: #{e}"
 end
@@ -122,12 +122,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> delete_dataset_with_http_info(tr_organization, dataset_id)
+> <Array(nil, Integer, Hash)> delete_dataset_with_http_info(tr_dataset, dataset_id)
 
 ```ruby
 begin
   # Delete Dataset
-  data, status_code, headers = api_instance.delete_dataset_with_http_info(tr_organization, dataset_id)
+  data, status_code, headers = api_instance.delete_dataset_with_http_info(tr_dataset, dataset_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -140,7 +140,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **tr_organization** | **String** | The organization id to use for the request |  |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
 | **dataset_id** | **String** | The id of the dataset you want to delete. |  |
 
 ### Return type

data/docs/EventsApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Get events for the dataset
 
-Get events for the dataset  Get events for the auth'ed user. Currently, this is only for events belonging to the auth'ed user. Soon, we plan to associate events to datasets instead of users.
+Get events for the dataset  Get events for the dataset specified by the TR-Dataset header.
 
 ### Examples
 

data/docs/FileApi.md

@@ -16,7 +16,7 @@ All URIs are relative to *https://api.trieve.ai*
 
 Delete File
 
-Delete File  Delete a file from S3 attached to the server based on its id. This will disassociate chunks from the file, but 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/RecommendChunksRequest.md

@@ -11,6 +11,7 @@
 | **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
 
@@ -24,7 +25,8 @@ instance = TrieveRubyClient::RecommendChunksRequest.new(
   negative_tracking_ids: null,
   positive_chunk_ids: null,
   positive_tracking_ids: null,
-  slim_chunks: null
+  slim_chunks: null,
+  strategy: null
 )
 ```
 

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/SearchChunkData.md

@@ -9,10 +9,9 @@
 | **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. |  |
-| **quote_negated_words** | **Boolean** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] |
 | **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] |
@@ -32,7 +31,6 @@ instance = TrieveRubyClient::SearchChunkData.new(
   page: null,
   page_size: null,
   query: null,
-  quote_negated_words: null,
   score_threshold: null,
   search_type: null,
   slim_chunks: null,

data/docs/SearchOverGroupsData.md

@@ -6,13 +6,12 @@
 | ---- | ---- | ----------- | ----- |
 | **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. |  |
-| **quote_negated_words** | **Boolean** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] |
 | **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] |
@@ -31,7 +30,6 @@ instance = TrieveRubyClient::SearchOverGroupsData.new(
   page: null,
   page_size: null,
   query: null,
-  quote_negated_words: null,
   score_threshold: null,
   search_type: null,
   slim_chunks: null

data/docs/SearchWithinGroupData.md

@@ -10,10 +10,9 @@
 | **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. |  |
-| **quote_negated_words** | **Boolean** | Turn on quote words and negated words to search for exact phrases and exclude words from the search results. Default is false. | [optional] |
 | **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] |
@@ -34,7 +33,6 @@ instance = TrieveRubyClient::SearchWithinGroupData.new(
   page: null,
   page_size: null,
   query: null,
-  quote_negated_words: null,
   score_threshold: null,
   search_type: null,
   slim_chunks: null,

data/docs/UpdateChunkGroupData.md

@@ -6,7 +6,9 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **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. | [optional] |
 
 ## Example
@@ -17,7 +19,9 @@ require 'trieve_ruby_client'
 instance = TrieveRubyClient::UpdateChunkGroupData.new(
   description: null,
   group_id: null,
+  metadata: null,
   name: null,
+  tag_set: null,
   tracking_id: null
 )
 ```

data/docs/UpdateGroupByTrackingIDData.md

@@ -5,7 +5,9 @@
 | 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
@@ -15,7 +17,9 @@ require 'trieve_ruby_client'
 
 instance = TrieveRubyClient::UpdateGroupByTrackingIDData.new(
   description: null,
+  metadata: null,
   name: null,
+  tag_set: null,
   tracking_id: null
 )
 ```

data/lib/trieve_ruby_client/api/auth_api.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -135,33 +135,35 @@ module TrieveRubyClient
 
     # Login
     # Login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
-    # @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id ID of organization to authenticate into
+    # @option opts [String] :redirect_uri URL to redirect to after successful login
+    # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
     # @return [nil]
-    def login(content, opts = {})
-      login_with_http_info(content, opts)
+    def login(opts = {})
+      login_with_http_info(opts)
       nil
     end
 
     # Login
     # Login  This will redirect you to the OAuth provider for authentication with email/pass, SSO, Google, Github, etc.
-    # @param content [AuthQuery] Query parameters for login to be included as kv pairs after ? on the request URL.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :organization_id ID of organization to authenticate into
+    # @option opts [String] :redirect_uri URL to redirect to after successful login
+    # @option opts [String] :inv_code Code sent via email as a result of successful call to send_invitation
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def login_with_http_info(content, opts = {})
+    def login_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: AuthApi.login ...'
       end
-      # verify the required parameter 'content' is set
-      if @api_client.config.client_side_validation && content.nil?
-        fail ArgumentError, "Missing the required parameter 'content' when calling AuthApi.login"
-      end
       # resource path
       local_var_path = '/api/auth'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'content'] = content
+      query_params[:'organization_id'] = opts[:'organization_id'] if !opts[:'organization_id'].nil?
+      query_params[:'redirect_uri'] = opts[:'redirect_uri'] if !opts[:'redirect_uri'].nil?
+      query_params[:'inv_code'] = opts[:'inv_code'] if !opts[:'inv_code'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/trieve_ruby_client/api/chunk_api.rb

@@ -3,7 +3,7 @@
 
 #Trieve OpenAPI Specification. This document describes all of the operations available through the Trieve API.
 
-The version of the OpenAPI document: 0.5.7
+The version of the OpenAPI document: 0.6.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0