Class: OCI::GenerativeAiInference::Models::FunctionDefinition

Inherits:
ToolDefinition
  • Object
show all
Defined in:
lib/oci/generative_ai_inference/models/function_definition.rb

Overview

A function the model may call.

Constant Summary

Constants inherited from ToolDefinition

ToolDefinition::TYPE_ENUM

Instance Attribute Summary collapse

Attributes inherited from ToolDefinition

#type

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ToolDefinition

get_subtype

Constructor Details

#initialize(attributes = {}) ⇒ FunctionDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Options Hash (attributes):

  • :name (String) —

    The value to assign to the #name property

  • :description (String) —

    The value to assign to the #description property

  • :parameters (Object) —

    The value to assign to the #parameters property



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 57

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

  attributes['type'] = 'FUNCTION'

  super(attributes)

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

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

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

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

Instance Attribute Details

#description ⇒ String

A description of what the function does, used by the model to choose when and how to call the function.

Returns:

  • (String) 


18
19
20
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 18

def description
  @description
end

#name ⇒ String

The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

Returns:

  • (String) 


14
15
16
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 14

def name
  @name
end

#parameters ⇒ Object

The parameters the functions accepts, described as a JSON Schema object. Omitting parameters defines a function with an empty parameter list.

Returns:

  • (Object) 


22
23
24
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 22

def parameters
  @parameters
end

Class Method Details

.attribute_map ⇒ Object

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



25
26
27
28
29
30
31
32
33
34
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 25

def self.attribute_map
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'type',
    'name': :'name',
    'description': :'description',
    'parameters': :'parameters'
    # rubocop:enable Style/SymbolLiteral
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 37

def self.swagger_types
  {
    # rubocop:disable Style/SymbolLiteral
    'type': :'String',
    'name': :'String',
    'description': :'String',
    'parameters': :'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



81
82
83
84
85
86
87
88
89
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 81

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

  self.class == other.class &&
    type == other.type &&
    name == other.name &&
    description == other.description &&
    parameters == other.parameters
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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 114

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


94
95
96
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 94

def eql?(other)
  self == other
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



103
104
105
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 103

def hash
  [type, name, description, parameters].hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



147
148
149
150
151
152
153
154
155
156
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 147

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



141
142
143
 
# File 'lib/oci/generative_ai_inference/models/function_definition.rb', line 141

def to_s
  to_hash.to_s
end