RubyGems - algolia - Versions diffs - 3.42.1 → 3.42.3 - Mend

algolia 3.42.1 → 3.42.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

checksums.yaml +4 -4
data/.github/workflows/do-not-edit-this-repository.yml +1 -1
data/.github/workflows/release.yml +2 -2
data/CHANGELOG.md +11 -0
data/Gemfile.lock +4 -4
data/lib/algolia/api/search_client.rb +16 -0
data/lib/algolia/api_client.rb +4 -0
data/lib/algolia/models/recommend/fallback_params.rb +18 -50
data/lib/algolia/models/recommend/recommend_search_params.rb +15 -49
data/lib/algolia/version.rb +1 -1
metadata +1 -1

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 729180bdf507d689e427b58776c291cd09ebb4b65c884a958f62d69f632b9aa1
-  data.tar.gz: 498b53a162a0a51693a67158f0c7f14b428f372aaf60ded0708886715dffd990
+  metadata.gz: c7ee727296f4ef0f5097f1e9a17f8b76e0a2e04303aeaaa1b84a78a8cc3e899e
+  data.tar.gz: 340f56004e8c495e8585bf43dc0b5a8cf36208c69b239b3d029e7b6b9428e8b7
 SHA512:
-  metadata.gz: a6ac87e73287d64f32f8a1d68b89261ff1a3f0dadf54c72455514c8aa076b6cb3906704bb6dba9c427c79747f3f3383fcc74dbb105727d972c2db4b95680625b
-  data.tar.gz: 3530b95cbf052c9bc5602bd83a0ed5f28523abe30978eedff8273e2a512da3b00e2c81e2b5a2c80583bcdcbc08bf575cb5c5900f307b2a40ba5029238f8f2c30
+  metadata.gz: 0c50e49997bdfb4101478f6800ce76397c73d51e7755a1c7c425e6c6565d7c4435c04d792707fbee1c1cc3efc7a7cc8ef2fea740312d579651338c4cac953563
+  data.tar.gz: 2d38395ca0ec5f708b0ba6a3210ff2c60d988829aac5cf80b8de2e767f408722932c899e86902555df17d064569612d9bf86ed5f115f9ee4f6bdff3c1b8a6821

data/.github/workflows/do-not-edit-this-repository.yml CHANGED Viewed

@@ -14,7 +14,7 @@ jobs:
     name: Close PR
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: Close PR
         env:

data/.github/workflows/release.yml CHANGED Viewed

@@ -16,12 +16,12 @@ jobs:
       id-token: write
       contents: write
     steps:
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 4.0.4
+          ruby-version: 4.0.5
           bundler-cache: true
       - uses: rubygems/release-gem@e9a6361a0b14562539327c2a02373edc56dd3169

data/CHANGELOG.md CHANGED Viewed

