algoliasearch 5.0.0-alpha.110 → 5.0.0-alpha.112

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 (125) hide show
  1. package/dist/algoliasearch/builds/browser.d.ts +1 -1
  2. package/dist/algoliasearch/builds/node.d.ts +1 -1
  3. package/dist/algoliasearch.cjs +62 -62
  4. package/dist/algoliasearch.esm.browser.js +64 -67
  5. package/dist/algoliasearch.esm.node.js +62 -62
  6. package/dist/algoliasearch.umd.js +2 -2
  7. package/dist/client-abtesting/model/aBTest.d.ts +9 -24
  8. package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
  9. package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
  10. package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
  11. package/dist/client-abtesting/model/aBTestResponse.d.ts +2 -2
  12. package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
  13. package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
  14. package/dist/client-abtesting/model/clientMethodProps.d.ts +5 -5
  15. package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
  16. package/dist/client-abtesting/model/effect.d.ts +5 -0
  17. package/dist/client-abtesting/model/effect.d.ts.map +1 -0
  18. package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
  19. package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
  20. package/dist/client-abtesting/model/index.d.ts +6 -0
  21. package/dist/client-abtesting/model/index.d.ts.map +1 -1
  22. package/dist/client-abtesting/model/listABTestsResponse.d.ts +1 -1
  23. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
  24. package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
  25. package/dist/client-abtesting/model/outliers.d.ts +10 -0
  26. package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
  27. package/dist/client-abtesting/model/status.d.ts +5 -0
  28. package/dist/client-abtesting/model/status.d.ts.map +1 -0
  29. package/dist/client-abtesting/model/variant.d.ts +13 -13
  30. package/dist/client-abtesting/src/abtestingClient.d.ts +11 -11
  31. package/dist/client-analytics/model/clientMethodProps.d.ts +38 -38
  32. package/dist/client-analytics/model/getStatusResponse.d.ts +1 -1
  33. package/dist/client-analytics/src/analyticsClient.d.ts +39 -39
  34. package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
  35. package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
  36. package/dist/client-personalization/model/eventScoring.d.ts +4 -6
  37. package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
  38. package/dist/client-personalization/model/eventType.d.ts +5 -0
  39. package/dist/client-personalization/model/eventType.d.ts.map +1 -0
  40. package/dist/client-personalization/model/facetScoring.d.ts +2 -2
  41. package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
  42. package/dist/client-personalization/model/index.d.ts +1 -0
  43. package/dist/client-personalization/model/index.d.ts.map +1 -1
  44. package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
  45. package/dist/client-personalization/src/personalizationClient.d.ts +7 -7
  46. package/dist/client-search/model/addApiKeyResponse.d.ts +1 -1
  47. package/dist/client-search/model/baseGetApiKeyResponse.d.ts +1 -1
  48. package/dist/client-search/model/baseIndexSettings.d.ts +10 -10
  49. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +5 -4
  50. package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  51. package/dist/client-search/model/clientMethodProps.d.ts +4 -4
  52. package/dist/client-search/model/createdAtResponse.d.ts +1 -1
  53. package/dist/client-search/model/deleteApiKeyResponse.d.ts +1 -1
  54. package/dist/client-search/model/deleteByParams.d.ts +2 -2
  55. package/dist/client-search/model/deleteSourceResponse.d.ts +1 -1
  56. package/dist/client-search/model/deletedAtResponse.d.ts +1 -1
  57. package/dist/client-search/model/exactOnSingleWordQuery.d.ts +1 -1
  58. package/dist/client-search/model/fetchedIndex.d.ts +1 -1
  59. package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +10 -10
  60. package/dist/client-search/model/log.d.ts +1 -1
  61. package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
  62. package/dist/client-search/model/operationIndexParams.d.ts +1 -1
  63. package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
  64. package/dist/client-search/model/removeUserIdResponse.d.ts +1 -1
  65. package/dist/client-search/model/removeWordsIfNoResults.d.ts +1 -1
  66. package/dist/client-search/model/replaceSourceResponse.d.ts +1 -1
  67. package/dist/client-search/model/saveObjectResponse.d.ts +1 -1
  68. package/dist/client-search/model/saveSynonymResponse.d.ts +1 -1
  69. package/dist/client-search/model/searchForFacetsOptions.d.ts +1 -1
  70. package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
  71. package/dist/client-search/model/searchParamsObject.d.ts +3 -0
  72. package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
  73. package/dist/client-search/model/searchUserIdsResponse.d.ts +1 -1
  74. package/dist/client-search/model/securedAPIKeyRestrictions.d.ts +1 -1
  75. package/dist/client-search/model/sortRemainingBy.d.ts +1 -1
  76. package/dist/client-search/model/updateApiKeyResponse.d.ts +1 -1
  77. package/dist/client-search/model/updatedAtResponse.d.ts +1 -1
  78. package/dist/client-search/model/updatedAtWithObjectIdResponse.d.ts +1 -1
  79. package/dist/client-search/model/updatedRuleResponse.d.ts +1 -1
  80. package/dist/client-search/model/userHit.d.ts +1 -1
  81. package/dist/client-search/model/userId.d.ts +1 -1
  82. package/dist/client-search/src/searchClient.d.ts +5 -5
  83. package/dist/lite/lite.cjs +1 -1
  84. package/dist/lite/lite.esm.browser.js +3 -6
  85. package/dist/lite/lite.esm.node.js +1 -1
  86. package/dist/lite/lite.umd.js +2 -2
  87. package/dist/lite/model/addApiKeyResponse.d.ts +1 -1
  88. package/dist/lite/model/baseGetApiKeyResponse.d.ts +1 -1
  89. package/dist/lite/model/baseIndexSettings.d.ts +10 -10
  90. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +5 -4
  91. package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
  92. package/dist/lite/model/deleteByParams.d.ts +2 -2
  93. package/dist/lite/model/exactOnSingleWordQuery.d.ts +1 -1
  94. package/dist/lite/model/fetchedIndex.d.ts +1 -1
  95. package/dist/lite/model/indexSettingsAsSearchParams.d.ts +10 -10
  96. package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
  97. package/dist/lite/model/removeWordsIfNoResults.d.ts +1 -1
  98. package/dist/lite/model/searchForFacetsOptions.d.ts +1 -1
  99. package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
  100. package/dist/lite/model/searchParamsObject.d.ts +3 -0
  101. package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
  102. package/dist/lite/model/securedAPIKeyRestrictions.d.ts +1 -1
  103. package/dist/lite/model/sortRemainingBy.d.ts +1 -1
  104. package/dist/lite/model/updatedRuleResponse.d.ts +1 -1
  105. package/dist/lite/model/userId.d.ts +1 -1
  106. package/dist/lite/src/liteClient.d.ts +1 -1
  107. package/lite/model/addApiKeyResponse.ts +1 -1
  108. package/lite/model/baseGetApiKeyResponse.ts +1 -1
  109. package/lite/model/baseIndexSettings.ts +10 -10
  110. package/lite/model/baseSearchParamsWithoutQuery.ts +5 -4
  111. package/lite/model/deleteByParams.ts +2 -2
  112. package/lite/model/exactOnSingleWordQuery.ts +1 -1
  113. package/lite/model/fetchedIndex.ts +1 -1
  114. package/lite/model/indexSettingsAsSearchParams.ts +10 -10
  115. package/lite/model/reRankingApplyFilter.ts +1 -1
  116. package/lite/model/removeWordsIfNoResults.ts +1 -1
  117. package/lite/model/searchForFacetsOptions.ts +1 -1
  118. package/lite/model/searchForHitsOptions.ts +1 -1
  119. package/lite/model/searchParamsObject.ts +3 -0
  120. package/lite/model/securedAPIKeyRestrictions.ts +1 -1
  121. package/lite/model/sortRemainingBy.ts +1 -1
  122. package/lite/model/updatedRuleResponse.ts +1 -1
  123. package/lite/model/userId.ts +1 -1
  124. package/lite/src/liteClient.ts +1 -1
  125. package/package.json +12 -12
