Class: OCI::AiSpeech::Models::EntityList

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/ai_speech/models/entity_list.rb

Overview

List of entities of a given type, to be used to train a customization. Note: If multiple EntityLists are provided, a separate Customization resource will be created for each EntityList.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EntityList

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 63

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

  self.entity_type = attributes[:'entityType'] if attributes[:'entityType']

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

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

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

Instance Attribute Details

#_alias ⇒ String

Alias of existing customization or to associate with new customization created from entityList.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 15

def _alias
  @_alias
end

#entities ⇒ Array<OCI::AiSpeech::Models::Entity>

List of entities such as names, words or phrases matching the given entityType to add recognition support for

Returns:



27
28
29
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 27

def entities
  @entities
end

#entity_type ⇒ String

[Required] Entity Type

Returns:

  • (String) 


23
24
25
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 23

def entity_type
  @entity_type
end

#id ⇒ String

Entity type OCID

Returns:

  • (String) 


19
20
21
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 19

def id
  @id
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'alias',
    'id': :'id',
    'entity_type': :'entityType',
    'entities': :'entities'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



42
43
44
45
46
47
48
49
50
51
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 42

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    '_alias': :'String',
    'id': :'String',
    'entity_type': :'String',
    'entities': :'Array<OCI::AiSpeech::Models::Entity>'
    # 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



93
94
95
96
97
98
99
100
101
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 93

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

  self.class == other.class &&
    _alias == other._alias &&
    id == other.id &&
    entity_type == other.entity_type &&
    entities == other.entities
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



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 126

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


106
107
108
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 106

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



115
116
117
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 115

def hash
  [_alias, id, entity_type, entities].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



159
160
161
162
163
164
165
166
167
168
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 159

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



153
154
155
 
# File 'lib/oci/ai_speech/models/entity_list.rb', line 153

def to_s
  to_hash.to_s
end