@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,161 +1,165 @@
1
- import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
2
- import type { AlternativesAsExact } from './alternativesAsExact';
3
- import type { Distinct } from './distinct';
4
- import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
5
- import type { IgnorePlurals } from './ignorePlurals';
6
- import type { QueryType } from './queryType';
7
- import type { RemoveStopWords } from './removeStopWords';
8
- import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
9
- import type { RenderingContent } from './renderingContent';
10
- import type { TypoTolerance } from './typoTolerance';
11
- export declare type IndexSettingsAsSearchParams = {
12
- /**
13
- * The complete list of attributes that will be used for faceting.
14
- */
15
- attributesForFaceting?: string[];
16
- /**
17
- * List of attributes that can\'t be retrieved at query time.
18
- */
19
- unretrievableAttributes?: string[];
20
- /**
21
- * This parameter controls which attributes to retrieve and which not to retrieve.
22
- */
23
- attributesToRetrieve?: string[];
24
- /**
25
- * Restricts a given query to look in only a subset of your searchable attributes.
26
- */
27
- restrictSearchableAttributes?: string[];
28
- /**
29
- * Controls how Algolia should sort your results.
30
- */
31
- ranking?: string[];
32
- /**
33
- * Specifies the custom ranking criterion.
34
- */
35
- customRanking?: string[];
36
- /**
37
- * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
38
- */
39
- relevancyStrictness?: number;
40
- /**
41
- * List of attributes to highlight.
42
- */
43
- attributesToHighlight?: string[];
44
- /**
45
- * List of attributes to snippet, with an optional maximum number of words to snippet.
46
- */
47
- attributesToSnippet?: string[];
48
- /**
49
- * The HTML string to insert before the highlighted parts in all highlight and snippet results.
50
- */
51
- highlightPreTag?: string;
52
- /**
53
- * The HTML string to insert after the highlighted parts in all highlight and snippet results.
54
- */
55
- highlightPostTag?: string;
56
- /**
57
- * String used as an ellipsis indicator when a snippet is truncated.
58
- */
59
- snippetEllipsisText?: string;
60
- /**
61
- * Restrict highlighting and snippeting to items that matched the query.
62
- */
63
- restrictHighlightAndSnippetArrays?: boolean;
64
- /**
65
- * Set the number of hits per page.
66
- */
67
- hitsPerPage?: number;
68
- /**
69
- * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
70
- */
71
- minWordSizefor1Typo?: number;
72
- /**
73
- * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
74
- */
75
- minWordSizefor2Typos?: number;
76
- typoTolerance?: TypoTolerance;
77
- /**
78
- * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
79
- */
80
- allowTyposOnNumericTokens?: boolean;
81
- /**
82
- * List of attributes on which you want to disable typo tolerance.
83
- */
84
- disableTypoToleranceOnAttributes?: string[];
85
- ignorePlurals?: IgnorePlurals;
86
- removeStopWords?: RemoveStopWords;
87
- /**
88
- * List of characters that the engine shouldn\'t automatically normalize.
89
- */
90
- keepDiacriticsOnCharacters?: string;
91
- /**
92
- * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
93
- */
94
- queryLanguages?: string[];
95
- /**
96
- * Splits compound words into their composing atoms in the query.
97
- */
98
- decompoundQuery?: boolean;
99
- /**
100
- * Whether Rules should be globally enabled.
101
- */
102
- enableRules?: boolean;
103
- /**
104
- * Enable the Personalization feature.
105
- */
106
- enablePersonalization?: boolean;
107
- queryType?: QueryType;
108
- removeWordsIfNoResults?: RemoveWordsIfNoResults;
109
- /**
110
- * Enables the advanced query syntax.
111
- */
112
- advancedSyntax?: boolean;
113
- /**
114
- * A list of words that should be considered as optional when found in the query.
115
- */
116
- optionalWords?: string[];
117
- /**
118
- * List of attributes on which you want to disable the exact ranking criterion.
119
- */
120
- disableExactOnAttributes?: string[];
121
- exactOnSingleWordQuery?: ExactOnSingleWordQuery;
122
- /**
123
- * List of alternatives that should be considered an exact match by the exact ranking criterion.
124
- */
125
- alternativesAsExact?: AlternativesAsExact[];
126
- /**
127
- * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
128
- */
129
- advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
130
- distinct?: Distinct;
131
- /**
132
- * Name of the de-duplication attribute to be used with the distinct feature.
133
- */
134
- attributeForDistinct?: string;
135
- /**
136
- * Whether to take into account an index\'s synonyms for a particular search.
137
- */
138
- synonyms?: boolean;
139
- /**
140
- * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
141
- */
142
- replaceSynonymsInHighlight?: boolean;
143
- /**
144
- * Precision of the proximity ranking criterion.
145
- */
146
- minProximity?: number;
147
- /**
148
- * Choose which fields to return in the API response. This parameters applies to search and browse queries.
149
- */
150
- responseFields?: string[];
151
- /**
152
- * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
153
- */
154
- maxFacetHits?: number;
155
- /**
156
- * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
157
- */
158
- attributeCriteriaComputedByMinProximity?: boolean;
159
- renderingContent?: RenderingContent;
160
- };
1
+ import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
2
+ import type { AlternativesAsExact } from './alternativesAsExact';
3
+ import type { Distinct } from './distinct';
4
+ import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
5
+ import type { IgnorePlurals } from './ignorePlurals';
6
+ import type { IndexSettingsAsSearchParamsSemanticSearch } from './indexSettingsAsSearchParamsSemanticSearch';
7
+ import type { Mode } from './mode';
8
+ import type { QueryType } from './queryType';
9
+ import type { RemoveStopWords } from './removeStopWords';
10
+ import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
11
+ import type { RenderingContent } from './renderingContent';
12
+ import type { TypoTolerance } from './typoTolerance';
13
+ export type IndexSettingsAsSearchParams = {
14
+ /**
15
+ * The complete list of attributes that will be used for faceting.
16
+ */
17
+ attributesForFaceting?: string[];
18
+ /**
19
+ * This parameter controls which attributes to retrieve and which not to retrieve.
20
+ */
21
+ attributesToRetrieve?: string[];
22
+ /**
23
+ * Restricts a given query to look in only a subset of your searchable attributes.
24
+ */
25
+ restrictSearchableAttributes?: string[];
26
+ /**
27
+ * Controls how Algolia should sort your results.
28
+ */
29
+ ranking?: string[];
30
+ /**
31
+ * Specifies the custom ranking criterion.
32
+ */
33
+ customRanking?: string[];
34
+ /**
35
+ * Controls the relevancy threshold below which less relevant results aren\'t included in the results.
36
+ */
37
+ relevancyStrictness?: number;
38
+ /**
39
+ * List of attributes to highlight.
40
+ */
41
+ attributesToHighlight?: string[];
42
+ /**
43
+ * List of attributes to snippet, with an optional maximum number of words to snippet.
44
+ */
45
+ attributesToSnippet?: string[];
46
+ /**
47
+ * The HTML string to insert before the highlighted parts in all highlight and snippet results.
48
+ */
49
+ highlightPreTag?: string;
50
+ /**
51
+ * The HTML string to insert after the highlighted parts in all highlight and snippet results.
52
+ */
53
+ highlightPostTag?: string;
54
+ /**
55
+ * String used as an ellipsis indicator when a snippet is truncated.
56
+ */
57
+ snippetEllipsisText?: string;
58
+ /**
59
+ * Restrict highlighting and snippeting to items that matched the query.
60
+ */
61
+ restrictHighlightAndSnippetArrays?: boolean;
62
+ /**
63
+ * Set the number of hits per page.
64
+ */
65
+ hitsPerPage?: number;
66
+ /**
67
+ * Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
68
+ */
69
+ minWordSizefor1Typo?: number;
70
+ /**
71
+ * Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
72
+ */
73
+ minWordSizefor2Typos?: number;
74
+ typoTolerance?: TypoTolerance;
75
+ /**
76
+ * Whether to allow typos on numbers (\"numeric tokens\") in the query string.
77
+ */
78
+ allowTyposOnNumericTokens?: boolean;
79
+ /**
80
+ * List of attributes on which you want to disable typo tolerance.
81
+ */
82
+ disableTypoToleranceOnAttributes?: string[];
83
+ ignorePlurals?: IgnorePlurals;
84
+ removeStopWords?: RemoveStopWords;
85
+ /**
86
+ * List of characters that the engine shouldn\'t automatically normalize.
87
+ */
88
+ keepDiacriticsOnCharacters?: string;
89
+ /**
90
+ * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
91
+ */
92
+ queryLanguages?: string[];
93
+ /**
94
+ * Splits compound words into their composing atoms in the query.
95
+ */
96
+ decompoundQuery?: boolean;
97
+ /**
98
+ * Whether Rules should be globally enabled.
99
+ */
100
+ enableRules?: boolean;
101
+ /**
102
+ * Enable the Personalization feature.
103
+ */
104
+ enablePersonalization?: boolean;
105
+ queryType?: QueryType;
106
+ removeWordsIfNoResults?: RemoveWordsIfNoResults;
107
+ mode?: Mode;
108
+ semanticSearch?: IndexSettingsAsSearchParamsSemanticSearch;
109
+ /**
110
+ * Enables the advanced query syntax.
111
+ */
112
+ advancedSyntax?: boolean;
113
+ /**
114
+ * A list of words that should be considered as optional when found in the query.
115
+ */
116
+ optionalWords?: string[];
117
+ /**
118
+ * List of attributes on which you want to disable the exact ranking criterion.
119
+ */
120
+ disableExactOnAttributes?: string[];
121
+ exactOnSingleWordQuery?: ExactOnSingleWordQuery;
122
+ /**
123
+ * List of alternatives that should be considered an exact match by the exact ranking criterion.
124
+ */
125
+ alternativesAsExact?: AlternativesAsExact[];
126
+ /**
127
+ * Allows you to specify which advanced syntax features are active when ‘advancedSyntax\' is enabled.
128
+ */
129
+ advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
130
+ /**
131
+ * Enriches the API’s response with meta-information as to how the query was processed.
132
+ */
133
+ explain?: string[];
134
+ distinct?: Distinct;
135
+ /**
136
+ * Name of the de-duplication attribute to be used with the distinct feature.
137
+ */
138
+ attributeForDistinct?: string;
139
+ /**
140
+ * Whether to take into account an index\'s synonyms for a particular search.
141
+ */
142
+ synonyms?: boolean;
143
+ /**
144
+ * Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
145
+ */
146
+ replaceSynonymsInHighlight?: boolean;
147
+ /**
148
+ * Precision of the proximity ranking criterion.
149
+ */
150
+ minProximity?: number;
151
+ /**
152
+ * Choose which fields to return in the API response. This parameters applies to search and browse queries.
153
+ */
154
+ responseFields?: string[];
155
+ /**
156
+ * Maximum number of facet hits to return during a search for facet values. For performance reasons, the maximum allowed number of returned values is 100.
157
+ */
158
+ maxFacetHits?: number;
159
+ /**
160
+ * When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
161
+ */
162
+ attributeCriteriaComputedByMinProximity?: boolean;
163
+ renderingContent?: RenderingContent;
164
+ };
161
165
  //# sourceMappingURL=indexSettingsAsSearchParams.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,oBAAY,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
