Class: Algolia::Search::DictionaryEntry

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

Overview

Dictionary entry.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DictionaryEntry

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

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

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

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

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

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

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

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

  # add extra attribute to additional_properties
  self.additional_properties ||= {}
  self.additional_properties.merge!(attributes.reject { |k, _| self.class.attribute_map.key?(k.to_sym) })
end

Instance Attribute Details

#additional_properties ⇒ Object

Returns the value of attribute additional_properties.



27
28
29
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 27

def additional_properties
  @additional_properties
end

#decomposition ⇒ Object

For compound entries, governs the behavior of the ‘word` parameter.



23
24
25
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 23

def decomposition
  @decomposition
end

#language ⇒ Object

[Supported language ISO code](www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/in-depth/supported-languages/).



14
15
16
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 14

def language
  @language
end

#object_id ⇒ Object

Unique identifier for a dictionary object.



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

def object_id
  @object_id
end

#state ⇒ Object

Returns the value of attribute state.



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

def state
  @state
end

#word ⇒ Object

Dictionary entry word. Usage depends on the type of dictionary entry. **‘stopwordEntry`** The stop word you want to add or update. If the entry already exists in Algolia’s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its ‘state` to `disabled`. **`compoundEntry`** When `decomposition` is empty: adds `word` as a compound atom. For example, atom “kino” decomposes the query “kopfkino” into "kopf" and "kino". When `decomposition` isn’t empty: creates a decomposition exception. For example, when decomposition is set to the ["hund", "hutte"] exception, "hundehutte" decomposes into “hund” and “hutte”, discarding the linking "e".



17
18
19
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 17

def word
  @word
end

#words ⇒ Object

Compound dictionary [word declensions](www.algolia.com/doc/guides/managing-results/optimize-search-results/handling-natural-languages-nlp/how-to/customize-plurals-and-other-declensions/). If the entry already exists in Algolia’s standard dictionary, you can override its behavior by adding it to the custom dictionary and setting its ‘state` to `disabled`.



20
21
22
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 20

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



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/algolia/models/search/dictionary_entry.rb', line 190

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 = 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



64
65
66
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 64

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 52

def self.attribute_map
  {
    :object_id => :objectID,
    :language => :language,
    :word => :word,
    :words => :words,
    :decomposition => :decomposition,
    :state => :state
  }
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



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

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

  # merge additional_properties into transformed_hash
  unless @additional_properties.nil?
    @additional_properties.each_pair do |k, v|
      transformed_hash[k.to_sym] = v
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 81

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

.types_mapping ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 69

def self.types_mapping
  {
    :object_id => :String,
    :language => :String,
    :word => :String,
    :words => :'Array<String>',
    :decomposition => :'Array<String>',
    :state => :DictionaryEntryState
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 131

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    object_id == other.object_id &&
    language == other.language &&
    word == other.word &&
    words == other.words &&
    decomposition == other.decomposition &&
    state == other.state
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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 270

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


145
146
147
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



151
152
153
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 151

def hash
  [object_id, language, word, words, decomposition, state].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



237
238
239
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 237

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 247

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

  # also add attributes from additional_properties to hash
  self.additional_properties&.each_pair do |k, v|
    hash[k.to_sym] = _to_hash(v)
  end
  hash
end

#to_json(*_args) ⇒ Object 



241
242
243
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 241

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



231
232
233
 
# File 'lib/algolia/models/search/dictionary_entry.rb', line 231

def to_s
  to_hash.to_s
end