Class: OCI::GenerativeAiAgentRuntime::Models::KnowledgeBaseMetadataSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb

Overview

Represents metadata about a field including its name, type, supported operations, and possible values.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ KnowledgeBaseMetadataSummary

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 89

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

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

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

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

  self.freeform_tags = attributes[:'freeformTags'] if attributes[:'freeformTags']

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

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

  self.defined_tags = attributes[:'definedTags'] if attributes[:'definedTags']

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

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

  self.system_tags = attributes[:'systemTags'] if attributes[:'systemTags']

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

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

Instance Attribute Details

#defined_tags ⇒ Hash<String, Hash<String, Object>>

Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"foo-namespace\": {\"bar-key\": \"value\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


38
39
40
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 38

def defined_tags
  @defined_tags
end

#freeform_tags ⇒ Hash<String, String>

Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {\"bar-key\": \"value\"}

Returns:

  • (Hash<String, String>) 


32
33
34
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 32

def freeform_tags
  @freeform_tags
end

#name ⇒ String

[Required] The name of the field

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 14

def name
  @name
end

#operations ⇒ Array<String>

[Required] List of supported operations for this field (e.g., "equals", "in", "contains")

Returns:

  • (Array<String>) 


22
23
24
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 22

def operations
  @operations
end

#system_tags ⇒ Hash<String, Hash<String, Object>>

System tags for this resource. Each key is predefined and scoped to a namespace. Example: {\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}

Returns:

  • (Hash<String, Hash<String, Object>>) 


44
45
46
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 44

def system_tags
  @system_tags
end

#type ⇒ String

[Required] The data type of the field (e.g., "array", "number", "string")

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 18

def type
  @type
end

#values ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::KnowledgeBaseMetadataValue>

[Required] List of metadata values available in the knowledge base along with the matching documents count.

Returns:



26
27
28
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 26

def values
  @values
end

Class Method Details

.attribute_map ⇒ Object

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



47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 47

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'name',
    'type': :'type',
    'operations': :'operations',
    'values': :'values',
    'freeform_tags': :'freeformTags',
    'defined_tags': :'definedTags',
    'system_tags': :'systemTags'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 62

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'name': :'String',
    'type': :'String',
    'operations': :'Array<String>',
    'values': :'Array<OCI::GenerativeAiAgentRuntime::Models::KnowledgeBaseMetadataValue>',
    'freeform_tags': :'Hash<String, String>',
    'defined_tags': :'Hash<String, Hash<String, Object>>',
    'system_tags': :'Hash<String, Hash<String, Object>>'
    # 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



129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 129

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

  self.class == other.class &&
    name == other.name &&
    type == other.type &&
    operations == other.operations &&
    values == other.values &&
    freeform_tags == other.freeform_tags &&
    defined_tags == other.defined_tags &&
    system_tags == other.system_tags
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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 165

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


145
146
147
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



154
155
156
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 154

def hash
  [name, type, operations, values, freeform_tags, defined_tags, system_tags].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



198
199
200
201
202
203
204
205
206
207
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 198

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



192
193
194
 
# File 'lib/oci/generative_ai_agent_runtime/models/knowledge_base_metadata_summary.rb', line 192

def to_s
  to_hash.to_s
end