Class: Algolia::AbtestingV3::MetricResult

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/abtesting-v3/metric_result.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MetricResult

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
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
140
141
142
143
144
145
146
147
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 79

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::MetricResult` initialize method"
    )
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      raise(
        ArgumentError,
        "`#{k}` is not a valid attribute in `Algolia::MetricResult`. Please check the name to make sure it's valid. List of attributes: " +
          self.class.attribute_map.keys.inspect
      )
    end

    h[k.to_sym] = v
  }

  if attributes.key?(:name)
    self.name = attributes[:name]
  else
    self.name = nil
  end

  if attributes.key?(:updated_at)
    self.updated_at = attributes[:updated_at]
  else
    self.updated_at = nil
  end

  if attributes.key?(:value)
    self.value = attributes[:value]
  else
    self.value = nil
  end

  if attributes.key?(:value_ci_high)
    self.value_ci_high = attributes[:value_ci_high]
  end

  if attributes.key?(:value_ci_low)
    self.value_ci_low = attributes[:value_ci_low]
  end

  if attributes.key?(:p_value)
    self.p_value = attributes[:p_value]
  else
    self.p_value = nil
  end

  if attributes.key?(:dimension)
    self.dimension = attributes[:dimension]
  end

  if attributes.key?(:metadata)
    self.metadata = attributes[:metadata]
  end

  if attributes.key?(:critical_value)
    self.critical_value = attributes[:critical_value]
  end

  if attributes.key?(:significant)
    self.significant = attributes[:significant]
  end
end

Instance Attribute Details

#critical_value ⇒ Object

The value that was computed during error correction. It is used to determine significance of the metric pValue. The critical value is calculated using Bonferroni or Benjamini-Hochberg corrections, based on the given configuration during the A/B test creation.



33
34
35
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 33

def critical_value
  @critical_value
end

#dimension ⇒ Object

Dimension defined during test creation.



28
29
30
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 28

def dimension
  @dimension
end

#metadata ⇒ Object

Returns the value of attribute metadata.



30
31
32
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 30

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



11
12
13
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 11

def name
  @name
end

#p_value ⇒ Object

PValue for the first variant (control) will always be 0. For the other variants, pValue is calculated for the current variant based on the control.



25
26
27
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 25

def p_value
  @p_value
end

#significant ⇒ Object

Whether the pValue is significant or not based on the critical value and the error correction algorithm used.



36
37
38
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 36

def significant
  @significant
end

#updated_at ⇒ Object

Date and time when the metric was last updated, in RFC 3339 format.



14
15
16
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 14

def updated_at
  @updated_at
end

#value ⇒ Object

Returns the value of attribute value.



16
17
18
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 16

def value
  @value
end

#value_ci_high ⇒ Object

The upper bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).



19
20
21
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 19

def value_ci_high
  @value_ci_high
end

#value_ci_low ⇒ Object

The lower bound of the 95% confidence interval for the metric value. The confidence interval is calculated using either the relative ratio or relative difference between the metric values for the control and the variant. Relative ratio is used for metrics that are ratios (e.g., click-through rate, conversion rate), while relative difference is used for continuous metrics (e.g., revenue).



22
23
24
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 22

def value_ci_low
  @value_ci_low
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 219

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # model
  else
    # models (e.g. Pet) or oneOf
    klass = Algolia::AbtestingV3.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
      .build_from_hash(value)
  end
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 39

def self.attribute_map
  {
    :name => :name,
    :updated_at => :updatedAt,
    :value => :value,
    :value_ci_high => :valueCIHigh,
    :value_ci_low => :valueCILow,
    :p_value => :pValue,
    :dimension => :dimension,
    :metadata => :metadata,
    :critical_value => :criticalValue,
    :significant => :significant
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 192

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  types_mapping.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
          _deserialize(::Regexp.last_match(1), v)
        }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
    end
  end

  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



71
72
73
74
75
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 71

def self.openapi_nullable
  Set.new(
    []
  )
end

.types_mapping ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 55

def self.types_mapping
  {
    :name => :"String",
    :updated_at => :"String",
    :value => :"Float",
    :value_ci_high => :"Float",
    :value_ci_low => :"Float",
    :p_value => :"Float",
    :dimension => :"String",
    :metadata => :"MetricMetadata",
    :critical_value => :"Float",
    :significant => :"Boolean"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 151

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    name == other.name &&
    updated_at == other.updated_at &&
    value == other.value &&
    value_ci_high == other.value_ci_high &&
    value_ci_low == other.value_ci_low &&
    p_value == other.p_value &&
    dimension == other.dimension &&
    metadata == other.metadata &&
    critical_value == other.critical_value &&
    significant == other.significant
end

#_to_hash(value) ⇒ Hash

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 298

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

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


168
169
170
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 168

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 174

def hash
  [
    name,
    updated_at,
    value,
    value_ci_high,
    value_ci_low,
    p_value,
    dimension,
    metadata,
    critical_value,
    significant
  ].hash
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



269
270
271
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 269

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 279

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end

  hash
end

#to_json(*_args) ⇒ Object 



273
274
275
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 273

def to_json(*_args)
  to_hash.to_json
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



263
264
265
 
# File 'lib/algolia/models/abtesting-v3/metric_result.rb', line 263

def to_s
  to_hash.to_s
end