@algolia/recommend 5.2.2 → 5.2.4-beta.2

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 (221) hide show
  1. package/README.md +2 -2
  2. package/dist/browser.d.ts +1300 -0
  3. package/dist/builds/browser.js +398 -0
  4. package/dist/builds/browser.js.map +1 -0
  5. package/dist/builds/browser.min.js +2 -0
  6. package/dist/builds/browser.min.js.map +1 -0
  7. package/dist/builds/browser.umd.js +12 -0
  8. package/dist/builds/node.cjs +416 -0
  9. package/dist/builds/node.cjs.map +1 -0
  10. package/dist/builds/node.js +396 -0
  11. package/dist/builds/node.js.map +1 -0
  12. package/dist/node.d.cts +1300 -0
  13. package/dist/node.d.ts +1300 -0
  14. package/dist/src/recommendClient.cjs +385 -0
  15. package/dist/src/recommendClient.cjs.map +1 -0
  16. package/dist/src/recommendClient.js +359 -0
  17. package/dist/src/recommendClient.js.map +1 -0
  18. package/index.d.ts +1 -1
  19. package/index.js +1 -1
  20. package/model/booleanString.ts +3 -0
  21. package/model/ignorePlurals.ts +2 -1
  22. package/model/index.ts +1 -0
  23. package/package.json +27 -27
  24. package/dist/builds/browser.d.ts +0 -24
  25. package/dist/builds/browser.d.ts.map +0 -1
  26. package/dist/builds/node.d.ts +0 -24
  27. package/dist/builds/node.d.ts.map +0 -1
  28. package/dist/model/advancedSyntaxFeatures.d.ts +0 -2
  29. package/dist/model/advancedSyntaxFeatures.d.ts.map +0 -1
  30. package/dist/model/alternativesAsExact.d.ts +0 -2
  31. package/dist/model/alternativesAsExact.d.ts.map +0 -1
  32. package/dist/model/aroundPrecision.d.ts +0 -6
  33. package/dist/model/aroundPrecision.d.ts.map +0 -1
  34. package/dist/model/aroundRadius.d.ts +0 -6
  35. package/dist/model/aroundRadius.d.ts.map +0 -1
  36. package/dist/model/aroundRadiusAll.d.ts +0 -5
  37. package/dist/model/aroundRadiusAll.d.ts.map +0 -1
  38. package/dist/model/autoFacetFilter.d.ts +0 -14
  39. package/dist/model/autoFacetFilter.d.ts.map +0 -1
  40. package/dist/model/baseRecommendRequest.d.ts +0 -17
  41. package/dist/model/baseRecommendRequest.d.ts.map +0 -1
  42. package/dist/model/baseSearchParams.d.ts +0 -4
  43. package/dist/model/baseSearchParams.d.ts.map +0 -1
  44. package/dist/model/baseSearchParamsWithoutQuery.d.ts +0 -116
  45. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +0 -1
  46. package/dist/model/baseSearchResponse.d.ts +0 -94
  47. package/dist/model/baseSearchResponse.d.ts.map +0 -1
  48. package/dist/model/boughtTogetherQuery.d.ts +0 -4
  49. package/dist/model/boughtTogetherQuery.d.ts.map +0 -1
  50. package/dist/model/clientMethodProps.d.ts +0 -135
  51. package/dist/model/clientMethodProps.d.ts.map +0 -1
  52. package/dist/model/condition.d.ts +0 -14
  53. package/dist/model/condition.d.ts.map +0 -1
  54. package/dist/model/consequence.d.ts +0 -18
  55. package/dist/model/consequence.d.ts.map +0 -1
  56. package/dist/model/deletedAtResponse.d.ts +0 -14
  57. package/dist/model/deletedAtResponse.d.ts.map +0 -1
  58. package/dist/model/distinct.d.ts +0 -5
  59. package/dist/model/distinct.d.ts.map +0 -1
  60. package/dist/model/errorBase.d.ts +0 -7
  61. package/dist/model/errorBase.d.ts.map +0 -1
  62. package/dist/model/exactOnSingleWordQuery.d.ts +0 -5
  63. package/dist/model/exactOnSingleWordQuery.d.ts.map +0 -1
  64. package/dist/model/exhaustive.d.ts +0 -26
  65. package/dist/model/exhaustive.d.ts.map +0 -1
  66. package/dist/model/facetFilters.d.ts +0 -5
  67. package/dist/model/facetFilters.d.ts.map +0 -1
  68. package/dist/model/facetOrdering.d.ts +0 -13
  69. package/dist/model/facetOrdering.d.ts.map +0 -1
  70. package/dist/model/facetStats.d.ts +0 -19
  71. package/dist/model/facetStats.d.ts.map +0 -1
  72. package/dist/model/facets.d.ts +0 -10
  73. package/dist/model/facets.d.ts.map +0 -1
  74. package/dist/model/fallbackParams.d.ts +0 -3
  75. package/dist/model/fallbackParams.d.ts.map +0 -1
  76. package/dist/model/fbtModel.d.ts +0 -5
  77. package/dist/model/fbtModel.d.ts.map +0 -1
  78. package/dist/model/frequentlyBoughtTogether.d.ts +0 -9
  79. package/dist/model/frequentlyBoughtTogether.d.ts.map +0 -1
  80. package/dist/model/getRecommendTaskResponse.d.ts +0 -5
  81. package/dist/model/getRecommendTaskResponse.d.ts.map +0 -1
  82. package/dist/model/getRecommendationsParams.d.ts +0 -11
  83. package/dist/model/getRecommendationsParams.d.ts.map +0 -1
  84. package/dist/model/getRecommendationsResponse.d.ts +0 -5
  85. package/dist/model/getRecommendationsResponse.d.ts.map +0 -1
  86. package/dist/model/hideConsequenceObject.d.ts +0 -10
  87. package/dist/model/hideConsequenceObject.d.ts.map +0 -1
  88. package/dist/model/highlightResult.d.ts +0 -5
  89. package/dist/model/highlightResult.d.ts.map +0 -1
  90. package/dist/model/highlightResultOption.d.ts +0 -20
  91. package/dist/model/highlightResultOption.d.ts.map +0 -1
  92. package/dist/model/ignorePlurals.d.ts +0 -6
  93. package/dist/model/ignorePlurals.d.ts.map +0 -1
  94. package/dist/model/index.d.ts +0 -94
  95. package/dist/model/index.d.ts.map +0 -1
  96. package/dist/model/indexSettingsAsSearchParams.d.ts +0 -160
  97. package/dist/model/indexSettingsAsSearchParams.d.ts.map +0 -1
  98. package/dist/model/lookingSimilar.d.ts +0 -11
  99. package/dist/model/lookingSimilar.d.ts.map +0 -1
  100. package/dist/model/lookingSimilarModel.d.ts +0 -5
  101. package/dist/model/lookingSimilarModel.d.ts.map +0 -1
  102. package/dist/model/lookingSimilarQuery.d.ts +0 -4
  103. package/dist/model/lookingSimilarQuery.d.ts.map +0 -1
  104. package/dist/model/matchLevel.d.ts +0 -5
  105. package/dist/model/matchLevel.d.ts.map +0 -1
  106. package/dist/model/matchedGeoLocation.d.ts +0 -15
  107. package/dist/model/matchedGeoLocation.d.ts.map +0 -1
  108. package/dist/model/mode.d.ts +0 -5
  109. package/dist/model/mode.d.ts.map +0 -1
  110. package/dist/model/numericFilters.d.ts +0 -5
  111. package/dist/model/numericFilters.d.ts.map +0 -1
  112. package/dist/model/optionalFilters.d.ts +0 -5
  113. package/dist/model/optionalFilters.d.ts.map +0 -1
  114. package/dist/model/paramsConsequence.d.ts +0 -19
  115. package/dist/model/paramsConsequence.d.ts.map +0 -1
  116. package/dist/model/personalization.d.ts +0 -15
  117. package/dist/model/personalization.d.ts.map +0 -1
  118. package/dist/model/promoteConsequenceObject.d.ts +0 -14
  119. package/dist/model/promoteConsequenceObject.d.ts.map +0 -1
  120. package/dist/model/queryType.d.ts +0 -5
  121. package/dist/model/queryType.d.ts.map +0 -1
  122. package/dist/model/range.d.ts +0 -14
  123. package/dist/model/range.d.ts.map +0 -1
  124. package/dist/model/rankingInfo.d.ts +0 -54
  125. package/dist/model/rankingInfo.d.ts.map +0 -1
  126. package/dist/model/reRankingApplyFilter.d.ts +0 -5
  127. package/dist/model/reRankingApplyFilter.d.ts.map +0 -1
  128. package/dist/model/recommendHit.d.ts +0 -27
  129. package/dist/model/recommendHit.d.ts.map +0 -1
  130. package/dist/model/recommendModels.d.ts +0 -2
  131. package/dist/model/recommendModels.d.ts.map +0 -1
  132. package/dist/model/recommendRule.d.ts +0 -24
  133. package/dist/model/recommendRule.d.ts.map +0 -1
  134. package/dist/model/recommendationsHit.d.ts +0 -4
  135. package/dist/model/recommendationsHit.d.ts.map +0 -1
  136. package/dist/model/recommendationsHits.d.ts +0 -5
  137. package/dist/model/recommendationsHits.d.ts.map +0 -1
  138. package/dist/model/recommendationsRequest.d.ts +0 -8
  139. package/dist/model/recommendationsRequest.d.ts.map +0 -1
  140. package/dist/model/recommendationsResults.d.ts +0 -5
  141. package/dist/model/recommendationsResults.d.ts.map +0 -1
  142. package/dist/model/recommendedForYou.d.ts +0 -7
  143. package/dist/model/recommendedForYou.d.ts.map +0 -1
  144. package/dist/model/recommendedForYouModel.d.ts +0 -5
  145. package/dist/model/recommendedForYouModel.d.ts.map +0 -1
  146. package/dist/model/recommendedForYouQuery.d.ts +0 -4
  147. package/dist/model/recommendedForYouQuery.d.ts.map +0 -1
  148. package/dist/model/redirect.d.ts +0 -8
  149. package/dist/model/redirect.d.ts.map +0 -1
  150. package/dist/model/redirectRuleIndexData.d.ts +0 -7
  151. package/dist/model/redirectRuleIndexData.d.ts.map +0 -1
  152. package/dist/model/redirectRuleIndexMetadata.d.ts +0 -21
  153. package/dist/model/redirectRuleIndexMetadata.d.ts.map +0 -1
  154. package/dist/model/redirectURL.d.ts +0 -7
  155. package/dist/model/redirectURL.d.ts.map +0 -1
  156. package/dist/model/relatedModel.d.ts +0 -5
  157. package/dist/model/relatedModel.d.ts.map +0 -1
  158. package/dist/model/relatedProducts.d.ts +0 -11
  159. package/dist/model/relatedProducts.d.ts.map +0 -1
  160. package/dist/model/relatedQuery.d.ts +0 -4
  161. package/dist/model/relatedQuery.d.ts.map +0 -1
  162. package/dist/model/removeStopWords.d.ts +0 -6
  163. package/dist/model/removeStopWords.d.ts.map +0 -1
  164. package/dist/model/removeWordsIfNoResults.d.ts +0 -5
  165. package/dist/model/removeWordsIfNoResults.d.ts.map +0 -1
  166. package/dist/model/renderingContent.d.ts +0 -10
  167. package/dist/model/renderingContent.d.ts.map +0 -1
  168. package/dist/model/ruleMetadata.d.ts +0 -10
  169. package/dist/model/ruleMetadata.d.ts.map +0 -1
  170. package/dist/model/searchPagination.d.ts +0 -19
  171. package/dist/model/searchPagination.d.ts.map +0 -1
  172. package/dist/model/searchParams.d.ts +0 -3
  173. package/dist/model/searchParams.d.ts.map +0 -1
  174. package/dist/model/searchParamsObject.d.ts +0 -7
  175. package/dist/model/searchParamsObject.d.ts.map +0 -1
  176. package/dist/model/searchParamsQuery.d.ts +0 -7
  177. package/dist/model/searchParamsQuery.d.ts.map +0 -1
  178. package/dist/model/searchRecommendRulesParams.d.ts +0 -38
  179. package/dist/model/searchRecommendRulesParams.d.ts.map +0 -1
  180. package/dist/model/searchRecommendRulesResponse.d.ts +0 -20
  181. package/dist/model/searchRecommendRulesResponse.d.ts.map +0 -1
  182. package/dist/model/semanticSearch.d.ts +0 -10
  183. package/dist/model/semanticSearch.d.ts.map +0 -1
  184. package/dist/model/snippetResult.d.ts +0 -5
  185. package/dist/model/snippetResult.d.ts.map +0 -1
  186. package/dist/model/snippetResultOption.d.ts +0 -12
  187. package/dist/model/snippetResultOption.d.ts.map +0 -1
  188. package/dist/model/sortRemainingBy.d.ts +0 -5
  189. package/dist/model/sortRemainingBy.d.ts.map +0 -1
  190. package/dist/model/supportedLanguage.d.ts +0 -5
  191. package/dist/model/supportedLanguage.d.ts.map +0 -1
  192. package/dist/model/tagFilters.d.ts +0 -5
  193. package/dist/model/tagFilters.d.ts.map +0 -1
  194. package/dist/model/taskStatus.d.ts +0 -5
  195. package/dist/model/taskStatus.d.ts.map +0 -1
  196. package/dist/model/trendingFacetHit.d.ts +0 -18
  197. package/dist/model/trendingFacetHit.d.ts.map +0 -1
  198. package/dist/model/trendingFacets.d.ts +0 -11
  199. package/dist/model/trendingFacets.d.ts.map +0 -1
  200. package/dist/model/trendingFacetsModel.d.ts +0 -5
  201. package/dist/model/trendingFacetsModel.d.ts.map +0 -1
  202. package/dist/model/trendingFacetsQuery.d.ts +0 -4
  203. package/dist/model/trendingFacetsQuery.d.ts.map +0 -1
  204. package/dist/model/trendingItems.d.ts +0 -15
  205. package/dist/model/trendingItems.d.ts.map +0 -1
  206. package/dist/model/trendingItemsModel.d.ts +0 -5
  207. package/dist/model/trendingItemsModel.d.ts.map +0 -1
  208. package/dist/model/trendingItemsQuery.d.ts +0 -4
  209. package/dist/model/trendingItemsQuery.d.ts.map +0 -1
  210. package/dist/model/typoTolerance.d.ts +0 -6
  211. package/dist/model/typoTolerance.d.ts.map +0 -1
  212. package/dist/model/typoToleranceEnum.d.ts +0 -5
  213. package/dist/model/typoToleranceEnum.d.ts.map +0 -1
  214. package/dist/model/value.d.ts +0 -13
  215. package/dist/model/value.d.ts.map +0 -1
  216. package/dist/recommend.cjs +0 -394
  217. package/dist/recommend.esm.browser.js +0 -1079
  218. package/dist/recommend.esm.node.js +0 -391
  219. package/dist/recommend.umd.js +0 -2
  220. package/dist/src/recommendClient.d.ts +0 -132
  221. package/dist/src/recommendClient.d.ts.map +0 -1
