Class: TrieveRubyClient::RecommendationEvent

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/models/recommendation_event.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecommendationEvent

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 87

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TrieveRubyClient::RecommendationEvent` 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))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TrieveRubyClient::RecommendationEvent`. 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?(:'created_at')
    self.created_at = attributes[:'created_at']
  else
    self.created_at = nil
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



18
19
20
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 18

def created_at
  @created_at
end

#dataset_id ⇒ Object

Returns the value of attribute dataset_id.



20
21
22
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 20

def dataset_id
  @dataset_id
end

#id ⇒ Object

Returns the value of attribute id.



22
23
24
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 22

def id
  @id
end

#negative_ids ⇒ Object

Returns the value of attribute negative_ids.



24
25
26
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 24

def negative_ids
  @negative_ids
end

#negative_tracking_ids ⇒ Object

Returns the value of attribute negative_tracking_ids.



26
27
28
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 26

def negative_tracking_ids
  @negative_tracking_ids
end

#positive_ids ⇒ Object

Returns the value of attribute positive_ids.



28
29
30
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 28

def positive_ids
  @positive_ids
end

#positive_tracking_ids ⇒ Object

Returns the value of attribute positive_tracking_ids.



30
31
32
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 30

def positive_tracking_ids
  @positive_tracking_ids
end

#recommendation_type ⇒ Object

Returns the value of attribute recommendation_type.



32
33
34
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 32

def recommendation_type
  @recommendation_type
end

#request_params ⇒ Object

Returns the value of attribute request_params.



34
35
36
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 34

def request_params
  @request_params
end

#results ⇒ Object

Returns the value of attribute results.



36
37
38
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 36

def results
  @results
end

#top_score ⇒ Object

Returns the value of attribute top_score.



38
39
40
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 38

def top_score
  @top_score
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



304
305
306
307
308
309
310
311
312
313
314
315
316
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
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 304

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
  else # model
    # models (e.g. Pet) or oneOf
    klass = TrieveRubyClient.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

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



58
59
60
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 58

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 41

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'dataset_id' => :'dataset_id',
    :'id' => :'id',
    :'negative_ids' => :'negative_ids',
    :'negative_tracking_ids' => :'negative_tracking_ids',
    :'positive_ids' => :'positive_ids',
    :'positive_tracking_ids' => :'positive_tracking_ids',
    :'recommendation_type' => :'recommendation_type',
    :'request_params' => :'request_params',
    :'results' => :'results',
    :'top_score' => :'top_score'
  }
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



280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 280

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



80
81
82
83
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 80

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

.openapi_types ⇒ Object

Attribute type mapping.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 63

def self.openapi_types
  {
    :'created_at' => :'String',
    :'dataset_id' => :'String',
    :'id' => :'String',
    :'negative_ids' => :'Array<String>',
    :'negative_tracking_ids' => :'Array<String>',
    :'positive_ids' => :'Array<String>',
    :'positive_tracking_ids' => :'Array<String>',
    :'recommendation_type' => :'String',
    :'request_params' => :'String',
    :'results' => :'Array<SearchResultType>',
    :'top_score' => :'Float'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 249

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      dataset_id == o.dataset_id &&
      id == o.id &&
      negative_ids == o.negative_ids &&
      negative_tracking_ids == o.negative_tracking_ids &&
      positive_ids == o.positive_ids &&
      positive_tracking_ids == o.positive_tracking_ids &&
      recommendation_type == o.recommendation_type &&
      request_params == o.request_params &&
      results == o.results &&
      top_score == o.top_score
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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 375

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?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


267
268
269
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 273

def hash
  [created_at, dataset_id, id, negative_ids, negative_tracking_ids, positive_ids, positive_tracking_ids, recommendation_type, request_params, results, top_score].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



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
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 179

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @created_at.nil?
    invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
  end

  if @dataset_id.nil?
    invalid_properties.push('invalid value for "dataset_id", dataset_id cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  if @negative_ids.nil?
    invalid_properties.push('invalid value for "negative_ids", negative_ids cannot be nil.')
  end

  if @negative_tracking_ids.nil?
    invalid_properties.push('invalid value for "negative_tracking_ids", negative_tracking_ids cannot be nil.')
  end

  if @positive_ids.nil?
    invalid_properties.push('invalid value for "positive_ids", positive_ids cannot be nil.')
  end

  if @positive_tracking_ids.nil?
    invalid_properties.push('invalid value for "positive_tracking_ids", positive_tracking_ids cannot be nil.')
  end

  if @recommendation_type.nil?
    invalid_properties.push('invalid value for "recommendation_type", recommendation_type cannot be nil.')
  end

  if @request_params.nil?
    invalid_properties.push('invalid value for "request_params", request_params cannot be nil.')
  end

  if @results.nil?
    invalid_properties.push('invalid value for "results", results cannot be nil.')
  end

  if @top_score.nil?
    invalid_properties.push('invalid value for "top_score", top_score cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



351
352
353
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 351

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



357
358
359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 357

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



345
346
347
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 345

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/trieve_ruby_client/models/recommendation_event.rb', line 231

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @created_at.nil?
  return false if @dataset_id.nil?
  return false if @id.nil?
  return false if @negative_ids.nil?
  return false if @negative_tracking_ids.nil?
  return false if @positive_ids.nil?
  return false if @positive_tracking_ids.nil?
  return false if @recommendation_type.nil?
  return false if @request_params.nil?
  return false if @results.nil?
  return false if @top_score.nil?
  true
end