@algolia/recommend 5.9.1 → 5.10.0-beta.1

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 (121) hide show
  1. package/README.md +4 -4
  2. package/dist/browser.d.ts +1 -1
  3. package/dist/builds/browser.js +1 -1
  4. package/dist/builds/browser.js.map +1 -1
  5. package/dist/builds/browser.min.js +1 -1
  6. package/dist/builds/browser.min.js.map +1 -1
  7. package/dist/builds/browser.umd.js +1 -1
  8. package/dist/builds/fetch.js +1 -1
  9. package/dist/builds/fetch.js.map +1 -1
  10. package/dist/builds/node.cjs +1 -1
  11. package/dist/builds/node.cjs.map +1 -1
  12. package/dist/builds/node.js +1 -1
  13. package/dist/builds/node.js.map +1 -1
  14. package/dist/fetch.d.ts +1 -1
  15. package/dist/node.d.cts +1 -1
  16. package/dist/node.d.ts +1 -1
  17. package/dist/src/recommendClient.cjs +1 -1
  18. package/dist/src/recommendClient.cjs.map +1 -1
  19. package/dist/src/recommendClient.js +1 -1
  20. package/dist/src/recommendClient.js.map +1 -1
  21. package/package.json +6 -7
  22. package/model/advancedSyntaxFeatures.ts +0 -3
  23. package/model/alternativesAsExact.ts +0 -3
  24. package/model/aroundPrecision.ts +0 -8
  25. package/model/aroundRadius.ts +0 -8
  26. package/model/aroundRadiusAll.ts +0 -6
  27. package/model/autoFacetFilter.ts +0 -16
  28. package/model/banner.ts +0 -13
  29. package/model/bannerImage.ts +0 -12
  30. package/model/bannerImageUrl.ts +0 -8
  31. package/model/bannerLink.ts +0 -8
  32. package/model/baseIndexSettings.ts +0 -90
  33. package/model/baseRecommendIndexSettings.ts +0 -184
  34. package/model/baseRecommendRequest.ts +0 -22
  35. package/model/baseRecommendSearchParams.ts +0 -133
  36. package/model/baseSearchResponse.ts +0 -129
  37. package/model/booleanString.ts +0 -3
  38. package/model/boughtTogetherQuery.ts +0 -6
  39. package/model/clientMethodProps.ts +0 -163
  40. package/model/condition.ts +0 -16
  41. package/model/consequence.ts +0 -22
  42. package/model/deletedAtResponse.ts +0 -16
  43. package/model/distinct.ts +0 -6
  44. package/model/errorBase.ts +0 -8
  45. package/model/exactOnSingleWordQuery.ts +0 -6
  46. package/model/exhaustive.ts +0 -31
  47. package/model/facetFilters.ts +0 -6
  48. package/model/facetOrdering.ts +0 -16
  49. package/model/facetStats.ts +0 -23
  50. package/model/fallbackParams.ts +0 -5
  51. package/model/fbtModel.ts +0 -6
  52. package/model/frequentlyBoughtTogether.ts +0 -12
  53. package/model/getRecommendTaskResponse.ts +0 -7
  54. package/model/getRecommendationsParams.ts +0 -13
  55. package/model/getRecommendationsResponse.ts +0 -7
  56. package/model/hideConsequenceObject.ts +0 -11
  57. package/model/highlightResult.ts +0 -5
  58. package/model/highlightResultOption.ts +0 -25
  59. package/model/ignorePlurals.ts +0 -9
  60. package/model/index.ts +0 -101
  61. package/model/indexSettingsFacets.ts +0 -11
  62. package/model/lookingSimilar.ts +0 -15
  63. package/model/lookingSimilarModel.ts +0 -6
  64. package/model/lookingSimilarQuery.ts +0 -6
  65. package/model/matchLevel.ts +0 -6
  66. package/model/matchedGeoLocation.ts +0 -18
  67. package/model/numericFilters.ts +0 -6
  68. package/model/optionalFilters.ts +0 -6
  69. package/model/paramsConsequence.ts +0 -23
  70. package/model/personalization.ts +0 -18
  71. package/model/promoteConsequenceObject.ts +0 -16
  72. package/model/queryType.ts +0 -6
  73. package/model/range.ts +0 -16
  74. package/model/rankingInfo.ts +0 -68
  75. package/model/reRankingApplyFilter.ts +0 -6
  76. package/model/recommendHit.ts +0 -34
  77. package/model/recommendIndexSettings.ts +0 -9
  78. package/model/recommendModels.ts +0 -3
  79. package/model/recommendRule.ts +0 -37
  80. package/model/recommendSearchParams.ts +0 -10
  81. package/model/recommendUpdatedAtResponse.ts +0 -16
  82. package/model/recommendationsHit.ts +0 -7
  83. package/model/recommendationsHits.ts +0 -7
  84. package/model/recommendationsRequest.ts +0 -18
  85. package/model/recommendationsResults.ts +0 -7
  86. package/model/recommendedForYou.ts +0 -10
  87. package/model/recommendedForYouModel.ts +0 -6
  88. package/model/recommendedForYouQuery.ts +0 -6
  89. package/model/redirect.ts +0 -10
  90. package/model/redirectRuleIndexData.ts +0 -8
  91. package/model/redirectRuleIndexMetadata.ts +0 -27
  92. package/model/redirectURL.ts +0 -8
  93. package/model/relatedModel.ts +0 -6
  94. package/model/relatedProducts.ts +0 -15
  95. package/model/relatedQuery.ts +0 -6
  96. package/model/removeStopWords.ts +0 -8
  97. package/model/removeWordsIfNoResults.ts +0 -6
  98. package/model/renderingContent.ts +0 -16
  99. package/model/ruleMetadata.ts +0 -11
  100. package/model/searchPagination.ts +0 -23
  101. package/model/searchParamsQuery.ts +0 -8
  102. package/model/searchRecommendRulesParams.ts +0 -46
  103. package/model/searchRecommendRulesResponse.ts +0 -25
  104. package/model/snippetResult.ts +0 -5
  105. package/model/snippetResultOption.ts +0 -15
  106. package/model/sortRemainingBy.ts +0 -6
  107. package/model/supportedLanguage.ts +0 -74
  108. package/model/tagFilters.ts +0 -6
  109. package/model/taskStatus.ts +0 -6
  110. package/model/timeRange.ts +0 -13
  111. package/model/trendingFacetHit.ts +0 -21
  112. package/model/trendingFacets.ts +0 -15
  113. package/model/trendingFacetsModel.ts +0 -6
  114. package/model/trendingFacetsQuery.ts +0 -6
  115. package/model/trendingItems.ts +0 -20
  116. package/model/trendingItemsModel.ts +0 -6
  117. package/model/trendingItemsQuery.ts +0 -6
  118. package/model/typoTolerance.ts +0 -8
  119. package/model/typoToleranceEnum.ts +0 -6
  120. package/model/value.ts +0 -17
  121. package/model/widgets.ts +0 -13
