@algolia/recommend 5.0.0-alpha.99 → 5.0.0-beta.10

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 (290) hide show
  1. package/LICENSE +21 -0
  2. package/dist/builds/browser.d.ts +21 -3
  3. package/dist/builds/browser.d.ts.map +1 -1
  4. package/dist/builds/node.d.ts +21 -3
  5. package/dist/builds/node.d.ts.map +1 -1
  6. package/dist/model/aroundPrecision.d.ts +1 -1
  7. package/dist/model/aroundPrecisionFromValueInner.d.ts +9 -0
  8. package/dist/model/aroundPrecisionFromValueInner.d.ts.map +1 -1
  9. package/dist/model/aroundRadius.d.ts +1 -1
  10. package/dist/model/aroundRadiusAll.d.ts +3 -0
  11. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  12. package/dist/model/autoFacetFilter.d.ts +14 -0
  13. package/dist/model/autoFacetFilter.d.ts.map +1 -0
  14. package/dist/model/baseRecommendRequest.d.ts +6 -4
  15. package/dist/model/baseRecommendRequest.d.ts.map +1 -1
  16. package/dist/model/baseSearchParamsWithoutQuery.d.ts +26 -29
  17. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  18. package/dist/model/baseSearchResponse.d.ts +8 -20
  19. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  20. package/dist/model/boughtTogetherQuery.d.ts +4 -0
  21. package/dist/model/boughtTogetherQuery.d.ts.map +1 -0
  22. package/dist/model/clientMethodProps.d.ts +18 -11
  23. package/dist/model/clientMethodProps.d.ts.map +1 -1
  24. package/dist/model/condition.d.ts +6 -9
  25. package/dist/model/condition.d.ts.map +1 -1
  26. package/dist/model/consequence.d.ts +9 -17
  27. package/dist/model/consequence.d.ts.map +1 -1
  28. package/dist/model/deletedAtResponse.d.ts +2 -2
  29. package/dist/model/distinct.d.ts +1 -1
  30. package/dist/model/exactOnSingleWordQuery.d.ts +1 -1
  31. package/dist/model/facetFilters.d.ts +2 -3
  32. package/dist/model/facetFilters.d.ts.map +1 -1
  33. package/dist/model/facetOrdering.d.ts +2 -2
  34. package/dist/model/facets.d.ts +2 -2
  35. package/dist/model/fallbackParams.d.ts +3 -0
  36. package/dist/model/fallbackParams.d.ts.map +1 -0
  37. package/dist/model/fbtModel.d.ts +5 -0
  38. package/dist/model/fbtModel.d.ts.map +1 -0
  39. package/dist/model/frequentlyBoughtTogether.d.ts +9 -0
  40. package/dist/model/frequentlyBoughtTogether.d.ts.map +1 -0
  41. package/dist/model/getRecommendationsParams.d.ts +2 -2
  42. package/dist/model/hideConsequenceObject.d.ts +10 -0
  43. package/dist/model/hideConsequenceObject.d.ts.map +1 -0
  44. package/dist/model/highlightResult.d.ts +1 -1
  45. package/dist/model/highlightResult.d.ts.map +1 -1
  46. package/dist/model/highlightResultOption.d.ts +3 -3
  47. package/dist/model/ignorePlurals.d.ts +3 -2
  48. package/dist/model/ignorePlurals.d.ts.map +1 -1
  49. package/dist/model/index.d.ts +23 -24
  50. package/dist/model/index.d.ts.map +1 -1
  51. package/dist/model/indexSettingsAsSearchParams.d.ts +32 -35
  52. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  53. package/dist/model/lookingSimilar.d.ts +11 -0
  54. package/dist/model/lookingSimilar.d.ts.map +1 -0
  55. package/dist/model/lookingSimilarModel.d.ts +5 -0
  56. package/dist/model/lookingSimilarModel.d.ts.map +1 -0
  57. package/dist/model/lookingSimilarQuery.d.ts +4 -0
  58. package/dist/model/lookingSimilarQuery.d.ts.map +1 -0
  59. package/dist/model/matchLevel.d.ts +1 -1
  60. package/dist/model/mode.d.ts +1 -1
  61. package/dist/model/numericFilters.d.ts +2 -3
  62. package/dist/model/numericFilters.d.ts.map +1 -1
  63. package/dist/model/optionalFilters.d.ts +2 -3
  64. package/dist/model/optionalFilters.d.ts.map +1 -1
  65. package/dist/model/paramsConsequence.d.ts +19 -0
  66. package/dist/model/paramsConsequence.d.ts.map +1 -0
  67. package/dist/model/promoteConsequenceObject.d.ts +14 -0
  68. package/dist/model/promoteConsequenceObject.d.ts.map +1 -0
  69. package/dist/model/queryType.d.ts +1 -1
  70. package/dist/model/rankingInfo.d.ts +13 -10
  71. package/dist/model/rankingInfo.d.ts.map +1 -1
  72. package/dist/model/reRankingApplyFilter.d.ts +2 -3
  73. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  74. package/dist/model/recommendHit.d.ts +3 -3
  75. package/dist/model/recommendRule.d.ts +24 -0
  76. package/dist/model/recommendRule.d.ts.map +1 -0
  77. package/dist/model/recommendRuleMetadata.d.ts +10 -0
  78. package/dist/model/recommendRuleMetadata.d.ts.map +1 -0
  79. package/dist/model/recommendationsHits.d.ts +0 -8
  80. package/dist/model/recommendationsHits.d.ts.map +1 -1
  81. package/dist/model/recommendationsRequest.d.ts +4 -2
  82. package/dist/model/recommendationsRequest.d.ts.map +1 -1
  83. package/dist/model/recommendationsResults.d.ts +2 -1
  84. package/dist/model/recommendationsResults.d.ts.map +1 -1
  85. package/dist/model/recommendedForYou.d.ts +7 -0
  86. package/dist/model/recommendedForYou.d.ts.map +1 -0
  87. package/dist/model/recommendedForYouModel.d.ts +1 -1
  88. package/dist/model/recommendedForYouQuery.d.ts +2 -2
  89. package/dist/model/recommendedForYouQuery.d.ts.map +1 -1
  90. package/dist/model/redirect.d.ts +1 -1
  91. package/dist/model/redirectURL.d.ts +7 -0
  92. package/dist/model/redirectURL.d.ts.map +1 -0
  93. package/dist/model/relatedModel.d.ts +5 -0
  94. package/dist/model/relatedModel.d.ts.map +1 -0
  95. package/dist/model/relatedProducts.d.ts +11 -0
  96. package/dist/model/relatedProducts.d.ts.map +1 -0
  97. package/dist/model/relatedQuery.d.ts +4 -0
  98. package/dist/model/relatedQuery.d.ts.map +1 -0
  99. package/dist/model/removeStopWords.d.ts +3 -2
  100. package/dist/model/removeStopWords.d.ts.map +1 -1
  101. package/dist/model/removeWordsIfNoResults.d.ts +1 -1
  102. package/dist/model/renderingContent.d.ts +3 -1
  103. package/dist/model/renderingContent.d.ts.map +1 -1
  104. package/dist/model/searchPagination.d.ts +19 -0
  105. package/dist/model/searchPagination.d.ts.map +1 -0
  106. package/dist/model/searchParams.d.ts +3 -0
  107. package/dist/model/searchParams.d.ts.map +1 -0
  108. package/dist/model/searchParamsObject.d.ts +3 -0
  109. package/dist/model/searchParamsObject.d.ts.map +1 -1
  110. package/dist/model/searchParamsQuery.d.ts +1 -1
  111. package/dist/model/searchRecommendRulesParams.d.ts +18 -6
  112. package/dist/model/searchRecommendRulesParams.d.ts.map +1 -1
  113. package/dist/model/searchRecommendRulesResponse.d.ts +6 -6
  114. package/dist/model/searchRecommendRulesResponse.d.ts.map +1 -1
  115. package/dist/model/semanticSearch.d.ts +2 -2
  116. package/dist/model/snippetResult.d.ts +1 -1
  117. package/dist/model/snippetResult.d.ts.map +1 -1
  118. package/dist/model/snippetResultOption.d.ts +2 -2
  119. package/dist/model/sortRemainingBy.d.ts +1 -1
  120. package/dist/model/supportedLanguage.d.ts +5 -0
  121. package/dist/model/supportedLanguage.d.ts.map +1 -0
  122. package/dist/model/tagFilters.d.ts +2 -3
  123. package/dist/model/tagFilters.d.ts.map +1 -1
  124. package/dist/model/taskStatus.d.ts +1 -1
  125. package/dist/model/trendingFacetHit.d.ts +2 -2
  126. package/dist/model/trendingFacets.d.ts +11 -0
  127. package/dist/model/trendingFacets.d.ts.map +1 -0
  128. package/dist/model/trendingFacetsModel.d.ts +1 -1
  129. package/dist/model/trendingFacetsQuery.d.ts +2 -2
  130. package/dist/model/trendingFacetsQuery.d.ts.map +1 -1
  131. package/dist/model/trendingItems.d.ts +15 -0
  132. package/dist/model/trendingItems.d.ts.map +1 -0
  133. package/dist/model/trendingItemsModel.d.ts +1 -1
  134. package/dist/model/trendingItemsQuery.d.ts +2 -2
  135. package/dist/model/trendingItemsQuery.d.ts.map +1 -1
  136. package/dist/model/typoTolerance.d.ts +1 -1
  137. package/dist/model/typoToleranceEnum.d.ts +3 -0
  138. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  139. package/dist/model/value.d.ts +5 -1
  140. package/dist/model/value.d.ts.map +1 -1
  141. package/dist/recommend.cjs +61 -45
  142. package/dist/recommend.esm.browser.js +58 -54
  143. package/dist/recommend.esm.node.js +61 -45
  144. package/dist/recommend.umd.js +2 -2
  145. package/dist/src/recommendClient.d.ts +36 -34
  146. package/dist/src/recommendClient.d.ts.map +1 -1
  147. package/model/aroundPrecision.ts +1 -1
  148. package/model/aroundPrecisionFromValueInner.ts +9 -0
  149. package/model/aroundRadius.ts +1 -1
  150. package/model/aroundRadiusAll.ts +3 -0
  151. package/model/autoFacetFilter.ts +16 -0
  152. package/model/baseRecommendRequest.ts +8 -4
  153. package/model/baseSearchParamsWithoutQuery.ts +26 -30
  154. package/model/baseSearchResponse.ts +9 -24
  155. package/model/{recommendationsQuery.ts → boughtTogetherQuery.ts} +3 -3
  156. package/model/clientMethodProps.ts +19 -11
  157. package/model/condition.ts +6 -12
  158. package/model/consequence.ts +9 -19
  159. package/model/deletedAtResponse.ts +2 -2
  160. package/model/distinct.ts +1 -1
  161. package/model/exactOnSingleWordQuery.ts +1 -1
  162. package/model/facetFilters.ts +2 -4
  163. package/model/facetOrdering.ts +2 -2
  164. package/model/facets.ts +2 -2
  165. package/model/{recommendationModels.ts → fallbackParams.ts} +3 -4
  166. package/model/fbtModel.ts +6 -0
  167. package/model/{consequenceHide.ts → frequentlyBoughtTogether.ts} +6 -5
  168. package/model/getRecommendationsParams.ts +2 -2
  169. package/model/hideConsequenceObject.ts +11 -0
  170. package/model/highlightResult.ts +1 -0
  171. package/model/highlightResultOption.ts +3 -3
  172. package/model/ignorePlurals.ts +4 -2
  173. package/model/index.ts +23 -24
  174. package/model/indexSettingsAsSearchParams.ts +32 -36
  175. package/model/lookingSimilar.ts +15 -0
  176. package/model/lookingSimilarModel.ts +6 -0
  177. package/model/lookingSimilarQuery.ts +6 -0
  178. package/model/matchLevel.ts +1 -1
  179. package/model/mode.ts +1 -1
  180. package/model/numericFilters.ts +2 -4
  181. package/model/optionalFilters.ts +2 -4
  182. package/model/paramsConsequence.ts +23 -0
  183. package/model/promoteConsequenceObject.ts +16 -0
  184. package/model/queryType.ts +1 -1
  185. package/model/rankingInfo.ts +13 -10
  186. package/model/reRankingApplyFilter.ts +2 -4
  187. package/model/recommendHit.ts +3 -3
  188. package/model/{ruleResponse.ts → recommendRule.ts} +7 -10
  189. package/model/{ruleResponseMetadata.ts → recommendRuleMetadata.ts} +5 -2
  190. package/model/recommendationsHits.ts +0 -10
  191. package/model/recommendationsRequest.ts +6 -2
  192. package/model/recommendationsResults.ts +4 -1
  193. package/model/{baseRecommendedForYouQuery.ts → recommendedForYou.ts} +3 -5
  194. package/model/recommendedForYouModel.ts +1 -1
  195. package/model/recommendedForYouQuery.ts +2 -3
  196. package/model/redirect.ts +1 -1
  197. package/model/{editType.ts → redirectURL.ts} +4 -2
  198. package/model/relatedModel.ts +6 -0
  199. package/model/relatedProducts.ts +15 -0
  200. package/model/relatedQuery.ts +6 -0
  201. package/model/removeStopWords.ts +4 -2
  202. package/model/removeWordsIfNoResults.ts +1 -1
  203. package/model/renderingContent.ts +4 -1
  204. package/model/searchPagination.ts +23 -0
  205. package/model/{mixedSearchFilters.ts → searchParams.ts} +3 -1
  206. package/model/searchParamsObject.ts +3 -0
  207. package/model/searchParamsQuery.ts +1 -1
  208. package/model/searchRecommendRulesParams.ts +21 -6
  209. package/model/searchRecommendRulesResponse.ts +6 -6
  210. package/model/semanticSearch.ts +2 -2
  211. package/model/snippetResult.ts +2 -1
  212. package/model/snippetResultOption.ts +2 -2
  213. package/model/sortRemainingBy.ts +1 -1
  214. package/model/supportedLanguage.ts +74 -0
  215. package/model/tagFilters.ts +2 -4
  216. package/model/taskStatus.ts +1 -1
  217. package/model/trendingFacetHit.ts +2 -2
  218. package/model/{baseTrendingFacetsQuery.ts → trendingFacets.ts} +7 -4
  219. package/model/trendingFacetsModel.ts +1 -1
  220. package/model/trendingFacetsQuery.ts +2 -3
  221. package/model/trendingItems.ts +20 -0
  222. package/model/trendingItemsModel.ts +1 -1
  223. package/model/trendingItemsQuery.ts +2 -2
  224. package/model/typoTolerance.ts +1 -1
  225. package/model/typoToleranceEnum.ts +3 -0
  226. package/model/value.ts +6 -1
  227. package/package.json +11 -8
  228. package/dist/model/anchoring.d.ts +0 -5
  229. package/dist/model/anchoring.d.ts.map +0 -1
  230. package/dist/model/automaticFacetFilter.d.ts +0 -18
  231. package/dist/model/automaticFacetFilter.d.ts.map +0 -1
  232. package/dist/model/automaticFacetFilters.d.ts +0 -6
  233. package/dist/model/automaticFacetFilters.d.ts.map +0 -1
  234. package/dist/model/baseRecommendationsQuery.d.ts +0 -12
  235. package/dist/model/baseRecommendationsQuery.d.ts.map +0 -1
  236. package/dist/model/baseRecommendedForYouQuery.d.ts +0 -8
  237. package/dist/model/baseRecommendedForYouQuery.d.ts.map +0 -1
  238. package/dist/model/baseRecommendedForYouQueryParameters.d.ts +0 -7
  239. package/dist/model/baseRecommendedForYouQueryParameters.d.ts.map +0 -1
  240. package/dist/model/baseTrendingFacetsQuery.d.ts +0 -9
  241. package/dist/model/baseTrendingFacetsQuery.d.ts.map +0 -1
  242. package/dist/model/baseTrendingItemsQuery.d.ts +0 -16
  243. package/dist/model/baseTrendingItemsQuery.d.ts.map +0 -1
  244. package/dist/model/consequenceHide.d.ts +0 -10
  245. package/dist/model/consequenceHide.d.ts.map +0 -1
  246. package/dist/model/consequenceParams.d.ts +0 -5
  247. package/dist/model/consequenceParams.d.ts.map +0 -1
  248. package/dist/model/consequenceQuery.d.ts +0 -6
  249. package/dist/model/consequenceQuery.d.ts.map +0 -1
  250. package/dist/model/consequenceQueryObject.d.ts +0 -12
  251. package/dist/model/consequenceQueryObject.d.ts.map +0 -1
  252. package/dist/model/edit.d.ts +0 -13
  253. package/dist/model/edit.d.ts.map +0 -1
  254. package/dist/model/editType.d.ts +0 -5
  255. package/dist/model/editType.d.ts.map +0 -1
  256. package/dist/model/mixedSearchFilters.d.ts +0 -2
  257. package/dist/model/mixedSearchFilters.d.ts.map +0 -1
  258. package/dist/model/params.d.ts +0 -13
  259. package/dist/model/params.d.ts.map +0 -1
  260. package/dist/model/promote.d.ts +0 -4
  261. package/dist/model/promote.d.ts.map +0 -1
  262. package/dist/model/promoteObjectID.d.ts +0 -14
  263. package/dist/model/promoteObjectID.d.ts.map +0 -1
  264. package/dist/model/promoteObjectIDs.d.ts +0 -14
  265. package/dist/model/promoteObjectIDs.d.ts.map +0 -1
  266. package/dist/model/recommendationModels.d.ts +0 -5
  267. package/dist/model/recommendationModels.d.ts.map +0 -1
  268. package/dist/model/recommendationsQuery.d.ts +0 -4
  269. package/dist/model/recommendationsQuery.d.ts.map +0 -1
  270. package/dist/model/recommendedForYouQueryParameters.d.ts +0 -4
  271. package/dist/model/recommendedForYouQueryParameters.d.ts.map +0 -1
  272. package/dist/model/ruleResponse.d.ts +0 -27
  273. package/dist/model/ruleResponse.d.ts.map +0 -1
  274. package/dist/model/ruleResponseMetadata.d.ts +0 -7
  275. package/dist/model/ruleResponseMetadata.d.ts.map +0 -1
  276. package/model/anchoring.ts +0 -6
  277. package/model/automaticFacetFilter.ts +0 -21
  278. package/model/automaticFacetFilters.ts +0 -8
  279. package/model/baseRecommendationsQuery.ts +0 -17
  280. package/model/baseRecommendedForYouQueryParameters.ts +0 -8
  281. package/model/baseTrendingItemsQuery.ts +0 -22
  282. package/model/consequenceParams.ts +0 -9
  283. package/model/consequenceQuery.ts +0 -8
  284. package/model/consequenceQueryObject.ts +0 -15
  285. package/model/edit.ts +0 -17
  286. package/model/params.ts +0 -18
  287. package/model/promote.ts +0 -6
  288. package/model/promoteObjectID.ts +0 -16
  289. package/model/promoteObjectIDs.ts +0 -16
  290. package/model/recommendedForYouQueryParameters.ts +0 -7
