algoliasearch 5.9.0 → 5.10.0

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 (168) hide show
  1. package/README.md +5 -5
  2. package/dist/algoliasearch.umd.js +7 -7
  3. package/dist/browser.d.ts +5 -5
  4. package/dist/browser.js +11 -2329
  5. package/dist/browser.js.map +1 -1
  6. package/dist/browser.min.js +1 -1
  7. package/dist/browser.min.js.map +1 -1
  8. package/dist/fetch.d.ts +5 -5
  9. package/dist/fetch.js +11 -2374
  10. package/dist/fetch.js.map +1 -1
  11. package/dist/lite/browser.d.ts +7 -7
  12. package/dist/lite/builds/browser.js +1 -1
  13. package/dist/lite/builds/browser.js.map +1 -1
  14. package/dist/lite/builds/browser.min.js +1 -1
  15. package/dist/lite/builds/browser.min.js.map +1 -1
  16. package/dist/lite/builds/browser.umd.js +1 -1
  17. package/dist/lite/builds/node.cjs +1 -1
  18. package/dist/lite/builds/node.cjs.map +1 -1
  19. package/dist/lite/builds/node.js +1 -1
  20. package/dist/lite/builds/node.js.map +1 -1
  21. package/dist/lite/node.d.cts +7 -7
  22. package/dist/lite/node.d.ts +7 -7
  23. package/dist/lite/src/liteClient.cjs +1 -1
  24. package/dist/lite/src/liteClient.cjs.map +1 -1
  25. package/dist/lite/src/liteClient.js +1 -1
  26. package/dist/lite/src/liteClient.js.map +1 -1
  27. package/dist/node.cjs +9 -2358
  28. package/dist/node.cjs.map +1 -1
  29. package/dist/node.d.cts +5 -5
  30. package/dist/node.d.ts +5 -5
  31. package/dist/node.js +11 -2374
  32. package/dist/node.js.map +1 -1
  33. package/package.json +17 -18
  34. package/builds/browser.ts +0 -130
  35. package/builds/fetch.ts +0 -130
  36. package/builds/models.ts +0 -250
  37. package/builds/node.ts +0 -130
  38. package/lite/builds/browser.ts +0 -51
  39. package/lite/builds/node.ts +0 -47
  40. package/lite/model/acl.ts +0 -21
  41. package/lite/model/advancedSyntaxFeatures.ts +0 -3
  42. package/lite/model/alternativesAsExact.ts +0 -3
  43. package/lite/model/apiKey.ts +0 -48
  44. package/lite/model/aroundPrecision.ts +0 -8
  45. package/lite/model/aroundRadius.ts +0 -8
  46. package/lite/model/aroundRadiusAll.ts +0 -6
  47. package/lite/model/automaticFacetFilter.ts +0 -21
  48. package/lite/model/automaticFacetFilters.ts +0 -8
  49. package/lite/model/banner.ts +0 -13
  50. package/lite/model/bannerImage.ts +0 -12
  51. package/lite/model/bannerImageUrl.ts +0 -8
  52. package/lite/model/bannerLink.ts +0 -8
  53. package/lite/model/baseGetApiKeyResponse.ts +0 -13
  54. package/lite/model/baseIndexSettings.ts +0 -90
  55. package/lite/model/baseRecommendIndexSettings.ts +0 -184
  56. package/lite/model/baseRecommendRequest.ts +0 -22
  57. package/lite/model/baseRecommendSearchParams.ts +0 -133
  58. package/lite/model/baseSearchParams.ts +0 -6
  59. package/lite/model/baseSearchParamsWithoutQuery.ts +0 -148
  60. package/lite/model/baseSearchResponse.ts +0 -129
  61. package/lite/model/booleanString.ts +0 -3
  62. package/lite/model/boughtTogetherQuery.ts +0 -6
  63. package/lite/model/browsePagination.ts +0 -23
  64. package/lite/model/browseParamsObject.ts +0 -6
  65. package/lite/model/browseResponse.ts +0 -8
  66. package/lite/model/clientMethodProps.ts +0 -63
  67. package/lite/model/consequenceParams.ts +0 -7
  68. package/lite/model/consequenceQuery.ts +0 -8
  69. package/lite/model/consequenceQueryObject.ts +0 -15
  70. package/lite/model/cursor.ts +0 -8
  71. package/lite/model/distinct.ts +0 -6
  72. package/lite/model/edit.ts +0 -17
  73. package/lite/model/editType.ts +0 -6
  74. package/lite/model/errorBase.ts +0 -8
  75. package/lite/model/exactOnSingleWordQuery.ts +0 -6
  76. package/lite/model/exhaustive.ts +0 -31
  77. package/lite/model/facetFilters.ts +0 -6
  78. package/lite/model/facetHits.ts +0 -18
  79. package/lite/model/facetOrdering.ts +0 -16
  80. package/lite/model/facetStats.ts +0 -23
  81. package/lite/model/fallbackParams.ts +0 -5
  82. package/lite/model/fbtModel.ts +0 -6
  83. package/lite/model/frequentlyBoughtTogether.ts +0 -12
  84. package/lite/model/getApiKeyResponse.ts +0 -6
  85. package/lite/model/getRecommendationsParams.ts +0 -13
  86. package/lite/model/getRecommendationsResponse.ts +0 -7
  87. package/lite/model/highlightResult.ts +0 -5
  88. package/lite/model/highlightResultOption.ts +0 -25
  89. package/lite/model/hit.ts +0 -29
  90. package/lite/model/ignorePlurals.ts +0 -9
  91. package/lite/model/index.ts +0 -128
  92. package/lite/model/indexSettings.ts +0 -9
  93. package/lite/model/indexSettingsAsSearchParams.ts +0 -205
  94. package/lite/model/indexSettingsFacets.ts +0 -11
  95. package/lite/model/lookingSimilar.ts +0 -15
  96. package/lite/model/lookingSimilarModel.ts +0 -6
  97. package/lite/model/lookingSimilarQuery.ts +0 -6
  98. package/lite/model/matchLevel.ts +0 -6
  99. package/lite/model/matchedGeoLocation.ts +0 -18
  100. package/lite/model/mode.ts +0 -6
  101. package/lite/model/numericFilters.ts +0 -6
  102. package/lite/model/optionalFilters.ts +0 -6
  103. package/lite/model/params.ts +0 -18
  104. package/lite/model/personalization.ts +0 -18
  105. package/lite/model/queryType.ts +0 -6
  106. package/lite/model/range.ts +0 -16
  107. package/lite/model/rankingInfo.ts +0 -68
  108. package/lite/model/reRankingApplyFilter.ts +0 -6
  109. package/lite/model/recommendHit.ts +0 -34
  110. package/lite/model/recommendIndexSettings.ts +0 -9
  111. package/lite/model/recommendSearchParams.ts +0 -10
  112. package/lite/model/recommendationsHit.ts +0 -7
  113. package/lite/model/recommendationsHits.ts +0 -7
  114. package/lite/model/recommendationsRequest.ts +0 -18
  115. package/lite/model/recommendationsResults.ts +0 -7
  116. package/lite/model/recommendedForYou.ts +0 -10
  117. package/lite/model/recommendedForYouModel.ts +0 -6
  118. package/lite/model/recommendedForYouQuery.ts +0 -6
  119. package/lite/model/redirect.ts +0 -10
  120. package/lite/model/redirectRuleIndexData.ts +0 -8
  121. package/lite/model/redirectRuleIndexMetadata.ts +0 -27
  122. package/lite/model/redirectURL.ts +0 -8
  123. package/lite/model/relatedModel.ts +0 -6
  124. package/lite/model/relatedProducts.ts +0 -15
  125. package/lite/model/relatedQuery.ts +0 -6
  126. package/lite/model/removeStopWords.ts +0 -8
  127. package/lite/model/removeWordsIfNoResults.ts +0 -6
  128. package/lite/model/renderingContent.ts +0 -16
  129. package/lite/model/searchForFacetValuesResponse.ts +0 -20
  130. package/lite/model/searchForFacets.ts +0 -6
  131. package/lite/model/searchForFacetsOptions.ts +0 -27
  132. package/lite/model/searchForHits.ts +0 -6
  133. package/lite/model/searchForHitsOptions.ts +0 -12
  134. package/lite/model/searchHits.ts +0 -20
  135. package/lite/model/searchMethodParams.ts +0 -10
  136. package/lite/model/searchPagination.ts +0 -23
  137. package/lite/model/searchParams.ts +0 -6
  138. package/lite/model/searchParamsObject.ts +0 -9
  139. package/lite/model/searchParamsQuery.ts +0 -8
  140. package/lite/model/searchParamsString.ts +0 -11
  141. package/lite/model/searchQuery.ts +0 -6
  142. package/lite/model/searchResponse.ts +0 -7
  143. package/lite/model/searchResponses.ts +0 -7
  144. package/lite/model/searchResult.ts +0 -6
  145. package/lite/model/searchStrategy.ts +0 -6
  146. package/lite/model/searchTypeDefault.ts +0 -6
  147. package/lite/model/searchTypeFacet.ts +0 -6
  148. package/lite/model/semanticSearch.ts +0 -11
  149. package/lite/model/settingsResponse.ts +0 -6
  150. package/lite/model/snippetResult.ts +0 -5
  151. package/lite/model/snippetResultOption.ts +0 -15
  152. package/lite/model/sortRemainingBy.ts +0 -6
  153. package/lite/model/supportedLanguage.ts +0 -74
  154. package/lite/model/tagFilters.ts +0 -6
  155. package/lite/model/trendingFacetHit.ts +0 -21
  156. package/lite/model/trendingFacets.ts +0 -15
  157. package/lite/model/trendingFacetsModel.ts +0 -6
  158. package/lite/model/trendingFacetsQuery.ts +0 -6
  159. package/lite/model/trendingItems.ts +0 -20
  160. package/lite/model/trendingItemsModel.ts +0 -6
  161. package/lite/model/trendingItemsQuery.ts +0 -6
  162. package/lite/model/typoTolerance.ts +0 -8
  163. package/lite/model/typoToleranceEnum.ts +0 -6
  164. package/lite/model/value.ts +0 -17
  165. package/lite/model/widgets.ts +0 -13
  166. package/lite/model/withPrimary.ts +0 -8
  167. package/lite/src/liteClient.ts +0 -305
  168. package/lite/tsconfig.json +0 -9
