@graphcommerce/algolia-recommend 10.0.0-canary.66 → 10.0.0-canary.68

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # @graphcommerce/algolia-recommend
 
+## 10.0.0-canary.68
+
+## 10.0.0-canary.67
+
 ## 10.0.0-canary.66
 
 ## 10.0.0-canary.65

package/algolia-recommend-spec.yaml

@@ -93,6 +93,7 @@ info:
     
     The current version of the Recommend API is version 1, as indicated by the `/1/` in each endpoint's URL.
 
+
   version: 1.0.0
 paths:
   /1/indexes/*/recommendations:
@@ -123,6 +124,7 @@ paths:
                   description: >-
                     Recommendation request with parameters depending on the requested model.
 
+
                   items:
                     $ref: '#/components/schemas/recommendationsRequest'
               required:
@@ -169,6 +171,7 @@ components:
         
         The required ACL to make a request is listed in each endpoint's reference.
 
+
   parameters:
     PathInPath:
       name: path
@@ -200,6 +203,7 @@ components:
       description: >
         [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
 
+
       schema:
         $ref: '#/components/schemas/recommendModels'
     ObjectID:
@@ -245,6 +249,7 @@ components:
         
         Combine it with `filters` to narrow down the list of results.
 
+
       example: comedy drama crime Macy Buscemi
       x-categories:
         - Search
@@ -285,6 +290,7 @@ components:
         
         For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
 
+
       example: (category:Book OR category:Ebook) AND _tags:published
       x-categories:
         - Filtering
@@ -307,6 +313,7 @@ components:
         
         `facet:\-value`.
 
+
       x-categories:
         - Filtering
       type: object
@@ -330,6 +337,7 @@ components:
         
         - Optional filters don't work with numeric attributes.
 
+
       example:
         - category:Book
         - author:John Doe
@@ -356,6 +364,7 @@ components:
         
         The same combination rules apply as for `facetFilters`.
 
+
       example:
         - - inStock = 1
           - deliveryDate < 1441755506
@@ -381,6 +390,7 @@ components:
         
         The same combination and escaping rules apply as for `facetFilters`.
 
+
       example:
         - - Book
           - Movie
@@ -404,6 +414,7 @@ components:
         
         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
     restrictSearchableAttributes:
@@ -430,6 +441,7 @@ components:
         
         For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
 
+
       example:
         - '*'
       x-categories:
@@ -446,6 +458,7 @@ components:
         
         as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
 
+
       x-categories:
         - Faceting
     aroundLatLng:
@@ -460,6 +473,7 @@ components:
         
         This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
 
+
       example: 40.71,-74.01
       x-categories:
         - Geo-Search
@@ -474,6 +488,7 @@ components:
       description: >-
         Return all records with a valid `_geoloc` attribute. Don't filter by distance.
 
+
       enum:
         - all
     aroundRadius:
@@ -487,6 +502,7 @@ components:
         
         The search radius is small if there are many hits close to the central coordinates.
 
+
       oneOf:
         - type: integer
           minimum: 1
@@ -503,18 +519,21 @@ components:
         description: >-
           Range object with lower and upper values in meters to define custom ranges.
 
+
         properties:
           from:
             type: integer
             description: >-
               Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
 
+
             example: 20
           value:
             type: integer
             description: >-
               Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
 
+
     aroundPrecision:
       description: >
         Precision of a coordinate-based search in meters to group results with similar distances.
@@ -522,6 +541,7 @@ components:
         
         The Geo ranking criterion considers all matches within the same range of distances to be equal.
 
+
       oneOf:
         - type: integer
           default: 10
@@ -533,6 +553,7 @@ components:
             
             as are records between 100 and 199 meters.
 
+
         - $ref: '#/components/schemas/aroundPrecisionFromValue'
       x-categories:
         - Geo-Search
@@ -541,6 +562,7 @@ components:
       description: >-
         Minimum radius (in meters) for a search around a location when `aroundRadius` isn't set.
 
+
       minimum: 1
       x-categories:
         - Geo-Search
@@ -565,6 +587,7 @@ components:
         
         For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
 
+
       example:
         - - 47.3165
           - 4.9665
@@ -602,6 +625,7 @@ components:
         
         This parameter is ignored if you also specify `insideBoundingBox`.
 
+
       example:
         - - 47.3165
           - 4.9665
@@ -703,6 +727,7 @@ components:
         
         - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
 
+
       x-categories:
         - Languages
     ruleContexts:
@@ -715,6 +740,7 @@ components:
         
         [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:
@@ -729,6 +755,7 @@ components:
         
         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:
@@ -743,6 +770,7 @@ components:
         
         For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
 
+
       example: test-user-123
       x-categories:
         - Personalization
@@ -764,6 +792,7 @@ components:
         
         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:
@@ -778,6 +807,7 @@ components:
       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:
@@ -785,6 +815,7 @@ components:
       description: >-
         Whether to include this search when calculating processing-time percentiles.
 
+
       x-categories:
         - Advanced
     enableABTest:
@@ -878,6 +909,7 @@ components:
       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
@@ -922,6 +954,7 @@ components:
               This ensures accurate facet counts.
               You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
 
+
           x-categories:
             - Faceting
         replicas:
@@ -953,6 +986,7 @@ components:
               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:
@@ -966,6 +1000,7 @@ components:
             
             For pagination limits above 1,000, the sorting of results beyond the 1,000th hit can't be guaranteed.
 
+
           maximum: 20000
         unretrievableAttributes:
           type: array
@@ -983,6 +1018,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           x-categories:
             - Attributes
         disableTypoToleranceOnWords:
@@ -997,6 +1033,7 @@ components:
             
             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:
@@ -1010,6 +1047,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           type: array
           items:
             type: string
@@ -1029,6 +1067,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           x-categories:
             - Languages
         decompoundedAttributes:
@@ -1059,6 +1098,7 @@ components:
             
             For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
 
+
           x-categories:
             - Languages
         indexLanguages:
@@ -1081,6 +1121,7 @@ components:
             
             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:
@@ -1094,6 +1135,7 @@ components:
             
             Attribute names are case-sensitive.
 
+
           x-categories:
             - Query strategy
         allowCompressionOfIntegerArray:
@@ -1103,6 +1145,7 @@ components:
             
             If true, the compressed arrays may be reordered.
 
+
           x-categories:
             - Performance
         numericAttributesForFiltering:
@@ -1129,6 +1172,7 @@ components:
             - `equalOnly("ATTRIBUTE")`.
               Support only filtering based on equality comparisons `=` and `!=`.
 
+
           example:
             - equalOnly(quantity)
             - popularity
@@ -1153,6 +1197,7 @@ components:
             
             For example, in a search for "Disney+", Algolia considers "Disney" and "+" as two separate words.
 
+
           x-categories:
             - Typos
         searchableAttributes:
@@ -1190,6 +1235,7 @@ components:
             
             Without a modifier, matches at the beginning of an attribute rank higher than matches at the end.
 
+
           x-categories:
             - Attributes
         userData:
@@ -1200,6 +1246,7 @@ components:
             
             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
@@ -1225,6 +1272,7 @@ components:
             
             This applies faceting _after_ deduplication, which will result in accurate facet counts.
 
+
           example: url
           type: string
         maxFacetHits:
@@ -1276,6 +1324,7 @@ components:
             
             or the other attributes will never be applied.
 
+
           x-categories:
             - Ranking
     attributesToRetrieve:
@@ -1301,6 +1350,7 @@ components:
         
         - The `objectID` attribute is always included.
 
+
       x-categories:
         - Attributes
     ranking:
@@ -1334,6 +1384,7 @@ components:
         
         and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/).
 
+
       x-categories:
         - Ranking
     relevancyStrictness:
@@ -1347,6 +1398,7 @@ components:
         
         Use this setting to strike a balance between the relevance and number of returned results.
 
+
       x-categories:
         - Ranking
     attributesToHighlight:
@@ -1376,6 +1428,7 @@ components:
         
         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:
@@ -1401,6 +1454,7 @@ components:
         
         where `NUMBER` is the number of words to be extracted.
 
+
       x-categories:
         - Highlighting and Snippeting
     highlightPreTag:
@@ -1408,6 +1462,7 @@ components:
       description: >-
         HTML tag to insert before the highlighted parts in all highlighted results and snippets.
 
+
       x-categories:
         - Highlighting and Snippeting
     highlightPostTag:
@@ -1415,6 +1470,7 @@ components:
       description: >-
         HTML tag to insert after the highlighted parts in all highlighted results and snippets.
 
+
       x-categories:
         - Highlighting and Snippeting
     snippetEllipsisText:
@@ -1429,6 +1485,7 @@ components:
         
         By default, all items are highlighted and snippeted.
 
+
       x-categories:
         - Highlighting and Snippeting
     minWordSizefor1Typo:
@@ -1436,6 +1493,7 @@ components:
       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
     minWordSizefor2Typos:
@@ -1443,6 +1501,7 @@ components:
       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
     typoToleranceEnum:
@@ -1464,12 +1523,14 @@ components:
         
         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
           default: true
           description: >-
             Whether typo tolerance is active. If true, matches with typos are included in the search results and rank after exact matches.
 
+
         - $ref: '#/components/schemas/typoToleranceEnum'
       x-categories:
         - Typos
@@ -1504,6 +1565,7 @@ components:
         
         Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
 
+
       x-categories:
         - Typos
     booleanString:
@@ -1532,6 +1594,7 @@ components:
             
             If false, singulars, plurals, and other declensions won't be considered equivalent.
 
+
           default: false
       x-categories:
         - Languages
@@ -1547,6 +1610,7 @@ components:
         
         You should only use this feature for the languages used in your index.
 
+
       example:
         - ca
         - es
@@ -1555,6 +1619,7 @@ components:
           description: >-
             ISO code for languages for which stop words should be removed. This overrides languages you set in `queryLanguges`.
 
+
           items:
             $ref: '#/components/schemas/supportedLanguage'
         - type: boolean
@@ -1564,6 +1629,7 @@ components:
             
             If false, stop words are not removed.
 
+
       x-categories:
         - Languages
     queryLanguages:
@@ -1593,6 +1659,7 @@ components:
         
         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:
@@ -1609,6 +1676,7 @@ components:
         
         For example, `Gartenstühle` won't be decompounded if the `ü` consists of `u` (U+0075) and `◌̈` (U+0308).
 
+
       x-categories:
         - Languages
     enableRules:
@@ -1642,6 +1710,7 @@ components:
         
         For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
 
+
       x-categories:
         - Query strategy
     removeWordsIfNoResults:
@@ -1674,6 +1743,7 @@ components:
         
         For more information, see [Remove words to improve results](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/).
 
+
       x-categories:
         - Query strategy
     advancedSyntax:
@@ -1684,6 +1754,7 @@ components:
         
         Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
 
+
       x-categories:
         - Query strategy
     optionalWordsArray:
@@ -1696,6 +1767,7 @@ components:
       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).
 
+
       x-categories:
         - Query strategy
     optionalWords:
@@ -1726,6 +1798,7 @@ components:
         
         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'
@@ -1750,6 +1823,7 @@ components:
         
         This reduces the impact of individual attributes with a lot of content on ranking.
 
+
       x-categories:
         - Query strategy
     exactOnSingleWordQuery:
@@ -1775,6 +1849,7 @@ components:
           Only exact matches will be highlighted,
           partial and prefix matches won't.
 
+
       x-categories:
         - Query strategy
     alternativesAsExact:
@@ -1813,6 +1888,7 @@ components:
         - `multiWordsSynonym`.
           Multi-word synonyms, such as "NY" = "New York", are considered exact matches.
 
+
       x-categories:
         - Query strategy
     advancedSyntaxFeatures:
@@ -1854,12 +1930,14 @@ components:
         
         The `distinct` setting is ignored if `attributeForDistinct` is not set.
 
+
       example: 1
       oneOf:
         - type: boolean
           description: >-
             Whether deduplication is turned on. If true, only one member of a group is shown in the search results.
 
+
         - type: integer
           description: >
             Number of members of a group of records to include in the search results.
@@ -1871,6 +1949,7 @@ components:
               For example, with `hitsPerPage: 10` and `distinct: 2`, up to 20 records are returned.
               Likewise, the `nbHits` response attribute contains the number of returned groups.
 
+
           minimum: 0
           maximum: 4
           default: 0
@@ -1895,6 +1974,7 @@ components:
         
         but all occurrences of "house" are replaced by "home" in the highlighted response.
 
+
       x-categories:
         - Highlighting and Snippeting
     minProximity:
@@ -1912,6 +1992,7 @@ components:
         
         For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
 
+
       x-categories:
         - Advanced
     responseFields:
@@ -1943,6 +2024,7 @@ components:
         
         Before restricting the response size, check the impact on your search experience.
 
+
       x-categories:
         - Advanced
     maxValuesPerFacet:
@@ -1968,6 +2050,7 @@ components:
         
         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:
@@ -1982,6 +2065,7 @@ components:
         
         Otherwise, the best matching attribute is determined by the order in the `searchableAttributes` setting.
 
+
       x-categories:
         - Advanced
     order:
@@ -1991,6 +2075,7 @@ components:
         
         This setting lets you always show specific facets or facet values at the top of the list.
 
+
       type: array
       items:
         type: string
@@ -2016,6 +2101,7 @@ components:
         - `hidden`.
           Don't show facet values that aren't explicitly positioned.
 
+
       type: string
       enum:
         - count
@@ -2113,6 +2199,7 @@ components:
         
         without changing your frontend code.
 
+
       type: object
       additionalProperties: false
       properties:
@@ -2132,12 +2219,14 @@ components:
         
         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.
 
+
       oneOf:
         - type: array
           items:
@@ -2255,6 +2344,7 @@ components:
           description: >-
             Minimum score a recommendation must have to be included in the response.
 
+
         maxRecommendations:
           type: integer
           minimum: 1
@@ -2268,6 +2358,7 @@ components:
             
             the actual number of recommendations may be lower than this value.
 
+
         queryParameters:
           $ref: '#/components/schemas/searchParamsObject'
       required:
@@ -2281,6 +2372,7 @@ components:
         
         This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
 
+
       enum:
         - bought-together
     objectID:
@@ -2312,6 +2404,7 @@ components:
         
         Similarity is determined from the user interactions and attributes.
 
+
       enum:
         - related-products
     fallbackParams:
@@ -2342,6 +2435,7 @@ components:
         
         If specified, only recommendations matching the facet filter will be returned.
 
+
     facetValue:
       type: string
       description: >
@@ -2349,6 +2443,7 @@ components:
         
         If specified, only recommendations matching the facet filter will be returned.
 
+
     trendingItemsModel:
       description: >
         Trending items model.
@@ -2356,6 +2451,7 @@ components:
         
         Trending items are determined from the number of conversion events collected on them.
 
+
       type: string
       enum:
         - trending-items
@@ -2385,6 +2481,7 @@ components:
         
         This model recommends trending facet values for the specified facet attribute.
 
+
       enum:
         - trending-facets
     trendingFacets:
@@ -2413,6 +2510,7 @@ components:
         
         This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
 
+
       enum:
         - looking-similar
     lookingSimilar:
@@ -2484,12 +2582,14 @@ components:
           description: >-
             A/B test ID. This is only included in the response for indices that are part of an A/B test.
 
+
         abTestVariantID:
           type: integer
           minimum: 1
           description: >-
             Variant ID. This is only included in the response for indices that are part of an A/B test.
 
+
         aroundLatLng:
           type: string
           description: Computed geographical location.
@@ -2504,6 +2604,7 @@ components:
           description: >-
             Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
 
+
           properties:
             facetsCount:
               type: boolean
@@ -2511,6 +2612,7 @@ components:
               description: >-
                 Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
 
+
             facetValues:
               type: boolean
               title: facetValues
@@ -2521,18 +2623,21 @@ components:
               description: >-
                 Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
 
+
             rulesMatch:
               type: boolean
               title: rulesMatch
               description: >-
                 Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
 
+
             typo:
               type: boolean
               title: typo
               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
@@ -2544,6 +2649,7 @@ components:
           description: >-
             See the `facetsCount` field of the `exhaustive` object in the response.
 
+
           deprecated: true
         exhaustiveNbHits:
           type: boolean
@@ -2595,6 +2701,7 @@ components:
           description: >-
             Index name used for the query. During A/B testing, the targeted index isn't always the index used by the query.
 
+
           example: indexNameAlt
         message:
           type: string
@@ -2608,6 +2715,7 @@ components:
           description: >-
             Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
 
+
           example: george clo
         processingTimeMS:
           $ref: '#/components/schemas/processingTimeMS'
@@ -2616,17 +2724,20 @@ components:
           description: >-
             Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
 
+
         queryAfterRemoval:
           type: string
           description: >-
             Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
 
+
         redirect:
           title: redirect
           type: object
           description: >
             [Redirect results to a URL](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/redirects/), this this parameter is for internal use only.
 
+
           properties:
             index:
               type: array
@@ -2649,6 +2760,7 @@ components:
           description: >-
             Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
 
+
           example: a00dbc80a8d13c4565a442e7e2dca80a
         _automaticInsights:
           type: boolean
@@ -2787,6 +2899,7 @@ components:
           description: >-
             Distance between the matched location and the search location (in meters).
 
+
     personalization:
       type: object
       properties:
@@ -2814,12 +2927,14 @@ components:
           description: >-
             Position of the first matched word in the best matching attribute of the record.
 
+
         geoDistance:
           type: integer
           minimum: 0
           description: >-
             Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
 
+
         geoPrecision:
           type: integer
           minimum: 1
@@ -2845,11 +2960,13 @@ components:
           description: >-
             Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
 
+
         userScore:
           type: integer
           description: >-
             Overall ranking of the record, expressed as a single integer. This attribute is internal.
 
+
         words:
           type: integer
           minimum: 1
@@ -2952,6 +3069,7 @@ components:
         
         A rule context must only contain alphanumeric characters.
 
+
       example: mobile
     Condition:
       type: object
@@ -2996,6 +3114,7 @@ components:
       description: >-
         Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
 
+
       properties:
         facet:
           type: string
@@ -3009,6 +3128,7 @@ components:
             
             If false, recommendations must have the same value for the `facet` attribute.
 
+
     ParamsConsequence:
       type: object
       description: Filter or boost recommendations matching a facet filter.
@@ -3018,6 +3138,7 @@ components:
           description: >-
             Filter recommendations that match or don't match the same `facet:facet_value` combination as the viewed item.
 
+
           items:
             $ref: '#/components/schemas/AutoFacetFilter'
         filters:
@@ -3036,6 +3157,7 @@ components:
             
             If you're using a negative filter `facet:-value`, matching records rank after records that don't match.
 
+
           items:
             type: string
           example:
@@ -3089,12 +3211,14 @@ components:
           description: >-
             Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.
 
+
           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.
@@ -3110,6 +3234,7 @@ components:
         
         A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
 
+
     deletedAt:
       type: string
       example: '2023-06-27T14:42:38.831Z'
@@ -3122,6 +3247,7 @@ components:
       description: >-
         Task status, `published` if the task is completed, `notPublished` otherwise.
 
+
     parameters_query:
       type: string
       description: Search query.
@@ -3142,6 +3268,7 @@ components:
         
         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
@@ -3160,6 +3287,7 @@ components:
         
         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.

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graphcommerce/algolia-recommend",
   "homepage": "https://www.graphcommerce.org/",
   "repository": "github:graphcommerce-org/graphcommerce",
-  "version": "10.0.0-canary.66",
+  "version": "10.0.0-canary.68",
   "sideEffects": false,
   "prettier": "@graphcommerce/prettier-config-pwa",
   "eslintConfig": {
@@ -22,11 +22,11 @@
     "generate": "tsx scripts/generate-recommend-spec.mts"
   },
   "peerDependencies": {
-    "@graphcommerce/algolia-products": "^10.0.0-canary.66",
-    "@graphcommerce/graphql": "^10.0.0-canary.66",
-    "@graphcommerce/graphql-mesh": "^10.0.0-canary.66",
-    "@graphcommerce/next-config": "^10.0.0-canary.66",
-    "@graphcommerce/next-ui": "^10.0.0-canary.66",
+    "@graphcommerce/algolia-products": "^10.0.0-canary.68",
+    "@graphcommerce/graphql": "^10.0.0-canary.68",
+    "@graphcommerce/graphql-mesh": "^10.0.0-canary.68",
+    "@graphcommerce/next-config": "^10.0.0-canary.68",
+    "@graphcommerce/next-ui": "^10.0.0-canary.68",
     "react": "^19.2.0"
   },
   "devDependencies": {