@@ -1 +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"}
1
+ {"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"}
@@ -1,9 +1,9 @@
1
1
  /**
2
- * Settings for the semantic search part of NeuralSearch. Only used when `mode` is _neuralSearch_.
2
+ * Settings for the semantic search part of NeuralSearch. Only used when `mode` is `neuralSearch`.
3
3
  */
4
4
  export type SemanticSearch = {
5
5
  /**
6
- * Indices from which to collect click and conversion events. If null, the current index and replica group will be used as the event source.
6
+ * Indices from which to collect click and conversion events. If null, the current index and all its replicas are used.
7
7
  */
8
8
  eventSources?: string[] | null;
9
9
  };
@@ -1,3 +1,3 @@
1
1
  import type { SnippetResultOption } from './snippetResultOption';
2
- export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption;
2
+ export type SnippetResult = Record<string, SnippetResultOption> | SnippetResultOption | SnippetResultOption[];
3
3
  //# sourceMappingURL=snippetResult.d.ts.map
@@ -1 +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"}
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,GACnB,mBAAmB,EAAE,CAAC"}
@@ -1,10 +1,10 @@
1
1
  import type { MatchLevel } from './matchLevel';
2
2
  /**
3
- * Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty.
3
+ * Snippets that show the context around a matching search query.
4
4
  */
