npm - @graphcommerce/algolia-recommend - Versions diffs - 9.1.0-canary.26 → 9.1.0-canary.29 - Mend

@graphcommerce/algolia-recommend 9.1.0-canary.26 → 9.1.0-canary.29

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 (5) hide show

package/CHANGELOG.md +10 -0
package/algolia-recommend-spec.yaml +1318 -816
package/mesh/createProductMapper.ts +5 -3
package/mesh/getRecommendations.ts +1 -1
package/package.json +6 -6

package/algolia-recommend-spec.yaml CHANGED Viewed

@@ -192,7 +192,7 @@ components:
       required: true
       schema:
         type: string
-        example: YourIndexName
+        example: ALGOLIA_INDEX_NAME
     Models:
       in: path
       name: model
@@ -223,17 +223,31 @@ components:
       type: string
       example: products
       description: Index name (case-sensitive).
-    query:
+    similarQuery:
       type: string
-      description: Search query.
+      description: >
+        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.
+      example: comedy drama crime Macy Buscemi
       x-categories:
         - Search
-    searchParamsQuery:
-      type: object
-      additionalProperties: false
-      properties:
-        query:
-          $ref: '#/components/schemas/query'
     filters:
       type: string
       description: >
@@ -312,6 +326,8 @@ components:
         - Optional filters are applied _after_ sort-by attributes.
+        - Optional filters are applied _before_ custom ranking attributes (in the default [ranking](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/)).
         - Optional filters don't work with numeric attributes.
       example:
@@ -332,7 +348,9 @@ components:
         **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**
