@algolia/recommend 5.0.0-alpha.7 → 5.0.0-alpha.70

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 (188) hide show
  1. package/dist/builds/browser.d.ts +5 -5
  2. package/dist/builds/browser.d.ts.map +1 -1
  3. package/dist/builds/node.d.ts +5 -5
  4. package/dist/builds/node.d.ts.map +1 -1
  5. package/dist/model/advancedSyntaxFeatures.d.ts +1 -1
  6. package/dist/model/advancedSyntaxFeatures.d.ts.map +1 -1
  7. package/dist/model/alternativesAsExact.d.ts +1 -1
  8. package/dist/model/alternativesAsExact.d.ts.map +1 -1
  9. package/dist/model/aroundRadius.d.ts +5 -5
  10. package/dist/model/aroundRadius.d.ts.map +1 -1
  11. package/dist/model/aroundRadiusAll.d.ts +1 -1
  12. package/dist/model/aroundRadiusAll.d.ts.map +1 -1
  13. package/dist/model/baseRecommendRequest.d.ts +17 -17
  14. package/dist/model/baseRecommendRequest.d.ts.map +1 -1
  15. package/dist/model/baseRecommendationRequest.d.ts +8 -8
  16. package/dist/model/baseRecommendationRequest.d.ts.map +1 -1
  17. package/dist/model/baseSearchParams.d.ts +3 -3
  18. package/dist/model/baseSearchParams.d.ts.map +1 -1
  19. package/dist/model/baseSearchParamsWithoutQuery.d.ts +122 -122
  20. package/dist/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  21. package/dist/model/baseSearchResponse.d.ts +103 -101
  22. package/dist/model/baseSearchResponse.d.ts.map +1 -1
  23. package/dist/model/baseSearchResponseRedirect.d.ts +8 -0
  24. package/dist/model/baseSearchResponseRedirect.d.ts.map +1 -0
  25. package/dist/model/baseTrendingRequest.d.ts +12 -12
  26. package/dist/model/baseTrendingRequest.d.ts.map +1 -1
  27. package/dist/model/clientMethodProps.d.ts +60 -60
  28. package/dist/model/clientMethodProps.d.ts.map +1 -1
  29. package/dist/model/distinct.d.ts +4 -4
  30. package/dist/model/distinct.d.ts.map +1 -1
  31. package/dist/model/errorBase.d.ts +6 -6
  32. package/dist/model/errorBase.d.ts.map +1 -1
  33. package/dist/model/exactOnSingleWordQuery.d.ts +4 -4
  34. package/dist/model/exactOnSingleWordQuery.d.ts.map +1 -1
  35. package/dist/model/facetFilters.d.ts +5 -5
  36. package/dist/model/facetFilters.d.ts.map +1 -1
  37. package/dist/model/facetOrdering.d.ts +12 -12
  38. package/dist/model/facetOrdering.d.ts.map +1 -1
  39. package/dist/model/facets.d.ts +9 -9
  40. package/dist/model/facets.d.ts.map +1 -1
  41. package/dist/model/facetsStats.d.ts +18 -18
  42. package/dist/model/facetsStats.d.ts.map +1 -1
  43. package/dist/model/getRecommendationsParams.d.ts +10 -10
  44. package/dist/model/getRecommendationsParams.d.ts.map +1 -1
  45. package/dist/model/getRecommendationsResponse.d.ts +4 -4
  46. package/dist/model/getRecommendationsResponse.d.ts.map +1 -1
  47. package/dist/model/highlightResult.d.ts +2 -2
  48. package/dist/model/highlightResult.d.ts.map +1 -1
  49. package/dist/model/highlightResultOption.d.ts +19 -19
  50. package/dist/model/highlightResultOption.d.ts.map +1 -1
  51. package/dist/model/ignorePlurals.d.ts +4 -4
  52. package/dist/model/ignorePlurals.d.ts.map +1 -1
  53. package/dist/model/index.d.ts +58 -53
  54. package/dist/model/index.d.ts.map +1 -1
  55. package/dist/model/indexSettingsAsSearchParams.d.ts +164 -160
  56. package/dist/model/indexSettingsAsSearchParams.d.ts.map +1 -1
  57. package/dist/model/indexSettingsAsSearchParamsSemanticSearch.d.ts +10 -0
  58. package/dist/model/indexSettingsAsSearchParamsSemanticSearch.d.ts.map +1 -0
  59. package/dist/model/matchLevel.d.ts +4 -4
  60. package/dist/model/matchLevel.d.ts.map +1 -1
  61. package/dist/model/matchedGeoLocation.d.ts +14 -14
  62. package/dist/model/matchedGeoLocation.d.ts.map +1 -1
  63. package/dist/model/mixedSearchFilters.d.ts +1 -1
  64. package/dist/model/mixedSearchFilters.d.ts.map +1 -1
  65. package/dist/model/mode.d.ts +5 -0
  66. package/dist/model/mode.d.ts.map +1 -0
  67. package/dist/model/numericFilters.d.ts +5 -5
  68. package/dist/model/numericFilters.d.ts.map +1 -1
  69. package/dist/model/optionalFilters.d.ts +5 -5
  70. package/dist/model/optionalFilters.d.ts.map +1 -1
  71. package/dist/model/personalization.d.ts +14 -14
  72. package/dist/model/personalization.d.ts.map +1 -1
  73. package/dist/model/queryType.d.ts +4 -4
  74. package/dist/model/queryType.d.ts.map +1 -1
  75. package/dist/model/rankingInfo.d.ts +50 -50
  76. package/dist/model/rankingInfo.d.ts.map +1 -1
  77. package/dist/model/reRankingApplyFilter.d.ts +5 -5
  78. package/dist/model/reRankingApplyFilter.d.ts.map +1 -1
  79. package/dist/model/recommendHit.d.ts +26 -26
  80. package/dist/model/recommendHit.d.ts.map +1 -1
  81. package/dist/model/recommendHits.d.ts +4 -4
  82. package/dist/model/recommendHits.d.ts.map +1 -1
  83. package/dist/model/recommendationModels.d.ts +4 -4
  84. package/dist/model/recommendationModels.d.ts.map +1 -1
  85. package/dist/model/recommendationRequest.d.ts +3 -3
  86. package/dist/model/recommendationRequest.d.ts.map +1 -1
  87. package/dist/model/recommendationsRequest.d.ts +3 -3
  88. package/dist/model/recommendationsRequest.d.ts.map +1 -1
  89. package/dist/model/recommendationsResponse.d.ts +3 -3
  90. package/dist/model/recommendationsResponse.d.ts.map +1 -1
  91. package/dist/model/redirectRuleIndexMetadata.d.ts +21 -0
  92. package/dist/model/redirectRuleIndexMetadata.d.ts.map +1 -0
  93. package/dist/model/redirectRuleIndexMetadataData.d.ts +7 -0
  94. package/dist/model/redirectRuleIndexMetadataData.d.ts.map +1 -0
  95. package/dist/model/removeStopWords.d.ts +4 -4
  96. package/dist/model/removeStopWords.d.ts.map +1 -1
  97. package/dist/model/removeWordsIfNoResults.d.ts +4 -4
  98. package/dist/model/removeWordsIfNoResults.d.ts.map +1 -1
  99. package/dist/model/renderingContent.d.ts +7 -7
  100. package/dist/model/renderingContent.d.ts.map +1 -1
  101. package/dist/model/searchParamsObject.d.ts +3 -3
  102. package/dist/model/searchParamsObject.d.ts.map +1 -1
  103. package/dist/model/searchParamsQuery.d.ts +6 -6
  104. package/dist/model/searchParamsQuery.d.ts.map +1 -1
  105. package/dist/model/snippetResult.d.ts +2 -2
  106. package/dist/model/snippetResult.d.ts.map +1 -1
  107. package/dist/model/snippetResultOption.d.ts +11 -11
  108. package/dist/model/snippetResultOption.d.ts.map +1 -1
  109. package/dist/model/sortRemainingBy.d.ts +4 -4
  110. package/dist/model/sortRemainingBy.d.ts.map +1 -1
  111. package/dist/model/tagFilters.d.ts +5 -5
  112. package/dist/model/tagFilters.d.ts.map +1 -1
  113. package/dist/model/trendingModels.d.ts +4 -4
  114. package/dist/model/trendingModels.d.ts.map +1 -1
  115. package/dist/model/trendingRequest.d.ts +3 -3
  116. package/dist/model/trendingRequest.d.ts.map +1 -1
  117. package/dist/model/typoTolerance.d.ts +5 -5
  118. package/dist/model/typoTolerance.d.ts.map +1 -1
  119. package/dist/model/typoToleranceEnum.d.ts +1 -1
  120. package/dist/model/typoToleranceEnum.d.ts.map +1 -1
  121. package/dist/model/value.d.ts +8 -8
  122. package/dist/model/value.d.ts.map +1 -1
  123. package/dist/recommend.cjs.js +235 -235
  124. package/dist/recommend.esm.browser.js +418 -468
  125. package/dist/recommend.esm.node.js +235 -235
  126. package/dist/recommend.umd.js +2 -2
  127. package/dist/src/recommendClient.d.ts +81 -81
  128. package/dist/src/recommendClient.d.ts.map +1 -1
  129. package/model/advancedSyntaxFeatures.ts +1 -1
  130. package/model/alternativesAsExact.ts +1 -1
  131. package/model/aroundRadius.ts +1 -1
  132. package/model/aroundRadiusAll.ts +1 -1
  133. package/model/baseRecommendRequest.ts +1 -1
  134. package/model/baseRecommendationRequest.ts +1 -1
  135. package/model/baseSearchParams.ts +1 -1
  136. package/model/baseSearchParamsWithoutQuery.ts +1 -1
  137. package/model/baseSearchResponse.ts +4 -1
  138. package/model/baseSearchResponseRedirect.ts +10 -0
  139. package/model/baseTrendingRequest.ts +1 -1
  140. package/model/clientMethodProps.ts +1 -1
  141. package/model/distinct.ts +1 -1
  142. package/model/errorBase.ts +1 -1
  143. package/model/exactOnSingleWordQuery.ts +1 -1
  144. package/model/facetFilters.ts +1 -1
  145. package/model/facetOrdering.ts +1 -1
  146. package/model/facets.ts +1 -1
  147. package/model/facetsStats.ts +1 -1
  148. package/model/getRecommendationsParams.ts +1 -1
  149. package/model/getRecommendationsResponse.ts +1 -1
  150. package/model/highlightResult.ts +1 -1
  151. package/model/highlightResultOption.ts +1 -1
  152. package/model/ignorePlurals.ts +1 -1
  153. package/model/index.ts +6 -1
  154. package/model/indexSettingsAsSearchParams.ts +12 -6
  155. package/model/indexSettingsAsSearchParamsSemanticSearch.ts +11 -0
  156. package/model/matchLevel.ts +1 -1
  157. package/model/matchedGeoLocation.ts +1 -1
  158. package/model/mixedSearchFilters.ts +1 -1
  159. package/model/mode.ts +6 -0
  160. package/model/numericFilters.ts +1 -1
  161. package/model/optionalFilters.ts +1 -1
  162. package/model/personalization.ts +1 -1
  163. package/model/queryType.ts +1 -1
  164. package/model/rankingInfo.ts +1 -1
  165. package/model/reRankingApplyFilter.ts +1 -1
  166. package/model/recommendHit.ts +1 -1
  167. package/model/recommendHits.ts +1 -1
  168. package/model/recommendationModels.ts +1 -1
  169. package/model/recommendationRequest.ts +1 -1
  170. package/model/recommendationsRequest.ts +1 -1
  171. package/model/recommendationsResponse.ts +1 -1
  172. package/model/redirectRuleIndexMetadata.ts +27 -0
  173. package/model/redirectRuleIndexMetadataData.ts +8 -0
  174. package/model/removeStopWords.ts +1 -1
  175. package/model/removeWordsIfNoResults.ts +1 -1
  176. package/model/renderingContent.ts +1 -1
  177. package/model/searchParamsObject.ts +1 -1
  178. package/model/searchParamsQuery.ts +1 -1
  179. package/model/snippetResult.ts +1 -1
  180. package/model/snippetResultOption.ts +1 -1
  181. package/model/sortRemainingBy.ts +1 -1
  182. package/model/tagFilters.ts +1 -1
  183. package/model/trendingModels.ts +1 -1
  184. package/model/trendingRequest.ts +1 -1
  185. package/model/typoTolerance.ts +1 -1
  186. package/model/typoToleranceEnum.ts +1 -1
  187. package/model/value.ts +1 -1
  188. package/package.json +31 -13
