Class: OCI::GenerativeAiAgent::Models::DefaultIndexConfig

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

Overview

The default index is service managed vector store on behalf of the customer.

Constant Summary

Constants inherited from IndexConfig

IndexConfig::INDEX_CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from IndexConfig

#index_config_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from IndexConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ DefaultIndexConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 44

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

  attributes['indexConfigType'] = 'DEFAULT_INDEX_CONFIG'

  super(attributes)

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

  self.should_enable_hybrid_search = attributes[:'shouldEnableHybridSearch'] unless attributes[:'shouldEnableHybridSearch'].nil?
  self.should_enable_hybrid_search = false if should_enable_hybrid_search.nil? && !attributes.key?(:'shouldEnableHybridSearch') # rubocop:disable Style/StringLiterals

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

  self.should_enable_hybrid_search = attributes[:'should_enable_hybrid_search'] unless attributes[:'should_enable_hybrid_search'].nil?
  self.should_enable_hybrid_search = false if should_enable_hybrid_search.nil? && !attributes.key?(:'shouldEnableHybridSearch') && !attributes.key?(:'should_enable_hybrid_search') # rubocop:disable Style/StringLiterals
end

Instance Attribute Details

#should_enable_hybrid_search ⇒ BOOLEAN

Whether to enable Hybrid search in service managed OpenSearch.

Returns:

  • (BOOLEAN) 


15
16
17
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 15

def should_enable_hybrid_search
  @should_enable_hybrid_search
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 18

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'index_config_type': :'indexConfigType',
    'should_enable_hybrid_search': :'shouldEnableHybridSearch'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

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



70
71
72
73
74
75
76
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 70

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

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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 101

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


81
82
83
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 81

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



90
91
92
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 90

def hash
  [index_config_type, should_enable_hybrid_search].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 134

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



128
129
130
 
# File 'lib/oci/generative_ai_agent/models/default_index_config.rb', line 128

def to_s
  to_hash.to_s
end