-        You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparsions are precise up to 3 decimals.
+        You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`.
+        Comparisons are precise up to 3 decimals.
         You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries.
@@ -374,19 +392,69 @@ components:
         - type: string
       x-categories:
         - Filtering
-    page:
-      type: integer
-      description: Page of search results to retrieve.
-      minimum: 0
+    sumOrFiltersScores:
+      type: boolean
+      description: >
+        Whether to sum all filter scores.
+        If true, all filter scores are summed.
+        Otherwise, the maximum filter score is kept.
+        For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
       x-categories:
-        - Pagination
+        - Filtering
+    restrictSearchableAttributes:
+      type: array
+      items:
+        type: string
+      example:
+        - title
+        - author
+      description: |
+        Restricts a search to a subset of your searchable attributes.
+        Attribute names are case-sensitive.
+      x-categories:
+        - Filtering
+    facets:
+      type: array
+      items:
+        type: string
+      description: >
+        Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.
+        To retrieve all facets, use the wildcard character `*`.
+        For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
+      example:
+        - '*'
+      x-categories:
+        - Faceting
+    facetingAfterDistinct:
+      type: boolean
+      description: >
+        Whether faceting should be applied after deduplication with `distinct`.
+        This leads to accurate facet counts when using faceting in combination with `distinct`.
+        It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting,
+        as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
+      x-categories:
+        - Faceting
     aroundLatLng:
       type: string
       description: >
         Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude.
-        Only records included within circle around this central location are included in the results.
+        Only records included within a circle around this central location are included in the results.
         The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings.
@@ -468,7 +536,15 @@ components:
         - $ref: '#/components/schemas/aroundPrecisionFromValue'
       x-categories:
         - Geo-Search
-    insideBoundingBox:
+    minimumAroundRadius:
+      type: integer
+      description: >-
+        Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
+      minimum: 1
+      x-categories:
+        - Geo-Search
+    insideBoundingBoxArray:
       type: array
       items:
         type: array
@@ -500,6 +576,11 @@ components:
           - 1.9916
       x-categories:
         - Geo-Search
+    insideBoundingBox:
+      oneOf:
+        - type: string
+        - type: 'null'
+        - $ref: '#/components/schemas/insideBoundingBoxArray'
     insidePolygon:
       type: array
       items:
@@ -608,6 +689,50 @@ components:
         - ur
         - uz
         - zh
+    naturalLanguages:
+      type: array
+      items:
+        $ref: '#/components/schemas/supportedLanguage'
+      description: >
+        ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):
+        - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages.
+        - Sets `removeWordsIfNoResults` to `allOptional`.
+        - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+      x-categories:
+        - Languages
+    ruleContexts:
+      type: array
+      items:
+        type: string
+      description: >
+        Assigns a rule context to the search query.
+        [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
+      example:
+        - mobile
+      x-categories:
+        - Rules
+    personalizationImpact:
+      type: integer
+      description: >
+        Impact that Personalization should have on this search.
+        The higher this value is, the more Personalization determines the ranking compared to other factors.
+        For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+      minimum: 0
+      maximum: 100
+      x-categories:
+        - Personalization
     userToken:
       type: string
       description: >
@@ -621,35 +746,58 @@ components:
       example: test-user-123
       x-categories:
         - Personalization
-    baseSearchParamsWithoutQuery:
+    getRankingInfo:
+      type: boolean
+      description: Whether the search response should include detailed ranking information.
+      x-categories:
+        - Advanced
+    synonyms:
+      type: boolean
+      description: Whether to take into account an index's synonyms for this search.
+      x-categories:
+        - Advanced
+    clickAnalytics:
+      type: boolean
+      description: >
+        Whether to include a `queryID` attribute in the response.
+        The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+      x-categories:
+        - Analytics
+    analytics:
+      type: boolean
+      description: Whether this search will be included in Analytics.
+      x-categories:
+        - Analytics
+    analyticsTags:
+      type: array
+      items:
+        type: string
+      description: >-
+        Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+      x-categories:
+        - Analytics
+    percentileComputation:
+      type: boolean
+      description: >-
+        Whether to include this search when calculating processing-time percentiles.
+      x-categories:
+        - Advanced
+    enableABTest:
+      type: boolean
+      description: Whether to enable A/B testing for this search.
+      x-categories:
+        - Advanced
+    baseRecommendSearchParams:
       type: object
       additionalProperties: false
       properties:
         similarQuery:
-          type: string
-          description: >
-            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.
-          example: comedy drama crime Macy Buscemi
-          x-categories:
-            - Search
+          $ref: '#/components/schemas/similarQuery'
         filters:
           $ref: '#/components/schemas/filters'
         facetFilters:
@@ -661,74 +809,13 @@ components:
         tagFilters:
           $ref: '#/components/schemas/tagFilters'
         sumOrFiltersScores:
-          type: boolean
-          description: >
-            Whether to sum all filter scores.
-            If true, all filter scores are summed.
-            Otherwise, the maximum filter score is kept.
-            For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
-          x-categories:
-            - Filtering
+          $ref: '#/components/schemas/sumOrFiltersScores'
         restrictSearchableAttributes:
-          type: array
-          items:
-            type: string
-          example:
-            - title
-            - author
-          description: |
-            Restricts a search to a subset of your searchable attributes.
-            Attribute names are case-sensitive.
-          x-categories:
-            - Filtering
+          $ref: '#/components/schemas/restrictSearchableAttributes'
         facets:
-          type: array
-          items:
-            type: string
-          description: >
-            Facets for which to retrieve facet values that match the search criteria and the number of matching facet values.
-            To retrieve all facets, use the wildcard character `*`.
-            For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
-          default: []
-          x-categories:
-            - Faceting
+          $ref: '#/components/schemas/facets'
         facetingAfterDistinct:
-          type: boolean
-          description: >
-            Whether faceting should be applied after deduplication with `distinct`.
-            This leads to accurate facet counts when using faceting in combination with `distinct`.
-            It's usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting,
-            as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
-          x-categories:
-            - Faceting
-        page:
-          $ref: '#/components/schemas/page'
-        offset:
-          type: integer
-          description: Position of the first hit to retrieve.
-          x-categories:
-            - Pagination
-        length:
-          type: integer
-          description: Number of hits to retrieve (used in combination with `offset`).
-          minimum: 0
-          maximum: 1000
-          x-categories:
-            - Pagination
+          $ref: '#/components/schemas/facetingAfterDistinct'
         aroundLatLng:
           $ref: '#/components/schemas/aroundLatLng'
         aroundLatLngViaIP:
@@ -738,122 +825,626 @@ components:
         aroundPrecision:
           $ref: '#/components/schemas/aroundPrecision'
         minimumAroundRadius:
-          type: integer
-          description: >-
-            Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
-          minimum: 1
-          x-categories:
-            - Geo-Search
+          $ref: '#/components/schemas/minimumAroundRadius'
         insideBoundingBox:
           $ref: '#/components/schemas/insideBoundingBox'
         insidePolygon:
           $ref: '#/components/schemas/insidePolygon'
         naturalLanguages:
+          $ref: '#/components/schemas/naturalLanguages'
+        ruleContexts:
+          $ref: '#/components/schemas/ruleContexts'
+        personalizationImpact:
+          $ref: '#/components/schemas/personalizationImpact'
+        userToken:
+          $ref: '#/components/schemas/userToken'
+        getRankingInfo:
+          $ref: '#/components/schemas/getRankingInfo'
+        synonyms:
+          $ref: '#/components/schemas/synonyms'
+        clickAnalytics:
+          $ref: '#/components/schemas/clickAnalytics'
+        analytics:
+          $ref: '#/components/schemas/analytics'
+        analyticsTags:
+          $ref: '#/components/schemas/analyticsTags'
+        percentileComputation:
+          $ref: '#/components/schemas/percentileComputation'
+        enableABTest:
+          $ref: '#/components/schemas/enableABTest'
+    query:
+      type: string
+      description: Search query.
+      x-categories:
+        - Search
+    searchParamsQuery:
+      type: object
+      additionalProperties: false
+      properties:
+        query:
+          $ref: '#/components/schemas/query'
+    userData:
+      example:
+        settingID: f2a7b51e3503acc6a39b3784ffb84300
+        pluginVersion: 1.6.0
+      description: |
+        An object with custom data.
+        You can store up to 32kB as custom data.
+      x-categories:
+        - Advanced
+    maxFacetHits:
+      type: integer
+      description: >-
+        Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+      maximum: 100
+      x-categories:
+        - Advanced
+    baseIndexSettings:
+      type: object
+      additionalProperties: false
+      properties:
+        attributesForFaceting:
           type: array
           items:
-            $ref: '#/components/schemas/supportedLanguage'
+            type: string
+          example:
+            - author
+            - filterOnly(isbn)
+            - searchable(edition)
+            - afterDistinct(category)
+            - afterDistinct(searchable(publisher))
           description: >
-            ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches):
+            Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
+            Facets are attributes that let you categorize search results.
-            - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages.
+            They can be used for filtering search results.
-            - Sets `removeWordsIfNoResults` to `allOptional`.
+            By default, no attribute is used for faceting.
-            - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
+            Attribute names are case-sensitive.
+            **Modifiers**
+            - `filterOnly("ATTRIBUTE")`.
+              Allows the attribute to be used as a filter but doesn't evaluate the facet values.
+            - `searchable("ATTRIBUTE")`.
+              Allows searching for facet values.
+            - `afterDistinct("ATTRIBUTE")`.
+              Evaluates the facet count _after_ deduplication with `distinct`.
+              This ensures accurate facet counts.
+              You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
           x-categories:
-            - Languages
-        ruleContexts:
+            - Faceting
+        replicas:
           type: array
           items:
             type: string
+          example:
+            - virtual(prod_products_price_asc)
+            - dev_products_replica
           description: >
-            Assigns a rule context to the search query.
+            Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).
-            [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
-          example:
-            - mobile
-          x-categories:
-            - Rules
-        personalizationImpact:
+            Replicas are copies of a primary index with the same records but different settings, synonyms, or rules.
+            If you want to offer a different ranking or sorting of your search results, you'll use replica indices.
+            All index operations on a primary index are automatically forwarded to its replicas.
+            To add a replica index, you must provide the complete set of replicas to this parameter.
+            If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer be synced with the primary index.
+            **Modifier**
+            - `virtual("REPLICA")`.
+              Create a virtual replica,
+              Virtual replicas don't increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
+          x-categories:
+            - Ranking
+        paginationLimitedTo:
           type: integer
+          example: 100
+          description: >
+            Maximum number of search results that can be obtained through pagination.
+            Higher pagination limits might slow down your search.
+            For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
+          maximum: 20000
+        unretrievableAttributes:
+          type: array
+          items:
+            type: string
+          example:
+            - total_sales
+          description: >
+            Attributes that can't be retrieved at query time.
+            This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/),
+            but don't want to include it in the search results.
+            Attribute names are case-sensitive.
+          x-categories:
+            - Attributes
+        disableTypoToleranceOnWords:
+          type: array
+          items:
+            type: string
+          example:
+            - wheel
+            - 1X2BCD
+          description: >
+            Creates a list of [words which require exact matches](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#turn-off-typo-tolerance-for-certain-words).
+            This also turns off [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) for the specified words.
+          x-categories:
+            - Typos
+        attributesToTransliterate:
+          description: >
+            Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead).
+            Transliteration supports searching in any of the Japanese writing systems.
+            To support transliteration, you must set the indexing language to Japanese.
+            Attribute names are case-sensitive.
+          type: array
+          items:
+            type: string
+          example:
+            - name
+            - description
+          x-categories:
+            - Languages
+        camelCaseAttributes:
+          type: array
+          items:
+            type: string
+          example:
+            - description
+          description: >
+            Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
+            Attribute names are case-sensitive.
+          x-categories:
+            - Languages
+        decompoundedAttributes:
+          type: object
+          example:
+            de:
+              - name
+          description: >
+            Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding).
+            Attribute names are case-sensitive.
+            Compound words are formed by combining two or more individual words,
+            and are particularly prevalent in Germanic languages—for example, "firefighter".
+            With decompounding, the individual components are indexed separately.
+            You can specify different lists for different languages.
+            Decompounding is supported for these languages:
+            Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
+            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).
+          x-categories:
+            - Languages
+        indexLanguages:
+          type: array
+          items:
+            $ref: '#/components/schemas/supportedLanguage'
+          example:
+            - ja
           description: >
-            Impact that Personalization should have on this search.
+            Languages for language-specific processing steps, such as word detection and dictionary settings.
+            **You should always specify an indexing language.**
+            If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
+            or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.
+            This can lead to unexpected search results.
+            For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+          x-categories:
+            - Languages
+        disablePrefixOnAttributes:
+          type: array
+          items:
+            type: string
+          example:
+            - sku
+          description: >
+            Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
-            The higher this value is, the more Personalization determines the ranking compared to other factors.
+            Attribute names are case-sensitive.
+          x-categories:
+            - Query strategy
+        allowCompressionOfIntegerArray:
+          type: boolean
+          description: >
+            Whether arrays with exclusively non-negative integers should be compressed for better performance.
-            For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
+            If true, the compressed arrays may be reordered.
+          x-categories:
+            - Performance
+        numericAttributesForFiltering:
+          type: array
+          items:
+            type: string
+          description: >
+            Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
+            Attribute names are case-sensitive.
+            By default, all numeric attributes are available as numerical filters.
+            For faster indexing, reduce the number of numeric attributes.
+            To turn off filtering for all numeric attributes, specify an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.
+            **Modifier**
+            - `equalOnly("ATTRIBUTE")`.
+              Support only filtering based on equality comparisons `=` and `!=`.
+          example:
+            - equalOnly(quantity)
+            - popularity
+          x-categories:
+            - Performance
+        separatorsToIndex:
+          type: string
+          example: +#
+          description: >
+            Control which non-alphanumeric characters are indexed.
+            By default, Algolia ignores [non-alphanumeric characters](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/#handling-non-alphanumeric-characters) like hyphen (`-`), plus (`+`), and parentheses (`(`,`)`).
+            To include such characters, define them with `separatorsToIndex`.
+            Separators are all non-letter characters except spaces and currency characters, such as $€£¥.
+            With `separatorsToIndex`, Algolia treats separator characters as separate words.
+            For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.
+          x-categories:
+            - Typos
+        searchableAttributes:
+          type: array
+          items:
+            type: string
+          example:
+            - title,alternative_title
+            - author
+            - unordered(text)
+            - emails.personal
+          description: >
+            Attributes used for searching. Attribute names are case-sensitive.
+            By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off.
+            With a non-empty list, Algolia only returns results with matches in the selected attributes.
+            In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first.
+            To make matches in two attributes rank equally, include them in a comma-separated string, such as `"title,alternate_title"`.
+            Attributes with the same priority are always unordered.
+            For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/).
+            **Modifier**
+            - `unordered("ATTRIBUTE")`.
+              Ignore the position of a match within the attribute.
+            Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
+          x-categories:
+            - Attributes
+        userData:
+          $ref: '#/components/schemas/userData'
+        customNormalization:
+          description: >
+            Characters and their normalized replacements.
+            This overrides Algolia's default [normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/).
+          type: object
+          additionalProperties:
+            type: object
+            additionalProperties:
+              type: string
+          x-categories:
+            - Languages
+        attributeForDistinct:
+          description: >
+            Attribute that should be used to establish groups of results.
+            Attribute names are case-sensitive.
+            All records with the same value for this attribute are considered a group.
+            You can combine `attributeForDistinct` with the `distinct` search parameter to control
+            how many items per group are included in the search results.
+            If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting.
+            This applies faceting _after_ deduplication, which will result in accurate facet counts.
+          example: url
+          type: string
+        maxFacetHits:
+          $ref: '#/components/schemas/maxFacetHits'
+        keepDiacriticsOnCharacters:
+          type: string
+          example: øé
+          description: |
+            Characters for which diacritics should be preserved.
+            By default, Algolia removes diacritics from letters.
+            For example, `é` becomes `e`. If this causes issues in your search,
+            you can specify characters that should keep their diacritics.
+          x-categories:
+            - Languages
+        customRanking:
+          type: array
+          items:
+            type: string
+          example:
+            - desc(popularity)
+            - asc(price)
+          description: >
+            Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).
+            Attribute names are case-sensitive.
+            The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.
+            Records with missing values for your selected custom ranking attributes are always sorted last.
+            Boolean attributes are sorted based on their alphabetical order.
+            **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.
+            If you use two or more custom ranking attributes,
+            [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes,
+            or the other attributes will never be applied.
+          x-categories:
+            - Ranking
+    attributesToRetrieve:
+      type: array
+      items:
+        type: string
+      example:
+        - author
+        - title
+        - content
+      description: >
+        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.
+      x-categories:
+        - Attributes
+    ranking:
+      type: array
+      items:
+        type: string
+      description: >
+        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,
+        you should test your changes in the dashboard,
+        and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
+      x-categories:
+        - Ranking
+    relevancyStrictness:
+      type: integer
+      example: 90
+      description: >
+        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.
+      x-categories:
+        - Ranking
+    attributesToHighlight:
+      type: array
+      items:
+        type: string
+      example:
+        - author
+        - title
+        - conten
+        - content
+      description: >
+        Attributes to highlight.
+        By default, all searchable attributes are highlighted.
+        Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.
+        Attribute names are case-sensitive.
+        With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.
+        You can use this to visually highlight matching parts of a search query in your UI.
+        For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
+      x-categories:
+        - Highlighting and Snippeting
+    attributesToSnippet:
+      type: array
+      items:
+        type: string
+      example:
+        - content:80
+        - description
+      description: >
+        Attributes for which to enable snippets.
+        Attribute names are case-sensitive.
+        Snippets provide additional context to matched words.
+        If you enable snippets, they include 10 words, including the matched word.
+        The matched word will also be wrapped by HTML tags for highlighting.
+        You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`,
+        where `NUMBER` is the number of words to be extracted.
-          minimum: 0
-          maximum: 100
-          x-categories:
-            - Personalization
-        userToken:
-          $ref: '#/components/schemas/userToken'
-        getRankingInfo:
-          type: boolean
-          description: >-
-            Whether the search response should include detailed ranking information.
+      x-categories:
+        - Highlighting and Snippeting
+    highlightPreTag:
+      type: string
+      description: >-
+        HTML tag to insert before the highlighted parts in all highlighted results and snippets.
-          x-categories:
-            - Advanced
-        synonyms:
-          type: boolean
-          description: Whether to take into account an index's synonyms for this search.
-          x-categories:
-            - Advanced
-        clickAnalytics:
-          type: boolean
-          description: >
-            Whether to include a `queryID` attribute in the response.
-            The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
+      x-categories:
+        - Highlighting and Snippeting
+    highlightPostTag:
+      type: string
+      description: >-
+        HTML tag to insert after the highlighted parts in all highlighted results and snippets.
-          x-categories:
-            - Analytics
-        analytics:
-          type: boolean
-          description: Whether this search will be included in Analytics.
-          x-categories:
-            - Analytics
-        analyticsTags:
-          type: array
-          items:
-            type: string
-          description: >-
-            Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
+      x-categories:
+        - Highlighting and Snippeting
+    snippetEllipsisText:
+      type: string
+      description: String used as an ellipsis indicator when a snippet is truncated.
+      x-categories:
+        - Highlighting and Snippeting
+    restrictHighlightAndSnippetArrays:
+      type: boolean
+      description: >
+        Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
+        By default, all items are highlighted and snippeted.
-          x-categories:
-            - Analytics
-        percentileComputation:
-          type: boolean
-          description: >-
-            Whether to include this search when calculating processing-time percentiles.
+      x-categories:
+        - Highlighting and Snippeting
+    minWordSizefor1Typo:
+      type: integer
+      description: >-
+        Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
-          x-categories:
-            - Advanced
-        enableABTest:
-          type: boolean
-          description: Whether to enable A/B testing for this search.
-          x-categories:
-            - Advanced
-    baseSearchParams:
-      allOf:
-        - $ref: '#/components/schemas/searchParamsQuery'
-        - $ref: '#/components/schemas/baseSearchParamsWithoutQuery'
-    hitsPerPage:
+      x-categories:
+        - Typos
+    minWordSizefor2Typos:
       type: integer
