@aws-sdk/client-personalize-runtime 3.529.1 → 3.535.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-types/PersonalizeRuntime.d.ts +3 -1
- package/dist-types/PersonalizeRuntimeClient.d.ts +1 -1
- package/dist-types/commands/GetActionRecommendationsCommand.d.ts +2 -1
- package/dist-types/commands/GetPersonalizedRankingCommand.d.ts +2 -1
- package/dist-types/commands/GetRecommendationsCommand.d.ts +2 -1
- package/dist-types/models/models_0.d.ts +43 -43
- package/dist-types/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/runtimeConfig.d.ts +2 -2
- package/dist-types/runtimeConfig.native.d.ts +2 -2
- package/dist-types/runtimeConfig.shared.d.ts +2 -2
- package/dist-types/ts3.4/PersonalizeRuntime.d.ts +2 -0
- package/dist-types/ts3.4/commands/GetActionRecommendationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetPersonalizedRankingCommand.d.ts +9 -0
- package/dist-types/ts3.4/commands/GetRecommendationsCommand.d.ts +9 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -2
- package/dist-types/ts3.4/runtimeConfig.shared.d.ts +2 -2
- package/package.json +40 -40
|
@@ -7,6 +7,7 @@ export interface PersonalizeRuntime {
|
|
|
7
7
|
/**
|
|
8
8
|
* @see {@link GetActionRecommendationsCommand}
|
|
9
9
|
*/
|
|
10
|
+
getActionRecommendations(): Promise<GetActionRecommendationsCommandOutput>;
|
|
10
11
|
getActionRecommendations(args: GetActionRecommendationsCommandInput, options?: __HttpHandlerOptions): Promise<GetActionRecommendationsCommandOutput>;
|
|
11
12
|
getActionRecommendations(args: GetActionRecommendationsCommandInput, cb: (err: any, data?: GetActionRecommendationsCommandOutput) => void): void;
|
|
12
13
|
getActionRecommendations(args: GetActionRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetActionRecommendationsCommandOutput) => void): void;
|
|
@@ -19,13 +20,14 @@ export interface PersonalizeRuntime {
|
|
|
19
20
|
/**
|
|
20
21
|
* @see {@link GetRecommendationsCommand}
|
|
21
22
|
*/
|
|
23
|
+
getRecommendations(): Promise<GetRecommendationsCommandOutput>;
|
|
22
24
|
getRecommendations(args: GetRecommendationsCommandInput, options?: __HttpHandlerOptions): Promise<GetRecommendationsCommandOutput>;
|
|
23
25
|
getRecommendations(args: GetRecommendationsCommandInput, cb: (err: any, data?: GetRecommendationsCommandOutput) => void): void;
|
|
24
26
|
getRecommendations(args: GetRecommendationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecommendationsCommandOutput) => void): void;
|
|
25
27
|
}
|
|
26
28
|
/**
|
|
27
|
-
* @public
|
|
28
29
|
* <p></p>
|
|
30
|
+
* @public
|
|
29
31
|
*/
|
|
30
32
|
export declare class PersonalizeRuntime extends PersonalizeRuntimeClient implements PersonalizeRuntime {
|
|
31
33
|
}
|
|
@@ -154,8 +154,8 @@ export type PersonalizeRuntimeClientResolvedConfigType = __SmithyResolvedConfigu
|
|
|
154
154
|
export interface PersonalizeRuntimeClientResolvedConfig extends PersonalizeRuntimeClientResolvedConfigType {
|
|
155
155
|
}
|
|
156
156
|
/**
|
|
157
|
-
* @public
|
|
158
157
|
* <p></p>
|
|
158
|
+
* @public
|
|
159
159
|
*/
|
|
160
160
|
export declare class PersonalizeRuntimeClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, PersonalizeRuntimeClientResolvedConfig> {
|
|
161
161
|
/**
|
|
@@ -22,10 +22,10 @@ export interface GetActionRecommendationsCommandOutput extends GetActionRecommen
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetActionRecommendationsCommand_base: {
|
|
24
24
|
new (input: GetActionRecommendationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetActionRecommendationsCommandInput, GetActionRecommendationsCommandOutput, PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [GetActionRecommendationsCommandInput]): import("@smithy/smithy-client").CommandImpl<GetActionRecommendationsCommandInput, GetActionRecommendationsCommandOutput, PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns a list of recommended actions in sorted in descending order by prediction score.
|
|
30
30
|
* Use the <code>GetActionRecommendations</code> API if you have a custom
|
|
31
31
|
* campaign that deploys a solution version trained with a PERSONALIZED_ACTIONS recipe.
|
|
@@ -76,6 +76,7 @@ declare const GetActionRecommendationsCommand_base: {
|
|
|
76
76
|
* @throws {@link PersonalizeRuntimeServiceException}
|
|
77
77
|
* <p>Base exception class for all service exceptions from PersonalizeRuntime service.</p>
|
|
78
78
|
*
|
|
79
|
+
* @public
|
|
79
80
|
*/
|
|
80
81
|
export declare class GetActionRecommendationsCommand extends GetActionRecommendationsCommand_base {
|
|
81
82
|
}
|
|
@@ -22,10 +22,10 @@ export interface GetPersonalizedRankingCommandOutput extends GetPersonalizedRank
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetPersonalizedRankingCommand_base: {
|
|
24
24
|
new (input: GetPersonalizedRankingCommandInput): import("@smithy/smithy-client").CommandImpl<GetPersonalizedRankingCommandInput, GetPersonalizedRankingCommandOutput, PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (__0_0: GetPersonalizedRankingCommandInput): import("@smithy/smithy-client").CommandImpl<GetPersonalizedRankingCommandInput, GetPersonalizedRankingCommandOutput, PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Re-ranks a list of recommended items for the given user. The first item in the list is
|
|
30
30
|
* deemed the most likely item to be of interest to the user.</p>
|
|
31
31
|
* <note>
|
|
@@ -90,6 +90,7 @@ declare const GetPersonalizedRankingCommand_base: {
|
|
|
90
90
|
* @throws {@link PersonalizeRuntimeServiceException}
|
|
91
91
|
* <p>Base exception class for all service exceptions from PersonalizeRuntime service.</p>
|
|
92
92
|
*
|
|
93
|
+
* @public
|
|
93
94
|
*/
|
|
94
95
|
export declare class GetPersonalizedRankingCommand extends GetPersonalizedRankingCommand_base {
|
|
95
96
|
}
|
|
@@ -22,10 +22,10 @@ export interface GetRecommendationsCommandOutput extends GetRecommendationsRespo
|
|
|
22
22
|
}
|
|
23
23
|
declare const GetRecommendationsCommand_base: {
|
|
24
24
|
new (input: GetRecommendationsCommandInput): import("@smithy/smithy-client").CommandImpl<GetRecommendationsCommandInput, GetRecommendationsCommandOutput, PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
|
+
new (...[input]: [] | [GetRecommendationsCommandInput]): import("@smithy/smithy-client").CommandImpl<GetRecommendationsCommandInput, GetRecommendationsCommandOutput, PersonalizeRuntimeClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
25
26
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
26
27
|
};
|
|
27
28
|
/**
|
|
28
|
-
* @public
|
|
29
29
|
* <p>Returns a list of recommended items. For campaigns, the campaign's Amazon Resource Name (ARN) is required and the required user and item input depends on the recipe type used to
|
|
30
30
|
* create the solution backing the campaign as follows:</p>
|
|
31
31
|
* <ul>
|
|
@@ -112,6 +112,7 @@ declare const GetRecommendationsCommand_base: {
|
|
|
112
112
|
* @throws {@link PersonalizeRuntimeServiceException}
|
|
113
113
|
* <p>Base exception class for all service exceptions from PersonalizeRuntime service.</p>
|
|
114
114
|
*
|
|
115
|
+
* @public
|
|
115
116
|
*/
|
|
116
117
|
export declare class GetRecommendationsCommand extends GetRecommendationsCommand_base {
|
|
117
118
|
}
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
|
|
2
2
|
import { PersonalizeRuntimeServiceException as __BaseException } from "./PersonalizeRuntimeServiceException";
|
|
3
3
|
/**
|
|
4
|
-
* @public
|
|
5
4
|
* <p>An object that identifies an action.</p>
|
|
6
5
|
* <p>The API returns a list of
|
|
7
6
|
* <code>PredictedAction</code>s.</p>
|
|
7
|
+
* @public
|
|
8
8
|
*/
|
|
9
9
|
export interface PredictedAction {
|
|
10
10
|
/**
|
|
11
|
-
* @public
|
|
12
11
|
* <p>The ID of the recommended action.</p>
|
|
12
|
+
* @public
|
|
13
13
|
*/
|
|
14
14
|
actionId?: string;
|
|
15
15
|
/**
|
|
16
|
-
* @public
|
|
17
16
|
* <p>The score of the recommended action. For information about action scores, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html">How action recommendation scoring works</a>.</p>
|
|
17
|
+
* @public
|
|
18
18
|
*/
|
|
19
19
|
score?: number;
|
|
20
20
|
}
|
|
@@ -23,29 +23,28 @@ export interface PredictedAction {
|
|
|
23
23
|
*/
|
|
24
24
|
export interface GetActionRecommendationsRequest {
|
|
25
25
|
/**
|
|
26
|
-
* @public
|
|
27
26
|
* <p>The Amazon Resource Name (ARN) of the campaign to use for getting action recommendations. This campaign must deploy a solution version trained with a PERSONALIZED_ACTIONS recipe.</p>
|
|
27
|
+
* @public
|
|
28
28
|
*/
|
|
29
29
|
campaignArn?: string;
|
|
30
30
|
/**
|
|
31
|
-
* @public
|
|
32
31
|
* <p>The user ID of the user to provide action recommendations for.</p>
|
|
32
|
+
* @public
|
|
33
33
|
*/
|
|
34
34
|
userId?: string;
|
|
35
35
|
/**
|
|
36
|
-
* @public
|
|
37
36
|
* <p>The number of results to return. The default is 5. The maximum is 100.</p>
|
|
37
|
+
* @public
|
|
38
38
|
*/
|
|
39
39
|
numResults?: number;
|
|
40
40
|
/**
|
|
41
|
-
* @public
|
|
42
41
|
* <p>The ARN of the filter to apply to the returned recommendations. For more information, see
|
|
43
42
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
|
|
44
43
|
* <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
|
|
44
|
+
* @public
|
|
45
45
|
*/
|
|
46
46
|
filterArn?: string;
|
|
47
47
|
/**
|
|
48
|
-
* @public
|
|
49
48
|
* <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
|
|
50
49
|
* as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
|
|
51
50
|
* </p>
|
|
@@ -56,6 +55,7 @@ export interface GetActionRecommendationsRequest {
|
|
|
56
55
|
* the expression to filter recommendations.</p>
|
|
57
56
|
* <p>For more information, see
|
|
58
57
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
|
|
58
|
+
* @public
|
|
59
59
|
*/
|
|
60
60
|
filterValues?: Record<string, string>;
|
|
61
61
|
}
|
|
@@ -64,21 +64,21 @@ export interface GetActionRecommendationsRequest {
|
|
|
64
64
|
*/
|
|
65
65
|
export interface GetActionRecommendationsResponse {
|
|
66
66
|
/**
|
|
67
|
-
* @public
|
|
68
67
|
* <p>A list of action recommendations sorted in descending order by prediction score. There can be a maximum of 100 actions
|
|
69
68
|
* in the list. For information about action scores, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/how-action-recommendation-scoring-works.html">How action recommendation scoring
|
|
70
69
|
* works</a>.</p>
|
|
70
|
+
* @public
|
|
71
71
|
*/
|
|
72
72
|
actionList?: PredictedAction[];
|
|
73
73
|
/**
|
|
74
|
-
* @public
|
|
75
74
|
* <p>The ID of the recommendation.</p>
|
|
75
|
+
* @public
|
|
76
76
|
*/
|
|
77
77
|
recommendationId?: string;
|
|
78
78
|
}
|
|
79
79
|
/**
|
|
80
|
-
* @public
|
|
81
80
|
* <p>Provide a valid value for the field or parameter.</p>
|
|
81
|
+
* @public
|
|
82
82
|
*/
|
|
83
83
|
export declare class InvalidInputException extends __BaseException {
|
|
84
84
|
readonly name: "InvalidInputException";
|
|
@@ -89,8 +89,8 @@ export declare class InvalidInputException extends __BaseException {
|
|
|
89
89
|
constructor(opts: __ExceptionOptionType<InvalidInputException, __BaseException>);
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
* @public
|
|
93
92
|
* <p>The specified resource does not exist.</p>
|
|
93
|
+
* @public
|
|
94
94
|
*/
|
|
95
95
|
export declare class ResourceNotFoundException extends __BaseException {
|
|
96
96
|
readonly name: "ResourceNotFoundException";
|
|
@@ -105,39 +105,38 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
105
105
|
*/
|
|
106
106
|
export interface GetPersonalizedRankingRequest {
|
|
107
107
|
/**
|
|
108
|
-
* @public
|
|
109
108
|
* <p>The Amazon Resource Name (ARN) of the campaign to use for generating the personalized
|
|
110
109
|
* ranking.</p>
|
|
110
|
+
* @public
|
|
111
111
|
*/
|
|
112
112
|
campaignArn: string | undefined;
|
|
113
113
|
/**
|
|
114
|
-
* @public
|
|
115
114
|
* <p>A list of items (by <code>itemId</code>) to rank. If an item was not included in the training dataset,
|
|
116
115
|
* the item is appended to the end of the reranked list. If you are including
|
|
117
116
|
* metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.</p>
|
|
117
|
+
* @public
|
|
118
118
|
*/
|
|
119
119
|
inputList: string[] | undefined;
|
|
120
120
|
/**
|
|
121
|
-
* @public
|
|
122
121
|
* <p>The user for which you want the campaign to provide a personalized ranking.</p>
|
|
122
|
+
* @public
|
|
123
123
|
*/
|
|
124
124
|
userId: string | undefined;
|
|
125
125
|
/**
|
|
126
|
-
* @public
|
|
127
126
|
* <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
|
|
128
127
|
* any interaction information that might be relevant when getting a user's recommendations, such
|
|
129
128
|
* as the user's current location or device type.</p>
|
|
129
|
+
* @public
|
|
130
130
|
*/
|
|
131
131
|
context?: Record<string, string>;
|
|
132
132
|
/**
|
|
133
|
-
* @public
|
|
134
133
|
* <p>The Amazon Resource Name (ARN) of a filter you created to include items or exclude items from recommendations for a given user.
|
|
135
134
|
* For more information, see
|
|
136
135
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
|
|
136
|
+
* @public
|
|
137
137
|
*/
|
|
138
138
|
filterArn?: string;
|
|
139
139
|
/**
|
|
140
|
-
* @public
|
|
141
140
|
* <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
|
|
142
141
|
* as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
|
|
143
142
|
* </p>
|
|
@@ -148,10 +147,10 @@ export interface GetPersonalizedRankingRequest {
|
|
|
148
147
|
* the expression to filter recommendations.</p>
|
|
149
148
|
* <p>For more information, see
|
|
150
149
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
|
|
150
|
+
* @public
|
|
151
151
|
*/
|
|
152
152
|
filterValues?: Record<string, string>;
|
|
153
153
|
/**
|
|
154
|
-
* @public
|
|
155
154
|
* <p>If you enabled metadata in recommendations when you created or updated the campaign, specify metadata columns from your Items dataset to include
|
|
156
155
|
* in the personalized ranking.
|
|
157
156
|
* The map key is <code>ITEMS</code> and the value is a list of column names from your Items dataset.
|
|
@@ -159,35 +158,36 @@ export interface GetPersonalizedRankingRequest {
|
|
|
159
158
|
* <p>
|
|
160
159
|
* For information about enabling metadata for a campaign, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata">Enabling metadata in recommendations for a campaign</a>.
|
|
161
160
|
* </p>
|
|
161
|
+
* @public
|
|
162
162
|
*/
|
|
163
163
|
metadataColumns?: Record<string, string[]>;
|
|
164
164
|
}
|
|
165
165
|
/**
|
|
166
|
-
* @public
|
|
167
166
|
* <p>An object that identifies an item.</p>
|
|
168
167
|
* <p>The and APIs return a list of
|
|
169
168
|
* <code>PredictedItem</code>s.</p>
|
|
169
|
+
* @public
|
|
170
170
|
*/
|
|
171
171
|
export interface PredictedItem {
|
|
172
172
|
/**
|
|
173
|
-
* @public
|
|
174
173
|
* <p>The recommended item ID.</p>
|
|
174
|
+
* @public
|
|
175
175
|
*/
|
|
176
176
|
itemId?: string;
|
|
177
177
|
/**
|
|
178
|
-
* @public
|
|
179
178
|
* <p>A numeric representation of the model's certainty that the item will be the next user
|
|
180
179
|
* selection. For more information on scoring logic, see <a>how-scores-work</a>.</p>
|
|
180
|
+
* @public
|
|
181
181
|
*/
|
|
182
182
|
score?: number;
|
|
183
183
|
/**
|
|
184
|
-
* @public
|
|
185
184
|
* <p>The name of the promotion that included the predicted item.</p>
|
|
185
|
+
* @public
|
|
186
186
|
*/
|
|
187
187
|
promotionName?: string;
|
|
188
188
|
/**
|
|
189
|
-
* @public
|
|
190
189
|
* <p>Metadata about the item from your Items dataset.</p>
|
|
190
|
+
* @public
|
|
191
191
|
*/
|
|
192
192
|
metadata?: Record<string, string>;
|
|
193
193
|
}
|
|
@@ -196,39 +196,38 @@ export interface PredictedItem {
|
|
|
196
196
|
*/
|
|
197
197
|
export interface GetPersonalizedRankingResponse {
|
|
198
198
|
/**
|
|
199
|
-
* @public
|
|
200
199
|
* <p>A list of items in order of most likely interest to the user. The maximum is 500.</p>
|
|
200
|
+
* @public
|
|
201
201
|
*/
|
|
202
202
|
personalizedRanking?: PredictedItem[];
|
|
203
203
|
/**
|
|
204
|
-
* @public
|
|
205
204
|
* <p>The ID of the recommendation.</p>
|
|
205
|
+
* @public
|
|
206
206
|
*/
|
|
207
207
|
recommendationId?: string;
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
|
-
* @public
|
|
211
210
|
* <p>Contains information on a promotion. A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>
|
|
211
|
+
* @public
|
|
212
212
|
*/
|
|
213
213
|
export interface Promotion {
|
|
214
214
|
/**
|
|
215
|
-
* @public
|
|
216
215
|
* <p>The name of the promotion.</p>
|
|
216
|
+
* @public
|
|
217
217
|
*/
|
|
218
218
|
name?: string;
|
|
219
219
|
/**
|
|
220
|
-
* @public
|
|
221
220
|
* <p>The percentage of recommended items to apply the promotion to.</p>
|
|
221
|
+
* @public
|
|
222
222
|
*/
|
|
223
223
|
percentPromotedItems?: number;
|
|
224
224
|
/**
|
|
225
|
-
* @public
|
|
226
225
|
* <p>The Amazon Resource Name (ARN) of the filter used by the promotion. This filter defines the criteria for promoted items. For more information, see
|
|
227
226
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/promoting-items.html#promotion-filters">Promotion filters</a>.</p>
|
|
227
|
+
* @public
|
|
228
228
|
*/
|
|
229
229
|
filterArn?: string;
|
|
230
230
|
/**
|
|
231
|
-
* @public
|
|
232
231
|
* <p>The values to use when promoting items.
|
|
233
232
|
* For each placeholder parameter in your promotion's filter expression, provide the parameter name (in matching case) as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
|
|
234
233
|
* </p>
|
|
@@ -239,6 +238,7 @@ export interface Promotion {
|
|
|
239
238
|
* the expression to filter recommendations.</p>
|
|
240
239
|
* <p>For more information on creating filters, see
|
|
241
240
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
|
|
241
|
+
* @public
|
|
242
242
|
*/
|
|
243
243
|
filterValues?: Record<string, string>;
|
|
244
244
|
}
|
|
@@ -247,44 +247,43 @@ export interface Promotion {
|
|
|
247
247
|
*/
|
|
248
248
|
export interface GetRecommendationsRequest {
|
|
249
249
|
/**
|
|
250
|
-
* @public
|
|
251
250
|
* <p>The Amazon Resource Name (ARN) of the campaign to use for getting recommendations.</p>
|
|
251
|
+
* @public
|
|
252
252
|
*/
|
|
253
253
|
campaignArn?: string;
|
|
254
254
|
/**
|
|
255
|
-
* @public
|
|
256
255
|
* <p>The item ID to provide recommendations for.</p>
|
|
257
256
|
* <p>Required for <code>RELATED_ITEMS</code> recipe type.</p>
|
|
257
|
+
* @public
|
|
258
258
|
*/
|
|
259
259
|
itemId?: string;
|
|
260
260
|
/**
|
|
261
|
-
* @public
|
|
262
261
|
* <p>The user ID to provide recommendations for.</p>
|
|
263
262
|
* <p>Required for <code>USER_PERSONALIZATION</code> recipe type.</p>
|
|
263
|
+
* @public
|
|
264
264
|
*/
|
|
265
265
|
userId?: string;
|
|
266
266
|
/**
|
|
267
|
-
* @public
|
|
268
267
|
* <p>The number of results to return. The default is 25. If you are including
|
|
269
268
|
* metadata in recommendations, the maximum is 50. Otherwise, the maximum is 500.</p>
|
|
269
|
+
* @public
|
|
270
270
|
*/
|
|
271
271
|
numResults?: number;
|
|
272
272
|
/**
|
|
273
|
-
* @public
|
|
274
273
|
* <p>The contextual metadata to use when getting recommendations. Contextual metadata includes
|
|
275
274
|
* any interaction information that might be relevant when getting a user's recommendations, such
|
|
276
275
|
* as the user's current location or device type.</p>
|
|
276
|
+
* @public
|
|
277
277
|
*/
|
|
278
278
|
context?: Record<string, string>;
|
|
279
279
|
/**
|
|
280
|
-
* @public
|
|
281
280
|
* <p>The ARN of the filter to apply to the returned recommendations. For more information, see
|
|
282
281
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering Recommendations</a>.</p>
|
|
283
282
|
* <p>When using this parameter, be sure the filter resource is <code>ACTIVE</code>.</p>
|
|
283
|
+
* @public
|
|
284
284
|
*/
|
|
285
285
|
filterArn?: string;
|
|
286
286
|
/**
|
|
287
|
-
* @public
|
|
288
287
|
* <p>The values to use when filtering recommendations. For each placeholder parameter in your filter expression, provide the parameter name (in matching case)
|
|
289
288
|
* as a key and the filter value(s) as the corresponding value. Separate multiple values for one parameter with a comma.
|
|
290
289
|
* </p>
|
|
@@ -295,22 +294,22 @@ export interface GetRecommendationsRequest {
|
|
|
295
294
|
* the expression to filter recommendations.</p>
|
|
296
295
|
* <p>For more information, see
|
|
297
296
|
* <a href="https://docs.aws.amazon.com/personalize/latest/dg/filter.html">Filtering recommendations and user segments</a>.</p>
|
|
297
|
+
* @public
|
|
298
298
|
*/
|
|
299
299
|
filterValues?: Record<string, string>;
|
|
300
300
|
/**
|
|
301
|
-
* @public
|
|
302
301
|
* <p>The Amazon Resource Name (ARN) of the recommender to use to get recommendations. Provide a recommender ARN if you
|
|
303
302
|
* created a Domain dataset group with a recommender for a domain use case.</p>
|
|
303
|
+
* @public
|
|
304
304
|
*/
|
|
305
305
|
recommenderArn?: string;
|
|
306
306
|
/**
|
|
307
|
-
* @public
|
|
308
307
|
* <p>The promotions to apply to the recommendation request.
|
|
309
308
|
* A promotion defines additional business rules that apply to a configurable subset of recommended items.</p>
|
|
309
|
+
* @public
|
|
310
310
|
*/
|
|
311
311
|
promotions?: Promotion[];
|
|
312
312
|
/**
|
|
313
|
-
* @public
|
|
314
313
|
* <p>If you enabled metadata in recommendations when you created or updated the campaign or recommender, specify the metadata columns from your Items dataset to include in item recommendations.
|
|
315
314
|
* The map key is <code>ITEMS</code> and the value is a list of column names from your Items dataset.
|
|
316
315
|
* The maximum number of columns you can provide is 10.</p>
|
|
@@ -318,6 +317,7 @@ export interface GetRecommendationsRequest {
|
|
|
318
317
|
* For information about enabling metadata for a campaign, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/campaigns.html#create-campaign-return-metadata">Enabling metadata in recommendations for a campaign</a>.
|
|
319
318
|
* For information about enabling metadata for a recommender, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/creating-recommenders.html#create-recommender-return-metadata">Enabling metadata in recommendations for a recommender</a>.
|
|
320
319
|
* </p>
|
|
320
|
+
* @public
|
|
321
321
|
*/
|
|
322
322
|
metadataColumns?: Record<string, string[]>;
|
|
323
323
|
}
|
|
@@ -326,14 +326,14 @@ export interface GetRecommendationsRequest {
|
|
|
326
326
|
*/
|
|
327
327
|
export interface GetRecommendationsResponse {
|
|
328
328
|
/**
|
|
329
|
-
* @public
|
|
330
329
|
* <p>A list of recommendations sorted in descending order by prediction score. There can be a
|
|
331
330
|
* maximum of 500 items in the list.</p>
|
|
331
|
+
* @public
|
|
332
332
|
*/
|
|
333
333
|
itemList?: PredictedItem[];
|
|
334
334
|
/**
|
|
335
|
-
* @public
|
|
336
335
|
* <p>The ID of the recommendation.</p>
|
|
336
|
+
* @public
|
|
337
337
|
*/
|
|
338
338
|
recommendationId?: string;
|
|
339
339
|
}
|
|
@@ -20,9 +20,9 @@ export declare const getRuntimeConfig: (config: PersonalizeRuntimeClientConfig)
|
|
|
20
20
|
apiVersion: string;
|
|
21
21
|
urlParser: import("@smithy/types").UrlParser;
|
|
22
22
|
base64Decoder: import("@smithy/types").Decoder;
|
|
23
|
-
base64Encoder:
|
|
23
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
24
24
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
25
|
-
utf8Encoder:
|
|
25
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
26
26
|
disableHostPrefix: boolean;
|
|
27
27
|
serviceId: string;
|
|
28
28
|
logger: import("@smithy/types").Logger;
|
|
@@ -20,9 +20,9 @@ export declare const getRuntimeConfig: (config: PersonalizeRuntimeClientConfig)
|
|
|
20
20
|
apiVersion: string;
|
|
21
21
|
urlParser: import("@smithy/types").UrlParser;
|
|
22
22
|
base64Decoder: import("@smithy/types").Decoder;
|
|
23
|
-
base64Encoder:
|
|
23
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
24
24
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
25
|
-
utf8Encoder:
|
|
25
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
26
26
|
disableHostPrefix: boolean;
|
|
27
27
|
serviceId: string;
|
|
28
28
|
logger: import("@smithy/types").Logger;
|
|
@@ -11,9 +11,9 @@ export declare const getRuntimeConfig: (config: PersonalizeRuntimeClientConfig)
|
|
|
11
11
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
12
12
|
streamCollector: import("@smithy/types").StreamCollector;
|
|
13
13
|
base64Decoder: import("@smithy/types").Decoder;
|
|
14
|
-
base64Encoder:
|
|
14
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
15
15
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
16
|
-
utf8Encoder:
|
|
16
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
17
17
|
disableHostPrefix: boolean;
|
|
18
18
|
serviceId: string;
|
|
19
19
|
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
@@ -5,7 +5,7 @@ import { PersonalizeRuntimeClientConfig } from "./PersonalizeRuntimeClient";
|
|
|
5
5
|
export declare const getRuntimeConfig: (config: PersonalizeRuntimeClientConfig) => {
|
|
6
6
|
apiVersion: string;
|
|
7
7
|
base64Decoder: import("@smithy/types").Decoder;
|
|
8
|
-
base64Encoder:
|
|
8
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
9
9
|
disableHostPrefix: boolean;
|
|
10
10
|
endpointProvider: (endpointParams: import("./endpoint/EndpointParameters").EndpointParameters, context?: {
|
|
11
11
|
logger?: import("@smithy/types").Logger | undefined;
|
|
@@ -17,5 +17,5 @@ export declare const getRuntimeConfig: (config: PersonalizeRuntimeClientConfig)
|
|
|
17
17
|
serviceId: string;
|
|
18
18
|
urlParser: import("@smithy/types").UrlParser;
|
|
19
19
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
20
|
-
utf8Encoder:
|
|
20
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
21
21
|
};
|
|
@@ -13,6 +13,7 @@ import {
|
|
|
13
13
|
} from "./commands/GetRecommendationsCommand";
|
|
14
14
|
import { PersonalizeRuntimeClient } from "./PersonalizeRuntimeClient";
|
|
15
15
|
export interface PersonalizeRuntime {
|
|
16
|
+
getActionRecommendations(): Promise<GetActionRecommendationsCommandOutput>;
|
|
16
17
|
getActionRecommendations(
|
|
17
18
|
args: GetActionRecommendationsCommandInput,
|
|
18
19
|
options?: __HttpHandlerOptions
|
|
@@ -39,6 +40,7 @@ export interface PersonalizeRuntime {
|
|
|
39
40
|
options: __HttpHandlerOptions,
|
|
40
41
|
cb: (err: any, data?: GetPersonalizedRankingCommandOutput) => void
|
|
41
42
|
): void;
|
|
43
|
+
getRecommendations(): Promise<GetRecommendationsCommandOutput>;
|
|
42
44
|
getRecommendations(
|
|
43
45
|
args: GetRecommendationsCommandInput,
|
|
44
46
|
options?: __HttpHandlerOptions
|
|
@@ -25,6 +25,15 @@ declare const GetActionRecommendationsCommand_base: {
|
|
|
25
25
|
ServiceInputTypes,
|
|
26
26
|
ServiceOutputTypes
|
|
27
27
|
>;
|
|
28
|
+
new (
|
|
29
|
+
...[input]: [] | [GetActionRecommendationsCommandInput]
|
|
30
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
31
|
+
GetActionRecommendationsCommandInput,
|
|
32
|
+
GetActionRecommendationsCommandOutput,
|
|
33
|
+
PersonalizeRuntimeClientResolvedConfig,
|
|
34
|
+
ServiceInputTypes,
|
|
35
|
+
ServiceOutputTypes
|
|
36
|
+
>;
|
|
28
37
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
38
|
};
|
|
30
39
|
export declare class GetActionRecommendationsCommand extends GetActionRecommendationsCommand_base {}
|
|
@@ -25,6 +25,15 @@ declare const GetPersonalizedRankingCommand_base: {
|
|
|
25
25
|
ServiceInputTypes,
|
|
26
26
|
ServiceOutputTypes
|
|
27
27
|
>;
|
|
28
|
+
new (
|
|
29
|
+
__0_0: GetPersonalizedRankingCommandInput
|
|
30
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
31
|
+
GetPersonalizedRankingCommandInput,
|
|
32
|
+
GetPersonalizedRankingCommandOutput,
|
|
33
|
+
PersonalizeRuntimeClientResolvedConfig,
|
|
34
|
+
ServiceInputTypes,
|
|
35
|
+
ServiceOutputTypes
|
|
36
|
+
>;
|
|
28
37
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
38
|
};
|
|
30
39
|
export declare class GetPersonalizedRankingCommand extends GetPersonalizedRankingCommand_base {}
|
|
@@ -25,6 +25,15 @@ declare const GetRecommendationsCommand_base: {
|
|
|
25
25
|
ServiceInputTypes,
|
|
26
26
|
ServiceOutputTypes
|
|
27
27
|
>;
|
|
28
|
+
new (
|
|
29
|
+
...[input]: [] | [GetRecommendationsCommandInput]
|
|
30
|
+
): import("@smithy/smithy-client").CommandImpl<
|
|
31
|
+
GetRecommendationsCommandInput,
|
|
32
|
+
GetRecommendationsCommandOutput,
|
|
33
|
+
PersonalizeRuntimeClientResolvedConfig,
|
|
34
|
+
ServiceInputTypes,
|
|
35
|
+
ServiceOutputTypes
|
|
36
|
+
>;
|
|
28
37
|
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
29
38
|
};
|
|
30
39
|
export declare class GetRecommendationsCommand extends GetRecommendationsCommand_base {}
|
|
@@ -27,9 +27,9 @@ export declare const getRuntimeConfig: (
|
|
|
27
27
|
apiVersion: string;
|
|
28
28
|
urlParser: import("@smithy/types").UrlParser;
|
|
29
29
|
base64Decoder: import("@smithy/types").Decoder;
|
|
30
|
-
base64Encoder:
|
|
30
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
31
31
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
32
|
-
utf8Encoder:
|
|
32
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
33
33
|
disableHostPrefix: boolean;
|
|
34
34
|
serviceId: string;
|
|
35
35
|
logger: import("@smithy/types").Logger;
|
|
@@ -31,9 +31,9 @@ export declare const getRuntimeConfig: (
|
|
|
31
31
|
apiVersion: string;
|
|
32
32
|
urlParser: import("@smithy/types").UrlParser;
|
|
33
33
|
base64Decoder: import("@smithy/types").Decoder;
|
|
34
|
-
base64Encoder:
|
|
34
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
35
35
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
36
|
-
utf8Encoder:
|
|
36
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
37
37
|
disableHostPrefix: boolean;
|
|
38
38
|
serviceId: string;
|
|
39
39
|
logger: import("@smithy/types").Logger;
|
|
@@ -15,9 +15,9 @@ export declare const getRuntimeConfig: (
|
|
|
15
15
|
bodyLengthChecker: import("@smithy/types").BodyLengthCalculator;
|
|
16
16
|
streamCollector: import("@smithy/types").StreamCollector;
|
|
17
17
|
base64Decoder: import("@smithy/types").Decoder;
|
|
18
|
-
base64Encoder:
|
|
18
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
19
19
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
20
|
-
utf8Encoder:
|
|
20
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
21
21
|
disableHostPrefix: boolean;
|
|
22
22
|
serviceId: string;
|
|
23
23
|
useDualstackEndpoint: boolean | import("@smithy/types").Provider<boolean>;
|
|
@@ -4,7 +4,7 @@ export declare const getRuntimeConfig: (
|
|
|
4
4
|
) => {
|
|
5
5
|
apiVersion: string;
|
|
6
6
|
base64Decoder: import("@smithy/types").Decoder;
|
|
7
|
-
base64Encoder:
|
|
7
|
+
base64Encoder: (_input: string | Uint8Array) => string;
|
|
8
8
|
disableHostPrefix: boolean;
|
|
9
9
|
endpointProvider: (
|
|
10
10
|
endpointParams: import("./endpoint/EndpointParameters").EndpointParameters,
|
|
@@ -19,5 +19,5 @@ export declare const getRuntimeConfig: (
|
|
|
19
19
|
serviceId: string;
|
|
20
20
|
urlParser: import("@smithy/types").UrlParser;
|
|
21
21
|
utf8Decoder: import("@smithy/types").Decoder;
|
|
22
|
-
utf8Encoder:
|
|
22
|
+
utf8Encoder: (input: string | Uint8Array) => string;
|
|
23
23
|
};
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-personalize-runtime",
|
|
3
3
|
"description": "AWS SDK for JavaScript Personalize Runtime Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.535.0",
|
|
5
5
|
"scripts": {
|
|
6
6
|
"build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
|
|
7
7
|
"build:cjs": "node ../../scripts/compilation/inline client-personalize-runtime",
|
|
@@ -20,47 +20,47 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "3.0.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "3.0.0",
|
|
23
|
-
"@aws-sdk/client-sts": "3.
|
|
24
|
-
"@aws-sdk/core": "3.
|
|
25
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
26
|
-
"@aws-sdk/middleware-host-header": "3.
|
|
27
|
-
"@aws-sdk/middleware-logger": "3.
|
|
28
|
-
"@aws-sdk/middleware-recursion-detection": "3.
|
|
29
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
-
"@aws-sdk/region-config-resolver": "3.
|
|
31
|
-
"@aws-sdk/types": "3.
|
|
32
|
-
"@aws-sdk/util-endpoints": "3.
|
|
33
|
-
"@aws-sdk/util-user-agent-browser": "3.
|
|
34
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
35
|
-
"@smithy/config-resolver": "^2.
|
|
36
|
-
"@smithy/core": "^1.
|
|
37
|
-
"@smithy/fetch-http-handler": "^2.
|
|
38
|
-
"@smithy/hash-node": "^2.
|
|
39
|
-
"@smithy/invalid-dependency": "^2.
|
|
40
|
-
"@smithy/middleware-content-length": "^2.
|
|
41
|
-
"@smithy/middleware-endpoint": "^2.
|
|
42
|
-
"@smithy/middleware-retry": "^2.
|
|
43
|
-
"@smithy/middleware-serde": "^2.
|
|
44
|
-
"@smithy/middleware-stack": "^2.
|
|
45
|
-
"@smithy/node-config-provider": "^2.
|
|
46
|
-
"@smithy/node-http-handler": "^2.
|
|
47
|
-
"@smithy/protocol-http": "^3.
|
|
48
|
-
"@smithy/smithy-client": "^2.
|
|
49
|
-
"@smithy/types": "^2.
|
|
50
|
-
"@smithy/url-parser": "^2.
|
|
51
|
-
"@smithy/util-base64": "^2.
|
|
52
|
-
"@smithy/util-body-length-browser": "^2.
|
|
53
|
-
"@smithy/util-body-length-node": "^2.
|
|
54
|
-
"@smithy/util-defaults-mode-browser": "^2.
|
|
55
|
-
"@smithy/util-defaults-mode-node": "^2.
|
|
56
|
-
"@smithy/util-endpoints": "^1.
|
|
57
|
-
"@smithy/util-middleware": "^2.
|
|
58
|
-
"@smithy/util-retry": "^2.
|
|
59
|
-
"@smithy/util-utf8": "^2.
|
|
60
|
-
"tslib": "^2.
|
|
23
|
+
"@aws-sdk/client-sts": "3.535.0",
|
|
24
|
+
"@aws-sdk/core": "3.535.0",
|
|
25
|
+
"@aws-sdk/credential-provider-node": "3.535.0",
|
|
26
|
+
"@aws-sdk/middleware-host-header": "3.535.0",
|
|
27
|
+
"@aws-sdk/middleware-logger": "3.535.0",
|
|
28
|
+
"@aws-sdk/middleware-recursion-detection": "3.535.0",
|
|
29
|
+
"@aws-sdk/middleware-user-agent": "3.535.0",
|
|
30
|
+
"@aws-sdk/region-config-resolver": "3.535.0",
|
|
31
|
+
"@aws-sdk/types": "3.535.0",
|
|
32
|
+
"@aws-sdk/util-endpoints": "3.535.0",
|
|
33
|
+
"@aws-sdk/util-user-agent-browser": "3.535.0",
|
|
34
|
+
"@aws-sdk/util-user-agent-node": "3.535.0",
|
|
35
|
+
"@smithy/config-resolver": "^2.2.0",
|
|
36
|
+
"@smithy/core": "^1.4.0",
|
|
37
|
+
"@smithy/fetch-http-handler": "^2.5.0",
|
|
38
|
+
"@smithy/hash-node": "^2.2.0",
|
|
39
|
+
"@smithy/invalid-dependency": "^2.2.0",
|
|
40
|
+
"@smithy/middleware-content-length": "^2.2.0",
|
|
41
|
+
"@smithy/middleware-endpoint": "^2.5.0",
|
|
42
|
+
"@smithy/middleware-retry": "^2.2.0",
|
|
43
|
+
"@smithy/middleware-serde": "^2.3.0",
|
|
44
|
+
"@smithy/middleware-stack": "^2.2.0",
|
|
45
|
+
"@smithy/node-config-provider": "^2.3.0",
|
|
46
|
+
"@smithy/node-http-handler": "^2.5.0",
|
|
47
|
+
"@smithy/protocol-http": "^3.3.0",
|
|
48
|
+
"@smithy/smithy-client": "^2.5.0",
|
|
49
|
+
"@smithy/types": "^2.12.0",
|
|
50
|
+
"@smithy/url-parser": "^2.2.0",
|
|
51
|
+
"@smithy/util-base64": "^2.3.0",
|
|
52
|
+
"@smithy/util-body-length-browser": "^2.2.0",
|
|
53
|
+
"@smithy/util-body-length-node": "^2.3.0",
|
|
54
|
+
"@smithy/util-defaults-mode-browser": "^2.2.0",
|
|
55
|
+
"@smithy/util-defaults-mode-node": "^2.3.0",
|
|
56
|
+
"@smithy/util-endpoints": "^1.2.0",
|
|
57
|
+
"@smithy/util-middleware": "^2.2.0",
|
|
58
|
+
"@smithy/util-retry": "^2.2.0",
|
|
59
|
+
"@smithy/util-utf8": "^2.3.0",
|
|
60
|
+
"tslib": "^2.6.2"
|
|
61
61
|
},
|
|
62
62
|
"devDependencies": {
|
|
63
|
-
"@smithy/service-client-documentation-generator": "^2.
|
|
63
|
+
"@smithy/service-client-documentation-generator": "^2.2.0",
|
|
64
64
|
"@tsconfig/node14": "1.0.3",
|
|
65
65
|
"@types/node": "^14.14.31",
|
|
66
66
|
"concurrently": "7.0.0",
|