@algolia/recommend 5.0.0-alpha.6 → 5.0.0-alpha.61

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,82 +1,82 @@
1
- import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
2
- import type { DelProps, GetProps, PostProps, PutProps } from '../model/clientMethodProps';
3
- import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
4
- import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
5
- export declare const apiClientVersion = "5.0.0-alpha.6";
6
- export declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
7
- transporter: import("@algolia/client-common").Transporter;
8
- /**
9
- * The `appId` currently in use.
10
- */
11
- appId: string;
12
- /**
13
- * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
14
- */
15
- clearCache(): Promise<void>;
16
- /**
17
- * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
18
- */
19
- readonly _ua: string;
20
- /**
21
- * Adds a `segment` to the `x-algolia-agent` sent with every requests.
22
- *
23
- * @param segment - The algolia agent (user-agent) segment to add.
24
- * @param version - The version of the agent.
25
- */
26
- addAlgoliaAgent(segment: string, version?: string): void;
27
- /**
28
- * This method allow you to send requests to the Algolia REST API.
29
- *
30
- * @summary Send requests to the Algolia REST API.
31
- * @param del - The del object.
32
- * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
33
- * @param del.parameters - Query parameters to be applied to the current query.
34
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
35
- */
36
- del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
37
- /**
38
- * This method allow you to send requests to the Algolia REST API.
39
- *
40
- * @summary Send requests to the Algolia REST API.
41
- * @param get - The get object.
42
- * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
43
- * @param get.parameters - Query parameters to be applied to the current query.
44
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
45
- */
46
- get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
47
- /**
48
- * Returns recommendations or trending results, for a specific model and `objectID`.
49
- *
50
- * @summary Get results.
51
- * @param getRecommendationsParams - The getRecommendationsParams object.
52
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
53
- */
54
- getRecommendations(getRecommendationsParams: GetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
55
- /**
56
- * This method allow you to send requests to the Algolia REST API.
57
- *
58
- * @summary Send requests to the Algolia REST API.
59
- * @param post - The post object.
60
- * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
61
- * @param post.parameters - Query parameters to be applied to the current query.
62
- * @param post.body - The parameters to send with the custom request.
63
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
64
- */
65
- post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
66
- /**
67
- * This method allow you to send requests to the Algolia REST API.
68
- *
69
- * @summary Send requests to the Algolia REST API.
70
- * @param put - The put object.
71
- * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
72
- * @param put.parameters - Query parameters to be applied to the current query.
73
- * @param put.body - The parameters to send with the custom request.
74
- * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
75
- */
76
- put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
77
- };
78
- /**
79
- * The client type.
80
- */
81
- export declare type RecommendClient = ReturnType<typeof createRecommendClient>;
1
+ import type { CreateClientOptions, RequestOptions } from '@algolia/client-common';
2
+ import type { DelProps, GetProps, PostProps, PutProps } from '../model/clientMethodProps';
3
+ import type { GetRecommendationsParams } from '../model/getRecommendationsParams';
4
+ import type { GetRecommendationsResponse } from '../model/getRecommendationsResponse';
5
+ export declare const apiClientVersion = "5.0.0-alpha.61";
6
+ export declare function createRecommendClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, ...options }: CreateClientOptions): {
7
+ transporter: import("@algolia/client-common").Transporter;
8
+ /**
9
+ * The `appId` currently in use.
10
+ */
11
+ appId: string;
12
+ /**
13
+ * Clears the cache of the transporter for the `requestsCache` and `responsesCache` properties.
14
+ */
15
+ clearCache(): Promise<void>;
16
+ /**
17
+ * Get the value of the `algoliaAgent`, used by our libraries internally and telemetry system.
18
+ */
19
+ readonly _ua: string;
20
+ /**
21
+ * Adds a `segment` to the `x-algolia-agent` sent with every requests.
22
+ *
23
+ * @param segment - The algolia agent (user-agent) segment to add.
24
+ * @param version - The version of the agent.
25
+ */
26
+ addAlgoliaAgent(segment: string, version?: string): void;
27
+ /**
28
+ * This method allow you to send requests to the Algolia REST API.
29
+ *
30
+ * @summary Send requests to the Algolia REST API.
31
+ * @param del - The del object.
32
+ * @param del.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
33
+ * @param del.parameters - Query parameters to be applied to the current query.
34
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
35
+ */
36
+ del({ path, parameters }: DelProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
37
+ /**
38
+ * This method allow you to send requests to the Algolia REST API.
39
+ *
40
+ * @summary Send requests to the Algolia REST API.
41
+ * @param get - The get object.
42
+ * @param get.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
43
+ * @param get.parameters - Query parameters to be applied to the current query.
44
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
45
+ */
46
+ get({ path, parameters }: GetProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
47
+ /**
48
+ * Returns recommendations or trending results, for a specific model and `objectID`.
49
+ *
50
+ * @summary Get results.
51
+ * @param getRecommendationsParams - The getRecommendationsParams object.
52
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
53
+ */
54
+ getRecommendations(getRecommendationsParams: GetRecommendationsParams, requestOptions?: RequestOptions): Promise<GetRecommendationsResponse>;
55
+ /**
56
+ * This method allow you to send requests to the Algolia REST API.
57
+ *
58
+ * @summary Send requests to the Algolia REST API.
59
+ * @param post - The post object.
60
+ * @param post.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
61
+ * @param post.parameters - Query parameters to be applied to the current query.
62
+ * @param post.body - The parameters to send with the custom request.
63
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
64
+ */
65
+ post({ path, parameters, body }: PostProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
66
+ /**
67
+ * This method allow you to send requests to the Algolia REST API.
68
+ *
69
+ * @summary Send requests to the Algolia REST API.
70
+ * @param put - The put object.
71
+ * @param put.path - The path of the API endpoint to target, anything after the /1 needs to be specified.
72
+ * @param put.parameters - Query parameters to be applied to the current query.
73
+ * @param put.body - The parameters to send with the custom request.
74
+ * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
75
+ */
76
+ put({ path, parameters, body }: PutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
77
+ };
78
+ /**
79
+ * The client type.
80
+ */
81
+ export type RecommendClient = ReturnType<typeof createRecommendClient>;
82
82
  //# sourceMappingURL=recommendClient.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../../../packages/recommend/src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,QAAQ,EACT,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AAEtF,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAsChD,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;OAMG;iDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IA8BtC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;EAoBlC;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
1
+ {"version":3,"file":"recommendClient.d.ts","sourceRoot":"","sources":["../../src/recommendClient.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EACV,mBAAmB,EAInB,cAAc,EAEf,MAAM,wBAAwB,CAAC;AAEhC,OAAO,KAAK,EACV,QAAQ,EACR,QAAQ,EACR,SAAS,EACT,QAAQ,EACT,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAClF,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AAEtF,eAAO,MAAM,gBAAgB,mBAAmB,CAAC;AAsCjD,wBAAgB,qBAAqB,CAAC,EACpC,KAAK,EAAE,WAAW,EAClB,MAAM,EAAE,YAAY,EACpB,QAAQ,EACR,aAAa,EACb,GAAG,OAAO,EACX,EAAE,mBAAmB;;IAwBlB;;OAEG;;IAGH;;OAEG;kBACW,QAAQ,IAAI,CAAC;IAO3B;;OAEG;;IAKH;;;;;OAKG;6BACsB,MAAM,YAAY,MAAM,GAAG,IAAI;IAIxD;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;;;OAQG;8BAEqB,QAAQ,mBACb,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAmB/B;;;;;;OAMG;iDAEyB,wBAAwB,mBACjC,cAAc,GAC9B,QAAQ,0BAA0B,CAAC;IA8BtC;;;;;;;;;OASG;qCAE2B,SAAS,mBACpB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;IAoB/B;;;;;;;;;OASG;oCAE2B,QAAQ,mBACnB,cAAc,GAC9B,QAAQ,OAAO,MAAM,EAAE,GAAG,CAAC,CAAC;EAoBlC;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,OAAO,qBAAqB,CAAC,CAAC"}
@@ -1,3 +1,3 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type AdvancedSyntaxFeatures = 'exactPhrase' | 'excludeWords';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type AlternativesAsExact =
4
4
  | 'ignorePlurals'
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { AroundRadiusAll } from './aroundRadiusAll';
4
4
 
@@ -1,3 +1,3 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type AroundRadiusAll = 'all';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { SearchParamsObject } from './searchParamsObject';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { RecommendationModels } from './recommendationModels';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
4
4
  import type { SearchParamsQuery } from './searchParamsQuery';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { AroundRadius } from './aroundRadius';
4
4
  import type { FacetFilters } from './facetFilters';
@@ -1,5 +1,6 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
+ import type { BaseSearchResponseRedirect } from './baseSearchResponseRedirect';
3
4
  import type { FacetsStats } from './facetsStats';
4
5
  import type { RenderingContent } from './renderingContent';
5
6
 
@@ -94,6 +95,8 @@ export type BaseSearchResponse = {
94
95
  */
95
96
  params: string;
96
97
 
98
+ redirect?: BaseSearchResponseRedirect;
99
+
97
100
  /**
98
101
  * The query string that will be searched, after normalization.
99
102
  */
@@ -0,0 +1,10 @@
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
+
3
+ import type { RedirectRuleIndexMetadata } from './redirectRuleIndexMetadata';
4
+
5
+ /**
6
+ * This parameter is for internal use only.
7
+ */
8
+ export type BaseSearchResponseRedirect = {
9
+ index?: RedirectRuleIndexMetadata[];
10
+ };
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { TrendingModels } from './trendingModels';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Properties for the `del` method.
package/model/distinct.ts CHANGED
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Enables de-duplication or grouping of results.
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Error.
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Controls how the exact ranking criterion is computed when the query contains only one word.
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { MixedSearchFilters } from './mixedSearchFilters';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { Facets } from './facets';
4
4
  import type { Value } from './value';
package/model/facets.ts CHANGED
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * The ordering of facets (widgets).
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type FacetsStats = {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { RecommendationsRequest } from './recommendationsRequest';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { RecommendationsResponse } from './recommendationsResponse';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { HighlightResultOption } from './highlightResultOption';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { MatchLevel } from './matchLevel';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Treats singular, plurals, and other forms of declensions as matching terms. IgnorePlurals is used in conjunction with the queryLanguages setting. List: language ISO codes for which ignoring plurals should be enabled. This list will override any values that you may have set in queryLanguages. True: enables the ignore plurals functionality, where singulars and plurals are considered equivalent (foot = feet). The languages supported here are either every language (this is the default, see list of languages below), or those set by queryLanguages. False: disables ignore plurals, where singulars and plurals are not considered the same for matching purposes (foot will not find feet).
package/model/index.ts CHANGED
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export * from './advancedSyntaxFeatures';
4
4
  export * from './alternativesAsExact';
@@ -9,6 +9,7 @@ export * from './baseRecommendationRequest';
9
9
  export * from './baseSearchParams';
10
10
  export * from './baseSearchParamsWithoutQuery';
11
11
  export * from './baseSearchResponse';
12
+ export * from './baseSearchResponseRedirect';
12
13
  export * from './baseTrendingRequest';
13
14
  export * from './distinct';
14
15
  export * from './errorBase';
@@ -23,9 +24,11 @@ export * from './highlightResult';
23
24
  export * from './highlightResultOption';
24
25
  export * from './ignorePlurals';
25
26
  export * from './indexSettingsAsSearchParams';
27
+ export * from './indexSettingsAsSearchParamsSemanticSearch';
26
28
  export * from './matchLevel';
27
29
  export * from './matchedGeoLocation';
28
30
  export * from './mixedSearchFilters';
31
+ export * from './mode';
29
32
  export * from './numericFilters';
30
33
  export * from './optionalFilters';
31
34
  export * from './personalization';
@@ -38,6 +41,8 @@ export * from './recommendationModels';
38
41
  export * from './recommendationRequest';
39
42
  export * from './recommendationsRequest';
40
43
  export * from './recommendationsResponse';
44
+ export * from './redirectRuleIndexMetadata';
45
+ export * from './redirectRuleIndexMetadataData';
41
46
  export * from './removeStopWords';
42
47
  export * from './removeWordsIfNoResults';
43
48
  export * from './renderingContent';
@@ -1,10 +1,12 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { AdvancedSyntaxFeatures } from './advancedSyntaxFeatures';
4
4
  import type { AlternativesAsExact } from './alternativesAsExact';
5
5
  import type { Distinct } from './distinct';
6
6
  import type { ExactOnSingleWordQuery } from './exactOnSingleWordQuery';
7
7
  import type { IgnorePlurals } from './ignorePlurals';
8
+ import type { IndexSettingsAsSearchParamsSemanticSearch } from './indexSettingsAsSearchParamsSemanticSearch';
9
+ import type { Mode } from './mode';
8
10
  import type { QueryType } from './queryType';
9
11
  import type { RemoveStopWords } from './removeStopWords';
10
12
  import type { RemoveWordsIfNoResults } from './removeWordsIfNoResults';
@@ -17,11 +19,6 @@ export type IndexSettingsAsSearchParams = {
17
19
  */
18
20
  attributesForFaceting?: string[];
19
21
 
20
- /**
21
- * List of attributes that can\'t be retrieved at query time.
22
- */
23
- unretrievableAttributes?: string[];
24
-
25
22
  /**
26
23
  * This parameter controls which attributes to retrieve and which not to retrieve.
27
24
  */
@@ -137,6 +134,10 @@ export type IndexSettingsAsSearchParams = {
137
134
 
138
135
  removeWordsIfNoResults?: RemoveWordsIfNoResults;
139
136
 
137
+ mode?: Mode;
138
+
139
+ semanticSearch?: IndexSettingsAsSearchParamsSemanticSearch;
140
+
140
141
  /**
141
142
  * Enables the advanced query syntax.
142
143
  */
@@ -164,6 +165,11 @@ export type IndexSettingsAsSearchParams = {
164
165
  */
165
166
  advancedSyntaxFeatures?: AdvancedSyntaxFeatures[];
166
167
 
168
+ /**
169
+ * Enriches the API’s response with meta-information as to how the query was processed.
170
+ */
171
+ explain?: string[];
172
+
167
173
  distinct?: Distinct;
168
174
 
169
175
  /**
@@ -0,0 +1,11 @@
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
+
3
+ /**
4
+ * The settings relevant for configuration of the semantic search engine. These settings are only used when the mode is set to \'neuralSearch\'.
5
+ */
6
+ export type IndexSettingsAsSearchParamsSemanticSearch = {
7
+ /**
8
+ * When null, the current index / replica group will be used as the event source.
9
+ */
10
+ eventSources?: string[] | null;
11
+ };
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Indicates how well the attribute matched the search query.
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type MatchedGeoLocation = {
4
4
  /**
@@ -1,3 +1,3 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type MixedSearchFilters = string[] | string;
package/model/mode.ts ADDED
@@ -0,0 +1,6 @@
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
+
3
+ /**
4
+ * The search mode that the index will use to query for results.
5
+ */
6
+ export type Mode = 'keywordSearch' | 'neuralSearch';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { MixedSearchFilters } from './mixedSearchFilters';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { MixedSearchFilters } from './mixedSearchFilters';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  export type Personalization = {
4
4
  /**
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * Controls if and how query words are interpreted as prefixes.
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { MatchedGeoLocation } from './matchedGeoLocation';
4
4
  import type { Personalization } from './personalization';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { MixedSearchFilters } from './mixedSearchFilters';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { HighlightResult } from './highlightResult';
4
4
  import type { RankingInfo } from './rankingInfo';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { RecommendHit } from './recommendHit';
4
4
 
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  /**
4
4
  * The recommendation model to use.
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { BaseRecommendRequest } from './baseRecommendRequest';
4
4
  import type { BaseRecommendationRequest } from './baseRecommendationRequest';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { RecommendationRequest } from './recommendationRequest';
4
4
  import type { TrendingRequest } from './trendingRequest';
@@ -1,4 +1,4 @@
1
- // This file is generated, manual changes will be lost - read more on https://github.com/algolia/api-clients-automation.
1
+ // Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
2
2
 
3
3
  import type { BaseSearchResponse } from './baseSearchResponse';
4
4
  import type { RecommendHits } from './recommendHits';