-      description: Number of hits per page.
-      minimum: 1
-      maximum: 1000
+      description: >-
+        Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
       x-categories:
-        - Pagination
+        - Typos
     typoToleranceEnum:
       type: string
       title: typo tolerance
@@ -871,7 +1462,7 @@ components:
         Whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
-        If typo tolerance is true, `min`, or `strict`, [word splitting and concetenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) is also active.
+        If typo tolerance is true, `min`, or `strict`, [word splitting and concatenation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/splitting-and-concatenation/) are also active.
       oneOf:
         - type: boolean
@@ -882,6 +1473,39 @@ components:
         - $ref: '#/components/schemas/typoToleranceEnum'
       x-categories:
         - Typos
+    allowTyposOnNumericTokens:
+      type: boolean
+      description: |
+        Whether to allow typos on numbers in the search query.
+        Turn off this setting to reduce the number of irrelevant matches
+        when searching in large sets of similar numbers.
+      x-categories:
+        - Typos
+    disableTypoToleranceOnAttributes:
+      type: array
+      items:
+        type: string
+      example:
+        - sku
+      description: >
+        Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
+        Attribute names are case-sensitive.
+        Returning only exact matches can help when:
+        - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/).
+        - Reducing the number of matches when you have too many.
+          This can happen with attributes that are long blocks of text, such as product descriptions.
+        Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
+      x-categories:
+        - Typos
     booleanString:
       type: string
       enum:
