venice_client 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +2 -0
  3. data/.openapi-generator/FILES +18 -147
  4. data/Gemfile.lock +94 -0
  5. data/README.md +10 -11
  6. data/docs/APIKeysApi.md +70 -0
  7. data/docs/AssistantMessage.md +1 -1
  8. data/docs/BillingUsageResponse.md +2 -0
  9. data/docs/CharactersApi.md +70 -0
  10. data/docs/ChatCompletionRequestVeniceParameters.md +7 -5
  11. data/docs/CreateChatCompletion200ResponseVeniceParameters.md +2 -0
  12. data/docs/DetailedError.md +20 -0
  13. data/docs/EditImageRequest.md +1 -1
  14. data/docs/EditImageRequestImage.md +15 -0
  15. data/docs/GenerateImageRequest.md +3 -1
  16. data/docs/GetApiKeyById200Response.md +18 -0
  17. data/docs/GetApiKeyById200ResponseData.md +34 -0
  18. data/docs/GetApiKeyRateLimits200Response.md +2 -0
  19. data/docs/GetBillingUsage200Response.md +2 -0
  20. data/docs/GetCharacterBySlug200Response.md +20 -0
  21. data/docs/ImageApi.md +1 -1
  22. data/docs/ListCharacters200ResponseDataInner.md +5 -1
  23. data/docs/PreviewApi.md +70 -0
  24. data/docs/StandardError.md +18 -0
  25. data/docs/ToolCallFunction.md +3 -1
  26. data/lib/venice_client/api/api_keys_api.rb +64 -1
  27. data/lib/venice_client/api/audio_api.rb +1 -1
  28. data/lib/venice_client/api/billing_api.rb +1 -1
  29. data/lib/venice_client/api/characters_api.rb +64 -1
  30. data/lib/venice_client/api/chat_api.rb +1 -1
  31. data/lib/venice_client/api/embeddings_api.rb +1 -1
  32. data/lib/venice_client/api/image_api.rb +1 -1
  33. data/lib/venice_client/api/models_api.rb +1 -1
  34. data/lib/venice_client/api/preview_api.rb +64 -1
  35. data/lib/venice_client/api/speech_api.rb +1 -1
  36. data/lib/venice_client/api_client.rb +1 -1
  37. data/lib/venice_client/api_error.rb +1 -1
  38. data/lib/venice_client/configuration.rb +1 -1
  39. data/lib/venice_client/models/assistant_message.rb +3 -4
  40. data/lib/venice_client/models/assistant_message_content.rb +1 -1
  41. data/lib/venice_client/models/audio_model_pricing.rb +1 -1
  42. data/lib/venice_client/models/audio_model_pricing_input.rb +1 -1
  43. data/lib/venice_client/models/billing_usage_request.rb +1 -1
  44. data/lib/venice_client/models/billing_usage_response.rb +12 -2
  45. data/lib/venice_client/models/chat_completion_request.rb +1 -1
  46. data/lib/venice_client/models/chat_completion_request_messages_inner.rb +1 -1
  47. data/lib/venice_client/models/chat_completion_request_response_format.rb +1 -1
  48. data/lib/venice_client/models/chat_completion_request_stop.rb +1 -1
  49. data/lib/venice_client/models/chat_completion_request_stream_options.rb +1 -1
  50. data/lib/venice_client/models/chat_completion_request_tool_choice.rb +1 -1
  51. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of.rb +1 -1
  52. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of_function.rb +1 -1
  53. data/lib/venice_client/models/chat_completion_request_venice_parameters.rb +34 -21
  54. data/lib/venice_client/models/create_api_key200_response.rb +1 -1
  55. data/lib/venice_client/models/create_api_key200_response_data.rb +1 -1
  56. data/lib/venice_client/models/create_api_key_request.rb +2 -2
  57. data/lib/venice_client/models/create_api_key_request_expires_at.rb +1 -1
  58. data/lib/venice_client/models/create_chat_completion200_response.rb +1 -1
  59. data/lib/venice_client/models/create_chat_completion200_response_choices_inner.rb +1 -1
  60. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs.rb +1 -1
  61. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner.rb +1 -1
  62. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_message.rb +1 -1
  63. data/lib/venice_client/models/create_chat_completion200_response_usage.rb +1 -1
  64. data/lib/venice_client/models/create_chat_completion200_response_venice_parameters.rb +29 -2
  65. data/lib/venice_client/models/create_chat_completion200_response_venice_parameters_web_search_citations_inner.rb +1 -1
  66. data/lib/venice_client/models/create_embedding200_response.rb +1 -1
  67. data/lib/venice_client/models/create_embedding200_response_data_inner.rb +1 -1
  68. data/lib/venice_client/models/create_embedding200_response_usage.rb +1 -1
  69. data/lib/venice_client/models/create_embedding_request_schema.rb +1 -1
  70. data/lib/venice_client/models/create_embedding_request_schema_input.rb +1 -1
  71. data/lib/venice_client/models/create_embedding_request_schema_model.rb +1 -1
  72. data/lib/venice_client/models/create_speech_request_schema.rb +1 -1
  73. data/lib/venice_client/models/delete_api_key200_response.rb +1 -1
  74. data/lib/venice_client/models/detailed_error.rb +248 -0
  75. data/lib/venice_client/models/edit_image_request.rb +2 -2
  76. data/lib/venice_client/models/edit_image_request_image.rb +104 -0
  77. data/lib/venice_client/models/generate_image200_response.rb +1 -1
  78. data/lib/venice_client/models/generate_image200_response_timing.rb +1 -1
  79. data/lib/venice_client/models/generate_image_request.rb +41 -3
  80. data/lib/venice_client/models/get_api_key_by_id200_response.rb +237 -0
  81. data/lib/venice_client/models/get_api_key_by_id200_response_data.rb +401 -0
  82. data/lib/venice_client/models/get_api_key_generate_web3_key200_response.rb +1 -1
  83. data/lib/venice_client/models/get_api_key_generate_web3_key200_response_data.rb +1 -1
  84. data/lib/venice_client/models/get_api_key_rate_limit_logs200_response.rb +1 -1
  85. data/lib/venice_client/models/get_api_key_rate_limit_logs200_response_data_inner.rb +1 -1
  86. data/lib/venice_client/models/get_api_key_rate_limits200_response.rb +12 -2
  87. data/lib/venice_client/models/get_api_key_rate_limits200_response_data.rb +1 -1
  88. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_api_tier.rb +1 -1
  89. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_balances.rb +1 -1
  90. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner.rb +1 -1
  91. data/lib/venice_client/models/get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner.rb +1 -1
  92. data/lib/venice_client/models/get_api_keys200_response.rb +1 -1
  93. data/lib/venice_client/models/get_api_keys200_response_data_inner.rb +1 -1
  94. data/lib/venice_client/models/get_api_keys200_response_data_inner_consumption_limits.rb +1 -1
  95. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage.rb +1 -1
  96. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage_trailing_seven_days.rb +1 -1
  97. data/lib/venice_client/models/get_billing_usage200_response.rb +12 -2
  98. data/lib/venice_client/models/get_billing_usage200_response_data_inner.rb +1 -1
  99. data/lib/venice_client/models/get_billing_usage200_response_data_inner_inference_details.rb +1 -1
  100. data/lib/venice_client/models/get_billing_usage200_response_pagination.rb +1 -1
  101. data/lib/venice_client/models/get_character_by_slug200_response.rb +287 -0
  102. data/lib/venice_client/models/image_model_constraints.rb +1 -1
  103. data/lib/venice_client/models/image_model_constraints_steps.rb +1 -1
  104. data/lib/venice_client/models/image_model_pricing.rb +1 -1
  105. data/lib/venice_client/models/image_model_pricing_generation.rb +1 -1
  106. data/lib/venice_client/models/image_model_pricing_upscale.rb +1 -1
  107. data/lib/venice_client/models/image_model_pricing_upscale2x.rb +1 -1
  108. data/lib/venice_client/models/image_model_pricing_upscale4x.rb +1 -1
  109. data/lib/venice_client/models/image_styles_get200_response.rb +1 -1
  110. data/lib/venice_client/models/image_url.rb +1 -1
  111. data/lib/venice_client/models/image_url_object.rb +1 -1
  112. data/lib/venice_client/models/json_object.rb +1 -1
  113. data/lib/venice_client/models/json_schema.rb +1 -1
  114. data/lib/venice_client/models/list_characters200_response.rb +1 -1
  115. data/lib/venice_client/models/list_characters200_response_data_inner.rb +45 -5
  116. data/lib/venice_client/models/list_characters200_response_data_inner_stats.rb +1 -1
  117. data/lib/venice_client/models/list_model_compatibility_mapping200_response.rb +1 -1
  118. data/lib/venice_client/models/list_model_traits200_response.rb +1 -1
  119. data/lib/venice_client/models/list_models200_response.rb +1 -1
  120. data/lib/venice_client/models/list_models200_response_type.rb +1 -1
  121. data/lib/venice_client/models/list_models_type_parameter.rb +1 -1
  122. data/lib/venice_client/models/llm_model_pricing.rb +1 -1
  123. data/lib/venice_client/models/llm_model_pricing_input.rb +1 -1
  124. data/lib/venice_client/models/llm_model_pricing_output.rb +1 -1
  125. data/lib/venice_client/models/model_response.rb +1 -1
  126. data/lib/venice_client/models/model_response_model_spec.rb +1 -1
  127. data/lib/venice_client/models/model_response_model_spec_capabilities.rb +3 -3
  128. data/lib/venice_client/models/model_response_model_spec_constraints.rb +1 -1
  129. data/lib/venice_client/models/model_response_model_spec_pricing.rb +1 -1
  130. data/lib/venice_client/models/objects_inner.rb +1 -1
  131. data/lib/venice_client/models/post_api_key_generate_web3_key_request.rb +1 -1
  132. data/lib/venice_client/models/simple_generate_image200_response.rb +1 -1
  133. data/lib/venice_client/models/simple_generate_image200_response_data_inner.rb +1 -1
  134. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of.rb +1 -1
  135. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of1.rb +1 -1
  136. data/lib/venice_client/models/simple_generate_image_request.rb +1 -1
  137. data/lib/venice_client/models/standard_error.rb +238 -0
  138. data/lib/venice_client/models/system_message.rb +1 -1
  139. data/lib/venice_client/models/system_message_content.rb +1 -1
  140. data/lib/venice_client/models/text.rb +1 -1
  141. data/lib/venice_client/models/text_model_constraints.rb +1 -1
  142. data/lib/venice_client/models/text_model_constraints_temperature.rb +1 -1
  143. data/lib/venice_client/models/text_model_constraints_top_p.rb +1 -1
  144. data/lib/venice_client/models/tool_call.rb +1 -1
  145. data/lib/venice_client/models/tool_call_function.rb +17 -5
  146. data/lib/venice_client/models/tool_message.rb +2 -1
  147. data/lib/venice_client/models/upscale_image_request.rb +1 -1
  148. data/lib/venice_client/models/upscale_image_request_enhance.rb +1 -1
  149. data/lib/venice_client/models/user_message.rb +1 -1
  150. data/lib/venice_client/models/user_message_content.rb +1 -1
  151. data/lib/venice_client/version.rb +2 -2
  152. data/lib/venice_client.rb +7 -11
  153. data/package-lock.json +2159 -0
  154. data/package.json +5 -0
  155. data/spec/models/detailed_error_spec.rb +42 -0
  156. data/spec/models/edit_image_request_image_spec.rb +21 -0
  157. data/spec/models/get_api_key_by_id200_response_data_spec.rb +88 -0
  158. data/spec/models/get_api_key_by_id200_response_spec.rb +36 -0
  159. data/spec/models/get_character_by_slug200_response_spec.rb +46 -0
  160. data/spec/models/standard_error_spec.rb +36 -0
  161. data/spec/spec_helper.rb +1 -1
  162. data/swagger.yaml +513 -714
  163. metadata +28 -1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -19,6 +19,69 @@ module VeniceClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # /api/v1/characters/{slug}
