Class: VeniceClient::ToolMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/venice_client/models/tool_message.rb

Overview

The tool message is a special message that is used to call a tool. It is not part of the conversation and is not visible to the user.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ToolMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/venice_client/models/tool_message.rb', line 97

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeniceClient::ToolMessage` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `VeniceClient::ToolMessage`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'content')
    self.content = attributes[:'content']
  else
    self.content = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.key?(:'reasoning_content')
    self.reasoning_content = attributes[:'reasoning_content']
  end

  if attributes.key?(:'role')
    self.role = attributes[:'role']
  else
    self.role = nil
  end

  if attributes.key?(:'tool_call_id')
    self.tool_call_id = attributes[:'tool_call_id']
  else
    self.tool_call_id = nil
  end

  if attributes.key?(:'tool_calls')
    if (value = attributes[:'tool_calls']).is_a?(Array)
      self.tool_calls = value
    end
  end
end

Instance Attribute Details

#content ⇒ Object

Returns the value of attribute content.



19
20
21
 
# File 'lib/venice_client/models/tool_message.rb', line 19

def content
  @content
end

#name ⇒ Object

Returns the value of attribute name.



21
22
23
 
# File 'lib/venice_client/models/tool_message.rb', line 21

def name
  @name
end

#reasoning_content ⇒ Object

Returns the value of attribute reasoning_content.



23
24
25
 
# File 'lib/venice_client/models/tool_message.rb', line 23

def reasoning_content
  @reasoning_content
end

#role ⇒ Object

Returns the value of attribute role.



25
26
27
 
# File 'lib/venice_client/models/tool_message.rb', line 25

def role
  @role
end

#tool_call_id ⇒ Object

Returns the value of attribute tool_call_id.



27
28
29
 
# File 'lib/venice_client/models/tool_message.rb', line 27

def tool_call_id
  @tool_call_id
end

#tool_calls ⇒ Object

Returns the value of attribute tool_calls.



29
30
31
 
# File 'lib/venice_client/models/tool_message.rb', line 29

def tool_calls
  @tool_calls
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/venice_client/models/tool_message.rb', line 258

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = VeniceClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/venice_client/models/tool_message.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/venice_client/models/tool_message.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'content' => :'content',
    :'name' => :'name',
    :'reasoning_content' => :'reasoning_content',
    :'role' => :'role',
    :'tool_call_id' => :'tool_call_id',
    :'tool_calls' => :'tool_calls'
  }
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



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/venice_client/models/tool_message.rb', line 234

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



88
89
90
91
92
93
 
# File 'lib/venice_client/models/tool_message.rb', line 88

def self.openapi_nullable
  Set.new([
    :'reasoning_content',
    :'tool_calls'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/venice_client/models/tool_message.rb', line 76

def self.openapi_types
  {
    :'content' => :'String',
    :'name' => :'String',
    :'reasoning_content' => :'String',
    :'role' => :'String',
    :'tool_call_id' => :'String',
    :'tool_calls' => :'Array<Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/venice_client/models/tool_message.rb', line 208

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      content == o.content &&
      name == o.name &&
      reasoning_content == o.reasoning_content &&
      role == o.role &&
      tool_call_id == o.tool_call_id &&
      tool_calls == o.tool_calls
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/venice_client/models/tool_message.rb', line 329

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


221
222
223
 
# File 'lib/venice_client/models/tool_message.rb', line 221

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



227
228
229
 
# File 'lib/venice_client/models/tool_message.rb', line 227

def hash
  [content, name, reasoning_content, role, tool_call_id, tool_calls].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/venice_client/models/tool_message.rb', line 146

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @content.nil?
    invalid_properties.push('invalid value for "content", content cannot be nil.')
  end

  if @role.nil?
    invalid_properties.push('invalid value for "role", role cannot be nil.')
  end

  if @tool_call_id.nil?
    invalid_properties.push('invalid value for "tool_call_id", tool_call_id cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



305
306
307
 
# File 'lib/venice_client/models/tool_message.rb', line 305

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/venice_client/models/tool_message.rb', line 311

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



299
300
301
 
# File 'lib/venice_client/models/tool_message.rb', line 299

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



166
167
168
169
170
171
172
173
174
 
# File 'lib/venice_client/models/tool_message.rb', line 166

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @content.nil?
  return false if @role.nil?
  role_validator = EnumAttributeValidator.new('String', ["tool"])
  return false unless role_validator.valid?(@role)
  return false if @tool_call_id.nil?
  true
end