trieve_ruby_client 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0f6247ccf8bd2317f17f1cff845cdc1babf31f3fe83f85725a67f24c59912ca
-  data.tar.gz: c2b40080de68df5761287386a67483b264dfdb9a036d4c0dfe8294b3361ecc10
+  metadata.gz: 2bd762d8a89b0815c978e406a8abb5f797697ae3f39a90c5b57631ddd287e46c
+  data.tar.gz: eef6e62b91d2025556ede8aa043c2195b6ad6ecf5b2656079af9bf78bc8ff6e3
 SHA512:
-  metadata.gz: b4f6ef5058ebc160e85f702217bf55e09426dcf8772bf17a7d8211d96d586f9442aa58d57982791d410fb489ed856fb8e4db0b4cf6c81e992da599e2514aae93
-  data.tar.gz: b3b6d16e25289e56bec18fa7e0cbbe4af70cc5f74ea8a7e6d205f22a60f954453d5c9550abbaa98a33041d5747e7a8f8eeb1b50960a0be23e7ab6353249eb2ec
+  metadata.gz: d2f07ed812c2f6724e55ee0c60ca18b322e8473e52135bdcfb46df405277483916f9ef1555ff4c9414b3ec20575d7aad26ff10dac22a1767b977ef37804c562e
+  data.tar.gz: 32c9b6ba5c2878e054fb2b2b223d0468e2e3dc7c911eb05f30e57f42127b30dc4ed5157ad73c76113fff81911ad0503ce447b782fec8d423de73e5db8c5b46d3

data/GENERATE_COMMAND.txt

@@ -0,0 +1 @@
+npx @openapitools/openapi-generator-cli generate -i openapi.json -g ruby -c ./openapi-generator.yaml --skip-validate-spec

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.0
-- Package version: 0.5.0
+- 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.0.gem
+gem install ./trieve_ruby_client-0.6.0.gem
 ```
 
-(for development, run `gem install --dev ./trieve_ruby_client-0.5.0.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.0'
+    gem 'trieve_ruby_client', '~> 0.6.0'
 
 ### Install from Git
 
