venice_client 1.0.0 → 1.0.2

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 (586) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +39 -0
  3. data/.gitlab-ci.yml +26 -0
  4. data/.openapi-generator/FILES +395 -0
  5. data/.openapi-generator/VERSION +1 -0
  6. data/.openapi-generator-ignore +23 -0
  7. data/.rspec +2 -0
  8. data/.rubocop.yml +148 -0
  9. data/.travis.yml +11 -0
  10. data/README.md +120 -390
  11. data/Rakefile +2 -0
  12. data/docs/APIKeysApi.md +236 -89
  13. data/docs/AssistantMessage.md +26 -0
  14. data/docs/AssistantMessageContent.md +15 -0
  15. data/docs/AudioApi.md +40 -19
  16. data/docs/AudioModelPricing.md +18 -0
  17. data/docs/AudioModelPricingInput.md +22 -0
  18. data/docs/BillingApi.md +50 -29
  19. data/docs/BillingUsageRequest.md +24 -8
  20. data/docs/BillingUsageResponse.md +16 -4
  21. data/docs/CharactersApi.md +36 -14
  22. data/docs/ChatApi.md +43 -22
  23. data/docs/ChatCompletionRequest.md +66 -28
  24. data/docs/ChatCompletionRequestMessagesInner.md +28 -0
  25. data/docs/ChatCompletionRequestResponseFormat.md +49 -0
  26. data/docs/ChatCompletionRequestStop.md +15 -0
  27. data/docs/ChatCompletionRequestStreamOptions.md +14 -3
  28. data/docs/ChatCompletionRequestToolChoice.md +20 -0
  29. data/docs/ChatCompletionRequestToolChoiceAnyOf.md +20 -0
  30. data/docs/ChatCompletionRequestToolChoiceAnyOfFunction.md +18 -0
  31. data/docs/ChatCompletionRequestVeniceParameters.md +26 -8
  32. data/docs/CreateApiKey200Response.md +20 -0
  33. data/docs/CreateApiKey200ResponseData.md +28 -0
  34. data/docs/CreateApiKeyRequest.md +24 -0
  35. data/docs/CreateApiKeyRequestExpiresAt.md +15 -0
  36. data/docs/CreateChatCompletion200Response.md +32 -0
  37. data/docs/CreateChatCompletion200ResponseChoicesInner.md +26 -0
  38. data/docs/CreateChatCompletion200ResponseChoicesInnerLogprobs.md +24 -0
  39. data/docs/CreateChatCompletion200ResponseChoicesInnerLogprobsTopLogprobsInner.md +22 -0
  40. data/docs/CreateChatCompletion200ResponseChoicesInnerMessage.md +28 -0
  41. data/docs/CreateChatCompletion200ResponseUsage.md +24 -0
  42. data/docs/CreateChatCompletion200ResponseVeniceParameters.md +32 -0
  43. data/docs/CreateChatCompletion200ResponseVeniceParametersWebSearchCitationsInner.md +24 -0
  44. data/docs/CreateChatCompletion400Response.md +20 -0
  45. data/docs/CreateChatCompletion401Response.md +18 -0
  46. data/docs/CreateChatCompletion402Response.md +18 -0
  47. data/docs/CreateChatCompletion415Response.md +18 -0
  48. data/docs/CreateChatCompletion429Response.md +18 -0
  49. data/docs/CreateChatCompletion500Response.md +18 -0
  50. data/docs/CreateChatCompletion503Response.md +18 -0
  51. data/docs/CreateChatCompletion504Response.md +18 -0
  52. data/docs/CreateEmbedding200Response.md +24 -0
  53. data/docs/CreateEmbedding200ResponseDataInner.md +22 -0
  54. data/docs/CreateEmbedding200ResponseUsage.md +20 -0
  55. data/docs/CreateEmbeddingRequestSchema.md +22 -7
  56. data/docs/CreateEmbeddingRequestSchemaInput.md +15 -0
  57. data/docs/CreateEmbeddingRequestSchemaModel.md +15 -0
  58. data/docs/CreateSpeech403Response.md +18 -0
  59. data/docs/CreateSpeechRequestSchema.md +24 -8
  60. data/docs/DeleteApiKey200Response.md +18 -0
  61. data/docs/EditImageRequest.md +20 -0
  62. data/docs/EmbeddingsApi.md +44 -23
  63. data/docs/GenerateImage200Response.md +24 -0
  64. data/docs/GenerateImage200ResponseTiming.md +24 -0
  65. data/docs/GenerateImageRequest.md +44 -18
  66. data/docs/GetApiKeyGenerateWeb3Key200Response.md +20 -0
  67. data/docs/GetApiKeyGenerateWeb3Key200ResponseData.md +18 -0
  68. data/docs/GetApiKeyRateLimitLogs200Response.md +20 -0
  69. data/docs/GetApiKeyRateLimitLogs200ResponseDataInner.md +26 -0
  70. data/docs/GetApiKeyRateLimits200Response.md +18 -0
  71. data/docs/GetApiKeyRateLimits200ResponseData.md +28 -0
  72. data/docs/GetApiKeyRateLimits200ResponseDataApiTier.md +20 -0
  73. data/docs/GetApiKeyRateLimits200ResponseDataBalances.md +22 -0
  74. data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInner.md +20 -0
  75. data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInnerRateLimitsInner.md +20 -0
  76. data/docs/GetApiKeys200Response.md +20 -0
  77. data/docs/GetApiKeys200ResponseDataInner.md +34 -0
  78. data/docs/GetApiKeys200ResponseDataInnerConsumptionLimits.md +22 -0
  79. data/docs/GetApiKeys200ResponseDataInnerUsage.md +18 -0
  80. data/docs/GetApiKeys200ResponseDataInnerUsageTrailingSevenDays.md +22 -0
  81. data/docs/GetBillingUsage200Response.md +20 -0
  82. data/docs/GetBillingUsage200ResponseDataInner.md +32 -0
  83. data/docs/GetBillingUsage200ResponseDataInnerInferenceDetails.md +24 -0
  84. data/docs/GetBillingUsage200ResponsePagination.md +24 -0
  85. data/docs/ImageApi.md +198 -102
  86. data/docs/ImageModelConstraints.md +22 -0
  87. data/docs/ImageModelConstraintsSteps.md +20 -0
  88. data/docs/ImageModelPricing.md +20 -0
  89. data/docs/ImageModelPricingGeneration.md +22 -0
  90. data/docs/ImageModelPricingUpscale.md +20 -0
  91. data/docs/ImageModelPricingUpscale2x.md +22 -0
  92. data/docs/ImageModelPricingUpscale4x.md +22 -0
  93. data/docs/ImageStylesGet200Response.md +20 -0
  94. data/docs/ImageStylesGet500Response.md +18 -0
  95. data/docs/ImageURLObject.md +18 -0
  96. data/docs/ImageUrl.md +20 -0
  97. data/docs/JsonObject.md +18 -0
  98. data/docs/JsonSchema.md +20 -0
  99. data/docs/LLMModelPricing.md +20 -0
  100. data/docs/LLMModelPricingInput.md +22 -0
  101. data/docs/LLMModelPricingOutput.md +22 -0
  102. data/docs/ListCharacters200Response.md +20 -0
  103. data/docs/ListCharacters200ResponseDataInner.md +36 -0
  104. data/docs/ListCharacters200ResponseDataInnerStats.md +18 -0
  105. data/docs/ListModelCompatibilityMapping200Response.md +22 -0
  106. data/docs/ListModelTraits200Response.md +22 -0
  107. data/docs/ListModels200Response.md +22 -0
  108. data/docs/ListModels200ResponseType.md +15 -0
  109. data/docs/ListModelsTypeParameter.md +15 -0
  110. data/docs/ModelResponse.md +24 -8
  111. data/docs/ModelResponseModelSpec.md +32 -11
  112. data/docs/ModelResponseModelSpecCapabilities.md +28 -10
  113. data/docs/ModelResponseModelSpecConstraints.md +26 -0
  114. data/docs/ModelResponseModelSpecPricing.md +24 -0
  115. data/docs/ModelsApi.md +112 -49
  116. data/docs/ObjectsInner.md +49 -0
  117. data/docs/PostApiKeyGenerateWeb3KeyRequest.md +30 -0
  118. data/docs/PreviewApi.md +36 -14
  119. data/docs/SimpleGenerateImage200Response.md +20 -0
  120. data/docs/SimpleGenerateImage200ResponseDataInner.md +20 -0
  121. data/docs/SimpleGenerateImage200ResponseDataInnerAnyOf.md +18 -0
  122. data/docs/SimpleGenerateImage200ResponseDataInnerAnyOf1.md +18 -0
  123. data/docs/SimpleGenerateImageRequest.md +36 -14
  124. data/docs/SpeechApi.md +40 -19
  125. data/docs/SystemMessage.md +22 -0
  126. data/docs/SystemMessageContent.md +15 -0
  127. data/docs/Text.md +20 -0
  128. data/docs/TextModelConstraints.md +20 -0
  129. data/docs/TextModelConstraintsTemperature.md +18 -0
  130. data/docs/TextModelConstraintsTopP.md +18 -0
  131. data/docs/ToolCall.md +18 -5
  132. data/docs/ToolCallFunction.md +22 -0
  133. data/docs/ToolMessage.md +28 -0
  134. data/docs/UpscaleImageRequest.md +24 -8
  135. data/docs/UpscaleImageRequestEnhance.md +15 -0
  136. data/docs/UserMessage.md +20 -0
  137. data/docs/UserMessageContent.md +15 -0
  138. data/git_push.sh +11 -9
  139. data/lib/venice_client/api/api_keys_api.rb +122 -65
  140. data/lib/venice_client/api/audio_api.rb +26 -14
  141. data/lib/venice_client/api/billing_api.rb +46 -23
  142. data/lib/venice_client/api/characters_api.rb +20 -11
  143. data/lib/venice_client/api/chat_api.rb +28 -16
  144. data/lib/venice_client/api/embeddings_api.rb +34 -22
  145. data/lib/venice_client/api/image_api.rb +146 -119
  146. data/lib/venice_client/api/models_api.rb +62 -37
  147. data/lib/venice_client/api/preview_api.rb +20 -11
  148. data/lib/venice_client/api/speech_api.rb +26 -14
  149. data/lib/venice_client/api_client.rb +99 -94
  150. data/lib/venice_client/api_error.rb +7 -5
  151. data/lib/venice_client/configuration.rb +129 -24
  152. data/lib/venice_client/models/assistant_message.rb +304 -0
  153. data/lib/venice_client/models/assistant_message_content.rb +104 -0
  154. data/lib/venice_client/models/audio_model_pricing.rb +238 -0
  155. data/lib/venice_client/models/audio_model_pricing_input.rb +292 -0
  156. data/lib/venice_client/models/billing_usage_request.rb +99 -38
  157. data/lib/venice_client/models/billing_usage_response.rb +68 -30
  158. data/lib/venice_client/models/chat_completion_request.rb +389 -61
  159. data/lib/venice_client/models/chat_completion_request_messages_inner.rb +106 -0
  160. data/lib/venice_client/models/chat_completion_request_response_format.rb +106 -0
  161. data/lib/venice_client/models/chat_completion_request_stop.rb +105 -0
  162. data/lib/venice_client/models/chat_completion_request_stream_options.rb +43 -29
  163. data/lib/venice_client/models/chat_completion_request_tool_choice.rb +104 -0
  164. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of.rb +263 -0
  165. data/lib/venice_client/models/chat_completion_request_tool_choice_any_of_function.rb +237 -0
  166. data/lib/venice_client/models/chat_completion_request_venice_parameters.rb +63 -37
  167. data/lib/venice_client/models/{inline_response_200_8.rb → create_api_key200_response.rb} +70 -32
  168. data/lib/venice_client/models/{inline_response_200_8_data.rb → create_api_key200_response_data.rb} +92 -43
  169. data/lib/venice_client/models/{api_keys_body.rb → create_api_key_request.rb} +65 -38
  170. data/lib/venice_client/models/create_api_key_request_expires_at.rb +104 -0
  171. data/lib/venice_client/models/{inline_response_200.rb → create_chat_completion200_response.rb} +120 -42
  172. data/lib/venice_client/models/{inline_response_200_choices.rb → create_chat_completion200_response_choices_inner.rb} +82 -44
  173. data/lib/venice_client/models/{inline_response_200_logprobs.rb → create_chat_completion200_response_choices_inner_logprobs.rb} +72 -34
  174. data/lib/venice_client/models/{inline_response_200_logprobs_top_logprobs.rb → create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner.rb} +71 -33
  175. data/lib/venice_client/models/create_chat_completion200_response_choices_inner_message.rb +104 -0
  176. data/lib/venice_client/models/{inline_response_200_usage.rb → create_chat_completion200_response_usage.rb} +83 -33
  177. data/lib/venice_client/models/{inline_response_200_venice_parameters.rb → create_chat_completion200_response_venice_parameters.rb} +131 -40
  178. data/lib/venice_client/models/{inline_response_200_venice_parameters_web_search_citations.rb → create_chat_completion200_response_venice_parameters_web_search_citations_inner.rb} +72 -34
  179. data/lib/venice_client/models/{inline_response_400.rb → create_chat_completion400_response.rb} +57 -31
  180. data/lib/venice_client/models/{inline_response_401.rb → create_chat_completion401_response.rb} +57 -31
  181. data/lib/venice_client/models/{inline_response_402.rb → create_chat_completion402_response.rb} +57 -31
  182. data/lib/venice_client/models/create_chat_completion415_response.rb +238 -0
  183. data/lib/venice_client/models/create_chat_completion429_response.rb +238 -0
  184. data/lib/venice_client/models/create_chat_completion500_response.rb +238 -0
  185. data/lib/venice_client/models/create_chat_completion503_response.rb +238 -0
  186. data/lib/venice_client/models/create_chat_completion504_response.rb +238 -0
  187. data/lib/venice_client/models/{inline_response_200_14.rb → create_embedding200_response.rb} +88 -36
  188. data/lib/venice_client/models/{inline_response_200_14_data.rb → create_embedding200_response_data_inner.rb} +75 -35
  189. data/lib/venice_client/models/{inline_response_200_14_usage.rb → create_embedding200_response_usage.rb} +70 -32
  190. data/lib/venice_client/models/create_embedding_request_schema.rb +92 -37
  191. data/lib/venice_client/models/create_embedding_request_schema_input.rb +107 -0
  192. data/lib/venice_client/models/create_embedding_request_schema_model.rb +104 -0
  193. data/lib/venice_client/models/{inline_response_403.rb → create_speech403_response.rb} +57 -31
  194. data/lib/venice_client/models/create_speech_request_schema.rb +112 -40
  195. data/lib/venice_client/models/{inline_response_200_12.rb → delete_api_key200_response.rb} +58 -46
  196. data/lib/venice_client/models/edit_image_request.rb +260 -0
  197. data/lib/venice_client/models/{inline_response_200_1.rb → generate_image200_response.rb} +83 -33
  198. data/lib/venice_client/models/{inline_response_200_1_timing.rb → generate_image200_response_timing.rb} +96 -34
  199. data/lib/venice_client/models/generate_image_request.rb +289 -46
  200. data/lib/venice_client/models/get_api_key_generate_web3_key200_response.rb +263 -0
  201. data/lib/venice_client/models/{inline_response_200_12_data.rb → get_api_key_generate_web3_key200_response_data.rb} +57 -31
  202. data/lib/venice_client/models/{inline_response_200_13.rb → get_api_key_rate_limit_logs200_response.rb} +63 -34
  203. data/lib/venice_client/models/{inline_response_200_11_data.rb → get_api_key_rate_limit_logs200_response_data_inner.rb} +107 -35
  204. data/lib/venice_client/models/{inline_response_200_10.rb → get_api_key_rate_limits200_response.rb} +57 -31
  205. data/lib/venice_client/models/{inline_response_200_10_data.rb → get_api_key_rate_limits200_response_data.rb} +112 -41
  206. data/lib/venice_client/models/{inline_response_200_10_data_api_tier.rb → get_api_key_rate_limits200_response_data_api_tier.rb} +71 -33
  207. data/lib/venice_client/models/{inline_response_200_10_data_balances.rb → get_api_key_rate_limits200_response_data_balances.rb} +60 -36
  208. data/lib/venice_client/models/{inline_response_200_10_data_rate_limits_1.rb → get_api_key_rate_limits200_response_data_rate_limits_inner.rb} +58 -32
  209. data/lib/venice_client/models/{inline_response_200_10_data_rate_limits.rb → get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner.rb} +70 -32
  210. data/lib/venice_client/models/{inline_response_200_7.rb → get_api_keys200_response.rb} +62 -34
  211. data/lib/venice_client/models/{inline_response_200_7_data.rb → get_api_keys200_response_data_inner.rb} +99 -56
  212. data/lib/venice_client/models/get_api_keys200_response_data_inner_consumption_limits.rb +287 -0
  213. data/lib/venice_client/models/{inline_response_200_7_usage.rb → get_api_keys200_response_data_inner_usage.rb} +57 -31
  214. data/lib/venice_client/models/get_api_keys200_response_data_inner_usage_trailing_seven_days.rb +292 -0
  215. data/lib/venice_client/models/{inline_response_200_15.rb → get_billing_usage200_response.rb} +70 -32
  216. data/lib/venice_client/models/{billing_usage_response_data.rb → get_billing_usage200_response_data_inner.rb} +131 -45
  217. data/lib/venice_client/models/{billing_usage_response_inference_details.rb → get_billing_usage200_response_data_inner_inference_details.rb} +56 -54
  218. data/lib/venice_client/models/{billing_usage_response_pagination.rb → get_billing_usage200_response_pagination.rb} +96 -34
  219. data/lib/venice_client/models/image_model_constraints.rb +292 -0
  220. data/lib/venice_client/models/image_model_constraints_steps.rb +265 -0
  221. data/lib/venice_client/models/image_model_pricing.rb +264 -0
  222. data/lib/venice_client/models/image_model_pricing_generation.rb +292 -0
  223. data/lib/venice_client/models/image_model_pricing_upscale.rb +263 -0
  224. data/lib/venice_client/models/image_model_pricing_upscale2x.rb +292 -0
  225. data/lib/venice_client/models/image_model_pricing_upscale4x.rb +292 -0
  226. data/lib/venice_client/models/{inline_response_200_3.rb → image_styles_get200_response.rb} +62 -34
  227. data/lib/venice_client/models/{inline_response_415.rb → image_styles_get500_response.rb} +57 -31
  228. data/lib/venice_client/models/image_url.rb +288 -0
  229. data/lib/venice_client/models/{inline_response_200_7_usage_trailing_seven_days.rb → image_url_object.rb} +68 -56
  230. data/lib/venice_client/models/json_object.rb +262 -0
  231. data/lib/venice_client/models/json_schema.rb +290 -0
  232. data/lib/venice_client/models/{inline_response_200_11.rb → list_characters200_response.rb} +62 -35
  233. data/lib/venice_client/models/{inline_response_200_13_data.rb → list_characters200_response_data_inner.rb} +154 -50
  234. data/lib/venice_client/models/{inline_response_200_13_stats.rb → list_characters200_response_data_inner_stats.rb} +57 -31
  235. data/lib/venice_client/models/{inline_response_200_6.rb → list_model_compatibility_mapping200_response.rb} +79 -37
  236. data/lib/venice_client/models/{inline_response_200_5.rb → list_model_traits200_response.rb} +79 -37
  237. data/lib/venice_client/models/{inline_response_200_4.rb → list_models200_response.rb} +75 -36
  238. data/lib/venice_client/models/list_models200_response_type.rb +104 -0
  239. data/lib/venice_client/models/list_models_type_parameter.rb +104 -0
  240. data/lib/venice_client/models/llm_model_pricing.rb +264 -0
  241. data/lib/venice_client/models/llm_model_pricing_input.rb +292 -0
  242. data/lib/venice_client/models/llm_model_pricing_output.rb +292 -0
  243. data/lib/venice_client/models/model_response.rb +84 -40
  244. data/lib/venice_client/models/model_response_model_spec.rb +62 -40
  245. data/lib/venice_client/models/model_response_model_spec_capabilities.rb +138 -38
  246. data/lib/venice_client/models/model_response_model_spec_constraints.rb +105 -0
  247. data/lib/venice_client/models/model_response_model_spec_pricing.rb +106 -0
  248. data/lib/venice_client/models/objects_inner.rb +105 -0
  249. data/lib/venice_client/models/{api_keys_generate_web3_key_body.rb → post_api_key_generate_web3_key_request.rb} +91 -40
  250. data/lib/venice_client/models/{inline_response_200_2.rb → simple_generate_image200_response.rb} +73 -35
  251. data/lib/venice_client/models/simple_generate_image200_response_data_inner.rb +104 -0
  252. data/lib/venice_client/models/simple_generate_image200_response_data_inner_any_of.rb +238 -0
  253. data/lib/venice_client/models/{api_keys_consumption_limit.rb → simple_generate_image200_response_data_inner_any_of1.rb} +67 -57
  254. data/lib/venice_client/models/simple_generate_image_request.rb +146 -54
  255. data/lib/venice_client/models/system_message.rb +297 -0
  256. data/lib/venice_client/models/system_message_content.rb +104 -0
  257. data/lib/venice_client/models/text.rb +298 -0
  258. data/lib/venice_client/models/text_model_constraints.rb +264 -0
  259. data/lib/venice_client/models/text_model_constraints_temperature.rb +238 -0
  260. data/lib/venice_client/models/text_model_constraints_top_p.rb +238 -0
  261. data/lib/venice_client/models/tool_call.rb +57 -31
  262. data/lib/venice_client/models/{chat_completion_request_function.rb → tool_call_function.rb} +59 -33
  263. data/lib/venice_client/models/tool_message.rb +344 -0
  264. data/lib/venice_client/models/upscale_image_request.rb +146 -40
  265. data/lib/venice_client/models/upscale_image_request_enhance.rb +105 -0
  266. data/lib/venice_client/models/user_message.rb +288 -0
  267. data/lib/venice_client/models/user_message_content.rb +104 -0
  268. data/lib/venice_client/version.rb +5 -4
  269. data/lib/venice_client.rb +134 -108
  270. data/openapitools.json +7 -0
  271. data/spec/api/api_keys_api_spec.rb +43 -41
  272. data/spec/api/audio_api_spec.rb +18 -16
  273. data/spec/api/billing_api_spec.rb +23 -21
  274. data/spec/api/characters_api_spec.rb +17 -15
  275. data/spec/api/chat_api_spec.rb +19 -17
  276. data/spec/api/embeddings_api_spec.rb +19 -17
  277. data/spec/api/image_api_spec.rb +43 -46
  278. data/spec/api/models_api_spec.rb +28 -26
  279. data/spec/api/preview_api_spec.rb +17 -15
  280. data/spec/api/speech_api_spec.rb +18 -16
  281. data/spec/models/assistant_message_content_spec.rb +21 -0
  282. data/spec/models/assistant_message_spec.rb +64 -0
  283. data/spec/models/audio_model_pricing_input_spec.rb +48 -0
  284. data/spec/models/audio_model_pricing_spec.rb +36 -0
  285. data/spec/models/billing_usage_request_spec.rb +19 -23
  286. data/spec/models/billing_usage_response_spec.rb +12 -16
  287. data/spec/models/chat_completion_request_messages_inner_spec.rb +21 -0
  288. data/spec/models/chat_completion_request_response_format_spec.rb +32 -0
  289. data/spec/models/chat_completion_request_spec.rb +74 -71
  290. data/spec/models/chat_completion_request_stop_spec.rb +21 -0
  291. data/spec/models/chat_completion_request_stream_options_spec.rb +11 -15
  292. data/spec/models/chat_completion_request_tool_choice_any_of_function_spec.rb +36 -0
  293. data/spec/models/chat_completion_request_tool_choice_any_of_spec.rb +42 -0
  294. data/spec/models/chat_completion_request_tool_choice_spec.rb +21 -0
  295. data/spec/models/chat_completion_request_venice_parameters_spec.rb +35 -32
  296. data/spec/models/create_api_key200_response_data_spec.rb +70 -0
  297. data/spec/models/create_api_key200_response_spec.rb +42 -0
  298. data/spec/models/create_api_key_request_expires_at_spec.rb +21 -0
  299. data/spec/models/create_api_key_request_spec.rb +58 -0
  300. data/spec/models/create_chat_completion200_response_choices_inner_logprobs_spec.rb +54 -0
  301. data/spec/models/create_chat_completion200_response_choices_inner_logprobs_top_logprobs_inner_spec.rb +48 -0
  302. data/spec/models/create_chat_completion200_response_choices_inner_message_spec.rb +21 -0
  303. data/spec/models/create_chat_completion200_response_choices_inner_spec.rb +68 -0
  304. data/spec/models/create_chat_completion200_response_spec.rb +82 -0
  305. data/spec/models/create_chat_completion200_response_usage_spec.rb +54 -0
  306. data/spec/models/create_chat_completion200_response_venice_parameters_spec.rb +82 -0
  307. data/spec/models/create_chat_completion200_response_venice_parameters_web_search_citations_inner_spec.rb +54 -0
  308. data/spec/models/create_chat_completion400_response_spec.rb +42 -0
  309. data/spec/models/create_chat_completion401_response_spec.rb +36 -0
  310. data/spec/models/create_chat_completion402_response_spec.rb +36 -0
  311. data/spec/models/create_chat_completion415_response_spec.rb +36 -0
  312. data/spec/models/create_chat_completion429_response_spec.rb +36 -0
  313. data/spec/models/create_chat_completion500_response_spec.rb +36 -0
  314. data/spec/models/create_chat_completion503_response_spec.rb +36 -0
  315. data/spec/models/create_chat_completion504_response_spec.rb +36 -0
  316. data/spec/models/create_embedding200_response_data_inner_spec.rb +52 -0
  317. data/spec/models/create_embedding200_response_spec.rb +58 -0
  318. data/spec/models/create_embedding200_response_usage_spec.rb +42 -0
  319. data/spec/models/create_embedding_request_schema_input_spec.rb +21 -0
  320. data/spec/models/create_embedding_request_schema_model_spec.rb +21 -0
  321. data/spec/models/create_embedding_request_schema_spec.rb +16 -20
  322. data/spec/models/create_speech403_response_spec.rb +36 -0
  323. data/spec/models/create_speech_request_schema_spec.rb +31 -34
  324. data/spec/models/delete_api_key200_response_spec.rb +36 -0
  325. data/spec/models/edit_image_request_spec.rb +42 -0
  326. data/spec/models/generate_image200_response_spec.rb +54 -0
  327. data/spec/models/generate_image200_response_timing_spec.rb +54 -0
  328. data/spec/models/generate_image_request_spec.rb +27 -31
  329. data/spec/models/get_api_key_generate_web3_key200_response_data_spec.rb +36 -0
  330. data/spec/models/get_api_key_generate_web3_key200_response_spec.rb +42 -0
  331. data/spec/models/get_api_key_rate_limit_logs200_response_data_inner_spec.rb +60 -0
  332. data/spec/models/get_api_key_rate_limit_logs200_response_spec.rb +46 -0
  333. data/spec/models/get_api_key_rate_limits200_response_data_api_tier_spec.rb +42 -0
  334. data/spec/models/get_api_key_rate_limits200_response_data_balances_spec.rb +48 -0
  335. data/spec/models/get_api_key_rate_limits200_response_data_rate_limits_inner_rate_limits_inner_spec.rb +42 -0
  336. data/spec/models/get_api_key_rate_limits200_response_data_rate_limits_inner_spec.rb +42 -0
  337. data/spec/models/get_api_key_rate_limits200_response_data_spec.rb +66 -0
  338. data/spec/models/get_api_key_rate_limits200_response_spec.rb +36 -0
  339. data/spec/models/get_api_keys200_response_data_inner_consumption_limits_spec.rb +48 -0
  340. data/spec/models/get_api_keys200_response_data_inner_spec.rb +88 -0
  341. data/spec/models/get_api_keys200_response_data_inner_usage_spec.rb +36 -0
  342. data/spec/models/get_api_keys200_response_data_inner_usage_trailing_seven_days_spec.rb +48 -0
  343. data/spec/models/get_api_keys200_response_spec.rb +46 -0
  344. data/spec/models/get_billing_usage200_response_data_inner_inference_details_spec.rb +54 -0
  345. data/spec/models/get_billing_usage200_response_data_inner_spec.rb +82 -0
  346. data/spec/models/get_billing_usage200_response_pagination_spec.rb +54 -0
  347. data/spec/models/get_billing_usage200_response_spec.rb +42 -0
  348. data/spec/models/image_model_constraints_spec.rb +48 -0
  349. data/spec/models/image_model_constraints_steps_spec.rb +42 -0
  350. data/spec/models/image_model_pricing_generation_spec.rb +48 -0
  351. data/spec/models/image_model_pricing_spec.rb +42 -0
  352. data/spec/models/image_model_pricing_upscale2x_spec.rb +48 -0
  353. data/spec/models/image_model_pricing_upscale4x_spec.rb +48 -0
  354. data/spec/models/image_model_pricing_upscale_spec.rb +42 -0
  355. data/spec/models/image_styles_get200_response_spec.rb +46 -0
  356. data/spec/models/image_styles_get500_response_spec.rb +36 -0
  357. data/spec/models/image_url_object_spec.rb +36 -0
  358. data/spec/models/image_url_spec.rb +46 -0
  359. data/spec/models/json_object_spec.rb +40 -0
  360. data/spec/models/json_schema_spec.rb +46 -0
  361. data/spec/models/list_characters200_response_data_inner_spec.rb +90 -0
  362. data/spec/models/list_characters200_response_data_inner_stats_spec.rb +36 -0
  363. data/spec/models/list_characters200_response_spec.rb +46 -0
  364. data/spec/models/list_model_compatibility_mapping200_response_spec.rb +52 -0
  365. data/spec/models/list_model_traits200_response_spec.rb +52 -0
  366. data/spec/models/list_models200_response_spec.rb +52 -0
  367. data/spec/models/list_models200_response_type_spec.rb +21 -0
  368. data/spec/models/list_models_type_parameter_spec.rb +21 -0
  369. data/spec/models/llm_model_pricing_input_spec.rb +48 -0
  370. data/spec/models/llm_model_pricing_output_spec.rb +48 -0
  371. data/spec/models/llm_model_pricing_spec.rb +42 -0
  372. data/spec/models/model_response_model_spec_capabilities_spec.rb +33 -36
  373. data/spec/models/model_response_model_spec_constraints_spec.rb +21 -0
  374. data/spec/models/model_response_model_spec_pricing_spec.rb +21 -0
  375. data/spec/models/model_response_model_spec_spec.rb +40 -37
  376. data/spec/models/model_response_spec.rb +32 -35
  377. data/spec/models/objects_inner_spec.rb +32 -0
  378. data/spec/models/post_api_key_generate_web3_key_request_spec.rb +76 -0
  379. data/spec/models/simple_generate_image200_response_data_inner_any_of1_spec.rb +36 -0
  380. data/spec/models/simple_generate_image200_response_data_inner_any_of_spec.rb +36 -0
  381. data/spec/models/simple_generate_image200_response_data_inner_spec.rb +21 -0
  382. data/spec/models/simple_generate_image200_response_spec.rb +42 -0
  383. data/spec/models/simple_generate_image_request_spec.rb +29 -33
  384. data/spec/models/system_message_content_spec.rb +21 -0
  385. data/spec/models/system_message_spec.rb +52 -0
  386. data/spec/models/text_model_constraints_spec.rb +42 -0
  387. data/spec/models/text_model_constraints_temperature_spec.rb +36 -0
  388. data/spec/models/text_model_constraints_top_p_spec.rb +36 -0
  389. data/spec/models/text_spec.rb +46 -0
  390. data/spec/models/tool_call_function_spec.rb +48 -0
  391. data/spec/models/tool_call_spec.rb +22 -25
  392. data/spec/models/tool_message_spec.rb +70 -0
  393. data/spec/models/upscale_image_request_enhance_spec.rb +21 -0
  394. data/spec/models/upscale_image_request_spec.rb +28 -31
  395. data/spec/models/user_message_content_spec.rb +21 -0
  396. data/spec/models/user_message_spec.rb +46 -0
  397. data/spec/spec_helper.rb +7 -6
  398. data/swagger.yaml +4791 -0
  399. data/update.sh +9 -0
  400. metadata +440 -356
  401. data/docs/AnyOfChatCompletionRequestMessagesItems.md +0 -6
  402. data/docs/AnyOfChatCompletionRequestStop.md +0 -6
  403. data/docs/AnyOfChatCompletionRequestToolChoice.md +0 -6
  404. data/docs/AnyOfCreateEmbeddingRequestSchemaInput.md +0 -6
  405. data/docs/AnyOfCreateEmbeddingRequestSchemaModel.md +0 -6
  406. data/docs/AnyOfModelResponseModelSpecConstraints.md +0 -6
  407. data/docs/AnyOfModelResponseModelSpecPricing.md +0 -6
  408. data/docs/AnyOfUpscaleImageRequestEnhance.md +0 -6
  409. data/docs/AnyOfUpscaleImageRequestImage.md +0 -6
  410. data/docs/AnyOfapiKeysBodyExpiresAt.md +0 -6
  411. data/docs/AnyOfapiKeysConsumptionLimitUsd.md +0 -6
  412. data/docs/AnyOfapiKeysConsumptionLimitVcu.md +0 -6
  413. data/docs/AnyOfapiKeysGenerateWeb3KeyBodyExpiresAt.md +0 -6
  414. data/docs/AnyOfinlineResponse2002DataItems.md +0 -6
  415. data/docs/AnyOfinlineResponse2004Type.md +0 -6
  416. data/docs/AnyOfinlineResponse2005Type.md +0 -6
  417. data/docs/AnyOfinlineResponse2006Type.md +0 -6
  418. data/docs/AnyOfinlineResponse200ChoicesMessage.md +0 -6
  419. data/docs/AnyOfinlineResponse200PromptLogprobs.md +0 -6
  420. data/docs/ApiKeysBody.md +0 -10
  421. data/docs/ApiKeysConsumptionLimit.md +0 -8
  422. data/docs/ApiKeysGenerateWeb3KeyBody.md +0 -13
  423. data/docs/BillingUsageResponseData.md +0 -14
  424. data/docs/BillingUsageResponseInferenceDetails.md +0 -10
  425. data/docs/BillingUsageResponsePagination.md +0 -10
  426. data/docs/ChatCompletionRequestFunction.md +0 -9
  427. data/docs/InlineResponse200.md +0 -14
  428. data/docs/InlineResponse2001.md +0 -10
  429. data/docs/InlineResponse20010.md +0 -7
  430. data/docs/InlineResponse20010Data.md +0 -12
  431. data/docs/InlineResponse20010DataApiTier.md +0 -8
  432. data/docs/InlineResponse20010DataBalances.md +0 -8
  433. data/docs/InlineResponse20010DataRateLimits.md +0 -8
  434. data/docs/InlineResponse20010DataRateLimits1.md +0 -8
  435. data/docs/InlineResponse20011.md +0 -8
  436. data/docs/InlineResponse20011Data.md +0 -11
  437. data/docs/InlineResponse20012.md +0 -8
  438. data/docs/InlineResponse20012Data.md +0 -7
  439. data/docs/InlineResponse20013.md +0 -8
  440. data/docs/InlineResponse20013Data.md +0 -16
  441. data/docs/InlineResponse20013Stats.md +0 -7
  442. data/docs/InlineResponse20014.md +0 -10
  443. data/docs/InlineResponse20014Data.md +0 -9
  444. data/docs/InlineResponse20014Usage.md +0 -8
  445. data/docs/InlineResponse20015.md +0 -8
  446. data/docs/InlineResponse2001Timing.md +0 -10
  447. data/docs/InlineResponse2002.md +0 -8
  448. data/docs/InlineResponse2003.md +0 -8
  449. data/docs/InlineResponse2004.md +0 -9
  450. data/docs/InlineResponse2005.md +0 -9
  451. data/docs/InlineResponse2006.md +0 -9
  452. data/docs/InlineResponse2007.md +0 -8
  453. data/docs/InlineResponse2007Data.md +0 -15
  454. data/docs/InlineResponse2007Usage.md +0 -7
  455. data/docs/InlineResponse2007UsageTrailingSevenDays.md +0 -8
  456. data/docs/InlineResponse2008.md +0 -8
  457. data/docs/InlineResponse2008Data.md +0 -12
  458. data/docs/InlineResponse2009.md +0 -7
  459. data/docs/InlineResponse200Choices.md +0 -11
  460. data/docs/InlineResponse200Logprobs.md +0 -10
  461. data/docs/InlineResponse200LogprobsTopLogprobs.md +0 -9
  462. data/docs/InlineResponse200Usage.md +0 -10
  463. data/docs/InlineResponse200VeniceParameters.md +0 -13
  464. data/docs/InlineResponse200VeniceParametersWebSearchCitations.md +0 -10
  465. data/docs/InlineResponse400.md +0 -8
  466. data/docs/InlineResponse401.md +0 -7
  467. data/docs/InlineResponse402.md +0 -7
  468. data/docs/InlineResponse403.md +0 -7
  469. data/docs/InlineResponse415.md +0 -7
  470. data/docs/InlineResponse429.md +0 -7
  471. data/docs/InlineResponse500.md +0 -7
  472. data/docs/InlineResponse5001.md +0 -7
  473. data/docs/InlineResponse503.md +0 -7
  474. data/docs/ModelCompatibilitySchema.md +0 -6
  475. data/docs/ModelTraitSchema.md +0 -6
  476. data/docs/OneOfChatCompletionRequestResponseFormat.md +0 -6
  477. data/docs/Type.md +0 -6
  478. data/lib/venice_client/models/any_of_chat_completion_request_messages_items.rb +0 -197
  479. data/lib/venice_client/models/any_of_chat_completion_request_stop.rb +0 -197
  480. data/lib/venice_client/models/any_of_chat_completion_request_tool_choice.rb +0 -197
  481. data/lib/venice_client/models/any_of_create_embedding_request_schema_input.rb +0 -197
  482. data/lib/venice_client/models/any_of_create_embedding_request_schema_model.rb +0 -197
  483. data/lib/venice_client/models/any_of_model_response_model_spec_constraints.rb +0 -197
  484. data/lib/venice_client/models/any_of_model_response_model_spec_pricing.rb +0 -197
  485. data/lib/venice_client/models/any_of_upscale_image_request_enhance.rb +0 -197
  486. data/lib/venice_client/models/any_of_upscale_image_request_image.rb +0 -197
  487. data/lib/venice_client/models/any_ofapi_keys_body_expires_at.rb +0 -197
  488. data/lib/venice_client/models/any_ofapi_keys_consumption_limit_usd.rb +0 -197
  489. data/lib/venice_client/models/any_ofapi_keys_consumption_limit_vcu.rb +0 -195
  490. data/lib/venice_client/models/any_ofapi_keys_generate_web3_key_body_expires_at.rb +0 -197
  491. data/lib/venice_client/models/any_ofinline_response_200_2_data_items.rb +0 -197
  492. data/lib/venice_client/models/any_ofinline_response_200_4_type.rb +0 -197
  493. data/lib/venice_client/models/any_ofinline_response_200_5_type.rb +0 -197
  494. data/lib/venice_client/models/any_ofinline_response_200_6_type.rb +0 -197
  495. data/lib/venice_client/models/any_ofinline_response_200_choices_message.rb +0 -197
  496. data/lib/venice_client/models/any_ofinline_response_200_prompt_logprobs.rb +0 -197
  497. data/lib/venice_client/models/inline_response_200_9.rb +0 -211
  498. data/lib/venice_client/models/inline_response_429.rb +0 -212
  499. data/lib/venice_client/models/inline_response_500.rb +0 -212
  500. data/lib/venice_client/models/inline_response_500_1.rb +0 -212
  501. data/lib/venice_client/models/inline_response_503.rb +0 -212
  502. data/lib/venice_client/models/model_compatibility_schema.rb +0 -202
  503. data/lib/venice_client/models/model_trait_schema.rb +0 -200
  504. data/lib/venice_client/models/one_of_chat_completion_request_response_format.rb +0 -197
  505. data/lib/venice_client/models/type.rb +0 -198
  506. data/spec/api_client_spec.rb +0 -225
  507. data/spec/base_object_spec.rb +0 -109
  508. data/spec/configuration_spec.rb +0 -41
  509. data/spec/models/any_of_chat_completion_request_messages_items_spec.rb +0 -34
  510. data/spec/models/any_of_chat_completion_request_stop_spec.rb +0 -34
  511. data/spec/models/any_of_chat_completion_request_tool_choice_spec.rb +0 -34
  512. data/spec/models/any_of_create_embedding_request_schema_input_spec.rb +0 -34
  513. data/spec/models/any_of_create_embedding_request_schema_model_spec.rb +0 -34
  514. data/spec/models/any_of_model_response_model_spec_constraints_spec.rb +0 -34
  515. data/spec/models/any_of_model_response_model_spec_pricing_spec.rb +0 -34
  516. data/spec/models/any_of_upscale_image_request_enhance_spec.rb +0 -34
  517. data/spec/models/any_of_upscale_image_request_image_spec.rb +0 -34
  518. data/spec/models/any_ofapi_keys_body_expires_at_spec.rb +0 -34
  519. data/spec/models/any_ofapi_keys_consumption_limit_usd_spec.rb +0 -34
  520. data/spec/models/any_ofapi_keys_consumption_limit_vcu_spec.rb +0 -34
  521. data/spec/models/any_ofapi_keys_generate_web3_key_body_expires_at_spec.rb +0 -34
  522. data/spec/models/any_ofinline_response_200_2_data_items_spec.rb +0 -34
  523. data/spec/models/any_ofinline_response_200_4_type_spec.rb +0 -34
  524. data/spec/models/any_ofinline_response_200_5_type_spec.rb +0 -34
  525. data/spec/models/any_ofinline_response_200_6_type_spec.rb +0 -34
  526. data/spec/models/any_ofinline_response_200_choices_message_spec.rb +0 -34
  527. data/spec/models/any_ofinline_response_200_prompt_logprobs_spec.rb +0 -34
  528. data/spec/models/api_keys_body_spec.rb +0 -61
  529. data/spec/models/api_keys_consumption_limit_spec.rb +0 -46
  530. data/spec/models/api_keys_generate_web3_key_body_spec.rb +0 -80
  531. data/spec/models/billing_usage_response_data_spec.rb +0 -86
  532. data/spec/models/billing_usage_response_inference_details_spec.rb +0 -57
  533. data/spec/models/billing_usage_response_pagination_spec.rb +0 -58
  534. data/spec/models/chat_completion_request_function_spec.rb +0 -52
  535. data/spec/models/inline_response_200_10_data_api_tier_spec.rb +0 -45
  536. data/spec/models/inline_response_200_10_data_balances_spec.rb +0 -45
  537. data/spec/models/inline_response_200_10_data_rate_limits_1_spec.rb +0 -45
  538. data/spec/models/inline_response_200_10_data_rate_limits_spec.rb +0 -46
  539. data/spec/models/inline_response_200_10_data_spec.rb +0 -69
  540. data/spec/models/inline_response_200_10_spec.rb +0 -40
  541. data/spec/models/inline_response_200_11_data_spec.rb +0 -64
  542. data/spec/models/inline_response_200_11_spec.rb +0 -50
  543. data/spec/models/inline_response_200_12_data_spec.rb +0 -39
  544. data/spec/models/inline_response_200_12_spec.rb +0 -46
  545. data/spec/models/inline_response_200_13_data_spec.rb +0 -93
  546. data/spec/models/inline_response_200_13_spec.rb +0 -49
  547. data/spec/models/inline_response_200_13_stats_spec.rb +0 -40
  548. data/spec/models/inline_response_200_14_data_spec.rb +0 -55
  549. data/spec/models/inline_response_200_14_spec.rb +0 -61
  550. data/spec/models/inline_response_200_14_usage_spec.rb +0 -45
  551. data/spec/models/inline_response_200_15_spec.rb +0 -45
  552. data/spec/models/inline_response_200_1_spec.rb +0 -57
  553. data/spec/models/inline_response_200_1_timing_spec.rb +0 -58
  554. data/spec/models/inline_response_200_2_spec.rb +0 -46
  555. data/spec/models/inline_response_200_3_spec.rb +0 -50
  556. data/spec/models/inline_response_200_4_spec.rb +0 -55
  557. data/spec/models/inline_response_200_5_spec.rb +0 -55
  558. data/spec/models/inline_response_200_6_spec.rb +0 -55
  559. data/spec/models/inline_response_200_7_data_spec.rb +0 -91
  560. data/spec/models/inline_response_200_7_spec.rb +0 -50
  561. data/spec/models/inline_response_200_7_usage_spec.rb +0 -39
  562. data/spec/models/inline_response_200_7_usage_trailing_seven_days_spec.rb +0 -45
  563. data/spec/models/inline_response_200_8_data_spec.rb +0 -73
  564. data/spec/models/inline_response_200_8_spec.rb +0 -45
  565. data/spec/models/inline_response_200_9_spec.rb +0 -39
  566. data/spec/models/inline_response_200_choices_spec.rb +0 -72
  567. data/spec/models/inline_response_200_logprobs_spec.rb +0 -57
  568. data/spec/models/inline_response_200_logprobs_top_logprobs_spec.rb +0 -51
  569. data/spec/models/inline_response_200_spec.rb +0 -85
  570. data/spec/models/inline_response_200_usage_spec.rb +0 -57
  571. data/spec/models/inline_response_200_venice_parameters_spec.rb +0 -80
  572. data/spec/models/inline_response_200_venice_parameters_web_search_citations_spec.rb +0 -57
  573. data/spec/models/inline_response_400_spec.rb +0 -45
  574. data/spec/models/inline_response_401_spec.rb +0 -39
  575. data/spec/models/inline_response_402_spec.rb +0 -39
  576. data/spec/models/inline_response_403_spec.rb +0 -40
  577. data/spec/models/inline_response_415_spec.rb +0 -40
  578. data/spec/models/inline_response_429_spec.rb +0 -39
  579. data/spec/models/inline_response_500_1_spec.rb +0 -40
  580. data/spec/models/inline_response_500_spec.rb +0 -39
  581. data/spec/models/inline_response_503_spec.rb +0 -40
  582. data/spec/models/model_compatibility_schema_spec.rb +0 -34
  583. data/spec/models/model_trait_schema_spec.rb +0 -34
  584. data/spec/models/one_of_chat_completion_request_response_format_spec.rb +0 -34
  585. data/spec/models/type_spec.rb +0 -34
  586. data/venice_client.gemspec +0 -38
