Class: OCI::GenerativeAiAgentRuntime::Models::RetrievalTrace

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

Overview

The trace that displays the retrieval information.

Constant Summary

Constants inherited from Trace

Trace::TRACE_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from Trace

#key, #parent_key, #source, #time_created, #time_finished, #trace_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Trace

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ RetrievalTrace

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 73

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

  attributes['traceType'] = 'RETRIEVAL_TRACE'

  super(attributes)

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

  self.retrieval_input = attributes[:'retrievalInput'] if attributes[:'retrievalInput']

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

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

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

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

Instance Attribute Details

#citations ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::Citation>

A list of citations retrieved from data sources.

Returns:



19
20
21
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 19

def citations
  @citations
end

#retrieval_input ⇒ String

The agent's search string for getting the displayed information.

Returns:

  • (String) 


15
16
17
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 15

def retrieval_input
  @retrieval_input
end

#usage ⇒ Array<OCI::GenerativeAiAgentRuntime::Models::Usage>

Details of model and its usage.

Returns:



23
24
25
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 23

def usage
  @usage
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 26

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'key',
    'parent_key': :'parentKey',
    'source': :'source',
    'time_created': :'timeCreated',
    'time_finished': :'timeFinished',
    'trace_type': :'traceType',
    'retrieval_input': :'retrievalInput',
    'citations': :'citations',
    'usage': :'usage'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 43

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'key': :'String',
    'parent_key': :'String',
    'source': :'OCI::GenerativeAiAgentRuntime::Models::SourceDetails',
    'time_created': :'DateTime',
    'time_finished': :'DateTime',
    'trace_type': :'String',
    'retrieval_input': :'String',
    'citations': :'Array<OCI::GenerativeAiAgentRuntime::Models::Citation>',
    'usage': :'Array<OCI::GenerativeAiAgentRuntime::Models::Usage>'
    # 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



101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 101

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

  self.class == other.class &&
    key == other.key &&
    parent_key == other.parent_key &&
    source == other.source &&
    time_created == other.time_created &&
    time_finished == other.time_finished &&
    trace_type == other.trace_type &&
    retrieval_input == other.retrieval_input &&
    citations == other.citations &&
    usage == other.usage
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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 139

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


119
120
121
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 119

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



128
129
130
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 128

def hash
  [key, parent_key, source, time_created, time_finished, trace_type, retrieval_input, citations, usage].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



172
173
174
175
176
177
178
179
180
181
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 172

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



166
167
168
 
# File 'lib/oci/generative_ai_agent_runtime/models/retrieval_trace.rb', line 166

def to_s
  to_hash.to_s
end