Class: OCI::AiVision::Models::DetectedLanguage

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_vision/models/detected_language.rb

Overview

The language detected in a document.

Constant Summary collapse

LANGUAGE_CODE_ENUM = 
[
  LANGUAGE_CODE_ENG = 'ENG'.freeze,
  LANGUAGE_CODE_CES = 'CES'.freeze,
  LANGUAGE_CODE_DAN = 'DAN'.freeze,
  LANGUAGE_CODE_NLD = 'NLD'.freeze,
  LANGUAGE_CODE_FIN = 'FIN'.freeze,
  LANGUAGE_CODE_FRA = 'FRA'.freeze,
  LANGUAGE_CODE_DEU = 'DEU'.freeze,
  LANGUAGE_CODE_ELL = 'ELL'.freeze,
  LANGUAGE_CODE_HUN = 'HUN'.freeze,
  LANGUAGE_CODE_ITA = 'ITA'.freeze,
  LANGUAGE_CODE_NOR = 'NOR'.freeze,
  LANGUAGE_CODE_POL = 'POL'.freeze,
  LANGUAGE_CODE_POR = 'POR'.freeze,
  LANGUAGE_CODE_RON = 'RON'.freeze,
  LANGUAGE_CODE_RUS = 'RUS'.freeze,
  LANGUAGE_CODE_SLK = 'SLK'.freeze,
  LANGUAGE_CODE_SPA = 'SPA'.freeze,
  LANGUAGE_CODE_SWE = 'SWE'.freeze,
  LANGUAGE_CODE_TUR = 'TUR'.freeze,
  LANGUAGE_CODE_ARA = 'ARA'.freeze,
  LANGUAGE_CODE_CHI_SIM = 'CHI_SIM'.freeze,
  LANGUAGE_CODE_HIN = 'HIN'.freeze,
  LANGUAGE_CODE_JPN = 'JPN'.freeze,
  LANGUAGE_CODE_KOR = 'KOR'.freeze,
  LANGUAGE_CODE_OTHERS = 'OTHERS'.freeze,
  LANGUAGE_CODE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DetectedLanguage

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :language_code (String) —

    The value to assign to the #language_code property

  • :confidence (Float) —

    The value to assign to the #confidence property



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 77

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  self.language_code = attributes[:'languageCode'] if attributes[:'languageCode']

  raise 'You cannot provide both :languageCode and :language_code' if attributes.key?(:'languageCode') && attributes.key?(:'language_code')

  self.language_code = attributes[:'language_code'] if attributes[:'language_code']

  self.confidence = attributes[:'confidence'] if attributes[:'confidence']
end

Instance Attribute Details

#confidence ⇒ Float

[Required] The confidence score between 0 and 1.

Returns:

  • (Float) 


47
48
49
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 47

def confidence
  @confidence
end

#language_code ⇒ String

[Required] The language of the document, abbreviated according to ISO 639-2.

Returns:

  • (String) 


43
44
45
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 43

def language_code
  @language_code
end

Class Method Details

.attribute_map ⇒ Object

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



50
51
52
53
54
55
56
57
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 50

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'language_code': :'languageCode',
    'confidence': :'confidence'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'language_code': :'String',
    'confidence': :'Float'
    # rubocop:enable Style/SymbolLiteral
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • other (Object) —

    the other object to be compared



112
113
114
115
116
117
118
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 112

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

  self.class == other.class &&
    language_code == other.language_code &&
    confidence == other.confidence
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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 143

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)

  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        public_method("#{key}=").call(
          attributes[self.class.attribute_map[key]]
            .map { |v| OCI::Internal::Util.convert_to_type(Regexp.last_match(1), v) }
        )
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      public_method("#{key}=").call(
        OCI::Internal::Util.convert_to_type(type, attributes[self.class.attribute_map[key]])
      )
    end
    # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • other (Object) —

    the other object to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


123
124
125
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 123

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



132
133
134
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 132

def hash
  [language_code, confidence].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 176

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = public_method(attr).call
    next if value.nil? && !instance_variable_defined?("@#{attr}")

    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



170
171
172
 
# File 'lib/oci/ai_vision/models/detected_language.rb', line 170

def to_s
  to_hash.to_s
end