Class: OCI::GenerativeAiAgentRuntime::Models::GenericToolOutput

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

Overview

Specifies an output format for tools that return freeform or unstructured JSON content.

Constant Summary

Constants inherited from ToolOutput

ToolOutput::TOOL_OUTPUT_TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ToolOutput

#tool_id, #tool_name, #tool_output_type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ToolOutput

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ GenericToolOutput

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :tool_id (String) —

    The value to assign to the #tool_id proprety

  • :tool_name (String) —

    The value to assign to the #tool_name proprety

  • :output (Object) —

    The value to assign to the #output property



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

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

  attributes['toolOutputType'] = 'GENERIC_TOOL_OUTPUT'

  super(attributes)

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

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

Instance Attribute Details

#output ⇒ Object

[Required] Specifies the freeform JSON object containing the toolu2019s output.

Returns:

  • (Object) 


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

def output
  @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
27
 
# File 'lib/oci/generative_ai_agent_runtime/models/generic_tool_output.rb', line 18

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_id': :'toolId',
    'tool_name': :'toolName',
    'tool_output_type': :'toolOutputType',
    'output': :'output'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_id': :'String',
    'tool_name': :'String',
    'tool_output_type': :'String',
    'output': :'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



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

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

  self.class == other.class &&
    tool_id == other.tool_id &&
    tool_name == other.tool_name &&
    tool_output_type == other.tool_output_type &&
    output == other.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/generic_tool_output.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/generic_tool_output.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/generic_tool_output.rb', line 92

def hash
  [tool_id, tool_name, tool_output_type, 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/generic_tool_output.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/generic_tool_output.rb', line 130

def to_s
  to_hash.to_s
end