trieve_ruby_client 0.8.2 → 0.11.0

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.8.2
+The version of the OpenAPI document: 0.11.0
 Contact: developers@trieve.ai
 Generated by: https://openapi-generator.tech
 Generator version: 7.4.0
@@ -19,37 +19,39 @@ module TrieveRubyClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # 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. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.
+    # Autocomplete
+    # This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
     # @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 autocomplete_req_payload [AutocompleteReqPayload] JSON request payload to semantically search for chunks (chunks)
     # @param [Hash] opts the optional parameters
-    # @return [ReturnQueuedChunk]
-    def create_chunk(tr_dataset, create_chunk_data, opts = {})
-      data, _status_code, _headers = create_chunk_with_http_info(tr_dataset, create_chunk_data, opts)
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [SearchResponseTypes]
+    def autocomplete(tr_dataset, autocomplete_req_payload, opts = {})
+      data, _status_code, _headers = autocomplete_with_http_info(tr_dataset, autocomplete_req_payload, opts)
       data
     end
 
-    # 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. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks.
+    # Autocomplete
+    # This route provides the primary autocomplete functionality for the API. This prioritize prefix matching with semantic or full-text search.
     # @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 autocomplete_req_payload [AutocompleteReqPayload] JSON request payload to semantically search for chunks (chunks)
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ReturnQueuedChunk, Integer, Hash)>] ReturnQueuedChunk data, response status code and response headers
-    def create_chunk_with_http_info(tr_dataset, create_chunk_data, opts = {})
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(SearchResponseTypes, Integer, Hash)>] SearchResponseTypes data, response status code and response headers
+    def autocomplete_with_http_info(tr_dataset, autocomplete_req_payload, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ChunkApi.create_chunk ...'
+        @api_client.config.logger.debug 'Calling API: ChunkApi.autocomplete ...'
       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 ChunkApi.create_chunk"
+        fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.autocomplete"
       end
-      # verify the required parameter 'create_chunk_data' is set
-      if @api_client.config.client_side_validation && create_chunk_data.nil?
-        fail ArgumentError, "Missing the required parameter 'create_chunk_data' when calling ChunkApi.create_chunk"
+      # verify the required parameter 'autocomplete_req_payload' is set
+      if @api_client.config.client_side_validation && autocomplete_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'autocomplete_req_payload' when calling ChunkApi.autocomplete"
       end
       # resource path
-      local_var_path = '/api/chunk'
+      local_var_path = '/api/chunk/autocomplete'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -64,21 +66,22 @@ module TrieveRubyClient
           header_params['Content-Type'] = content_type
       end
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_data)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(autocomplete_req_payload)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'ReturnQueuedChunk'
+      return_type = opts[:debug_return_type] || 'SearchResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
 
       new_options = opts.merge(
-        :operation => :"ChunkApi.create_chunk",
+        :operation => :"ChunkApi.autocomplete",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -89,42 +92,42 @@ module TrieveRubyClient
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ChunkApi#create_chunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ChunkApi#autocomplete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # Generate suggested queries
-    # Generate suggested queries  This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
+    # Count chunks above threshold
+    # This route can be used to determine the number of chunks that match a given search criteria including filters and score threshold. It may be high latency for large datasets. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization. There is a dataset configuration imposed restriction on the maximum limit value (default 10,000) which is used to prevent DDOS attacks.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param suggested_queries_request [SuggestedQueriesRequest] JSON request payload to get alternative suggested queries
+    # @param count_chunks_req_payload [CountChunksReqPayload] 
     # @param [Hash] opts the optional parameters
-    # @return [SuggestedQueriesResponse]
-    def create_suggested_queries_handler(tr_dataset, suggested_queries_request, opts = {})
-      data, _status_code, _headers = create_suggested_queries_handler_with_http_info(tr_dataset, suggested_queries_request, opts)
+    # @return [CountChunkQueryResponseBody]
+    def count_chunks(tr_dataset, count_chunks_req_payload, opts = {})
+      data, _status_code, _headers = count_chunks_with_http_info(tr_dataset, count_chunks_req_payload, opts)
       data
     end
 
-    # Generate suggested queries
-    # Generate suggested queries  This endpoint will generate 3 suggested queries based off the query provided in the request body and return them as a JSON object.
+    # Count chunks above threshold
+    # This route can be used to determine the number of chunks that match a given search criteria including filters and score threshold. It may be high latency for large datasets. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization. There is a dataset configuration imposed restriction on the maximum limit value (default 10,000) which is used to prevent DDOS attacks.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param suggested_queries_request [SuggestedQueriesRequest] JSON request payload to get alternative suggested queries
+    # @param count_chunks_req_payload [CountChunksReqPayload] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(SuggestedQueriesResponse, Integer, Hash)>] SuggestedQueriesResponse data, response status code and response headers
-    def create_suggested_queries_handler_with_http_info(tr_dataset, suggested_queries_request, opts = {})
+    # @return [Array<(CountChunkQueryResponseBody, Integer, Hash)>] CountChunkQueryResponseBody data, response status code and response headers
+    def count_chunks_with_http_info(tr_dataset, count_chunks_req_payload, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: ChunkApi.create_suggested_queries_handler ...'
+        @api_client.config.logger.debug 'Calling API: ChunkApi.count_chunks ...'
       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 ChunkApi.create_suggested_queries_handler"
+        fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.count_chunks"
       end
-      # verify the required parameter 'suggested_queries_request' is set
-      if @api_client.config.client_side_validation && suggested_queries_request.nil?
-        fail ArgumentError, "Missing the required parameter 'suggested_queries_request' when calling ChunkApi.create_suggested_queries_handler"
+      # verify the required parameter 'count_chunks_req_payload' is set
+      if @api_client.config.client_side_validation && count_chunks_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'count_chunks_req_payload' when calling ChunkApi.count_chunks"
       end
       # resource path
-      local_var_path = '/api/chunk/gen_suggestions'
+      local_var_path = '/api/chunk/count'
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -144,16 +147,91 @@ module TrieveRubyClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(suggested_queries_request)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(count_chunks_req_payload)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'SuggestedQueriesResponse'
+      return_type = opts[:debug_return_type] || 'CountChunkQueryResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ChunkApi.count_chunks",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChunkApi#count_chunks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param create_chunk_req_payload_enum [CreateChunkReqPayloadEnum] JSON request payload to create a new chunk (chunk)
+    # @param [Hash] opts the optional parameters
+    # @return [ReturnQueuedChunk]
+    def create_chunk(tr_dataset, create_chunk_req_payload_enum, opts = {})
+      data, _status_code, _headers = create_chunk_with_http_info(tr_dataset, create_chunk_req_payload_enum, opts)
+      data
+    end
+
+    # 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. If uploading in bulk, the maximum amount of chunks that can be uploaded at once is 120 chunks. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param create_chunk_req_payload_enum [CreateChunkReqPayloadEnum] JSON request payload to create a new chunk (chunk)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ReturnQueuedChunk, Integer, Hash)>] ReturnQueuedChunk data, response status code and response headers
+    def create_chunk_with_http_info(tr_dataset, create_chunk_req_payload_enum, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChunkApi.create_chunk ...'
+      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 ChunkApi.create_chunk"
+      end
+      # verify the required parameter 'create_chunk_req_payload_enum' is set
+      if @api_client.config.client_side_validation && create_chunk_req_payload_enum.nil?
+        fail ArgumentError, "Missing the required parameter 'create_chunk_req_payload_enum' when calling ChunkApi.create_chunk"
+      end
+      # resource path
+      local_var_path = '/api/chunk'
+
+      # 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'])
+      # 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-Dataset'] = tr_dataset
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_chunk_req_payload_enum)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ReturnQueuedChunk'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
 
       new_options = opts.merge(
-        :operation => :"ChunkApi.create_suggested_queries_handler",
+        :operation => :"ChunkApi.create_chunk",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -164,13 +242,13 @@ module TrieveRubyClient
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: ChunkApi#create_suggested_queries_handler\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: ChunkApi#create_chunk\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     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.
+    # 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. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
@@ -181,7 +259,7 @@ module TrieveRubyClient
     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.
+    # 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. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
@@ -240,7 +318,7 @@ module TrieveRubyClient
     end
 
     # Delete Chunk By Tracking Id
-    # Delete Chunk By Tracking Id  Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
+    # Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] tracking_id of the chunk you want to delete
     # @param [Hash] opts the optional parameters
@@ -251,7 +329,7 @@ module TrieveRubyClient
     end
 
     # Delete Chunk By Tracking Id
-    # Delete Chunk By Tracking Id  Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk.
+    # Delete a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. If deleting a root chunk which has a collision, the most recently created collision will become a new root chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] tracking_id of the chunk you want to delete
     # @param [Hash] opts the optional parameters
@@ -310,7 +388,7 @@ module TrieveRubyClient
     end
 
     # 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.
+    # 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
@@ -321,7 +399,7 @@ module TrieveRubyClient
     end
 
     # 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.
+    # 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
@@ -385,22 +463,24 @@ module TrieveRubyClient
     end
 
     # Get Chunk By Id
-    # Get Chunk By Id  Get a singular chunk by id.
+    # Get a singular chunk by id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param chunk_id [String] Id of the chunk you want to fetch.
     # @param [Hash] opts the optional parameters
-    # @return [ChunkMetadata]
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [ChunkReturnTypes]
     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.
+    # Get a singular chunk by id.
     # @param tr_dataset [String] The dataset id to use for the request
     # @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
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(ChunkReturnTypes, Integer, Hash)>] ChunkReturnTypes data, response status code and response headers
     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 ...'
@@ -424,6 +504,7 @@ module TrieveRubyClient
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -432,7 +513,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'ChunkMetadata'
+      return_type = opts[:debug_return_type] || 'ChunkReturnTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -455,22 +536,24 @@ module TrieveRubyClient
     end
 
     # Get Chunk By Tracking Id
-    # Get Chunk By Tracking Id  Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
+    # Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] tracking_id of the chunk you want to fetch
     # @param [Hash] opts the optional parameters
-    # @return [ChunkMetadata]
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [ChunkReturnTypes]
     def get_chunk_by_tracking_id(tr_dataset, tracking_id, opts = {})
       data, _status_code, _headers = get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts)
       data
     end
 
     # Get Chunk By Tracking Id
-    # Get Chunk By Tracking Id  Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
+    # Get a singular chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use your own id as the primary reference for a chunk.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param tracking_id [String] tracking_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
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(ChunkReturnTypes, Integer, Hash)>] ChunkReturnTypes data, response status code and response headers
     def get_chunk_by_tracking_id_with_http_info(tr_dataset, tracking_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunk_by_tracking_id ...'
@@ -494,6 +577,7 @@ module TrieveRubyClient
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -502,7 +586,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'ChunkMetadata'
+      return_type = opts[:debug_return_type] || 'ChunkReturnTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -525,22 +609,24 @@ module TrieveRubyClient
     end
 
     # Get Chunks By Ids
-    # Get Chunks By Ids  Get multiple chunks by multiple ids.
+    # Get multiple chunks by multiple ids.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
     # @param [Hash] opts the optional parameters
-    # @return [Array<ChunkMetadata>]
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<ChunkReturnTypes>]
     def get_chunks_by_ids(tr_dataset, get_chunks_data, opts = {})
       data, _status_code, _headers = get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts)
       data
     end
 
     # Get Chunks By Ids
