Class: VeniceClient::CreateChatCompletion200ResponseVeniceParameters

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

Overview

Unique parameters to Venice’s API implementation.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateChatCompletion200ResponseVeniceParameters

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
173
174
175
176
177
178
179
180
181
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 116

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#character_slug ⇒ Object

The character slug of a public Venice character.



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

def character_slug
  @character_slug
end

#disable_thinking ⇒ Object

Did the request disable thinking?



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

def disable_thinking
  @disable_thinking
end

#enable_web_citations ⇒ Object

Did the request enable web citations?



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

def enable_web_citations
  @enable_web_citations
end

#enable_web_search ⇒ Object

Did the request enable web search?



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

def enable_web_search
  @enable_web_search
end

#include_search_results_in_stream ⇒ Object

Did the request include search results in the stream?



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

def include_search_results_in_stream
  @include_search_results_in_stream
end

#include_venice_system_prompt ⇒ Object

Did the request include the Venice system prompt?



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

def include_venice_system_prompt
  @include_venice_system_prompt
end

#return_search_results_as_documents ⇒ Object

Did the request also return search results as a tool-call documents block?



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

def return_search_results_as_documents
  @return_search_results_as_documents
end

#strip_thinking_response ⇒ Object

Did the request strip thinking response?



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

def strip_thinking_response
  @strip_thinking_response
end

#web_search_citations ⇒ Object

Citations from web search results.



44
45
46
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 44

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



360
361
362
363
364
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
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 360

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



84
85
86
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 84

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 89

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 69

def self.attribute_map
  {
    :'enable_web_search' => :'enable_web_search',
    :'enable_web_citations' => :'enable_web_citations',
    :'include_venice_system_prompt' => :'include_venice_system_prompt',
    :'include_search_results_in_stream' => :'include_search_results_in_stream',
    :'return_search_results_as_documents' => :'return_search_results_as_documents',
    :'character_slug' => :'character_slug',
    :'strip_thinking_response' => :'strip_thinking_response',
    :'disable_thinking' => :'disable_thinking',
    :'web_search_citations' => :'web_search_citations'
  }
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



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 336

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



109
110
111
112
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 109

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

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 94

def self.openapi_types
  {
    :'enable_web_search' => :'String',
    :'enable_web_citations' => :'Boolean',
    :'include_venice_system_prompt' => :'Boolean',
    :'include_search_results_in_stream' => :'Boolean',
    :'return_search_results_as_documents' => :'Boolean',
    :'character_slug' => :'String',
    :'strip_thinking_response' => :'Boolean',
    :'disable_thinking' => :'Boolean',
    :'web_search_citations' => :'Array<CreateChatCompletion200ResponseVeniceParametersWebSearchCitationsInner>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 307

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      enable_web_search == o.enable_web_search &&
      enable_web_citations == o.enable_web_citations &&
      include_venice_system_prompt == o.include_venice_system_prompt &&
      include_search_results_in_stream == o.include_search_results_in_stream &&
      return_search_results_as_documents == o.return_search_results_as_documents &&
      character_slug == o.character_slug &&
      strip_thinking_response == o.strip_thinking_response &&
      disable_thinking == o.disable_thinking &&
      web_search_citations == o.web_search_citations
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



431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 431

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


323
324
325
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 323

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



329
330
331
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 329

def hash
  [enable_web_search, enable_web_citations, include_venice_system_prompt, include_search_results_in_stream, return_search_results_as_documents, character_slug, strip_thinking_response, disable_thinking, web_search_citations].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



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
213
214
215
216
217
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 185

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

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

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

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

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

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

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



407
408
409
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 407

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 413

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



401
402
403
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 401

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



221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb', line 221

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @enable_web_search.nil?
  enable_web_search_validator = EnumAttributeValidator.new('String', ["auto", "false", "true"])
  return false unless enable_web_search_validator.valid?(@enable_web_search)
  return false if @enable_web_citations.nil?
  return false if @include_venice_system_prompt.nil?
  return false if @include_search_results_in_stream.nil?
  return false if @return_search_results_as_documents.nil?
  return false if @strip_thinking_response.nil?
  return false if @disable_thinking.nil?
  true
end