model

Type Members

1. case class Abtest(name: TestName, feature: FeatureName, author: String, start: OffsetDateTime, end: Option[OffsetDateTime], groups: List[Group], ranges: GroupRanges, requiredTags: List[Tag] = Nil, alternativeIdName: Option[MetaFieldName] = None, matchingUserMeta: UserMeta = Map(), salt: Option[String] = None, segmentRanges: List[GroupRange] = Nil, groupMetas: GroupMetas = Map(), specialization: Option[Specialization] = None) extends Product with Serializable

   

   Internal representation of an A/B test, the public representation is Abtest

2. case class AbtestSpec(name: TestName, feature: FeatureName, author: String, start: OffsetDateTime, end: Option[OffsetDateTime], groups: List[Group], requiredTags: List[Tag] = Nil, alternativeIdName: Option[MetaFieldName] = None, matchingUserMeta: UserMeta = Map(), reshuffle: Boolean = false, segmentRanges: List[GroupRange] = Nil, groupMetas: GroupMetas = Map(), specialization: Option[Specialization] = None) extends Product with Serializable

   

   Data used to create an A/B tests

   Data used to create an A/B tests

   name

   name of the test, it's more like a note/description. It is NOT an identifier.

   feature

   feature name of the treatment. This is an identifier with which feature code can determine for each user which treatment they get.

   author

   author name. Can be used for ownership

   start

   scheduled start of the test

   end

   scheduled end of the test, optional, if not given the test will last indefinitely

   groups

   group definitions. group sizes don't have to add up to 1, but they cannot go beyond 1. If the sum group size is less than 1, it means that there is a portion (1 - the sum group size) of users won't be the in tests at all, you could make this group your control group.

   requiredTags

   an array of string tags for eligibility control. Once set, only users having these tags (tags are passed in group assignment inquiry requests) are eligible for this test.

   alternativeIdName

   by default Thomas uses the "userId" field passed in the group assignment inquiry request as the unique identification for segmenting users. In some A/B test cases, e.g. some features in the user registration process, a user Id might not be given yet. In such cases, you can choose to use any user meta field as the unique identification for users.

   matchingUserMeta

   this is more advanced eligibility control. You can set a field and regex pair to match user meta. Only users whose metadata field value matches the regex are eligible for the experiment.

   reshuffle

   by default Thomas will try to keep the user assignment consistent between different versions of experiments of a feature. Setting this field to true will redistribute users again among all groups.

   segmentRanges

   his field is used for creating mutually exclusive tests. When Thomas segments users into different groups, it hashes the user Id to a number between 0 and 1. If an A/B test is set with a set of segment ranges, then only hashes within that range will be eligible for that test. Thus if two tests have non-overlapping segment ranges, they will be mutually exclusive, i.e. users who eligible for one will not be eligible for the other.

3. case class Feature(name: FeatureName, description: Option[String], overrides: Overrides, overrideEligibility: Boolean = false, locked: Boolean = false) extends Product with Serializable

   

4. case class Group(name: GroupName, size: GroupSize) extends Product with Serializable

   

5. type GroupMeta = JsObject

   

6. type GroupMetas = Map[GroupName, GroupMeta]

   

7. case class GroupRange(start: Double, end: Double) extends Product with Serializable

   

8. type GroupRanges = Map[GroupName, List[GroupRange]]

   

9. type GroupSize = Double

   

10. type MetaFieldName = String

    

11. type Overrides = Map[UserId, GroupName]

    

12. type Tag = String

    

13. type TestId = Type

    

14. type TestName = String

    

15. case class UserGroupQuery(userId: Option[UserId], at: Option[OffsetDateTime] = None, tags: List[Tag] = Nil, meta: UserMeta = Map(), features: List[FeatureName] = Nil) extends Product with Serializable

    

16. case class UserGroupQueryResult(groups: Map[FeatureName, GroupName], metas: Map[FeatureName, GroupMeta]) extends Product with Serializable

    

17. case class UserInfo(userId: Option[UserId], meta: UserMeta = Map()) extends Product with Serializable

    

18. type UserMeta = Map[MetaFieldName, String]