23
+ # This is a preview API and may change. Returns a single character by its slug.
24
+ # @param slug [String] The slug of the character to retrieve
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [GetCharacterBySlug200Response]
27
+ def get_character_by_slug(slug, opts = {})
28
+ data, _status_code, _headers = get_character_by_slug_with_http_info(slug, opts)
29
+ data
30
+ end
31
+
32
+ # /api/v1/characters/{slug}
33
+ # This is a preview API and may change. Returns a single character by its slug.
34
+ # @param slug [String] The slug of the character to retrieve
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(GetCharacterBySlug200Response, Integer, Hash)>] GetCharacterBySlug200Response data, response status code and response headers
37
+ def get_character_by_slug_with_http_info(slug, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: PreviewApi.get_character_by_slug ...'
40
+ end
41
+ # verify the required parameter 'slug' is set
42
+ if @api_client.config.client_side_validation && slug.nil?
43
+ fail ArgumentError, "Missing the required parameter 'slug' when calling PreviewApi.get_character_by_slug"
44
+ end
45
+ # resource path
46
+ local_var_path = '/characters/{slug}'.sub('{' + 'slug' + '}', CGI.escape(slug.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+
56
+ # form parameters
57
+ form_params = opts[:form_params] || {}
58
+
59
+ # http body (model)
60
+ post_body = opts[:debug_body]
61
+
62
+ # return_type
63
+ return_type = opts[:debug_return_type] || 'GetCharacterBySlug200Response'
64
+
65
+ # auth_names
66
+ auth_names = opts[:debug_auth_names] || ['BearerAuth']
67
+
68
+ new_options = opts.merge(
69
+ :operation => :"PreviewApi.get_character_by_slug",
70
+ :header_params => header_params,
71
+ :query_params => query_params,
72
+ :form_params => form_params,
73
+ :body => post_body,
74
+ :auth_names => auth_names,
75
+ :return_type => return_type
76
+ )
77
+
78
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
79
+ if @api_client.config.debugging
80
+ @api_client.config.logger.debug "API called: PreviewApi#get_character_by_slug\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
81
+ end
82
+ return data, status_code, headers
83
+ end
84
+
22
85
  # /api/v1/characters
23
86
  # This is a preview API and may change. Returns a list of characters supported in the API.
24
87
  # @param [Hash] opts the optional parameters
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module VeniceClient
17
- # The assistant message contains the response from the LLM.
17
+ # The assistant message contains the response from the LLM. Must have either content or tool_calls.
18
18
  class AssistantMessage
19
19
  attr_accessor :content
20
20
 
@@ -85,6 +85,7 @@ module VeniceClient
85
85
  Set.new([
86
86
  :'content',
87
87
  :'reasoning_content',
88
+ :'tool_calls'
88
89
  ])
89
90
  end
90
91
 
@@ -106,8 +107,6 @@ module VeniceClient
106
107
 
107
108
  if attributes.key?(:'content')
108
109
  self.content = attributes[:'content']
109
- else
110
- self.content = nil
111
110
  end
112
111
 
113
112
  if attributes.key?(:'name')
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -16,6 +16,9 @@ require 'time'
16
16
  module VeniceClient
17
17
  # The response schema for the billing usage endpoint
18
18
  class BillingUsageResponse
19
+ # A warning message to disambiguate DIEM usage from legacy DIEM (formerly VCU) usage
20
+ attr_accessor :warning_message
21
+
19
22
  attr_accessor :data
20
23
 
21
24
  attr_accessor :pagination
@@ -23,6 +26,7 @@ module VeniceClient
23
26
  # Attribute mapping from ruby-style variable name to JSON key.
24
27
  def self.attribute_map
25
28
  {
29
+ :'warning_message' => :'warningMessage',
26
30
  :'data' => :'data',
27
31
  :'pagination' => :'pagination'
28
32
  }
@@ -41,6 +45,7 @@ module VeniceClient
41
45
  # Attribute type mapping.
42
46
  def self.openapi_types
43
47
  {
48
+ :'warning_message' => :'String',
44
49
  :'data' => :'Array<GetBillingUsage200ResponseDataInner>',
45
50
  :'pagination' => :'GetBillingUsage200ResponsePagination'
46
51
  }
@@ -68,6 +73,10 @@ module VeniceClient
68
73
  h[k.to_sym] = v
69
74
  }
70
75
 
76
+ if attributes.key?(:'warning_message')
77
+ self.warning_message = attributes[:'warning_message']
78
+ end
79
+
71
80
  if attributes.key?(:'data')
72
81
  if (value = attributes[:'data']).is_a?(Array)
73
82
  self.data = value
@@ -133,6 +142,7 @@ module VeniceClient
133
142
  def ==(o)
134
143
  return true if self.equal?(o)
135
144
  self.class == o.class &&
145
+ warning_message == o.warning_message &&
136
146
  data == o.data &&
137
147
  pagination == o.pagination
138
148
  end
@@ -146,7 +156,7 @@ module VeniceClient
146
156
  # Calculates hash code according to all attributes.
147
157
  # @return [Integer] Hash code
148
158
  def hash
149
- [data, pagination].hash
159
+ [warning_message, data, pagination].hash
150
160
  end
151
161
 
152
162
  # Builds the object from hash
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,20 +3,20 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
10
10
 
11
11
  =end
12
12
 
13
- require "date"
14
- require "time"
13
+ require 'date'
14
+ require 'time'
15
15
 
16
16
  module VeniceClient
17
- # Unique parameters to Venice's API implementation.
17
+ # Unique parameters to Venice's API implementation. Customize these to control the behavior of the model.
18
18
  class ChatCompletionRequestVeniceParameters
19
- # The character slug of a public Venice character.
19
+ # The character slug of a public Venice character. Discoverable as the \"Public ID\" on the published character page.
20
20
  attr_accessor :character_slug
21
21
 
22
22
  # 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.
@@ -34,6 +34,9 @@ module VeniceClient
34
34
  # Experimental feature - When set to true, the LLM will include search results in the stream as the first emitted chunk. Defaults to false.
35
35
  attr_accessor :include_search_results_in_stream
36
36
 
37
+ # When set, search results are also surfaced in an OpenAI-compatible tool call named \"venice_web_search_documents\" to ease LangChain consumption.
38
+ attr_accessor :return_search_results_as_documents
39
+
37
40
  # Whether to include the Venice supplied system prompts along side specified system prompts. Defaults to true.
38
41
  attr_accessor :include_venice_system_prompt
39
42
 
@@ -68,7 +71,8 @@ module VeniceClient
68
71
  :'enable_web_search' => :'enable_web_search',
69
72
  :'enable_web_citations' => :'enable_web_citations',
70
73
  :'include_search_results_in_stream' => :'include_search_results_in_stream',
71
- :'include_venice_system_prompt' => :'include_venice_system_prompt',
74
+ :'return_search_results_as_documents' => :'return_search_results_as_documents',
75
+ :'include_venice_system_prompt' => :'include_venice_system_prompt'
72
76
  }
73
77
  end
74
78
 
@@ -91,13 +95,15 @@ module VeniceClient
91
95
  :'enable_web_search' => :'String',
92
96
  :'enable_web_citations' => :'Boolean',
93
97
  :'include_search_results_in_stream' => :'Boolean',
94
- :'include_venice_system_prompt' => :'Boolean',
98
+ :'return_search_results_as_documents' => :'Boolean',
99
+ :'include_venice_system_prompt' => :'Boolean'
95
100
  }