@@ -1,14 +0,0 @@
1
- /**
2
- * Facet attribute. Only recommendations with the same value (or only recommendations with a different value) as the original viewed item are included.
3
- */
4
- export type AutoFacetFilter = {
5
- /**
6
- * Facet attribute.
7
- */
8
- facet?: string;
9
- /**
10
- * Whether the filter is negative. If true, recommendations must not have the same value for the `facet` attribute. If false, recommendations must have the same value for the `facet` attribute.
11
- */
12
- negative?: boolean;
13
- };
14
- //# sourceMappingURL=autoFacetFilter.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"autoFacetFilter.d.ts","sourceRoot":"","sources":["../../model/autoFacetFilter.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC"}
@@ -1,17 +0,0 @@
1
- import type { SearchParams } from './searchParams';
2
- export type BaseRecommendRequest = {
3
- /**
4
- * Index name (case-sensitive).
5
- */
6
- indexName: string;
7
- /**
8
- * Minimum score a recommendation must have to be included in the response.
9
- */
10
- threshold: number;
11
- /**
12
- * Maximum number of recommendations to retrieve. By default, all recommendations are returned and no fallback request is made. Depending on the available recommendations and the other request parameters, the actual number of recommendations may be lower than this value.
13
- */
14
- maxRecommendations?: number;
15
- queryParameters?: SearchParams;
16
- };
17
- //# sourceMappingURL=baseRecommendRequest.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAEnD,MAAM,MAAM,oBAAoB,GAAG;IACjC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B,eAAe,CAAC,EAAE,YAAY,CAAC;CAChC,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
2
- import type { SearchParamsQuery } from './searchParamsQuery';
3
- export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
4
- //# sourceMappingURL=baseSearchParams.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseSearchParams.d.ts","sourceRoot":"","sources":["../../model/baseSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,MAAM,MAAM,gBAAgB,GAAG,4BAA4B,GAAG,iBAAiB,CAAC"}
@@ -1,116 +0,0 @@
1
- import type { AroundPrecision } from './aroundPrecision';
2
- import type { AroundRadius } from './aroundRadius';
3
- import type { FacetFilters } from './facetFilters';
4
- import type { NumericFilters } from './numericFilters';
5
- import type { OptionalFilters } from './optionalFilters';
6
- import type { SupportedLanguage } from './supportedLanguage';
7
- import type { TagFilters } from './tagFilters';
8
- export type BaseSearchParamsWithoutQuery = {
9
- /**
10
- * Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
11
- */
12
- similarQuery?: string;
13
- /**
14
- * Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
15
- */
16
- filters?: string;
17
- facetFilters?: FacetFilters;
18
- optionalFilters?: OptionalFilters;
19
- numericFilters?: NumericFilters;
20
- tagFilters?: TagFilters;
21
- /**
22
- * Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
23
- */
24
- sumOrFiltersScores?: boolean;
25
- /**
26
- * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
27
- */
28
- restrictSearchableAttributes?: string[];
29
- /**
30
- * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
31
- */
32
- facets?: string[];
33
- /**
34
- * Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
35
- */
36
- facetingAfterDistinct?: boolean;
37
- /**
38
- * Page of search results to retrieve.
39
- */
40
- page?: number;
41
- /**
42
- * Position of the first hit to retrieve.
43
- */
44
- offset?: number;
45
- /**
46
- * Number of hits to retrieve (used in combination with `offset`).
47
- */
48
- length?: number;
49
- /**
50
- * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
51
- */
52
- aroundLatLng?: string;
53
- /**
54
- * Whether to obtain the coordinates from the request\'s IP address.
55
- */
56
- aroundLatLngViaIP?: boolean;
57
- aroundRadius?: AroundRadius;
58
- aroundPrecision?: AroundPrecision;
59
- /**
60
- * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
61
- */
62
- minimumAroundRadius?: number;
63
- /**
64
- * Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
65
- */
66
- insideBoundingBox?: number[][];
67
- /**
68
- * Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
69
- */
70
- insidePolygon?: number[][];
71
- /**
72
- * ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
73
- */
74
- naturalLanguages?: SupportedLanguage[];
75
- /**
76
- * Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
77
- */
78
- ruleContexts?: string[];
79
- /**
80
- * Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
81
- */
82
- personalizationImpact?: number;
83
- /**
84
- * Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
85
- */
86
- userToken?: string;
87
- /**
88
- * Whether the search response should include detailed ranking information.
89
- */
90
- getRankingInfo?: boolean;
91
- /**
92
- * Whether to take into account an index\'s synonyms for this search.
93
- */
94
- synonyms?: boolean;
95
- /**
96
- * Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
97
- */
98
- clickAnalytics?: boolean;
99
- /**
100
- * Whether this search will be included in Analytics.
101
- */
102
- analytics?: boolean;
103
- /**
104
- * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
105
- */
106
- analyticsTags?: string[];
107
- /**
108
- * Whether to include this search when calculating processing-time percentiles.
109
- */
110
- percentileComputation?: boolean;
111
- /**
112
- * Whether to enable A/B testing for this search.
113
- */
114
- enableABTest?: boolean;
115
- };
116
- //# sourceMappingURL=baseSearchParamsWithoutQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}
@@ -1,94 +0,0 @@
1
- import type { Exhaustive } from './exhaustive';
2
- import type { FacetStats } from './facetStats';
3
- import type { Redirect } from './redirect';
4
- import type { RenderingContent } from './renderingContent';
5
- export type BaseSearchResponse = Record<string, any> & {
6
- /**
7
- * A/B test ID. This is only included in the response for indices that are part of an A/B test.
8
- */
9
- abTestID?: number;
10
- /**
11
- * Variant ID. This is only included in the response for indices that are part of an A/B test.
12
- */
13
- abTestVariantID?: number;
14
- /**
15
- * Computed geographical location.
16
- */
17
- aroundLatLng?: string;
18
- /**
19
- * Distance from a central coordinate provided by `aroundLatLng`.
20
- */
21
- automaticRadius?: string;
22
- exhaustive?: Exhaustive;
23
- /**
24
- * See the `facetsCount` field of the `exhaustive` object in the response.
25
- */
26
- exhaustiveFacetsCount?: boolean;
27
- /**
28
- * See the `nbHits` field of the `exhaustive` object in the response.
29
- */
30
- exhaustiveNbHits?: boolean;
31
- /**
32
- * See the `typo` field of the `exhaustive` object in the response.
33
- */
34
- exhaustiveTypo?: boolean;
35
- /**
36
- * Facet counts.
37
- */
38
- facets?: Record<string, Record<string, number>>;
39
- /**
40
- * Statistics for numerical facets.
41
- */
42
- facets_stats?: Record<string, FacetStats>;
43
- /**
44
- * Index name used for the query.
45
- */
46
- index?: string;
47
- /**
48
- * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
49
- */
50
- indexUsed?: string;
51
- /**
52
- * Warnings about the query.
53
- */
54
- message?: string;
55
- /**
56
- * Number of hits selected and sorted by the relevant sort algorithm.
57
- */
58
- nbSortedHits?: number;
59
- /**
60
- * 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.
61
- */
62
- parsedQuery?: string;
63
- /**
64
- * Time the server took to process the request, in milliseconds.
65
- */
66
- processingTimeMS: number;
67
- /**
68
- * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
69
- */
70
- processingTimingsMS?: Record<string, unknown>;
71
- /**
72
- * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
73
- */
74
- queryAfterRemoval?: string;
75
- redirect?: Redirect;
76
- renderingContent?: RenderingContent;
77
- /**
78
- * Time the server took to process the request, in milliseconds.
79
- */
80
- serverTimeMS?: number;
81
- /**
82
- * Host name of the server that processed the request.
83
- */
84
- serverUsed?: string;
85
- /**
86
- * An object with custom data. You can store up to 32kB as custom data.
87
- */
88
- userData?: Record<string, unknown>;
89
- /**
90
- * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
91
- */
92
- queryID?: string;
93
- };
94
- //# sourceMappingURL=baseSearchResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"baseSearchResponse.d.ts","sourceRoot":"","sources":["../../model/baseSearchResponse.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAE3D,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IACrD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEhD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAE1C;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE9C;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,4 +0,0 @@
1
- import type { BaseRecommendRequest } from './baseRecommendRequest';
2
- import type { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
3
- export type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
4
- //# sourceMappingURL=boughtTogetherQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"boughtTogetherQuery.d.ts","sourceRoot":"","sources":["../../model/boughtTogetherQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E,MAAM,MAAM,mBAAmB,GAAG,oBAAoB,GAAG,wBAAwB,CAAC"}
@@ -1,135 +0,0 @@
1
- import type { RecommendModels } from './recommendModels';
2
- import type { RecommendationsRequest } from './recommendationsRequest';
3
- import type { SearchRecommendRulesParams } from './searchRecommendRulesParams';
4
- /**
5
- * Properties for the `customDelete` method.
6
- */
7
- export type CustomDeleteProps = {
8
- /**
9
- * Path of the endpoint, anything after \"/1\" must be specified.
10
- */
11
- path: string;
12
- /**
13
- * Query parameters to apply to the current query.
14
- */
15
- parameters?: Record<string, any>;
16
- };
17
- /**
18
- * Properties for the `customGet` method.
19
- */
20
- export type CustomGetProps = {
21
- /**
22
- * Path of the endpoint, anything after \"/1\" must be specified.
23
- */
24
- path: string;
25
- /**
26
- * Query parameters to apply to the current query.
27
- */
28
- parameters?: Record<string, any>;
29
- };
30
- /**
31
- * Properties for the `customPost` method.
32
- */
33
- export type CustomPostProps = {
34
- /**
35
- * Path of the endpoint, anything after \"/1\" must be specified.
36
- */
37
- path: string;
38
- /**
39
- * Query parameters to apply to the current query.
40
- */
41
- parameters?: Record<string, any>;
42
- /**
43
- * Parameters to send with the custom request.
44
- */
45
- body?: Record<string, unknown>;
46
- };
47
- /**
48
- * Properties for the `customPut` method.
49
- */
50
- export type CustomPutProps = {
51
- /**
52
- * Path of the endpoint, anything after \"/1\" must be specified.
53
- */
54
- path: string;
55
- /**
56
- * Query parameters to apply to the current query.
57
- */
58
- parameters?: Record<string, any>;
59
- /**
60
- * Parameters to send with the custom request.
61
- */
62
- body?: Record<string, unknown>;
63
- };
64
- /**
65
- * Properties for the `deleteRecommendRule` method.
66
- */
67
- export type DeleteRecommendRuleProps = {
68
- /**
69
- * Name of the index on which to perform the operation.
70
- */
71
- indexName: string;
72
- /**
73
- * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
74
- */
75
- model: RecommendModels;
76
- /**
77
- * Unique record identifier.
78
- */
79
- objectID: string;
80
- };
81
- /**
82
- * Properties for the `getRecommendRule` method.
83
- */
84
- export type GetRecommendRuleProps = {
85
- /**
86
- * Name of the index on which to perform the operation.
87
- */
88
- indexName: string;
89
- /**
90
- * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
91
- */
92
- model: RecommendModels;
93
- /**
94
- * Unique record identifier.
95
- */
96
- objectID: string;
97
- };
98
- /**
99
- * Properties for the `getRecommendStatus` method.
100
- */
101
- export type GetRecommendStatusProps = {
102
- /**
103
- * Name of the index on which to perform the operation.
104
- */
105
- indexName: string;
106
- /**
107
- * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
108
- */
109
- model: RecommendModels;
110
- /**
111
- * Unique task identifier.
112
- */
113
- taskID: number;
114
- };
115
- /**
116
- * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
117
- *
118
- * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
119
- */
120
- export type LegacyGetRecommendationsParams = RecommendationsRequest[];
121
- /**
122
- * Properties for the `searchRecommendRules` method.
123
- */
124
- export type SearchRecommendRulesProps = {
125
- /**
126
- * Name of the index on which to perform the operation.
127
- */
128
- indexName: string;
129
- /**
130
- * [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models).
131
- */
132
- model: RecommendModels;
133
- searchRecommendRulesParams?: SearchRecommendRulesParams;
134
- };
135
- //# sourceMappingURL=clientMethodProps.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"clientMethodProps.d.ts","sourceRoot":"","sources":["../../model/clientMethodProps.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAClC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG,sBAAsB,EAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,EAAE,eAAe,CAAC;IACvB,0BAA0B,CAAC,EAAE,0BAA0B,CAAC;CACzD,CAAC"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
3
- */
4
- export type Condition = {
5
- /**
6
- * Filter expression to only include items that match the filter criteria in the response. You can use these filter expressions: - **Numeric filters.** `<facet> <op> <number>`, where `<op>` is one of `<`, `<=`, `=`, `!=`, `>`, `>=`. - **Ranges.** `<facet>:<lower> TO <upper>` where `<lower>` and `<upper>` are the lower and upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>` (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`. **Not supported:** `facet:value OR num > 3`. - You can\'t use `NOT` with combinations of filters. **Not supported:** `NOT(facet:value OR facet:value)` - You can\'t combine conjunctions (`AND`) with `OR`. **Not supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet attribute name or facet value has spaces, keywords (`OR`, `AND`, `NOT`), or quotes. If a facet attribute is an array, the filter matches if it matches at least one element of the array. For more information, see [Filters](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/).
7
- */
8
- filters?: string;
9
- /**
10
- * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
11
- */
12
- context?: string;
13
- };
14
- //# sourceMappingURL=condition.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"condition.d.ts","sourceRoot":"","sources":["../../model/condition.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,18 +0,0 @@
1
- import type { HideConsequenceObject } from './hideConsequenceObject';
2
- import type { ParamsConsequence } from './paramsConsequence';
3
- import type { PromoteConsequenceObject } from './promoteConsequenceObject';
4
- /**
5
- * Effect of the rule.
6
- */
7
- export type Consequence = {
8
- /**
9
- * Exclude items from recommendations.
10
- */
11
- hide?: HideConsequenceObject[];
12
- /**
13
- * Place items at specific positions in the list of recommendations.
14
- */
15
- promote?: PromoteConsequenceObject[];
16
- params?: ParamsConsequence;
17
- };
18
- //# sourceMappingURL=consequence.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"consequence.d.ts","sourceRoot":"","sources":["../../model/consequence.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAE3E;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,IAAI,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,wBAAwB,EAAE,CAAC;IAErC,MAAM,CAAC,EAAE,iBAAiB,CAAC;CAC5B,CAAC"}
@@ -1,14 +0,0 @@
1
- /**
2
- * Response, taskID, and deletion timestamp.
3
- */
4
- export type DeletedAtResponse = {
5
- /**
6
- * Unique identifier of a task. 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`.
7
- */
8
- taskID: number;
9
- /**
10
- * Date and time when the object was deleted, in RFC 3339 format.
11
- */
12
- deletedAt: string;
13
- };
14
- //# sourceMappingURL=deletedAtResponse.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"deletedAtResponse.d.ts","sourceRoot":"","sources":["../../model/deletedAtResponse.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set.
3
- */
4
- export type Distinct = boolean | number;
5
- //# sourceMappingURL=distinct.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"distinct.d.ts","sourceRoot":"","sources":["../../model/distinct.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC"}
@@ -1,7 +0,0 @@
1
- /**
2
- * Error.
3
- */
4
- export type ErrorBase = Record<string, any> & {
5
- message?: string;
6
- };
7
- //# sourceMappingURL=errorBase.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"errorBase.d.ts","sourceRoot":"","sources":["../../model/errorBase.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG;IAC5C,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won\'t.
3
- */
4
- export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';
5
- //# sourceMappingURL=exactOnSingleWordQuery.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"exactOnSingleWordQuery.d.ts","sourceRoot":"","sources":["../../model/exactOnSingleWordQuery.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,WAAW,GAAG,MAAM,GAAG,MAAM,CAAC"}
@@ -1,26 +0,0 @@
1
- /**
2
- * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
3
- */
4
- export type Exhaustive = {
5
- /**
6
- * 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-).
7
- */
8
- facetsCount?: boolean;
9
- /**
10
- * The value is `false` if not all facet values are retrieved.
11
- */
12
- facetValues?: boolean;
13
- /**
14
- * 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.
15
- */
16
- nbHits?: boolean;
17
- /**
18
- * 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.
19
- */
20
- rulesMatch?: boolean;
21
- /**
22
- * 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.
23
- */
24
- typo?: boolean;
25
- };
26
- //# sourceMappingURL=exhaustive.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"exhaustive.d.ts","sourceRoot":"","sources":["../../model/exhaustive.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC"}
@@ -1,5 +0,0 @@
1
- /**
2
- * Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
3
- */
4
- export type FacetFilters = FacetFilters[] | string;
5
- //# sourceMappingURL=facetFilters.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"facetFilters.d.ts","sourceRoot":"","sources":["../../model/facetFilters.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,YAAY,EAAE,GAAG,MAAM,CAAC"}
@@ -1,13 +0,0 @@
1
- import type { Facets } from './facets';
2
- import type { Value } from './value';
3
- /**
4
- * Order of facet names and facet values in your UI.
5
- */
6
- export type FacetOrdering = {
7
- facets?: Facets;
8
- /**
9
- * Order of facet values. One object for each facet.
10
- */
11
- values?: Record<string, Value>;
12
- };
13
- //# sourceMappingURL=facetOrdering.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"facetOrdering.d.ts","sourceRoot":"","sources":["../../model/facetOrdering.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AACvC,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;CAChC,CAAC"}
@@ -1,19 +0,0 @@
1
- export type FacetStats = {
2
- /**
3
- * Minimum value in the results.
4
- */
5
- min?: number;
6
- /**
7
- * Maximum value in the results.
8
- */
9
- max?: number;
10
- /**
11
- * Average facet value in the results.
12
- */
13
- avg?: number;
14
- /**
15
- * Sum of all values in the results.
16
- */
17
- sum?: number;
18
- };
19
- //# sourceMappingURL=facetStats.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"facetStats.d.ts","sourceRoot":"","sources":["../../model/facetStats.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,UAAU,GAAG;IACvB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC"}
@@ -1,10 +0,0 @@
1
- /**
2
- * Order of facet names.
3
- */
4
- export type Facets = {
5
- /**
6
- * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
7
- */
8
- order?: string[];
9
- };
10
- //# sourceMappingURL=facets.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"facets.d.ts","sourceRoot":"","sources":["../../model/facets.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC"}
@@ -1,3 +0,0 @@
1
- import type { SearchParamsObject } from './searchParamsObject';
2
- export type FallbackParams = Record<string, unknown> & SearchParamsObject;
3
- //# sourceMappingURL=fallbackParams.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"fallbackParams.d.ts","sourceRoot":"","sources":["../../model/fallbackParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,kBAAkB,CAAC"}