@@ -20,7 +20,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
20
20
  import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
21
21
  import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
22
22
  import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
23
- export declare const apiClientVersion = "5.0.0-alpha.110";
23
+ export declare const apiClientVersion = "5.0.0-alpha.112";
24
24
  export declare const REGIONS: readonly ["de", "us"];
25
25
  export type Region = (typeof REGIONS)[number];
26
26
  export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -92,8 +92,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
92
92
  *
93
93
  * @param getAddToCartRate - The getAddToCartRate object.
94
94
  * @param getAddToCartRate.index - Index name.
95
- * @param getAddToCartRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
96
- * @param getAddToCartRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
95
+ * @param getAddToCartRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
96
+ * @param getAddToCartRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
97
97
  * @param getAddToCartRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
98
98
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
99
99
  */
@@ -106,8 +106,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
106
106
  *
107
107
  * @param getAverageClickPosition - The getAverageClickPosition object.
108
108
  * @param getAverageClickPosition.index - Index name.
109
- * @param getAverageClickPosition.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
110
- * @param getAverageClickPosition.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
109
+ * @param getAverageClickPosition.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
110
+ * @param getAverageClickPosition.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
111
111
  * @param getAverageClickPosition.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
112
112
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
113
113
  */
@@ -120,8 +120,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
120
120
  *
