Class: OCI::GenerativeAiAgent::Models::DataSourceConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent/models/data_source_config.rb

Overview

The details of data source.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

OciObjectStorageDataSourceConfig

Constant Summary collapse

DATA_SOURCE_CONFIG_TYPE_ENUM = 
[
  DATA_SOURCE_CONFIG_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'.freeze,
  DATA_SOURCE_CONFIG_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DataSourceConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 73

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.should_enable_multi_modality = attributes[:'shouldEnableMultiModality'] unless attributes[:'shouldEnableMultiModality'].nil?
  self.should_enable_multi_modality = true if should_enable_multi_modality.nil? && !attributes.key?(:'shouldEnableMultiModality') # rubocop:disable Style/StringLiterals

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

  self.should_enable_multi_modality = attributes[:'should_enable_multi_modality'] unless attributes[:'should_enable_multi_modality'].nil?
  self.should_enable_multi_modality = true if should_enable_multi_modality.nil? && !attributes.key?(:'shouldEnableMultiModality') && !attributes.key?(:'should_enable_multi_modality') # rubocop:disable Style/StringLiterals

  self.data_source_config_type = attributes[:'dataSourceConfigType'] if attributes[:'dataSourceConfigType']

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

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

Instance Attribute Details

#data_source_config_type ⇒ String

[Required] The type of the tool. The allowed values are: - OCI_OBJECT_STORAGE: The data source is OCI Object Storage.

Returns:

  • (String) 


28
29
30
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 28

def data_source_config_type
  @data_source_config_type
end

#should_enable_multi_modality ⇒ BOOLEAN

Flag to enable or disable multi modality such as image processing while ingestion of data. True enable the processing and false exclude the multi modality contents during ingestion.

Returns:

  • (BOOLEAN) 


21
22
23
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 21

def should_enable_multi_modality
  @should_enable_multi_modality
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 31

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'should_enable_multi_modality': :'shouldEnableMultiModality',
    'data_source_config_type': :'dataSourceConfigType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



55
56
57
58
59
60
61
62
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 55

def self.get_subtype(object_hash)
  type = object_hash[:'dataSourceConfigType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::GenerativeAiAgent::Models::OciObjectStorageDataSourceConfig' if type == 'OCI_OBJECT_STORAGE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::GenerativeAiAgent::Models::DataSourceConfig'
end

.swagger_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 41

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'should_enable_multi_modality': :'BOOLEAN',
    'data_source_config_type': :'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



114
115
116
117
118
119
120
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 114

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

  self.class == other.class &&
    should_enable_multi_modality == other.should_enable_multi_modality &&
    data_source_config_type == other.data_source_config_type
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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 145

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


125
126
127
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 125

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



134
135
136
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 134

def hash
  [should_enable_multi_modality, data_source_config_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 178

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



172
173
174
 
# File 'lib/oci/generative_ai_agent/models/data_source_config.rb', line 172

def to_s
  to_hash.to_s
end