-    # Get Chunks By Ids  Get multiple chunks by multiple ids.
+    # Get multiple chunks by multiple ids.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param get_chunks_data [GetChunksData] JSON request payload to get the chunks in the request
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<ChunkMetadata>, Integer, Hash)>] Array<ChunkMetadata> data, response status code and response headers
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(Array<ChunkReturnTypes>, Integer, Hash)>] Array<ChunkReturnTypes> data, response status code and response headers
     def get_chunks_by_ids_with_http_info(tr_dataset, get_chunks_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_ids ...'
@@ -569,6 +655,7 @@ module TrieveRubyClient
           header_params['Content-Type'] = content_type
       end
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -577,7 +664,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(get_chunks_data)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Array<ChunkMetadata>'
+      return_type = opts[:debug_return_type] || 'Array<ChunkReturnTypes>'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -599,23 +686,25 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
-    # Get Chunks By TrackingIds
-    # Get Chunks By TrackingIds  Get multiple chunks by ids.
+    # Get Chunks By Tracking Ids
+    # Get multiple chunks by ids.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
     # @param [Hash] opts the optional parameters
-    # @return [ChunkMetadata]
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<ChunkReturnTypes>]
     def get_chunks_by_tracking_ids(tr_dataset, get_tracking_chunks_data, opts = {})
       data, _status_code, _headers = get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts)
       data
     end
 
