algolia 3.0.0.beta.12 → 3.0.0.beta.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc3e5a8f05ae1aec49daf5a6d57ce82012c9f0bd8d97491f80af9de068c77b4d
-  data.tar.gz: 20de9175b058d3f5b46d0a3d675ab8bc0902db0e94fffafcbf4992a2740ea91b
+  metadata.gz: 77b4c1bf1ec0ae78a66401213ff5ad43cbe5af1eb876e3f869954e7970f9e2d7
+  data.tar.gz: 30161fea26f09f5a8651297ad0d785231ca8477c09cb6bd948ff4c66fa9f72eb
 SHA512:
-  metadata.gz: 507dc3326da3951a9a4c7ef68514ef8e65d42b90f8a7824a783187e5309e694bb163e1fcc151f4e270a434c84ad965ec318f993ec924b454fff54d88a6c7c4ff
-  data.tar.gz: 1f77a1c75b00f255bed2a80759af9a5870618e372e3c9484a519c7f196f7e21a69b717a0fd8ac79dfd641434aa712a9d77d303f886fcc1bb2a841f2d4925329b
+  metadata.gz: e61a29d8f4887039452dac0d97c7e1c307665f1162d6065e3ba15617130ddee08af68a0d7bc8cc87c726aaa42cddaebcb117c1e8e4e52c4272cfa190e73235a3
+  data.tar.gz: fab57401cf66f5871fd0298cea6248880097e9b85c7d4aa8fb7ddbfa733fb206547ffe27f2eb7c1d37382ee4f748295a0d2fda5e5a5510f08d85409065e6fddb

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## [3.0.0.beta.14](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.13...3.0.0.beta.14)
+
+- [2c6147ee7](https://github.com/algolia/api-clients-automation/commit/2c6147ee7) feat(specs): add generate code endpoint to ingestion specs ([#3489](https://github.com/algolia/api-clients-automation/pull/3489)) by [@shortcuts](https://github.com/shortcuts/)
+- [6c62a81a7](https://github.com/algolia/api-clients-automation/commit/6c62a81a7) fix(specs): ingestion docker task input ([#3488](https://github.com/algolia/api-clients-automation/pull/3488)) by [@shortcuts](https://github.com/shortcuts/)
+- [eab2887f8](https://github.com/algolia/api-clients-automation/commit/eab2887f8) fix(specs): ingestion search endpoint ([#3487](https://github.com/algolia/api-clients-automation/pull/3487)) by [@shortcuts](https://github.com/shortcuts/)
+
+## [3.0.0.beta.13](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.12...3.0.0.beta.13)
+
+- [ac0cadb8a](https://github.com/algolia/api-clients-automation/commit/ac0cadb8a) feat(specs): add transformation copilot to ingestion ([#3479](https://github.com/algolia/api-clients-automation/pull/3479)) by [@Fluf22](https://github.com/Fluf22/)
+- [08a04dec8](https://github.com/algolia/api-clients-automation/commit/08a04dec8) fix(specs): ingestion destination reject indexPrefix ([#3478](https://github.com/algolia/api-clients-automation/pull/3478)) by [@shortcuts](https://github.com/shortcuts/)
+- [cdd673d33](https://github.com/algolia/api-clients-automation/commit/cdd673d33) fix(specs): ingestion destinations and transformations ([#3477](https://github.com/algolia/api-clients-automation/pull/3477)) by [@shortcuts](https://github.com/shortcuts/)
+- [b4742be76](https://github.com/algolia/api-clients-automation/commit/b4742be76) fix(clients): move the license to the root ([#3457](https://github.com/algolia/api-clients-automation/pull/3457)) by [@millotp](https://github.com/millotp/)
+- [e5d14171c](https://github.com/algolia/api-clients-automation/commit/e5d14171c) fix(specs): dictionary entry for stopwords has type property ([#3456](https://github.com/algolia/api-clients-automation/pull/3456)) by [@kai687](https://github.com/kai687/)
+- [7af1e75e9](https://github.com/algolia/api-clients-automation/commit/7af1e75e9) fix(specs): body is not required in multiple batch request ([#3454](https://github.com/algolia/api-clients-automation/pull/3454)) by [@kai687](https://github.com/kai687/)
+- [b90bef261](https://github.com/algolia/api-clients-automation/commit/b90bef261) feat(specs): add runSource endpoint ([#3453](https://github.com/algolia/api-clients-automation/pull/3453)) by [@millotp](https://github.com/millotp/)
+- [27679b7fd](https://github.com/algolia/api-clients-automation/commit/27679b7fd) chore(clients): remove mention of GA ([#3452](https://github.com/algolia/api-clients-automation/pull/3452)) by [@millotp](https://github.com/millotp/)
+
 ## [3.0.0.beta.12](https://github.com/algolia/algoliasearch-client-ruby/compare/3.0.0.beta.11...3.0.0.beta.12)
 
 - [e982ddf0a](https://github.com/algolia/api-clients-automation/commit/e982ddf0a) fix(specs): built-in ops accept also int ([#3450](https://github.com/algolia/api-clients-automation/pull/3450)) by [@kai687](https://github.com/kai687/)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.0.0.beta.12)
+    algolia (3.0.0.beta.14)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)

data/lib/algolia/api/ingestion_client.rb

@@ -953,6 +953,60 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TaskUpdateResponse")
     end
 
+    # Generates code for the selected model based on the given prompt.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param generate_transformation_code_payload [GenerateTransformationCodePayload]  (required)
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def generate_transformation_code_with_http_info(generate_transformation_code_payload, request_options = {})
+      # verify the required parameter 'generate_transformation_code_payload' is set
+      if @api_client.config.client_side_validation && generate_transformation_code_payload.nil?
+        raise(
+          ArgumentError,
+          "Parameter `generate_transformation_code_payload` is required when calling `generate_transformation_code`."
+        )
+      end
+
+      path = "/1/transformations/models"
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(generate_transformation_code_payload)
+
+      new_options = request_options.merge(
+        :operation => :"IngestionClient.generate_transformation_code",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Generates code for the selected model based on the given prompt.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param generate_transformation_code_payload [GenerateTransformationCodePayload]  (required)
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [GenerateTransformationCodeResponse]
+    def generate_transformation_code(generate_transformation_code_payload, request_options = {})
+      response = generate_transformation_code_with_http_info(generate_transformation_code_payload, request_options)
+      @api_client.deserialize(
+        response.body,
+        request_options[:debug_return_type] || "Ingestion::GenerateTransformationCodeResponse"
+      )
+    end
+
     # Retrieves an authentication resource by its ID.
     #
     # Required API Key ACLs:
@@ -2163,19 +2217,91 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::ListTasksResponseV1")
     end
 
+    # Retrieves a list of existing LLM transformation helpers.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def list_transformation_models_with_http_info(request_options = {})
+      path = "/1/transformations/models"
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body]
+
+      new_options = request_options.merge(
+        :operation => :"IngestionClient.list_transformation_models",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:GET, path, new_options)
+    end
+
+    # Retrieves a list of existing LLM transformation helpers.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [TransformationModels]
+    def list_transformation_models(request_options = {})
+      response = list_transformation_models_with_http_info(request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::TransformationModels")
+    end
+
     # Retrieves a list of transformations.
     #
     # Required API Key ACLs:
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # @param items_per_page [Integer] Number of items per page. (default to 10)
+    # @param page [Integer] Page number of the paginated API response.
     # @param sort [SortKeys] Property by which to sort the list. (default to 'desc')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def list_transformations_with_http_info(sort = nil, order = nil, request_options = {})
+    def list_transformations_with_http_info(
+      items_per_page = nil,
+      page = nil,
+      sort = nil,
+      order = nil,
+      request_options = {}
+    )
+      if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page > 100
+        raise(
+          ArgumentError,
+          "invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_transformations, must be smaller than or equal to 100."
+        )
+      end
+
+      if @api_client.config.client_side_validation && !items_per_page.nil? && items_per_page < 1
+        raise(
+          ArgumentError,
+          "invalid value for \"\"items_per_page\"\" when calling IngestionClient.list_transformations, must be greater than or equal to 1."
+        )
+      end
+
+      if @api_client.config.client_side_validation && !page.nil? && page < 1
+        raise(
+          ArgumentError,
+          "invalid value for \"\"page\"\" when calling IngestionClient.list_transformations, must be greater than or equal to 1."
+        )
+      end
+
       path = "/1/transformations"
       query_params = {}
+      query_params[:itemsPerPage] = items_per_page unless items_per_page.nil?
+      query_params[:page] = page unless page.nil?
       query_params[:sort] = sort unless sort.nil?
       query_params[:order] = order unless order.nil?
       query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
@@ -2201,12 +2327,14 @@ module Algolia
     #   - addObject
     #   - deleteIndex
     #   - editSettings
+    # @param items_per_page [Integer] Number of items per page. (default to 10)
+    # @param page [Integer] Page number of the paginated API response.
     # @param sort [SortKeys] Property by which to sort the list. (default to 'desc')
     # @param order [OrderKeys] Sort order of the response, ascending or descending. (default to 'desc')
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [ListTransformationsResponse]
-    def list_transformations(sort = nil, order = nil, request_options = {})
-      response = list_transformations_with_http_info(sort, order, request_options)
+    def list_transformations(items_per_page = nil, page = nil, sort = nil, order = nil, request_options = {})
+      response = list_transformations_with_http_info(items_per_page, page, sort, order, request_options)
       @api_client.deserialize(
         response.body,
         request_options[:debug_return_type] || "Ingestion::ListTransformationsResponse"
@@ -2267,6 +2395,56 @@ module Algolia
       @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse")
     end
 
+    # Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param source_id [String] Unique identifier of a source. (required)
+    # @param run_source_payload [RunSourcePayload]
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [Http::Response] the response
+    def run_source_with_http_info(source_id, run_source_payload = nil, request_options = {})
+      # verify the required parameter 'source_id' is set
+      if @api_client.config.client_side_validation && source_id.nil?
+        raise ArgumentError, "Parameter `source_id` is required when calling `run_source`."
+      end
+
+      path = "/1/sources/{sourceID}/run".sub("{" + "sourceID" + "}", Transport.encode_uri(source_id.to_s))
+      query_params = {}
+      query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil?
+      header_params = {}
+      header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil?
+
+      post_body = request_options[:debug_body] || @api_client.object_to_http_body(run_source_payload)
+
+      new_options = request_options.merge(
+        :operation => :"IngestionClient.run_source",
+        :header_params => header_params,
+        :query_params => query_params,
+        :body => post_body,
+        :use_read_transporter => false
+      )
+
+      @api_client.call_api(:POST, path, new_options)
+    end
+
+    # Runs all tasks linked to a source, only available for Shopify sources. It will create 1 run per task.
+    #
+    # Required API Key ACLs:
+    #   - addObject
+    #   - deleteIndex
+    #   - editSettings
+    # @param source_id [String] Unique identifier of a source. (required)
+    # @param run_source_payload [RunSourcePayload]
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    # @return [RunSourceResponse]
+    def run_source(source_id, run_source_payload = nil, request_options = {})
+      response = run_source_with_http_info(source_id, run_source_payload, request_options)
+      @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunSourceResponse")
+    end
+
     # Runs a task. You can check the status of task runs with the observability endpoints.
     #
     # Required API Key ACLs:
@@ -2708,10 +2886,10 @@ module Algolia
     # @param transformation_try [TransformationTry]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [Http::Response] the response
-    def try_transformations_with_http_info(transformation_try, request_options = {})
+    def try_transformation_with_http_info(transformation_try, request_options = {})
       # verify the required parameter 'transformation_try' is set
       if @api_client.config.client_side_validation && transformation_try.nil?
-        raise ArgumentError, "Parameter `transformation_try` is required when calling `try_transformations`."
+        raise ArgumentError, "Parameter `transformation_try` is required when calling `try_transformation`."
       end
 
       path = "/1/transformations/try"
@@ -2723,7 +2901,7 @@ module Algolia
       post_body = request_options[:debug_body] || @api_client.object_to_http_body(transformation_try)
 
       new_options = request_options.merge(
-        :operation => :"IngestionClient.try_transformations",
+        :operation => :"IngestionClient.try_transformation",
         :header_params => header_params,
         :query_params => query_params,
         :body => post_body,
@@ -2742,8 +2920,8 @@ module Algolia
     # @param transformation_try [TransformationTry]  (required)
     # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
     # @return [TransformationTryResponse]
-    def try_transformations(transformation_try, request_options = {})
-      response = try_transformations_with_http_info(transformation_try, request_options)
+    def try_transformation(transformation_try, request_options = {})
+      response = try_transformation_with_http_info(transformation_try, request_options)
       @api_client.deserialize(
         response.body,
         request_options[:debug_return_type] || "Ingestion::TransformationTryResponse"

data/lib/algolia/models/ingestion/destination.rb

@@ -26,6 +26,8 @@ module Algolia
       # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
+      attr_accessor :transformation_ids
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -57,7 +59,8 @@ module Algolia
           :input => :input,
           :created_at => :createdAt,
           :updated_at => :updatedAt,
-          :authentication_id => :authenticationID
+          :authentication_id => :authenticationID,
+          :transformation_ids => :transformationIDs
         }
       end
 
@@ -75,7 +78,8 @@ module Algolia
           :input => :"DestinationInput",
           :created_at => :"String",
           :updated_at => :"String",
-          :authentication_id => :"String"
+          :authentication_id => :"String",
+          :transformation_ids => :"Array<String>"
         }
       end
 
@@ -146,6 +150,12 @@ module Algolia
         if attributes.key?(:authentication_id)
           self.authentication_id = attributes[:authentication_id]
         end
+
+        if attributes.key?(:transformation_ids)
+          if (value = attributes[:transformation_ids]).is_a?(Array)
+            self.transformation_ids = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -159,7 +169,8 @@ module Algolia
           input == other.input &&
           created_at == other.created_at &&
           updated_at == other.updated_at &&
-          authentication_id == other.authentication_id
+          authentication_id == other.authentication_id &&
+          transformation_ids == other.transformation_ids
       end
 
       # @see the `==` method
@@ -171,7 +182,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [destination_id, type, name, input, created_at, updated_at, authentication_id].hash
+        [destination_id, type, name, input, created_at, updated_at, authentication_id, transformation_ids].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/destination_create.rb

@@ -17,6 +17,8 @@ module Algolia
       # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
+      attr_accessor :transformation_ids
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -45,7 +47,8 @@ module Algolia
           :type => :type,
           :name => :name,
           :input => :input,
-          :authentication_id => :authenticationID
+          :authentication_id => :authenticationID,
+          :transformation_ids => :transformationIDs
         }
       end
 
@@ -60,7 +63,8 @@ module Algolia
           :type => :"DestinationType",
           :name => :"String",
           :input => :"DestinationInput",
-          :authentication_id => :"String"
+          :authentication_id => :"String",
+          :transformation_ids => :"Array<String>"
         }
       end
 
@@ -115,6 +119,12 @@ module Algolia
         if attributes.key?(:authentication_id)
           self.authentication_id = attributes[:authentication_id]
         end
+
+        if attributes.key?(:transformation_ids)
+          if (value = attributes[:transformation_ids]).is_a?(Array)
+            self.transformation_ids = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -125,7 +135,8 @@ module Algolia
           type == other.type &&
           name == other.name &&
           input == other.input &&
-          authentication_id == other.authentication_id
+          authentication_id == other.authentication_id &&
+          transformation_ids == other.transformation_ids
       end
 
       # @see the `==` method
@@ -137,7 +148,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [type, name, input, authentication_id].hash
+        [type, name, input, authentication_id, transformation_ids].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/destination_input.rb

@@ -10,8 +10,7 @@ module Algolia
       # List of class defined in oneOf (OpenAPI v3)
         def openapi_one_of
           [
-            :"DestinationIndexName",
-            :"DestinationIndexPrefix"
+            :"DestinationIndexName"
           ]
         end
 

data/lib/algolia/models/ingestion/destination_update.rb

@@ -17,6 +17,8 @@ module Algolia
       # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
+      attr_accessor :transformation_ids
+
       class EnumAttributeValidator
         attr_reader :datatype
         attr_reader :allowable_values
@@ -45,7 +47,8 @@ module Algolia
           :type => :type,
           :name => :name,
           :input => :input,
-          :authentication_id => :authenticationID
+          :authentication_id => :authenticationID,
+          :transformation_ids => :transformationIDs
         }
       end
 
@@ -60,7 +63,8 @@ module Algolia
           :type => :"DestinationType",
           :name => :"String",
           :input => :"DestinationInput",
-          :authentication_id => :"String"
+          :authentication_id => :"String",
+          :transformation_ids => :"Array<String>"
         }
       end
 
@@ -109,6 +113,12 @@ module Algolia
         if attributes.key?(:authentication_id)
           self.authentication_id = attributes[:authentication_id]
         end
+
+        if attributes.key?(:transformation_ids)
+          if (value = attributes[:transformation_ids]).is_a?(Array)
+            self.transformation_ids = value
+          end
+        end
       end
 
       # Checks equality by comparing each attribute.
@@ -119,7 +129,8 @@ module Algolia
           type == other.type &&
           name == other.name &&
           input == other.input &&
-          authentication_id == other.authentication_id
+          authentication_id == other.authentication_id &&
+          transformation_ids == other.transformation_ids
       end
 
       # @see the `==` method
@@ -131,7 +142,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [type, name, input, authentication_id].hash
+        [type, name, input, authentication_id, transformation_ids].hash
       end
 
       # Builds the object from hash