Class: UltracartClient::Experiment

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/experiment.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Experiment

Initializes the object



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ultracart_api/models/experiment.rb', line 173

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key

  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'container_id')
    self.container_id = attributes[:'container_id']
  end

  if attributes.has_key?(:'duration_days')
    self.duration_days = attributes[:'duration_days']
  end

  if attributes.has_key?(:'end_dts')
    self.end_dts = attributes[:'end_dts']
  end

  if attributes.has_key?(:'equal_weighting')
    self.equal_weighting = attributes[:'equal_weighting']
  end

  if attributes.has_key?(:'experiment_type')
    self.experiment_type = attributes[:'experiment_type']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'notes')
    self.notes = attributes[:'notes']
  end

  if attributes.has_key?(:'objective')
    self.objective = attributes[:'objective']
  end

  if attributes.has_key?(:'objective_parameter')
    self.objective_parameter = attributes[:'objective_parameter']
  end

  if attributes.has_key?(:'openai_current_iteration')
    self.openai_current_iteration = attributes[:'openai_current_iteration']
  end

  if attributes.has_key?(:'openai_element_type')
    self.openai_element_type = attributes[:'openai_element_type']
  end

  if attributes.has_key?(:'openai_model')
    self.openai_model = attributes[:'openai_model']
  end

  if attributes.has_key?(:'openai_total_iterations')
    self.openai_total_iterations = attributes[:'openai_total_iterations']
  end

  if attributes.has_key?(:'optimization_type')
    self.optimization_type = attributes[:'optimization_type']
  end

  if attributes.has_key?(:'p95_sessions_needed')
    self.p95_sessions_needed = attributes[:'p95_sessions_needed']
  end

  if attributes.has_key?(:'p_value')
    self.p_value = attributes[:'p_value']
  end

  if attributes.has_key?(:'session_count')
    self.session_count = attributes[:'session_count']
  end

  if attributes.has_key?(:'start_dts')
    self.start_dts = attributes[:'start_dts']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'storefront_experiment_oid')
    self.storefront_experiment_oid = attributes[:'storefront_experiment_oid']
  end

  if attributes.has_key?(:'storefront_oid')
    self.storefront_oid = attributes[:'storefront_oid']
  end

  if attributes.has_key?(:'uri')
    self.uri = attributes[:'uri']
  end

  if attributes.has_key?(:'variations')
    if (value = attributes[:'variations']).is_a?(Array)
      self.variations = value
    end
  end
end

Instance Attribute Details

#container_id ⇒ Object

Contained ID where the experiment element was located



18
19
20
 
# File 'lib/ultracart_api/models/experiment.rb', line 18

def container_id
  @container_id
end

#duration_days ⇒ Object

Duration in days



21
22
23
 
# File 'lib/ultracart_api/models/experiment.rb', line 21

def duration_days
  @duration_days
end

#end_dts ⇒ Object

End date/time



24
25
26
 
# File 'lib/ultracart_api/models/experiment.rb', line 24

def end_dts
  @end_dts
end

#equal_weighting ⇒ Object

Whether or not traffic is equally weighted or shifts over time during the experiment



27
28
29
 
# File 'lib/ultracart_api/models/experiment.rb', line 27

def equal_weighting
  @equal_weighting
end

#experiment_type ⇒ Object

The type of experiment



30
31
32
 
# File 'lib/ultracart_api/models/experiment.rb', line 30

def experiment_type
  @experiment_type
end

#id ⇒ Object

Experiment id



33
34
35
 
# File 'lib/ultracart_api/models/experiment.rb', line 33

def id
  @id
end

#name ⇒ Object

Experiment name



36
37
38
 
# File 'lib/ultracart_api/models/experiment.rb', line 36

def name
  @name
end

#notes ⇒ Object

Notes about the experiment



39
40
41
 
# File 'lib/ultracart_api/models/experiment.rb', line 39

def notes
  @notes
end

#objective ⇒ Object