1
+ {"version":3,"file":"indexSettingsAsSearchParams.d.ts","sourceRoot":"","sources":["../../model/indexSettingsAsSearchParams.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AACrD,OAAO,KAAK,EAAE,yCAAyC,EAAE,MAAM,6CAA6C,CAAC;AAC7G,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AACvE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,MAAM,2BAA2B,GAAG;IACxC;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEhC;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEjC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iCAAiC,CAAC,EAAE,OAAO,CAAC;IAE5C;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5C,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,0BAA0B,CAAC,EAAE,MAAM,CAAC;IAEpC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD,IAAI,CAAC,EAAE,IAAI,CAAC;IAEZ,cAAc,CAAC,EAAE,yCAAyC,CAAC;IAE3D;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,wBAAwB,CAAC,EAAE,MAAM,EAAE,CAAC;IAEpC,sBAAsB,CAAC,EAAE,sBAAsB,CAAC;IAEhD;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAE5C;;OAEG;IACH,sBAAsB,CAAC,EAAE,sBAAsB,EAAE,CAAC;IAElD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAE1B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,uCAAuC,CAAC,EAAE,OAAO,CAAC;IAElD,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACrC,CAAC"}
@@ -0,0 +1,10 @@
1
+ /**
2
+ * The settings relevant for configuration of the semantic search engine. These settings are only used when the mode is set to \'neuralSearch\'.
3
+ */
4
+ export type IndexSettingsAsSearchParamsSemanticSearch = {
5
+ /**
6
+ * When null, the current index / replica group will be used as the event source.
7
+ */
8
+ eventSources?: string[] | null;
9
+ };
10
+ //# sourceMappingURL=indexSettingsAsSearchParamsSemanticSearch.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"indexSettingsAsSearchParamsSemanticSearch.d.ts","sourceRoot":"","sources":["../../model/indexSettingsAsSearchParamsSemanticSearch.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,yCAAyC,GAAG;IACtD;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,CAAC;CAChC,CAAC"}
@@ -1,5 +1,5 @@
1
- /**
2
- * Indicates how well the attribute matched the search query.
3
- */
4
- export declare type MatchLevel = 'full' | 'none' | 'partial';
1
+ /**
2
+ * Indicates how well the attribute matched the search query.
3
+ */
4
+ export type MatchLevel = 'full' | 'none' | 'partial';
5
5
  //# sourceMappingURL=matchLevel.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"matchLevel.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/matchLevel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC"}
1
+ {"version":3,"file":"matchLevel.d.ts","sourceRoot":"","sources":["../../model/matchLevel.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC"}
@@ -1,15 +1,15 @@
1
- export declare type MatchedGeoLocation = {
2
- /**
3
- * Latitude of the matched location.
4
- */
5
- lat?: number;
6
- /**
7
- * Longitude of the matched location.
8
- */
9
- lng?: number;
10
- /**
11
- * Distance between the matched location and the search location (in meters).
12
- */
13
- distance?: number;
14
- };
1
+ export type MatchedGeoLocation = {
2
+ /**
3
+ * Latitude of the matched location.
4
+ */
5
+ lat?: number;
6
+ /**
7
+ * Longitude of the matched location.
8
+ */
9
+ lng?: number;
10
+ /**
11
+ * Distance between the matched location and the search location (in meters).
12
+ */
13
+ distance?: number;
14
+ };
15
15
  //# sourceMappingURL=matchedGeoLocation.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/matchedGeoLocation.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"matchedGeoLocation.d.ts","sourceRoot":"","sources":["../../model/matchedGeoLocation.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC"}
@@ -1,2 +1,2 @@
1
- export declare type MixedSearchFilters = string[] | string;
1
+ export type MixedSearchFilters = string[] | string;
2
2
  //# sourceMappingURL=mixedSearchFilters.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"mixedSearchFilters.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/mixedSearchFilters.ts"],"names":[],"mappings":"AAEA,oBAAY,kBAAkB,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"mixedSearchFilters.d.ts","sourceRoot":"","sources":["../../model/mixedSearchFilters.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,kBAAkB,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * The search mode that the index will use to query for results.
3
+ */
4
+ export type Mode = 'keywordSearch' | 'neuralSearch';
5
+ //# sourceMappingURL=mode.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mode.d.ts","sourceRoot":"","sources":["../../model/mode.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,eAAe,GAAG,cAAc,CAAC"}
@@ -1,6 +1,6 @@
1
- import type { MixedSearchFilters } from './mixedSearchFilters';
2
- /**
3
- * Filter on numeric attributes.
4
- */
5
- export declare type NumericFilters = MixedSearchFilters[] | string;
1
+ import type { MixedSearchFilters } from './mixedSearchFilters';
2
+ /**
3
+ * Filter on numeric attributes.
4
+ */
5
+ export type NumericFilters = MixedSearchFilters[] | string;
6
6
  //# sourceMappingURL=numericFilters.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"numericFilters.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/numericFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,cAAc,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"numericFilters.d.ts","sourceRoot":"","sources":["../../model/numericFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
@@ -1,6 +1,6 @@
1
- import type { MixedSearchFilters } from './mixedSearchFilters';
2
- /**
3
- * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
4
- */
5
- export declare type OptionalFilters = MixedSearchFilters[] | string;
1
+ import type { MixedSearchFilters } from './mixedSearchFilters';
2
+ /**
3
+ * Create filters for ranking purposes, where records that match the filter are ranked higher, or lower in the case of a negative optional filter.
4
+ */
5
+ export type OptionalFilters = MixedSearchFilters[] | string;
6
6
  //# sourceMappingURL=optionalFilters.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"optionalFilters.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/optionalFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,oBAAY,eAAe,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
1
+ {"version":3,"file":"optionalFilters.d.ts","sourceRoot":"","sources":["../../model/optionalFilters.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE/D;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,kBAAkB,EAAE,GAAG,MAAM,CAAC"}
@@ -1,15 +1,15 @@
1
- export declare type Personalization = {
2
- /**
3
- * The score of the filters.
4
- */
5
- filtersScore?: number;
6
- /**
7
- * The score of the ranking.
8
- */
9
- rankingScore?: number;
10
- /**
11
- * The score of the event.
12
- */
13
- score?: number;
14
- };
1
+ export type Personalization = {
2
+ /**
3
+ * The score of the filters.
4
+ */
5
+ filtersScore?: number;
6
+ /**
7
+ * The score of the ranking.
8
+ */
9
+ rankingScore?: number;
10
+ /**
11
+ * The score of the event.
12
+ */
13
+ score?: number;
14
+ };
15
15
  //# sourceMappingURL=personalization.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/personalization.ts"],"names":[],"mappings":"AAEA,oBAAY,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
1
+ {"version":3,"file":"personalization.d.ts","sourceRoot":"","sources":["../../model/personalization.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC"}
@@ -1,5 +1,5 @@
1
- /**
2
- * Controls if and how query words are interpreted as prefixes.
3
- */
4
- export declare type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
1
+ /**
2
+ * Controls if and how query words are interpreted as prefixes.
3
+ */
4
+ export type QueryType = 'prefixAll' | 'prefixLast' | 'prefixNone';
5
5
  //# sourceMappingURL=queryType.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"queryType.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/queryType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,oBAAY,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC"}
1
+ {"version":3,"file":"queryType.d.ts","sourceRoot":"","sources":["../../model/queryType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,YAAY,GAAG,YAAY,CAAC"}
@@ -1,51 +1,51 @@
1
- import type { MatchedGeoLocation } from './matchedGeoLocation';
2
- import type { Personalization } from './personalization';
3
- export declare type RankingInfo = {
4
- /**
5
- * This field is reserved for advanced usage.
6
- */
7
- filters: number;
8
- /**
9
- * Position of the most important matched attribute in the attributes to index list.
10
- */
11
- firstMatchedWord: number;
12
- /**
13
- * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
14
- */
15
- geoDistance: number;
16
- /**
17
- * Precision used when computing the geo distance, in meters.
18
- */
19
- geoPrecision?: number;
20
- matchedGeoLocation?: MatchedGeoLocation;
21
- personalization?: Personalization;
22
- /**
23
- * Number of exactly matched words.
24
- */
25
- nbExactWords: number;
26
- /**
27
- * Number of typos encountered when matching the record.
28
- */
29
- nbTypos: number;
30
- /**
31
- * Present and set to true if a Rule promoted the hit.
32
- */
33
- promoted: boolean;
34
- /**
35
- * When the query contains more than one word, the sum of the distances between matched words (in meters).
36
- */
37
- proximityDistance?: number;
38
- /**
39
- * Custom ranking for the object, expressed as a single integer value.
40
- */
41
- userScore: number;
42
- /**
43
- * Number of matched words, including prefixes and typos.
44
- */
45
- words: number;
46
- /**
47
- * Wether the record are promoted by the re-ranking strategy.
48
- */
49
- promotedByReRanking?: boolean;
50
- };
1
+ import type { MatchedGeoLocation } from './matchedGeoLocation';
2
+ import type { Personalization } from './personalization';
3
+ export type RankingInfo = {
4
+ /**
5
+ * This field is reserved for advanced usage.
6
+ */
7
+ filters: number;
8
+ /**
9
+ * Position of the most important matched attribute in the attributes to index list.
10
+ */
11
+ firstMatchedWord: number;
12
+ /**
13
+ * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
14
+ */
15
+ geoDistance: number;
16
+ /**
17
+ * Precision used when computing the geo distance, in meters.
18
+ */
19
+ geoPrecision?: number;
20
+ matchedGeoLocation?: MatchedGeoLocation;
21
+ personalization?: Personalization;
22
+ /**
23
+ * Number of exactly matched words.
24
+ */
25
+ nbExactWords: number;
26
+ /**
27
+ * Number of typos encountered when matching the record.
28
+ */
29
+ nbTypos: number;
30
+ /**
31
+ * Present and set to true if a Rule promoted the hit.
32
+ */
33
+ promoted: boolean;
34
+ /**
35
+ * When the query contains more than one word, the sum of the distances between matched words (in meters).
36
+ */
37
+ proximityDistance?: number;
38
+ /**
39
+ * Custom ranking for the object, expressed as a single integer value.
40
+ */
41
+ userScore: number;
42
+ /**
43
+ * Number of matched words, including prefixes and typos.
44
+ */
45
+ words: number;
46
+ /**
47
+ * Wether the record are promoted by the re-ranking strategy.
48
+ */
49
+ promotedByReRanking?: boolean;
50
+ };
51
51
  //# sourceMappingURL=rankingInfo.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,oBAAY,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}
1
+ {"version":3,"file":"rankingInfo.d.ts","sourceRoot":"","sources":["../../model/rankingInfo.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IAExC,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B,CAAC"}