File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed
packages/recommend/src/types Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change @@ -2,11 +2,40 @@ import { RecommendModel } from './RecommendModel';
2
2
import { RecommendSearchOptions } from './RecommendSearchOptions' ;
3
3
4
4
export type RecommendationsQuery = {
5
+ /**
6
+ * The name of the target index.
7
+ */
5
8
readonly indexName : string ;
9
+
10
+ /**
11
+ * The name of the Recommendation model to use.
12
+ */
6
13
readonly model : RecommendModel ;
14
+
15
+ /**
16
+ * The `objectID` of the item to get recommendations for.
17
+ */
7
18
readonly objectID : string ;
19
+
20
+ /**
21
+ * Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
22
+ */
8
23
readonly threshold ?: number ;
24
+
25
+ /**
26
+ * How many recommendations to retrieve.
27
+ */
9
28
readonly maxRecommendations ?: number ;
29
+
30
+ /**
31
+ * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
32
+ */
10
33
readonly queryParameters ?: RecommendSearchOptions ;
34
+
35
+ /**
36
+ * List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
37
+ *
38
+ * Additional filters to use as fallback when there aren’t enough recommendations.
39
+ */
11
40
readonly fallbackParameters ?: RecommendSearchOptions ;
12
41
} ;
You can’t perform that action at this time.
0 commit comments