@algolia/client-search 4.14.3 → 4.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client-search.d.ts +45 -0
- package/package.json +4 -4
package/dist/client-search.d.ts
CHANGED
|
@@ -1102,6 +1102,34 @@ export declare type RankingInfo = {
|
|
|
1102
1102
|
readonly promotedByReRanking?: boolean;
|
|
1103
1103
|
};
|
|
1104
1104
|
|
|
1105
|
+
export declare type RedirectRuleIndexMetadata = {
|
|
1106
|
+
/**
|
|
1107
|
+
* Source index for the redirect rule
|
|
1108
|
+
*/
|
|
1109
|
+
readonly source: string;
|
|
1110
|
+
/**
|
|
1111
|
+
* Destination index for the redirect rule
|
|
1112
|
+
*/
|
|
1113
|
+
readonly dest: string;
|
|
1114
|
+
/**
|
|
1115
|
+
* Reason for the redirect rule
|
|
1116
|
+
*/
|
|
1117
|
+
readonly reason: string;
|
|
1118
|
+
/**
|
|
1119
|
+
* Status for the redirect rule
|
|
1120
|
+
*/
|
|
1121
|
+
readonly succeed: boolean;
|
|
1122
|
+
/**
|
|
1123
|
+
* Data for the redirect rule
|
|
1124
|
+
*/
|
|
1125
|
+
readonly data: {
|
|
1126
|
+
/**
|
|
1127
|
+
* Rule objectId
|
|
1128
|
+
*/
|
|
1129
|
+
readonly ruleObjectID: string;
|
|
1130
|
+
};
|
|
1131
|
+
};
|
|
1132
|
+
|
|
1105
1133
|
export declare const removeUserID: (base: SearchClient) => (userID: string, requestOptions?: RequestOptions | undefined) => Readonly<Promise<RemoveUserIDResponse>>;
|
|
1106
1134
|
|
|
1107
1135
|
export declare type RemoveUserIDResponse = {
|
|
@@ -1879,6 +1907,12 @@ export declare type SearchResponse<TObject = {}> = {
|
|
|
1879
1907
|
* as a JSON object with one field per parameter.
|
|
1880
1908
|
*/
|
|
1881
1909
|
params?: Record<string, any>;
|
|
1910
|
+
/**
|
|
1911
|
+
* This parameter is for internal use only.
|
|
1912
|
+
*/
|
|
1913
|
+
redirect?: {
|
|
1914
|
+
index?: RedirectRuleIndexMetadata[];
|
|
1915
|
+
};
|
|
1882
1916
|
};
|
|
1883
1917
|
/**
|
|
1884
1918
|
* The relevancy threshold applied to search in a virtual index.
|
|
@@ -2271,6 +2305,17 @@ export declare type Settings = {
|
|
|
2271
2305
|
* less relevant results.
|
|
2272
2306
|
*/
|
|
2273
2307
|
readonly relevancyStrictness?: number;
|
|
2308
|
+
/**
|
|
2309
|
+
* The search mode that the index will use to query for results.
|
|
2310
|
+
*/
|
|
2311
|
+
readonly mode?: 'neuralSearch' | 'keywordSearch';
|
|
2312
|
+
/**
|
|
2313
|
+
* The settings relevant for configuration of the semantic search engine.
|
|
2314
|
+
* These settings are only used when the mode is set to 'neuralSearch'.
|
|
2315
|
+
*/
|
|
2316
|
+
readonly semanticSearch?: {
|
|
2317
|
+
readonly eventSources?: readonly string[];
|
|
2318
|
+
};
|
|
2274
2319
|
/**
|
|
2275
2320
|
* Content defining how the search interface should be rendered.
|
|
2276
2321
|
* This is set via the settings for a default value and can be overridden via rules
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@algolia/client-search",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.16.0",
|
|
4
4
|
"private": false,
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -16,8 +16,8 @@
|
|
|
16
16
|
"dist"
|
|
17
17
|
],
|
|
18
18
|
"dependencies": {
|
|
19
|
-
"@algolia/client-common": "4.
|
|
20
|
-
"@algolia/requester-common": "4.
|
|
21
|
-
"@algolia/transporter": "4.
|
|
19
|
+
"@algolia/client-common": "4.16.0",
|
|
20
|
+
"@algolia/requester-common": "4.16.0",
|
|
21
|
+
"@algolia/transporter": "4.16.0"
|
|
22
22
|
}
|
|
23
23
|
}
|