Class: VeniceClient::ModelResponseModelSpecCapabilities

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

Overview

Text model specific capabilities.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ModelResponseModelSpecCapabilities

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 111

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `VeniceClient::ModelResponseModelSpecCapabilities` 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::ModelResponseModelSpecCapabilities`. 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?(:'optimized_for_code')
    self.optimized_for_code = attributes[:'optimized_for_code']
  else
    self.optimized_for_code = nil
  end

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

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

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

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

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

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

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

Instance Attribute Details

#optimized_for_code ⇒ Object

Is the LLM optimized for coding?



20
21
22
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 20

def optimized_for_code
  @optimized_for_code
end

#quantization ⇒ Object

The quantization type of the running model.



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

def quantization
  @quantization
end

#supports_function_calling ⇒ Object

Does the LLM model support function calling?



26
27
28
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 26

def supports_function_calling
  @supports_function_calling
end

#supports_log_probs ⇒ Object

Does the LLM model support logprobs parameter?



41
42
43
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 41

def supports_log_probs
  @supports_log_probs
end

#supports_reasoning ⇒ Object

Does the model support reasoning with <thinking> blocks of output.



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

def supports_reasoning
  @supports_reasoning
end

#supports_response_schema ⇒ Object

Does the LLM model support response schema? Only models that support function calling can support response_schema.



32
33
34
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 32

def supports_response_schema
  @supports_response_schema
end

#supports_vision ⇒ Object

Does the LLM support vision?



35
36
37
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 35

def supports_vision
  @supports_vision
end

#supports_web_search ⇒ Object

Does the LLM model support web search?



38
39
40
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 38

def supports_web_search
  @supports_web_search
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



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 365

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



80
81
82
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 80

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



85
86
87
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 85

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 66

def self.attribute_map
  {
    :'optimized_for_code' => :'optimizedForCode',
    :'quantization' => :'quantization',
    :'supports_function_calling' => :'supportsFunctionCalling',
    :'supports_reasoning' => :'supportsReasoning',
    :'supports_response_schema' => :'supportsResponseSchema',
    :'supports_vision' => :'supportsVision',
    :'supports_web_search' => :'supportsWebSearch',
    :'supports_log_probs' => :'supportsLogProbs'
  }
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



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 341

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



104
105
106
107
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 104

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 90

def self.openapi_types
  {
    :'optimized_for_code' => :'Boolean',
    :'quantization' => :'String',
    :'supports_function_calling' => :'Boolean',
    :'supports_reasoning' => :'Boolean',
    :'supports_response_schema' => :'Boolean',
    :'supports_vision' => :'Boolean',
    :'supports_web_search' => :'Boolean',
    :'supports_log_probs' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      optimized_for_code == o.optimized_for_code &&
      quantization == o.quantization &&
      supports_function_calling == o.supports_function_calling &&
      supports_reasoning == o.supports_reasoning &&
      supports_response_schema == o.supports_response_schema &&
      supports_vision == o.supports_vision &&
      supports_web_search == o.supports_web_search &&
      supports_log_probs == o.supports_log_probs
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



436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 436

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


328
329
330
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 328

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



334
335
336
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 334

def hash
  [optimized_for_code, quantization, supports_function_calling, supports_reasoning, supports_response_schema, supports_vision, supports_web_search, supports_log_probs].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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 176

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

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

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

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

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

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

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

  if @supports_log_probs.nil?
    invalid_properties.push('invalid value for "supports_log_probs", supports_log_probs 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



412
413
414
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 412

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



418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 418

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



406
407
408
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 406

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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/venice_client/models/model_response_model_spec_capabilities.rb', line 216

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @optimized_for_code.nil?
  return false if @quantization.nil?
  quantization_validator = EnumAttributeValidator.new('String', ["fp8", "fp16", "bf16", "not-available"])
  return false unless quantization_validator.valid?(@quantization)
  return false if @supports_function_calling.nil?
  return false if @supports_reasoning.nil?
  return false if @supports_response_schema.nil?
  return false if @supports_vision.nil?
  return false if @supports_web_search.nil?
  return false if @supports_log_probs.nil?
  true
end