Class: Aws::PersonalizeEvents::Types::Event

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-personalizeevents/types.rb

Overview

Represents item interaction event information sent using the ‘PutEvents` API.

See Also:

Constant Summary collapse

SENSITIVE = 
[:item_id, :properties, :impression]

Instance Attribute Summary collapse

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

Returns:

  • (String) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  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 Item interactions dataset’s schema and depends on the types of events you are tracking.

Returns:

  • (String) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  include Aws::Structure
end

#event_value ⇒ Float

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

Returns:

  • (Float) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  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”]`. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see [Recording impressions data].

[1]: docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data

Returns:

  • (Array<String>) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  include Aws::Structure
end

#item_id ⇒ String

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

Returns:

  • (String) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  include Aws::Structure
end

#metric_attribution ⇒ Types::MetricAttribution

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

[1]: docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html

Returns:



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  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,

‘“12”`

The keys use camel case names that match the fields in the Item interactions dataset’s schema. In the above example, the ‘numberOfRatings` would match the ’NUMBER_OF_RATINGS’ field defined in the Item interactions dataset’s schema.

The following can’t be included as a keyword for properties (case insensitive).

  • userId

  • sessionId

  • eventType

  • timestamp

  • recommendationId

  • impression

Returns:

  • (String) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  include Aws::Structure
end

#recommendation_id ⇒ String

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.

For more information on recording impressions data, see [Recording impressions data]. For more information on creating a metric attribution see [Measuring impact of recommendations].

[1]: docs.aws.amazon.com/personalize/latest/dg/recording-events.html#putevents-including-impressions-data [2]: docs.aws.amazon.com/personalize/latest/dg/measuring-recommendation-impact.html

Returns:

  • (String) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  include Aws::Structure
end

#sent_at ⇒ Time

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

Returns:

  • (Time) 


252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/aws-sdk-personalizeevents/types.rb', line 252

class Event < Struct.new(
  :event_id,
  :event_type,
  :event_value,
  :item_id,
  :properties,
  :sent_at,
  :recommendation_id,
  :impression,
  :metric_attribution)
  SENSITIVE = [:item_id, :properties, :impression]
  include Aws::Structure
end