@@ -1,133 +0,0 @@
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 { AroundPrecision } from './aroundPrecision';
4
- import type { AroundRadius } from './aroundRadius';
5
- import type { FacetFilters } from './facetFilters';
6
- import type { NumericFilters } from './numericFilters';
7
- import type { OptionalFilters } from './optionalFilters';
8
- import type { SupportedLanguage } from './supportedLanguage';
9
- import type { TagFilters } from './tagFilters';
10
-
11
- export type BaseRecommendSearchParams = {
12
- /**
13
- * Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
14
- */
15
- similarQuery?: string;
16
-
17
- /**
18
- * 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/).
19
- */
20
- filters?: string;
21
-
22
- facetFilters?: FacetFilters;
23
-
24
- optionalFilters?: OptionalFilters;
25
-
26
- numericFilters?: NumericFilters;
27
-
28
- tagFilters?: TagFilters;
29
-
30
- /**
31
- * Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
32
- */
33
- sumOrFiltersScores?: boolean;
34
-
35
- /**
36
- * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
37
- */
38
- restrictSearchableAttributes?: Array<string>;
39
-
40
- /**
41
- * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
42
- */
43
- facets?: Array<string>;
44
-
45
- /**
46
- * Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
47
- */
48
- facetingAfterDistinct?: boolean;
49
-
50
- /**
51
- * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
52
- */
53
- aroundLatLng?: string;
54
-
55
- /**
56
- * Whether to obtain the coordinates from the request\'s IP address.
57
- */
58
- aroundLatLngViaIP?: boolean;
59
-
60
- aroundRadius?: AroundRadius;
61
-
62
- aroundPrecision?: AroundPrecision;
63
-
64
- /**
65
- * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
66
- */
67
- minimumAroundRadius?: number;
68
-
69
- /**
70
- * Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
71
- */
72
- insideBoundingBox?: Array<Array<number>>;
73
-
74
- /**
75
- * 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`.
76
- */
77
- insidePolygon?: Array<Array<number>>;
78
-
79
- /**
80
- * 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`.
81
- */
82
- naturalLanguages?: Array<SupportedLanguage>;
83
-
84
- /**
85
- * 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.
86
- */
87
- ruleContexts?: Array<string>;
88
-
89
- /**
90
- * Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
91
- */
92
- personalizationImpact?: number;
93
-
94
- /**
95
- * 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/).
96
- */
97
- userToken?: string;
98
-
99
- /**
100
- * Whether the search response should include detailed ranking information.
101
- */
102
- getRankingInfo?: boolean;
103
-
104
- /**
105
- * Whether to take into account an index\'s synonyms for this search.
106
- */
107
- synonyms?: boolean;
108
-
109
- /**
110
- * Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
111
- */
112
- clickAnalytics?: boolean;
113
-
114
- /**
115
- * Whether this search will be included in Analytics.
116
- */
117
- analytics?: boolean;
118
-
119
- /**
120
- * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
121
- */
122
- analyticsTags?: Array<string>;
123
-
124
- /**
125
- * Whether to include this search when calculating processing-time percentiles.
126
- */
127
- percentileComputation?: boolean;
128
-
129
- /**
130
- * Whether to enable A/B testing for this search.
131
- */
132
- enableABTest?: boolean;
133
- };
@@ -1,6 +0,0 @@
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 { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
4
- import type { SearchParamsQuery } from './searchParamsQuery';
5
-
6
- export type BaseSearchParams = SearchParamsQuery & BaseSearchParamsWithoutQuery;
@@ -1,148 +0,0 @@
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 { AroundPrecision } from './aroundPrecision';
4
- import type { AroundRadius } from './aroundRadius';
5
- import type { FacetFilters } from './facetFilters';
6
- import type { NumericFilters } from './numericFilters';
7
- import type { OptionalFilters } from './optionalFilters';
8
- import type { SupportedLanguage } from './supportedLanguage';
9
- import type { TagFilters } from './tagFilters';
10
-
11
- export type BaseSearchParamsWithoutQuery = {
12
- /**
13
- * Keywords to be used instead of the search query to conduct a more broader search. Using the `similarQuery` parameter changes other settings: - `queryType` is set to `prefixNone`. - `removeStopWords` is set to true. - `words` is set as the first ranking criterion. - All remaining words are treated as `optionalWords`. Since the `similarQuery` is supposed to do a broad search, they usually return many results. Combine it with `filters` to narrow down the list of results.
14
- */
15
- similarQuery?: string;
16
-
17
- /**
18
- * 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/).
19
- */
20
- filters?: string;
21
-
22
- facetFilters?: FacetFilters;
23
-
24
- optionalFilters?: OptionalFilters;
25
-
26
- numericFilters?: NumericFilters;
27
-
28
- tagFilters?: TagFilters;
29
-
30
- /**
31
- * Whether to sum all filter scores. If true, all filter scores are summed. Otherwise, the maximum filter score is kept. For more information, see [filter scores](https://www.algolia.com/doc/guides/managing-results/refine-results/filtering/in-depth/filter-scoring/#accumulating-scores-with-sumorfiltersscores).
32
- */
33
- sumOrFiltersScores?: boolean;
34
-
35
- /**
36
- * Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
37
- */
38
- restrictSearchableAttributes?: Array<string>;
39
-
40
- /**
41
- * Facets for which to retrieve facet values that match the search criteria and the number of matching facet values. To retrieve all facets, use the wildcard character `*`. For more information, see [facets](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#contextual-facet-values-and-counts).
42
- */
43
- facets?: Array<string>;
44
-
45
- /**
46
- * Whether faceting should be applied after deduplication with `distinct`. This leads to accurate facet counts when using faceting in combination with `distinct`. It\'s usually better to use `afterDistinct` modifiers in the `attributesForFaceting` setting, as `facetingAfterDistinct` only computes correct facet counts if all records have the same facet values for the `attributeForDistinct`.
47
- */
48
- facetingAfterDistinct?: boolean;
49
-
50
- /**
51
- * Page of search results to retrieve.
52
- */
53
- page?: number;
54
-
55
- /**
56
- * Position of the first hit to retrieve.
57
- */
58
- offset?: number;
59
-
60
- /**
61
- * Number of hits to retrieve (used in combination with `offset`).
62
- */
63
- length?: number;
64
-
65
- /**
66
- * Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
67
- */
68
- aroundLatLng?: string;
69
-
70
- /**
71
- * Whether to obtain the coordinates from the request\'s IP address.
72
- */
73
- aroundLatLngViaIP?: boolean;
74
-
75
- aroundRadius?: AroundRadius;
76
-
77
- aroundPrecision?: AroundPrecision;
78
-
79
- /**
80
- * Minimum radius (in meters) for a search around a location when `aroundRadius` isn\'t set.
81
- */
82
- minimumAroundRadius?: number;
83
-
84
- /**
85
- * Coordinates for a rectangular area in which to search. Each bounding box is defined by the two opposite points of its diagonal, and expressed as latitude and longitude pair: `[p1 lat, p1 long, p2 lat, p2 long]`. Provide multiple bounding boxes as nested arrays. For more information, see [rectangular area](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas).
86
- */
87
- insideBoundingBox?: Array<Array<number>>;
88
-
89
- /**
90
- * 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`.
91
- */
92
- insidePolygon?: Array<Array<number>>;
93
-
94
- /**
95
- * 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`.
96
- */
97
- naturalLanguages?: Array<SupportedLanguage>;
98
-
99
- /**
100
- * 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.
101
- */
102
- ruleContexts?: Array<string>;
103
-
104
- /**
105
- * Impact that Personalization should have on this search. The higher this value is, the more Personalization determines the ranking compared to other factors. For more information, see [Understanding Personalization impact](https://www.algolia.com/doc/guides/personalization/personalizing-results/in-depth/configuring-personalization/#understanding-personalization-impact).
106
- */
107
- personalizationImpact?: number;
108
-
109
- /**
110
- * 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/).
111
- */
112
- userToken?: string;
113
-
114
- /**
115
- * Whether the search response should include detailed ranking information.
116
- */
117
- getRankingInfo?: boolean;
118
-
119
- /**
120
- * Whether to take into account an index\'s synonyms for this search.
121
- */
122
- synonyms?: boolean;
123
-
124
- /**
125
- * Whether to include a `queryID` attribute in the response. The query ID is a unique identifier for a search query and is required for tracking [click and conversion events](https://www.algolia.com/guides/sending-events/getting-started/).
126
- */
127
- clickAnalytics?: boolean;
128
-
129
- /**
130
- * Whether this search will be included in Analytics.
131
- */
132
- analytics?: boolean;
133
-
134
- /**
135
- * Tags to apply to the query for [segmenting analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
136
- */
137
- analyticsTags?: Array<string>;
138
-
139
- /**
140
- * Whether to include this search when calculating processing-time percentiles.
141
- */
142
- percentileComputation?: boolean;
143
-
144
- /**
145
- * Whether to enable A/B testing for this search.
146
- */
147
- enableABTest?: boolean;
148
- };
@@ -1,129 +0,0 @@
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 { Exhaustive } from './exhaustive';
4
- import type { FacetStats } from './facetStats';
5
- import type { Redirect } from './redirect';
6
- import type { RenderingContent } from './renderingContent';
7
-
8
- export type BaseSearchResponse = Record<string, any> & {
9
- /**
10
- * A/B test ID. This is only included in the response for indices that are part of an A/B test.
11
- */
12
- abTestID?: number;
13
-
14
- /**
15
- * Variant ID. This is only included in the response for indices that are part of an A/B test.
16
- */
17
- abTestVariantID?: number;
18
-
19
- /**
20
- * Computed geographical location.
21
- */
22
- aroundLatLng?: string;
23
-
24
- /**
25
- * Distance from a central coordinate provided by `aroundLatLng`.
26
- */
27
- automaticRadius?: string;
28
-
29
- exhaustive?: Exhaustive;
30
-
31
- /**
32
- * Rules applied to the query.
33
- */
34
- appliedRules?: Array<Record<string, unknown>>;
35
-
36
- /**
37
- * See the `facetsCount` field of the `exhaustive` object in the response.
38
- */
39
- exhaustiveFacetsCount?: boolean;
40
-
41
- /**
42
- * See the `nbHits` field of the `exhaustive` object in the response.
43
- */
44
- exhaustiveNbHits?: boolean;
45
-
46
- /**
47
- * See the `typo` field of the `exhaustive` object in the response.
48
- */
49
- exhaustiveTypo?: boolean;
50
-
51
- /**
52
- * Facet counts.
53
- */
54
- facets?: { [key: string]: { [key: string]: number } };
55
-
56
- /**
57
- * Statistics for numerical facets.
58
- */
59
- facets_stats?: { [key: string]: FacetStats };
60
-
61
- /**
62
- * Index name used for the query.
63
- */
64
- index?: string;
65
-
66
- /**
67
- * Index name used for the query. During A/B testing, the targeted index isn\'t always the index used by the query.
68
- */
69
- indexUsed?: string;
70
-
71
- /**
72
- * Warnings about the query.
73
- */
74
- message?: string;
75
-
76
- /**
77
- * Number of hits selected and sorted by the relevant sort algorithm.
78
- */
79
- nbSortedHits?: number;
80
-
81
- /**
82
- * Post-[normalization](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/#what-does-normalization-mean) query string that will be searched.
83
- */
84
- parsedQuery?: string;
85
-
86
- /**
87
- * Time the server took to process the request, in milliseconds.
88
- */
89
- processingTimeMS: number;
90
-
91
- /**
92
- * Experimental. List of processing steps and their times, in milliseconds. You can use this list to investigate performance issues.
93
- */
94
- processingTimingsMS?: Record<string, unknown>;
95
-
96
- /**
97
- * Markup text indicating which parts of the original query have been removed to retrieve a non-empty result set.
98
- */
99
- queryAfterRemoval?: string;
100
-
101
- redirect?: Redirect;
102
-
103
- renderingContent?: RenderingContent;
104
-
105
- /**
106
- * Time the server took to process the request, in milliseconds.
107
- */
108
- serverTimeMS?: number;
109
-
110
- /**
111
- * Host name of the server that processed the request.
112
- */
113
- serverUsed?: string;
114
-
115
- /**
116
- * An object with custom data. You can store up to 32kB as custom data.
117
- */
118
- userData?: Record<string, unknown>;
119
-
120
- /**
121
- * Unique identifier for the query. This is used for [click analytics](https://www.algolia.com/doc/guides/analytics/click-analytics/).
122
- */
123
- queryID?: string;
124
-
125
- /**
126
- * Whether automatic events collection is enabled for the application.
127
- */
128
- _automaticInsights?: boolean;
129
- };
@@ -1,3 +0,0 @@
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
- export type BooleanString = 'true' | 'false';
@@ -1,6 +0,0 @@
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 { BaseRecommendRequest } from './baseRecommendRequest';
4
- import type { FrequentlyBoughtTogether } from './frequentlyBoughtTogether';
5
-
6
- export type BoughtTogetherQuery = BaseRecommendRequest & FrequentlyBoughtTogether;
@@ -1,23 +0,0 @@
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
- export type BrowsePagination = {
4
- /**
5
- * Page of search results to retrieve.
6
- */
7
- page?: number;
8
-
9
- /**
10
- * Number of results (hits).
11
- */
12
- nbHits?: number;
13
-
14
- /**
15
- * Number of pages of results.
16
- */
17
- nbPages?: number;
18
-
19
- /**
20
- * Number of hits per page.
21
- */
22
- hitsPerPage?: number;
23
- };
@@ -1,6 +0,0 @@
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 { Cursor } from './cursor';
4
- import type { SearchParamsObject } from './searchParamsObject';
5
-
6
- export type BrowseParamsObject = SearchParamsObject & Cursor;
@@ -1,8 +0,0 @@
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 { BaseSearchResponse } from './baseSearchResponse';
4
- import type { BrowsePagination } from './browsePagination';
5
- import type { Cursor } from './cursor';
6
- import type { SearchHits } from './searchHits';
7
-
8
- export type BrowseResponse<T = Record<string, any>> = BaseSearchResponse & BrowsePagination & SearchHits<T> & Cursor;
@@ -1,63 +0,0 @@
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 { RecommendationsRequest } from './recommendationsRequest';
4
- import type { SearchForFacetsOptions } from './searchForFacetsOptions';
5
- import type { SearchForHitsOptions } from './searchForHitsOptions';
6
- import { SearchParamsObject } from './searchParamsObject';
7
-
8
- /**
9
- * Properties for the `customPost` method.
10
- */
11
- export type CustomPostProps = {
12
- /**
13
- * Path of the endpoint, anything after \"/1\" must be specified.
14
- */
15
- path: string;
16
- /**
17
- * Query parameters to apply to the current query.
18
- */
19
- parameters?: { [key: string]: any };
20
- /**
21
- * Parameters to send with the custom request.
22
- */
23
- body?: Record<string, unknown>;
24
- };
25
-
26
- /**
27
- * Recommend method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
28
- *
29
- * @deprecated This signature will be removed from the next major version, we recommend using the `GetRecommendationsParams` type for performances and future proof reasons.
30
- */
31
- export type LegacyGetRecommendationsParams = RecommendationsRequest[];
32
-
33
- /**
34
- * In v4, the search parameters are wrapped in a `params` parameter.
35
- *
36
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
37
- */
38
- type LegacySearchParams = {
39
- params?: SearchParamsObject;
40
- };
41
-
42
- /**
43
- * In v4, the search parameters are wrapped in a `params` parameter.
44
- *
45
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
46
- */
47
- type LegacySearchForFacets = LegacySearchParams & SearchForFacetsOptions;
48
-
49
- /**
50
- * In v4, the search parameters are wrapped in a `params` parameter.
51
- *
52
- * @deprecated The `search` method now accepts flat `searchParams` at the root of the method.
53
- */
54
- type LegacySearchForHits = LegacySearchParams & SearchForHitsOptions;
55
-
56
- type LegacySearchQuery = LegacySearchForFacets | LegacySearchForHits;
57
-
58
- /**
59
- * Search method signature compatible with the `algoliasearch` v4 package. When using this signature, extra computation will be required to make it match the new signature.
60
- *
61
- * @deprecated This signature will be removed from the next major version, we recommend using the `SearchMethodParams` type for performances and future proof reasons.
62
- */
63
- export type LegacySearchMethodProps = LegacySearchQuery[];
@@ -1,7 +0,0 @@
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 { BaseSearchParamsWithoutQuery } from './baseSearchParamsWithoutQuery';
4
- import type { IndexSettingsAsSearchParams } from './indexSettingsAsSearchParams';
5
- import type { Params } from './params';
6
-
7
- export type ConsequenceParams = BaseSearchParamsWithoutQuery & IndexSettingsAsSearchParams & Params;
@@ -1,8 +0,0 @@
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 { ConsequenceQueryObject } from './consequenceQueryObject';
4
-
5
- /**
6
- * Replace or edit the search query. If `consequenceQuery` is a string, the entire search query is replaced with that string. If `consequenceQuery` is an object, it describes incremental edits made to the query.
7
- */
8
- export type ConsequenceQuery = ConsequenceQueryObject | string;
@@ -1,15 +0,0 @@
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 { Edit } from './edit';
4
-
5
- export type ConsequenceQueryObject = {
6
- /**
7
- * Words to remove from the search query.
8
- */
9
- remove?: Array<string>;
10
-
11
- /**
12
- * Changes to make to the search query.
13
- */
14
- edits?: Array<Edit>;
15
- };
@@ -1,8 +0,0 @@
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
- export type Cursor = {
4
- /**
5
- * Cursor to get the next page of the response. The parameter must match the value returned in the response of a previous request. The last page of the response does not return a `cursor` attribute.
6
- */
7
- cursor?: string;
8
- };
@@ -1,6 +0,0 @@
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
- * Determines how many records of a group are included in the search results. Records with the same value for the `attributeForDistinct` attribute are considered a group. The `distinct` setting controls how many members of the group are returned. This is useful for [deduplication and grouping](https://www.algolia.com/doc/guides/managing-results/refine-results/grouping/#introducing-algolias-distinct-feature). The `distinct` setting is ignored if `attributeForDistinct` is not set.
5
- */
6
- export type Distinct = boolean | number;
@@ -1,17 +0,0 @@
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 { EditType } from './editType';
4
-
5
- export type Edit = {
6
- type?: EditType;
7
-
8
- /**
9
- * Text or patterns to remove from the query string.
10
- */
11
- delete?: string;
12
-
13
- /**
14
- * Text to be added in place of the deleted text inside the query string.
15
- */
16
- insert?: string;
17
- };
@@ -1,6 +0,0 @@
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
- * Type of edit.
5
- */
6
- export type EditType = 'remove' | 'replace';
@@ -1,8 +0,0 @@
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
- * Error.
5
- */
6
- export type ErrorBase = Record<string, any> & {
7
- message?: string;
8
- };
@@ -1,6 +0,0 @@
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
- * Determines how the [Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes) is computed when the search query has only one word. - `attribute`. The Exact ranking criterion is 1 if the query word and attribute value are the same. For example, a search for \"road\" will match the value \"road\", but not \"road trip\". - `none`. The Exact ranking criterion is ignored on single-word searches. - `word`. The Exact ranking criterion is 1 if the query word is found in the attribute value. The query word must have at least 3 characters and must not be a stop word. Only exact matches will be highlighted, partial and prefix matches won\'t.
5
- */
6
- export type ExactOnSingleWordQuery = 'attribute' | 'none' | 'word';