121
121
  * @param getClickPositions - The getClickPositions object.
122
122
  * @param getClickPositions.index - Index name.
123
- * @param getClickPositions.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
124
- * @param getClickPositions.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
123
+ * @param getClickPositions.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
124
+ * @param getClickPositions.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
125
125
  * @param getClickPositions.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
126
126
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
127
127
  */
@@ -134,8 +134,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
134
134
  *
135
135
  * @param getClickThroughRate - The getClickThroughRate object.
136
136
  * @param getClickThroughRate.index - Index name.
137
- * @param getClickThroughRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
138
- * @param getClickThroughRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
137
+ * @param getClickThroughRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
138
+ * @param getClickThroughRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
139
139
  * @param getClickThroughRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
140
140
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
141
141
  */
@@ -148,8 +148,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
148
148
  *
149
149
  * @param getConversionRate - The getConversionRate object.
150
150
  * @param getConversionRate.index - Index name.
151
- * @param getConversionRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
152
- * @param getConversionRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
151
+ * @param getConversionRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
152
+ * @param getConversionRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
153
153
  * @param getConversionRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
154
154
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
155
155
  */
@@ -162,8 +162,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
162
162
  *
163
163
  * @param getNoClickRate - The getNoClickRate object.
164
164
  * @param getNoClickRate.index - Index name.
165
- * @param getNoClickRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
166
- * @param getNoClickRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
165
+ * @param getNoClickRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
166
+ * @param getNoClickRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
167
167
  * @param getNoClickRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
168
168
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
169
169
  */
@@ -176,8 +176,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
176
176
  *
177
177
  * @param getNoResultsRate - The getNoResultsRate object.
178
178
  * @param getNoResultsRate.index - Index name.
179
- * @param getNoResultsRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
180
- * @param getNoResultsRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
179
+ * @param getNoResultsRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
180
+ * @param getNoResultsRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
181
181
  * @param getNoResultsRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
182
182
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
183
183
  */
@@ -190,8 +190,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
190
190
  *
191
191
  * @param getPurchaseRate - The getPurchaseRate object.
192
192
  * @param getPurchaseRate.index - Index name.
193
- * @param getPurchaseRate.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
194
- * @param getPurchaseRate.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
193
+ * @param getPurchaseRate.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
194
+ * @param getPurchaseRate.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
195
195
  * @param getPurchaseRate.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
196
196
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
197
197
  */
@@ -204,8 +204,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
204
204
  *
205
205
  * @param getRevenue - The getRevenue object.
206
206
  * @param getRevenue.index - Index name.
207
- * @param getRevenue.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
208
- * @param getRevenue.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
207
+ * @param getRevenue.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
208
+ * @param getRevenue.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
209
209
  * @param getRevenue.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
