trieve_ruby_client 0.3.5 → 0.5.0

data/lib/trieve_ruby_client/api/chunk_group_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.3.5
+The version of the OpenAPI document: 0.5.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -19,8 +19,8 @@ module TrieveRubyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # add_chunk_to_group
-    # add_chunk_to_group  Route to add a chunk to a group
+    # Add Chunk to Group
+    # Add Chunk to Group  Route to add a chunk to a group.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -31,8 +31,8 @@ module TrieveRubyClient
       nil
     end
 
-    # add_chunk_to_group
-    # add_chunk_to_group  Route to add a chunk to a group
+    # Add Chunk to Group
+    # Add Chunk to Group  Route to add a chunk to a group.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -100,8 +100,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # 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. Think of a bookmark as a chunk which is a member of a group.
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -112,8 +112,8 @@ module TrieveRubyClient
       nil
     end
 
-    # 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. Think of a bookmark as a chunk which is a member of a group.
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Id of the group to add the chunk to as a bookmark
     # @param add_chunk_to_group_data [AddChunkToGroupData] JSON request payload to add a chunk to a group (bookmark it)
@@ -181,8 +181,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # create_chunk_group
-    # create_chunk_group  Create a new chunk_group.
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
     # @param [Hash] opts the optional parameters
@@ -192,8 +192,8 @@ module TrieveRubyClient
       data
     end
 
-    # create_chunk_group
-    # create_chunk_group  Create a new chunk_group.
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
     # @param [Hash] opts the optional parameters
@@ -256,28 +256,26 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # delete_chunk_group
-    # delete_chunk_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
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
-    # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'
+    # @param group_id [String] Id of the group you want to fetch.
     # @param delete_chunks [Boolean] Delete the chunks within the group
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_chunk_group(tr_dataset, group_id, tracking_or_chunk, delete_chunks, opts = {})
-      delete_chunk_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, delete_chunks, opts)
+    def delete_chunk_group(tr_dataset, group_id, delete_chunks, opts = {})
+      delete_chunk_group_with_http_info(tr_dataset, group_id, delete_chunks, opts)
       nil
     end
 
-    # delete_chunk_group
-    # delete_chunk_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
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
-    # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either 'chunk' or 'tracking_id'
+    # @param group_id [String] Id of the group you want to fetch.
     # @param delete_chunks [Boolean] Delete the chunks within the group
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_chunk_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, delete_chunks, opts = {})
+    def delete_chunk_group_with_http_info(tr_dataset, group_id, delete_chunks, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.delete_chunk_group ...'
       end
@@ -285,16 +283,16 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.delete_chunk_group"
       end
-      # verify the required parameter 'tracking_or_chunk' is set
-      if @api_client.config.client_side_validation && tracking_or_chunk.nil?
-        fail ArgumentError, "Missing the required parameter 'tracking_or_chunk' when calling ChunkGroupApi.delete_chunk_group"
+      # verify the required parameter 'group_id' is set
+      if @api_client.config.client_side_validation && group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'group_id' when calling ChunkGroupApi.delete_chunk_group"
       end
       # verify the required parameter 'delete_chunks' is set
       if @api_client.config.client_side_validation && delete_chunks.nil?
         fail ArgumentError, "Missing the required parameter 'delete_chunks' when calling ChunkGroupApi.delete_chunk_group"
       end
       # resource path
-      local_var_path = '/api/{tracking_or_chunk}/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s)).sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s))
+      local_var_path = '/api/chunk_group/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -335,6 +333,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
+    # Delete Group by Tracking ID
+    # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to delete
     # @param [Hash] opts the optional parameters
@@ -344,6 +344,8 @@ module TrieveRubyClient
       nil
     end
 
+    # Delete Group by Tracking ID
+    # Delete Group by Tracking ID  Delete a chunk_group with the given tracking id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to delete
     # @param [Hash] opts the optional parameters
@@ -401,28 +403,96 @@ module TrieveRubyClient
       return data, status_code, headers
     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 Group
+    # Get Group  Fetch the group with the given id. get_group
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param group_id [String] Id of the group you want to fetch.
+    # @param [Hash] opts the optional parameters
+    # @return [ChunkGroup]
+    def get_chunk_group(tr_dataset, group_id, opts = {})
+      data, _status_code, _headers = get_chunk_group_with_http_info(tr_dataset, group_id, opts)
+      data
+    end
+
+    # Get Group
+    # Get Group  Fetch the group with the given id. get_group
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param group_id [String] Id of the group you want to fetch.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ChunkGroup, Integer, Hash)>] ChunkGroup data, response status code and response headers
+    def get_chunk_group_with_http_info(tr_dataset, group_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunk_group ...'
+      end
+      # verify the required parameter 'tr_dataset' is set
+      if @api_client.config.client_side_validation && tr_dataset.nil?
+        fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_chunk_group"
+      end
+      # verify the required parameter 'group_id' is set
+      if @api_client.config.client_side_validation && group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'group_id' when calling ChunkGroupApi.get_chunk_group"
+      end
+      # resource path
+      local_var_path = '/api/chunk_group/{group_id}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'TR-Dataset'] = tr_dataset
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ChunkGroup'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ChunkGroupApi.get_chunk_group",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChunkGroupApi#get_chunk_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
-    # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
+    # @param group_id [String] Id of the group you want to fetch.
     # @param page [Integer] The page of chunks to get from the group
     # @param [Hash] opts the optional parameters
     # @return [BookmarkData]
-    def get_chunks_in_group(tr_dataset, group_id, tracking_or_chunk, page, opts = {})
-      data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, page, opts)
+    def get_chunks_in_group(tr_dataset, group_id, page, opts = {})
+      data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts)
       data
     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
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param group_id [Uuid] Id of the group you want to fetch. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
-    # @param tracking_or_chunk [String] The type of id you are using to search for the group. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
+    # @param group_id [String] Id of the group you want to fetch.
     # @param page [Integer] The page of chunks to get from the group
     # @param [Hash] opts the optional parameters
     # @return [Array<(BookmarkData, Integer, Hash)>] BookmarkData data, response status code and response headers