@@ -72,7 +72,7 @@ end
 
 ## Documentation for API Endpoints
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
@@ -109,7 +109,7 @@ Class | Method | HTTP request | Description
 *TrieveRubyClient::ChunkGroupApi* | [**update_chunk_group**](docs/ChunkGroupApi.md#update_chunk_group) | **PUT** /api/chunk_group | Update Group
 *TrieveRubyClient::ChunkGroupApi* | [**update_group_by_tracking_id**](docs/ChunkGroupApi.md#update_group_by_tracking_id) | **PUT** /api/chunk_group/tracking_id/{tracking_id} | Update Group by Tracking ID
 *TrieveRubyClient::DatasetApi* | [**create_dataset**](docs/DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset
-*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset
+*TrieveRubyClient::DatasetApi* | [**delete_dataset**](docs/DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset
 *TrieveRubyClient::DatasetApi* | [**get_client_dataset_config**](docs/DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration
 *TrieveRubyClient::DatasetApi* | [**get_dataset**](docs/DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset
 *TrieveRubyClient::DatasetApi* | [**get_datasets_from_organization**](docs/DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization
@@ -136,10 +136,10 @@ Class | Method | HTTP request | Description
 *TrieveRubyClient::StripeApi* | [**get_all_plans**](docs/StripeApi.md#get_all_plans) | **GET** /api/stripe/plans | Get All Plans
 *TrieveRubyClient::StripeApi* | [**update_subscription_plan**](docs/StripeApi.md#update_subscription_plan) | **PATCH** /api/stripe/subscription_plan/{subscription_id}/{plan_id} | Update Subscription Plan
 *TrieveRubyClient::TopicApi* | [**create_topic**](docs/TopicApi.md#create_topic) | **POST** /api/topic | Create Topic
-*TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic | Delete Topic
+*TrieveRubyClient::TopicApi* | [**delete_topic**](docs/TopicApi.md#delete_topic) | **DELETE** /api/topic/{topic_id} | Delete Topic
 *TrieveRubyClient::TopicApi* | [**get_all_topics_for_user**](docs/TopicApi.md#get_all_topics_for_user) | **GET** /api/topic/user/{user_id} | Get All Topics for User
 *TrieveRubyClient::TopicApi* | [**update_topic**](docs/TopicApi.md#update_topic) | **PUT** /api/topic | Update Topic
-*TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key | Delete User Api Key
+*TrieveRubyClient::UserApi* | [**delete_user_api_key**](docs/UserApi.md#delete_user_api_key) | **DELETE** /api/user/delete_api_key/{api_key_id} | Delete User Api Key
 *TrieveRubyClient::UserApi* | [**set_user_api_key**](docs/UserApi.md#set_user_api_key) | **POST** /api/user/set_api_key | Set User Api Key
 *TrieveRubyClient::UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /api/user | Update User
 
@@ -170,7 +170,6 @@ Class | Method | HTTP request | Description
  - [TrieveRubyClient::DatasetAndUsage](docs/DatasetAndUsage.md)
  - [TrieveRubyClient::DatasetDTO](docs/DatasetDTO.md)
  - [TrieveRubyClient::DatasetUsageCount](docs/DatasetUsageCount.md)
- - [TrieveRubyClient::DeleteDatasetRequest](docs/DeleteDatasetRequest.md)
  - [TrieveRubyClient::DeleteTopicData](docs/DeleteTopicData.md)
  - [TrieveRubyClient::DeleteUserApiKeyRequest](docs/DeleteUserApiKeyRequest.md)
  - [TrieveRubyClient::EditMessageData](docs/EditMessageData.md)
@@ -185,26 +184,38 @@ Class | Method | HTTP request | Description
  - [TrieveRubyClient::GetGroupsForChunksData](docs/GetGroupsForChunksData.md)
  - [TrieveRubyClient::GroupData](docs/GroupData.md)
  - [TrieveRubyClient::GroupScoreChunkDTO](docs/GroupScoreChunkDTO.md)
+ - [TrieveRubyClient::GroupSlimChunksDTO](docs/GroupSlimChunksDTO.md)
  - [TrieveRubyClient::InvitationData](docs/InvitationData.md)
  - [TrieveRubyClient::MatchCondition](docs/MatchCondition.md)
  - [TrieveRubyClient::Message](docs/Message.md)
  - [TrieveRubyClient::Organization](docs/Organization.md)
  - [TrieveRubyClient::OrganizationUsageCount](docs/OrganizationUsageCount.md)
  - [TrieveRubyClient::Range](docs/Range.md)
- - [TrieveRubyClient::ReccomendGroupChunksRequest](docs/ReccomendGroupChunksRequest.md)
+ - [TrieveRubyClient::RangeCondition](docs/RangeCondition.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)
+ - [TrieveRubyClient::ScoreSlimChunks](docs/ScoreSlimChunks.md)
  - [TrieveRubyClient::SearchChunkData](docs/SearchChunkData.md)
  - [TrieveRubyClient::SearchChunkQueryResponseBody](docs/SearchChunkQueryResponseBody.md)
+ - [TrieveRubyClient::SearchChunkResponseTypes](docs/SearchChunkResponseTypes.md)
+ - [TrieveRubyClient::SearchGroupSlimChunksResult](docs/SearchGroupSlimChunksResult.md)
  - [TrieveRubyClient::SearchGroupsResult](docs/SearchGroupsResult.md)
  - [TrieveRubyClient::SearchOverGroupsData](docs/SearchOverGroupsData.md)
  - [TrieveRubyClient::SearchOverGroupsResponseBody](docs/SearchOverGroupsResponseBody.md)
+ - [TrieveRubyClient::SearchOverGroupsResponseTypes](docs/SearchOverGroupsResponseTypes.md)
+ - [TrieveRubyClient::SearchOverGroupsSlimChunksResponseBody](docs/SearchOverGroupsSlimChunksResponseBody.md)
+ - [TrieveRubyClient::SearchSlimChunkQueryResponseBody](docs/SearchSlimChunkQueryResponseBody.md)
  - [TrieveRubyClient::SearchWithinGroupData](docs/SearchWithinGroupData.md)
+ - [TrieveRubyClient::SearchWithinGroupResponseTypes](docs/SearchWithinGroupResponseTypes.md)
  - [TrieveRubyClient::SetUserApiKeyRequest](docs/SetUserApiKeyRequest.md)
  - [TrieveRubyClient::SetUserApiKeyResponse](docs/SetUserApiKeyResponse.md)
  - [TrieveRubyClient::SingleQueuedChunkResponse](docs/SingleQueuedChunkResponse.md)
+ - [TrieveRubyClient::SlimChunkMetadata](docs/SlimChunkMetadata.md)
  - [TrieveRubyClient::SlimGroup](docs/SlimGroup.md)
  - [TrieveRubyClient::SlimUser](docs/SlimUser.md)
  - [TrieveRubyClient::StripePlan](docs/StripePlan.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

@@ -1,6 +1,6 @@
 # TrieveRubyClient::AuthApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -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/ChunkApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::ChunkApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -528,7 +528,7 @@ end
 
 ## get_recommended_chunks
 
-> <Array<ChunkMetadataWithFileData>> get_recommended_chunks(tr_dataset, recommend_chunks_request)
+> <RecommendChunksResponseTypes> get_recommended_chunks(tr_dataset, recommend_chunks_request)
 
 Get Recommended Chunks
 
@@ -564,7 +564,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<ChunkMetadataWithFileData>>, Integer, Hash)> get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
+> <Array(<RecommendChunksResponseTypes>, Integer, Hash)> get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
 
 ```ruby
 begin
@@ -572,7 +572,7 @@ begin
   data, status_code, headers = api_instance.get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Array<ChunkMetadataWithFileData>>
+  p data # => <RecommendChunksResponseTypes>
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkApi->get_recommended_chunks_with_http_info: #{e}"
 end
@@ -587,7 +587,7 @@ end
 
 ### Return type
 
-[**Array&lt;ChunkMetadataWithFileData&gt;**](ChunkMetadataWithFileData.md)
+[**RecommendChunksResponseTypes**](RecommendChunksResponseTypes.md)
 
 ### Authorization
 
@@ -601,7 +601,7 @@ end
 
 ## search_chunk
 
-> <SearchChunkQueryResponseBody> search_chunk(tr_dataset, search_chunk_data)
+> <SearchChunkResponseTypes> search_chunk(tr_dataset, search_chunk_data)
 
 Search
 
@@ -637,7 +637,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SearchChunkQueryResponseBody>, Integer, Hash)> search_chunk_with_http_info(tr_dataset, search_chunk_data)
+> <Array(<SearchChunkResponseTypes>, Integer, Hash)> search_chunk_with_http_info(tr_dataset, search_chunk_data)
 
 ```ruby
 begin
@@ -645,7 +645,7 @@ begin
   data, status_code, headers = api_instance.search_chunk_with_http_info(tr_dataset, search_chunk_data)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SearchChunkQueryResponseBody>
+  p data # => <SearchChunkResponseTypes>
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkApi->search_chunk_with_http_info: #{e}"
 end
@@ -660,7 +660,7 @@ end
 
 ### Return type
 
-[**SearchChunkQueryResponseBody**](SearchChunkQueryResponseBody.md)
+[**SearchChunkResponseTypes**](SearchChunkResponseTypes.md)
 
 ### Authorization
 

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

@@ -1,6 +1,6 @@
 # TrieveRubyClient::ChunkGroupApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -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
 
-> <Array<GroupScoreChunkDTO>> 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,15 +797,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Array<GroupScoreChunkDTO>>, 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 # => <Array<GroupScoreChunkDTO>>
+  p data # => <RecommendGroupChunkResponseTypes>
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->get_recommended_groups_with_http_info: #{e}"
 end
@@ -816,11 +816,11 @@ 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
 
-[**Array&lt;GroupScoreChunkDTO&gt;**](GroupScoreChunkDTO.md)
+[**RecommendGroupChunkResponseTypes**](RecommendGroupChunkResponseTypes.md)
 
 ### Authorization
 
@@ -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
 
@@ -983,7 +983,7 @@ nil (empty response body)
 
 ## search_over_groups
 
-> <SearchOverGroupsResponseBody> search_over_groups(search_over_groups_data)
+> <SearchOverGroupsResponseTypes> search_over_groups(tr_dataset, search_over_groups_data)
 
 Search Over Groups
 
@@ -994,13 +994,21 @@ Search Over Groups  This route allows you to get groups as results instead of ch
 ```ruby
 require 'time'
 require 'trieve_ruby_client'
+# setup authorization
+TrieveRubyClient.configure do |config|
+  # 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::ChunkGroupApi.new
+tr_dataset = 'tr_dataset_example' # String | The dataset id to use for the request
 search_over_groups_data = TrieveRubyClient::SearchOverGroupsData.new({query: 'query_example', search_type: 'search_type_example'}) # SearchOverGroupsData | JSON request payload to semantically search over groups
 
 begin
   # Search Over Groups
-  result = api_instance.search_over_groups(search_over_groups_data)
+  result = api_instance.search_over_groups(tr_dataset, search_over_groups_data)
   p result
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->search_over_groups: #{e}"
@@ -1011,15 +1019,15 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SearchOverGroupsResponseBody>, Integer, Hash)> search_over_groups_with_http_info(search_over_groups_data)
+> <Array(<SearchOverGroupsResponseTypes>, Integer, Hash)> search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
 
 ```ruby
 begin
   # Search Over Groups
-  data, status_code, headers = api_instance.search_over_groups_with_http_info(search_over_groups_data)
+  data, status_code, headers = api_instance.search_over_groups_with_http_info(tr_dataset, search_over_groups_data)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SearchOverGroupsResponseBody>
+  p data # => <SearchOverGroupsResponseTypes>
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->search_over_groups_with_http_info: #{e}"
 end
@@ -1029,15 +1037,16 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **tr_dataset** | **String** | The dataset id to use for the request |  |
 | **search_over_groups_data** | [**SearchOverGroupsData**](SearchOverGroupsData.md) | JSON request payload to semantically search over groups |  |
 
 ### Return type
 
-[**SearchOverGroupsResponseBody**](SearchOverGroupsResponseBody.md)
+[**SearchOverGroupsResponseTypes**](SearchOverGroupsResponseTypes.md)
 
 ### Authorization
 
-No authorization required
+[ApiKey](../README.md#ApiKey)
 
 ### HTTP request headers
 
@@ -1047,7 +1056,7 @@ No authorization required
 
 ## search_within_group
 
-> <SearchGroupsResult> search_within_group(tr_dataset, search_within_group_data)
+> <SearchWithinGroupResponseTypes> search_within_group(tr_dataset, search_within_group_data)
 
 Search Within Group
 
@@ -1083,7 +1092,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SearchGroupsResult>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data)
+> <Array(<SearchWithinGroupResponseTypes>, Integer, Hash)> search_within_group_with_http_info(tr_dataset, search_within_group_data)
 
 ```ruby
 begin
@@ -1091,7 +1100,7 @@ begin
   data, status_code, headers = api_instance.search_within_group_with_http_info(tr_dataset, search_within_group_data)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <SearchGroupsResult>
+  p data # => <SearchWithinGroupResponseTypes>
 rescue TrieveRubyClient::ApiError => e
   puts "Error when calling ChunkGroupApi->search_within_group_with_http_info: #{e}"
 end
@@ -1106,7 +1115,7 @@ end
 
 ### Return type
 
-[**SearchGroupsResult**](SearchGroupsResult.md)
+[**SearchWithinGroupResponseTypes**](SearchWithinGroupResponseTypes.md)
 
 ### Authorization
 

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

@@ -1,11 +1,11 @@
 # TrieveRubyClient::DatasetApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_dataset**](DatasetApi.md#create_dataset) | **POST** /api/dataset | Create dataset |
-| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset | Delete Dataset |
+| [**delete_dataset**](DatasetApi.md#delete_dataset) | **DELETE** /api/dataset/{dataset_id} | Delete Dataset |
 | [**get_client_dataset_config**](DatasetApi.md#get_client_dataset_config) | **GET** /api/dataset/envs | Get Client Configuration |
 | [**get_dataset**](DatasetApi.md#get_dataset) | **GET** /api/dataset/{dataset_id} | Get Dataset |
 | [**get_datasets_from_organization**](DatasetApi.md#get_datasets_from_organization) | **GET** /api/dataset/organization/{organization_id} | Get Datasets from Organization |
@@ -87,7 +87,7 @@ end
 
 ## delete_dataset
 
-> delete_dataset(tr_organization, delete_dataset_request)
+> 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
-delete_dataset_request = TrieveRubyClient::DeleteDatasetRequest.new({dataset_id: 'dataset_id_example'}) # DeleteDatasetRequest | JSON request payload to delete a dataset
+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, delete_dataset_request)
+  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, delete_dataset_request)
+> <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, delete_dataset_request)
+  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,8 +140,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **tr_organization** | **String** | The organization id to use for the request |  |
-| **delete_dataset_request** | [**DeleteDatasetRequest**](DeleteDatasetRequest.md) | JSON request payload to delete a dataset |  |
+| **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
 
@@ -153,7 +153,7 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 

data/docs/EventsApi.md

@@ -1,6 +1,6 @@
 # TrieveRubyClient::EventsApi
 
-All URIs are relative to *http://localhost:8090*
+All URIs are relative to *https://api.trieve.ai*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
@@ -13,7 +13,7 @@ All URIs are relative to *http://localhost:8090*
 
 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