210
210
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
211
211
  */
@@ -218,8 +218,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
218
218
  *
219
219
  * @param getSearchesCount - The getSearchesCount object.
220
220
  * @param getSearchesCount.index - Index name.
221
- * @param getSearchesCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
222
- * @param getSearchesCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
221
+ * @param getSearchesCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
222
+ * @param getSearchesCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
223
223
  * @param getSearchesCount.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
224
224
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
225
225
  */
@@ -232,8 +232,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
232
232
  *
233
233
  * @param getSearchesNoClicks - The getSearchesNoClicks object.
234
234
  * @param getSearchesNoClicks.index - Index name.
235
- * @param getSearchesNoClicks.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
236
- * @param getSearchesNoClicks.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
235
+ * @param getSearchesNoClicks.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
236
+ * @param getSearchesNoClicks.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
237
237
  * @param getSearchesNoClicks.limit - Number of items to return.
238
238
  * @param getSearchesNoClicks.offset - Position of the first item to return.
239
239
  * @param getSearchesNoClicks.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -248,8 +248,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
248
248
  *
249
249
  * @param getSearchesNoResults - The getSearchesNoResults object.
250
250
  * @param getSearchesNoResults.index - Index name.
251
- * @param getSearchesNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
252
- * @param getSearchesNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
251
+ * @param getSearchesNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
252
+ * @param getSearchesNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
253
253
  * @param getSearchesNoResults.limit - Number of items to return.
254
254
  * @param getSearchesNoResults.offset - Position of the first item to return.
255
255
  * @param getSearchesNoResults.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -275,8 +275,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
275
275
  *
276
276
  * @param getTopCountries - The getTopCountries object.
277
277
  * @param getTopCountries.index - Index name.
278
- * @param getTopCountries.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
279
- * @param getTopCountries.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
278
+ * @param getTopCountries.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
279
+ * @param getTopCountries.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
280
280
  * @param getTopCountries.limit - Number of items to return.
281
281
  * @param getTopCountries.offset - Position of the first item to return.
282
282
  * @param getTopCountries.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -292,8 +292,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
292
292
  * @param getTopFilterAttributes - The getTopFilterAttributes object.
293
293
  * @param getTopFilterAttributes.index - Index name.
294
294
  * @param getTopFilterAttributes.search - Search query.
295
- * @param getTopFilterAttributes.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
296
- * @param getTopFilterAttributes.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
295
+ * @param getTopFilterAttributes.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
296
+ * @param getTopFilterAttributes.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
297
297
  * @param getTopFilterAttributes.limit - Number of items to return.
298
298
  * @param getTopFilterAttributes.offset - Position of the first item to return.
299
299
  * @param getTopFilterAttributes.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -310,8 +310,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
310
310
  * @param getTopFilterForAttribute.attribute - Attribute name.
311
311
  * @param getTopFilterForAttribute.index - Index name.
312
312
  * @param getTopFilterForAttribute.search - Search query.
313
- * @param getTopFilterForAttribute.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
314
- * @param getTopFilterForAttribute.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
313
+ * @param getTopFilterForAttribute.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
314
+ * @param getTopFilterForAttribute.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
315
315
  * @param getTopFilterForAttribute.limit - Number of items to return.
316
316
  * @param getTopFilterForAttribute.offset - Position of the first item to return.
317
317
  * @param getTopFilterForAttribute.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -327,8 +327,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
327
327
  * @param getTopFiltersNoResults - The getTopFiltersNoResults object.
328
328
  * @param getTopFiltersNoResults.index - Index name.
329
329
  * @param getTopFiltersNoResults.search - Search query.
330
- * @param getTopFiltersNoResults.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
331
- * @param getTopFiltersNoResults.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
330
+ * @param getTopFiltersNoResults.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
331
+ * @param getTopFiltersNoResults.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
332
332
  * @param getTopFiltersNoResults.limit - Number of items to return.
333
333
  * @param getTopFiltersNoResults.offset - Position of the first item to return.
