Class: OCI::GenerativeAiAgent::Models::RagToolConfig

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

Overview

The configuration for RAG Tool.

Constant Summary

Constants inherited from ToolConfig

ToolConfig::TOOL_CONFIG_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ToolConfig

#tool_config_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ToolConfig

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RagToolConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 50

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

  attributes['toolConfigType'] = 'RAG_TOOL_CONFIG'

  super(attributes)

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

  self.knowledge_base_configs = attributes[:'knowledgeBaseConfigs'] if attributes[:'knowledgeBaseConfigs']

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

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

  self.generation_llm_customization = attributes[:'generationLlmCustomization'] if attributes[:'generationLlmCustomization']

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

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

Instance Attribute Details

#generation_llm_customization ⇒ OCI::GenerativeAiAgent::Models::LlmCustomization

Returns:



18
19
20
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 18

def generation_llm_customization
  @generation_llm_customization
end

#knowledge_base_configs ⇒ Array<OCI::GenerativeAiAgent::Models::KnowledgeBaseConfig>

[Required] The KnowledgeBase configurations that this RAG Tool uses

Returns:



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

def knowledge_base_configs
  @knowledge_base_configs
end

Class Method Details

.attribute_map ⇒ Object

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



21
22
23
24
25
26
27
28
29
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 21

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_config_type': :'toolConfigType',
    'knowledge_base_configs': :'knowledgeBaseConfigs',
    'generation_llm_customization': :'generationLlmCustomization'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 32

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_config_type': :'String',
    'knowledge_base_configs': :'Array<OCI::GenerativeAiAgent::Models::KnowledgeBaseConfig>',
    'generation_llm_customization': :'OCI::GenerativeAiAgent::Models::LlmCustomization'
    # 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



80
81
82
83
84
85
86
87
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 80

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

  self.class == other.class &&
    tool_config_type == other.tool_config_type &&
    knowledge_base_configs == other.knowledge_base_configs &&
    generation_llm_customization == other.generation_llm_customization
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



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

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


92
93
94
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 92

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



101
102
103
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 101

def hash
  [tool_config_type, knowledge_base_configs, generation_llm_customization].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



145
146
147
148
149
150
151
152
153
154
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 145

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



139
140
141
 
# File 'lib/oci/generative_ai_agent/models/rag_tool_config.rb', line 139

def to_s
  to_hash.to_s
end