personalizeevents.d.ts
6.97 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class PersonalizeEvents extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: PersonalizeEvents.Types.ClientConfiguration)
config: Config & PersonalizeEvents.Types.ClientConfiguration;
/**
* Records user interaction event data. For more information see event-record-api.
*/
putEvents(params: PersonalizeEvents.Types.PutEventsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Records user interaction event data. For more information see event-record-api.
*/
putEvents(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds one or more items to an Items dataset. For more information see importing-items.
*/
putItems(params: PersonalizeEvents.Types.PutItemsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds one or more items to an Items dataset. For more information see importing-items.
*/
putItems(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds one or more users to a Users dataset. For more information see importing-users.
*/
putUsers(params: PersonalizeEvents.Types.PutUsersRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds one or more users to a Users dataset. For more information see importing-users.
*/
putUsers(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace PersonalizeEvents {
export type Arn = string;
export type _Date = Date;
export interface Event {
/**
* An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.
*/
eventId?: StringType;
/**
* The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.
*/
eventType: StringType;
/**
* The event value that corresponds to the EVENT_VALUE field of the Interactions schema.
*/
eventValue?: FloatType;
/**
* The item ID key that corresponds to the ITEM_ID field of the Interactions schema.
*/
itemId?: ItemId;
/**
* A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID (itemId) and rating (eventValue) , you might also send the number of movie ratings made by the user. Each item in the map consists of a key-value pair. For example, {"numberOfRatings": "12"} The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.
*/
properties?: EventPropertiesJSON;
/**
* The timestamp (in Unix time) on the client side when the event occurred.
*/
sentAt: _Date;
/**
* The ID of the recommendation.
*/
recommendationId?: RecommendationId;
/**
* A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"].
*/
impression?: Impression;
}
export type EventList = Event[];
export type EventPropertiesJSON = string;
export type FloatType = number;
export type Impression = ItemId[];
export interface Item {
/**
* The ID associated with the item.
*/
itemId: StringType;
/**
* A string map of item-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfRatings": "12"} The keys use camel case names that match the fields in the Items schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Items schema.
*/
properties?: ItemProperties;
}
export type ItemId = string;
export type ItemList = Item[];
export type ItemProperties = string;
export interface PutEventsRequest {
/**
* The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.
*/
trackingId: StringType;
/**
* The user associated with the event.
*/
userId?: UserId;
/**
* 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. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information see event-record-api.
*/
sessionId: StringType;
/**
* A list of event data from the session.
*/
eventList: EventList;
}
export interface PutItemsRequest {
/**
* The Amazon Resource Number (ARN) of the Items dataset you are adding the item or items to.
*/
datasetArn: Arn;
/**
* A list of item data.
*/
items: ItemList;
}
export interface PutUsersRequest {
/**
* The Amazon Resource Number (ARN) of the Users dataset you are adding the user or users to.
*/
datasetArn: Arn;
/**
* A list of user data.
*/
users: UserList;
}
export type RecommendationId = string;
export type StringType = string;
export interface User {
/**
* The ID associated with the user.
*/
userId: StringType;
/**
* A string map of user-specific metadata. Each element in the map consists of a key-value pair. For example, {"numberOfVideosWatched": "45"} The keys use camel case names that match the fields in the Users schema. In the above example, the numberOfVideosWatched would match the 'NUMBER_OF_VIDEOS_WATCHED' field defined in the Users schema.
*/
properties?: UserProperties;
}
export type UserId = string;
export type UserList = User[];
export type UserProperties = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2018-03-22"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the PersonalizeEvents client.
*/
export import Types = PersonalizeEvents;
}
export = PersonalizeEvents;