@algolia/recommend 5.0.0-alpha.98 → 5.0.0-beta.1

package/dist/model/paramsConsequence.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"paramsConsequence.d.ts","sourceRoot":"","sources":["../../model/paramsConsequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,qBAAqB,CAAC,EAAE,eAAe,EAAE,CAAC;IAE1C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/promoteConsequenceObject.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Object ID and position of the recommendation you want to pin.
+ */
+export type PromoteConsequenceObject = {
+    /**
+     * Unique record identifier.
+     */
+    objectID?: string;
+    /**
+     * Index in the list of recommendations where to place this item.
+     */
+    position?: number;
+};
+//# sourceMappingURL=promoteConsequenceObject.d.ts.map

package/dist/model/promoteConsequenceObject.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"promoteConsequenceObject.d.ts","sourceRoot":"","sources":["../../model/promoteConsequenceObject.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/model/queryType.d.ts

@@ -1,5 +1,5 @@
 /**
- * Determines how query words are [interpreted as prefixes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
+ * Determines if and how query words are interpreted as prefixes.  By default, only the last query word is treated as prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower.  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/).
  */
 export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
 //# sourceMappingURL=queryType.d.ts.map

package/dist/model/rankingInfo.d.ts

@@ -1,12 +1,15 @@
 import type { MatchedGeoLocation } from './matchedGeoLocation';
 import type { Personalization } from './personalization';
+/**
+ * Object with detailed information about the record\'s ranking.
+ */
 export type RankingInfo = {
     /**
-     * This field is reserved for advanced usage.
+     * Whether a filter matched the query.
      */
     filters: number;
     /**
-     * Position of the most important matched attribute in the attributes to index list.
+     * Position of the first matched word in the best matching attribute of the record.
      */
     firstMatchedWord: number;
     /**
@@ -28,23 +31,23 @@ export type RankingInfo = {
      */
     nbTypos: number;
     /**
-     * Present and set to true if a Rule promoted the hit.
+     * Whether the record was promoted by a rule.
      */
     promoted: boolean;
     /**
-     * When the query contains more than one word, the sum of the distances between matched words (in meters).
+     * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
      */
     proximityDistance?: number;
     /**
-     * Custom ranking for the object, expressed as a single integer value.
+     * Overall ranking of the record, expressed as a single integer. This attribute is internal.
      */
     userScore: number;
     /**
-     * Number of matched words, including prefixes and typos.
+     * Number of matched words.
      */
     words: number;
     /**
-     * Wether the record are promoted by the re-ranking strategy.
+     * Whether the record is re-ranked.
      */
     promotedByReRanking?: boolean;
 };

package/dist/model/rankingInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}
+{"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}

package/dist/model/reRankingApplyFilter.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * When [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) is enabled, only records that match these filters will be affected by Dynamic Re-Ranking.
+ * Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
  */
 export type ReRankingApplyFilter = MixedSearchFilters[] | string;
 //# sourceMappingURL=reRankingApplyFilter.d.ts.map

package/dist/model/recommendHit.d.ts

@@ -6,15 +6,15 @@ import type { SnippetResult } from './snippetResult';
  */
 export type RecommendHit = Record<string, any> & {
     /**
-     * Unique object identifier.
+     * Unique record identifier.
      */
     objectID: string;
     /**
-     * Show highlighted section and words matched on a query.
+     * Surround words that match the query with HTML tags for highlighting.
      */
     _highlightResult?: Record<string, HighlightResult>;
     /**
-     * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+     * Snippets that show the context around a matching search query.
      */
     _snippetResult?: Record<string, SnippetResult>;
     _rankingInfo?: RankingInfo;

package/dist/model/recommendRule.d.ts

@@ -0,0 +1,24 @@
+import type { Condition } from './condition';
+import type { Consequence } from './consequence';
+import type { RecommendRuleMetadata } from './recommendRuleMetadata';
+/**
+ * Recommend rule.
+ */
+export type RecommendRule = {
+    _metadata?: RecommendRuleMetadata;
+    /**
+     * Unique identifier of a rule object.
+     */
+    objectID?: string;
+    condition?: Condition;
+    consequence?: Consequence;
+    /**
+     * Description of the rule\'s purpose. This can be helpful for display in the Algolia dashboard.
+     */
+    description?: string;
+    /**
+     * Indicates whether to enable the rule. If it isn\'t enabled, it isn\'t applied at query time.
+     */
+    enabled?: boolean;
+};
+//# sourceMappingURL=recommendRule.d.ts.map

package/dist/model/recommendRule.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRule.d.ts","sourceRoot":"","sources":["../../model/recommendRule.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACjD,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,SAAS,CAAC,EAAE,qBAAqB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC"}

package/dist/model/recommendRuleMetadata.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Rule metadata.
+ */
+export type RecommendRuleMetadata = {
+    /**
+     * Date and time when the object was updated, in RFC 3339 format.
+     */
+    lastUpdate?: string;
+};
+//# sourceMappingURL=recommendRuleMetadata.d.ts.map

package/dist/model/recommendRuleMetadata.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendRuleMetadata.d.ts","sourceRoot":"","sources":["../../model/recommendRuleMetadata.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC"}

package/dist/model/recommendationsHits.d.ts

@@ -1,13 +1,5 @@
 import type { RecommendationsHit } from './recommendationsHit';
 export type RecommendationsHits = {
     hits: RecommendationsHit[];
-    /**
-     * Text to search for in an index.
-     */
-    query?: string;
-    /**
-     * URL-encoded string of all search parameters.
-     */
-    params?: string;
 };
 //# sourceMappingURL=recommendationsHits.d.ts.map

package/dist/model/recommendationsHits.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommendationsHits.d.ts","sourceRoot":"","sources":["../../model/recommendationsHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAE3B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"recommendationsHits.d.ts","sourceRoot":"","sources":["../../model/recommendationsHits.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,kBAAkB,EAAE,CAAC;CAC5B,CAAC"}

package/dist/model/recommendationsRequest.d.ts

@@ -1,6 +1,8 @@
-import type { RecommendationsQuery } from './recommendationsQuery';
+import type { BoughtTogetherQuery } from './boughtTogetherQuery';
+import type { LookingSimilarQuery } from './lookingSimilarQuery';
 import type { RecommendedForYouQuery } from './recommendedForYouQuery';
+import type { RelatedQuery } from './relatedQuery';
 import type { TrendingFacetsQuery } from './trendingFacetsQuery';
 import type { TrendingItemsQuery } from './trendingItemsQuery';
-export type RecommendationsRequest = RecommendationsQuery | RecommendedForYouQuery | TrendingFacetsQuery | TrendingItemsQuery;
+export type RecommendationsRequest = BoughtTogetherQuery | LookingSimilarQuery | RecommendedForYouQuery | RelatedQuery | TrendingFacetsQuery | TrendingItemsQuery;
 //# sourceMappingURL=recommendationsRequest.d.ts.map

package/dist/model/recommendationsRequest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,oBAAoB,GACpB,sBAAsB,GACtB,mBAAmB,GACnB,kBAAkB,CAAC"}
+{"version":3,"file":"recommendationsRequest.d.ts","sourceRoot":"","sources":["../../model/recommendationsRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,sBAAsB,GAC9B,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,YAAY,GACZ,mBAAmB,GACnB,kBAAkB,CAAC"}

package/dist/model/recommendedForYou.d.ts

@@ -0,0 +1,7 @@
+import type { FallbackParams } from './fallbackParams';
+import type { RecommendedForYouModel } from './recommendedForYouModel';
+export type RecommendedForYou = {
+    model: RecommendedForYouModel;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=recommendedForYou.d.ts.map

package/dist/model/recommendedForYou.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"recommendedForYou.d.ts","sourceRoot":"","sources":["../../model/recommendedForYou.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,iBAAiB,GAAG;IAC9B,KAAK,EAAE,sBAAsB,CAAC;IAE9B,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/recommendedForYouModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Recommended for you model.
+ * \"Recommened for you\" model.
  */
 export type RecommendedForYouModel = 'recommended-for-you';
 //# sourceMappingURL=recommendedForYouModel.d.ts.map

package/dist/model/recommendedForYouQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseRecommendedForYouQuery } from './baseRecommendedForYouQuery';
-export type RecommendedForYouQuery = BaseRecommendedForYouQuery & BaseRecommendRequest;
+import type { RecommendedForYou } from './recommendedForYou';
+export type RecommendedForYouQuery = BaseRecommendRequest & RecommendedForYou;
 //# sourceMappingURL=recommendedForYouQuery.d.ts.map

package/dist/model/recommendedForYouQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E,MAAM,MAAM,sBAAsB,GAAG,0BAA0B,GAC7D,oBAAoB,CAAC"}
+{"version":3,"file":"recommendedForYouQuery.d.ts","sourceRoot":"","sources":["../../model/recommendedForYouQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,GAAG,iBAAiB,CAAC"}

package/dist/model/relatedModel.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Related products or similar content model.  This model recommends items that are similar to the item with the ID `objectID`. Similarity is determined from the user interactions and attributes.
+ */
+export type RelatedModel = 'related-products';
+//# sourceMappingURL=relatedModel.d.ts.map

package/dist/model/relatedModel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relatedModel.d.ts","sourceRoot":"","sources":["../../model/relatedModel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,kBAAkB,CAAC"}

package/dist/model/relatedProducts.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { RelatedModel } from './relatedModel';
+export type RelatedProducts = {
+    model: RelatedModel;
+    /**
+     * Unique record identifier.
+     */
+    objectID: string;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=relatedProducts.d.ts.map

package/dist/model/relatedProducts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relatedProducts.d.ts","sourceRoot":"","sources":["../../model/relatedProducts.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,eAAe,GAAG;IAC5B,KAAK,EAAE,YAAY,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/relatedQuery.d.ts

@@ -0,0 +1,4 @@
+import type { BaseRecommendRequest } from './baseRecommendRequest';
+import type { RelatedProducts } from './relatedProducts';
+export type RelatedQuery = BaseRecommendRequest & RelatedProducts;
+//# sourceMappingURL=relatedQuery.d.ts.map

package/dist/model/relatedQuery.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"relatedQuery.d.ts","sourceRoot":"","sources":["../../model/relatedQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,YAAY,GAAG,oBAAoB,GAAG,eAAe,CAAC"}

package/dist/model/removeStopWords.d.ts

@@ -1,5 +1,6 @@
+import type { SupportedLanguage } from './supportedLanguage';
 /**
- * Removes stop (common) words from the query before executing it. `removeStopWords` is used in conjunction with the `queryLanguages` setting. _list_: language ISO codes for which stop words should be enabled. This list will override any values that you may have set in `queryLanguages`. _true_: enables the stop words feature, ensuring that stop words are removed from consideration in a search. The languages supported here are either [every language](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/) (this is the default) or those set by `queryLanguages`. _false_: turns off the stop words feature, allowing stop words to be taken into account in a search.
+ * Removes stop words from the search query.  Stop words are common words like articles, conjunctions, prepositions, or pronouns that have little or no meaning on their own. In English, \"the\", \"a\", or \"and\" are stop words.  You should only use this feature for the languages used in your index.
  */
-export type RemoveStopWords = string[] | boolean;
+export type RemoveStopWords = SupportedLanguage[] | boolean;
 //# sourceMappingURL=removeStopWords.d.ts.map

package/dist/model/removeStopWords.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../model/removeStopWords.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,EAAE,GAAG,OAAO,CAAC"}
+{"version":3,"file":"removeStopWords.d.ts","sourceRoot":"","sources":["../../model/removeStopWords.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC"}

package/dist/model/removeWordsIfNoResults.d.ts

@@ -1,5 +1,5 @@
 /**
- * Strategy to [remove words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/in-depth/why-use-remove-words-if-no-results/) from the query when it doesn\'t match any hits.
+ * Strategy for removing words from the query when it doesn\'t return any results. This helps to avoid returning empty search results.  - `none`.   No words are removed when a query doesn\'t return results.  - `lastWords`.   Treat the last (then second to last, then third to last) word as optional,   until there are results or at most 5 words have been removed.  - `firstWords`.   Treat the first (then second, then third) word as optional,   until there are results or at most 5 words have been removed.  - `allOptional`.   Treat all words as optional.  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/).
  */
 export type RemoveWordsIfNoResults = 'allOptional' | 'firstWords' | 'lastWords' | 'none';
 //# sourceMappingURL=removeWordsIfNoResults.d.ts.map

package/dist/model/renderingContent.d.ts

@@ -1,6 +1,6 @@
 import type { FacetOrdering } from './facetOrdering';
 /**
- * Extra content for the search UI, for example, to control the [ordering and display of facets](https://www.algolia.com/doc/guides/managing-results/rules/merchandising-and-promoting/how-to/merchandising-facets/#merchandise-facets-and-their-values-in-the-manual-editor). You can set a default value and dynamically override it with [Rules](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/).
+ * 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 without changing your frontend code.
  */
 export type RenderingContent = {
     facetOrdering?: FacetOrdering;

package/dist/model/searchParams.d.ts

@@ -0,0 +1,3 @@
+import type { SearchParamsObject } from './searchParamsObject';
+export type SearchParams = Record<string, any> & SearchParamsObject;
+//# sourceMappingURL=searchParams.d.ts.map

package/dist/model/searchParams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"searchParams.d.ts","sourceRoot":"","sources":["../../model/searchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB,CAAC"}

package/dist/model/searchParamsObject.d.ts

@@ -1,4 +1,7 @@
 import type { BaseSearchParams } from './baseSearchParams';
 import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
+/**
+ * Each parameter value, including the `query` must not be larger than 512 bytes.
+ */
 export type SearchParamsObject = BaseSearchParams & IndexSettingsAsSearchParams;
 //# sourceMappingURL=searchParamsObject.d.ts.map

package/dist/model/searchParamsObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}
+{"version":3,"file":"searchParamsObject.d.ts","sourceRoot":"","sources":["../../model/searchParamsObject.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAC;AAEjF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,gBAAgB,GAAG,2BAA2B,CAAC"}

package/dist/model/searchParamsQuery.d.ts

@@ -1,6 +1,6 @@
 export type SearchParamsQuery = {
     /**
-     * Text to search for in an index.
+     * Search query.
      */
     query?: string;
 };

package/dist/model/searchRecommendRulesParams.d.ts

@@ -1,17 +1,17 @@
 /**
- * Recommend rules search parameters.
+ * Recommend rules parameters.
  */
 export type SearchRecommendRulesParams = {
     /**
-     * Full-text query.
+     * Search query.
      */
     query?: string;
     /**
-     * Restricts responses to the specified [contextual rule](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#creating-contextual-rules).
+     * Only search for rules with matching context.
      */
     context?: string;
     /**
-     * Requested page (the first page is page 0).
+     * Requested page of the API response.
      */
     page?: number;
     /**
@@ -19,8 +19,20 @@ export type SearchRecommendRulesParams = {
      */
     hitsPerPage?: number;
     /**
-     * Restricts responses to enabled rules. When absent (default), _all_ rules are retrieved.
+     * Whether to only show rules where the value of their `enabled` property matches this parameter. If absent, show all rules, regardless of their `enabled` property.
      */
-    enabled?: boolean | null;
+    enabled?: boolean;
+    /**
+     * Filter expression. This only searches for rules matching the filter expression.
+     */
+    filters?: string;
+    /**
+     * Include facets and facet values in the response. Use `[\'*\']` to include all facets.
+     */
+    facets?: string[];
+    /**
+     * Maximum number of values to return for each facet.
+     */
+    maxValuesPerFacet?: number;
 };
 //# sourceMappingURL=searchRecommendRulesParams.d.ts.map

package/dist/model/searchRecommendRulesParams.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRecommendRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;CAC1B,CAAC"}
+{"version":3,"file":"searchRecommendRulesParams.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesParams.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;CAC5B,CAAC"}

package/dist/model/searchRecommendRulesResponse.d.ts

@@ -1,19 +1,19 @@
-import type { RuleResponse } from './ruleResponse';
+import type { RecommendRule } from './recommendRule';
 export type SearchRecommendRulesResponse = {
     /**
-     * Fetched rules.
+     * Recommend rules that match the search criteria.
      */
-    hits: RuleResponse[];
+    hits: RecommendRule[];
     /**
-     * Number of hits the search query matched.
+     * Number of results (hits).
      */
     nbHits: number;
     /**
-     * Page to retrieve (the first page is `0`, not `1`).
+     * Page of search results to retrieve.
      */
     page: number;
     /**
-     * Number of pages of results for the current query.
+     * Number of pages of results.
      */
     nbPages: number;
 };

package/dist/model/searchRecommendRulesResponse.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"searchRecommendRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,YAAY,EAAE,CAAC;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}
+{"version":3,"file":"searchRecommendRulesResponse.d.ts","sourceRoot":"","sources":["../../model/searchRecommendRulesResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,IAAI,EAAE,aAAa,EAAE,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC"}

package/dist/model/semanticSearch.d.ts

@@ -1,9 +1,9 @@
 /**
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
  */
 export type SemanticSearch = {
     /**
-     * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
+     * Indices from which to collect click and conversion events.  If null, the current index and all its replicas are used.
      */
     eventSources?: string[] | null;
 };

package/dist/model/snippetResult.d.ts

@@ -1,3 +1,3 @@
 import type { SnippetResultOption } from './snippetResultOption';
-export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption;
+export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
 //# sourceMappingURL=snippetResult.d.ts.map

package/dist/model/snippetResult.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,CAAC"}
+{"version":3,"file":"snippetResult.d.ts","sourceRoot":"","sources":["../../model/snippetResult.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,aAAa,GACrB,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GACnC,mBAAmB,GACnB,mBAAmB,EAAE,CAAC"}

package/dist/model/snippetResultOption.d.ts

@@ -1,10 +1,10 @@
 import type { MatchLevel } from './matchLevel';
 /**
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
+ * Snippets that show the context around a matching search query.
  */
 export type SnippetResultOption = {
     /**
-     * Markup text with `facetQuery` matches highlighted.
+     * Highlighted attribute value, including HTML tags.
      */
     value: string;
     matchLevel: MatchLevel;

package/dist/model/sortRemainingBy.d.ts

@@ -1,5 +1,5 @@
 /**
- * How to display the remaining items:    - `count`: facet count (descending).   - `alpha`: alphabetical (ascending).   - `hidden`: show only pinned values.
+ * Order of facet values that aren\'t explicitly positioned with the `order` setting.  - `count`.   Order remaining facet values by decreasing count.   The count is the number of matching records containing this facet value.  - `alpha`.   Sort facet values alphabetically.  - `hidden`.   Don\'t show facet values that aren\'t explicitly positioned.
  */
 export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
 //# sourceMappingURL=sortRemainingBy.d.ts.map

package/dist/model/supportedLanguage.d.ts

@@ -0,0 +1,5 @@
+/**
+ * ISO code for a supported language.
+ */
+export type SupportedLanguage = 'af' | 'ar' | 'az' | 'bg' | 'bn' | 'ca' | 'cs' | 'cy' | 'da' | 'de' | 'el' | 'en' | 'eo' | 'es' | 'et' | 'eu' | 'fa' | 'fi' | 'fo' | 'fr' | 'ga' | 'gl' | 'he' | 'hi' | 'hu' | 'hy' | 'id' | 'is' | 'it' | 'ja' | 'ka' | 'kk' | 'ko' | 'ku' | 'ky' | 'lt' | 'lv' | 'mi' | 'mn' | 'mr' | 'ms' | 'mt' | 'nb' | 'nl' | 'no' | 'ns' | 'pl' | 'ps' | 'pt-br' | 'pt' | 'qu' | 'ro' | 'ru' | 'sk' | 'sq' | 'sv' | 'sw' | 'ta' | 'te' | 'th' | 'tl' | 'tn' | 'tr' | 'tt' | 'uk' | 'ur' | 'uz' | 'zh';
+//# sourceMappingURL=supportedLanguage.d.ts.map

package/dist/model/supportedLanguage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportedLanguage.d.ts","sourceRoot":"","sources":["../../model/supportedLanguage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,OAAO,GACP,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,CAAC"}

package/dist/model/tagFilters.d.ts

@@ -1,6 +1,6 @@
 import type { MixedSearchFilters } from './mixedSearchFilters';
 /**
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
+ * Filter the search by values of the special `_tags` attribute.  **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.**  Different from regular facets, `_tags` can only be used for filtering (including or excluding records). You won\'t get a facet count. The same combination and escaping rules apply as for `facetFilters`.
  */
 export type TagFilters = MixedSearchFilters[] | string;
 //# sourceMappingURL=tagFilters.d.ts.map

package/dist/model/taskStatus.d.ts

@@ -1,5 +1,5 @@
 /**
- * _published_ if the task has been processed, _notPublished_ otherwise.
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
  */
 export type TaskStatus = 'notPublished' | 'published';
 //# sourceMappingURL=taskStatus.d.ts.map

package/dist/model/trendingFacetHit.d.ts

@@ -7,11 +7,11 @@ export type TrendingFacetHit = {
      */
     _score: number;
     /**
-     * Facet name for trending models.
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
      */
     facetName: string;
     /**
-     * Facet value for trending models.
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
      */
     facetValue: string;
 };

package/dist/model/trendingFacets.d.ts

@@ -0,0 +1,11 @@
+import type { FallbackParams } from './fallbackParams';
+import type { TrendingFacetsModel } from './trendingFacetsModel';
+export type TrendingFacets = {
+    /**
+     * Facet attribute for which to retrieve trending facet values.
+     */
+    facetName: any | null;
+    model: TrendingFacetsModel;
+    fallbackParameters?: FallbackParams;
+};
+//# sourceMappingURL=trendingFacets.d.ts.map

package/dist/model/trendingFacets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingFacets.d.ts","sourceRoot":"","sources":["../../model/trendingFacets.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAEjE,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,GAAG,GAAG,IAAI,CAAC;IAEtB,KAAK,EAAE,mBAAmB,CAAC;IAE3B,kBAAkB,CAAC,EAAE,cAAc,CAAC;CACrC,CAAC"}

package/dist/model/trendingFacetsModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Trending facets model.
+ * Trending facet values model.  This model recommends trending facet values for the specified facet attribute.
  */
 export type TrendingFacetsModel = 'trending-facets';
 //# sourceMappingURL=trendingFacetsModel.d.ts.map

package/dist/model/trendingFacetsQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingFacetsQuery } from './baseTrendingFacetsQuery';
-export type TrendingFacetsQuery = BaseRecommendRequest & BaseTrendingFacetsQuery;
+import type { TrendingFacets } from './trendingFacets';
+export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
 //# sourceMappingURL=trendingFacetsQuery.d.ts.map

package/dist/model/trendingFacetsQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEzE,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GACpD,uBAAuB,CAAC"}
+{"version":3,"file":"trendingFacetsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingFacetsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,cAAc,CAAC"}

package/dist/model/trendingItems.d.ts

@@ -0,0 +1,15 @@
+import type { SearchParamsObject } from './searchParamsObject';
+import type { TrendingItemsModel } from './trendingItemsModel';
+export type TrendingItems = {
+    /**
+     * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetName: string;
+    /**
+     * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
+     */
+    facetValue: string;
+    model: TrendingItemsModel;
+    fallbackParameters?: SearchParamsObject;
+};
+//# sourceMappingURL=trendingItems.d.ts.map

package/dist/model/trendingItems.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trendingItems.d.ts","sourceRoot":"","sources":["../../model/trendingItems.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,aAAa,GAAG;IAC1B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB,KAAK,EAAE,kBAAkB,CAAC;IAE1B,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}

package/dist/model/trendingItemsModel.d.ts

@@ -1,5 +1,5 @@
 /**
- * Trending items model.
+ * Trending items model.  Trending items are determined from the number of conversion events collected on them.
  */
 export type TrendingItemsModel = 'trending-items';
 //# sourceMappingURL=trendingItemsModel.d.ts.map

package/dist/model/trendingItemsQuery.d.ts

@@ -1,4 +1,4 @@
 import type { BaseRecommendRequest } from './baseRecommendRequest';
-import type { BaseTrendingItemsQuery } from './baseTrendingItemsQuery';
-export type TrendingItemsQuery = BaseRecommendRequest & BaseTrendingItemsQuery;
+import type { TrendingItems } from './trendingItems';
+export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
 //# sourceMappingURL=trendingItemsQuery.d.ts.map