Package software.amazon.awssdk.services.personalizeevents.model

Interface ActionInteraction.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ActionInteraction.Builder,ActionInteraction>, SdkBuilder<ActionInteraction.Builder,ActionInteraction>, SdkPojo
Enclosing class:
ActionInteraction
public static interface ActionInteraction.Builder extends SdkPojo, CopyableBuilder<ActionInteraction.Builder,ActionInteraction>

  • Method Details

    • actionId

      ActionInteraction.Builder actionId(String actionId)

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

      Parameters:
      actionId - The ID of the action the user interacted with. This corresponds to the ACTION_ID field of the Action interaction schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • userId

      ActionInteraction.Builder userId(String userId)

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

      Parameters:
      userId - The ID of the user who interacted with the action. This corresponds to the USER_ID field of the Action interaction schema.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionId

      ActionInteraction.Builder sessionId(String sessionId)

      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.

      Parameters:
      sessionId - 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:
      Returns a reference to this object so that method calls can be chained together.

    • timestamp

      ActionInteraction.Builder timestamp(Instant timestamp)

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

      Parameters:
      timestamp - The timestamp for when the action interaction event occurred. Timestamps must be in Unix epoch time format, in seconds.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventType

      ActionInteraction.Builder eventType(String eventType)

      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.

      Parameters:
      eventType - 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:
      Returns a reference to this object so that method calls can be chained together.

    • eventId

      ActionInteraction.Builder eventId(String eventId)

      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.

      Parameters:
      eventId - 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:
      Returns a reference to this object so that method calls can be chained together.

    • recommendationId

      ActionInteraction.Builder recommendationId(String recommendationId)

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

      Parameters:
      recommendationId - The ID of the list of recommendations that contains the action the user interacted with.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • impression

      ActionInteraction.Builder impression(Collection<String> impression)

      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.

      Parameters:
      impression - 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:
      Returns a reference to this object so that method calls can be chained together.

    • impression

      ActionInteraction.Builder impression(String... impression)

      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.

      Parameters:
      impression - 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:
      Returns a reference to this object so that method calls can be chained together.

    • properties

      ActionInteraction.Builder properties(String properties)

      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

      Parameters:
      properties - 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:
      Returns a reference to this object so that method calls can be chained together.