Objective that is being optimized



42
43
44
 
# File 'lib/ultracart_api/models/experiment.rb', line 42

def objective
  @objective
end

#objective_parameter ⇒ Object

Objective parameter (such as event name) that is being optimized



45
46
47
 
# File 'lib/ultracart_api/models/experiment.rb', line 45

def objective_parameter
  @objective_parameter
end

#openai_current_iteration ⇒ Object

The current iteration of the OpenAI related experiment



48
49
50
 
# File 'lib/ultracart_api/models/experiment.rb', line 48

def openai_current_iteration
  @openai_current_iteration
end

#openai_element_type ⇒ Object

The type of OpenAI element being experimented on



51
52
53
 
# File 'lib/ultracart_api/models/experiment.rb', line 51

def openai_element_type
  @openai_element_type
end

#openai_model ⇒ Object

The type of OpenAI model used



54
55
56
 
# File 'lib/ultracart_api/models/experiment.rb', line 54

def openai_model
  @openai_model
end

#openai_total_iterations ⇒ Object

The total number of iterations to perform on the experiment



57
58
59
 
# File 'lib/ultracart_api/models/experiment.rb', line 57

def openai_total_iterations
  @openai_total_iterations
end

#optimization_type ⇒ Object

Type of optimization



60
61
62
 
# File 'lib/ultracart_api/models/experiment.rb', line 60

def optimization_type
  @optimization_type
end

#p95_sessions_needed ⇒ Object

Estimated sessions needed to achieve P95



63
64
65
 
# File 'lib/ultracart_api/models/experiment.rb', line 63

def p95_sessions_needed
  @p95_sessions_needed
end

#p_value ⇒ Object

Statistics p-value for the experiment



66
67
68
 
# File 'lib/ultracart_api/models/experiment.rb', line 66

def p_value
  @p_value
end

#session_count ⇒ Object

Total number of sessions in the experiment



69
70
71
 
# File 'lib/ultracart_api/models/experiment.rb', line 69

def session_count
  @session_count
end

#start_dts ⇒ Object

Start date/time



72
73
74
 
# File 'lib/ultracart_api/models/experiment.rb', line 72

def start_dts
  @start_dts
end

#status ⇒ Object

Status of the experiment



75
76
77
 
# File 'lib/ultracart_api/models/experiment.rb', line 75

def status
  @status
end

#storefront_experiment_oid ⇒ Object

Storefront Experiment Oid



78
79
80
 
# File 'lib/ultracart_api/models/experiment.rb', line 78

def storefront_experiment_oid
  @storefront_experiment_oid
end

#storefront_oid ⇒ Object

Storefront oid



81
82
83
 
# File 'lib/ultracart_api/models/experiment.rb', line 81

def storefront_oid
  @storefront_oid
end

#uri ⇒ Object

URI the experiment was started on



84
85
86
 
# File 'lib/ultracart_api/models/experiment.rb', line 84

def uri
  @uri
end

#variations ⇒ Object

Variations being tested in the experiment



87
88
89
 
# File 'lib/ultracart_api/models/experiment.rb', line 87

def variations
  @variations
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/ultracart_api/models/experiment.rb', line 112

