Class: Aws::PersonalizeEvents::Types::Event
- Inherits:
-
Struct
- Object
- Struct
- Aws::PersonalizeEvents::Types::Event
- Defined in:
- gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb
Overview
When making an API call, you may pass Event data as a hash:
{
event_id: "StringType",
event_type: "StringType", # required
event_value: 1.0,
item_id: "ItemId",
properties: "EventPropertiesJSON",
sent_at: Time.now, # required
recommendation_id: "RecommendationId",
impression: ["ItemId"],
}
Represents user interaction event information sent using the
PutEvents
API.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#event_id ⇒ String
An ID associated with the event.
-
#event_type ⇒ String
The type of event, such as click or download.
-
#event_value ⇒ Float
The event value that corresponds to the
EVENT_VALUE
field of the Interactions schema. -
#impression ⇒ Array<String>
A list of item IDs that represents the sequence of items you have shown the user.
-
#item_id ⇒ String
The item ID key that corresponds to the
ITEM_ID
field of the Interactions schema. -
#properties ⇒ String
A string map of event-specific data that you might choose to record.
-
#recommendation_id ⇒ String
The ID of the recommendation.
-
#sent_at ⇒ Time
The timestamp (in Unix time) on the client side when the event occurred.
Instance Attribute Details
#event_id ⇒ String
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.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#event_type ⇒ String
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.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#event_value ⇒ Float
The event value that corresponds to the EVENT_VALUE
field of the
Interactions schema.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#impression ⇒ Array<String>
A list of item IDs that represents the sequence of items you have
shown the user. For example, ["itemId1", "itemId2", "itemId3"]
.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#item_id ⇒ String
The item ID key that corresponds to the ITEM_ID
field of the
Interactions schema.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#properties ⇒ String
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.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#recommendation_id ⇒ String
The ID of the recommendation.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |
#sent_at ⇒ Time
The timestamp (in Unix time) on the client side when the event occurred.
86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 86 class Event < Struct.new( :event_id, :event_type, :event_value, :item_id, :properties, :sent_at, :recommendation_id, :impression) SENSITIVE = [] include Aws::Structure end |