trieve_ruby_client 0.4.0 → 0.5.7

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.4.0
+The version of the OpenAPI document: 0.5.7
 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 Chunk
-    # Create Chunk  Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
+    # Create or Upsert Chunk or Chunks
+    # Create or Upsert Chunk or Chunks  Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
     # @param [Hash] opts the optional parameters
@@ -30,8 +30,8 @@ module TrieveRubyClient
       data
     end
 
-    # Create Chunk
-    # Create Chunk  Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
+    # Create or Upsert Chunk or Chunks
+    # Create or Upsert Chunk or Chunks  Create a new chunk. If the chunk has the same tracking_id as an existing chunk, the request will fail. Once a chunk is created, it can be searched for using the search endpoint.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param create_chunk_data [CreateChunkData] JSON request payload to create a new chunk (chunk)
     # @param [Hash] opts the optional parameters
@@ -172,23 +172,21 @@ module TrieveRubyClient
     # Delete Chunk
     # Delete Chunk  Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'
-    # @param chunk_id [String] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
+    # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_chunk(tr_dataset, tracking_or_chunk, chunk_id, opts = {})
-      delete_chunk_with_http_info(tr_dataset, tracking_or_chunk, chunk_id, opts)
+    def delete_chunk(tr_dataset, chunk_id, opts = {})
+      delete_chunk_with_http_info(tr_dataset, chunk_id, opts)
       nil
     end
 
     # Delete Chunk
     # Delete Chunk  Delete a chunk by its id. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either 'chunk' or 'tracking_id'