data/docs/AudioApi.md CHANGED
@@ -2,48 +2,71 @@
2
2
 
3
3
  All URIs are relative to *https://api.venice.ai/api/v1*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_speech**](AudioApi.md#create_speech) | **POST** /audio/speech | /api/v1/audio/speech
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_speech**](AudioApi.md#create_speech) | **POST** /audio/speech | /api/v1/audio/speech |
8
8
 
9
- # **create_speech**
10
- > String create_speech(opts)
9
+
10
+ ## create_speech
11
+
12
+ > File create_speech(opts)
11
13
 
12
14
  /api/v1/audio/speech
13
15
 
14
16
  Converts text to speech using various voice models and formats.
15
17
 
16
- ### Example
18
+ ### Examples
19
+
17
20
  ```ruby
18
- # load the gem
21
+ require 'time'
19
22
  require 'venice_client'
20
23
  # setup authorization
21
24
  VeniceClient.configure do |config|
25
+ # Configure Bearer authorization (JWT): BearerAuth
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
22
27
  end
23
28
 
24
29
  api_instance = VeniceClient::AudioApi.new
25
- opts = {
26
- body: VeniceClient::CreateSpeechRequestSchema.new # CreateSpeechRequestSchema |
30
+ opts = {
31
+ create_speech_request_schema: VeniceClient::CreateSpeechRequestSchema.new({input: 'Hello, this is a test of the text to speech system.'}) # CreateSpeechRequestSchema |
27
32
  }
28
33
 
29
34
  begin
30
- #/api/v1/audio/speech
35
+ # /api/v1/audio/speech
31
36
  result = api_instance.create_speech(opts)
32
37
  p result
33
38
  rescue VeniceClient::ApiError => e
34
- puts "Exception when calling AudioApi->create_speech: #{e}"
39
+ puts "Error when calling AudioApi->create_speech: #{e}"
40
+ end
41
+ ```
42
+
43
+ #### Using the create_speech_with_http_info variant
44
+
45
+ This returns an Array which contains the response data, status code and headers.
46
+
47
+ > <Array(File, Integer, Hash)> create_speech_with_http_info(opts)
48
+
49
+ ```ruby
50
+ begin
51
+ # /api/v1/audio/speech
52
+ data, status_code, headers = api_instance.create_speech_with_http_info(opts)
53
+ p status_code # => 2xx
54
+ p headers # => { ... }
55
+ p data # => File
56
+ rescue VeniceClient::ApiError => e
57
+ puts "Error when calling AudioApi->create_speech_with_http_info: #{e}"
35
58
  end
36
59
  ```
37
60
 
38
61
  ### Parameters
39
62
 
40
- Name | Type | Description | Notes
41
- ------------- | ------------- | ------------- | -------------
42
- **body** | [**CreateSpeechRequestSchema**](CreateSpeechRequestSchema.md)| | [optional]
63
+ | Name | Type | Description | Notes |
64
+ | ---- | ---- | ----------- | ----- |
65
+ | **create_speech_request_schema** | [**CreateSpeechRequestSchema**](CreateSpeechRequestSchema.md) | | [optional] |
43
66
 
44
67
  ### Return type
45
68
 
46
- **String**
69
+ **File**
47
70
 
48
71
  ### Authorization
49
72
 
@@ -51,8 +74,6 @@ Name | Type | Description | Notes
51
74
 
52
75
  ### HTTP request headers
53
76
 
54
- - **Content-Type**: application/json
55
- - **Accept**: audio/aac, audio/flac, audio/mpeg, audio/opus, audio/pcm, audio/wav, application/json
56
-
57
-
77
+ - **Content-Type**: application/json
78
+ - **Accept**: audio/aac, audio/flac, audio/mpeg, audio/opus, audio/pcm, audio/wav, application/json
58
79
 
@@ -0,0 +1,18 @@
1
+ # VeniceClient::AudioModelPricing
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **input** | [**AudioModelPricingInput**](AudioModelPricingInput.md) | | |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'venice_client'
13
+
14
+ instance = VeniceClient::AudioModelPricing.new(
15
+ input: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,22 @@
1
+ # VeniceClient::AudioModelPricingInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **usd** | **Float** | USD cost per million input characters | |
8
+ | **vcu** | **Float** | VCU cost per million input characters (deprecated - use Diem instead) | |
9
+ | **diem** | **Float** | Diem cost per million input characters | |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'venice_client'
15
+
16
+ instance = VeniceClient::AudioModelPricingInput.new(
17
+ usd: 3.5,
18
+ vcu: 35,
19
+ diem: 35
20
+ )
21
+ ```
22
+
data/docs/BillingApi.md CHANGED
@@ -2,60 +2,83 @@
2
2
 
3
3
  All URIs are relative to *https://api.venice.ai/api/v1*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_billing_usage**](BillingApi.md#get_billing_usage) | **GET** /billing/usage | /api/v1/billing/usage
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**get_billing_usage**](BillingApi.md#get_billing_usage) | **GET** /billing/usage | /api/v1/billing/usage |
8
8
 
9
- # **get_billing_usage**
10
- > InlineResponse20015 get_billing_usage(opts)
9
+
10
+ ## get_billing_usage
11
+
12
+ > <GetBillingUsage200Response> get_billing_usage(opts)
11
13
 
12
14
  /api/v1/billing/usage
13
15
 
14
16
  Get paginated billing usage data for the authenticated user. NOTE: This is a beta endpoint and may be subject to change.
15
17
 
16
- ### Example
18
+ ### Examples
19
+
17
20
  ```ruby
18
- # load the gem
21
+ require 'time'
19
22
  require 'venice_client'
20
23
  # setup authorization
21
24
  VeniceClient.configure do |config|
25
+ # Configure Bearer authorization (JWT): BearerAuth
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
22
27
  end
23
28
 
24
29
  api_instance = VeniceClient::BillingApi.new
25
- opts = {
26
- accept: 'accept_example', # String | Accept header to specify the response format
27
- currency: 'currency_example', # String |
28
- end_date: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime |
30
+ opts = {
31
+ accept: 'application/json, text/csv', # String | Accept header to specify the response format
32
+ currency: 'USD', # String |
33
+ end_date: Time.parse('2024-12-31T23:59:59Z'), # Time |
29
34
  limit: 200, # Integer |
30
35
  page: 1, # Integer |
31
- sort_order: 'desc', # String |
32
- start_date: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime |
36
+ sort_order: 'asc', # String |
37
+ start_date: Time.parse('2024-01-01T00:00Z') # Time |
33
38
  }
34
39
 
35
40
  begin
36
- #/api/v1/billing/usage
41
+ # /api/v1/billing/usage
37
42
  result = api_instance.get_billing_usage(opts)
38
43
  p result
39
44
  rescue VeniceClient::ApiError => e
40
- puts "Exception when calling BillingApi->get_billing_usage: #{e}"
45
+ puts "Error when calling BillingApi->get_billing_usage: #{e}"
46
+ end
47
+ ```
48
+
49
+ #### Using the get_billing_usage_with_http_info variant
50
+
51
+ This returns an Array which contains the response data, status code and headers.
52
+
53
+ > <Array(<GetBillingUsage200Response>, Integer, Hash)> get_billing_usage_with_http_info(opts)
54
+
55
+ ```ruby
56
+ begin
57
+ # /api/v1/billing/usage
58
+ data, status_code, headers = api_instance.get_billing_usage_with_http_info(opts)
59
+ p status_code # => 2xx
60
+ p headers # => { ... }
61
+ p data # => <GetBillingUsage200Response>
62
+ rescue VeniceClient::ApiError => e
63
+ puts "Error when calling BillingApi->get_billing_usage_with_http_info: #{e}"
41
64
  end
42
65
  ```
43
66
 
44
67
  ### Parameters
45
68
 
46
- Name | Type | Description | Notes
47
- ------------- | ------------- | ------------- | -------------
48
- **accept** | **String**| Accept header to specify the response format | [optional]
49
- **currency** | **String**| | [optional]
50
- **end_date** | **DateTime**| | [optional]
51
- **limit** | **Integer**| | [optional] [default to 200]
52
- **page** | **Integer**| | [optional] [default to 1]
53
- **sort_order** | **String**| | [optional] [default to desc]
54
- **start_date** | **DateTime**| | [optional]
69
+ | Name | Type | Description | Notes |
70
+ | ---- | ---- | ----------- | ----- |
71
+ | **accept** | **String** | Accept header to specify the response format | [optional] |
72
+ | **currency** | **String** | | [optional] |
73
+ | **end_date** | **Time** | | [optional] |
74
+ | **limit** | **Integer** | | [optional][default to 200] |
75
+ | **page** | **Integer** | | [optional][default to 1] |
76
+ | **sort_order** | **String** | | [optional][default to &#39;desc&#39;] |
77
+ | **start_date** | **Time** | | [optional] |
55
78
 
56
79
  ### Return type
57
80
 
58
- [**InlineResponse20015**](InlineResponse20015.md)
81
+ [**GetBillingUsage200Response**](GetBillingUsage200Response.md)
59
82
 
60
83
  ### Authorization
61
84
 
@@ -63,8 +86,6 @@ Name | Type | Description | Notes
63
86
 
64
87
  ### HTTP request headers
65
88
 
66
- - **Content-Type**: Not defined
67
- - **Accept**: application/json, text/csv
68
-
69
-
89
+ - **Content-Type**: Not defined
90
+ - **Accept**: application/json, text/csv
70
91
 
@@ -1,12 +1,28 @@
1
1
  # VeniceClient::BillingUsageRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **currency** | **String** | Filter by currency | [optional]
7
- **end_date** | **DateTime** | End date for filtering records (ISO 8601) | [optional]
8
- **limit** | **Integer** | Number of items per page | [optional] [default to 200]
9
- **page** | **Integer** | Page number for pagination | [optional] [default to 1]
10
- **sort_order** | **String** | Sort order for createdAt field | [optional] [default to &#x27;desc&#x27;]
11
- **start_date** | **DateTime** | Start date for filtering records (ISO 8601) | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **currency** | **String** | Filter by currency | [optional] |
8
+ | **end_date** | **Time** | End date for filtering records (ISO 8601) | [optional] |
9
+ | **limit** | **Integer** | Number of items per page | [optional][default to 200] |
10
+ | **page** | **Integer** | Page number for pagination | [optional][default to 1] |
11
+ | **sort_order** | **String** | Sort order for createdAt field | [optional][default to &#39;desc&#39;] |
12
+ | **start_date** | **Time** | Start date for filtering records (ISO 8601) | [optional] |
13
+
14
+ ## Example
15
+
16
+ ```ruby
17
+ require 'venice_client'
18
+
19
+ instance = VeniceClient::BillingUsageRequest.new(
20
+ currency: USD,
21
+ end_date: 2024-12-31T23:59:59Z,
22
+ limit: 200,
23
+ page: 1,
24
+ sort_order: desc,
25
+ start_date: 2024-01-01T00:00Z
26
+ )
27
+ ```
12
28
 
@@ -1,8 +1,20 @@
1
1
  # VeniceClient::BillingUsageResponse
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **data** | [**Array&lt;BillingUsageResponseData&gt;**](BillingUsageResponseData.md) | |
7
- **pagination** | [**BillingUsageResponsePagination**](BillingUsageResponsePagination.md) | |
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **data** | [**Array&lt;GetBillingUsage200ResponseDataInner&gt;**](GetBillingUsage200ResponseDataInner.md) | | |
8
+ | **pagination** | [**GetBillingUsage200ResponsePagination**](GetBillingUsage200ResponsePagination.md) | | |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'venice_client'
14
+
15
+ instance = VeniceClient::BillingUsageResponse.new(
16
+ data: null,
17
+ pagination: null
18
+ )
19
+ ```
8
20
 
@@ -2,42 +2,66 @@
2
2
 
3
3
  All URIs are relative to *https://api.venice.ai/api/v1*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**list_characters**](CharactersApi.md#list_characters) | **GET** /characters | /api/v1/characters
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**list_characters**](CharactersApi.md#list_characters) | **GET** /characters | /api/v1/characters |
8
8
 
9
- # **list_characters**
10
- > InlineResponse20013 list_characters
9
+
10
+ ## list_characters
11
+
12
+ > <ListCharacters200Response> list_characters
11
13
 
12
14
  /api/v1/characters
13
15
 
14
16
  This is a preview API and may change. Returns a list of characters supported in the API.
15
17
 
16
- ### Example
18
+ ### Examples
19
+
17
20
  ```ruby
18
- # load the gem
21
+ require 'time'
19
22
  require 'venice_client'
20
23
  # setup authorization
21
24
  VeniceClient.configure do |config|
25
+ # Configure Bearer authorization (JWT): BearerAuth
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
22
27
  end
23
28
 
24
29
  api_instance = VeniceClient::CharactersApi.new
25
30
 
26
31
  begin
27
- #/api/v1/characters
32
+ # /api/v1/characters
28
33
  result = api_instance.list_characters
29
34
  p result
30
35
  rescue VeniceClient::ApiError => e
31
- puts "Exception when calling CharactersApi->list_characters: #{e}"
36
+ puts "Error when calling CharactersApi->list_characters: #{e}"
37
+ end
38
+ ```
39
+
40
+ #### Using the list_characters_with_http_info variant
41
+
42
+ This returns an Array which contains the response data, status code and headers.
43
+
44
+ > <Array(<ListCharacters200Response>, Integer, Hash)> list_characters_with_http_info
45
+
46
+ ```ruby
47
+ begin
48
+ # /api/v1/characters
49
+ data, status_code, headers = api_instance.list_characters_with_http_info
50
+ p status_code # => 2xx
51
+ p headers # => { ... }
52
+ p data # => <ListCharacters200Response>
53
+ rescue VeniceClient::ApiError => e
54
+ puts "Error when calling CharactersApi->list_characters_with_http_info: #{e}"
32
55
  end
33
56
  ```
34
57
 
35
58
  ### Parameters
59
+
36
60
  This endpoint does not need any parameter.
37
61
 
38
62
  ### Return type
39
63
 
40
- [**InlineResponse20013**](InlineResponse20013.md)
64
+ [**ListCharacters200Response**](ListCharacters200Response.md)
41
65
 
42
66
  ### Authorization
43
67
 
@@ -45,8 +69,6 @@ This endpoint does not need any parameter.
45
69
 
46
70
  ### HTTP request headers
47
71
 
48
- - **Content-Type**: Not defined
49
- - **Accept**: application/json
50
-
51
-
72
+ - **Content-Type**: Not defined
73
+ - **Accept**: application/json
52
74
 
data/docs/ChatApi.md CHANGED
@@ -2,50 +2,73 @@
2
2
 
3
3
  All URIs are relative to *https://api.venice.ai/api/v1*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**create_chat_completion**](ChatApi.md#create_chat_completion) | **POST** /chat/completions | /api/v1/chat/completions
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_chat_completion**](ChatApi.md#create_chat_completion) | **POST** /chat/completions | /api/v1/chat/completions |
8
8
 
9
- # **create_chat_completion**
10
- > InlineResponse200 create_chat_completion(opts)
9
+
10
+ ## create_chat_completion
11
+
12
+ > <CreateChatCompletion200Response> create_chat_completion(opts)
11
13
 
12
14
  /api/v1/chat/completions
13
15
 
14
- Run text inference based on the supplied parameters.
16
+ Run text inference based on the supplied parameters. Long running requests should use the streaming API by setting stream=true in your request.
17
+
18
+ ### Examples
15
19
 
16
- ### Example
17
20
  ```ruby
18
- # load the gem
21
+ require 'time'
19
22
  require 'venice_client'
20
23
  # setup authorization
21
24
  VeniceClient.configure do |config|
25
+ # Configure Bearer authorization (JWT): BearerAuth
26
+ config.access_token = 'YOUR_BEARER_TOKEN'
22
27
  end
23
28
 
24
29
  api_instance = VeniceClient::ChatApi.new
25
- opts = {
26
- body: VeniceClient::ChatCompletionRequest.new # ChatCompletionRequest |
27
- accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br). Only applied when stream is false.
30
+ opts = {
31
+ accept_encoding: 'gzip, br', # String | Supported compression encodings (gzip, br). Only applied when stream is false.
32
+ chat_completion_request: VeniceClient::ChatCompletionRequest.new({messages: [VeniceClient::ChatCompletionRequestMessagesInner.new({content: VeniceClient::SystemMessageContent.new, role: 'system', tool_call_id: 'tool_call_id_example'})], model: 'venice-uncensored'}) # ChatCompletionRequest |
28
33
  }
29
34
 
30
35
  begin
31
- #/api/v1/chat/completions
36
+ # /api/v1/chat/completions
32
37
  result = api_instance.create_chat_completion(opts)
33
38
  p result
34
39
  rescue VeniceClient::ApiError => e
35
- puts "Exception when calling ChatApi->create_chat_completion: #{e}"
40
+ puts "Error when calling ChatApi->create_chat_completion: #{e}"
41
+ end
42
+ ```
43
+
44
+ #### Using the create_chat_completion_with_http_info variant
45
+
46
+ This returns an Array which contains the response data, status code and headers.
47
+
48
+ > <Array(<CreateChatCompletion200Response>, Integer, Hash)> create_chat_completion_with_http_info(opts)
49
+
50
+ ```ruby
51
+ begin
52
+ # /api/v1/chat/completions
53
+ data, status_code, headers = api_instance.create_chat_completion_with_http_info(opts)
54
+ p status_code # => 2xx
55
+ p headers # => { ... }
56
+ p data # => <CreateChatCompletion200Response>
57
+ rescue VeniceClient::ApiError => e
58
+ puts "Error when calling ChatApi->create_chat_completion_with_http_info: #{e}"
36
59
  end
37
60
  ```
38
61
 
39
62
  ### Parameters
40
63
 
41
- Name | Type | Description | Notes
42
- ------------- | ------------- | ------------- | -------------
43
- **body** | [**ChatCompletionRequest**](ChatCompletionRequest.md)| | [optional]
44
- **accept_encoding** | **String**| Supported compression encodings (gzip, br). Only applied when stream is false. | [optional]
64
+ | Name | Type | Description | Notes |
65
+ | ---- | ---- | ----------- | ----- |
66
+ | **accept_encoding** | **String** | Supported compression encodings (gzip, br). Only applied when stream is false. | [optional] |
67
+ | **chat_completion_request** | [**ChatCompletionRequest**](ChatCompletionRequest.md) | | [optional] |
45
68
 
46
69
  ### Return type
47
70
 
48
- [**InlineResponse200**](InlineResponse200.md)
71
+ [**CreateChatCompletion200Response**](CreateChatCompletion200Response.md)
49
72
 
50
73
  ### Authorization
51
74
 
@@ -53,8 +76,6 @@ Name | Type | Description | Notes
53
76
 
54
77
  ### HTTP request headers
55
78
 
56
- - **Content-Type**: application/json
57
- - **Accept**: application/json
58
-
59
-
79
+ - **Content-Type**: application/json
80
+ - **Accept**: application/json
60
81
 
@@ -1,32 +1,70 @@
1
1
  # VeniceClient::ChatCompletionRequest
2
2
 
3
3
  ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **frequency_penalty** | [**BigDecimal**](BigDecimal.md) | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model&#x27;s likelihood to repeat the same line verbatim. | [optional] [default to 0]
7
- **logprobs** | **BOOLEAN** | Whether to include log probabilities in the response. This is not supported by all models. | [optional]
8
- **max_completion_tokens** | **Integer** | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. | [optional]
9
- **max_temp** | [**BigDecimal**](BigDecimal.md) | Maximum temperature value for dynamic temperature scaling. | [optional]
10
- **max_tokens** | **Integer** | The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. This value is now deprecated in favor of max_completion_tokens. | [optional]
11
- **messages** | [**Array&lt;AnyOfChatCompletionRequestMessagesItems&gt;**](.md) | A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text and images. For compatibility purposes, the schema supports submitting multiple image_url messages, however, only the last image_url message will be passed to and processed by the model. |
12
- **min_p** | [**BigDecimal**](BigDecimal.md) | Sets a minimum probability threshold for token selection. Tokens with probabilities below this value are filtered out. | [optional]
13
- **min_temp** | [**BigDecimal**](BigDecimal.md) | Minimum temperature value for dynamic temperature scaling. | [optional]
14
- **model** | **String** | The ID of the model you wish to prompt. May also be a model trait, or a compatibility mapping. See the models endpoint for a list of models available to you. You can use feature suffixes to enable features from the venice_parameters object. Please see \&quot;Model Feature Suffix\&quot; documentation for more details. |
15
- **n** | **Integer** | How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs. | [optional] [default to 1]
16
- **presence_penalty** | [**BigDecimal**](BigDecimal.md) | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model&#x27;s likelihood to talk about new topics. | [optional] [default to 0]
17
- **repetition_penalty** | [**BigDecimal**](BigDecimal.md) | The parameter for repetition penalty. 1.0 means no penalty. Values &gt; 1.0 discourage repetition. | [optional]
18
- **seed** | **Integer** | The random seed used to generate the response. This is useful for reproducibility. | [optional]
19
- **stop** | [**AnyOfChatCompletionRequestStop**](AnyOfChatCompletionRequestStop.md) | Up to 4 sequences where the API will stop generating further tokens. Defaults to null. | [optional]
20
- **stop_token_ids** | [**Array&lt;BigDecimal&gt;**](BigDecimal.md) | Array of token IDs where the API will stop generating further tokens. | [optional]
21
- **stream** | **BOOLEAN** | Whether to stream back partial progress. Defaults to false. | [optional]
22
- **stream_options** | [**ChatCompletionRequestStreamOptions**](ChatCompletionRequestStreamOptions.md) | | [optional]
23
- **temperature** | [**BigDecimal**](BigDecimal.md) | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both. | [optional] [default to 0.3]
24
- **top_k** | **Integer** | The number of highest probability vocabulary tokens to keep for top-k-filtering. | [optional]
25
- **top_p** | [**BigDecimal**](BigDecimal.md) | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. | [optional] [default to 1]
26
- **user** | **String** | This field is discarded on the request but is supported in the Venice API for compatibility with OpenAPI clients. | [optional]
27
- **venice_parameters** | [**ChatCompletionRequestVeniceParameters**](ChatCompletionRequestVeniceParameters.md) | | [optional]
28
- **parallel_tool_calls** | **BOOLEAN** | Whether to enable parallel function calling during tool use. | [optional] [default to true]
29
- **response_format** | [**OneOfChatCompletionRequestResponseFormat**](OneOfChatCompletionRequestResponseFormat.md) | Format in which the response should be returned. | [optional]
30
- **tool_choice** | [**AnyOfChatCompletionRequestToolChoice**](AnyOfChatCompletionRequestToolChoice.md) | | [optional]
31
- **tools** | [**Array&lt;ToolCall&gt;**](ToolCall.md) | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. | [optional]
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **frequency_penalty** | **Float** | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model&#39;s likelihood to repeat the same line verbatim. | [optional][default to 0] |
8
+ | **logprobs** | **Boolean** | Whether to include log probabilities in the response. This is not supported by all models. | [optional] |
9
+ | **top_logprobs** | **Integer** | The number of highest probability tokens to return for each token position. | [optional] |
10
+ | **max_completion_tokens** | **Integer** | An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. | [optional] |
11
+ | **max_temp** | **Float** | Maximum temperature value for dynamic temperature scaling. | [optional] |
12
+ | **max_tokens** | **Integer** | The maximum number of tokens that can be generated in the chat completion. This value can be used to control costs for text generated via API. This value is now deprecated in favor of max_completion_tokens. | [optional] |
13
+ | **messages** | [**Array&lt;ChatCompletionRequestMessagesInner&gt;**](ChatCompletionRequestMessagesInner.md) | A list of messages comprising the conversation so far. Depending on the model you use, different message types (modalities) are supported, like text and images. For compatibility purposes, the schema supports submitting multiple image_url messages, however, only the last image_url message will be passed to and processed by the model. | |
14
+ | **min_p** | **Float** | Sets a minimum probability threshold for token selection. Tokens with probabilities below this value are filtered out. | [optional] |
15
+ | **min_temp** | **Float** | Minimum temperature value for dynamic temperature scaling. | [optional] |
16
+ | **model** | **String** | The ID of the model you wish to prompt. May also be a model trait, or a model compatibility mapping. See the models endpoint for a list of models available to you. You can use feature suffixes to enable features from the venice_parameters object. Please see \&quot;Model Feature Suffix\&quot; documentation for more details. | |
17
+ | **n** | **Integer** | How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs. | [optional][default to 1] |
18
+ | **presence_penalty** | **Float** | Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model&#39;s likelihood to talk about new topics. | [optional][default to 0] |
19
+ | **repetition_penalty** | **Float** | The parameter for repetition penalty. 1.0 means no penalty. Values &gt; 1.0 discourage repetition. | [optional] |
20
+ | **seed** | **Integer** | The random seed used to generate the response. This is useful for reproducibility. | [optional] |
21
+ | **stop** | [**ChatCompletionRequestStop**](ChatCompletionRequestStop.md) | | [optional] |
22
+ | **stop_token_ids** | **Array&lt;Float&gt;** | Array of token IDs where the API will stop generating further tokens. | [optional] |
23
+ | **stream** | **Boolean** | Whether to stream back partial progress. Defaults to false. | [optional] |
24
+ | **stream_options** | [**ChatCompletionRequestStreamOptions**](ChatCompletionRequestStreamOptions.md) | | [optional] |
25
+ | **temperature** | **Float** | What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both. | [optional][default to 0.7] |
26
+ | **top_k** | **Integer** | The number of highest probability vocabulary tokens to keep for top-k-filtering. | [optional] |
27
+ | **top_p** | **Float** | An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. | [optional][default to 0.9] |
28
+ | **user** | **String** | This field is discarded on the request but is supported in the Venice API for compatibility with OpenAI clients. | [optional] |
29
+ | **venice_parameters** | [**ChatCompletionRequestVeniceParameters**](ChatCompletionRequestVeniceParameters.md) | | [optional] |
30
+ | **parallel_tool_calls** | **Boolean** | Whether to enable parallel function calling during tool use. | [optional][default to true] |
31
+ | **response_format** | [**ChatCompletionRequestResponseFormat**](ChatCompletionRequestResponseFormat.md) | | [optional] |
32
+ | **tool_choice** | [**ChatCompletionRequestToolChoice**](ChatCompletionRequestToolChoice.md) | | [optional] |
33
+ | **tools** | [**Array&lt;ToolCall&gt;**](ToolCall.md) | A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. | [optional] |
34
+
35
+ ## Example
36
+
37
+ ```ruby
38
+ require 'venice_client'
39
+
40
+ instance = VeniceClient::ChatCompletionRequest.new(
41
+ frequency_penalty: null,
42
+ logprobs: true,
43
+ top_logprobs: 1,
44
+ max_completion_tokens: null,
45
+ max_temp: 1.5,
46
+ max_tokens: null,
47
+ messages: null,
48
+ min_p: 0.05,
49
+ min_temp: 0.1,
50
+ model: venice-uncensored,
51
+ n: null,
52
+ presence_penalty: null,
53
+ repetition_penalty: 1.2,
54
+ seed: 42,
55
+ stop: null,
56
+ stop_token_ids: [151643,151645],
57
+ stream: true,
58
+ stream_options: null,
59
+ temperature: 0.7,
60
+ top_k: 40,
61
+ top_p: 0.9,
62
+ user: null,
63
+ venice_parameters: null,
64
+ parallel_tool_calls: false,
65
+ response_format: null,
66
+ tool_choice: null,
67
+ tools: null
68
+ )
69
+ ```
32
70