Class: OCI::AiSpeech::Models::EntityListDataset

Inherits:
CustomizationDatasetDetails show all
Defined in:
lib/oci/ai_speech/models/entity_list_dataset.rb

Overview

Entity List Dataset

Constant Summary

Constants inherited from CustomizationDatasetDetails

CustomizationDatasetDetails::DATASET_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from CustomizationDatasetDetails

#dataset_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from CustomizationDatasetDetails

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ EntityListDataset

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 52

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

  attributes['datasetType'] = 'ENTITY_LIST'

  super(attributes)

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

  self.reference_examples = attributes[:'referenceExamples'] if attributes[:'referenceExamples']

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

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

  self.entity_list = attributes[:'entityList'] if attributes[:'entityList']

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

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

Instance Attribute Details

#entity_list ⇒ Array<OCI::AiSpeech::Models::EntityList>

Array of entityLists

Returns:



20
21
22
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 20

def entity_list
  @entity_list
end

#reference_examples ⇒ Array<String>

List of sentences referencing 1 or more entityType matching those defined in the linked entityLists, used to improve accuracy by providing model training context of where/how an entity may appear in a sentence. EntityTypes referenced in sentences should be written in all caps surrounded by angled braces (i.e "<PATIENT>" if entityType=patient)

Returns:

  • (Array<String>) 


16
17
18
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 16

def reference_examples
  @reference_examples
end

Class Method Details

.attribute_map ⇒ Object

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



23
24
25
26
27
28
29
30
31
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 23

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'dataset_type': :'datasetType',
    'reference_examples': :'referenceExamples',
    'entity_list': :'entityList'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 34

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'dataset_type': :'String',
    'reference_examples': :'Array<String>',
    'entity_list': :'Array<OCI::AiSpeech::Models::EntityList>'
    # 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



82
83
84
85
86
87
88
89
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 82

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

  self.class == other.class &&
    dataset_type == other.dataset_type &&
    reference_examples == other.reference_examples &&
    entity_list == other.entity_list
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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 114

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


94
95
96
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 94

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 103

def hash
  [dataset_type, reference_examples, entity_list].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 147

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



141
142
143
 
# File 'lib/oci/ai_speech/models/entity_list_dataset.rb', line 141

def to_s
  to_hash.to_s
end