@@ -1,3 +1,14 @@
+## [3.42.3](https://github.com/algolia/algoliasearch-client-ruby/compare/3.42.2...3.42.3)
+- [772f7055cc](https://github.com/algolia/api-clients-automation/commit/772f7055cc) fix(clients): add warning in replace_all_objects for empty objects ([#6610](https://github.com/algolia/api-clients-automation/pull/6610)) by [@eric-zaharia](https://github.com/eric-zaharia/)
+- [ac68c1a79c](https://github.com/algolia/api-clients-automation/commit/ac68c1a79c) fix(specs): add facetFilters back to recommend fallbackParameters ([#6727](https://github.com/algolia/api-clients-automation/pull/6727)) by [@raed667](https://github.com/raed667/)
+## [3.42.2](https://github.com/algolia/algoliasearch-client-ruby/compare/3.42.1...3.42.2)
+- [035c03ecad](https://github.com/algolia/api-clients-automation/commit/035c03ecad) fix(specs): BREAKING CHANGE – remove recommend query params overridden by the API ([#6604](https://github.com/algolia/api-clients-automation/pull/6604)) by [@raed667](https://github.com/raed667/)
+  - The `ranking`, `facetFilters`, and `enableABTest` parameters have been removed from the Recommend request, and `enableRules` from its fallback parameters, as the Recommend API ignores them. API behavior is unchanged, but code setting these fields must be updated.
+- [5031c65633](https://github.com/algolia/api-clients-automation/commit/5031c65633) chore(deps): dependencies 2026-06-15 ([#6508](https://github.com/algolia/api-clients-automation/pull/6508)) by [@algolia-api-clients-automation-bot[bot]](https://github.com/apps/algolia-api-clients-automation-bot)
 ## [3.42.1](https://github.com/algolia/algoliasearch-client-ruby/compare/3.42.0...3.42.1)
 - [a676cd9cef](https://github.com/algolia/api-clients-automation/commit/a676cd9cef) fix(clients): bump replaceAllObjects default maxRetries from 100 to 800 ([#6580](https://github.com/algolia/api-clients-automation/pull/6580)) by [@Fluf22](https://github.com/Fluf22/)

data/Gemfile.lock CHANGED Viewed

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    algolia (3.42.1)
+    algolia (3.42.3)
       base64 (>= 0.2.0, < 1)
       faraday (>= 1.0.1, < 3.0)
       faraday-net_http_persistent (>= 0.15, < 3)
@@ -12,16 +12,16 @@ GEM
   specs:
     base64 (0.3.0)
     connection_pool (2.5.4)
-    faraday (2.14.2)
+    faraday (2.14.3)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
-    faraday-net_http (3.4.3)
+    faraday-net_http (3.4.4)
       net-http (~> 0.5)
     faraday-net_http_persistent (2.3.1)
       faraday (~> 2.5)
       net-http-persistent (>= 4.0.4, < 5)
-    json (2.19.7)
+    json (2.20.0)
     logger (1.7.0)
     net-http (0.9.1)
       uri (>= 0.11.1)

data/lib/algolia/api/search_client.rb CHANGED Viewed

@@ -3542,6 +3542,8 @@ module Algolia
     # in order to transform records before indexing them to Algolia.
     # `set_transformation_options` must have been called, or the client created via `SearchClient.with_transformation`.
     #
+    # Warning: Calling this method with an empty `objects` array will delete all records currently in the given `index_name`.
+    #
     # @param index_name [String] the `index_name` to replace objects in. (required)
     # @param objects [Array] the array of objects to store in the given Algolia `index_name`. (required)
     # @param batch_size [Integer] the size of each chunk of objects sent in a single push call. (optional, default: 1000)
@@ -3559,6 +3561,12 @@ module Algolia
     )
       assert_ingestion_transporter!
+      if objects.empty?
+        @api_client.logger.warn(
+          "replace_all_objects_with_transformation was called with an empty list of objects, which will delete all records currently in the \"#{index_name}\" index."
+        )
+      end
       opts = Algolia::ChunkedHelperOptions.resolve(
         chunked_options,
         default_max_retries: Algolia::ChunkedHelperOptions::DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES
@@ -4049,6 +4057,8 @@ module Algolia
     # Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
     #
+    # Warning: Calling this method with an empty `objects` array will delete all records currently in the given `index_name`.
+    #
     # @param index_name [String] The `index_name` to replace `objects` in.
     # @param objects [Array] The array of `objects` to store in the given Algolia `index_name`.
     # @param batch_size [int] The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
@@ -4064,6 +4074,12 @@ module Algolia
       request_options = {},
       chunked_options = nil
     )
+      if objects.empty?
+        @api_client.logger.warn(
+          "replace_all_objects was called with an empty list of objects, which will delete all records currently in the \"#{index_name}\" index."
+        )
+      end
       opts = Algolia::ChunkedHelperOptions.resolve(
         chunked_options,
         default_max_retries: Algolia::ChunkedHelperOptions::DEFAULT_REPLACE_ALL_OBJECTS_MAX_RETRIES

data/lib/algolia/api_client.rb CHANGED Viewed

@@ -8,11 +8,15 @@ module Algolia
     attr_accessor :transporter
+    # The logger, shared with the requester when it provides one.
+    attr_reader :logger
     # Initializes the ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
       @requester = config.requester || Http::HttpRequester.new("net_http_persistent", LoggerHelper.create)
+      @logger = (@requester.logger if @requester.respond_to?(:logger)) || LoggerHelper.create
       @transporter = Transport::Transport.new(config, @requester)
     end

data/lib/algolia/models/recommend/fallback_params.rb CHANGED Viewed

@@ -7,6 +7,7 @@ require "time"
 module Algolia
   module Recommend
+    # Search parameters to use for a fallback request if there aren't enough recommendations.
     class FallbackParams
       # Keywords to be used instead of the search query to conduct a more broader search Using the `similarQuery` parameter changes other settings - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords` Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
       attr_accessor :similar_query
@@ -14,8 +15,6 @@ module Algolia
       # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
       attr_accessor :filters
-      attr_accessor :facet_filters
       attr_accessor :optional_filters
       attr_accessor :numeric_filters
@@ -82,9 +81,6 @@ module Algolia
       # Whether to include this search when calculating processing-time percentiles.
       attr_accessor :percentile_computation
-      # Whether to enable A/B testing for this search.
-      attr_accessor :enable_ab_test
       # Search query.
       attr_accessor :query
@@ -151,9 +147,6 @@ module Algolia
       # Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
       attr_accessor :attributes_to_retrieve
-      # Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
-      attr_accessor :ranking
       # Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
       attr_accessor :relevancy_strictness
@@ -199,9 +192,6 @@ module Algolia
       # Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
       attr_accessor :decompound_query
-      # Whether to enable rules.
-      attr_accessor :enable_rules
       # Whether to enable Personalization.
       attr_accessor :enable_personalization
@@ -252,12 +242,13 @@ module Algolia
       attr_accessor :re_ranking_apply_filter
+      attr_accessor :facet_filters
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :similar_query => :similarQuery,
           :filters => :filters,
-          :facet_filters => :facetFilters,
           :optional_filters => :optionalFilters,
           :numeric_filters => :numericFilters,
           :tag_filters => :tagFilters,
@@ -282,7 +273,6 @@ module Algolia
           :analytics => :analytics,
           :analytics_tags => :analyticsTags,
           :percentile_computation => :percentileComputation,
-          :enable_ab_test => :enableABTest,
           :query => :query,
           :attributes_for_faceting => :attributesForFaceting,
           :replicas => :replicas,
@@ -305,7 +295,6 @@ module Algolia
           :keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
           :custom_ranking => :customRanking,
           :attributes_to_retrieve => :attributesToRetrieve,
-          :ranking => :ranking,
           :relevancy_strictness => :relevancyStrictness,
           :attributes_to_highlight => :attributesToHighlight,
           :attributes_to_snippet => :attributesToSnippet,
@@ -322,7 +311,6 @@ module Algolia
           :remove_stop_words => :removeStopWords,
           :query_languages => :queryLanguages,
           :decompound_query => :decompoundQuery,
-          :enable_rules => :enableRules,
           :enable_personalization => :enablePersonalization,
           :query_type => :queryType,
           :remove_words_if_no_results => :removeWordsIfNoResults,
@@ -341,7 +329,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
           :rendering_content => :renderingContent,
           :enable_re_ranking => :enableReRanking,
-          :re_ranking_apply_filter => :reRankingApplyFilter
+          :re_ranking_apply_filter => :reRankingApplyFilter,
+          :facet_filters => :facetFilters
         }
       end
@@ -350,7 +339,6 @@ module Algolia
         {
           :similar_query => :"String",
           :filters => :"String",
-          :facet_filters => :"FacetFilters",
           :optional_filters => :"OptionalFilters",
           :numeric_filters => :"NumericFilters",
           :tag_filters => :"TagFilters",
@@ -375,7 +363,6 @@ module Algolia
           :analytics => :"Boolean",
           :analytics_tags => :"Array<String>",
           :percentile_computation => :"Boolean",
-          :enable_ab_test => :"Boolean",
           :query => :"String",
           :attributes_for_faceting => :"Array<String>",
           :replicas => :"Array<String>",
@@ -398,7 +385,6 @@ module Algolia
           :keep_diacritics_on_characters => :"String",
           :custom_ranking => :"Array<String>",
           :attributes_to_retrieve => :"Array<String>",
-          :ranking => :"Array<String>",
           :relevancy_strictness => :"Integer",
           :attributes_to_highlight => :"Array<String>",
           :attributes_to_snippet => :"Array<String>",
@@ -415,7 +401,6 @@ module Algolia
           :remove_stop_words => :"RemoveStopWords",
           :query_languages => :"Array<SupportedLanguage>",
           :decompound_query => :"Boolean",
-          :enable_rules => :"Boolean",
           :enable_personalization => :"Boolean",
           :query_type => :"QueryType",
           :remove_words_if_no_results => :"RemoveWordsIfNoResults",
@@ -434,7 +419,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
           :rendering_content => :"RenderingContent",
           :enable_re_ranking => :"Boolean",
-          :re_ranking_apply_filter => :"ReRankingApplyFilter"
+          :re_ranking_apply_filter => :"ReRankingApplyFilter",
+          :facet_filters => :"FacetFilters"
         }
       end
@@ -453,7 +439,9 @@ module Algolia
       # List of class defined in allOf (OpenAPI v3)
       def self.openapi_all_of
         [
-          :"RecommendSearchParams"
+          :"BaseRecommendSearchParams",
+          :"RecommendIndexSettings",
+          :"SearchParamsQuery"
         ]
       end
@@ -488,10 +476,6 @@ module Algolia
           self.filters = attributes[:filters]
         end
-        if attributes.key?(:facet_filters)
-          self.facet_filters = attributes[:facet_filters]
-        end
         if attributes.key?(:optional_filters)
           self.optional_filters = attributes[:optional_filters]
         end
@@ -600,10 +584,6 @@ module Algolia
           self.percentile_computation = attributes[:percentile_computation]
         end
-        if attributes.key?(:enable_ab_test)
-          self.enable_ab_test = attributes[:enable_ab_test]
-        end
         if attributes.key?(:query)
           self.query = attributes[:query]
         end
@@ -718,12 +698,6 @@ module Algolia
           end
         end
-        if attributes.key?(:ranking)
-          if (value = attributes[:ranking]).is_a?(Array)
-            self.ranking = value
-          end
-        end
         if attributes.key?(:relevancy_strictness)
           self.relevancy_strictness = attributes[:relevancy_strictness]
         end
@@ -796,10 +770,6 @@ module Algolia
           self.decompound_query = attributes[:decompound_query]
         end
-        if attributes.key?(:enable_rules)
-          self.enable_rules = attributes[:enable_rules]
-        end
         if attributes.key?(:enable_personalization)
           self.enable_personalization = attributes[:enable_personalization]
         end
@@ -883,6 +853,10 @@ module Algolia
         if attributes.key?(:re_ranking_apply_filter)
           self.re_ranking_apply_filter = attributes[:re_ranking_apply_filter]
         end
+        if attributes.key?(:facet_filters)
+          self.facet_filters = attributes[:facet_filters]
+        end
       end
       # Checks equality by comparing each attribute.
@@ -892,7 +866,6 @@ module Algolia
         self.class == other.class &&
           similar_query == other.similar_query &&
           filters == other.filters &&
-          facet_filters == other.facet_filters &&
           optional_filters == other.optional_filters &&
           numeric_filters == other.numeric_filters &&
           tag_filters == other.tag_filters &&
@@ -917,7 +890,6 @@ module Algolia
           analytics == other.analytics &&
           analytics_tags == other.analytics_tags &&
           percentile_computation == other.percentile_computation &&
-          enable_ab_test == other.enable_ab_test &&
           query == other.query &&
           attributes_for_faceting == other.attributes_for_faceting &&
           replicas == other.replicas &&
@@ -940,7 +912,6 @@ module Algolia
           keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
           custom_ranking == other.custom_ranking &&
           attributes_to_retrieve == other.attributes_to_retrieve &&
-          ranking == other.ranking &&
           relevancy_strictness == other.relevancy_strictness &&
           attributes_to_highlight == other.attributes_to_highlight &&
           attributes_to_snippet == other.attributes_to_snippet &&
@@ -957,7 +928,6 @@ module Algolia
           remove_stop_words == other.remove_stop_words &&
           query_languages == other.query_languages &&
           decompound_query == other.decompound_query &&
-          enable_rules == other.enable_rules &&
           enable_personalization == other.enable_personalization &&
           query_type == other.query_type &&
           remove_words_if_no_results == other.remove_words_if_no_results &&
@@ -976,7 +946,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
           rendering_content == other.rendering_content &&
           enable_re_ranking == other.enable_re_ranking &&
-          re_ranking_apply_filter == other.re_ranking_apply_filter
+          re_ranking_apply_filter == other.re_ranking_apply_filter &&
+          facet_filters == other.facet_filters
       end
       # @see the `==` method
@@ -991,7 +962,6 @@ module Algolia
         [
           similar_query,
           filters,
-          facet_filters,
           optional_filters,
           numeric_filters,
           tag_filters,
@@ -1016,7 +986,6 @@ module Algolia
           analytics,
           analytics_tags,
           percentile_computation,
-          enable_ab_test,
           query,
           attributes_for_faceting,
           replicas,
@@ -1039,7 +1008,6 @@ module Algolia
           keep_diacritics_on_characters,
           custom_ranking,
           attributes_to_retrieve,
-          ranking,
           relevancy_strictness,
           attributes_to_highlight,
           attributes_to_snippet,
@@ -1056,7 +1024,6 @@ module Algolia
           remove_stop_words,
           query_languages,
           decompound_query,
-          enable_rules,
           enable_personalization,
           query_type,
           remove_words_if_no_results,
@@ -1075,7 +1042,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity,
           rendering_content,
           enable_re_ranking,
-          re_ranking_apply_filter
+          re_ranking_apply_filter,
+          facet_filters
         ].hash
       end

data/lib/algolia/models/recommend/recommend_search_params.rb CHANGED Viewed

@@ -15,8 +15,6 @@ module Algolia
       # Filter expression to only include items that match the filter criteria in the response.  You can use these filter expressions:  - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>`, where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>`, where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`.  You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions:  - You can only combine filters of the same type with `OR`.   **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters.   **Not supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`.   **Not supported:** `facet:value OR (facet:value AND facet:value)`  Use quotes if the facet attribute name or facet value contains spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array.  For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering).
       attr_accessor :filters
-      attr_accessor :facet_filters
       attr_accessor :optional_filters
       attr_accessor :numeric_filters
@@ -83,9 +81,6 @@ module Algolia
       # Whether to include this search when calculating processing-time percentiles.
       attr_accessor :percentile_computation
-      # Whether to enable A/B testing for this search.
-      attr_accessor :enable_ab_test
       # Search query.
       attr_accessor :query
@@ -152,9 +147,6 @@ module Algolia
       # Attributes to include in the API response To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
       attr_accessor :attributes_to_retrieve
-      # Determines the order in which Algolia returns your results.  By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they're specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list.  **Modifiers**  - `asc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`.   Sort the index by the values of an attribute, in descending order.  Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
-      attr_accessor :ranking
       # Relevancy threshold below which less relevant results aren't included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
       attr_accessor :relevancy_strictness
@@ -200,9 +192,6 @@ module Algolia
       # Whether to split compound words in the query into their building blocks For more information, see [Word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#splitting-compound-words). Word segmentation is supported for these languages: German, Dutch, Finnish, Swedish, and Norwegian. Decompounding doesn't work for words with [non-spacing mark Unicode characters](https://www.charactercodes.net/category/non-spacing_mark). For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
       attr_accessor :decompound_query
-      # Whether to enable rules.
-      attr_accessor :enable_rules
       # Whether to enable Personalization.
       attr_accessor :enable_personalization
@@ -253,12 +242,14 @@ module Algolia
       attr_accessor :re_ranking_apply_filter
+      # Whether to enable rules.
+      attr_accessor :enable_rules
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
           :similar_query => :similarQuery,
           :filters => :filters,
-          :facet_filters => :facetFilters,
           :optional_filters => :optionalFilters,
           :numeric_filters => :numericFilters,
           :tag_filters => :tagFilters,
@@ -283,7 +274,6 @@ module Algolia
           :analytics => :analytics,
           :analytics_tags => :analyticsTags,
           :percentile_computation => :percentileComputation,
-          :enable_ab_test => :enableABTest,
           :query => :query,
           :attributes_for_faceting => :attributesForFaceting,
           :replicas => :replicas,
@@ -306,7 +296,6 @@ module Algolia
           :keep_diacritics_on_characters => :keepDiacriticsOnCharacters,
           :custom_ranking => :customRanking,
           :attributes_to_retrieve => :attributesToRetrieve,
-          :ranking => :ranking,
           :relevancy_strictness => :relevancyStrictness,
           :attributes_to_highlight => :attributesToHighlight,
           :attributes_to_snippet => :attributesToSnippet,
@@ -323,7 +312,6 @@ module Algolia
           :remove_stop_words => :removeStopWords,
           :query_languages => :queryLanguages,
           :decompound_query => :decompoundQuery,
-          :enable_rules => :enableRules,
           :enable_personalization => :enablePersonalization,
           :query_type => :queryType,
           :remove_words_if_no_results => :removeWordsIfNoResults,
@@ -342,7 +330,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :attributeCriteriaComputedByMinProximity,
           :rendering_content => :renderingContent,
           :enable_re_ranking => :enableReRanking,
-          :re_ranking_apply_filter => :reRankingApplyFilter
+          :re_ranking_apply_filter => :reRankingApplyFilter,
+          :enable_rules => :enableRules
         }
       end
@@ -351,7 +340,6 @@ module Algolia
         {
           :similar_query => :"String",
           :filters => :"String",
-          :facet_filters => :"FacetFilters",
           :optional_filters => :"OptionalFilters",
           :numeric_filters => :"NumericFilters",
           :tag_filters => :"TagFilters",
@@ -376,7 +364,6 @@ module Algolia
           :analytics => :"Boolean",
           :analytics_tags => :"Array<String>",
           :percentile_computation => :"Boolean",
-          :enable_ab_test => :"Boolean",
           :query => :"String",
           :attributes_for_faceting => :"Array<String>",
           :replicas => :"Array<String>",
@@ -399,7 +386,6 @@ module Algolia
           :keep_diacritics_on_characters => :"String",
           :custom_ranking => :"Array<String>",
           :attributes_to_retrieve => :"Array<String>",
-          :ranking => :"Array<String>",
           :relevancy_strictness => :"Integer",
           :attributes_to_highlight => :"Array<String>",
           :attributes_to_snippet => :"Array<String>",
@@ -416,7 +402,6 @@ module Algolia
           :remove_stop_words => :"RemoveStopWords",
           :query_languages => :"Array<SupportedLanguage>",
           :decompound_query => :"Boolean",
-          :enable_rules => :"Boolean",
           :enable_personalization => :"Boolean",
           :query_type => :"QueryType",
           :remove_words_if_no_results => :"RemoveWordsIfNoResults",
@@ -435,7 +420,8 @@ module Algolia
           :attribute_criteria_computed_by_min_proximity => :"Boolean",
           :rendering_content => :"RenderingContent",
           :enable_re_ranking => :"Boolean",
-          :re_ranking_apply_filter => :"ReRankingApplyFilter"
+          :re_ranking_apply_filter => :"ReRankingApplyFilter",
+          :enable_rules => :"Boolean"
         }
       end
@@ -491,10 +477,6 @@ module Algolia
           self.filters = attributes[:filters]
         end
-        if attributes.key?(:facet_filters)
-          self.facet_filters = attributes[:facet_filters]
-        end
         if attributes.key?(:optional_filters)
           self.optional_filters = attributes[:optional_filters]
         end
@@ -603,10 +585,6 @@ module Algolia
           self.percentile_computation = attributes[:percentile_computation]
         end
-        if attributes.key?(:enable_ab_test)
-          self.enable_ab_test = attributes[:enable_ab_test]
-        end
         if attributes.key?(:query)
           self.query = attributes[:query]
         end
@@ -721,12 +699,6 @@ module Algolia
           end
         end
-        if attributes.key?(:ranking)
-          if (value = attributes[:ranking]).is_a?(Array)
-            self.ranking = value
-          end
-        end
         if attributes.key?(:relevancy_strictness)
           self.relevancy_strictness = attributes[:relevancy_strictness]
         end
@@ -799,10 +771,6 @@ module Algolia
           self.decompound_query = attributes[:decompound_query]
         end
-        if attributes.key?(:enable_rules)
-          self.enable_rules = attributes[:enable_rules]
-        end
         if attributes.key?(:enable_personalization)
           self.enable_personalization = attributes[:enable_personalization]
         end
@@ -886,6 +854,10 @@ module Algolia
         if attributes.key?(:re_ranking_apply_filter)
           self.re_ranking_apply_filter = attributes[:re_ranking_apply_filter]
         end
+        if attributes.key?(:enable_rules)
+          self.enable_rules = attributes[:enable_rules]
+        end
       end
       # Checks equality by comparing each attribute.
@@ -895,7 +867,6 @@ module Algolia
         self.class == other.class &&
           similar_query == other.similar_query &&
           filters == other.filters &&
-          facet_filters == other.facet_filters &&
           optional_filters == other.optional_filters &&
           numeric_filters == other.numeric_filters &&
           tag_filters == other.tag_filters &&
@@ -920,7 +891,6 @@ module Algolia
           analytics == other.analytics &&
           analytics_tags == other.analytics_tags &&
           percentile_computation == other.percentile_computation &&
-          enable_ab_test == other.enable_ab_test &&
           query == other.query &&
           attributes_for_faceting == other.attributes_for_faceting &&
           replicas == other.replicas &&
@@ -943,7 +913,6 @@ module Algolia
           keep_diacritics_on_characters == other.keep_diacritics_on_characters &&
           custom_ranking == other.custom_ranking &&
           attributes_to_retrieve == other.attributes_to_retrieve &&
-          ranking == other.ranking &&
           relevancy_strictness == other.relevancy_strictness &&
           attributes_to_highlight == other.attributes_to_highlight &&
           attributes_to_snippet == other.attributes_to_snippet &&
@@ -960,7 +929,6 @@ module Algolia
           remove_stop_words == other.remove_stop_words &&
           query_languages == other.query_languages &&
           decompound_query == other.decompound_query &&
-          enable_rules == other.enable_rules &&
           enable_personalization == other.enable_personalization &&
           query_type == other.query_type &&
           remove_words_if_no_results == other.remove_words_if_no_results &&
@@ -979,7 +947,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity == other.attribute_criteria_computed_by_min_proximity &&
           rendering_content == other.rendering_content &&
           enable_re_ranking == other.enable_re_ranking &&
-          re_ranking_apply_filter == other.re_ranking_apply_filter
+          re_ranking_apply_filter == other.re_ranking_apply_filter &&
+          enable_rules == other.enable_rules
       end
       # @see the `==` method
@@ -994,7 +963,6 @@ module Algolia
         [
           similar_query,
           filters,
-          facet_filters,
           optional_filters,
           numeric_filters,
           tag_filters,
@@ -1019,7 +987,6 @@ module Algolia
           analytics,
           analytics_tags,
           percentile_computation,
-          enable_ab_test,
           query,
           attributes_for_faceting,
           replicas,
@@ -1042,7 +1009,6 @@ module Algolia
           keep_diacritics_on_characters,
           custom_ranking,
           attributes_to_retrieve,
-          ranking,
           relevancy_strictness,
           attributes_to_highlight,
           attributes_to_snippet,
@@ -1059,7 +1025,6 @@ module Algolia
           remove_stop_words,
           query_languages,
           decompound_query,
-          enable_rules,
           enable_personalization,
           query_type,
           remove_words_if_no_results,
@@ -1078,7 +1043,8 @@ module Algolia
           attribute_criteria_computed_by_min_proximity,
           rendering_content,
           enable_re_ranking,
-          re_ranking_apply_filter
+          re_ranking_apply_filter,
+          enable_rules
         ].hash
       end

data/lib/algolia/version.rb CHANGED Viewed

@@ -3,5 +3,5 @@
 # Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
 module Algolia
-  VERSION = "3.42.1"
+  VERSION = "3.42.3"
 end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: algolia
 version: !ruby/object:Gem::Version
-  version: 3.42.1
+  version: 3.42.3
 platform: ruby
 authors:
 - https://alg.li/support