@@ -942,6 +1566,61 @@ components:
       x-categories:
         - Languages
+    queryLanguages:
+      type: array
+      items:
+        $ref: '#/components/schemas/supportedLanguage'
+      example:
+        - es
+      description: >
+        Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
+        This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings.
+        This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages.
+        To support this, you must place the CJK language **first**.
+        **You should always specify a query language.**
+        If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
+        or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.
+        This can lead to unexpected search results.
+        For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
+      x-categories:
+        - Languages
+    decompoundQuery:
+      type: boolean
+      description: >
+        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).
+      x-categories:
+        - Languages
+    enableRules:
+      type: boolean
+      description: Whether to enable rules.
+      x-categories:
+        - Rules
+    enablePersonalization:
+      type: boolean
+      description: Whether to enable Personalization.
+      x-categories:
+        - Personalization
     queryType:
       type: string
       enum:
@@ -952,7 +1631,7 @@ components:
         Determines if and how query words are interpreted as prefixes.
-        By default, only the last query word is treated as prefix (`prefixLast`).
+        By default, only the last query word is treated as a prefix (`prefixLast`).
         To turn off prefix search, use `prefixNone`.
@@ -997,35 +1676,82 @@ components:
       x-categories:
         - Query strategy
-    mode:
-      type: string
-      enum:
-        - neuralSearch
-        - keywordSearch
+    advancedSyntax:
+      type: boolean
       description: >
-        Search mode the index will use to query for results.
+        Whether to support phrase matching and excluding words from search queries.
-        This setting only applies to indices, for which Algolia enabled NeuralSearch for you.
+        Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
       x-categories:
         - Query strategy
-    semanticSearch:
-      type: object
-      description: |
-        Settings for the semantic search part of NeuralSearch.
-        Only used when `mode` is `neuralSearch`.
-      properties:
-        eventSources:
-          oneOf:
-            - type: array
-              description: |
-                Indices from which to collect click and conversion events.
+    optionalWordsArray:
+      type: array
+      items:
+        type: string
+      example:
+        - blue
+        - iphone case
+      description: >-
+        List of [optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
-                If null, the current index and all its replicas are used.
-              items:
-                type: string
-            - type: 'null'
+      x-categories:
+        - Query strategy
+    optionalWords:
+      description: >
+        Words that should be considered optional when found in the query.
+        By default, records must match all words in the search query to be included in the search results.
+        Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.
+        For example, if the search query is "action video" and "video" is an optional word,
+        the search engine runs two queries. One for "action video" and one for "action".
+        Records that match all words are ranked higher.
+        For a search query with 4 or more words **and** all its words are optional,
+        the number of matched words required for a record to be included in the search results increases for every 1,000 records:
+        - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:
+          results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
+        - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down).
+          For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.
+        For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
+      oneOf:
+        - type: string
+        - type: 'null'
+        - $ref: '#/components/schemas/optionalWordsArray'
+    disableExactOnAttributes:
+      type: array
+      items:
+        type: string
+      example:
+        - description
+      description: >
+        Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
+        Attribute names are case-sensitive.
+        This can be useful for attributes with long values, where the likelihood of an exact match is high,
+        such as product descriptions.
+        Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
+        This reduces the impact of individual attributes with a lot of content on ranking.
+      x-categories:
+        - Query strategy
     exactOnSingleWordQuery:
       type: string
       enum:
@@ -1057,6 +1783,36 @@ components:
         - ignorePlurals
         - singleWordSynonym
         - multiWordsSynonym