@@ -1,16 +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
- * Condition that triggers the rule. If not specified, the rule is triggered for all recommendations.
5
- */
6
- export type Condition = {
7
- /**
8
- * 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/).
9
- */
10
- filters?: string;
11
-
12
- /**
13
- * An additional restriction that only triggers the rule, when the search has the same value as `ruleContexts` parameter. For example, if `context: mobile`, the rule is only triggered when the search request has a matching `ruleContexts: mobile`. A rule context must only contain alphanumeric characters.
14
- */
15
- context?: string;
16
- };
@@ -1,22 +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 { HideConsequenceObject } from './hideConsequenceObject';
4
- import type { ParamsConsequence } from './paramsConsequence';
5
- import type { PromoteConsequenceObject } from './promoteConsequenceObject';
6
-
7
- /**
8
- * Effect of the rule.
9
- */
10
- export type Consequence = {
11
- /**
12
- * Exclude items from recommendations.
13
- */
14
- hide?: Array<HideConsequenceObject>;
15
-
16
- /**
17
- * Place items at specific positions in the list of recommendations.
18
- */
19
- promote?: Array<PromoteConsequenceObject>;
20
-
21
- params?: ParamsConsequence;
22
- };
@@ -1,16 +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
- * Response, taskID, and deletion timestamp.
5
- */
6
- export type DeletedAtResponse = {
7
- /**
8
- * Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task\'s progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
9
- */
10
- taskID: number;
11
-
12
- /**
13
- * Date and time when the object was deleted, in RFC 3339 format.
14
- */
15
- deletedAt: string;
16
- };
package/model/distinct.ts DELETED
@@ -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,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';
@@ -1,31 +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
- * Whether certain properties of the search response are calculated exhaustive (exact) or approximated.
5
- */
6
- export type Exhaustive = {
7
- /**
8
- * Whether the facet count is exhaustive (`true`) or approximate (`false`). See the [related discussion](https://support.algolia.com/hc/en-us/articles/4406975248145-Why-are-my-facet-and-hit-counts-not-accurate-).
9
- */
10
- facetsCount?: boolean;
11
-
12
- /**
13
- * The value is `false` if not all facet values are retrieved.
14
- */
15
- facetValues?: boolean;
16
-
17
- /**
18
- * Whether the `nbHits` is exhaustive (`true`) or approximate (`false`). When the query takes more than 50ms to be processed, the engine makes an approximation. This can happen when using complex filters on millions of records, when typo-tolerance was not exhaustive, or when enough hits have been retrieved (for example, after the engine finds 10,000 exact matches). `nbHits` is reported as non-exhaustive whenever an approximation is made, even if the approximation didn’t, in the end, impact the exhaustivity of the query.
19
- */
20
- nbHits?: boolean;
21
-
22
- /**
23
- * Rules matching exhaustivity. The value is `false` if rules were enable for this query, and could not be fully processed due a timeout. This is generally caused by the number of alternatives (such as typos) which is too large.
24
- */
25
- rulesMatch?: boolean;
26
-
27
- /**
28
- * Whether the typo search was exhaustive (`true`) or approximate (`false`). An approximation is done when the typo search query part takes more than 10% of the query budget (ie. 5ms by default) to be processed (this can happen when a lot of typo alternatives exist for the query). This field will not be included when typo-tolerance is entirely disabled.
29
- */
30
- typo?: boolean;
31
- };
@@ -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
- * Filter the search by facet values, so that only records with the same facet values are retrieved. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** - `[filter1, filter2]` is interpreted as `filter1 AND filter2`. - `[[filter1, filter2], filter3]` is interpreted as `filter1 OR filter2 AND filter3`. - `facet:-value` is interpreted as `NOT facet:value`. While it\'s best to avoid attributes that start with a `-`, you can still filter them by escaping with a backslash: `facet:\\-value`.
5
- */
6
- export type FacetFilters = Array<FacetFilters> | string;
@@ -1,16 +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 { IndexSettingsFacets } from './indexSettingsFacets';
4
- import type { Value } from './value';
5
-
6
- /**
7
- * Order of facet names and facet values in your UI.
8
- */
9
- export type FacetOrdering = {
10
- facets?: IndexSettingsFacets;
11
-
12
- /**
13
- * Order of facet values. One object for each facet.
14
- */
15
- values?: { [key: string]: Value };
16
- };
@@ -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 FacetStats = {
4
- /**
5
- * Minimum value in the results.
6
- */
7
- min?: number;
8
-
9
- /**
10
- * Maximum value in the results.
11
- */
12
- max?: number;
13
-
14
- /**
15
- * Average facet value in the results.
16
- */
17
- avg?: number;
18
-
19
- /**
20
- * Sum of all values in the results.
21
- */
22
- sum?: number;
23
- };
@@ -1,5 +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 { RecommendSearchParams } from './recommendSearchParams';
4
-
5
- export type FallbackParams = RecommendSearchParams & Record<string, unknown>;
package/model/fbtModel.ts DELETED
@@ -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
- * Frequently bought together model. This model recommends items that have been purchased within 1 day with the item with the ID `objectID`.
5
- */
6
- export type FbtModel = 'bought-together';
@@ -1,12 +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 { FbtModel } from './fbtModel';
4
-
5
- export type FrequentlyBoughtTogether = {
6
- model: FbtModel;
7
-
8
- /**
9
- * Unique record identifier.
10
- */
11
- objectID: string;
12
- };
@@ -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 { TaskStatus } from './taskStatus';
4
-
5
- export type GetRecommendTaskResponse = {
6
- status: TaskStatus;
7
- };
@@ -1,13 +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
-
5
- /**
6
- * Recommend request body.
7
- */
8
- export type GetRecommendationsParams = {
9
- /**
10
- * Recommendation request with parameters depending on the requested model.
11
- */
12
- requests: Array<RecommendationsRequest>;
13
- };
@@ -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 { RecommendationsResults } from './recommendationsResults';
4
-
5
- export type GetRecommendationsResponse = {
6
- results: Array<RecommendationsResults>;
7
- };
@@ -1,11 +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
- * Object ID of the recommendation you want to exclude.
5
- */
6
- export type HideConsequenceObject = {
7
- /**
8
- * Unique record identifier.
9
- */
10
- objectID?: string;
11
- };
@@ -1,5 +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 { HighlightResultOption } from './highlightResultOption';
4
-
5
- export type HighlightResult = HighlightResultOption | { [key: string]: HighlightResult } | Array<HighlightResult>;
@@ -1,25 +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 { MatchLevel } from './matchLevel';
4
-
5
- /**
6
- * Surround words that match the query with HTML tags for highlighting.
7
- */
8
- export type HighlightResultOption = {
9
- /**
10
- * Highlighted attribute value, including HTML tags.
11
- */
12
- value: string;
13
-
14
- matchLevel: MatchLevel;
15
-
16
- /**
17
- * List of matched words from the search query.
18
- */
19
- matchedWords: Array<string>;
20
-
21
- /**
22
- * Whether the entire attribute value is highlighted.
23
- */
24
- fullyHighlighted?: boolean;
25
- };
@@ -1,9 +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 { BooleanString } from './booleanString';
4
- import type { SupportedLanguage } from './supportedLanguage';
5
-
6
- /**
7
- * Treat singular, plurals, and other forms of declensions as equivalent. You should only use this feature for the languages used in your index.
8
- */
9
- export type IgnorePlurals = Array<SupportedLanguage> | BooleanString | boolean;
package/model/index.ts DELETED
@@ -1,101 +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 * from './advancedSyntaxFeatures';
4
- export * from './alternativesAsExact';
5
- export * from './aroundPrecision';
6
- export * from './aroundRadius';
7
- export * from './aroundRadiusAll';
8
- export * from './autoFacetFilter';
9
- export * from './banner';
10
- export * from './bannerImage';
11
- export * from './bannerImageUrl';
12
- export * from './bannerLink';
13
- export * from './baseIndexSettings';
14
- export * from './baseRecommendIndexSettings';
15
- export * from './baseRecommendRequest';
16
- export * from './baseRecommendSearchParams';
17
- export * from './baseSearchResponse';
18
- export * from './booleanString';
19
- export * from './boughtTogetherQuery';
20
- export * from './clientMethodProps';
21
- export * from './condition';
22
- export * from './consequence';
23
- export * from './deletedAtResponse';
24
- export * from './distinct';
25
- export * from './errorBase';
26
- export * from './exactOnSingleWordQuery';
27
- export * from './exhaustive';
28
- export * from './facetFilters';
29
- export * from './facetOrdering';
30
- export * from './facetStats';
31
- export * from './fallbackParams';
32
- export * from './fbtModel';
33
- export * from './frequentlyBoughtTogether';
34
- export * from './getRecommendationsParams';
35
- export * from './getRecommendationsResponse';
36
- export * from './getRecommendTaskResponse';
37
- export * from './hideConsequenceObject';
38
- export * from './highlightResult';
39
- export * from './highlightResultOption';
40
- export * from './ignorePlurals';
41
- export * from './indexSettingsFacets';
42
- export * from './lookingSimilar';
43
- export * from './lookingSimilarModel';
44
- export * from './lookingSimilarQuery';
45
- export * from './matchedGeoLocation';
46
- export * from './matchLevel';
47
- export * from './numericFilters';
48
- export * from './optionalFilters';
49
- export * from './paramsConsequence';
50
- export * from './personalization';
51
- export * from './promoteConsequenceObject';
52
- export * from './queryType';
53
- export * from './range';
54
- export * from './rankingInfo';
55
- export * from './recommendationsHit';
56
- export * from './recommendationsHits';
57
- export * from './recommendationsRequest';
58
- export * from './recommendationsResults';
59
- export * from './recommendedForYou';
60
- export * from './recommendedForYouModel';
61
- export * from './recommendedForYouQuery';
62
- export * from './recommendHit';
63
- export * from './recommendIndexSettings';
64
- export * from './recommendModels';
65
- export * from './recommendRule';
66
- export * from './recommendSearchParams';
67
- export * from './recommendUpdatedAtResponse';
68
- export * from './redirect';
69
- export * from './redirectRuleIndexData';
70
- export * from './redirectRuleIndexMetadata';
71
- export * from './redirectURL';
72
- export * from './relatedModel';
73
- export * from './relatedProducts';
74
- export * from './relatedQuery';
75
- export * from './removeStopWords';
76
- export * from './removeWordsIfNoResults';
77
- export * from './renderingContent';
78
- export * from './reRankingApplyFilter';
79
- export * from './ruleMetadata';
80
- export * from './searchPagination';
81
- export * from './searchParamsQuery';
82
- export * from './searchRecommendRulesParams';
83
- export * from './searchRecommendRulesResponse';
84
- export * from './snippetResult';
85
- export * from './snippetResultOption';
86
- export * from './sortRemainingBy';
87
- export * from './supportedLanguage';
88
- export * from './tagFilters';
89
- export * from './taskStatus';
90
- export * from './timeRange';
91
- export * from './trendingFacetHit';
92
- export * from './trendingFacets';
93
- export * from './trendingFacetsModel';
94
- export * from './trendingFacetsQuery';
95
- export * from './trendingItems';
96
- export * from './trendingItemsModel';
97
- export * from './trendingItemsQuery';
98
- export * from './typoTolerance';
99
- export * from './typoToleranceEnum';
100
- export * from './value';
101
- export * from './widgets';
@@ -1,11 +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
- * Order of facet names.
5
- */
6
- export type IndexSettingsFacets = {
7
- /**
8
- * Explicit order of facets or facet values. This setting lets you always show specific facets or facet values at the top of the list.
9
- */
10
- order?: Array<string>;
11
- };
@@ -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 { FallbackParams } from './fallbackParams';
4
- import type { LookingSimilarModel } from './lookingSimilarModel';
5
-
6
- export type LookingSimilar = {
7
- model: LookingSimilarModel;
8
-
9
- /**
10
- * Unique record identifier.
11
- */
12
- objectID: string;
13
-
14
- fallbackParameters?: FallbackParams;
15
- };
@@ -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
- * Looking similar model. This model recommends items that look similar to the item with the ID `objectID` based on image attributes in your index.
5
- */
6
- export type LookingSimilarModel = 'looking-similar';
@@ -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 { LookingSimilar } from './lookingSimilar';
5
-
6
- export type LookingSimilarQuery = BaseRecommendRequest & LookingSimilar;
@@ -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
- * Whether the whole query string matches or only a part.
5
- */
6
- export type MatchLevel = 'none' | 'partial' | 'full';
@@ -1,18 +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 MatchedGeoLocation = {
4
- /**
5
- * Latitude of the matched location.
6
- */
7
- lat?: number;
8
-
9
- /**
10
- * Longitude of the matched location.
11
- */
12
- lng?: number;
13
-
14
- /**
15
- * Distance between the matched location and the search location (in meters).
16
- */
17
- distance?: number;
18
- };
@@ -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
- * Filter by numeric facets. **Prefer using the `filters` parameter, which supports all filter types and combinations with boolean operators.** You can use numeric comparison operators: `<`, `<=`, `=`, `!=`, `>`, `>=`. Comparisons are precise up to 3 decimals. You can also provide ranges: `facet:<lower> TO <upper>`. The range includes the lower and upper boundaries. The same combination rules apply as for `facetFilters`.
5
- */
6
- export type NumericFilters = Array<NumericFilters> | string;
@@ -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
- * Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match. - Optional filters don\'t work on virtual replicas. - Optional filters are applied _after_ sort-by attributes. - Optional filters don\'t work with numeric attributes.
5
- */
6
- export type OptionalFilters = Array<OptionalFilters> | string;
@@ -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
- import type { AutoFacetFilter } from './autoFacetFilter';
4
-
5
- /**
6
- * Filter or boost recommendations matching a facet filter.
7
- */
8
- export type ParamsConsequence = {
9
- /**
10
- * Filter recommendations that match or don\'t match the same `facet:facet_value` combination as the viewed item.
11
- */
12
- automaticFacetFilters?: Array<AutoFacetFilter>;
13
-
14
- /**
15
- * 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/).
16
- */
17
- filters?: string;
18
-
19
- /**
20
- * Filters to promote or demote records in the search results. Optional filters work like facet filters, but they don\'t exclude records from the search results. Records that match the optional filter rank before records that don\'t match. Matches with higher weights (`<score=N>`) rank before matches with lower weights. If you\'re using a negative filter `facet:-value`, matching records rank after records that don\'t match.
21
- */
22
- optionalFilters?: Array<string>;
23
- };
@@ -1,18 +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 Personalization = {
4
- /**
5
- * The score of the filters.
6
- */
7
- filtersScore?: number;
8
-
9
- /**
10
- * The score of the ranking.
11
- */
12
- rankingScore?: number;
13
-
14
- /**
15
- * The score of the event.
16
- */
17
- score?: number;
18
- };
@@ -1,16 +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
- * Object ID and position of the recommendation you want to pin.
5
- */
6
- export type PromoteConsequenceObject = {
7
- /**
8
- * Unique record identifier.
9
- */
10
- objectID?: string;
11
-
12
- /**
13
- * Index in the list of recommendations where to place this item.
14
- */
15
- position?: number;
16
- };
@@ -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 if and how query words are interpreted as prefixes. By default, only the last query word is treated as a prefix (`prefixLast`). To turn off prefix search, use `prefixNone`. Avoid `prefixAll`, which treats all query words as prefixes. This might lead to counterintuitive results and makes your search slower. For more information, see [Prefix searching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/prefix-searching/).
5
- */
6
- export type QueryType = 'prefixLast' | 'prefixAll' | 'prefixNone';
package/model/range.ts DELETED
@@ -1,16 +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
- * Range object with lower and upper values in meters to define custom ranges.
5
- */
6
- export type Range = {
7
- /**
8
- * Lower boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
9
- */
10
- from?: number;
11
-
12
- /**
13
- * Upper boundary of a range in meters. The Geo ranking criterion considers all records within the range to be equal.
14
- */
15
- value?: number;
16
- };
@@ -1,68 +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 { MatchedGeoLocation } from './matchedGeoLocation';
4
- import type { Personalization } from './personalization';
5
-
6
- /**
7
- * Object with detailed information about the record\'s ranking.
8
- */
9
- export type RankingInfo = {
10
- /**
11
- * Whether a filter matched the query.
12
- */
13
- filters?: number;
14
-
15
- /**
16
- * Position of the first matched word in the best matching attribute of the record.
17
- */
18
- firstMatchedWord: number;
19
-
20
- /**
21
- * Distance between the geo location in the search query and the best matching geo location in the record, divided by the geo precision (in meters).
22
- */
23
- geoDistance: number;
24
-
25
- /**
26
- * Precision used when computing the geo distance, in meters.
27
- */
28
- geoPrecision?: number;
29
-
30
- matchedGeoLocation?: MatchedGeoLocation;
31
-
32
- personalization?: Personalization;
33
-
34
- /**
35
- * Number of exactly matched words.
36
- */
37
- nbExactWords: number;
38
-
39
- /**
40
- * Number of typos encountered when matching the record.
41
- */
42
- nbTypos: number;
43
-
44
- /**
45
- * Whether the record was promoted by a rule.
46
- */
47
- promoted?: boolean;
48
-
49
- /**
50
- * Number of words between multiple matches in the query plus 1. For single word queries, `proximityDistance` is 0.
51
- */
52
- proximityDistance?: number;
53
-
54
- /**
55
- * Overall ranking of the record, expressed as a single integer. This attribute is internal.
56
- */
57
- userScore: number;
58
-
59
- /**
60
- * Number of matched words.
61
- */
62
- words?: number;
63
-
64
- /**
65
- * Whether the record is re-ranked.
66
- */
67
- promotedByReRanking?: boolean;
68
- };