Skip to content

Commit e1431c8

Browse files
fix(specs): remove recommend query params overridden by the API (generated)
algolia/api-clients-automation#6604 Co-authored-by: algolia-api-clients-automation-bot[bot] <288895823+algolia-api-clients-automation-bot[bot]@users.noreply.github.com> Co-authored-by: Raed <raed.chammam@algolia.com>
1 parent cd38da1 commit e1431c8

10 files changed

Lines changed: 22 additions & 49 deletions

packages/algoliasearch/lite/model/baseRecommendIndexSettings.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ export type BaseRecommendIndexSettings = {
2020
*/
2121
attributesToRetrieve?: Array<string> | undefined;
2222

23-
/**
24-
* Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
25-
*/
26-
ranking?: Array<string> | undefined;
27-
2823
/**
2924
* Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
3025
*/
@@ -96,11 +91,6 @@ export type BaseRecommendIndexSettings = {
9691
*/
9792
decompoundQuery?: boolean | undefined;
9893

99-
/**
100-
* Whether to enable rules.
101-
*/
102-
enableRules?: boolean | undefined;
103-
10494
/**
10595
* Whether to enable Personalization.
10696
*/

packages/algoliasearch/lite/model/baseRecommendSearchParams.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import type { AroundPrecision } from './aroundPrecision';
44
import type { AroundRadius } from './aroundRadius';
5-
import type { FacetFilters } from './facetFilters';
65
import type { InsideBoundingBox } from './insideBoundingBox';
76
import type { NumericFilters } from './numericFilters';
87
import type { OptionalFilters } from './optionalFilters';
@@ -20,8 +19,6 @@ export type BaseRecommendSearchParams = {
2019
*/
2120
filters?: string | undefined;
2221

23-
facetFilters?: FacetFilters | undefined;
24-
2522
optionalFilters?: OptionalFilters | undefined;
2623

2724
numericFilters?: NumericFilters | undefined;
@@ -123,9 +120,4 @@ export type BaseRecommendSearchParams = {
123120
* Whether to include this search when calculating processing-time percentiles.
124121
*/
125122
percentileComputation?: boolean | undefined;
126-
127-
/**
128-
* Whether to enable A/B testing for this search.
129-
*/
130-
enableABTest?: boolean | undefined;
131123
};
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
// 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.
22

3-
import type { RecommendSearchParams } from './recommendSearchParams';
3+
import type { BaseRecommendSearchParams } from './baseRecommendSearchParams';
4+
import type { RecommendIndexSettings } from './recommendIndexSettings';
5+
import type { SearchParamsQuery } from './searchParamsQuery';
46

5-
export type FallbackParams = RecommendSearchParams & Record<string, unknown>;
7+
/**
8+
* Search parameters to use for a fallback request if there aren\'t enough recommendations.
9+
*/
10+
export type FallbackParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;

packages/algoliasearch/lite/model/recommendSearchParams.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,7 @@ import type { SearchParamsQuery } from './searchParamsQuery';
77
/**
88
* Search parameters for filtering the recommendations.
99
*/
10-
export type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;
10+
export type RecommendSearchParams = BaseRecommendSearchParams &
11+
SearchParamsQuery &
12+
RecommendIndexSettings &
13+
Record<string, unknown>;

packages/recommend/model/baseRecommendIndexSettings.ts

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,6 @@ export type BaseRecommendIndexSettings = {
2020
*/
2121
attributesToRetrieve?: Array<string> | undefined;
2222

23-
/**
24-
* Determines the order in which Algolia returns your results. By default, each entry corresponds to a [ranking criteria](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria). The tie-breaking algorithm sequentially applies each criterion in the order they\'re specified. If you configure a replica index for [sorting by an attribute](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/how-to/sort-by-attribute), you put the sorting attribute at the top of the list. **Modifiers** - `asc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in ascending order. - `desc(\"ATTRIBUTE\")`. Sort the index by the values of an attribute, in descending order. Before you modify the default setting, test your changes in the dashboard, and by [A/B testing](https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing).
25-
*/
26-
ranking?: Array<string> | undefined;
27-
2823
/**
2924
* Relevancy threshold below which less relevant results aren\'t included in the results You can only set `relevancyStrictness` on [virtual replica indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/#what-are-virtual-replicas). Use this setting to strike a balance between the relevance and number of returned results.
3025
*/
@@ -96,11 +91,6 @@ export type BaseRecommendIndexSettings = {
9691
*/
9792
decompoundQuery?: boolean | undefined;
9893

99-
/**
100-
* Whether to enable rules.
101-
*/
102-
enableRules?: boolean | undefined;
103-
10494
/**
10595
* Whether to enable Personalization.
10696
*/

packages/recommend/model/baseRecommendSearchParams.ts

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
import type { AroundPrecision } from './aroundPrecision';
44
import type { AroundRadius } from './aroundRadius';
5-
import type { FacetFilters } from './facetFilters';
65
import type { InsideBoundingBox } from './insideBoundingBox';
76
import type { NumericFilters } from './numericFilters';
87
import type { OptionalFilters } from './optionalFilters';
@@ -20,8 +19,6 @@ export type BaseRecommendSearchParams = {
2019
*/
2120
filters?: string | undefined;
2221

23-
facetFilters?: FacetFilters | undefined;
24-
2522
optionalFilters?: OptionalFilters | undefined;
2623

2724
numericFilters?: NumericFilters | undefined;
@@ -123,9 +120,4 @@ export type BaseRecommendSearchParams = {
123120
* Whether to include this search when calculating processing-time percentiles.
124121
*/
125122
percentileComputation?: boolean | undefined;
126-
127-
/**
128-
* Whether to enable A/B testing for this search.
129-
*/
130-
enableABTest?: boolean | undefined;
131123
};

packages/recommend/model/facetFilters.ts

Lines changed: 0 additions & 6 deletions
This file was deleted.
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
// 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.
22

3-
import type { RecommendSearchParams } from './recommendSearchParams';
3+
import type { BaseRecommendSearchParams } from './baseRecommendSearchParams';
4+
import type { RecommendIndexSettings } from './recommendIndexSettings';
5+
import type { SearchParamsQuery } from './searchParamsQuery';
46

5-
export type FallbackParams = RecommendSearchParams & Record<string, unknown>;
7+
/**
8+
* Search parameters to use for a fallback request if there aren\'t enough recommendations.
9+
*/
10+
export type FallbackParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;

packages/recommend/model/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@ export * from './distinct';
2525
export * from './errorBase';
2626
export * from './exactOnSingleWordQuery';
2727
export * from './exhaustive';
28-
export * from './facetFilters';
2928
export * from './facetOrdering';
3029
export * from './facetStats';
3130
export * from './fallbackParams';

packages/recommend/model/recommendSearchParams.ts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,7 @@ import type { SearchParamsQuery } from './searchParamsQuery';
77
/**
88
* Search parameters for filtering the recommendations.
99
*/
10-
export type RecommendSearchParams = BaseRecommendSearchParams & SearchParamsQuery & RecommendIndexSettings;
10+
export type RecommendSearchParams = BaseRecommendSearchParams &
11+
SearchParamsQuery &
12+
RecommendIndexSettings &
13+
Record<string, unknown>;

0 commit comments

Comments
 (0)