algoliasearch 5.0.0-alpha.111 → 5.0.0-alpha.112
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/algoliasearch/builds/browser.d.ts +1 -1
- package/dist/algoliasearch/builds/node.d.ts +1 -1
- package/dist/algoliasearch.cjs +20 -20
- package/dist/algoliasearch.esm.browser.js +22 -25
- package/dist/algoliasearch.esm.node.js +20 -20
- package/dist/algoliasearch.umd.js +2 -2
- package/dist/client-abtesting/model/aBTest.d.ts +9 -24
- package/dist/client-abtesting/model/aBTest.d.ts.map +1 -1
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts +12 -0
- package/dist/client-abtesting/model/aBTestConfiguration.d.ts.map +1 -0
- package/dist/client-abtesting/model/aBTestResponse.d.ts +2 -2
- package/dist/client-abtesting/model/abTestsVariant.d.ts +3 -3
- package/dist/client-abtesting/model/addABTestsRequest.d.ts +1 -1
- package/dist/client-abtesting/model/clientMethodProps.d.ts +5 -5
- package/dist/client-abtesting/model/customSearchParams.d.ts +1 -1
- package/dist/client-abtesting/model/effect.d.ts +5 -0
- package/dist/client-abtesting/model/effect.d.ts.map +1 -0
- package/dist/client-abtesting/model/emptySearch.d.ts +10 -0
- package/dist/client-abtesting/model/emptySearch.d.ts.map +1 -0
- package/dist/client-abtesting/model/index.d.ts +6 -0
- package/dist/client-abtesting/model/index.d.ts.map +1 -1
- package/dist/client-abtesting/model/listABTestsResponse.d.ts +1 -1
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts +12 -0
- package/dist/client-abtesting/model/minimumDetectableEffect.d.ts.map +1 -0
- package/dist/client-abtesting/model/outliers.d.ts +10 -0
- package/dist/client-abtesting/model/outliers.d.ts.map +1 -0
- package/dist/client-abtesting/model/status.d.ts +5 -0
- package/dist/client-abtesting/model/status.d.ts.map +1 -0
- package/dist/client-abtesting/model/variant.d.ts +13 -13
- package/dist/client-abtesting/src/abtestingClient.d.ts +11 -11
- package/dist/client-analytics/src/analyticsClient.d.ts +1 -1
- package/dist/client-personalization/model/clientMethodProps.d.ts +2 -2
- package/dist/client-personalization/model/deleteUserProfileResponse.d.ts +2 -2
- package/dist/client-personalization/model/eventScoring.d.ts +4 -6
- package/dist/client-personalization/model/eventScoring.d.ts.map +1 -1
- package/dist/client-personalization/model/eventType.d.ts +5 -0
- package/dist/client-personalization/model/eventType.d.ts.map +1 -0
- package/dist/client-personalization/model/facetScoring.d.ts +2 -2
- package/dist/client-personalization/model/getUserTokenResponse.d.ts +3 -3
- package/dist/client-personalization/model/index.d.ts +1 -0
- package/dist/client-personalization/model/index.d.ts.map +1 -1
- package/dist/client-personalization/model/personalizationStrategyParams.d.ts +3 -3
- package/dist/client-personalization/src/personalizationClient.d.ts +7 -7
- package/dist/client-search/model/baseIndexSettings.d.ts +9 -9
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts +4 -3
- package/dist/client-search/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/client-search/model/deleteByParams.d.ts +1 -1
- package/dist/client-search/model/indexSettingsAsSearchParams.d.ts +6 -6
- package/dist/client-search/model/multipleBatchRequest.d.ts +1 -1
- package/dist/client-search/model/operationIndexParams.d.ts +1 -1
- package/dist/client-search/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/client-search/model/searchForFacetsOptions.d.ts +1 -1
- package/dist/client-search/model/searchForHitsOptions.d.ts +1 -1
- package/dist/client-search/model/searchParamsObject.d.ts +3 -0
- package/dist/client-search/model/searchParamsObject.d.ts.map +1 -1
- package/dist/client-search/src/searchClient.d.ts +1 -1
- package/dist/lite/lite.cjs +1 -1
- package/dist/lite/lite.esm.browser.js +3 -6
- package/dist/lite/lite.esm.node.js +1 -1
- package/dist/lite/lite.umd.js +2 -2
- package/dist/lite/model/baseIndexSettings.d.ts +9 -9
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts +4 -3
- package/dist/lite/model/baseSearchParamsWithoutQuery.d.ts.map +1 -1
- package/dist/lite/model/deleteByParams.d.ts +1 -1
- package/dist/lite/model/indexSettingsAsSearchParams.d.ts +6 -6
- package/dist/lite/model/reRankingApplyFilter.d.ts +1 -1
- package/dist/lite/model/searchForFacetsOptions.d.ts +1 -1
- package/dist/lite/model/searchForHitsOptions.d.ts +1 -1
- package/dist/lite/model/searchParamsObject.d.ts +3 -0
- package/dist/lite/model/searchParamsObject.d.ts.map +1 -1
- package/dist/lite/src/liteClient.d.ts +1 -1
- package/lite/model/baseIndexSettings.ts +9 -9
- package/lite/model/baseSearchParamsWithoutQuery.ts +4 -3
- package/lite/model/deleteByParams.ts +1 -1
- package/lite/model/indexSettingsAsSearchParams.ts +6 -6
- package/lite/model/reRankingApplyFilter.ts +1 -1
- package/lite/model/searchForFacetsOptions.ts +1 -1
- package/lite/model/searchForHitsOptions.ts +1 -1
- package/lite/model/searchParamsObject.ts +3 -0
- package/lite/src/liteClient.ts +1 -1
- package/package.json +11 -11
|
@@ -6,11 +6,11 @@ export type Variant = {
|
|
|
6
6
|
*/
|
|
7
7
|
addToCartCount: number;
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* [Add-to-cart rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#add-to-cart-rate) for this variant.
|
|
10
10
|
*/
|
|
11
11
|
addToCartRate: number | null;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* [Average click position](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-position) for this variant.
|
|
14
14
|
*/
|
|
15
15
|
averageClickPosition: number | null;
|
|
16
16
|
/**
|
|
@@ -18,7 +18,7 @@ export type Variant = {
|
|
|
18
18
|
*/
|
|
19
19
|
clickCount: number;
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* [Click-through rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#click-through-rate) for this variant.
|
|
22
22
|
*/
|
|
23
23
|
clickThroughRate: number | null;
|
|
24
24
|
/**
|
|
@@ -26,7 +26,7 @@ export type Variant = {
|
|
|
26
26
|
*/
|
|
27
27
|
conversionCount: number;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* [Conversion rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#conversion-rate) for this variant.
|
|
30
30
|
*/
|
|
31
31
|
conversionRate: number | null;
|
|
32
32
|
/**
|
|
@@ -34,20 +34,20 @@ export type Variant = {
|
|
|
34
34
|
*/
|
|
35
35
|
currencies?: Record<string, Currency>;
|
|
36
36
|
/**
|
|
37
|
-
*
|
|
37
|
+
* Description for this variant.
|
|
38
38
|
*/
|
|
39
39
|
description: string;
|
|
40
40
|
/**
|
|
41
|
-
*
|
|
41
|
+
* Estimated number of searches required to achieve the desired statistical significance. The A/B test configuration must include a `mininmumDetectableEffect` setting for this number to be included in the response.
|
|
42
42
|
*/
|
|
43
43
|
estimatedSampleSize?: number;
|
|
44
44
|
filterEffects?: FilterEffects;
|
|
45
45
|
/**
|
|
46
|
-
* A/B test
|
|
46
|
+
* Index name of the A/B test variant (case-sensitive).
|
|
47
47
|
*/
|
|
48
48
|
index: string;
|
|
49
49
|
/**
|
|
50
|
-
* Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for
|
|
50
|
+
* Number of [searches without results](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#searches-without-results) for this variant.
|
|
51
51
|
*/
|
|
52
52
|
noResultCount: number | null;
|
|
53
53
|
/**
|
|
@@ -55,11 +55,11 @@ export type Variant = {
|
|
|
55
55
|
*/
|
|
56
56
|
purchaseCount: number;
|
|
57
57
|
/**
|
|
58
|
-
*
|
|
58
|
+
* [Purchase rate](https://www.algolia.com/doc/guides/search-analytics/concepts/metrics/#purchase-rate) for this variant.
|
|
59
59
|
*/
|
|
60
60
|
purchaseRate: number | null;
|
|
61
61
|
/**
|
|
62
|
-
* Number of searches
|
|
62
|
+
* Number of searches for this variant.
|
|
63
63
|
*/
|
|
64
64
|
searchCount: number | null;
|
|
65
65
|
/**
|
|
@@ -67,15 +67,15 @@ export type Variant = {
|
|
|
67
67
|
*/
|
|
68
68
|
trackedSearchCount?: number;
|
|
69
69
|
/**
|
|
70
|
-
*
|
|
70
|
+
* Percentage of search requests each variant receives.
|
|
71
71
|
*/
|
|
72
72
|
trafficPercentage: number;
|
|
73
73
|
/**
|
|
74
|
-
* Number of users
|
|
74
|
+
* Number of users that made searches to this variant.
|
|
75
75
|
*/
|
|
76
76
|
userCount: number | null;
|
|
77
77
|
/**
|
|
78
|
-
* Number of users that
|
|
78
|
+
* Number of users that made tracked searches to this variant.
|
|
79
79
|
*/
|
|
80
80
|
trackedUserCount: number | null;
|
|
81
81
|
};
|
|
@@ -4,7 +4,7 @@ import type { ABTestResponse } from '../model/aBTestResponse';
|
|
|
4
4
|
import type { AddABTestsRequest } from '../model/addABTestsRequest';
|
|
5
5
|
import type { CustomDeleteProps, CustomGetProps, CustomPostProps, CustomPutProps, DeleteABTestProps, GetABTestProps, ListABTestsProps, StopABTestProps } from '../model/clientMethodProps';
|
|
6
6
|
import type { ListABTestsResponse } from '../model/listABTestsResponse';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.112";
|
|
8
8
|
export declare const REGIONS: readonly ["de", "us"];
|
|
9
9
|
export type Region = (typeof REGIONS)[number];
|
|
10
10
|
export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -31,7 +31,7 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
|
|
|
31
31
|
*/
|
|
32
32
|
addAlgoliaAgent(segment: string, version?: string): void;
|
|
33
33
|
/**
|
|
34
|
-
* Creates
|
|
34
|
+
* Creates a new A/B test.
|
|
35
35
|
*
|
|
36
36
|
* Required API Key ACLs:
|
|
37
37
|
* - editSettings.
|
|
@@ -79,29 +79,29 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
|
|
|
79
79
|
*/
|
|
80
80
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
81
81
|
/**
|
|
82
|
-
*
|
|
82
|
+
* Deletes an A/B test by its ID.
|
|
83
83
|
*
|
|
84
84
|
* Required API Key ACLs:
|
|
85
85
|
* - editSettings.
|
|
86
86
|
*
|
|
87
87
|
* @param deleteABTest - The deleteABTest object.
|
|
88
|
-
* @param deleteABTest.id - Unique A/B test
|
|
88
|
+
* @param deleteABTest.id - Unique A/B test identifier.
|
|
89
89
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
90
90
|
*/
|
|
91
91
|
deleteABTest({ id }: DeleteABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
92
92
|
/**
|
|
93
|
-
*
|
|
93
|
+
* Retrieves the details for an A/B test by its ID.
|
|
94
94
|
*
|
|
95
95
|
* Required API Key ACLs:
|
|
96
96
|
* - analytics.
|
|
97
97
|
*
|
|
98
98
|
* @param getABTest - The getABTest object.
|
|
99
|
-
* @param getABTest.id - Unique A/B test
|
|
99
|
+
* @param getABTest.id - Unique A/B test identifier.
|
|
100
100
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
101
101
|
*/
|
|
102
102
|
getABTest({ id }: GetABTestProps, requestOptions?: RequestOptions): Promise<ABTest>;
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* Lists all A/B tests you configured for this application.
|
|
105
105
|
*
|
|
106
106
|
* Required API Key ACLs:
|
|
107
107
|
* - analytics.
|
|
@@ -109,19 +109,19 @@ export declare function createAbtestingClient({ appId: appIdOption, apiKey: apiK
|
|
|
109
109
|
* @param listABTests - The listABTests object.
|
|
110
110
|
* @param listABTests.offset - Position of the first item to return.
|
|
111
111
|
* @param listABTests.limit - Number of items to return.
|
|
112
|
-
* @param listABTests.indexPrefix - Only
|
|
113
|
-
* @param listABTests.indexSuffix - Only
|
|
112
|
+
* @param listABTests.indexPrefix - Index name prefix. Only A/B tests for indices starting with this string are included in the response.
|
|
113
|
+
* @param listABTests.indexSuffix - Index name suffix. Only A/B tests for indices ending with this string are included in the response.
|
|
114
114
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
115
115
|
*/
|
|
116
116
|
listABTests({ offset, limit, indexPrefix, indexSuffix }?: ListABTestsProps, requestOptions?: RequestOptions | undefined): Promise<ListABTestsResponse>;
|
|
117
117
|
/**
|
|
118
|
-
*
|
|
118
|
+
* Stops an A/B test by its ID. You can\'t restart stopped A/B tests.
|
|
119
119
|
*
|
|
120
120
|
* Required API Key ACLs:
|
|
121
121
|
* - editSettings.
|
|
122
122
|
*
|
|
123
123
|
* @param stopABTest - The stopABTest object.
|
|
124
|
-
* @param stopABTest.id - Unique A/B test
|
|
124
|
+
* @param stopABTest.id - Unique A/B test identifier.
|
|
125
125
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
126
126
|
*/
|
|
127
127
|
stopABTest({ id }: StopABTestProps, requestOptions?: RequestOptions): Promise<ABTestResponse>;
|
|
@@ -20,7 +20,7 @@ import type { GetTopFiltersNoResultsResponse } from '../model/getTopFiltersNoRes
|
|
|
20
20
|
import type { GetTopHitsResponse } from '../model/getTopHitsResponse';
|
|
21
21
|
import type { GetTopSearchesResponse } from '../model/getTopSearchesResponse';
|
|
22
22
|
import type { GetUsersCountResponse } from '../model/getUsersCountResponse';
|
|
23
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
23
|
+
export declare const apiClientVersion = "5.0.0-alpha.112";
|
|
24
24
|
export declare const REGIONS: readonly ["de", "us"];
|
|
25
25
|
export type Region = (typeof REGIONS)[number];
|
|
26
26
|
export declare function createAnalyticsClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -63,7 +63,7 @@ export type CustomPutProps = {
|
|
|
63
63
|
*/
|
|
64
64
|
export type DeleteUserProfileProps = {
|
|
65
65
|
/**
|
|
66
|
-
*
|
|
66
|
+
* Unique identifier representing a user for which to fetch the personalization profile.
|
|
67
67
|
*/
|
|
68
68
|
userToken: string;
|
|
69
69
|
};
|
|
@@ -72,7 +72,7 @@ export type DeleteUserProfileProps = {
|
|
|
72
72
|
*/
|
|
73
73
|
export type GetUserTokenProfileProps = {
|
|
74
74
|
/**
|
|
75
|
-
*
|
|
75
|
+
* Unique identifier representing a user for which to fetch the personalization profile.
|
|
76
76
|
*/
|
|
77
77
|
userToken: string;
|
|
78
78
|
};
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
export type DeleteUserProfileResponse = {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
|
|
4
4
|
*/
|
|
5
5
|
userToken: string;
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
7
|
+
* Date and time when the user profile can be safely considered to be deleted. Any events received after the `deletedUntil` date start a new user profile.
|
|
8
8
|
*/
|
|
9
9
|
deletedUntil: string;
|
|
10
10
|
};
|
|
@@ -1,15 +1,13 @@
|
|
|
1
|
+
import type { EventType } from './eventType';
|
|
1
2
|
export type EventScoring = {
|
|
2
3
|
/**
|
|
3
|
-
*
|
|
4
|
+
* Event score.
|
|
4
5
|
*/
|
|
5
6
|
score: number;
|
|
6
7
|
/**
|
|
7
|
-
*
|
|
8
|
+
* Event name.
|
|
8
9
|
*/
|
|
9
10
|
eventName: string;
|
|
10
|
-
|
|
11
|
-
* The type of the event.
|
|
12
|
-
*/
|
|
13
|
-
eventType: string;
|
|
11
|
+
eventType: EventType;
|
|
14
12
|
};
|
|
15
13
|
//# sourceMappingURL=eventScoring.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"eventScoring.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/eventScoring.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB
|
|
1
|
+
{"version":3,"file":"eventScoring.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/eventScoring.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"eventType.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/eventType.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,YAAY,GAAG,MAAM,CAAC"}
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
export type GetUserTokenResponse = {
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* Unique pseudonymous or anonymous user identifier. This helps with analytics and click and conversion events. For more information, see [user token](https://www.algolia.com/doc/guides/sending-events/concepts/usertoken/).
|
|
4
4
|
*/
|
|
5
5
|
userToken: string;
|
|
6
6
|
/**
|
|
7
|
-
* Date of last event
|
|
7
|
+
* Date and time of the last event from this user, in RFC 3339 format.
|
|
8
8
|
*/
|
|
9
9
|
lastEventAt: string;
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Scores for different facet values. Scores represent the user affinity for a user profile towards specific facet values, given the personalization strategy and past events.
|
|
12
12
|
*/
|
|
13
13
|
scores: Record<string, any>;
|
|
14
14
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qBAAqB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../client-personalization/model/index.ts"],"names":[],"mappings":"AAEA,cAAc,6BAA6B,CAAC;AAC5C,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,aAAa,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,wBAAwB,CAAC;AACvC,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,qBAAqB,CAAC"}
|
|
@@ -2,15 +2,15 @@ import type { EventScoring } from './eventScoring';
|
|
|
2
2
|
import type { FacetScoring } from './facetScoring';
|
|
3
3
|
export type PersonalizationStrategyParams = {
|
|
4
4
|
/**
|
|
5
|
-
* Scores associated with the events.
|
|
5
|
+
* Scores associated with each event. The higher the scores, the higher the impact of those events on the personalization of search results.
|
|
6
6
|
*/
|
|
7
7
|
eventScoring: EventScoring[];
|
|
8
8
|
/**
|
|
9
|
-
* Scores associated with the
|
|
9
|
+
* Scores associated with each facet. The higher the scores, the higher the impact of those events on the personalization of search results.
|
|
10
10
|
*/
|
|
11
11
|
facetScoring: FacetScoring[];
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Impact of personalization on the search results. If set to 0, personalization has no impact on the search results.
|
|
14
14
|
*/
|
|
15
15
|
personalizationImpact: number;
|
|
16
16
|
};
|
|
@@ -4,7 +4,7 @@ import type { DeleteUserProfileResponse } from '../model/deleteUserProfileRespon
|
|
|
4
4
|
import type { GetUserTokenResponse } from '../model/getUserTokenResponse';
|
|
5
5
|
import type { PersonalizationStrategyParams } from '../model/personalizationStrategyParams';
|
|
6
6
|
import type { SetPersonalizationStrategyResponse } from '../model/setPersonalizationStrategyResponse';
|
|
7
|
-
export declare const apiClientVersion = "5.0.0-alpha.
|
|
7
|
+
export declare const apiClientVersion = "5.0.0-alpha.112";
|
|
8
8
|
export declare const REGIONS: readonly ["eu", "us"];
|
|
9
9
|
export type Region = (typeof REGIONS)[number];
|
|
10
10
|
export declare function createPersonalizationClient({ appId: appIdOption, apiKey: apiKeyOption, authMode, algoliaAgents, region: regionOption, ...options }: CreateClientOptions & {
|
|
@@ -69,18 +69,18 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
|
|
|
69
69
|
*/
|
|
70
70
|
customPut({ path, parameters, body }: CustomPutProps, requestOptions?: RequestOptions): Promise<Record<string, any>>;
|
|
71
71
|
/**
|
|
72
|
-
*
|
|
72
|
+
* Deletes a user profile. The response includes a date and time when the user profile can safely be considered deleted.
|
|
73
73
|
*
|
|
74
74
|
* Required API Key ACLs:
|
|
75
75
|
* - recommendation.
|
|
76
76
|
*
|
|
77
77
|
* @param deleteUserProfile - The deleteUserProfile object.
|
|
78
|
-
* @param deleteUserProfile.userToken -
|
|
78
|
+
* @param deleteUserProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
|
|
79
79
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
80
80
|
*/
|
|
81
81
|
deleteUserProfile({ userToken }: DeleteUserProfileProps, requestOptions?: RequestOptions): Promise<DeleteUserProfileResponse>;
|
|
82
82
|
/**
|
|
83
|
-
*
|
|
83
|
+
* Retrieves the current personalization strategy.
|
|
84
84
|
*
|
|
85
85
|
* Required API Key ACLs:
|
|
86
86
|
* - recommendation.
|
|
@@ -89,18 +89,18 @@ export declare function createPersonalizationClient({ appId: appIdOption, apiKey
|
|
|
89
89
|
*/
|
|
90
90
|
getPersonalizationStrategy(requestOptions?: RequestOptions): Promise<PersonalizationStrategyParams>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* Retrieves a user profile and their affinities for different facets.
|
|
93
93
|
*
|
|
94
94
|
* Required API Key ACLs:
|
|
95
95
|
* - recommendation.
|
|
96
96
|
*
|
|
97
97
|
* @param getUserTokenProfile - The getUserTokenProfile object.
|
|
98
|
-
* @param getUserTokenProfile.userToken -
|
|
98
|
+
* @param getUserTokenProfile.userToken - Unique identifier representing a user for which to fetch the personalization profile.
|
|
99
99
|
* @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
|
|
100
100
|
*/
|
|
101
101
|
getUserTokenProfile({ userToken }: GetUserTokenProfileProps, requestOptions?: RequestOptions): Promise<GetUserTokenResponse>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* Creates a new personalization strategy.
|
|
104
104
|
*
|
|
105
105
|
* Required API Key ACLs:
|
|
106
106
|
* - recommendation.
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { SupportedLanguage } from './supportedLanguage';
|
|
2
2
|
export type BaseIndexSettings = {
|
|
3
3
|
/**
|
|
4
|
-
* Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are
|
|
4
|
+
* Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/). Facets are attributes that let you categorize search results. They can be used for filtering search results. By default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** - `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn\'t evalue the facet values. - `searchable(\"ATTRIBUTE\")`. Allows searching for facet values. - `afterDistinct(\"ATTRIBUTE\")`. Evaluates the facet count _after_ deduplication with `distinct`. This ensures accurate facet counts. You can apply this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
|
|
5
5
|
*/
|
|
6
6
|
attributesForFaceting?: string[];
|
|
7
7
|
/**
|
|
@@ -13,7 +13,7 @@ export type BaseIndexSettings = {
|
|
|
13
13
|
*/
|
|
14
14
|
paginationLimitedTo?: number;
|
|
15
15
|
/**
|
|
16
|
-
* Attributes that can\'t be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results.
|
|
16
|
+
* Attributes that can\'t be retrieved at query time. This can be useful if you want to use an attribute for ranking or to [restrict access](https://www.algolia.com/doc/guides/security/api-keys/how-to/user-restricted-access-to-data/), but don\'t want to include it in the search results. Attribute names are case-sensitive.
|
|
17
17
|
*/
|
|
18
18
|
unretrievableAttributes?: string[];
|
|
19
19
|
/**
|
|
@@ -21,15 +21,15 @@ export type BaseIndexSettings = {
|
|
|
21
21
|
*/
|
|
22
22
|
disableTypoToleranceOnWords?: string[];
|
|
23
23
|
/**
|
|
24
|
-
* Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese.
|
|
24
|
+
* Attributes, for which you want to support [Japanese transliteration](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/language-specific-configurations/#japanese-transliteration-and-type-ahead). Transliteration supports searching in any of the Japanese writing systems. To support transliteration, you must set the indexing language to Japanese. Attribute names are case-sensitive.
|
|
25
25
|
*/
|
|
26
26
|
attributesToTransliterate?: string[];
|
|
27
27
|
/**
|
|
28
|
-
* Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words.
|
|
28
|
+
* Attributes for which to split [camel case](https://wikipedia.org/wiki/Camel_case) words. Attribute names are case-sensitive.
|
|
29
29
|
*/
|
|
30
30
|
camelCaseAttributes?: string[];
|
|
31
31
|
/**
|
|
32
|
-
* Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
|
|
32
|
+
* Searchable attributes to which Algolia should apply [word segmentation](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-segmentation/) (decompounding). Attribute names are case-sensitive. Compound words are formed by combining two or more individual words, and are particularly prevalent in Germanic languages—for example, \"firefighter\". With decompounding, the individual components are indexed separately. You can specify different lists for different languages. Decompounding is supported for these languages: Dutch (`nl`), German (`de`), Finnish (`fi`), Danish (`da`), Swedish (`sv`), and Norwegian (`no`).
|
|
33
33
|
*/
|
|
34
34
|
decompoundedAttributes?: Record<string, any>;
|
|
35
35
|
/**
|
|
@@ -37,7 +37,7 @@ export type BaseIndexSettings = {
|
|
|
37
37
|
*/
|
|
38
38
|
indexLanguages?: SupportedLanguage[];
|
|
39
39
|
/**
|
|
40
|
-
* Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search).
|
|
40
|
+
* Searchable attributes for which you want to turn off [prefix matching](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/#adjusting-prefix-search). Attribute names are case-sensitive.
|
|
41
41
|
*/
|
|
42
42
|
disablePrefixOnAttributes?: string[];
|
|
43
43
|
/**
|
|
@@ -45,7 +45,7 @@ export type BaseIndexSettings = {
|
|
|
45
45
|
*/
|
|
46
46
|
allowCompressionOfIntegerArray?: boolean;
|
|
47
47
|
/**
|
|
48
|
-
* Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
|
|
48
|
+
* Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters). Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric attributes, specifiy an attribute that doesn\'t exist in your index, such as `NO_NUMERIC_FILTERING`. **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
|
|
49
49
|
*/
|
|
50
50
|
numericAttributesForFiltering?: string[];
|
|
51
51
|
/**
|
|
@@ -53,7 +53,7 @@ export type BaseIndexSettings = {
|
|
|
53
53
|
*/
|
|
54
54
|
separatorsToIndex?: string;
|
|
55
55
|
/**
|
|
56
|
-
* Attributes used for searching. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
|
|
56
|
+
* Attributes used for searching. Attribute names are case-sensitive. By default, all attributes are searchable and the [Attribute](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#attribute) ranking criterion is turned off. With a non-empty list, Algolia only returns results with matches in the selected attributes. In addition, the Attribute ranking criterion is turned on: matches in attributes that are higher in the list of `searchableAttributes` rank first. To make matches in two attributes rank equally, include them in a comma-separated string, such as `\"title,alternate_title\"`. Attributes with the same priority are always unordered. For more information, see [Searchable attributes](https://www.algolia.com/doc/guides/sending-and-managing-data/prepare-your-data/how-to/setting-searchable-attributes/). **Modifier** - `unordered(\"ATTRIBUTE\")`. Ignore the position of a match within the attribute. Without modifier, matches at the beginning of an attribute rank higer than matches at the end.
|
|
57
57
|
*/
|
|
58
58
|
searchableAttributes?: string[];
|
|
59
59
|
/**
|
|
@@ -65,7 +65,7 @@ export type BaseIndexSettings = {
|
|
|
65
65
|
*/
|
|
66
66
|
customNormalization?: Record<string, Record<string, string>>;
|
|
67
67
|
/**
|
|
68
|
-
* Attribute that should be used to establish groups of results. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
|
|
68
|
+
* Attribute that should be used to establish groups of results. Attribute names are case-sensitive. All records with the same value for this attribute are considered a group. You can combine `attributeForDistinct` with the `distinct` search parameter to control how many items per group are included in the search results. If you want to use the same attribute also for faceting, use the `afterDistinct` modifier of the `attributesForFaceting` setting. This applies faceting _after_ deduplication, which will result in accurate facet counts.
|
|
69
69
|
*/
|
|
70
70
|
attributeForDistinct?: string;
|
|
71
71
|
};
|
|
@@ -3,6 +3,7 @@ import type { AroundRadius } from './aroundRadius';
|
|
|
3
3
|
import type { FacetFilters } from './facetFilters';
|
|
4
4
|
import type { NumericFilters } from './numericFilters';
|
|
5
5
|
import type { OptionalFilters } from './optionalFilters';
|
|
6
|
+
import type { SupportedLanguage } from './supportedLanguage';
|
|
6
7
|
import type { TagFilters } from './tagFilters';
|
|
7
8
|
export type BaseSearchParamsWithoutQuery = {
|
|
8
9
|
/**
|
|
@@ -22,7 +23,7 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
22
23
|
*/
|
|
23
24
|
sumOrFiltersScores?: boolean;
|
|
24
25
|
/**
|
|
25
|
-
* Restricts a search to a subset of your searchable attributes.
|
|
26
|
+
* Restricts a search to a subset of your searchable attributes. Attribute names are case-sensitive.
|
|
26
27
|
*/
|
|
27
28
|
restrictSearchableAttributes?: string[];
|
|
28
29
|
/**
|
|
@@ -64,13 +65,13 @@ export type BaseSearchParamsWithoutQuery = {
|
|
|
64
65
|
*/
|
|
65
66
|
insideBoundingBox?: number[][];
|
|
66
67
|
/**
|
|
67
|
-
* Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored
|
|
68
|
+
* Coordinates of a polygon in which to search. Polygons are defined by 3 to 10,000 points. Each point is represented by its latitude and longitude. Provide multiple polygons as nested arrays. For more information, see [filtering inside polygons](https://www.algolia.com/doc/guides/managing-results/refine-results/geolocation/#filtering-inside-rectangular-or-polygonal-areas). This parameter is ignored if you also specify `insideBoundingBox`.
|
|
68
69
|
*/
|
|
69
70
|
insidePolygon?: number[][];
|
|
70
71
|
/**
|
|
71
72
|
* ISO language codes that adjust settings that are useful for processing natural language queries (as opposed to keyword searches): - Sets `removeStopWords` and `ignorePlurals` to the list of provided languages. - Sets `removeWordsIfNoResults` to `allOptional`. - Adds a `natural_language` attribute to `ruleContexts` and `analyticsTags`.
|
|
72
73
|
*/
|
|
73
|
-
naturalLanguages?:
|
|
74
|
+
naturalLanguages?: SupportedLanguage[];
|
|
74
75
|
/**
|
|
75
76
|
* Assigns a rule context to the search query. [Rule contexts](https://www.algolia.com/doc/guides/managing-results/rules/rules-overview/how-to/customize-search-results-by-platform/#whats-a-context) are strings that you can use to trigger matching rules.
|
|
76
77
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,
|
|
1
|
+
{"version":3,"file":"baseSearchParamsWithoutQuery.d.ts","sourceRoot":"","sources":["../../../../client-search/model/baseSearchParamsWithoutQuery.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE/C,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC,UAAU,CAAC,EAAE,UAAU,CAAC;IAExB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,4BAA4B,CAAC,EAAE,MAAM,EAAE,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B,YAAY,CAAC,EAAE,YAAY,CAAC;IAE5B,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE/B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAE3B;;OAEG;IACH,gBAAgB,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAEvC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IAExB;;OAEG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IAEzB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,EAAE,CAAC;IAEzB;;OAEG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB,CAAC"}
|
|
@@ -20,7 +20,7 @@ export type DeleteByParams = {
|
|
|
20
20
|
*/
|
|
21
21
|
insideBoundingBox?: number[][];
|
|
22
22
|
/**
|
|
23
|
-
* 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
|
|
23
|
+
* 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`.
|
|
24
24
|
*/
|
|
25
25
|
insidePolygon?: number[][];
|
|
26
26
|
};
|
|
@@ -14,7 +14,7 @@ import type { SupportedLanguage } from './supportedLanguage';
|
|
|
14
14
|
import type { TypoTolerance } from './typoTolerance';
|
|
15
15
|
export type IndexSettingsAsSearchParams = {
|
|
16
16
|
/**
|
|
17
|
-
* Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
|
17
|
+
* Attributes to include in the API response. To reduce the size of your response, you can retrieve only some of the attributes. Attribute names are case-sensitive. - `*` retrieves all attributes, except attributes included in the `customRanking` and `unretrievableAttributes` settings. - To retrieve all attributes except a specific one, prefix the attribute with a dash and combine it with the `*`: `[\"*\", \"-ATTRIBUTE\"]`. - The `objectID` attribute is always included.
|
|
18
18
|
*/
|
|
19
19
|
attributesToRetrieve?: string[];
|
|
20
20
|
/**
|
|
@@ -22,7 +22,7 @@ export type IndexSettingsAsSearchParams = {
|
|
|
22
22
|
*/
|
|
23
23
|
ranking?: string[];
|
|
24
24
|
/**
|
|
25
|
-
* Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **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. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
|
|
25
|
+
* Attributes to use as [custom ranking](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/). Attribute names are case-sensitive. The custom ranking attributes decide which items are shown first if the other ranking criteria are equal. Records with missing values for your selected custom ranking attributes are always sorted last. Boolean attributes are sorted based on their alphabetical order. **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. If you use two or more custom ranking attributes, [reduce the precision](https://www.algolia.com/doc/guides/managing-results/must-do/custom-ranking/how-to/controlling-custom-ranking-metrics-precision/) of your first attributes, or the other attributes will never be applied.
|
|
26
26
|
*/
|
|
27
27
|
customRanking?: string[];
|
|
28
28
|
/**
|
|
@@ -30,11 +30,11 @@ export type IndexSettingsAsSearchParams = {
|
|
|
30
30
|
*/
|
|
31
31
|
relevancyStrictness?: number;
|
|
32
32
|
/**
|
|
33
|
-
* Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
|
|
33
|
+
* Attributes to highlight. By default, all searchable attributes are highlighted. Use `*` to highlight all attributes or use an empty array `[]` to turn off highlighting. Attribute names are case-sensitive. With highlighting, strings that match the search query are surrounded by HTML tags defined by `highlightPreTag` and `highlightPostTag`. You can use this to visually highlight matching parts of a search query in your UI. For more information, see [Highlighting and snippeting](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/highlighting-snippeting/js/).
|
|
34
34
|
*/
|
|
35
35
|
attributesToHighlight?: string[];
|
|
36
36
|
/**
|
|
37
|
-
* Attributes for which to enable snippets. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
|
|
37
|
+
* Attributes for which to enable snippets. Attribute names are case-sensitive. Snippets provide additional context to matched words. If you enable snippets, they include 10 words, including the matched word. The matched word will also be wrapped by HTML tags for highlighting. You can adjust the number of words with the following notation: `ATTRIBUTE:NUMBER`, where `NUMBER` is the number of words to be extracted.
|
|
38
38
|
*/
|
|
39
39
|
attributesToSnippet?: string[];
|
|
40
40
|
/**
|
|
@@ -71,7 +71,7 @@ export type IndexSettingsAsSearchParams = {
|
|
|
71
71
|
*/
|
|
72
72
|
allowTyposOnNumericTokens?: boolean;
|
|
73
73
|
/**
|
|
74
|
-
* Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
74
|
+
* Attributes for which you want to turn off [typo tolerance](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/). Attribute names are case-sensitive. Returning only exact matches can help when: - [Searching in hyphenated attributes](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/typo-tolerance/how-to/how-to-search-in-hyphenated-attributes/). - Reducing the number of matches when you have too many. This can happen with attributes that are long blocks of text, such as product descriptions. Consider alternatives such as `disableTypoToleranceOnWords` or adding synonyms if your attributes have intentional unusual spellings that might look like typos.
|
|
75
75
|
*/
|
|
76
76
|
disableTypoToleranceOnAttributes?: string[];
|
|
77
77
|
ignorePlurals?: IgnorePlurals;
|
|
@@ -109,7 +109,7 @@ export type IndexSettingsAsSearchParams = {
|
|
|
109
109
|
*/
|
|
110
110
|
optionalWords?: string[];
|
|
111
111
|
/**
|
|
112
|
-
* Searchable attributes for which you want to [turn off 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). This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
|
|
112
|
+
* Searchable attributes for which you want to [turn off 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). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelyhood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
|
|
113
113
|
*/
|
|
114
114
|
disableExactOnAttributes?: string[];
|
|
115
115
|
exactOnSingleWordQuery?: ExactOnSingleWordQuery;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { MixedSearchFilters } from './mixedSearchFilters';
|
|
2
2
|
/**
|
|
3
|
-
* Restrict [Dynamic Re-
|
|
3
|
+
* Restrict [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/) to records that match these filters.
|
|
4
4
|
*/
|
|
5
5
|
export type ReRankingApplyFilter = MixedSearchFilters[] | string;
|
|
6
6
|
//# sourceMappingURL=reRankingApplyFilter.d.ts.map
|