Class: OCI::GenerativeAiAgentRuntime::Models::Trace

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

Overview

The trace that displays the internal progression, such as reasoning and actions during an execution.

This class has direct subclasses. If you are using this class as input to a service operations then you should favor using a subclass over the base class

Direct Known Subclasses

ErrorTrace, GenerationTrace, RetrievalTrace

Constant Summary collapse

TRACE_TYPE_ENUM = 
[
  TRACE_TYPE_ERROR_TRACE = 'ERROR_TRACE'.freeze,
  TRACE_TYPE_RETRIEVAL_TRACE = 'RETRIEVAL_TRACE'.freeze,
  TRACE_TYPE_GENERATION_TRACE = 'GENERATION_TRACE'.freeze,
  TRACE_TYPE_UNKNOWN_ENUM_VALUE = 'UNKNOWN_ENUM_VALUE'.freeze
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Trace

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :time_created (DateTime) —

    The value to assign to the #time_created property

  • :trace_type (String) —

    The value to assign to the #trace_type property



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

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

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

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

  self.trace_type = attributes[:'traceType'] if attributes[:'traceType']

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

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

Instance Attribute Details

#time_created ⇒ DateTime

The date and time that the trace was created in the format of an RFC3339 datetime string.

Returns:

  • (DateTime) 


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

def time_created
  @time_created
end

#trace_type ⇒ String

[Required] The type of the trace.

Returns:

  • (String) 


27
28
29
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 27

def trace_type
  @trace_type
end

Class Method Details

.attribute_map ⇒ Object

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



30
31
32
33
34
35
36
37
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 30

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'time_created': :'timeCreated',
    'trace_type': :'traceType'
    # rubocop:enable Style/SymbolLiteral
  }
end

.get_subtype(object_hash) ⇒ Object

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.



54
55
56
57
58
59
60
61
62
63
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 54

def self.get_subtype(object_hash)
  type = object_hash[:'traceType'] # rubocop:disable Style/SymbolLiteral

  return 'OCI::GenerativeAiAgentRuntime::Models::ErrorTrace' if type == 'ERROR_TRACE'
  return 'OCI::GenerativeAiAgentRuntime::Models::RetrievalTrace' if type == 'RETRIEVAL_TRACE'
  return 'OCI::GenerativeAiAgentRuntime::Models::GenerationTrace' if type == 'GENERATION_TRACE'

  # TODO: Log a warning when the subtype is not found.
  'OCI::GenerativeAiAgentRuntime::Models::Trace'
end

.swagger_types ⇒ Object

Attribute type mapping.



40
41
42
43
44
45
46
47
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 40

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'time_created': :'DateTime',
    'trace_type': :'String'
    # 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



113
114
115
116
117
118
119
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 113

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

  self.class == other.class &&
    time_created == other.time_created &&
    trace_type == other.trace_type
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



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 144

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


124
125
126
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 124

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



133
134
135
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 133

def hash
  [time_created, trace_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 177

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



171
172
173
 
# File 'lib/oci/generative_ai_agent_runtime/models/trace.rb', line 171

def to_s
  to_hash.to_s
end