@aws-sdk/client-personalize-events 3.686.0 → 3.691.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.
|
@@ -22,7 +22,7 @@ export interface Action {
|
|
|
22
22
|
* separate each category with a pipe separator (<code>|</code>). For example, <code>\"Deluxe|Premium\"</code>.</p>
|
|
23
23
|
* @public
|
|
24
24
|
*/
|
|
25
|
-
properties?: __LazyJsonString | string;
|
|
25
|
+
properties?: __LazyJsonString | string | undefined;
|
|
26
26
|
}
|
|
27
27
|
/**
|
|
28
28
|
* <p>Represents an action interaction event sent using the
|
|
@@ -41,7 +41,7 @@ export interface ActionInteraction {
|
|
|
41
41
|
* field of the Action interaction schema.</p>
|
|
42
42
|
* @public
|
|
43
43
|
*/
|
|
44
|
-
userId?: string;
|
|
44
|
+
userId?: string | undefined;
|
|
45
45
|
/**
|
|
46
46
|
* <p>The ID associated with the user's visit.
|
|
47
47
|
* Your application generates a unique <code>sessionId</code> when a user first visits your website or uses your application. </p>
|
|
@@ -66,19 +66,19 @@ export interface ActionInteraction {
|
|
|
66
66
|
* same event ID are not used in model training.</p>
|
|
67
67
|
* @public
|
|
68
68
|
*/
|
|
69
|
-
eventId?: string;
|
|
69
|
+
eventId?: string | undefined;
|
|
70
70
|
/**
|
|
71
71
|
* <p>The ID of the list of recommendations that contains the action the user interacted with.</p>
|
|
72
72
|
* @public
|
|
73
73
|
*/
|
|
74
|
-
recommendationId?: string;
|
|
74
|
+
recommendationId?: string | undefined;
|
|
75
75
|
/**
|
|
76
76
|
* <p>A list of action IDs that represents the sequence of actions you have shown the user. For example, <code>["actionId1", "actionId2", "actionId3"]</code>.
|
|
77
77
|
* Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the <code>Viewed</code> event type.
|
|
78
78
|
* </p>
|
|
79
79
|
* @public
|
|
80
80
|
*/
|
|
81
|
-
impression?: string[];
|
|
81
|
+
impression?: string[] | undefined;
|
|
82
82
|
/**
|
|
83
83
|
* <p>A string map of event-specific data that you might choose to record. For example, if a
|
|
84
84
|
* user takes an action, other than the action ID, you might also send the number of actions taken by the user.</p>
|
|
@@ -118,7 +118,7 @@ export interface ActionInteraction {
|
|
|
118
118
|
* </ul>
|
|
119
119
|
* @public
|
|
120
120
|
*/
|
|
121
|
-
properties?: __LazyJsonString | string;
|
|
121
|
+
properties?: __LazyJsonString | string | undefined;
|
|
122
122
|
}
|
|
123
123
|
/**
|
|
124
124
|
* <p>Provide a valid value for the field or parameter.</p>
|
|
@@ -211,7 +211,7 @@ export interface Event {
|
|
|
211
211
|
* same event ID are not used in model training.</p>
|
|
212
212
|
* @public
|
|
213
213
|
*/
|
|
214
|
-
eventId?: string;
|
|
214
|
+
eventId?: string | undefined;
|
|
215
215
|
/**
|
|
216
216
|
* <p>The type of event, such as click or download. This property corresponds to the <code>EVENT_TYPE</code>
|
|
217
217
|
* field of your Item interactions dataset's schema and depends on the types of events you are tracking.</p>
|
|
@@ -222,12 +222,12 @@ export interface Event {
|
|
|
222
222
|
* <p>The event value that corresponds to the <code>EVENT_VALUE</code> field of the Item interactions schema.</p>
|
|
223
223
|
* @public
|
|
224
224
|
*/
|
|
225
|
-
eventValue?: number;
|
|
225
|
+
eventValue?: number | undefined;
|
|
226
226
|
/**
|
|
227
227
|
* <p>The item ID key that corresponds to the <code>ITEM_ID</code> field of the Item interactions dataset's schema.</p>
|
|
228
228
|
* @public
|
|
229
229
|
*/
|
|
230
|
-
itemId?: string;
|
|
230
|
+
itemId?: string | undefined;
|
|
231
231
|
/**
|
|
232
232
|
* <p>A string map of event-specific data that you might choose to record. For example, if a
|
|
233
233
|
* user rates a movie on your site, other than movie ID (<code>itemId</code>) and rating (<code>eventValue</code>)
|
|
@@ -269,7 +269,7 @@ export interface Event {
|
|
|
269
269
|
* </ul>
|
|
270
270
|
* @public
|
|
271
271
|
*/
|
|
272
|
-
properties?: __LazyJsonString | string;
|
|
272
|
+
properties?: __LazyJsonString | string | undefined;
|
|
273
273
|
/**
|
|
274
274
|
* <p>The timestamp (in Unix time) on the client side when the event occurred.</p>
|
|
275
275
|
* @public
|
|
@@ -285,19 +285,19 @@ export interface Event {
|
|
|
285
285
|
* </p>
|
|
286
286
|
* @public
|
|
287
287
|
*/
|
|
288
|
-
recommendationId?: string;
|
|
288
|
+
recommendationId?: string | undefined;
|
|
289
289
|
/**
|
|
290
290
|
* <p>A list of item IDs that represents the sequence of items you have shown the user. For example, <code>["itemId1", "itemId2", "itemId3"]</code>. Provide a list of
|
|
291
291
|
* items to manually record impressions data for an event. For more information on recording impressions data,
|
|
292
292
|
* see <a href="https://docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data">Recording impressions data</a>. </p>
|
|
293
293
|
* @public
|
|
294
294
|
*/
|
|
295
|
-
impression?: string[];
|
|
295
|
+
impression?: string[] | undefined;
|
|
296
296
|
/**
|
|
297
297
|
* <p>Contains information about the metric attribution associated with an event. For more information about metric attributions, see <a href="https://docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html">Measuring impact of recommendations</a>.</p>
|
|
298
298
|
* @public
|
|
299
299
|
*/
|
|
300
|
-
metricAttribution?: MetricAttribution;
|
|
300
|
+
metricAttribution?: MetricAttribution | undefined;
|
|
301
301
|
}
|
|
302
302
|
/**
|
|
303
303
|
* @public
|
|
@@ -314,7 +314,7 @@ export interface PutEventsRequest {
|
|
|
314
314
|
* <p>The user associated with the event.</p>
|
|
315
315
|
* @public
|
|
316
316
|
*/
|
|
317
|
-
userId?: string;
|
|
317
|
+
userId?: string | undefined;
|
|
318
318
|
/**
|
|
319
319
|
* <p>The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application.
|
|
320
320
|
* Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see
|
|
@@ -350,7 +350,7 @@ export interface Item {
|
|
|
350
350
|
* separate each category with a pipe separator (<code>|</code>). For example, <code>\"Horror|Action\"</code>.</p>
|
|
351
351
|
* @public
|
|
352
352
|
*/
|
|
353
|
-
properties?: __LazyJsonString | string;
|
|
353
|
+
properties?: __LazyJsonString | string | undefined;
|
|
354
354
|
}
|
|
355
355
|
/**
|
|
356
356
|
* @public
|
|
@@ -389,7 +389,7 @@ export interface User {
|
|
|
389
389
|
* For example, <code>\"Member|Frequent shopper\"</code>.</p>
|
|
390
390
|
* @public
|
|
391
391
|
*/
|
|
392
|
-
properties?: __LazyJsonString | string;
|
|
392
|
+
properties?: __LazyJsonString | string | undefined;
|
|
393
393
|
}
|
|
394
394
|
/**
|
|
395
395
|
* @public
|
|
@@ -5,18 +5,18 @@ import {
|
|
|
5
5
|
import { PersonalizeEventsServiceException as __BaseException } from "./PersonalizeEventsServiceException";
|
|
6
6
|
export interface Action {
|
|
7
7
|
actionId: string | undefined;
|
|
8
|
-
properties?: __LazyJsonString | string;
|
|
8
|
+
properties?: __LazyJsonString | string | undefined;
|
|
9
9
|
}
|
|
10
10
|
export interface ActionInteraction {
|
|
11
11
|
actionId: string | undefined;
|
|
12
|
-
userId?: string;
|
|
12
|
+
userId?: string | undefined;
|
|
13
13
|
sessionId: string | undefined;
|
|
14
14
|
timestamp: Date | undefined;
|
|
15
15
|
eventType: string | undefined;
|
|
16
|
-
eventId?: string;
|
|
17
|
-
recommendationId?: string;
|
|
18
|
-
impression?: string[];
|
|
19
|
-
properties?: __LazyJsonString | string;
|
|
16
|
+
eventId?: string | undefined;
|
|
17
|
+
recommendationId?: string | undefined;
|
|
18
|
+
impression?: string[] | undefined;
|
|
19
|
+
properties?: __LazyJsonString | string | undefined;
|
|
20
20
|
}
|
|
21
21
|
export declare class InvalidInputException extends __BaseException {
|
|
22
22
|
readonly name: "InvalidInputException";
|
|
@@ -51,25 +51,25 @@ export interface MetricAttribution {
|
|
|
51
51
|
eventAttributionSource: string | undefined;
|
|
52
52
|
}
|
|
53
53
|
export interface Event {
|
|
54
|
-
eventId?: string;
|
|
54
|
+
eventId?: string | undefined;
|
|
55
55
|
eventType: string | undefined;
|
|
56
|
-
eventValue?: number;
|
|
57
|
-
itemId?: string;
|
|
58
|
-
properties?: __LazyJsonString | string;
|
|
56
|
+
eventValue?: number | undefined;
|
|
57
|
+
itemId?: string | undefined;
|
|
58
|
+
properties?: __LazyJsonString | string | undefined;
|
|
59
59
|
sentAt: Date | undefined;
|
|
60
|
-
recommendationId?: string;
|
|
61
|
-
impression?: string[];
|
|
62
|
-
metricAttribution?: MetricAttribution;
|
|
60
|
+
recommendationId?: string | undefined;
|
|
61
|
+
impression?: string[] | undefined;
|
|
62
|
+
metricAttribution?: MetricAttribution | undefined;
|
|
63
63
|
}
|
|
64
64
|
export interface PutEventsRequest {
|
|
65
65
|
trackingId: string | undefined;
|
|
66
|
-
userId?: string;
|
|
66
|
+
userId?: string | undefined;
|
|
67
67
|
sessionId: string | undefined;
|
|
68
68
|
eventList: Event[] | undefined;
|
|
69
69
|
}
|
|
70
70
|
export interface Item {
|
|
71
71
|
itemId: string | undefined;
|
|
72
|
-
properties?: __LazyJsonString | string;
|
|
72
|
+
properties?: __LazyJsonString | string | undefined;
|
|
73
73
|
}
|
|
74
74
|
export interface PutItemsRequest {
|
|
75
75
|
datasetArn: string | undefined;
|
|
@@ -77,7 +77,7 @@ export interface PutItemsRequest {
|
|
|
77
77
|
}
|
|
78
78
|
export interface User {
|
|
79
79
|
userId: string | undefined;
|
|
80
|
-
properties?: __LazyJsonString | string;
|
|
80
|
+
properties?: __LazyJsonString | string | undefined;
|
|
81
81
|
}
|
|
82
82
|
export interface PutUsersRequest {
|
|
83
83
|
datasetArn: string | undefined;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aws-sdk/client-personalize-events",
|
|
3
3
|
"description": "AWS SDK for JavaScript Personalize Events Client for Node.js, Browser and React Native",
|
|
4
|
-
"version": "3.
|
|
4
|
+
"version": "3.691.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-events",
|
|
@@ -20,19 +20,19 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"@aws-crypto/sha256-browser": "5.2.0",
|
|
22
22
|
"@aws-crypto/sha256-js": "5.2.0",
|
|
23
|
-
"@aws-sdk/client-sso-oidc": "3.
|
|
24
|
-
"@aws-sdk/client-sts": "3.
|
|
25
|
-
"@aws-sdk/core": "3.
|
|
26
|
-
"@aws-sdk/credential-provider-node": "3.
|
|
23
|
+
"@aws-sdk/client-sso-oidc": "3.691.0",
|
|
24
|
+
"@aws-sdk/client-sts": "3.691.0",
|
|
25
|
+
"@aws-sdk/core": "3.691.0",
|
|
26
|
+
"@aws-sdk/credential-provider-node": "3.691.0",
|
|
27
27
|
"@aws-sdk/middleware-host-header": "3.686.0",
|
|
28
28
|
"@aws-sdk/middleware-logger": "3.686.0",
|
|
29
29
|
"@aws-sdk/middleware-recursion-detection": "3.686.0",
|
|
30
|
-
"@aws-sdk/middleware-user-agent": "3.
|
|
30
|
+
"@aws-sdk/middleware-user-agent": "3.691.0",
|
|
31
31
|
"@aws-sdk/region-config-resolver": "3.686.0",
|
|
32
32
|
"@aws-sdk/types": "3.686.0",
|
|
33
33
|
"@aws-sdk/util-endpoints": "3.686.0",
|
|
34
34
|
"@aws-sdk/util-user-agent-browser": "3.686.0",
|
|
35
|
-
"@aws-sdk/util-user-agent-node": "3.
|
|
35
|
+
"@aws-sdk/util-user-agent-node": "3.691.0",
|
|
36
36
|
"@smithy/config-resolver": "^3.0.10",
|
|
37
37
|
"@smithy/core": "^2.5.1",
|
|
38
38
|
"@smithy/fetch-http-handler": "^4.0.0",
|