Event

class Event

Represents item interaction event information sent using the PutEvents API.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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 distinguish unique events. Any subsequent events after the first with the same event ID are not used in model training.

Link copied to clipboard

The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Item interactions dataset's schema and depends on the types of events you are tracking.

Link copied to clipboard

The event value that corresponds to the EVENT_VALUE field of the Item interactions schema.

Link copied to clipboard

A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

Link copied to clipboard

The item ID key that corresponds to the ITEM_ID field of the Item interactions dataset's schema.

Link copied to clipboard

Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

Link copied to clipboard

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.

Link copied to clipboard

The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

Link copied to clipboard

The timestamp (in Unix time) on the client side when the event occurred.

Functions

Link copied to clipboard
inline fun copy(block: Event.Builder.() -> Unit = {}): Event
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String