-    # @param chunk_id [String] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
+    # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_chunk_with_http_info(tr_dataset, tracking_or_chunk, chunk_id, opts = {})
+    def delete_chunk_with_http_info(tr_dataset, chunk_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.delete_chunk ...'
       end
@@ -196,12 +194,12 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.delete_chunk"
       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 ChunkApi.delete_chunk"
+      # verify the required parameter 'chunk_id' is set
+      if @api_client.config.client_side_validation && chunk_id.nil?
+        fail ArgumentError, "Missing the required parameter 'chunk_id' when calling ChunkApi.delete_chunk"
       end
       # resource path
-      local_var_path = '/api/chunk/{tracking_or_chunk}/{chunk_id}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s))
+      local_var_path = '/api/chunk/{chunk_id}'.sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -311,8 +309,8 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # RAG on User Defined Chunks
-    # RAG on User Defined Chunks  This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
+    # RAG on Specified Chunks
+    # RAG on Specified Chunks  This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \"search before generate\" page at docs.trieve.ai.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param generate_chunks_request [GenerateChunksRequest] JSON request payload to perform RAG on some chunks (chunks)
     # @param [Hash] opts the optional parameters
@@ -322,8 +320,8 @@ module TrieveRubyClient
       data
     end
 
-    # RAG on User Defined Chunks
-    # RAG on User Defined Chunks  This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \&quot;search before generate\&quot; page at docs.trieve.ai.
+    # RAG on Specified Chunks
+    # RAG on Specified Chunks  This endpoint exists as an alternative to the topic+message concept where our API handles chat memory. With this endpoint, the user is responsible for providing the context window and the prompt. See more in the \&quot;search before generate\&quot; page at docs.trieve.ai.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param generate_chunks_request [GenerateChunksRequest] JSON request payload to perform RAG on some chunks (chunks)
     # @param [Hash] opts the optional parameters
@@ -389,23 +387,21 @@ module TrieveRubyClient
     # Get Chunk By Id
     # Get Chunk By Id  Get a singular chunk by id.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
-    # @param chunk_id [String] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
+    # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
     # @return [ChunkMetadata]
-    def get_chunk_by_id(tr_dataset, tracking_or_chunk, chunk_id, opts = {})
-      data, _status_code, _headers = get_chunk_by_id_with_http_info(tr_dataset, tracking_or_chunk, chunk_id, opts)
+    def get_chunk_by_id(tr_dataset, chunk_id, opts = {})
+      data, _status_code, _headers = get_chunk_by_id_with_http_info(tr_dataset, chunk_id, opts)
       data
     end
 
     # Get Chunk By Id
     # Get Chunk By Id  Get a singular chunk by id.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param tracking_or_chunk [String] The type of id you are using to search for the chunk. This can be either &#39;chunk&#39; or &#39;tracking_id&#39;
-    # @param chunk_id [String] Id of the chunk you want to fetch. This can be either the chunk_id or the tracking_id.
+    # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
     # @return [Array<(ChunkMetadata, Integer, Hash)>] ChunkMetadata data, response status code and response headers
-    def get_chunk_by_id_with_http_info(tr_dataset, tracking_or_chunk, chunk_id, opts = {})
+    def get_chunk_by_id_with_http_info(tr_dataset, chunk_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunk_by_id ...'
       end
@@ -413,12 +409,12 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.get_chunk_by_id"
       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 ChunkApi.get_chunk_by_id"
+      # verify the required parameter 'chunk_id' is set
+      if @api_client.config.client_side_validation && chunk_id.nil?
+        fail ArgumentError, "Missing the required parameter 'chunk_id' when calling ChunkApi.get_chunk_by_id"
       end
       # resource path
-      local_var_path = '/api/chunk/{tracking_or_chunk}/{chunk_id}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s))
+      local_var_path = '/api/chunk/{chunk_id}'.sub('{' + 'chunk_id' + '}', CGI.escape(chunk_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -533,7 +529,7 @@ module TrieveRubyClient
     # @param tr_dataset [String] The dataset id to use for the request
     # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
     # @param [Hash] opts the optional parameters
-    # @return [Array<ChunkMetadataWithFileData>]
+    # @return [RecommendChunksResponseTypes]
     def get_recommended_chunks(tr_dataset, recommend_chunks_request, opts = {})
       data, _status_code, _headers = get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts)
       data
@@ -544,7 +540,7 @@ module TrieveRubyClient
     # @param tr_dataset [String] The dataset id to use for the request
     # @param recommend_chunks_request [RecommendChunksRequest] JSON request payload to get recommendations of chunks similar to the chunks in the request
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<ChunkMetadataWithFileData>, Integer, Hash)>] Array<ChunkMetadataWithFileData> data, response status code and response headers
+    # @return [Array<(RecommendChunksResponseTypes, Integer, Hash)>] RecommendChunksResponseTypes data, response status code and response headers
     def get_recommended_chunks_with_http_info(tr_dataset, recommend_chunks_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.get_recommended_chunks ...'
@@ -581,7 +577,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(recommend_chunks_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<ChunkMetadataWithFileData>'
+      return_type = opts[:debug_return_type] || 'RecommendChunksResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -608,7 +604,7 @@ module TrieveRubyClient
     # @param tr_dataset [String] The dataset id to use for the request
     # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
     # @param [Hash] opts the optional parameters
-    # @return [SearchChunkQueryResponseBody]
+    # @return [SearchChunkResponseTypes]
     def search_chunk(tr_dataset, search_chunk_data, opts = {})
       data, _status_code, _headers = search_chunk_with_http_info(tr_dataset, search_chunk_data, opts)
       data
@@ -619,7 +615,7 @@ module TrieveRubyClient
     # @param tr_dataset [String] The dataset id to use for the request
     # @param search_chunk_data [SearchChunkData] JSON request payload to semantically search for chunks (chunks)
     # @param [Hash] opts the optional parameters
-    # @return [Array<(SearchChunkQueryResponseBody, Integer, Hash)>] SearchChunkQueryResponseBody data, response status code and response headers
+    # @return [Array<(SearchChunkResponseTypes, Integer, Hash)>] SearchChunkResponseTypes data, response status code and response headers
     def search_chunk_with_http_info(tr_dataset, search_chunk_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.search_chunk ...'
@@ -656,7 +652,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(search_chunk_data)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'SearchChunkQueryResponseBody'
+      return_type = opts[:debug_return_type] || 'SearchChunkResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -708,7 +704,7 @@ module TrieveRubyClient
         fail ArgumentError, "Missing the required parameter 'update_chunk_data' when calling ChunkApi.update_chunk"
       end
       # resource path
-      local_var_path = '/api/chunk/update'
+      local_var_path = '/api/chunk'
 
       # query parameters
       query_params = opts[:query_params] || {}

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.4.0
+The version of the OpenAPI document: 0.5.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -20,7 +20,7 @@ module TrieveRubyClient
       @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  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)
@@ -32,7 +32,7 @@ module TrieveRubyClient
     end
 
     # Add Chunk to Group
-    # Add Chunk to Group  Route to add a chunk to a group
+    # Add Chunk to Group  Route to add a chunk to a group.
     # @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)
@@ -101,7 +101,7 @@ module TrieveRubyClient
     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  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)
@@ -113,7 +113,7 @@ module TrieveRubyClient
     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  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)
@@ -182,7 +182,7 @@ module TrieveRubyClient
     end
 
     # Create Chunk Group
-    # Create Chunk Group  Create a new 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
@@ -193,7 +193,7 @@ module TrieveRubyClient
     end
 
     # Create Chunk Group
-    # Create Chunk Group  Create a new 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
@@ -259,25 +259,23 @@ module TrieveRubyClient
     # 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 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. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
+    # @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, tracking_or_chunk, group_id, delete_chunks, opts = {})
-      delete_chunk_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, 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 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 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. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
+    # @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, tracking_or_chunk, group_id, 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/chunk_group/{tracking_or_chunk}/{group_id}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_id.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] || {}
@@ -408,23 +406,21 @@ module TrieveRubyClient
     # 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 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. This can be either the group_id or the tracking_id.
+    # @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, tracking_or_chunk, group_id, opts = {})
-      data, _status_code, _headers = get_chunk_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, opts)
+    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 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. This can be either the group_id or the tracking_id.
+    # @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, tracking_or_chunk, group_id, opts = {})
+    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
@@ -432,12 +428,12 @@ module TrieveRubyClient
       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 '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_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.get_chunk_group"
       end
       # resource path
