Class: OCI::AiLanguage::Models::BatchDetectDominantLanguageDetails

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_language/models/batch_detect_dominant_language_details.rb

Overview

The documents details for language detect call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BatchDetectDominantLanguageDetails

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



80
81
82
83
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
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 80

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._alias = attributes[:'alias'] if attributes[:'alias']

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

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

  self.should_ignore_transliteration = attributes[:'shouldIgnoreTransliteration'] unless attributes[:'shouldIgnoreTransliteration'].nil?
  self.should_ignore_transliteration = false if should_ignore_transliteration.nil? && !attributes.key?(:'shouldIgnoreTransliteration') # rubocop:disable Style/StringLiterals

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

  self.should_ignore_transliteration = attributes[:'should_ignore_transliteration'] unless attributes[:'should_ignore_transliteration'].nil?
  self.should_ignore_transliteration = false if should_ignore_transliteration.nil? && !attributes.key?(:'shouldIgnoreTransliteration') && !attributes.key?(:'should_ignore_transliteration') # rubocop:disable Style/StringLiterals

  self.chars_to_consider = attributes[:'charsToConsider'] if attributes[:'charsToConsider']

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

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

  self.endpoint_id = attributes[:'endpointId'] if attributes[:'endpointId']

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

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

  self.compartment_id = attributes[:'compartmentId'] if attributes[:'compartmentId']

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

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

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

Instance Attribute Details

#_alias ⇒ String

Unique name across user tenancy in a region to identify an endpoint to be used for inferencing.

Returns:

  • (String) 


13
14
15
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 13

def _alias
  @_alias
end

#chars_to_consider ⇒ Integer

default value is None. Specifies maximum number of characters to consider for determining the dominant language. If unspecified, then optimum number characters will be considered. If 0 is specified then all the characters are used to determine the language. If the value is greater than 0, then specified number of characters will be considered from the beginning of the text.

Returns:

  • (Integer) 


26
27
28
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 26

def chars_to_consider
  @chars_to_consider
end

#compartment_id ⇒ String

The OCID of the compartment that calls the API, inference will be served from pre trained model

Returns:

  • (String) 


34
35
36
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 34

def compartment_id
  @compartment_id
end

#documents ⇒ Array<OCI::AiLanguage::Models::DominantLanguageDocument>

[Required] List of Documents for detect language.

Returns:



38
39
40
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 38

def documents
  @documents
end

#endpoint_id ⇒ String

The endpoint which have to be used for inferencing. If endpointId and compartmentId is provided, then inference will be served from custom model which is mapped to this Endpoint.

Returns:

  • (String) 


30
31
32
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 30

def endpoint_id
  @endpoint_id
end

#should_ignore_transliteration ⇒ BOOLEAN

Specifies whether to consider or ignore transliteration. For example "hi, aap kaise ho? sab kuch teek hai? I will call you tomorrow." would be detected as English when ignore transliteration=true, Hindi when ignoreTransliteration=false.

Returns:

  • (BOOLEAN) 


17
18
19
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 17

def should_ignore_transliteration
  @should_ignore_transliteration
end

Class Method Details

.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
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 41

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'alias',
    'should_ignore_transliteration': :'shouldIgnoreTransliteration',
    'chars_to_consider': :'charsToConsider',
    'endpoint_id': :'endpointId',
    'compartment_id': :'compartmentId',
    'documents': :'documents'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 55

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'String',
    'should_ignore_transliteration': :'BOOLEAN',
    'chars_to_consider': :'Integer',
    'endpoint_id': :'String',
    'compartment_id': :'String',
    'documents': :'Array<OCI::AiLanguage::Models::DominantLanguageDocument>'
    # 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



128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 128

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

  self.class == other.class &&
    _alias == other._alias &&
    should_ignore_transliteration == other.should_ignore_transliteration &&
    chars_to_consider == other.chars_to_consider &&
    endpoint_id == other.endpoint_id &&
    compartment_id == other.compartment_id &&
    documents == other.documents
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



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 163

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


143
144
145
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 143

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



152
153
154
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 152

def hash
  [_alias, should_ignore_transliteration, chars_to_consider, endpoint_id, compartment_id, documents].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



196
197
198
199
200
201
202
203
204
205
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 196

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



190
191
192
 
# File 'lib/oci/ai_language/models/batch_detect_dominant_language_details.rb', line 190

def to_s
  to_hash.to_s
end