334
334
  * @param getTopFiltersNoResults.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -346,8 +346,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
346
346
  * @param getTopHits.search - Search query.
347
347
  * @param getTopHits.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
348
348
  * @param getTopHits.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
349
- * @param getTopHits.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
350
- * @param getTopHits.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
349
+ * @param getTopHits.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
350
+ * @param getTopHits.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
351
351
  * @param getTopHits.limit - Number of items to return.
352
352
  * @param getTopHits.offset - Position of the first item to return.
353
353
  * @param getTopHits.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
@@ -364,8 +364,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
364
364
  * @param getTopSearches.index - Index name.
365
365
  * @param getTopSearches.clickAnalytics - Whether to include metrics related to click and conversion events in the response.
366
366
  * @param getTopSearches.revenueAnalytics - Whether to include revenue-related metrics in the response. If true, metrics related to click and conversion events are also included in the response.
367
- * @param getTopSearches.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
368
- * @param getTopSearches.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
367
+ * @param getTopSearches.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
368
+ * @param getTopSearches.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
369
369
  * @param getTopSearches.orderBy - Attribute by which to order the response items. If the `clickAnalytics` parameter is false, only `searchCount` is available.
370
370
  * @param getTopSearches.direction - Sorting direction of the results: ascending or descending.
371
371
  * @param getTopSearches.limit - Number of items to return.
@@ -382,8 +382,8 @@ export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiK
382
382
  *
383
383
  * @param getUsersCount - The getUsersCount object.
384
384
  * @param getUsersCount.index - Index name.
385
- * @param getUsersCount.startDate - Start date (`YYYY-MM-DD`) of the period to analyze.
386
- * @param getUsersCount.endDate - End date (`YYYY-MM-DD`) of the period to analyze.
385
+ * @param getUsersCount.startDate - Start date of the period to analyze, in `YYYY-MM-DD` format.
386
+ * @param getUsersCount.endDate - End date of the period to analyze, in `YYYY-MM-DD` format.
387
387
  * @param getUsersCount.tags - Tags by which to segment the analytics. You can combine multiple tags with `OR` and `AND`. Tags must be URL-encoded. For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
388
388
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
389
389
  */