-      local_var_path = '/api/chunk_group/{tracking_or_chunk}/{group_id}'.sub('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_id.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] || {}
@@ -480,25 +476,23 @@ module TrieveRubyClient
     # 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 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. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
+    # @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, tracking_or_chunk, group_id, page, opts = {})
-      data, _status_code, _headers = get_chunks_in_group_with_http_info(tr_dataset, tracking_or_chunk, group_id, 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.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @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. This can be either the group_id or the tracking_id. If both are provided, the group_id will be used.
+    # @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, tracking_or_chunk, group_id, 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
@@ -506,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('{' + 'tracking_or_chunk' + '}', CGI.escape(tracking_or_chunk.to_s)).sub('{' + 'group_id' + '}', CGI.escape(group_id.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] || {}
@@ -789,7 +779,7 @@ module TrieveRubyClient
     # @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
-    # @return [Array<GroupScoreChunkDTO>]
+    # @return [RecommendGroupChunkResponseTypes]
     def get_recommended_groups(tr_dataset, reccomend_group_chunks_request, opts = {})
       data, _status_code, _headers = get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request, opts)
       data
@@ -800,7 +790,7 @@ module TrieveRubyClient
     # @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
-    # @return [Array<(Array<GroupScoreChunkDTO>, Integer, Hash)>] Array<GroupScoreChunkDTO> data, response status code and response headers
+    # @return [Array<(RecommendGroupChunkResponseTypes, Integer, Hash)>] RecommendGroupChunkResponseTypes data, response status code and response headers
     def get_recommended_groups_with_http_info(tr_dataset, reccomend_group_chunks_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.get_recommended_groups ...'
@@ -837,7 +827,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(reccomend_group_chunks_request)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<GroupScoreChunkDTO>'
+      return_type = opts[:debug_return_type] || 'RecommendGroupChunkResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -1018,23 +1008,29 @@ module TrieveRubyClient
 
     # 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 tr_dataset [String] The dataset id to use for the request
     # @param search_over_groups_data [SearchOverGroupsData] JSON request payload to semantically search over groups
     # @param [Hash] opts the optional parameters
-    # @return [SearchOverGroupsResponseBody]
-    def search_over_groups(search_over_groups_data, opts = {})
-      data, _status_code, _headers = search_over_groups_with_http_info(search_over_groups_data, opts)
+    # @return [SearchOverGroupsResponseTypes]
+    def search_over_groups(tr_dataset, search_over_groups_data, opts = {})
+      data, _status_code, _headers = search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts)
       data
     end
 
     # 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 tr_dataset [String] The dataset id to use for the request
     # @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
-    def search_over_groups_with_http_info(search_over_groups_data, opts = {})
+    # @return [Array<(SearchOverGroupsResponseTypes, Integer, Hash)>] SearchOverGroupsResponseTypes data, response status code and response headers
+    def search_over_groups_with_http_info(tr_dataset, search_over_groups_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_over_groups ...'
       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.search_over_groups"
+      end
       # verify the required parameter 'search_over_groups_data' is set
       if @api_client.config.client_side_validation && search_over_groups_data.nil?
         fail ArgumentError, "Missing the required parameter 'search_over_groups_data' when calling ChunkGroupApi.search_over_groups"
@@ -1054,6 +1050,7 @@ module TrieveRubyClient
       if !content_type.nil?
           header_params['Content-Type'] = content_type
       end
+      header_params[:'TR-Dataset'] = tr_dataset
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -1062,10 +1059,10 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(search_over_groups_data)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseBody'
+      return_type = opts[:debug_return_type] || 'SearchOverGroupsResponseTypes'
 
       # auth_names
-      auth_names = opts[:debug_auth_names] || []
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
 
       new_options = opts.merge(
         :operation => :"ChunkGroupApi.search_over_groups",
@@ -1089,7 +1086,7 @@ module TrieveRubyClient
     # @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
-    # @return [SearchGroupsResult]
+    # @return [SearchWithinGroupResponseTypes]
     def search_within_group(tr_dataset, search_within_group_data, opts = {})
       data, _status_code, _headers = search_within_group_with_http_info(tr_dataset, search_within_group_data, opts)
       data
@@ -1100,7 +1097,7 @@ module TrieveRubyClient
     # @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
-    # @return [Array<(SearchGroupsResult, Integer, Hash)>] SearchGroupsResult data, response status code and response headers
+    # @return [Array<(SearchWithinGroupResponseTypes, Integer, Hash)>] SearchWithinGroupResponseTypes data, response status code and response headers
     def search_within_group_with_http_info(tr_dataset, search_within_group_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkGroupApi.search_within_group ...'
@@ -1137,7 +1134,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(search_within_group_data)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'SearchGroupsResult'
+      return_type = opts[:debug_return_type] || 'SearchWithinGroupResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -1160,7 +1157,7 @@ module TrieveRubyClient
     end
 
     # Update Group
-    # Update Group  Update a chunk_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
@@ -1171,7 +1168,7 @@ module TrieveRubyClient
     end
 
     # Update Group
-    # Update Group  Update a chunk_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

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.4.0
+The version of the OpenAPI document: 0.5.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -97,21 +97,21 @@ module TrieveRubyClient
     # 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 dataset_id [String] The id of the dataset you want to delete.
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def delete_dataset(tr_organization, delete_dataset_request, opts = {})
-      delete_dataset_with_http_info(tr_organization, delete_dataset_request, opts)
+    def delete_dataset(tr_organization, dataset_id, opts = {})
+      delete_dataset_with_http_info(tr_organization, dataset_id, opts)
       nil
     end
 
     # 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 dataset_id [String] The id of the dataset you want to delete.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_dataset_with_http_info(tr_organization, delete_dataset_request, opts = {})
+    def delete_dataset_with_http_info(tr_organization, dataset_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DatasetApi.delete_dataset ...'
       end
@@ -119,12 +119,12 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_organization.nil?
         fail ArgumentError, "Missing the required parameter 'tr_organization' when calling DatasetApi.delete_dataset"
       end
-      # verify the required parameter 'delete_dataset_request' is set
-      if @api_client.config.client_side_validation && delete_dataset_request.nil?
-        fail ArgumentError, "Missing the required parameter 'delete_dataset_request' when calling DatasetApi.delete_dataset"
+      # verify the required parameter 'dataset_id' is set
+      if @api_client.config.client_side_validation && dataset_id.nil?
+        fail ArgumentError, "Missing the required parameter 'dataset_id' when calling DatasetApi.delete_dataset"
       end
       # resource path
-      local_var_path = '/api/dataset'
+      local_var_path = '/api/dataset/{dataset_id}'.sub('{' + 'dataset_id' + '}', CGI.escape(dataset_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -133,18 +133,13 @@ module TrieveRubyClient
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
-      # HTTP header 'Content-Type'
-      content_type = @api_client.select_header_content_type(['application/json'])
-      if !content_type.nil?
-          header_params['Content-Type'] = content_type
-      end
       header_params[:'TR-Organization'] = tr_organization
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(delete_dataset_request)
+      post_body = opts[:debug_body]
 
       # return_type
       return_type = opts[:debug_return_type]

data/lib/trieve_ruby_client/api/events_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.4.0
+The version of the OpenAPI document: 0.5.7
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0