Class: OCI::GenerativeAiAgentRuntime::Models::FunctionCallingPerformedAction

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

Overview

Represents an action for recording the result of a function call.

Constant Summary

Constants inherited from PerformedAction

PerformedAction::PERFORMED_ACTION_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from PerformedAction

#action_id, #performed_action_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerformedAction

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ FunctionCallingPerformedAction

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :action_id (String) —

    The value to assign to the #action_id proprety

  • :function_call_output (String) —

    The value to assign to the #function_call_output property



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

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

  attributes['performedActionType'] = 'FUNCTION_CALLING_PERFORMED_ACTION'

  super(attributes)

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

  self.function_call_output = attributes[:'functionCallOutput'] if attributes[:'functionCallOutput']

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

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

Instance Attribute Details

#function_call_output ⇒ String

[Required] The result or output of the function call.

Returns:

  • (String) 


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

def function_call_output
  @function_call_output
end

Class Method Details

.attribute_map ⇒ Object

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



18
19
20
21
22
23
24
25
26
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 18

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'action_id': :'actionId',
    'performed_action_type': :'performedActionType',
    'function_call_output': :'functionCallOutput'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'action_id': :'String',
    'performed_action_type': :'String',
    'function_call_output': :'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



71
72
73
74
75
76
77
78
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 71

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

  self.class == other.class &&
    action_id == other.action_id &&
    performed_action_type == other.performed_action_type &&
    function_call_output == other.function_call_output
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



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 103

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


83
84
85
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 83

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



92
93
94
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 92

def hash
  [action_id, performed_action_type, function_call_output].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



136
137
138
139
140
141
142
143
144
145
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 136

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



130
131
132
 
# File 'lib/oci/generative_ai_agent_runtime/models/function_calling_performed_action.rb', line 130

def to_s
  to_hash.to_s
end