-    def get_chunks_in_group_with_http_info(tr_dataset, group_id, tracking_or_chunk, page, opts = {})
+    def get_chunks_in_group_with_http_info(tr_dataset, group_id, page, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_chunks_in_group ...'
       end
@@ -430,20 +500,16 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkGroupApi.get_chunks_in_group"
       end
-      # verify the required parameter 'tracking_or_chunk' is set
-      if @api_client.config.client_side_validation && tracking_or_chunk.nil?
-        fail ArgumentError, "Missing the required parameter 'tracking_or_chunk' when calling ChunkGroupApi.get_chunks_in_group"
-      end
-      # verify the required parameter 'page' is set
-      if @api_client.config.client_side_validation && page.nil?
-        fail ArgumentError, "Missing the required parameter 'page' when calling ChunkGroupApi.get_chunks_in_group"
+      # verify the required parameter 'group_id' is set
+      if @api_client.config.client_side_validation && group_id.nil?
+        fail ArgumentError, "Missing the required parameter 'group_id' when calling ChunkGroupApi.get_chunks_in_group"
       end
       if @api_client.config.client_side_validation && page < 0
         fail ArgumentError, 'invalid value for "page" when calling ChunkGroupApi.get_chunks_in_group, must be greater than or equal to 0.'
       end
 
       # resource path
-      local_var_path = '/api/chunk_group/{tracking_or_chunk}/{group_id}/{page}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s)).sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'page' + '}', CGI.escape(page.to_s))
+      local_var_path = '/api/chunk_group/{group_id}/{page}'.sub('{' + 'group_id' + '}', CGI.escape(group_id.to_s)).sub('{' + 'page' + '}', CGI.escape(page.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -483,8 +549,8 @@ module TrieveRubyClient
       return data, status_code, headers
     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
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_tracking_id [String] The id of the group to get the chunks from
     # @param page [Integer] The page of chunks to get from the group
@@ -495,8 +561,8 @@ module TrieveRubyClient
       data
     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
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_tracking_id [String] The id of the group to get the chunks from
     # @param page [Integer] The page of chunks to get from the group
@@ -563,8 +629,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # get_group_by_tracking_id
-    # get_group_by_tracking_id
+    # Get Group by Tracking ID
+    # Get Group by Tracking ID  Fetch the group with the given tracking id. get_group_by_tracking_id
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] The tracking id of the group to fetch.
     # @param [Hash] opts the optional parameters
@@ -574,8 +640,8 @@ module TrieveRubyClient
       data
     end
 
-    # get_group_by_tracking_id
-    # get_group_by_tracking_id
+    # Get Group by Tracking ID
+    # Get Group by Tracking ID  Fetch the group with the given tracking id. get_group_by_tracking_id
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] The tracking id of the group to fetch.
     # @param [Hash] opts the optional parameters
@@ -633,6 +699,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
+    # Get Groups for Chunks
+    # Get Groups for Chunks  Route to get the groups that a chunk is in.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
     # @param [Hash] opts the optional parameters
@@ -642,6 +710,8 @@ module TrieveRubyClient
       data
     end
 
+    # Get Groups for Chunks
+    # Get Groups for Chunks  Route to get the groups that a chunk is in.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param get_groups_for_chunks_data [GetGroupsForChunksData] JSON request payload to get the groups that a chunk is in
     # @param [Hash] opts the optional parameters
