Class: Algolia::Search::SynonymHit

Inherits:
Object
  • Object
show all
Defined in:
lib/algolia/models/search/synonym_hit.rb

Overview

Synonym object.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SynonymHit

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 97

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    raise(
      ArgumentError,
      "The input argument (attributes) must be a hash in `Algolia::SynonymHit` 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::SynonymHit`. 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?(:object_id)
    self.object_id = attributes[:object_id]
  else
    self.object_id = nil
  end

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

  if attributes.key?(:synonyms)
    if (value = attributes[:synonyms]).is_a?(Array)
      self.synonyms = value
    end
  end

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

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

  if attributes.key?(:corrections)
    if (value = attributes[:corrections]).is_a?(Array)
      self.corrections = value
    end
  end

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

  if attributes.key?(:replacements)
    if (value = attributes[:replacements]).is_a?(Array)
      self.replacements = value
    end
  end
end

Instance Attribute Details

#corrections ⇒ Object

Words to be matched in records.



25
26
27
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 25

def corrections
  @corrections
end

#input ⇒ Object

Word or phrase to appear in query strings (for [‘onewaysynonym`s](www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/one-way-synonyms/)).



19
20
21
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 19

def input
  @input
end

#object_id ⇒ Object

Unique identifier of a synonym object.



11
12
13
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 11

def object_id
  @object_id
end

#placeholder ⇒ Object

[Placeholder token](www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/) to be put inside records.



28
29
30
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 28

def placeholder
  @placeholder
end

#replacements ⇒ Object

Query words that will match the [placeholder token](www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-placeholders/).



31
32
33
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 31

def replacements
  @replacements
end

#synonyms ⇒ Object

Words or phrases considered equivalent.



16
17
18
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 16

def synonyms
  @synonyms
end

#type ⇒ Object

Returns the value of attribute type.



13
14
15
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 13

def type
  @type
end

#word ⇒ Object

Word or phrase to appear in query strings (for [‘altcorrection1` and `altcorrection2`](www.algolia.com/doc/guides/managing-results/optimize-search-results/adding-synonyms/in-depth/synonyms-alternative-corrections/)).



22
23
24
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 22

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



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
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 218

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::Search.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



70
71
72
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 70

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 56

def self.attribute_map
  {
    :object_id => :objectID,
    :type => :type,
    :synonyms => :synonyms,
    :input => :input,
    :word => :word,
    :corrections => :corrections,
    :placeholder => :placeholder,
    :replacements => :replacements
  }
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



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

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



89
90
91
92
93
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 89

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

.types_mapping ⇒ Object

Attribute type mapping.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 75

def self.types_mapping
  {
    :object_id => :"String",
    :type => :"SynonymType",
    :synonyms => :"Array<String>",
    :input => :"String",
    :word => :"String",
    :corrections => :"Array<String>",
    :placeholder => :"String",
    :replacements => :"Array<String>"
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 163

def ==(other)
  return true if self.equal?(other)
  self.class == other.class &&
    object_id == other.object_id &&
    type == other.type &&
    synonyms == other.synonyms &&
    input == other.input &&
    word == other.word &&
    corrections == other.corrections &&
    placeholder == other.placeholder &&
    replacements == other.replacements
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



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 297

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


178
179
180
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 178

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



184
185
186
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 184

def hash
  [object_id, type, synonyms, input, word, corrections, placeholder, replacements].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



268
269
270
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 268

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



278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 278

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 



272
273
274
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 272

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



262
263
264
 
# File 'lib/algolia/models/search/synonym_hit.rb', line 262

def to_s
  to_hash.to_s
end