5
5
  export type SnippetResultOption = {
6
6
  /**
7
- * Markup text with `facetQuery` matches highlighted.
7
+ * Highlighted attribute value, including HTML tags.
8
8
  */
9
9
  value: string;
10
10
  matchLevel: MatchLevel;
@@ -1,5 +1,5 @@
1
1
  /**
2
- * How to display the remaining items: - `count`: facet count (descending). - `alpha`: alphabetical (ascending). - `hidden`: show only pinned values.
2
+ * 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.
3
3
  */
4
4
  export type SortRemainingBy = 'alpha' | 'count' | 'hidden';
5
5
  //# sourceMappingURL=sortRemainingBy.d.ts.map
@@ -0,0 +1,5 @@
1
+ /**
2
+ * ISO code for a supported language.
3
+ */
4
+ 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';
5
+ //# sourceMappingURL=supportedLanguage.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -1,6 +1,5 @@
1
- import type { MixedSearchFilters } from './mixedSearchFilters';
2
1
  /**
3
- * [Filter hits by tags](https://www.algolia.com/doc/api-reference/api-parameters/tagFilters/).
2
+ * 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`.
4
3
  */
5
- export type TagFilters = MixedSearchFilters[] | string;
4
+ export type TagFilters = TagFilters[] | string;
6
5
  //# sourceMappingURL=tagFilters.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../model/tagFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"tagFilters.d.ts","sourceRoot":"","sources":["../../model/tagFilters.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,UAAU,EAAE,GAAG,MAAM,CAAC"}
@@ -1,5 +1,5 @@
1
1
  /**
2
- * _published_ if the task has been processed, _notPublished_ otherwise.
2
+ * Task status, `published` if the task is completed, `notPublished` otherwise.
3
3
  */
4
4
  export type TaskStatus = 'notPublished' | 'published';
5
5
  //# sourceMappingURL=taskStatus.d.ts.map
@@ -7,11 +7,11 @@ export type TrendingFacetHit = {
7
7
  */
8
8
  _score: number;
9
9
  /**
10
- * Facet name for trending models.
10
+ * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
11
11
  */
12
12
  facetName: string;
13
13
  /**
14
- * Facet value for trending models.
14
+ * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
15
15
  */
16
16
  facetValue: string;
17
17
  };
@@ -0,0 +1,11 @@
1
+ import type { FallbackParams } from './fallbackParams';
2
+ import type { TrendingFacetsModel } from './trendingFacetsModel';
3
+ export type TrendingFacets = {
4
+ /**
5
+ * Facet attribute for which to retrieve trending facet values.
6
+ */
7
+ facetName: any | null;
8
+ model: TrendingFacetsModel;
9
+ fallbackParameters?: FallbackParams;
10
+ };
11
+ //# sourceMappingURL=trendingFacets.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Trending facets model.
2
+ * Trending facet values model. This model recommends trending facet values for the specified facet attribute.
3
3
  */
4
4
  export type TrendingFacetsModel = 'trending-facets';
5
5
  //# sourceMappingURL=trendingFacetsModel.d.ts.map
@@ -1,4 +1,4 @@
1
1
  import type { BaseRecommendRequest } from './baseRecommendRequest';
2
- import type { BaseTrendingFacetsQuery } from './baseTrendingFacetsQuery';
3
- export type TrendingFacetsQuery = BaseRecommendRequest & BaseTrendingFacetsQuery;
2
+ import type { TrendingFacets } from './trendingFacets';
3
+ export type TrendingFacetsQuery = BaseRecommendRequest & TrendingFacets;
4
4
  //# sourceMappingURL=trendingFacetsQuery.d.ts.map
@@ -1 +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"}
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,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,cAAc,CAAC"}
@@ -0,0 +1,15 @@
1
+ import type { SearchParamsObject } from './searchParamsObject';
2
+ import type { TrendingItemsModel } from './trendingItemsModel';
3
+ export type TrendingItems = {
4
+ /**
5
+ * Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
6
+ */
7
+ facetName: string;
8
+ /**
9
+ * Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
10
+ */
11
+ facetValue: string;
12
+ model: TrendingItemsModel;
13
+ fallbackParameters?: SearchParamsObject;
14
+ };
15
+ //# sourceMappingURL=trendingItems.d.ts.map
@@ -0,0 +1 @@
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"}
@@ -1,5 +1,5 @@
1
1
  /**
2
- * Trending items model.
2
+ * Trending items model. Trending items are determined from the number of conversion events collected on them.
3
3
  */
4
4
  export type TrendingItemsModel = 'trending-items';
5
5
  //# sourceMappingURL=trendingItemsModel.d.ts.map
@@ -1,4 +1,4 @@
1
1
  import type { BaseRecommendRequest } from './baseRecommendRequest';
2
- import type { BaseTrendingItemsQuery } from './baseTrendingItemsQuery';
3
- export type TrendingItemsQuery = BaseRecommendRequest & BaseTrendingItemsQuery;
2
+ import type { TrendingItems } from './trendingItems';
3
+ export type TrendingItemsQuery = BaseRecommendRequest & TrendingItems;
4
4
  //# sourceMappingURL=trendingItemsQuery.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAEvE,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,sBAAsB,CAAC"}
1
+ {"version":3,"file":"trendingItemsQuery.d.ts","sourceRoot":"","sources":["../../model/trendingItemsQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,kBAAkB,GAAG,oBAAoB,GAAG,aAAa,CAAC"}
@@ -1,6 +1,6 @@
1
1
  import type { TypoToleranceEnum } from './typoToleranceEnum';
2
2
  /**
3
- * Controls whether [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/) is enabled and how it is applied.
3
+ * 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.
4
4
  */
5
5
  export type TypoTolerance = TypoToleranceEnum | boolean;
6
6
  //# sourceMappingURL=typoTolerance.d.ts.map
@@ -1,2 +1,5 @@
1
+ /**
2
+ * - `min`. Return matches with the lowest number of typos. For example, if you have matches without typos, only include those. But if there are no matches without typos (with 1 typo), include matches with 1 typo (2 typos). - `strict`. Return matches with the two lowest numbers of typos. With `strict`, the Typo ranking criterion is applied first in the `ranking` setting.
3
+ */
1
4
  export type TypoToleranceEnum = 'min' | 'strict';
2
5
  //# sourceMappingURL=typoToleranceEnum.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
1
+ {"version":3,"file":"typoToleranceEnum.d.ts","sourceRoot":"","sources":["../../model/typoToleranceEnum.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,QAAQ,CAAC"}
@@ -1,9 +1,13 @@
1
1
  import type { SortRemainingBy } from './sortRemainingBy';
2
2
  export type Value = {
3
3
  /**
4
- * Pinned order of facet lists.
4
+ * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
5
5
  */
6
6
  order?: string[];
7
7
  sortRemainingBy?: SortRemainingBy;
8
+ /**
9
+ * Hide facet values.
10
+ */
11
+ hide?: string[];
8
12
  };
9
13
  //# sourceMappingURL=value.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;CACnC,CAAC"}
1
+ {"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../model/value.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjB,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB,CAAC"}
@@ -4,7 +4,7 @@ var clientCommon = require('@algolia/client-common');
4
4
  var requesterNodeHttp = require('@algolia/requester-node-http');
5
5
 
6
6
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
7
- const apiClientVersion = '5.0.0-alpha.99';
7
+ const apiClientVersion = '5.0.0-beta.10';
8
8
  function getDefaultHosts(appId) {
9
9
  return [
10
10
  {
@@ -89,7 +89,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
89
89
  /**
90
90
  * This method allow you to send requests to the Algolia REST API.
91
91
  *
92
- * @summary Send requests to the Algolia REST API.
93
92
  * @param customDelete - The customDelete object.
94
93
  * @param customDelete.path - Path of the endpoint, anything after \"/1\" must be specified.
95
94
  * @param customDelete.parameters - Query parameters to apply to the current query.
@@ -99,7 +98,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
99
98
  if (!path) {
100
99
  throw new Error('Parameter `path` is required when calling `customDelete`.');
101
100
  }
102
- const requestPath = '/1{path}'.replace('{path}', path);
101
+ const requestPath = '/{path}'.replace('{path}', path);
103
102
  const headers = {};
104
103
  const queryParameters = parameters ? parameters : {};
105
104
  const request = {
@@ -113,7 +112,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
113
112
  /**
114
113
  * This method allow you to send requests to the Algolia REST API.
115
114
  *
116
- * @summary Send requests to the Algolia REST API.
117
115
  * @param customGet - The customGet object.
118
116
  * @param customGet.path - Path of the endpoint, anything after \"/1\" must be specified.
119
117
  * @param customGet.parameters - Query parameters to apply to the current query.
@@ -123,7 +121,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
123
121
  if (!path) {
124
122
  throw new Error('Parameter `path` is required when calling `customGet`.');
125
123
  }
126
- const requestPath = '/1{path}'.replace('{path}', path);
124
+ const requestPath = '/{path}'.replace('{path}', path);
127
125
  const headers = {};
128
126
  const queryParameters = parameters ? parameters : {};
129
127
  const request = {
@@ -137,7 +135,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
137
135
  /**
138
136
  * This method allow you to send requests to the Algolia REST API.
139
137
  *
140
- * @summary Send requests to the Algolia REST API.
141
138
  * @param customPost - The customPost object.
142
139
  * @param customPost.path - Path of the endpoint, anything after \"/1\" must be specified.
143
140
  * @param customPost.parameters - Query parameters to apply to the current query.
@@ -148,7 +145,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
148
145
  if (!path) {
149
146
  throw new Error('Parameter `path` is required when calling `customPost`.');
150
147
  }
151
- const requestPath = '/1{path}'.replace('{path}', path);
148
+ const requestPath = '/{path}'.replace('{path}', path);
152
149
  const headers = {};
153
150
  const queryParameters = parameters ? parameters : {};
154
151
  const request = {
@@ -163,7 +160,6 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
163
160
  /**
164
161
  * This method allow you to send requests to the Algolia REST API.
165
162
  *
166
- * @summary Send requests to the Algolia REST API.
167
163
  * @param customPut - The customPut object.
168
164
  * @param customPut.path - Path of the endpoint, anything after \"/1\" must be specified.
169
165
  * @param customPut.parameters - Query parameters to apply to the current query.
@@ -174,7 +170,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
174
170
  if (!path) {
175
171
  throw new Error('Parameter `path` is required when calling `customPut`.');
176
172
  }
177
- const requestPath = '/1{path}'.replace('{path}', path);
173
+ const requestPath = '/{path}'.replace('{path}', path);
178
174
  const headers = {};
179
175
  const queryParameters = parameters ? parameters : {};
180
176
  const request = {
@@ -187,13 +183,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
187
183
  return transporter.request(request, requestOptions);
188
184
  },
189
185
  /**
190
- * Delete a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
186
+ * Deletes a Recommend rule from a recommendation scenario.
187
+ *
188
+ * Required API Key ACLs:
189
+ * - editSettings.
191
190
  *
192
- * @summary Delete a Recommend rule.
193
191
  * @param deleteRecommendRule - The deleteRecommendRule object.
194
- * @param deleteRecommendRule.indexName - Index on which to perform the request.
195
- * @param deleteRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
196
- * @param deleteRecommendRule.objectID - Unique record (object) identifier.
192
+ * @param deleteRecommendRule.indexName - Name of the index on which to perform the operation.
193
+ * @param deleteRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
194
+ * @param deleteRecommendRule.objectID - Unique record identifier.
197
195
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
198
196
  */
199
197
  deleteRecommendRule({ indexName, model, objectID }, requestOptions) {
@@ -221,13 +219,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
221
219
  return transporter.request(request, requestOptions);
222
220
  },
223
221
  /**
224
- * Return a [Recommend rule](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
222
+ * Retrieves a Recommend rule that you previously created in the Algolia dashboard.
223
+ *
224
+ * Required API Key ACLs:
225
+ * - settings.
225
226
  *
226
- * @summary Get a Recommend rule.
227
227
  * @param getRecommendRule - The getRecommendRule object.
228
- * @param getRecommendRule.indexName - Index on which to perform the request.
229
- * @param getRecommendRule.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
230
- * @param getRecommendRule.objectID - Unique record (object) identifier.
228
+ * @param getRecommendRule.indexName - Name of the index on which to perform the operation.
229
+ * @param getRecommendRule.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
230
+ * @param getRecommendRule.objectID - Unique record identifier.
231
231
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
232
232
  */
233
233
  getRecommendRule({ indexName, model, objectID }, requestOptions) {
@@ -255,13 +255,15 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
255
255
  return transporter.request(request, requestOptions);
256
256
  },
257
257
  /**
258
- * Some operations, such as deleting a Recommend rule, will respond with a `taskID` value. Use this value here to check the status of that task.
258
+ * Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed depending on the load on the server. The API response includes a task ID that you can use to check the status.
259
+ *
260
+ * Required API Key ACLs:
261
+ * - editSettings.
259
262
  *
260
- * @summary Get a Recommend task\'s status.
261
263
  * @param getRecommendStatus - The getRecommendStatus object.
262
- * @param getRecommendStatus.indexName - Index on which to perform the request.
263
- * @param getRecommendStatus.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
264
- * @param getRecommendStatus.taskID - Unique identifier of a task. Numeric value (up to 64bits).
264
+ * @param getRecommendStatus.indexName - Name of the index on which to perform the operation.
265
+ * @param getRecommendStatus.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
266
+ * @param getRecommendStatus.taskID - Unique task identifier.
265
267
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
266
268
  */
267
269
  getRecommendStatus({ indexName, model, taskID }, requestOptions) {
@@ -289,13 +291,22 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
289
291
  return transporter.request(request, requestOptions);
290
292
  },
291
293
  /**
292
- * Returns results from either recommendation or trending models: - **Recommendations** are provided by the [Related Products](https://www.algolia.com/doc/guides/algolia-recommend/overview/#related-products-and-related-content) and [Frequently Bought Together](https://www.algolia.com/doc/guides/algolia-recommend/overview/#frequently-bought-together) models - **Trending** models are [Trending Items and Trending Facet Values](https://www.algolia.com/doc/guides/algolia-recommend/overview/#trending-items-and-trending-facet-values).
294
+ * Retrieves recommendations from selected AI models.
295
+ *
296
+ * Required API Key ACLs:
297
+ * - search.
293
298
  *
294
- * @summary Get recommendations and trending items.
295
299
  * @param getRecommendationsParams - The getRecommendationsParams object.
296
300
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
297
301
  */
298
302
  getRecommendations(getRecommendationsParams, requestOptions) {
303
+ if (getRecommendationsParams && Array.isArray(getRecommendationsParams)) {
304
+ const newSignatureRequest = {
305
+ requests: getRecommendationsParams,
306
+ };
307
+ // eslint-disable-next-line no-param-reassign
308
+ getRecommendationsParams = newSignatureRequest;
309
+ }
299
310
  if (!getRecommendationsParams) {
300
311
  throw new Error('Parameter `getRecommendationsParams` is required when calling `getRecommendations`.');
301
312
  }
@@ -317,12 +328,14 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
317
328
  return transporter.request(request, requestOptions);
318
329
  },
319
330
  /**
320
- * List [Recommend rules](https://www.algolia.com/doc/guides/algolia-recommend/how-to/rules/).
331
+ * Searches for Recommend rules. Use an empty query to list all rules for this recommendation scenario.
332
+ *
333
+ * Required API Key ACLs:
334
+ * - settings.
321
335
  *
322
- * @summary List Recommend rules.
323
336
  * @param searchRecommendRules - The searchRecommendRules object.
324
- * @param searchRecommendRules.indexName - Index on which to perform the request.
325
- * @param searchRecommendRules.model - [Recommend models](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
337
+ * @param searchRecommendRules.indexName - Name of the index on which to perform the operation.
338
+ * @param searchRecommendRules.model - [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
326
339
  * @param searchRecommendRules.searchRecommendRulesParams - The searchRecommendRulesParams object.
327
340
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
328
341
  */
@@ -353,6 +366,7 @@ function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authM
353
366
  }
354
367
 
355
368
  // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
369
+ // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
356
370
  function recommendClient(appId, apiKey, options) {
357
371
  if (!appId || typeof appId !== 'string') {
358
372
  throw new Error('`appId` is missing.');
@@ -360,21 +374,23 @@ function recommendClient(appId, apiKey, options) {
360
374
  if (!apiKey || typeof apiKey !== 'string') {
361
375
  throw new Error('`apiKey` is missing.');
362
376
  }
363
- return createRecommendClient({
364
- appId,
365
- apiKey,
366
- timeouts: {
367
- connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
368
- read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
369
- write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
370
- },
371
- requester: requesterNodeHttp.createHttpRequester(),
372
- algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
373
- responsesCache: clientCommon.createNullCache(),
374
- requestsCache: clientCommon.createNullCache(),
375
- hostsCache: clientCommon.createMemoryCache(),
376
- ...options,
377
- });
377
+ return {
378
+ ...createRecommendClient({
379
+ appId,
380
+ apiKey,
381
+ timeouts: {
382
+ connect: clientCommon.DEFAULT_CONNECT_TIMEOUT_NODE,
383
+ read: clientCommon.DEFAULT_READ_TIMEOUT_NODE,
384
+ write: clientCommon.DEFAULT_WRITE_TIMEOUT_NODE,
385
+ },
386
+ requester: requesterNodeHttp.createHttpRequester(),
387
+ algoliaAgents: [{ segment: 'Node.js', version: process.versions.node }],
388
+ responsesCache: clientCommon.createNullCache(),
389
+ requestsCache: clientCommon.createNullCache(),
390
+ hostsCache: clientCommon.createMemoryCache(),
391
+ ...options,
392
+ }),
393
+ };
378
394
  }
379
395
 
380
396
  exports.apiClientVersion = apiClientVersion;