@@ -704,6 +774,8 @@ module TrieveRubyClient
       return data, status_code, headers
     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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param reccomend_group_chunks_request [ReccomendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
     # @param [Hash] opts the optional parameters
@@ -713,6 +785,8 @@ module TrieveRubyClient
       data
     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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param reccomend_group_chunks_request [ReccomendGroupChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
     # @param [Hash] opts the optional parameters
@@ -775,8 +849,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # get_dataset_groups
-    # get_dataset_groups  Fetch the groups which belong to a dataset specified by its id.
+    # Get Groups for Dataset
+    # Get Groups for Dataset  Fetch the groups which belong to a dataset specified by its id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param dataset_id [String] The id of the dataset to fetch groups for.
     # @param page [Integer] The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
@@ -787,8 +861,8 @@ module TrieveRubyClient
       data
     end
 
-    # get_dataset_groups
-    # get_dataset_groups  Fetch the groups which belong to a dataset specified by its id.
+    # Get Groups for Dataset
+    # Get Groups for Dataset  Fetch the groups which belong to a dataset specified by its id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param dataset_id [String] The id of the dataset to fetch groups for.
     # @param page [Integer] The page of groups to fetch. Each page contains 10 groups. Support for custom page size is coming soon.
@@ -851,8 +925,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # remove_chunk_from_group
-    # remove_chunk_from_group  Route to remove a chunk from a group.
+    # Remove Chunk from Group
+    # Remove Chunk from Group  Route to remove a chunk from a group.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group to remove the bookmark&#39;ed chunk from
     # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
@@ -863,8 +937,8 @@ module TrieveRubyClient
       nil
     end
 
-    # remove_chunk_from_group
-    # remove_chunk_from_group  Route to remove a chunk from a group.
+    # Remove Chunk from Group
+    # Remove Chunk from Group  Route to remove a chunk from a group.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param group_id [String] Id of the group to remove the bookmark&#39;ed chunk from
     # @param create_chunk_group_data [CreateChunkGroupData] JSON request payload to cretea a chunkGroup
@@ -932,8 +1006,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # group_oriented_search
-    # group_oriented_search  This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
+    # Search Over Groups
+    # Search Over Groups  This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
     # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
     # @param [Hash] opts the optional parameters
     # @return [SearchOverGroupsResponseBody]
@@ -942,8 +1016,8 @@ module TrieveRubyClient
       data
     end
 
-    # group_oriented_search
-    # group_oriented_search  This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
+    # Search Over Groups
+    # Search Over Groups  This route allows you to get groups as results instead of chunks. Each group returned will have the matching chunks sorted by similarity within the group. This is useful for when you want to get groups of chunks which are similar to the search query. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large. Compatible with semantic, fulltext, or hybrid search modes.
     # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
     # @param [Hash] opts the optional parameters
     # @return [Array<(SearchOverGroupsResponseBody, Integer, Hash)>] SearchOverGroupsResponseBody data, response status code and response headers
@@ -1000,8 +1074,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # search_within_group
-    # search_within_group  This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
+    # Search Within Group
+    # Search Within Group  This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
     # @param [Hash] opts the optional parameters
@@ -1011,8 +1085,8 @@ module TrieveRubyClient
       data
     end
 
-    # search_within_group
-    # search_within_group  This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
+    # Search Within Group
+    # Search Within Group  This route allows you to search only within a group. This is useful for when you only want search results to contain chunks which are members of a specific group. If choosing hybrid search, the results will be re-ranked using BAAI/bge-reranker-large.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param search_within_group_data [SearchWithinGroupData] JSON request payload to semantically search a group
     # @param [Hash] opts the optional parameters
@@ -1075,8 +1149,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # update_chunk_group
-    # update_chunk_group  Update a chunk_group.
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
     # @param [Hash] opts the optional parameters
@@ -1086,8 +1160,8 @@ module TrieveRubyClient
       nil
     end
 
-    # update_chunk_group
-    # update_chunk_group  Update a chunk_group.
+    # 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.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param update_chunk_group_data [UpdateChunkGroupData] JSON request payload to update a chunkGroup
     # @param [Hash] opts the optional parameters
@@ -1150,6 +1224,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
+    # Update Group by Tracking ID
+    # Update Group by Tracking ID  Update a chunk_group with the given tracking id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to update
     # @param update_group_by_tracking_id_data [UpdateGroupByTrackingIDData] JSON request payload to update a chunkGroup
@@ -1160,6 +1236,8 @@ module TrieveRubyClient
       nil
     end
 
+    # Update Group by Tracking ID
+    # Update Group by Tracking ID  Update a chunk_group with the given tracking id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] Tracking id of the chunk_group to update
     # @param update_group_by_tracking_id_data [UpdateGroupByTrackingIDData] JSON request payload to update a chunkGroup

data/lib/trieve_ruby_client/api/dataset_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.3.5
+The version of the OpenAPI document: 0.5.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -19,8 +19,8 @@ module TrieveRubyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # create_dataset
-    # create_dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
+    # Create dataset
+    # Create dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
     # @param [Hash] opts the optional parameters
@@ -30,8 +30,8 @@ module TrieveRubyClient
       data
     end
 
-    # create_dataset
-    # create_dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
+    # Create dataset
+    # Create dataset  Create a new dataset. The auth'ed user must be an owner of the organization to create a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param create_dataset_request [CreateDatasetRequest] JSON request payload to create a new dataset
     # @param [Hash] opts the optional parameters
@@ -94,8 +94,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # delete_dataset
-    # delete_dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
+    # Delete Dataset
+    # Delete Dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param delete_dataset_request [DeleteDatasetRequest] JSON request payload to delete a dataset
     # @param [Hash] opts the optional parameters
@@ -105,8 +105,8 @@ module TrieveRubyClient
       nil
     end
 
-    # delete_dataset
-    # delete_dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
+    # Delete Dataset
+    # Delete Dataset  Delete a dataset. The auth'ed user must be an owner of the organization to delete a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param delete_dataset_request [DeleteDatasetRequest] JSON request payload to delete a dataset
     # @param [Hash] opts the optional parameters
@@ -169,8 +169,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # get_client_dataset_config
-    # get_client_dataset_config  Get the client configuration for a dataset. Will use the TR-D
+    # Get Client Configuration
+    # Get Client Configuration  Get the client configuration for a dataset. Will use the TR-D
     # @param tr_dataset [String] The dataset id to use for the request
     # @param [Hash] opts the optional parameters
     # @return [ClientDatasetConfiguration]
@@ -179,8 +179,8 @@ module TrieveRubyClient
       data
     end
 
-    # get_client_dataset_config
-    # get_client_dataset_config  Get the client configuration for a dataset. Will use the TR-D
+    # Get Client Configuration
+    # Get Client Configuration  Get the client configuration for a dataset. Will use the TR-D
     # @param tr_dataset [String] The dataset id to use for the request
     # @param [Hash] opts the optional parameters
     # @return [Array<(ClientDatasetConfiguration, Integer, Hash)>] ClientDatasetConfiguration data, response status code and response headers
@@ -233,8 +233,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # get_dataset
-    # get_dataset  Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
+    # Get Dataset
+    # Get Dataset  Get a dataset by id. The auth'ed user must be an admin or owner of the organization to get a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param tr_dataset [String] The dataset id to use for the request
     # @param dataset_id [String] The id of the dataset you want to retrieve.
@@ -245,8 +245,8 @@ module TrieveRubyClient
       data
     end
 
-    # get_dataset
-    # get_dataset  Get a dataset by id. The auth&#39;ed user must be an admin or owner of the organization to get a dataset.
+    # Get Dataset
+    # Get Dataset  Get a dataset by id. The auth&#39;ed user must be an admin or owner of the organization to get a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param tr_dataset [String] The dataset id to use for the request
     # @param dataset_id [String] The id of the dataset you want to retrieve.
@@ -310,8 +310,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # get_organization_datasets
-    # get_organization_datasets  Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
+    # Get Datasets from Organization
+    # Get Datasets from Organization  Get all datasets for an organization. The auth'ed user must be an admin or owner of the organization to get its datasets.
     # @param tr_organization [String] The organization id to use for the request
     # @param organization_id [String] id of the organization you want to retrieve datasets for
     # @param [Hash] opts the optional parameters
@@ -321,8 +321,8 @@ module TrieveRubyClient
       data
     end
 
-    # get_organization_datasets
-    # get_organization_datasets  Get all datasets for an organization. The auth&#39;ed user must be an admin or owner of the organization to get its datasets.
+    # Get Datasets from Organization
+    # Get Datasets from Organization  Get all datasets for an organization. The auth&#39;ed user must be an admin or owner of the organization to get its datasets.
     # @param tr_organization [String] The organization id to use for the request
     # @param organization_id [String] id of the organization you want to retrieve datasets for
     # @param [Hash] opts the optional parameters
@@ -380,8 +380,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # update_dataset
-    # update_dataset  Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
+    # Update Dataset
+    # Update Dataset  Update a dataset. The auth'ed user must be an owner of the organization to update a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
     # @param [Hash] opts the optional parameters
@@ -391,8 +391,8 @@ module TrieveRubyClient
       data
     end
 
-    # update_dataset
-    # update_dataset  Update a dataset. The auth&#39;ed user must be an owner of the organization to update a dataset.
+    # Update Dataset
+    # Update Dataset  Update a dataset. The auth&#39;ed user must be an owner of the organization to update a dataset.
     # @param tr_organization [String] The organization id to use for the request
     # @param update_dataset_request [UpdateDatasetRequest] JSON request payload to update a dataset
     # @param [Hash] opts the optional parameters