Class: Aws::PersonalizeEvents::Types::ActionInteraction

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

Overview

Represents an action interaction event sent using the PutActionInteractions API.

See Also:

Constant Summary collapse

SENSITIVE = 
[:action_id, :user_id, :impression, :properties]

Instance Attribute Summary collapse

Instance Attribute Details

#action_id ⇒ String

The ID of the action the user interacted with. This corresponds to the ACTION_ID field of the Action interaction schema.

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#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) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#event_type ⇒ String

The type of action interaction event. You can specify Viewed, Taken, and Not Taken event types. For more information about action interaction event type data, see Event type data.

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#impression ⇒ Array<String>

A list of action IDs that represents the sequence of actions you have shown the user. For example, ["actionId1", "actionId2", "actionId3"]. Amazon Personalize doesn't use impressions data from action interaction events. Instead, record multiple events for each action and use the Viewed event type.

Returns:

  • (Array<String>) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#properties ⇒ String

A string map of event-specific data that you might choose to record. For example, if a user takes an action, other than the action ID, you might also send the number of actions taken by the user.

Each item in the map consists of a key-value pair. For example,

{"numberOfActions": "12"}

The keys use camel case names that match the fields in the Action interactions schema. In the above example, the numberOfActions would match the 'NUMBER_OF_ACTIONS' field defined in the Action interactions schema.

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

  • userId

  • sessionId

  • eventType

  • timestamp

  • recommendationId

  • impression

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#recommendation_id ⇒ String

The ID of the list of recommendations that contains the action the user interacted with.

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#session_id ⇒ String

The ID associated with the user's visit. Your application generates a unique sessionId when a user first visits your website or uses your application.

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#timestamp ⇒ Time

The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.

Returns:

  • (Time) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end

#user_id ⇒ String

The ID of the user who interacted with the action. This corresponds to the USER_ID field of the Action interaction schema.

Returns:

  • (String) 


133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'gems/aws-sdk-personalizeevents/lib/aws-sdk-personalizeevents/types.rb', line 133

class ActionInteraction < Struct.new(
  :action_id,
  :user_id,
  :session_id,
  :timestamp,
  :event_type,
  :event_id,
  :recommendation_id,
  :impression,
  :properties)
  SENSITIVE = [:action_id, :user_id, :impression, :properties]
  include Aws::Structure
end