Class: Aws::CustomerProfiles::Types::DiversityColumn

Inherits:

Struct

• Object
• Struct
• Aws::CustomerProfiles::Types::DiversityColumn

Defined in:

gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb

Overview

Defines a diversity constraint for a single item column, specifying a cap type and a target value or placeholder that controls how many recommended items may share the same column value.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cap_type ⇒ String

  The type of diversity cap to apply.

• #name ⇒ String

  The name of the item catalog column on which to apply the diversity cap.

• #target ⇒ String

  The diversity cap target.

Instance Attribute Details

#cap_type ⇒ String

The type of diversity cap to apply. Valid values are PERCENTAGE (interpret Target as a percentage of returned items) and VALUE (interpret Target as an absolute count).

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2926

class DiversityColumn < Struct.new(
  :name,
  :cap_type,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the item catalog column on which to apply the diversity cap. The column must be defined in the recommender schema.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2926

class DiversityColumn < Struct.new(
  :name,
  :cap_type,
  :target)
  SENSITIVE = []
  include Aws::Structure
end

#target ⇒ String

The diversity cap target. Either an integer literal (for example, "25") or a placeholder expression of the form $name whose value is supplied at inference time through GetProfileRecommendations.

Returns:

• (String)

# File 'gems/aws-sdk-customerprofiles/lib/aws-sdk-customerprofiles/types.rb', line 2926

class DiversityColumn < Struct.new(
  :name,
  :cap_type,
  :target)
  SENSITIVE = []
  include Aws::Structure
end