Class: RagieRubySdk::ScoredChunk

Inherits:
Object
  • Object
show all
Defined in:
lib/ragie_ruby_sdk/models/scored_chunk.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScoredChunk

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
149
150
151
152
153
154
155
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 84

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

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

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

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

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

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

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

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

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

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

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

Instance Attribute Details

#document_id ⇒ Object

Returns the value of attribute document_id.



28
29
30
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 28

def document_id
  @document_id
end

#document_metadata ⇒ Object

Returns the value of attribute document_metadata.



32
33
34
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 32

def document_metadata
  @document_metadata
end

#document_name ⇒ Object

Returns the value of attribute document_name.



30
31
32
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 30

def document_name
  @document_name
end

#id ⇒ Object

Returns the value of attribute id.



22
23
24
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 22

def id
  @id
end

#index ⇒ Object

Returns the value of attribute index.



24
25
26
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 24

def index
  @index
end

#links ⇒ Object

Returns the value of attribute links.



34
35
36
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 34

def links
  @links
end

#metadata ⇒ Object

Returns the value of attribute metadata.



26
27
28
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 26

def metadata
  @metadata
end

#score ⇒ Object

Returns the value of attribute score.



20
21
22
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 20

def score
  @score
end

#text ⇒ Object

Returns the value of attribute text.



18
19
20
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 18

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



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 347

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 = RagieRubySdk.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_attribute_map ⇒ Object

Returns attribute mapping this model knows about



52
53
54
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 52

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



57
58
59
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 57

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 37

def self.attribute_map
  {
    :'text' => :'text',
    :'score' => :'score',
    :'id' => :'id',
    :'index' => :'index',
    :'metadata' => :'metadata',
    :'document_id' => :'document_id',
    :'document_name' => :'document_name',
    :'document_metadata' => :'document_metadata',
    :'links' => :'links'
  }
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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 323

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



77
78
79
80
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 62

def self.openapi_types
  {
    :'text' => :'String',
    :'score' => :'Float',
    :'id' => :'String',
    :'index' => :'Integer',
    :'metadata' => :'Hash<String, Object>',
    :'document_id' => :'String',
    :'document_name' => :'String',
    :'document_metadata' => :'Hash<String, Object>',
    :'links' => :'Hash<String, Link>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 294

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text == o.text &&
      score == o.score &&
      id == o.id &&
      index == o.index &&
      metadata == o.metadata &&
      document_id == o.document_id &&
      document_name == o.document_name &&
      document_metadata == o.document_metadata &&
      links == o.links
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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 418

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


310
311
312
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 310

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



316
317
318
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 316

def hash
  [text, score, id, index, metadata, document_id, document_name, document_metadata, links].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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 159

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

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

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

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

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

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

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

  if @links.nil?
    invalid_properties.push('invalid value for "links", links 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



394
395
396
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 394

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



400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 400

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



388
389
390
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 388

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



199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/ragie_ruby_sdk/models/scored_chunk.rb', line 199

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @text.nil?
  return false if @score.nil?
  return false if @id.nil?
  return false if @index.nil?
  return false if @document_id.nil?
  return false if @document_name.nil?
  return false if @document_metadata.nil?
  return false if @links.nil?
  true
end