Class: VeniceClient::ChatCompletionRequestVeniceParameters

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

Overview

Unique parameters to Venice’s API implementation. Customize these to control the behavior of the model.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ChatCompletionRequestVeniceParameters

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
 
# File 'lib/venice_client/models/chat_completion_request_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::ChatCompletionRequestVeniceParameters` 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::ChatCompletionRequestVeniceParameters`. 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?(:'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 = false
  end

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

  if attributes.key?(:'enable_web_search')
    self.enable_web_search = attributes[:'enable_web_search']
  else
    self.enable_web_search = 'off'
  end

  if attributes.key?(:'enable_web_scraping')
    self.enable_web_scraping = attributes[:'enable_web_scraping']
  else
    self.enable_web_scraping = false
  end

  if attributes.key?(:'enable_web_citations')
    self.enable_web_citations = attributes[:'enable_web_citations']
  else
    self.enable_web_citations = false
  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 = false
  end

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

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

Instance Attribute Details

#character_slug ⇒ Object

The character slug of a public Venice character. Discoverable as the "Public ID" on the published character page.



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

def character_slug
  @character_slug
end

#disable_thinking ⇒ Object

On supported reasoning models, will disable thinking and strip the <think></think> blocks from the response. Defaults to false.



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

def disable_thinking
  @disable_thinking
end

#enable_web_citations ⇒ Object

When web search is enabled, this will request that the LLM cite its sources using a ^index^ or ^i,j^ superscript format (e.g., ^1^). Defaults to false.



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

def enable_web_citations
  @enable_web_citations
end

#enable_web_scraping ⇒ Object

Enable Venice web scraping of URLs in the latest user message using Firecrawl. Off by default.



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

def enable_web_scraping
  @enable_web_scraping
end

#enable_web_search ⇒ Object

Enable web search for this request. Defaults to off. On will force web search on the request. Auto will enable it based on the model’s discretion. Citations will be returned either in the first chunk of a streaming result, or in the non streaming response.



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

def enable_web_search
  @enable_web_search
end

#include_search_results_in_stream ⇒ Object

Experimental feature - When set to true, the LLM will include search results in the stream as the first emitted chunk. Defaults to false.



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

def include_search_results_in_stream
  @include_search_results_in_stream
end

#include_venice_system_prompt ⇒ Object

Whether to include the Venice supplied system prompts along side specified system prompts. Defaults to true.



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

def include_venice_system_prompt
  @include_venice_system_prompt
end

#return_search_results_as_documents ⇒ Object

When set, search results are also surfaced in an OpenAI-compatible tool call named "venice_web_search_documents" to ease LangChain consumption.



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

def return_search_results_as_documents
  @return_search_results_as_documents
end

#strip_thinking_response ⇒ Object

Strip <think></think> blocks from the response. Applicable only to reasoning / thinking models. Also available to use as a model feature suffix. Defaults to false.



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

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



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
296
297
298
299
300
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 263

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/chat_completion_request_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/chat_completion_request_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/chat_completion_request_venice_parameters.rb', line 69

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



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 239

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/chat_completion_request_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/chat_completion_request_venice_parameters.rb', line 94

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 210

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



334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 334

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


226
227
228
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 226

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



232
233
234
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 232

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



183
184
185
186
187
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 183

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



310
311
312
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 310

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



316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 316

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



304
305
306
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 304

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



191
192
193
194
195
196
 
# File 'lib/venice_client/models/chat_completion_request_venice_parameters.rb', line 191

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  enable_web_search_validator = EnumAttributeValidator.new('String', ["auto", "off", "on"])
  return false unless enable_web_search_validator.valid?(@enable_web_search)
  true
end