Class: OCI::AiLanguage::Models::KeyPhraseDocumentResult

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

Overview

The document response for keyPhrases detect call.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KeyPhraseDocumentResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 79

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

  self.key_phrases = attributes[:'keyPhrases'] if attributes[:'keyPhrases']

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

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

  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']
end

Instance Attribute Details

#key ⇒ String

[Required] Document unique identifier defined by the user.

Returns:

  • (String) 


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

def key
  @key
end

#key_phrases ⇒ Array<OCI::AiLanguage::Models::KeyPhrase>

[Required] List of detected keyPhrases.

Returns:



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

def key_phrases
  @key_phrases
end

#language_code ⇒ String

[Required] Language code supported - auto : Automatically detect language - ar : Arabic - pt-BR : Brazilian Portuguese - cs : Czech - da : Danish - nl : Dutch - en : English - fi : Finnish - fr : French - fr-CA : Canadian French - de : German - it : Italian - ja : Japanese - ko : Korean - no : Norwegian - pl : Polish - ro : Romanian - zh-CN : Simplified Chinese - es : Spanish - sv : Swedish - zh-TW : Traditional Chinese - tr : Turkish - el : Greek - he : Hebrew

Returns:

  • (String) 


46
47
48
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 46

def language_code
  @language_code
end

Class Method Details

.attribute_map ⇒ Object

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



49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 49

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

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 60

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'key_phrases': :'Array<OCI::AiLanguage::Models::KeyPhrase>',
    'language_code': :'String'
    # 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



107
108
109
110
111
112
113
114
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 107

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

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 139

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


119
120
121
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 128

def hash
  [key, key_phrases, language_code].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 172

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



166
167
168
 
# File 'lib/oci/ai_language/models/key_phrase_document_result.rb', line 166

def to_s
  to_hash.to_s
end