-    # Get Chunks By TrackingIds
-    # Get Chunks By TrackingIds  Get multiple chunks by ids.
+    # Get Chunks By Tracking Ids
+    # Get multiple chunks by ids.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param get_tracking_chunks_data [GetTrackingChunksData] JSON request payload to get the chunks in the request
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ChunkMetadata, Integer, Hash)>] ChunkMetadata data, response status code and response headers
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(Array<ChunkReturnTypes>, Integer, Hash)>] Array<ChunkReturnTypes> data, response status code and response headers
     def get_chunks_by_tracking_ids_with_http_info(tr_dataset, get_tracking_chunks_data, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.get_chunks_by_tracking_ids ...'
@@ -644,6 +733,7 @@ module TrieveRubyClient
           header_params['Content-Type'] = content_type
       end
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -652,7 +742,7 @@ module TrieveRubyClient
       post_body = opts[:debug_body] || @api_client.object_to_http_body(get_tracking_chunks_data)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'ChunkMetadata'
+      return_type = opts[:debug_return_type] || 'Array<ChunkReturnTypes>'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -675,22 +765,24 @@ module TrieveRubyClient
     end
 
     # Get Recommended Chunks
-    # Get Recommended Chunks  Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \"add to playlist\" recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
+    # Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
     # @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<ChunkMetadataWithScore>]
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [RecommendResponseTypes]
     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
     end
 
     # Get Recommended Chunks
-    # Get Recommended Chunks  Get recommendations of chunks similar to the chunks in the request. Think about this as a feature similar to the \&quot;add to playlist\&quot; recommendation feature on Spotify. This request pairs especially well with our groups endpoint.
+    # Get recommendations of chunks similar to the positive samples in the request and dissimilar to the negative. You must provide at least one of either positive_chunk_ids or positive_tracking_ids.
     # @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<ChunkMetadataWithScore>, Integer, Hash)>] Array<ChunkMetadataWithScore> data, response status code and response headers
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(RecommendResponseTypes, Integer, Hash)>] RecommendResponseTypes 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 ...'
@@ -719,6 +811,7 @@ module TrieveRubyClient
           header_params['Content-Type'] = content_type
       end
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
@@ -727,7 +820,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<ChunkMetadataWithScore>'
+      return_type = opts[:debug_return_type] || 'RecommendResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -749,24 +842,101 @@ module TrieveRubyClient
       return data, status_code, headers
     end
 
