Class: OCI::GenerativeAiAgentRuntime::Models::ToolOutput

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

Overview

Base schema for tool outputs. Identified by toolOutputType, which determines the format of the output content.

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

GenericToolOutput, RagToolOutput, SqlToolOutput

Constant Summary collapse

TOOL_OUTPUT_TYPE_ENUM = 
[
  TOOL_OUTPUT_TYPE_GENERIC_TOOL_OUTPUT = 'GENERIC_TOOL_OUTPUT'.freeze,
  TOOL_OUTPUT_TYPE_SQL_TOOL_OUTPUT = 'SQL_TOOL_OUTPUT'.freeze,
  TOOL_OUTPUT_TYPE_RAG_TOOL_OUTPUT = 'RAG_TOOL_OUTPUT'.freeze,
  TOOL_OUTPUT_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 = {}) ⇒ ToolOutput

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 property

  • :tool_name (String) —

    The value to assign to the #tool_name property

  • :tool_output_type (String) —

    The value to assign to the #tool_output_type property



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 81

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

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

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

  self.tool_name = attributes[:'toolName'] if attributes[:'toolName']

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

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

  self.tool_output_type = attributes[:'toolOutputType'] if attributes[:'toolOutputType']

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

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

Instance Attribute Details

#tool_id ⇒ String

[Required] Specifies the unique OCID of the tool.

Returns:

  • (String) 


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

def tool_id
  @tool_id
end

#tool_name ⇒ String

Specifies the display name of the tool.

Returns:

  • (String) 


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

def tool_name
  @tool_name
end

#tool_output_type ⇒ String

[Required] Specifies the type of tool output (e.g., GENERIC_TOOL_OUTPUT, SQL_TOOL_OUTPUT).

Returns:

  • (String) 


31
32
33
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 31

def tool_output_type
  @tool_output_type
end

Class Method Details

.attribute_map ⇒ Object

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



34
35
36
37
38
39
40
41
42
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 34

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'tool_id': :'toolId',
    'tool_name': :'toolName',
    'tool_output_type': :'toolOutputType'
    # 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.



60
61
62
63
64
65
66
67
68
69
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 60

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

  return 'OCI::GenerativeAiAgentRuntime::Models::GenericToolOutput' if type == 'GENERIC_TOOL_OUTPUT'
  return 'OCI::GenerativeAiAgentRuntime::Models::SqlToolOutput' if type == 'SQL_TOOL_OUTPUT'
  return 'OCI::GenerativeAiAgentRuntime::Models::RagToolOutput' if type == 'RAG_TOOL_OUTPUT'

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

.swagger_types ⇒ Object

Attribute type mapping.



45
46
47
48
49
50
51
52
53
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 45

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



126
127
128
129
130
131
132
133
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 126

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
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



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 158

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


138
139
140
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 138

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



147
148
149
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 147

def hash
  [tool_id, tool_name, tool_output_type].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 191

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



185
186
187
 
# File 'lib/oci/generative_ai_agent_runtime/models/tool_output.rb', line 185

def to_s
  to_hash.to_s
end