Class: OCI::AiLanguage::Models::InputConfiguration

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

Overview

input documents configuration by default TXT files will be processed and this behaviour will not change in future after adding new types

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InputConfiguration

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



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

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

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

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

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

Instance Attribute Details

#configuration ⇒ Hash<String, OCI::AiLanguage::Models::DocumentsConfiguration>

meta data about documents For CSV valid JSON format is :{inputColumn: "reviewDetails", rowId: "reviewId", copyColumnsToOutput: ["reviewId" "userId"] , delimiter: "," Note: In future if new file types added we will update here in documentation about input file meta data

Returns:



25
26
27
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 25

def configuration
  @configuration
end

#document_types ⇒ Array<String>

Type of documents supported for this release only TXT,CSV and one element is allowed here. for future scope this is marked as list

Returns:

  • (Array<String>) 


18
19
20
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 18

def document_types
  @document_types
end

Class Method Details

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
35
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 28

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'document_types': :'documentTypes',
    'configuration': :'configuration'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



38
39
40
41
42
43
44
45
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 38

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'document_types': :'Array<String>',
    'configuration': :'Hash<String, OCI::AiLanguage::Models::DocumentsConfiguration>'
    # 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



77
78
79
80
81
82
83
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 77

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

  self.class == other.class &&
    document_types == other.document_types &&
    configuration == other.configuration
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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 108

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


88
89
90
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 88

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



97
98
99
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 97

def hash
  [document_types, configuration].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 141

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



135
136
137
 
# File 'lib/oci/ai_language/models/input_configuration.rb', line 135

def to_s
  to_hash.to_s
end