96
101
  end
97
102
 
98
103
  # List of attributes with nullable: true
99
104
  def self.openapi_nullable
100
- Set.new([])
105
+ Set.new([
106
+ ])
101
107
  end
102
108
 
103
109
  # Initializes the object
@@ -135,7 +141,7 @@ module VeniceClient
135
141
  if attributes.key?(:'enable_web_search')
136
142
  self.enable_web_search = attributes[:'enable_web_search']
137
143
  else
138
- self.enable_web_search = "off"
144
+ self.enable_web_search = 'false'
139
145
  end
140
146
 
141
147
  if attributes.key?(:'enable_web_citations')
@@ -150,6 +156,10 @@ module VeniceClient
150
156
  self.include_search_results_in_stream = false
151
157
  end
152
158
 
159
+ if attributes.key?(:'return_search_results_as_documents')
160
+ self.return_search_results_as_documents = attributes[:'return_search_results_as_documents']
161
+ end
162
+
153
163
  if attributes.key?(:'include_venice_system_prompt')
154
164
  self.include_venice_system_prompt = attributes[:'include_venice_system_prompt']
155
165
  else
@@ -160,7 +170,7 @@ module VeniceClient
160
170
  # Show invalid properties with the reasons. Usually used together with valid?
161
171
  # @return Array for valid properties with the reasons