+        - ignoreConjugations
+      x-categories:
+        - Query strategy
+    properties-alternativesAsExact:
+      type: array
+      items:
+        $ref: '#/components/schemas/alternativesAsExact'
+      description: >
+        Determine which plurals and synonyms should be considered an exact matches.
+        By default, Algolia treats singular and plural forms of a word, and single-word synonyms, as [exact](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#exact) matches when searching.
+        For example:
+        - "swimsuit" and "swimsuits" are treated the same
+        - "swimsuit" and "swimwear" are treated the same (if they are [synonyms](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/#regular-synonyms)).
+        - `ignorePlurals`.
+          Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.
+        - `singleWordSynonym`.
+          Single-word synonyms, such as "NY" = "NYC", are considered exact matches.
+        - `multiWordsSynonym`.
+          Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
       x-categories:
         - Query strategy
     advancedSyntaxFeatures:
@@ -1066,6 +1822,24 @@ components:
         - excludeWords
       x-categories:
         - Query strategy
+    properties-advancedSyntaxFeatures:
+      type: array
+      items:
+        $ref: '#/components/schemas/advancedSyntaxFeatures'
+      description: |
+        Advanced search syntax features you want to support.
+        - `exactPhrase`.
+          Phrases in quotes must match exactly.
+          For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case".
+        - `excludeWords`.
+          Query words prefixed with a `-` must not occur in a record.
+          For example, `search -engine` matches records that contain "search" but not "engine".
+        This setting only has an effect if `advancedSyntax` is true.
+      x-categories:
+        - Query strategy
     distinct:
       description: >
         Determines how many records of a group are included in the search results.
@@ -1102,12 +1876,112 @@ components:
           default: 0
       x-categories:
         - Advanced
-    maxFacetHits:
+    replaceSynonymsInHighlight:
+      type: boolean
+      description: >
+        Whether to replace a highlighted word with the matched synonym.
+        By default, the original words are highlighted even if a synonym matches.
+        For example, with `home` as a synonym for `house` and a search for `home`,
+        records matching either "home" or "house" are included in the search results,
+        and either "home" or "house" are highlighted.
+        With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,
+        but all occurrences of "house" are replaced by "home" in the highlighted response.
+      x-categories:
+        - Highlighting and Snippeting
+    minProximity:
       type: integer
-      description: >-
-        Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
+      minimum: 1
+      maximum: 7
+      description: >
+        Minimum proximity score for two matching words.
+        This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
+        by equally scoring matches that are farther apart.
+        For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
+      x-categories:
+        - Advanced
+    responseFields:
+      type: array
+      items:
+        type: string
+      description: >
+        Properties to include in the API response of search and browse requests.
+        By default, all response properties are included.
+        To reduce the response size, you can select which properties should be included.
+        An empty list may lead to an empty API response (except properties you can't exclude).
+        You can't exclude these properties:
+        `message`, `warning`, `cursor`, `abTestVariantID`,
+        or any property added by setting `getRankingInfo` to true.
+        Your search depends on the `hits` field. If you omit this field, searches won't return any results.
+        Your UI might also depend on other properties, for example, for pagination.
+        Before restricting the response size, check the impact on your search experience.
+      x-categories:
+        - Advanced
+    maxValuesPerFacet:
+      type: integer
+      description: Maximum number of facet values to return for each facet.
+      maximum: 1000
+      x-categories:
+        - Faceting
+    sortFacetValuesBy:
+      type: string
+      description: >
+        Order in which to retrieve facet values.
+        - `count`.
+          Facet values are retrieved by decreasing count.
+          The count is the number of matching records containing this facet value.
+        - `alpha`.
+          Retrieve facet values alphabetically.
+        This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`).
+        For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
+      x-categories:
+        - Faceting
+    attributeCriteriaComputedByMinProximity:
+      type: boolean
+      description: >
+        Whether the best matching attribute should be determined by minimum proximity.
+        This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.
+        If true, the best matching attribute is selected based on the minimum proximity of multiple matches.
+        Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
-      maximum: 100
       x-categories:
         - Advanced
     order:
@@ -1120,7 +1994,7 @@ components:
       type: array
       items:
         type: string
-    facets:
+    IndexSettings_facets:
       description: Order of facet names.
       type: object
       additionalProperties: false
@@ -1174,7 +2048,7 @@ components:
       additionalProperties: false
       properties:
         facets:
-          $ref: '#/components/schemas/facets'
+          $ref: '#/components/schemas/IndexSettings_facets'
         values:
           $ref: '#/components/schemas/values'
     redirectURL:
@@ -1184,12 +2058,58 @@ components:
       properties:
         url:
           type: string
+    bannerImageUrl:
+      description: URL for an image to show inside a banner.
+      type: object
+      additionalProperties: false
+      properties:
+        url:
+          type: string
+    bannerImage:
+      description: Image to show inside a banner.
+      type: object
+      additionalProperties: false
+      properties:
+        urls:
+          type: array
+          items:
+            $ref: '#/components/schemas/bannerImageUrl'
+        title:
+          type: string
+    bannerLink:
+      description: Link for a banner defined in the Merchandising Studio.
+      type: object
+      additionalProperties: false
+      properties:
+        url:
+          type: string
+    banner:
+      description: Banner with image and link to redirect users.
+      type: object
+      additionalProperties: false
+      properties:
+        image:
+          $ref: '#/components/schemas/bannerImage'
+        link:
+          $ref: '#/components/schemas/bannerLink'
+    banners:
+      description: Banners defined in the Merchandising Studio for a given search.
+      type: array
+      items:
+        $ref: '#/components/schemas/banner'
+    widgets:
+      description: Widgets returned from any rules that are applied to the current search.
+      type: object
+      additionalProperties: false
+      properties:
+        banners:
+          $ref: '#/components/schemas/banners'
     renderingContent:
       description: >
         Extra data that can be used in the search UI.
-        You can use this to control aspects of your search UI, such as, the order of facet names and values
+        You can use this to control aspects of your search UI, such as the order of facet names and values
         without changing your frontend code.
@@ -1200,8 +2120,20 @@ components:
           $ref: '#/components/schemas/facetOrdering'
         redirect:
           $ref: '#/components/schemas/redirectURL'
+        widgets:
+          $ref: '#/components/schemas/widgets'
       x-categories:
         - Advanced
+    enableReRanking:
+      type: boolean
+      description: >
+        Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
+        This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
+      x-categories:
+        - Filtering
     reRankingApplyFilter:
       description: >
         Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
@@ -1213,570 +2145,102 @@ components:
         - type: string
           x-categories:
             - Filtering
-    indexSettingsAsSearchParams:
+    properties-reRankingApplyFilter:
+      oneOf:
+        - $ref: '#/components/schemas/reRankingApplyFilter'
+        - type: 'null'
+    baseRecommendIndexSettings:
       type: object
       additionalProperties: false
       properties:
         attributesToRetrieve:
-          type: array
-          items:
-            type: string
-          example:
-            - author
-            - title
-            - content
-          description: >
-            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.
-          x-categories:
-            - Attributes
+          $ref: '#/components/schemas/attributesToRetrieve'
         ranking:
-          type: array
-          items:
-            type: string
-          description: >
-            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,
-            you should test your changes in the dashboard,
-            and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
-          x-categories:
-            - Ranking
-        customRanking:
-          type: array
-          items:
-            type: string
-          example:
-            - desc(popularity)
-            - asc(price)
-          description: >
-            Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/).
-            Attribute names are case-sensitive.
-            The custom ranking attributes decide which items are shown first if the other ranking criteria are equal.
-            Records with missing values for your selected custom ranking attributes are always sorted last.
-            Boolean attributes are sorted based on their alphabetical order.
-            **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.
-            If you use two or more custom ranking attributes,
-            [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes,
-            or the other attributes will never be applied.
-          x-categories:
-            - Ranking
+          $ref: '#/components/schemas/ranking'
         relevancyStrictness:
-          type: integer
-          example: 90
-          description: >
-            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.
-          x-categories:
-            - Ranking
+          $ref: '#/components/schemas/relevancyStrictness'
         attributesToHighlight:
-          type: array
-          items:
-            type: string
-          example:
-            - author
-            - title
-            - conten
-            - content
-          description: >
-            Attributes to highlight.
-            By default, all searchable attributes are highlighted.
-            Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting.
-            Attribute names are case-sensitive.
-            With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`.
-            You can use this to visually highlight matching parts of a search query in your UI.
-            For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
-          x-categories:
-            - Highlighting and Snippeting
+          $ref: '#/components/schemas/attributesToHighlight'
         attributesToSnippet:
-          type: array
-          items:
-            type: string
-          example:
-            - content:80
-            - description
-          description: >
-            Attributes for which to enable snippets.
-            Attribute names are case-sensitive.
-            Snippets provide additional context to matched words.
-            If you enable snippets, they include 10 words, including the matched word.
-            The matched word will also be wrapped by HTML tags for highlighting.
-            You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`,
-            where `NUMBER` is the number of words to be extracted.
-          x-categories:
-            - Highlighting and Snippeting
+          $ref: '#/components/schemas/attributesToSnippet'
         highlightPreTag:
-          type: string
-          description: >-
-            HTML tag to insert before the highlighted parts in all highlighted results and snippets.
-          x-categories:
-            - Highlighting and Snippeting
+          $ref: '#/components/schemas/highlightPreTag'
         highlightPostTag:
-          type: string
-          description: >-
-            HTML tag to insert after the highlighted parts in all highlighted results and snippets.
-          x-categories:
-            - Highlighting and Snippeting
+          $ref: '#/components/schemas/highlightPostTag'
         snippetEllipsisText:
-          type: string
-          description: String used as an ellipsis indicator when a snippet is truncated.
-          x-categories:
-            - Highlighting and Snippeting
+          $ref: '#/components/schemas/snippetEllipsisText'
         restrictHighlightAndSnippetArrays:
-          type: boolean
-          description: >
-            Whether to restrict highlighting and snippeting to items that at least partially matched the search query.
-            By default, all items are highlighted and snippeted.
-          x-categories:
-            - Highlighting and Snippeting
-        hitsPerPage:
-          $ref: '#/components/schemas/hitsPerPage'
+          $ref: '#/components/schemas/restrictHighlightAndSnippetArrays'
         minWordSizefor1Typo:
-          type: integer
-          description: >-
-            Minimum number of characters a word in the search query must contain to accept matches with [one typo](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
-          x-categories:
-            - Typos
+          $ref: '#/components/schemas/minWordSizefor1Typo'
         minWordSizefor2Typos:
-          type: integer
-          description: >-
-            Minimum number of characters a word in the search query must contain to accept matches with [two typos](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/in-depth/configuring-typo-tolerance/#configuring-word-length-for-typos).
-          x-categories:
-            - Typos
+          $ref: '#/components/schemas/minWordSizefor2Typos'
         typoTolerance:
           $ref: '#/components/schemas/typoTolerance'
         allowTyposOnNumericTokens:
-          type: boolean
-          description: |
-            Whether to allow typos on numbers in the search query.
-            Turn off this setting to reduce the number of irrelevant matches
-            when searching in large sets of similar numbers.
-          x-categories:
-            - Typos
+          $ref: '#/components/schemas/allowTyposOnNumericTokens'
         disableTypoToleranceOnAttributes:
-          type: array
-          items:
-            type: string
-          example:
-            - sku
-          description: >
-            Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/).
-            Attribute names are case-sensitive.
-            Returning only exact matches can help when:
-            - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/).
-            - Reducing the number of matches when you have too many.
-              This can happen with attributes that are long blocks of text, such as product descriptions.
-            Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
-          x-categories:
-            - Typos
+          $ref: '#/components/schemas/disableTypoToleranceOnAttributes'
         ignorePlurals:
-          $ref: '#/components/schemas/ignorePlurals'
-        removeStopWords:
-          $ref: '#/components/schemas/removeStopWords'
-        keepDiacriticsOnCharacters:
-          type: string
-          example: øé
-          description: |
-            Characters for which diacritics should be preserved.
-            By default, Algolia removes diacritics from letters.
-            For example, `é` becomes `e`. If this causes issues in your search,
-            you can specify characters that should keep their diacritics.
-          x-categories:
-            - Languages
-        queryLanguages:
-          type: array
-          items:
-            $ref: '#/components/schemas/supportedLanguage'
-          example:
-            - es
-          description: >
-            Languages for language-specific query processing steps such as plurals, stop-word removal, and word-detection dictionaries.
-            This setting sets a default list of languages used by the `removeStopWords` and `ignorePlurals` settings.
-            This setting also sets a dictionary for word detection in the logogram-based [CJK](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/normalization/#normalization-for-logogram-based-languages-cjk) languages.
-            To support this, you must place the CJK language **first**.
-            **You should always specify a query language.**
-            If you don't specify an indexing language, the search engine uses all [supported languages](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/),
-            or the languages you specified with the `ignorePlurals` or `removeStopWords` parameters.
-            This can lead to unexpected search results.
-            For more information, see [Language-specific configuration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/).
-          x-categories:
-            - Languages
-        decompoundQuery:
-          type: boolean
-          description: >
-            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).
-          x-categories:
-            - Languages
+          $ref: '#/components/schemas/ignorePlurals'
+        removeStopWords:
+          $ref: '#/components/schemas/removeStopWords'
+        queryLanguages:
+          $ref: '#/components/schemas/queryLanguages'
+        decompoundQuery:
+          $ref: '#/components/schemas/decompoundQuery'
         enableRules:
-          type: boolean
-          description: Whether to enable rules.
-          x-categories:
-            - Rules
+          $ref: '#/components/schemas/enableRules'
         enablePersonalization:
-          type: boolean
-          description: Whether to enable Personalization.
-          x-categories:
-            - Personalization
+          $ref: '#/components/schemas/enablePersonalization'
         queryType:
           $ref: '#/components/schemas/queryType'
         removeWordsIfNoResults:
           $ref: '#/components/schemas/removeWordsIfNoResults'
-        mode:
-          $ref: '#/components/schemas/mode'
-        semanticSearch:
-          $ref: '#/components/schemas/semanticSearch'
         advancedSyntax:
-          type: boolean
-          description: >
-            Whether to support phrase matching and excluding words from search queries.
-            Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
-          x-categories:
-            - Query strategy
+          $ref: '#/components/schemas/advancedSyntax'
         optionalWords:
-          type: array
-          items:
-            type: string
-          example:
-            - blue
-            - iphone case
-          description: >
-            Words that should be considered optional when found in the query.
-            By default, records must match all words in the search query to be included in the search results.
-            Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words.
-            For example, if the search query is "action video" and "video" is an optional word,
-            the search engine runs two queries. One for "action video" and one for "action".
-            Records that match all words are ranked higher.
-            For a search query with 4 or more words **and** all its words are optional,
-            the number of matched words required for a record to be included in the search results increases for every 1,000 records:
-            - If `optionalWords` has less than 10 words, the required number of matched words increases by 1:
-              results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words.
-            - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words dividied by 5 (rounded down).
-              For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words.
-            For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
-          x-categories:
-            - Query strategy
+          $ref: '#/components/schemas/optionalWords'
         disableExactOnAttributes:
-          type: array
-          items:
-            type: string
-          example:
-            - description
-          description: >
-            Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes).
-            Attribute names are case-sensitive.
-            This can be useful for attributes with long values, where the likelyhood of an exact match is high,
-            such as product descriptions.
-            Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes.
-            This reduces the impact of individual attributes with a lot of content on ranking.
-          x-categories:
-            - Query strategy
+          $ref: '#/components/schemas/disableExactOnAttributes'
         exactOnSingleWordQuery:
           $ref: '#/components/schemas/exactOnSingleWordQuery'
         alternativesAsExact:
-          type: array
-          items:
-            $ref: '#/components/schemas/alternativesAsExact'
-          description: >
-            Alternatives of query words that should be considered as exact matches by the Exact ranking criterion.
-            - `ignorePlurals`.
-              Plurals and similar declensions added by the `ignorePlurals` setting are considered exact matches.
-            - `singleWordSynonym`.
-              Single-word synonyms, such as "NY/NYC" are considered exact matches.
-            - `multiWordsSynonym`.
-              Multi-word synonyms, such as "NY/New York" are considered exact matches.
-          x-categories:
-            - Query strategy
+          $ref: '#/components/schemas/properties-alternativesAsExact'
         advancedSyntaxFeatures:
-          type: array
-          items:
-            $ref: '#/components/schemas/advancedSyntaxFeatures'
-          description: |
-            Advanced search syntax features you want to support.
-            - `exactPhrase`.
-              Phrases in quotes must match exactly.
-              For example, `sparkly blue "iPhone case"` only returns records with the exact string "iPhone case".
-            - `excludeWords`.
-              Query words prefixed with a `-` must not occur in a record.
-              For example, `search -engine` matches records that contain "search" but not "engine".
-            This setting only has an effect if `advancedSyntax` is true.
-          x-categories:
-            - Query strategy
+          $ref: '#/components/schemas/properties-advancedSyntaxFeatures'
         distinct:
           $ref: '#/components/schemas/distinct'
         replaceSynonymsInHighlight:
-          type: boolean
-          description: >
-            Whether to replace a highlighted word with the matched synonym.
-            By default, the original words are highlighted even if a synonym matches.
-            For example, with `home` as a synonym for `house` and a search for `home`,
-            records matching either "home" or "house" are included in the search results,
-            and either "home" or "house" are highlighted.
-            With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records,
-            but all occurences of "house" are replaced by "home" in the highlighted response.
-          x-categories:
-            - Highlighting and Snippeting
+          $ref: '#/components/schemas/replaceSynonymsInHighlight'
         minProximity:
-          type: integer
-          minimum: 1
-          maximum: 7
-          description: >
-            Minimum proximity score for two matching words.
-            This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity)
-            by equally scoring matches that are farther apart.
-            For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
-          x-categories:
-            - Advanced
+          $ref: '#/components/schemas/minProximity'
         responseFields:
-          type: array
-          items:
-            type: string
-          description: >
-            Properties to include in the API response of `search` and `browse` requests.
-            By default, all response properties are included.
-            To reduce the response size, you can select, which attributes should be included.
-            You can't exclude these properties:
-            `message`, `warning`, `cursor`, `serverUsed`, `indexUsed`,
-            `abTestVariantID`, `parsedQuery`, or any property triggered by the `getRankingInfo` parameter.
-            Don't exclude properties that you might need in your search UI.
-          x-categories:
-            - Advanced
-        maxFacetHits:
-          $ref: '#/components/schemas/maxFacetHits'
+          $ref: '#/components/schemas/responseFields'
         maxValuesPerFacet:
-          type: integer
-          description: Maximum number of facet values to return for each facet.
-          maximum: 1000
-          x-categories:
-            - Faceting
+          $ref: '#/components/schemas/maxValuesPerFacet'
         sortFacetValuesBy:
-          type: string
-          description: >
-            Order in which to retrieve facet values.
-            - `count`.
-              Facet values are retrieved by decreasing count.
-              The count is the number of matching records containing this facet value.
-            - `alpha`.
-              Retrieve facet values alphabetically.
-            This setting doesn't influence how facet values are displayed in your UI (see `renderingContent`).
-            For more information, see [facet value display](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/facet-display/js/).
-          x-categories:
-            - Faceting
+          $ref: '#/components/schemas/sortFacetValuesBy'
         attributeCriteriaComputedByMinProximity:
-          type: boolean
-          description: >
-            Whether the best matching attribute should be determined by minimum proximity.
-            This setting only affects ranking if the Attribute ranking criterion comes before Proximity in the `ranking` setting.
-            If true, the best matching attribute is selected based on the minimum proximity of multiple matches.
-            Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
-          x-categories:
-            - Advanced
+          $ref: '#/components/schemas/attributeCriteriaComputedByMinProximity'
         renderingContent:
           $ref: '#/components/schemas/renderingContent'
         enableReRanking:
-          type: boolean
-          description: >
-            Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
-            This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
-          x-categories:
-            - Filtering
+          $ref: '#/components/schemas/enableReRanking'
         reRankingApplyFilter:
-          oneOf:
-            - $ref: '#/components/schemas/reRankingApplyFilter'
-            - type: 'null'
-    searchParamsObject:
-      title: Search parameters as object
-      description: >-
-        Each parameter value, including the `query` must not be larger than 512 bytes.
+          $ref: '#/components/schemas/properties-reRankingApplyFilter'
+    recommendIndexSettings:
+      description: Index settings.
       allOf:
-        - $ref: '#/components/schemas/baseSearchParams'
-        - $ref: '#/components/schemas/indexSettingsAsSearchParams'
-    searchParams:
-      title: queryParameters
+        - $ref: '#/components/schemas/baseIndexSettings'
+        - $ref: '#/components/schemas/baseRecommendIndexSettings'
+    recommendSearchParams:
+      title: Search parameters as object
+      description: Search parameters for filtering the recommendations.
       allOf:
-        - $ref: '#/components/schemas/searchParamsObject'
+        - $ref: '#/components/schemas/baseRecommendSearchParams'
+        - $ref: '#/components/schemas/searchParamsQuery'
+        - $ref: '#/components/schemas/recommendIndexSettings'
     baseRecommendRequest:
       type: object
       additionalProperties: false
@@ -1794,7 +2258,7 @@ components:
         maxRecommendations:
           type: integer
           minimum: 1
-          maximum: 1000
+          maximum: 30
           description: >
             Maximum number of recommendations to retrieve.
@@ -1853,7 +2317,7 @@ components:
     fallbackParams:
       title: fallbackParameters
       allOf:
-        - $ref: '#/components/schemas/searchParamsObject'
+        - $ref: '#/components/schemas/recommendSearchParams'
     relatedProducts:
       type: object
       properties:
@@ -1927,6 +2391,7 @@ components:
       type: object
       properties:
         facetName:
+          type: string
           description: Facet attribute for which to retrieve trending facet values.
         model:
           $ref: '#/components/schemas/trendingFacetsModel'
@@ -1967,26 +2432,6 @@ components:
       allOf:
         - $ref: '#/components/schemas/baseRecommendRequest'
         - $ref: '#/components/schemas/lookingSimilar'
-    recommendedForYouModel:
-      type: string
-      description: |
-        "Recommened for you" model.
-      enum:
-        - recommended-for-you
-    recommendedForYou:
-      type: object
-      properties:
-        model:
-          $ref: '#/components/schemas/recommendedForYouModel'
-        fallbackParameters:
-          $ref: '#/components/schemas/searchParamsObject'
-      required:
-        - model
-    recommendedForYouQuery:
-      title: Recommended for you
-      allOf:
-        - $ref: '#/components/schemas/baseRecommendRequest'
-        - $ref: '#/components/schemas/recommendedForYou'
     recommendationsRequest:
       oneOf:
         - $ref: '#/components/schemas/boughtTogetherQuery'
@@ -1994,7 +2439,6 @@ components:
         - $ref: '#/components/schemas/trendingItemsQuery'
         - $ref: '#/components/schemas/trendingFacetsQuery'
         - $ref: '#/components/schemas/lookingSimilarQuery'
-        - $ref: '#/components/schemas/recommendedForYouQuery'
     processingTimeMS:
       type: integer
       description: Time the server took to process the request, in milliseconds.
@@ -2029,17 +2473,6 @@ components:
         - reason
         - dest
         - source
-    userData:
-      type: object
-      example:
-        settingID: f2a7b51e3503acc6a39b3784ffb84300
-        pluginVersion: 1.6.0
-      description: |
-        An object with custom data.
-        You can store up to 32kB as custom data.
-      x-categories:
-        - Advanced
     baseSearchResponse:
       type: object
       additionalProperties: true
@@ -2100,6 +2533,12 @@ components:
               description: >-
                 Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
+        appliedRules:
+          description: Rules applied to the query.
+          title: appliedRules
+          type: array
+          items:
+            type: object
         exhaustiveFacetsCount:
           type: boolean
           description: >-
@@ -2214,6 +2653,12 @@ components:
         _automaticInsights:
           type: boolean
           description: Whether automatic events collection is enabled for the application.
+    page:
+      type: integer
+      description: Page of search results to retrieve.
+      minimum: 0
+      x-categories:
+        - Pagination
     nbHits:
       type: integer
       description: Number of results (hits).
@@ -2222,6 +2667,13 @@ components:
       type: integer
       description: Number of pages of results.
       example: 1
+    hitsPerPage:
+      type: integer
+      description: Number of hits per page.
+      minimum: 1
+      maximum: 1000
+      x-categories:
+        - Pagination
     SearchPagination:
       type: object
       additionalProperties: false
@@ -2234,17 +2686,6 @@ components:
           $ref: '#/components/schemas/nbPages'
         hitsPerPage:
           $ref: '#/components/schemas/hitsPerPage'
-      required:
-        - page
-        - nbHits
-        - nbPages
-        - hitsPerPage
-    highlightResultMap:
-      type: object
-      description: Surround words that match the query with HTML tags for highlighting.
-      additionalProperties:
-        x-additionalPropertiesName: attribute
-        $ref: '#/components/schemas/highlightResult'
     highlightedValue:
       type: string
       description: Highlighted attribute value, including HTML tags.
@@ -2282,29 +2723,23 @@ components:
       x-discriminator-fields:
         - matchLevel
         - matchedWords
-    highlightResultOptionMap:
+    highlightResultMap:
       type: object
       description: Surround words that match the query with HTML tags for highlighting.
+      x-is-free-form: false
       additionalProperties:
         x-additionalPropertiesName: attribute
-        $ref: '#/components/schemas/highlightResultOption'
-    highlightResultOptionArray:
-      type: array
-      description: Surround words that match the query with HTML tags for highlighting.
-      items:
-        $ref: '#/components/schemas/highlightResultOption'
+        $ref: '#/components/schemas/highlightResult'
     highlightResult:
       oneOf:
-        - $ref: '#/components/schemas/highlightResultMap'
         - $ref: '#/components/schemas/highlightResultOption'
-        - $ref: '#/components/schemas/highlightResultOptionMap'
-        - $ref: '#/components/schemas/highlightResultOptionArray'
-    snippetResultMap:
-      type: object
-      description: Snippets that show the context around a matching search query.
-      additionalProperties:
-        x-additionalPropertiesName: attribute
-        $ref: '#/components/schemas/snippetResult'
+        - $ref: '#/components/schemas/highlightResultMap'
+        - $ref: '#/components/schemas/highlightResultArray'
+    highlightResultArray:
+      type: array
+      description: Surround words that match the query with HTML tags for highlighting.
+      items:
+        $ref: '#/components/schemas/highlightResult'
     snippetResultOption:
       type: object
       description: Snippets that show the context around a matching search query.
@@ -2319,23 +2754,23 @@ components:
         - matchLevel
       x-discriminator-fields:
         - matchLevel
-    snippetResultOptionMap:
+    snippetResultMap:
       type: object
       description: Snippets that show the context around a matching search query.
+      x-is-free-form: false
       additionalProperties:
         x-additionalPropertiesName: attribute
-        $ref: '#/components/schemas/snippetResultOption'
-    snippetResultOptionArray:
-      type: array
-      description: Snippets that show the context around a matching search query.
-      items:
-        $ref: '#/components/schemas/snippetResultOption'
+        $ref: '#/components/schemas/snippetResult'
     snippetResult:
       oneOf:
-        - $ref: '#/components/schemas/snippetResultMap'
         - $ref: '#/components/schemas/snippetResultOption'
-        - $ref: '#/components/schemas/snippetResultOptionMap'
-        - $ref: '#/components/schemas/snippetResultOptionArray'
+        - $ref: '#/components/schemas/snippetResultMap'
+        - $ref: '#/components/schemas/snippetResultArray'
+    snippetResultArray:
+      type: array
+      description: Snippets that show the context around a matching search query.
+      items:
+        $ref: '#/components/schemas/snippetResult'
     matchedGeoLocation:
       type: object
       properties:
@@ -2442,7 +2877,6 @@ components:
       additionalProperties: true
       required:
         - objectID
-        - _score
       properties:
         objectID:
           $ref: '#/components/schemas/objectID'
@@ -2456,11 +2890,12 @@ components:
           $ref: '#/components/schemas/distinctSeqID'
         _score:
           $ref: '#/components/schemas/recommendScore'
+      x-discriminator-fields:
+        - objectID
     trendingFacetHit:
       type: object
       description: Trending facet hit.
       required:
-        - _score
         - facetName
         - facetValue
       properties:
@@ -2470,6 +2905,9 @@ components:
           $ref: '#/components/schemas/facetName'
         facetValue:
           $ref: '#/components/schemas/facetValue'
+      x-discriminator-fields:
+        - facetName
+        - facetValue
     recommendationsHit:
       oneOf:
         - $ref: '#/components/schemas/recommendHit'
@@ -2613,6 +3051,21 @@ components:
           $ref: '#/components/schemas/PromoteConsequence'
         params:
           $ref: '#/components/schemas/ParamsConsequence'
+    timeRange:
+      type: object
+      additionalProperties: false
+      properties:
+        from:
+          type: integer
+          format: int64
+          description: When the rule should start to be active, in Unix epoch time.
+        until:
+          type: integer
+          format: int64
+          description: When the rule should stop to be active, in Unix epoch time.
+      required:
+        - from
+        - until
     RecommendRule:
       type: object
       description: Recommend rule.
@@ -2636,12 +3089,17 @@ components:
           description: >-
             Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
-          example: Display a promotional banner
+          example: Boost on-sale items
         enabled:
           type: boolean
           description: >-
             Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
+        validity:
+          type: array
+          description: Time periods when the rule is active.
+          items:
+            $ref: '#/components/schemas/timeRange'
     taskID:
       type: integer
       format: int64
@@ -2670,12 +3128,50 @@ components:
     parameters_page:
       type: integer
       minimum: 0
-      description: Requested page of the API response.
+      description: >
+        Requested page of the API response.
+        Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).
+        - `hitsPerPage`: sets the number of search results (_hits_) displayed per page.
+        - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.
+        For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
     parameters_hitsPerPage:
       type: integer
       minimum: 1
       maximum: 1000
-      description: Maximum number of hits per page.
+      description: >
+        Maximum number of hits per page.
+        Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).
+        - `hitsPerPage`: sets the number of search results (_hits_) displayed per page.
+        - `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.
+        For example, to display 10 results per page starting from the third page, set `hitsPerPage` to 10 and `page` to 2.
+    recommendUpdatedAtResponse:
+      type: object
+      description: Response, taskID, and update timestamp.
+      additionalProperties: false
+      required:
+        - taskID
+        - updatedAt
+      properties:
+        taskID:
+          $ref: '#/components/schemas/taskID'
+        updatedAt:
+          $ref: '#/components/schemas/updatedAt'
   responses:
     BadRequest:
       description: Bad request or request arguments.
@@ -2718,3 +3214,9 @@ components:
                 $ref: '#/components/schemas/taskID'
               deletedAt:
                 $ref: '#/components/schemas/deletedAt'
+    RecommendUpdatedAt:
+      description: OK
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/recommendUpdatedAtResponse'