@@ -63,7 +63,7 @@ export type CustomPutProps = {
63
63
  */
64
64
  export type DeleteUserProfileProps = {
65
65
  /**
66
- * UserToken representing the user for which to fetch the Personalization profile.
66
+ * Unique identifier representing a user for which to fetch the personalization profile.
67
67
  */
68
68
  userToken: string;
69
69
  };
@@ -72,7 +72,7 @@ export type DeleteUserProfileProps = {
72
72
  */
73
73
  export type GetUserTokenProfileProps = {
74
74
  /**
75
- * UserToken representing the user for which to fetch the Personalization profile.
75
+ * Unique identifier representing a user for which to fetch the personalization profile.
76
76
  */
77
77
  userToken: string;
78
78
  };
@@ -1,10 +1,10 @@
1
1
  export type DeleteUserProfileResponse = {
2
2
  /**
3
- * UserToken representing the user for which to fetch the Personalization profile.
3
+ * 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/).
4
4
  */
5
5
  userToken: string;
6
6
  /**
7
- * A date until which the data can safely be considered as deleted for the given user. Any data received after the `deletedUntil` date will start building a new user profile.
7
+ * Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile.
8
8
  */
9
9
  deletedUntil: string;
10
10
  };
@@ -1,15 +1,13 @@
1
+ import type { EventType } from './eventType';
1
2
  export type EventScoring = {
2
3
  /**
3
- * The score for the event.
4
+ * Event score.
4
5
  */
5
6
  score: number;
6
7
  /**
7
- * The name of the event.
8
+ * Event name.
8
9
  */
9
10
  eventName: string;
10
- /**
11
- * The type of the event.
12
- */
13
- eventType: string;
11
+ eventType: EventType;
14
12
  };
15
13
  //# sourceMappingURL=eventScoring.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"eventScoring.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/eventScoring.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}
1
+ {"version":3,"file":"eventScoring.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/eventScoring.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC"}
@@ -0,0 +1,5 @@
1
+ /**
2
+ * Event type.
3
+ */
4
+ export type EventType = 'click' | 'conversion' | 'view';
5
+ //# sourceMappingURL=eventType.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"eventType.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/eventType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC"}
@@ -1,10 +1,10 @@
1
1
  export type FacetScoring = {
2
2
  /**
3
- * The score for the event.
3
+ * Event score.
4
4
  */
5
5
  score: number;
6
6
  /**
7
- * The name of the facet.
7
+ * Facet attribute name.
8
8
  */
9
9
  facetName: string;
10
10
  };
@@ -1,14 +1,14 @@
1
1
  export type GetUserTokenResponse = {
2
2
  /**
3
- * UserToken representing the user for which to fetch the Personalization profile.
3
+ * 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/).
4
4
  */
5
5
  userToken: string;
6
6
  /**
7
- * Date of last event update. (ISO-8601 format).
7
+ * Date and time of the last event from this user, in RFC 3339 format.
8
8
  */
9
9
  lastEventAt: string;
10
10
  /**
11
- * The userToken scores.
11
+ * Scores for different facet values. Scores represent the user affinity for a user profile towards specific facet values, given the personalization strategy and past events.
12
12
  */
13
13
  scores: Record<string, any>;
14
14
  };
@@ -1,6 +1,7 @@
1
1
  export * from './deleteUserProfileResponse';
2
2
  export * from './errorBase';
3
3
  export * from './eventScoring';
4
+ export * from './eventType';
4
5
  export * from './facetScoring';
5
6
  export * from './getUserTokenResponse';
6
7
  export * from './personalizationStrategyParams';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qBAAqB,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qBAAqB,CAAC"}
@@ -2,15 +2,15 @@ import type { EventScoring } from './eventScoring';
2
2
  import type { FacetScoring } from './facetScoring';
3
3
  export type PersonalizationStrategyParams = {
4
4
  /**
5
- * Scores associated with the events.
5
+ * Scores associated with each event. The higher the scores, the higher the impact of those events on the personalization of search results.
6
6
  */
7
7
  eventScoring: EventScoring[];
8
8
  /**
9
- * Scores associated with the facets.
9
+ * Scores associated with each facet. The higher the scores, the higher the impact of those events on the personalization of search results.
10
10
  */
11
11
  facetScoring: FacetScoring[];
12
12
  /**
13
- * The impact that personalization has on search results: a number between 0 (personalization disabled) and 100 (personalization fully enabled).
13
+ * Impact of personalization on the search results. If set to 0, personalization has no impact on the search results.
14
14
  */
15
15
  personalizationImpact: number;
16
16
  };
@@ -4,7 +4,7 @@ import type { DeleteUserProfileResponse } from '../model/deleteUserProfileRespon
4
4
  import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
5
5
  import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
6
6
  import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
7
- export declare const apiClientVersion = "5.0.0-alpha.110";
7
+ export declare const apiClientVersion = "5.0.0-alpha.112";
8
8
  export declare const REGIONS: readonly ["eu", "us"];
9
9
  export type Region = (typeof REGIONS)[number];
10
10
  export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
@@ -69,18 +69,18 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
69
69
  */
70
70
  customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
71
71
  /**
72
- * Delete the user profile and all its associated data. Returns, as part of the response, a date until which the data can safely be considered as deleted for the given user. This means if you send events for the given user before this date, they will be ignored. Any data received after the deletedUntil date will start building a new user profile. It might take a couple hours for the deletion request to be fully processed.
72
+ * Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.
73
73
  *
74
74
  * Required API Key ACLs:
75
75
  * - recommendation.
76
76
  *
77
77
  * @param deleteUserProfile - The deleteUserProfile object.
78
- * @param deleteUserProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
78
+ * @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
79
79
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
80
80
  */
81
81
  deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<DeleteUserProfileResponse>;
82
82
  /**
83
- * The strategy contains information on the events and facets that impact user profiles and personalized search results.
83
+ * Retrieves the current personalization strategy.
84
84
  *
85
85
  * Required API Key ACLs:
86
86
  * - recommendation.
@@ -89,18 +89,18 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
89
89
  */
90
90
  getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
91
91
  /**
92
- * Get the user profile built from Personalization strategy. The profile is structured by facet name used in the strategy. Each facet value is mapped to its score. Each score represents the user affinity for a specific facet value given the userToken past events and the Personalization strategy defined. Scores are bounded to 20. The last processed event timestamp is provided using the ISO 8601 format for debugging purposes.
92
+ * Retrieves a user profile and their affinities for different facets.
93
93
  *
94
94
  * Required API Key ACLs:
95
95
  * - recommendation.
96
96
  *
97
97
  * @param getUserTokenProfile - The getUserTokenProfile object.
98
- * @param getUserTokenProfile.userToken - UserToken representing the user for which to fetch the Personalization profile.
98
+ * @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
99
99
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
100
100
  */
101
101
  getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<GetUserTokenResponse>;
102
102
  /**
103
- * A strategy defines the events and facets that impact user profiles and personalized search results.
103
+ * Creates a new personalization strategy.
104
104
  *
105
105
  * Required API Key ACLs:
106
106
  * - recommendation.
@@ -4,7 +4,7 @@ export type AddApiKeyResponse = {
4
4
  */
5
5
  key: string;
6
6
  /**
7
- * Timestamp of creation in [ISO 8601](https://wikipedia.org/wiki/ISO_8601) format.
7
+ * Date and time when the object was created, in RFC 3339 format.
8
8
  */
9
9
  createdAt: string;
10
10
  };
@@ -4,7 +4,7 @@ export type BaseGetApiKeyResponse = {
4
4
  */
5
5
  value?: string;
6
6
  /**
7
- * Timestamp of creation in milliseconds in [Unix epoch time](https://wikipedia.org/wiki/Unix_time).
7
+ * Timestamp when the object was created, in milliseconds since the Unix epoch.
8
8
  */
9
9
  createdAt: number;
10
10
  };
@@ -1,11 +1,11 @@
1
1
  import type { SupportedLanguage } from './supportedLanguage';
2
2
  export type BaseIndexSettings = {
3
3
  /**
4
- * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are ways to categorize search results based on attributes. Facets can be used to let user filter search results. By default, no attribute is used for faceting. **Modifiers** <dl> <dt><code>filterOnly(\"ATTRIBUTE\")</code></dt> <dd>Allows using this attribute as a filter, but doesn\'t evalue the facet values.</dd> <dt><code>searchable(\"ATTRIBUTE\")</code></dt> <dd>Allows searching for facet values.</dd> <dt><code>afterDistinct(\"ATTRIBUTE\")</code></dt> <dd> Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`. </dd> </dl> Without modifiers, the attribute is used as a regular facet.
4
+ * Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn\'t evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
5
5
  */
6
6
  attributesForFaceting?: string[];
7
7
  /**
8
- * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** <dl> <dt><code>virtual(\"REPLICA\")</code></dt> <dd> Create a virtual replica, Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/). </dd> </dl> Without modifier, a standard replica is created, which duplicates your record count and is used for strict, or [exhaustive sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/exhaustive-sort/).
8
+ * Creates [replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/). Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you want to offer a different ranking or sorting of your search results, you\'ll use replica indices. All index operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must provide the complete set of replicas to this parameter. If you omit a replica from this list, the replica turns into a regular, standalone index that will no longer by synced with the primary index. **Modifier** - `virtual(\"REPLICA\")`. Create a virtual replica, Virtual replicas don\'t increase the number of records and are optimized for [Relevant sorting](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/relevant-sort/).
9
9
  */
10
10
  replicas?: string[];
11
11
  /**
@@ -13,7 +13,7 @@ export type BaseIndexSettings = {
13
13
  */
14
14
  paginationLimitedTo?: number;
15
15
  /**
16
- * Attributes that can\'t be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results.
16
+ * Attributes that can\'t be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results. Attribute names are case-sensitive.
17
17
  */
18
18
  unretrievableAttributes?: string[];
19
19
  /**
@@ -21,15 +21,15 @@ export type BaseIndexSettings = {
21
21
  */
22
22
  disableTypoToleranceOnWords?: string[];
23
23
  /**
24
- * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese.
24
+ * Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
25
25
  */
26
26
  attributesToTransliterate?: string[];
27
27
  /**
28
- * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
28
+ * Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
29
29
  */
30
30
  camelCaseAttributes?: string[];
31
31
  /**
32
- * Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
32
+ * Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
33
33
  */
34
34
  decompoundedAttributes?: Record<string, any>;
35
35
  /**
@@ -37,7 +37,7 @@ export type BaseIndexSettings = {
37
37
  */
38
38
  indexLanguages?: SupportedLanguage[];
39
39
  /**
40
- * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
40
+ * Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
41
41
  */
42
42
  disablePrefixOnAttributes?: string[];
43
43
  /**
@@ -45,7 +45,7 @@ export type BaseIndexSettings = {
45
45
  */
46
46
  allowCompressionOfIntegerArray?: boolean;
47
47
  /**
48
- * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** <dl> <dt><code>equalOnly(\"ATTRIBUTE\")</code></dt> <dd> Support only filtering based on equality comparisons `=` and `!=`. </dd> </dl> Without modifier, all numeric comparisons are supported.
48
+ * Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
49
49
  */
50
50
  numericAttributesForFiltering?: string[];
51
51
  /**
@@ -53,7 +53,7 @@ export type BaseIndexSettings = {
53
53
  */
54
54
  separatorsToIndex?: string;
55
55
  /**
56
- * Attributes used for searching. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** <dl> <dt><code>unordered(\"ATTRIBUTE\")</code></dt> <dd> Ignore the position of a match within the attribute. </dd> </dl> Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
56
+ * Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
57
57
  */
58
58
  searchableAttributes?: string[];
59
59
  /**
@@ -65,7 +65,7 @@ export type BaseIndexSettings = {
65
65
  */
66
66
  customNormalization?: Record<string, Record<string, string>>;
67
67
  /**
68
- * Attribute that should be used to establish groups of results. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
68
+ * Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
69
69
  */
70
70
  attributeForDistinct?: string;
71
71
  };
@@ -3,6 +3,7 @@ import type { AroundRadius } from './aroundRadius';
3
3
  import type { FacetFilters } from './facetFilters';
4
4
  import type { NumericFilters } from './numericFilters';
5
5
  import type { OptionalFilters } from './optionalFilters';
6
+ import type { SupportedLanguage } from './supportedLanguage';
6
7
  import type { TagFilters } from './tagFilters';
7
8
  export type BaseSearchParamsWithoutQuery = {
8
9
  /**
@@ -10,7 +11,7 @@ export type BaseSearchParamsWithoutQuery = {
10
11
  */
11
12
  similarQuery?: string;
12
13
  /**
13
- * Filter the search so that only records with matching values are included in the results. These filters are supported: - **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/).
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/).
14
15
  */
15
16
  filters?: string;
16
17
  facetFilters?: FacetFilters;
@@ -22,7 +23,7 @@ export type BaseSearchParamsWithoutQuery = {
22
23
  */
23
24
  sumOrFiltersScores?: boolean;
24
25
  /**
25
- * Restricts a search to a subset of your searchable attributes.
26
+ * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
26
27
  */
27
28
  restrictSearchableAttributes?: string[];
28
29
  /**
@@ -64,13 +65,13 @@ export type BaseSearchParamsWithoutQuery = {
64
65
  */
65
66
  insideBoundingBox?: number[][];
66
67
  /**
67
- * 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`.
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`.
68
69
  */
69
70
  insidePolygon?: number[][];
70
71
  /**
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`.
72
73
  */
73
- naturalLanguages?: string[];
74
+ naturalLanguages?: SupportedLanguage[];
74
75
  /**
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.
76
77
  */
@@ -1 +1 @@
1
- {"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../../../client-search/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,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,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,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
+ {"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../../../client-search/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"}