162
172
  def list_invalid_properties
163
- warn "[DEPRECATED] the `list_invalid_properties` method is obsolete"
173
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
164
174
  invalid_properties = Array.new
165
175
  invalid_properties
166
176
  end
@@ -168,8 +178,8 @@ module VeniceClient
168
178
  # Check to see if the all the properties in the model are valid
169
179
  # @return true if the model is valid
170
180
  def valid?
171
- warn "[DEPRECATED] the `valid?` method is obsolete"
172
- enable_web_search_validator = EnumAttributeValidator.new("String", ["auto", "off", "on"])
181
+ warn '[DEPRECATED] the `valid?` method is obsolete'
182
+ enable_web_search_validator = EnumAttributeValidator.new('String', ["auto", "false", "true"])
173
183
  return false unless enable_web_search_validator.valid?(@enable_web_search)
174
184
  true
175
185
  end
@@ -177,7 +187,7 @@ module VeniceClient
177
187
  # Custom attribute writer method checking allowed values (enum).
178
188
  # @param [Object] enable_web_search Object to be assigned
179
189
  def enable_web_search=(enable_web_search)
180
- validator = EnumAttributeValidator.new("String", ["auto", "off", "on"])
190
+ validator = EnumAttributeValidator.new('String', ["auto", "false", "true"])
181
191
  unless validator.valid?(enable_web_search)
