Class: OCI::GenerativeAiInference::Models::GroundingMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/grounding_metadata.rb

Overview

Grounding metadata.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GroundingMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 60

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

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

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

  self.search_entry_point = attributes[:'searchEntryPoint'] if attributes[:'searchEntryPoint']

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

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

  self.grounding_chunks = attributes[:'groundingChunks'] if attributes[:'groundingChunks']

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

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

  self.grounding_supports = attributes[:'groundingSupports'] if attributes[:'groundingSupports']

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

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

Instance Attribute Details

#grounding_chunks ⇒ Array<OCI::GenerativeAiInference::Models::GroundingChunk>

Array of objects containing the web sources.

Returns:



20
21
22
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 20

def grounding_chunks
  @grounding_chunks
end

#grounding_supports ⇒ Array<OCI::GenerativeAiInference::Models::GroundingSupport>

Array of chunks to connect model response text to the sources in groundingChunks.

Returns:



24
25
26
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 24

def grounding_supports
  @grounding_supports
end

#search_entry_point ⇒ OCI::GenerativeAiInference::Models::SearchEntryPoint

Returns:



16
17
18
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 16

def search_entry_point
  @search_entry_point
end

#web_search_queries ⇒ Array<String>

The queries to be used for Search suggestions.

Returns:

  • (Array<String>) 


13
14
15
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 13

def web_search_queries
  @web_search_queries
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
34
35
36
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 27

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'web_search_queries': :'webSearchQueries',
    'search_entry_point': :'searchEntryPoint',
    'grounding_chunks': :'groundingChunks',
    'grounding_supports': :'groundingSupports'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



39
40
41
42
43
44
45
46
47
48
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 39

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'web_search_queries': :'Array<String>',
    'search_entry_point': :'OCI::GenerativeAiInference::Models::SearchEntryPoint',
    'grounding_chunks': :'Array<OCI::GenerativeAiInference::Models::GroundingChunk>',
    'grounding_supports': :'Array<OCI::GenerativeAiInference::Models::GroundingSupport>'
    # 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



98
99
100
101
102
103
104
105
106
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 98

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

  self.class == other.class &&
    web_search_queries == other.web_search_queries &&
    search_entry_point == other.search_entry_point &&
    grounding_chunks == other.grounding_chunks &&
    grounding_supports == other.grounding_supports
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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 131

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


111
112
113
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 111

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



120
121
122
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 120

def hash
  [web_search_queries, search_entry_point, grounding_chunks, grounding_supports].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 164

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



158
159
160
 
# File 'lib/oci/generative_ai_inference/models/grounding_metadata.rb', line 158

def to_s
  to_hash.to_s
end