def self.attribute_map
  {
    :'container_id' => :'container_id',
    :'duration_days' => :'duration_days',
    :'end_dts' => :'end_dts',
    :'equal_weighting' => :'equal_weighting',
    :'experiment_type' => :'experiment_type',
    :'id' => :'id',
    :'name' => :'name',
    :'notes' => :'notes',
    :'objective' => :'objective',
    :'objective_parameter' => :'objective_parameter',
    :'openai_current_iteration' => :'openai_current_iteration',
    :'openai_element_type' => :'openai_element_type',
    :'openai_model' => :'openai_model',
    :'openai_total_iterations' => :'openai_total_iterations',
    :'optimization_type' => :'optimization_type',
    :'p95_sessions_needed' => :'p95_sessions_needed',
    :'p_value' => :'p_value',
    :'session_count' => :'session_count',
    :'start_dts' => :'start_dts',
    :'status' => :'status',
    :'storefront_experiment_oid' => :'storefront_experiment_oid',
    :'storefront_oid' => :'storefront_oid',
    :'uri' => :'uri',
    :'variations' => :'variations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/ultracart_api/models/experiment.rb', line 142

def self.swagger_types
  {
    :'container_id' => :'String',
    :'duration_days' => :'Integer',
    :'end_dts' => :'String',
    :'equal_weighting' => :'BOOLEAN',
    :'experiment_type' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'notes' => :'String',
    :'objective' => :'String',
    :'objective_parameter' => :'String',
    :'openai_current_iteration' => :'Integer',
    :'openai_element_type' => :'String',
    :'openai_model' => :'String',
    :'openai_total_iterations' => :'Integer',
    :'optimization_type' => :'String',
    :'p95_sessions_needed' => :'Integer',
    :'p_value' => :'Float',
    :'session_count' => :'Integer',
    :'start_dts' => :'String',
    :'status' => :'String',
    :'storefront_experiment_oid' => :'Integer',
    :'storefront_oid' => :'Integer',
    :'uri' => :'String',
    :'variations' => :'Array<ExperimentVariation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/ultracart_api/models/experiment.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      container_id == o.container_id &&
      duration_days == o.duration_days &&
      end_dts == o.end_dts &&
      equal_weighting == o.equal_weighting &&
      experiment_type == o.experiment_type &&
      id == o.id &&
      name == o.name &&
      notes == o.notes &&
      objective == o.objective &&
      objective_parameter == o.objective_parameter &&
      openai_current_iteration == o.openai_current_iteration &&
      openai_element_type == o.openai_element_type &&
      openai_model == o.openai_model &&
      openai_total_iterations == o.openai_total_iterations &&
      optimization_type == o.optimization_type &&
      p95_sessions_needed == o.p95_sessions_needed &&
      p_value == o.p_value &&
      session_count == o.session_count &&
      start_dts == o.start_dts &&
      status == o.status &&
      storefront_experiment_oid == o.storefront_experiment_oid &&
      storefront_oid == o.storefront_oid &&
      uri == o.uri &&
      variations == o.variations
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ultracart_api/models/experiment.rb', line 382

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly

    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model

    temp_model = UltracartClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/ultracart_api/models/experiment.rb', line 448

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ultracart_api/models/experiment.rb', line 361

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute

      # is documented as an array but the input is not

      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional

  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


348
349
350
 
# File 'lib/ultracart_api/models/experiment.rb', line 348

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



354
355
356
 
# File 'lib/ultracart_api/models/experiment.rb', line 354

def hash
  [container_id, duration_days, end_dts, equal_weighting, experiment_type, id, name, notes, objective, objective_parameter, openai_current_iteration, openai_element_type, openai_model, openai_total_iterations, optimization_type, p95_sessions_needed, p_value, session_count, start_dts, status, storefront_experiment_oid, storefront_oid, uri, variations].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



280
281
282
283
 
# File 'lib/ultracart_api/models/experiment.rb', line 280

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



428
429
430
 
# File 'lib/ultracart_api/models/experiment.rb', line 428

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



434
435
436
437
438
439
440
441
442
 
# File 'lib/ultracart_api/models/experiment.rb', line 434

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



422
423
424
 
# File 'lib/ultracart_api/models/experiment.rb', line 422

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



287
288
289
290
291
292
293
 
# File 'lib/ultracart_api/models/experiment.rb', line 287

def valid?
  openai_element_type_validator = EnumAttributeValidator.new('String', ['headline', 'text', 'textblock'])
  return false unless openai_element_type_validator.valid?(@openai_element_type)
  status_validator = EnumAttributeValidator.new('String', ['Running', 'Ended', 'Deleted'])
  return false unless status_validator.valid?(@status)
  true
end