182
192
  fail ArgumentError, "invalid value for \"enable_web_search\", must be one of #{validator.allowable_values}."
183
193
  end
@@ -189,13 +199,14 @@ module VeniceClient
189
199
  def ==(o)
190
200
  return true if self.equal?(o)
191
201
  self.class == o.class &&
192
- character_slug == o.character_slug &&
193
- strip_thinking_response == o.strip_thinking_response &&
194
- disable_thinking == o.disable_thinking &&
195
- enable_web_search == o.enable_web_search &&
196
- enable_web_citations == o.enable_web_citations &&
197
- include_search_results_in_stream == o.include_search_results_in_stream &&
198
- include_venice_system_prompt == o.include_venice_system_prompt
202
+ character_slug == o.character_slug &&
203
+ strip_thinking_response == o.strip_thinking_response &&
204
+ disable_thinking == o.disable_thinking &&
205
+ enable_web_search == o.enable_web_search &&
206
+ enable_web_citations == o.enable_web_citations &&
207
+ include_search_results_in_stream == o.include_search_results_in_stream &&
208
+ return_search_results_as_documents == o.return_search_results_as_documents &&
209
+ include_venice_system_prompt == o.include_venice_system_prompt
199
210
  end
200
211
 
201
212
  # @see the `==` method