+    # Generate suggested queries
+    # This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param suggested_queries_req_payload [SuggestedQueriesReqPayload] JSON request payload to get alternative suggested queries
+    # @param [Hash] opts the optional parameters
+    # @return [SuggestedQueriesResponse]
+    def get_suggested_queries(tr_dataset, suggested_queries_req_payload, opts = {})
+      data, _status_code, _headers = get_suggested_queries_with_http_info(tr_dataset, suggested_queries_req_payload, opts)
+      data
+    end
+
+    # Generate suggested queries
+    # This endpoint will generate 3 suggested queries based off a hybrid search using RAG with the query provided in the request body and return them as a JSON object.
+    # @param tr_dataset [String] The dataset id to use for the request
+    # @param suggested_queries_req_payload [SuggestedQueriesReqPayload] JSON request payload to get alternative suggested queries
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuggestedQueriesResponse, Integer, Hash)>] SuggestedQueriesResponse data, response status code and response headers
+    def get_suggested_queries_with_http_info(tr_dataset, suggested_queries_req_payload, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChunkApi.get_suggested_queries ...'
+      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 ChunkApi.get_suggested_queries"
+      end
+      # verify the required parameter 'suggested_queries_req_payload' is set
+      if @api_client.config.client_side_validation && suggested_queries_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'suggested_queries_req_payload' when calling ChunkApi.get_suggested_queries"
+      end
+      # resource path
+      local_var_path = '/api/chunk/gen_suggestions'
+
+      # 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'])
+      # 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-Dataset'] = tr_dataset
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(suggested_queries_req_payload)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuggestedQueriesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKey']
+
+      new_options = opts.merge(
+        :operation => :"ChunkApi.get_suggested_queries",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ChunkApi#get_suggested_queries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Search
-    # Search  This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.
+    # This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results' `chunk_html` values will be modified with `<b><mark>` tags for sub-sentence highlighting.
     # @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 search_chunks_req_payload [SearchChunksReqPayload] JSON request payload to semantically search for chunks (chunks)
     # @param [Hash] opts the optional parameters
-    # @return [SearchChunkQueryResponseBody]
-    def search_chunks(tr_dataset, search_chunk_data, opts = {})
-      data, _status_code, _headers = search_chunks_with_http_info(tr_dataset, search_chunk_data, opts)
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [SearchResponseTypes]
+    def search_chunks(tr_dataset, search_chunks_req_payload, opts = {})
+      data, _status_code, _headers = search_chunks_with_http_info(tr_dataset, search_chunks_req_payload, opts)
       data
     end
 
     # Search
-    # Search  This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&lt;mark&gt;&#x60; tags for sub-sentence highlighting.
+    # This route provides the primary search functionality for the API. It can be used to search for chunks by semantic similarity, full-text similarity, or a combination of both. Results&#39; &#x60;chunk_html&#x60; values will be modified with &#x60;&lt;b&gt;&lt;mark&gt;&#x60; tags for sub-sentence highlighting.
     # @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 search_chunks_req_payload [SearchChunksReqPayload] 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
-    def search_chunks_with_http_info(tr_dataset, search_chunk_data, opts = {})
+    # @option opts [APIVersion] :x_api_version The API version to use for this request. Defaults to V2 for orgs created after July 12, 2024 and V1 otherwise.
+    # @return [Array<(SearchResponseTypes, Integer, Hash)>] SearchResponseTypes data, response status code and response headers
+    def search_chunks_with_http_info(tr_dataset, search_chunks_req_payload, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.search_chunks ...'
       end
@@ -774,9 +944,9 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.search_chunks"
       end
-      # verify the required parameter 'search_chunk_data' is set
-      if @api_client.config.client_side_validation && search_chunk_data.nil?
-        fail ArgumentError, "Missing the required parameter 'search_chunk_data' when calling ChunkApi.search_chunks"
+      # verify the required parameter 'search_chunks_req_payload' is set
+      if @api_client.config.client_side_validation && search_chunks_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'search_chunks_req_payload' when calling ChunkApi.search_chunks"
       end
       # resource path
       local_var_path = '/api/chunk/search'
@@ -794,15 +964,16 @@ module TrieveRubyClient
           header_params['Content-Type'] = content_type
       end
       header_params[:'TR-Dataset'] = tr_dataset
+      header_params[:'X-API-Version'] = opts[:'x_api_version'] if !opts[:'x_api_version'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_chunk_data)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(search_chunks_req_payload)
 
       # return_type
-      return_type = opts[:debug_return_type] || 'SearchChunkQueryResponseBody'
+      return_type = opts[:debug_return_type] || 'SearchResponseTypes'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKey']
@@ -825,23 +996,23 @@ module TrieveRubyClient
     end
 
     # Update Chunk
-    # Update Chunk  Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
+    # Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param update_chunk_data [UpdateChunkData] JSON request payload to update a chunk (chunk)
+    # @param update_chunk_req_payload [UpdateChunkReqPayload] JSON request payload to update a chunk (chunk)
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def update_chunk(tr_dataset, update_chunk_data, opts = {})
-      update_chunk_with_http_info(tr_dataset, update_chunk_data, opts)
+    def update_chunk(tr_dataset, update_chunk_req_payload, opts = {})
+      update_chunk_with_http_info(tr_dataset, update_chunk_req_payload, opts)
       nil
     end
 
     # Update Chunk
-    # Update Chunk  Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail.
+    # Update a chunk. If you try to change the tracking_id of the chunk to have the same tracking_id as an existing chunk, the request will fail. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
-    # @param update_chunk_data [UpdateChunkData] JSON request payload to update a chunk (chunk)
+    # @param update_chunk_req_payload [UpdateChunkReqPayload] JSON request payload to update a chunk (chunk)
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def update_chunk_with_http_info(tr_dataset, update_chunk_data, opts = {})
+    def update_chunk_with_http_info(tr_dataset, update_chunk_req_payload, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ChunkApi.update_chunk ...'
       end
@@ -849,9 +1020,9 @@ module TrieveRubyClient
       if @api_client.config.client_side_validation && tr_dataset.nil?
         fail ArgumentError, "Missing the required parameter 'tr_dataset' when calling ChunkApi.update_chunk"
       end
-      # verify the required parameter 'update_chunk_data' is set
-      if @api_client.config.client_side_validation && update_chunk_data.nil?
-        fail ArgumentError, "Missing the required parameter 'update_chunk_data' when calling ChunkApi.update_chunk"
+      # verify the required parameter 'update_chunk_req_payload' is set
+      if @api_client.config.client_side_validation && update_chunk_req_payload.nil?
+        fail ArgumentError, "Missing the required parameter 'update_chunk_req_payload' when calling ChunkApi.update_chunk"
       end
       # resource path
       local_var_path = '/api/chunk'
@@ -874,7 +1045,7 @@ module TrieveRubyClient
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_chunk_data)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(update_chunk_req_payload)
 
       # return_type
       return_type = opts[:debug_return_type]
@@ -900,7 +1071,7 @@ module TrieveRubyClient
     end
 
     # Update Chunk By Tracking Id
-    # Update Chunk By Tracking Id  Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
+    # Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth'ed user or api key must have an admin or owner role for the specified dataset's organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param update_chunk_by_tracking_id_data [UpdateChunkByTrackingIdData] JSON request payload to update a chunk by tracking_id (chunks)
     # @param [Hash] opts the optional parameters
@@ -911,7 +1082,7 @@ module TrieveRubyClient
     end
 
     # Update Chunk By Tracking Id
-    # Update Chunk By Tracking Id  Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk.
+    # Update a chunk by tracking_id. This is useful for when you are coordinating with an external system and want to use the tracking_id to identify the chunk. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.
     # @param tr_dataset [String] The dataset id to use for the request
     # @param update_chunk_by_tracking_id_data [UpdateChunkByTrackingIdData] JSON request payload to update a chunk by tracking_id (chunks)
     # @param [Hash] opts the optional parameters