@@ -1,6 +1,6 @@
1
- import type { ClientOptions } from '@algolia/client-common';
2
- import type { RecommendClient } from '../src/recommendClient';
3
- export { apiClientVersion, RecommendClient } from '../src/recommendClient';
4
- export * from '../model';
5
- export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
1
+ import type { ClientOptions } from '@algolia/client-common';
2
+ import type { RecommendClient } from '../src/recommendClient';
3
+ export { apiClientVersion, RecommendClient } from '../src/recommendClient';
4
+ export * from '../model';
5
+ export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
6
6
  //# sourceMappingURL=browser.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAe5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CA8BjB"}
1
+ {"version":3,"file":"browser.d.ts","sourceRoot":"","sources":["../../builds/browser.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAe5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CA8BjB"}
@@ -1,6 +1,6 @@
1
- import type { ClientOptions } from '@algolia/client-common';
2
- import type { RecommendClient } from '../src/recommendClient';
3
- export { apiClientVersion, RecommendClient } from '../src/recommendClient';
4
- export * from '../model';
5
- export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
1
+ import type { ClientOptions } from '@algolia/client-common';
2
+ import type { RecommendClient } from '../src/recommendClient';
3
+ export { apiClientVersion, RecommendClient } from '../src/recommendClient';
4
+ export * from '../model';
5
+ export declare function recommendClient(appId: string, apiKey: string, options?: ClientOptions): RecommendClient;
6
6
  //# sourceMappingURL=node.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CAwBjB"}
1
+ {"version":3,"file":"node.d.ts","sourceRoot":"","sources":["../../builds/node.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAW5D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,OAAO,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC3E,cAAc,UAAU,CAAC;AAEzB,wBAAgB,eAAe,CAC7B,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,EACd,OAAO,CAAC,EAAE,aAAa,GACtB,eAAe,CAwBjB"}
@@ -1,2 +1,2 @@
1
- export declare type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
1
+ export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
2
2
  //# sourceMappingURL=advancedSyntaxFeatures.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,oBAAY,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}
1
+ {"version":3,"file":"advancedSyntaxFeatures.d.ts","sourceRoot":"","sources":["../../model/advancedSyntaxFeatures.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,sBAAsB,GAAG,aAAa,GAAG,cAAc,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
1
+ export type AlternativesAsExact = 'ignorePlurals' | 'multiWordsSynonym' | 'singleWordSynonym';
2
2
  //# sourceMappingURL=alternativesAsExact.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,oBAAY,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}
1
+ {"version":3,"file":"alternativesAsExact.d.ts","sourceRoot":"","sources":["../../model/alternativesAsExact.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,mBAAmB,GAC3B,eAAe,GACf,mBAAmB,GACnB,mBAAmB,CAAC"}
@@ -1,6 +1,6 @@
1
- import type { AroundRadiusAll } from './aroundRadiusAll';
2
- /**
3
- * Define the maximum radius for a geo search (in meters).
4
- */
5
- export declare type AroundRadius = AroundRadiusAll | number;
1
+ import type { AroundRadiusAll } from './aroundRadiusAll';
2
+ /**
3
+ * Define the maximum radius for a geo search (in meters).
4
+ */
5
+ export type AroundRadius = AroundRadiusAll | number;
6
6
  //# sourceMappingURL=aroundRadius.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"aroundRadius.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/aroundRadius.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,oBAAY,YAAY,GAAG,eAAe,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"aroundRadius.d.ts","sourceRoot":"","sources":["../../model/aroundRadius.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG,eAAe,GAAG,MAAM,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare type AroundRadiusAll = 'all';
1
+ export type AroundRadiusAll = 'all';
2
2
  //# sourceMappingURL=aroundRadiusAll.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG,KAAK,CAAC"}
1
+ {"version":3,"file":"aroundRadiusAll.d.ts","sourceRoot":"","sources":["../../model/aroundRadiusAll.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG,KAAK,CAAC"}
@@ -1,18 +1,18 @@
1
- import type { SearchParamsObject } from './searchParamsObject';
2
- export declare type BaseRecommendRequest = {
3
- /**
4
- * The Algolia index name.
5
- */
6
- indexName: string;
7
- /**
8
- * The threshold to use when filtering recommendations by their score.
9
- */
10
- threshold: number;
11
- /**
12
- * The max number of recommendations to retrieve. If it\'s set to 0, all the recommendations of the objectID may be returned.
13
- */
14
- maxRecommendations?: number;
15
- queryParameters?: SearchParamsObject;
16
- fallbackParameters?: SearchParamsObject;
17
- };
1
+ import type { SearchParamsObject } from './searchParamsObject';
2
+ export type BaseRecommendRequest = {
3
+ /**
4
+ * The Algolia index name.
5
+ */
6
+ indexName: string;
7
+ /**
8
+ * The threshold to use when filtering recommendations by their score.
9
+ */
10
+ threshold: number;
11
+ /**
12
+ * The max number of recommendations to retrieve. If it\'s set to 0, all the recommendations of the objectID may be returned.
13
+ */
14
+ maxRecommendations?: number;
15
+ queryParameters?: SearchParamsObject;
16
+ fallbackParameters?: SearchParamsObject;
17
+ };
18
18
  //# sourceMappingURL=baseRecommendRequest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,oBAAY,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,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
1
+ {"version":3,"file":"baseRecommendRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,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,kBAAkB,CAAC;IAErC,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC,CAAC"}
@@ -1,9 +1,9 @@
1
- import type { RecommendationModels } from './recommendationModels';
2
- export declare type BaseRecommendationRequest = {
3
- model: RecommendationModels;
4
- /**
5
- * Unique identifier of the object.
6
- */
7
- objectID: string;
8
- };
1
+ import type { RecommendationModels } from './recommendationModels';
2
+ export type BaseRecommendationRequest = {
3
+ model: RecommendationModels;
4
+ /**
5
+ * Unique identifier of the object.
6
+ */
7
+ objectID: string;
8
+ };
9
9
  //# sourceMappingURL=baseRecommendationRequest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"baseRecommendationRequest.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/baseRecommendationRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,oBAAY,yBAAyB,GAAG;IACtC,KAAK,EAAE,oBAAoB,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
1
+ {"version":3,"file":"baseRecommendationRequest.d.ts","sourceRoot":"","sources":["../../model/baseRecommendationRequest.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AAEnE,MAAM,MAAM,yBAAyB,GAAG;IACtC,KAAK,EAAE,oBAAoB,CAAC;IAE5B;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC"}
@@ -1,4 +1,4 @@
1
- import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
2
- import type { SearchParamsQuery } from './searchParamsQuery';
3
- export declare type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
1
+ import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
2
+ import type { SearchParamsQuery } from './searchParamsQuery';
3
+ export type BaseSearchParams = BaseSearchParamsWithoutQuery & SearchParamsQuery;
4
4
  //# sourceMappingURL=baseSearchParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"baseSearchParams.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/baseSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,gCAAgC,CAAC;AACnF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAE7D,oBAAY,gBAAgB,GAAG,4BAA4B,GAAG,iBAAiB,CAAC"}
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,123 +1,123 @@
1
- import type { AroundRadius } from './aroundRadius';
2
- import type { FacetFilters } from './facetFilters';
3
- import type { NumericFilters } from './numericFilters';
4
- import type { OptionalFilters } from './optionalFilters';
5
- import type { ReRankingApplyFilter } from './reRankingApplyFilter';
6
- import type { TagFilters } from './tagFilters';
7
- export declare type BaseSearchParamsWithoutQuery = {
8
- /**
9
- * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
10
- */
11
- similarQuery?: string;
12
- /**
13
- * Filter the query with numeric, facet and/or tag filters.
14
- */
15
- filters?: string;
16
- facetFilters?: FacetFilters;
17
- optionalFilters?: OptionalFilters;
18
- numericFilters?: NumericFilters;
19
- tagFilters?: TagFilters;
20
- /**
21
- * Determines how to calculate the total score for filtering.
22
- */
23
- sumOrFiltersScores?: boolean;
24
- /**
25
- * Retrieve facets and their facet values.
26
- */
27
- facets?: string[];
28
- /**
29
- * Maximum number of facet values to return for each facet during a regular search.
30
- */
31
- maxValuesPerFacet?: number;
32
- /**
33
- * Force faceting to be applied after de-duplication (via the Distinct setting).
34
- */
35
- facetingAfterDistinct?: boolean;
36
- /**
37
- * Controls how facet values are fetched.
38
- */
39
- sortFacetValuesBy?: string;
40
- /**
41
- * Specify the page to retrieve.
42
- */
43
- page?: number;
44
- /**
45
- * Specify the offset of the first hit to return.
46
- */
47
- offset?: number;
48
- /**
49
- * Set the number of hits to retrieve (used only with offset).
50
- */
51
- length?: number;
52
- /**
53
- * Search for entries around a central geolocation, enabling a geo search within a circular area.
54
- */
55
- aroundLatLng?: string;
56
- /**
57
- * Search for entries around a given location automatically computed from the requester\'s IP address.
58
- */
59
- aroundLatLngViaIP?: boolean;
60
- aroundRadius?: AroundRadius;
61
- /**
62
- * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
63
- */
64
- aroundPrecision?: number;
65
- /**
66
- * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
67
- */
68
- minimumAroundRadius?: number;
69
- /**
70
- * Search inside a rectangular area (in geo coordinates).
71
- */
72
- insideBoundingBox?: number[];
73
- /**
74
- * Search inside a polygon (in geo coordinates).
75
- */
76
- insidePolygon?: number[];
77
- /**
78
- * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
79
- */
80
- naturalLanguages?: string[];
81
- /**
82
- * Enables contextual rules.
83
- */
84
- ruleContexts?: string[];
85
- /**
86
- * Define the impact of the Personalization feature.
87
- */
88
- personalizationImpact?: number;
89
- /**
90
- * Associates a certain user token with the current search.
91
- */
92
- userToken?: string;
93
- /**
94
- * Retrieve detailed ranking information.
95
- */
96
- getRankingInfo?: boolean;
97
- /**
98
- * Enable the Click Analytics feature.
99
- */
100
- clickAnalytics?: boolean;
101
- /**
102
- * Whether the current query will be taken into account in the Analytics.
103
- */
104
- analytics?: boolean;
105
- /**
106
- * List of tags to apply to the query for analytics purposes.
107
- */
108
- analyticsTags?: string[];
109
- /**
110
- * Whether to include or exclude a query from the processing-time percentile computation.
111
- */
112
- percentileComputation?: boolean;
113
- /**
114
- * Whether this search should participate in running AB tests.
115
- */
116
- enableABTest?: boolean;
117
- /**
118
- * Whether this search should use AI Re-Ranking.
119
- */
120
- enableReRanking?: boolean;
121
- reRankingApplyFilter?: ReRankingApplyFilter | null;
122
- };
1
+ import type { AroundRadius } from './aroundRadius';
2
+ import type { FacetFilters } from './facetFilters';
3
+ import type { NumericFilters } from './numericFilters';
4
+ import type { OptionalFilters } from './optionalFilters';
5
+ import type { ReRankingApplyFilter } from './reRankingApplyFilter';
6
+ import type { TagFilters } from './tagFilters';
7
+ export type BaseSearchParamsWithoutQuery = {
8
+ /**
9
+ * Overrides the query parameter and performs a more generic search that can be used to find \"similar\" results.
10
+ */
11
+ similarQuery?: string;
12
+ /**
13
+ * Filter the query with numeric, facet and/or tag filters.
14
+ */
15
+ filters?: string;
16
+ facetFilters?: FacetFilters;
17
+ optionalFilters?: OptionalFilters;
18
+ numericFilters?: NumericFilters;
19
+ tagFilters?: TagFilters;
20
+ /**
21
+ * Determines how to calculate the total score for filtering.
22
+ */
23
+ sumOrFiltersScores?: boolean;
24
+ /**
25
+ * Retrieve facets and their facet values.
26
+ */
27
+ facets?: string[];
28
+ /**
29
+ * Maximum number of facet values to return for each facet during a regular search.
30
+ */
31
+ maxValuesPerFacet?: number;
32
+ /**
33
+ * Force faceting to be applied after de-duplication (via the Distinct setting).
34
+ */
35
+ facetingAfterDistinct?: boolean;
36
+ /**
37
+ * Controls how facet values are fetched.
38
+ */
39
+ sortFacetValuesBy?: string;
40
+ /**
41
+ * Specify the page to retrieve.
42
+ */
43
+ page?: number;
44
+ /**
45
+ * Specify the offset of the first hit to return.
46
+ */
47
+ offset?: number;
48
+ /**
49
+ * Set the number of hits to retrieve (used only with offset).
50
+ */
51
+ length?: number;
52
+ /**
53
+ * Search for entries around a central geolocation, enabling a geo search within a circular area.
54
+ */
55
+ aroundLatLng?: string;
56
+ /**
57
+ * Search for entries around a given location automatically computed from the requester\'s IP address.
58
+ */
59
+ aroundLatLngViaIP?: boolean;
60
+ aroundRadius?: AroundRadius;
61
+ /**
62
+ * Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
63
+ */
64
+ aroundPrecision?: number;
65
+ /**
66
+ * Minimum radius (in meters) used for a geo search when aroundRadius is not set.
67
+ */
68
+ minimumAroundRadius?: number;
69
+ /**
70
+ * Search inside a rectangular area (in geo coordinates).
71
+ */
72
+ insideBoundingBox?: number[];
73
+ /**
74
+ * Search inside a polygon (in geo coordinates).
75
+ */
76
+ insidePolygon?: number[];
77
+ /**
78
+ * This parameter changes the default values of certain parameters and settings that work best for a natural language query, such as ignorePlurals, removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts. These parameters and settings work well together when the query is formatted in natural language instead of keywords, for example when your user performs a voice search.
79
+ */
80
+ naturalLanguages?: string[];
81
+ /**
82
+ * Enables contextual rules.
83
+ */
84
+ ruleContexts?: string[];
85
+ /**
86
+ * Define the impact of the Personalization feature.
87
+ */
88
+ personalizationImpact?: number;
89
+ /**
90
+ * Associates a certain user token with the current search.
91
+ */
92
+ userToken?: string;
93
+ /**
94
+ * Retrieve detailed ranking information.
95
+ */
96
+ getRankingInfo?: boolean;
97
+ /**
98
+ * Enable the Click Analytics feature.
99
+ */
100
+ clickAnalytics?: boolean;
101
+ /**
102
+ * Whether the current query will be taken into account in the Analytics.
103
+ */
104
+ analytics?: boolean;
105
+ /**
106
+ * List of tags to apply to the query for analytics purposes.
107
+ */
108
+ analyticsTags?: string[];
109
+ /**
110
+ * Whether to include or exclude a query from the processing-time percentile computation.
111
+ */
112
+ percentileComputation?: boolean;
113
+ /**
114
+ * Whether this search should participate in running AB tests.
115
+ */
116
+ enableABTest?: boolean;
117
+ /**
118
+ * Whether this search should use AI Re-Ranking.
119
+ */
120
+ enableReRanking?: boolean;
121
+ reRankingApplyFilter?: ReRankingApplyFilter | null;
122
+ };
123
123
  //# sourceMappingURL=baseSearchParamsWithoutQuery.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,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,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,oBAAY,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,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;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;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;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,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;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpD,CAAC"}
1
+ {"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,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,oBAAoB,EAAE,MAAM,wBAAwB,CAAC;AACnE,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,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;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;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;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,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;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B,oBAAoB,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACpD,CAAC"}
@@ -1,102 +1,104 @@
1
- import type { FacetsStats } from './facetsStats';
2
- import type { RenderingContent } from './renderingContent';
3
- export declare type BaseSearchResponse = {
4
- /**
5
- * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
6
- */
7
- abTestID?: number;
8
- /**
9
- * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
10
- */
11
- abTestVariantID?: number;
12
- /**
13
- * The computed geo location.
14
- */
15
- aroundLatLng?: string;
16
- /**
17
- * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
18
- */
19
- automaticRadius?: string;
20
- /**
21
- * Whether the facet count is exhaustive or approximate.
22
- */
23
- exhaustiveFacetsCount?: boolean;
24
- /**
25
- * Indicate if the nbHits count was exhaustive or approximate.
26
- */
27
- exhaustiveNbHits: boolean;
28
- /**
29
- * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
30
- */
31
- exhaustiveTypo?: boolean;
32
- /**
33
- * A mapping of each facet name to the corresponding facet counts.
34
- */
35
- facets?: Record<string, Record<string, number>>;
36
- /**
37
- * Statistics for numerical facets.
38
- */
39
- facets_stats?: Record<string, FacetsStats>;
40
- /**
41
- * Set the number of hits per page.
42
- */
43
- hitsPerPage: number;
44
- /**
45
- * Index name used for the query.
46
- */
47
- index?: string;
48
- /**
49
- * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
50
- */
51
- indexUsed?: string;
52
- /**
53
- * Used to return warnings about the query.
54
- */
55
- message?: string;
56
- /**
57
- * Number of hits that the search query matched.
58
- */
59
- nbHits: number;
60
- /**
61
- * Number of pages available for the current query.
62
- */
63
- nbPages: number;
64
- /**
65
- * The number of hits selected and sorted by the relevant sort algorithm.
66
- */
67
- nbSortedHits?: number;
68
- /**
69
- * Specify the page to retrieve.
70
- */
71
- page: number;
72
- /**
73
- * A url-encoded string of all search parameters.
74
- */
75
- params: string;
76
- /**
77
- * The query string that will be searched, after normalization.
78
- */
79
- parsedQuery?: string;
80
- /**
81
- * Time the server took to process the request, in milliseconds.
82
- */
83
- processingTimeMS: number;
84
- /**
85
- * The text to search in the index.
86
- */
87
- query: string;
88
- /**
89
- * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
90
- */
91
- queryAfterRemoval?: string;
92
- /**
93
- * Actual host name of the server that processed the request.
94
- */
95
- serverUsed?: string;
96
- /**
97
- * Lets you store custom data in your indices.
98
- */
99
- userData?: Record<string, any>;
100
- renderingContent?: RenderingContent;
101
- };
1
+ import type { BaseSearchResponseRedirect } from './baseSearchResponseRedirect';
2
+ import type { FacetsStats } from './facetsStats';
3
+ import type { RenderingContent } from './renderingContent';
4
+ export type BaseSearchResponse = {
5
+ /**
6
+ * If a search encounters an index that is being A/B tested, abTestID reports the ongoing A/B test ID.
7
+ */
8
+ abTestID?: number;
9
+ /**
10
+ * If a search encounters an index that is being A/B tested, abTestVariantID reports the variant ID of the index used (starting at 1).
11
+ */
12
+ abTestVariantID?: number;
13
+ /**
14
+ * The computed geo location.
15
+ */
16
+ aroundLatLng?: string;
17
+ /**
18
+ * The automatically computed radius. For legacy reasons, this parameter is a string and not an integer.
19
+ */
20
+ automaticRadius?: string;
21
+ /**
22
+ * Whether the facet count is exhaustive or approximate.
23
+ */
24
+ exhaustiveFacetsCount?: boolean;
25
+ /**
26
+ * Indicate if the nbHits count was exhaustive or approximate.
27
+ */
28
+ exhaustiveNbHits: boolean;
29
+ /**
30
+ * Indicate if the typo-tolerance search was exhaustive or approximate (only included when typo-tolerance is enabled).
31
+ */
32
+ exhaustiveTypo?: boolean;
33
+ /**
34
+ * A mapping of each facet name to the corresponding facet counts.
35
+ */
36
+ facets?: Record<string, Record<string, number>>;
37
+ /**
38
+ * Statistics for numerical facets.
39
+ */
40
+ facets_stats?: Record<string, FacetsStats>;
41
+ /**
42
+ * Set the number of hits per page.
43
+ */
44
+ hitsPerPage: number;
45
+ /**
46
+ * Index name used for the query.
47
+ */
48
+ index?: string;
49
+ /**
50
+ * Index name used for the query. In the case of an A/B test, the targeted index isn\'t always the index used by the query.
51
+ */
52
+ indexUsed?: string;
53
+ /**
54
+ * Used to return warnings about the query.
55
+ */
56
+ message?: string;
57
+ /**
58
+ * Number of hits that the search query matched.
59
+ */
60
+ nbHits: number;
61
+ /**
62
+ * Number of pages available for the current query.
63
+ */
64
+ nbPages: number;
65
+ /**
66
+ * The number of hits selected and sorted by the relevant sort algorithm.
67
+ */
68
+ nbSortedHits?: number;
69
+ /**
70
+ * Specify the page to retrieve.
71
+ */
72
+ page: number;
73
+ /**
74
+ * A url-encoded string of all search parameters.
75
+ */
76
+ params: string;
77
+ redirect?: BaseSearchResponseRedirect;
78
+ /**
79
+ * The query string that will be searched, after normalization.
80
+ */
81
+ parsedQuery?: string;
82
+ /**
83
+ * Time the server took to process the request, in milliseconds.
84
+ */
85
+ processingTimeMS: number;
86
+ /**
87
+ * The text to search in the index.
88
+ */
89
+ query: string;
90
+ /**
91
+ * A markup text indicating which parts of the original query have been removed in order to retrieve a non-empty result set.
92
+ */
93
+ queryAfterRemoval?: string;
94
+ /**
95
+ * Actual host name of the server that processed the request.
96
+ */
97
+ serverUsed?: string;
98
+ /**
99
+ * Lets you store custom data in your indices.
100
+ */
101
+ userData?: Record<string, any>;
102
+ renderingContent?: RenderingContent;
103
+ };
102
104
  //# sourceMappingURL=baseSearchResponse.d.ts.map