Class: OCI::GenerativeAiAgent::Models::IndexConfig

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

Overview

The index configuration of Knowledge bases.

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

Constant Summary collapse

INDEX_CONFIG_TYPE_ENUM = 
[
  INDEX_CONFIG_TYPE_DEFAULT_INDEX_CONFIG = 'DEFAULT_INDEX_CONFIG'.freeze,
  INDEX_CONFIG_TYPE_OCI_OPEN_SEARCH_INDEX_CONFIG = 'OCI_OPEN_SEARCH_INDEX_CONFIG'.freeze,
  INDEX_CONFIG_TYPE_OCI_DATABASE_CONFIG = 'OCI_DATABASE_CONFIG'.freeze,
  INDEX_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 = {}) ⇒ IndexConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 72

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

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

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

Instance Attribute Details

#index_config_type ⇒ String

[Required] The type of index. The allowed values are: - DEFAULT_INDEX_CONFIG: DefaultIndexConfig allows the service to create and manage vector store on behalf of the customer. - OCI_OPEN_SEARCH_INDEX_CONFIG: OciOpenSearchIndexConfig allows customer to configure their OpenSearch cluster. - OCI_DATABASE_CONFIG: OciDatabaseConfig allows customer to configure their Database.

Returns:

  • (String) 


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

def index_config_type
  @index_config_type
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'index_config_type': :'indexConfigType'
    # 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.



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

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

  return 'OCI::GenerativeAiAgent::Models::DefaultIndexConfig' if type == 'DEFAULT_INDEX_CONFIG'
  return 'OCI::GenerativeAiAgent::Models::OciDatabaseConfig' if type == 'OCI_DATABASE_CONFIG'
  return 'OCI::GenerativeAiAgent::Models::OciOpenSearchIndexConfig' if type == 'OCI_OPEN_SEARCH_INDEX_CONFIG'

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

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 40

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



105
106
107
108
109
110
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 105

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

  self.class == other.class &&
    index_config_type == other.index_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



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 135

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


115
116
117
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 115

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



124
125
126
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 124

def hash
  [index_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



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 168

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



162
163
164
 
# File 'lib/oci/generative_ai_agent/models/index_config.rb', line 162

def to_s
  to_hash.to_s
end