@@ -207,7 +218,7 @@ module VeniceClient
207
218
  # Calculates hash code according to all attributes.
208
219
  # @return [Integer] Hash code
209
220
  def hash
210
- [character_slug, strip_thinking_response, disable_thinking, enable_web_search, enable_web_citations, include_search_results_in_stream, include_venice_system_prompt].hash
221
+ [character_slug, strip_thinking_response, disable_thinking, enable_web_search, enable_web_citations, include_search_results_in_stream, return_search_results_as_documents, include_venice_system_prompt].hash
211
222
  end
212
223
 
213
224
  # Builds the object from hash
@@ -321,5 +332,7 @@ module VeniceClient
321
332
  value
322
333
  end
323
334
  end
335
+
324
336
  end
337
+
325
338
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -14,7 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module VeniceClient
17
- # The request body for creating a new API key. API key creation is rate limited to 20 requests per minute and a maximum of 500 active API keys per user. VCU is being deprecated in favor of Diem. Please update your API calls to use Diem instead.
17
+ # The request body for creating a new API key. API key creation is rate limited to 20 requests per minute and a maximum of 500 active API keys per user. VCU (Legacy Diem) is being deprecated in favor of tokenized Diem. Please update your API calls to use Diem instead.
18
18
  class CreateApiKeyRequest
19
19
  # The API Key type. Admin keys have full access to the API while inference keys are only able to call inference endpoints.
20
20
  attr_accessor :api_key_type
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Venice.ai API.
5
5
 
6
- The version of the OpenAPI document: 20250709.013306
6
+ The version of the OpenAPI document: 20250918.173746
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.14.0