venice_client 1.0.0 → 1.0.2

data/docs/ImageUrl.md

@@ -0,0 +1,20 @@
+# VeniceClient::ImageUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **image_url** | [**ImageURLObject**](ImageURLObject.md) |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageUrl.new(
+  image_url: null,
+  type: null
+)
+```
+

data/docs/JsonObject.md

@@ -0,0 +1,18 @@
+# VeniceClient::JsonObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::JsonObject.new(
+  type: null
+)
+```
+

data/docs/JsonSchema.md

@@ -0,0 +1,20 @@
+# VeniceClient::JsonSchema
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **json_schema** | **Hash<String, Object>** |  |  |
+| **type** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::JsonSchema.new(
+  json_schema: null,
+  type: null
+)
+```
+

data/docs/LLMModelPricing.md

@@ -0,0 +1,20 @@
+# VeniceClient::LLMModelPricing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | [**LLMModelPricingInput**](LLMModelPricingInput.md) |  |  |
+| **output** | [**LLMModelPricingOutput**](LLMModelPricingOutput.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::LLMModelPricing.new(
+  input: null,
+  output: null
+)
+```
+

data/docs/LLMModelPricingInput.md

@@ -0,0 +1,22 @@
+# VeniceClient::LLMModelPricingInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** | USD cost per million input tokens |  |
+| **vcu** | **Float** | VCU cost per million input tokens (deprecated - use Diem instead) |  |
+| **diem** | **Float** | Diem cost per million input tokens |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::LLMModelPricingInput.new(
+  usd: 0.7,
+  vcu: 7,
+  diem: 7
+)
+```
+

data/docs/LLMModelPricingOutput.md

@@ -0,0 +1,22 @@
+# VeniceClient::LLMModelPricingOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** | USD cost per million output tokens |  |
+| **vcu** | **Float** | VCU cost per million output tokens (deprecated - use Diem instead) |  |
+| **diem** | **Float** | Diem cost per million output tokens |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::LLMModelPricingOutput.new(
+  usd: 2.8,
+  vcu: 28,
+  diem: 28
+)
+```
+

data/docs/ListCharacters200Response.md

@@ -0,0 +1,20 @@
+# VeniceClient::ListCharacters200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<ListCharacters200ResponseDataInner>**](ListCharacters200ResponseDataInner.md) |  |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListCharacters200Response.new(
+  data: null,
+  object: null
+)
+```
+

data/docs/ListCharacters200ResponseDataInner.md

@@ -0,0 +1,36 @@
+# VeniceClient::ListCharacters200ResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adult** | **Boolean** | Whether the character is considered adult content |  |
+| **created_at** | **String** | Date when the character was created |  |
+| **description** | **String** | Description of the character |  |
+| **name** | **String** | Name of the character |  |
+| **share_url** | **String** | Share URL of the character |  |
+| **slug** | **String** | Slug of the character to be used in the completions API |  |
+| **stats** | [**ListCharacters200ResponseDataInnerStats**](ListCharacters200ResponseDataInnerStats.md) |  |  |
+| **tags** | **Array<String>** | Tags associated with the character |  |
+| **updated_at** | **String** | Date when the character was last updated |  |
+| **web_enabled** | **Boolean** | Whether the character is enabled for web use |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListCharacters200ResponseDataInner.new(
+  adult: false,
+  created_at: 2024-12-20T21:28:08.934Z,
+  description: Alan Watts (6 January 1915 – 16 November 1973) was a British and American writer, speaker, and self-styled "philosophical entertainer", known for interpreting and popularizing Buddhist, Taoist, and Hindu philosophy for a Western audience.,
+  name: Alan Watts,
+  share_url: https://venice.ai/c/alan-watts,
+  slug: alan-watts,
+  stats: null,
+  tags: ["AlanWatts","Philosophy","Buddhism","Taoist","Hindu"],
+  updated_at: 2025-02-09T03:23:53.708Z,
+  web_enabled: true
+)
+```
+

data/docs/ListCharacters200ResponseDataInnerStats.md

@@ -0,0 +1,18 @@
+# VeniceClient::ListCharacters200ResponseDataInnerStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **imports** | **Float** | Number of imports for the character |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListCharacters200ResponseDataInnerStats.new(
+  imports: 112
+)
+```
+

data/docs/ListModelCompatibilityMapping200Response.md

@@ -0,0 +1,22 @@
+# VeniceClient::ListModelCompatibilityMapping200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, String>** | List of available models |  |
+| **object** | **String** |  |  |
+| **type** | [**ListModels200ResponseType**](ListModels200ResponseType.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListModelCompatibilityMapping200Response.new(
+  data: {"gpt-4o":"llama-3.3-70b"},
+  object: null,
+  type: null
+)
+```
+

data/docs/ListModelTraits200Response.md

@@ -0,0 +1,22 @@
+# VeniceClient::ListModelTraits200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Hash<String, String>** | List of available models |  |
+| **object** | **String** |  |  |
+| **type** | [**ListModels200ResponseType**](ListModels200ResponseType.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListModelTraits200Response.new(
+  data: {"default":"llama-3.3-70b","fastest":"llama-3.2-3b-akash"},
+  object: null,
+  type: null
+)
+```
+

data/docs/ListModels200Response.md

@@ -0,0 +1,22 @@
+# VeniceClient::ListModels200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<ModelResponse>**](ModelResponse.md) | List of available models |  |
+| **object** | **String** |  |  |
+| **type** | [**ListModels200ResponseType**](ListModels200ResponseType.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListModels200Response.new(
+  data: null,
+  object: null,
+  type: null
+)
+```
+

data/docs/ListModels200ResponseType.md

@@ -0,0 +1,15 @@
+# VeniceClient::ListModels200ResponseType
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListModels200ResponseType.new()
+```
+

data/docs/ListModelsTypeParameter.md

@@ -0,0 +1,15 @@
+# VeniceClient::ListModelsTypeParameter
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ListModelsTypeParameter.new()
+```
+

data/docs/ModelResponse.md

@@ -1,12 +1,28 @@
 # VeniceClient::ModelResponse
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**created** | [**BigDecimal**](BigDecimal.md) | Release date on Venice API | [optional] 
-**id** | **String** | Model ID | 
-**model_spec** | [**ModelResponseModelSpec**](ModelResponseModelSpec.md) |  | 
-**object** | **String** | Object type | 
-**owned_by** | **String** | Who runs the model | 
-**type** | **String** | Model type | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Float** | Release date on Venice API | [optional] |
+| **id** | **String** | Model ID |  |
+| **model_spec** | [**ModelResponseModelSpec**](ModelResponseModelSpec.md) |  |  |
+| **object** | **String** | Object type |  |
+| **owned_by** | **String** | Who runs the model |  |
+| **type** | **String** | Model type |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ModelResponse.new(
+  created: 1699000000,
+  id: venice-uncensored,
+  model_spec: null,
+  object: model,
+  owned_by: venice.ai,
+  type: text
+)
+```
 

data/docs/ModelResponseModelSpec.md

@@ -1,15 +1,36 @@
 # VeniceClient::ModelResponseModelSpec
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**available_context_tokens** | [**BigDecimal**](BigDecimal.md) | The context length supported by the model. Only applicable for text models. | [optional] 
-**beta** | **BOOLEAN** | Is this model in beta? | [optional] 
-**capabilities** | [**ModelResponseModelSpecCapabilities**](ModelResponseModelSpecCapabilities.md) |  | [optional] 
-**constraints** | [**AnyOfModelResponseModelSpecConstraints**](AnyOfModelResponseModelSpecConstraints.md) | Constraints that apply to this model. | [optional] 
-**model_source** | **String** | The source of the model, such as a URL to the model repository. | [optional] 
-**offline** | **BOOLEAN** | Is this model presently offline? | [optional] [default to false]
-**pricing** | [**AnyOfModelResponseModelSpecPricing**](AnyOfModelResponseModelSpecPricing.md) | Pricing details for the model | [optional] 
-**traits** | **Array<String>** | Traits that apply to this model. You can specify a trait to auto-select a model vs. specifying the model ID in your request to avoid breakage as Venice updates and iterates on its models. | [optional] 
-**voices** | **Array<String>** | The voices available for this TTS model. Only applicable for TTS models. | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **available_context_tokens** | **Float** | The context length supported by the model. Only applicable for text models. | [optional] |
+| **beta** | **Boolean** | Is this model in beta? | [optional] |
+| **capabilities** | [**ModelResponseModelSpecCapabilities**](ModelResponseModelSpecCapabilities.md) |  | [optional] |
+| **constraints** | [**ModelResponseModelSpecConstraints**](ModelResponseModelSpecConstraints.md) |  | [optional] |
+| **name** | **String** | The name of the model. | [optional] |
+| **model_source** | **String** | The source of the model, such as a URL to the model repository. | [optional] |
+| **offline** | **Boolean** | Is this model presently offline? | [optional][default to false] |
+| **pricing** | [**ModelResponseModelSpecPricing**](ModelResponseModelSpecPricing.md) |  | [optional] |
+| **traits** | **Array<String>** | Traits that apply to this model. You can specify a trait to auto-select a model vs. specifying the model ID in your request to avoid breakage as Venice updates and iterates on its models. | [optional] |
+| **voices** | **Array<String>** | The voices available for this TTS model. Only applicable for TTS models. | [optional] |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ModelResponseModelSpec.new(
+  available_context_tokens: 32768,
+  beta: false,
+  capabilities: null,
+  constraints: null,
+  name: Venice Uncensored 1.1,
+  model_source: https://huggingface.co/cognitivecomputations/Dolphin-Mistral-24B-Venice-Edition,
+  offline: false,
+  pricing: null,
+  traits: ["default_code"],
+  voices: ["af_alloy","af_aoede","af_bella","af_heart","af_jadzia"]
+)
+```
 

data/docs/ModelResponseModelSpecCapabilities.md

@@ -1,14 +1,32 @@
 # VeniceClient::ModelResponseModelSpecCapabilities
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**optimized_for_code** | **BOOLEAN** | Is the LLM optimized for coding? | 
-**quantization** | **String** | The quantization type of the running model. | 
-**supports_function_calling** | **BOOLEAN** | Does the LLM model support function calling? | 
-**supports_reasoning** | **BOOLEAN** | Does the model support reasoning with <thinking> blocks of output. | 
-**supports_response_schema** | **BOOLEAN** | Does the LLM model support response schema? Only models that support function calling can support response_schema. | 
-**supports_vision** | **BOOLEAN** | Does the LLM support vision? | 
-**supports_web_search** | **BOOLEAN** | Does the LLM model support web search? | 
-**supports_log_probs** | **BOOLEAN** | Does the LLM model support logprobs parameter? | 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **optimized_for_code** | **Boolean** | Is the LLM optimized for coding? |  |
+| **quantization** | **String** | The quantization type of the running model. |  |
+| **supports_function_calling** | **Boolean** | Does the LLM model support function calling? |  |
+| **supports_reasoning** | **Boolean** | Does the model support reasoning with <thinking> blocks of output. |  |
+| **supports_response_schema** | **Boolean** | Does the LLM model support response schema? Only models that support function calling can support response_schema. |  |
+| **supports_vision** | **Boolean** | Does the LLM support vision? |  |
+| **supports_web_search** | **Boolean** | Does the LLM model support web search? |  |
+| **supports_log_probs** | **Boolean** | Does the LLM model support logprobs parameter? |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ModelResponseModelSpecCapabilities.new(
+  optimized_for_code: true,
+  quantization: fp8,
+  supports_function_calling: true,
+  supports_reasoning: true,
+  supports_response_schema: true,
+  supports_vision: true,
+  supports_web_search: true,
+  supports_log_probs: true
+)
+```
 

data/docs/ModelResponseModelSpecConstraints.md

@@ -0,0 +1,26 @@
+# VeniceClient::ModelResponseModelSpecConstraints
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **prompt_character_limit** | **Float** | The maximum supported prompt length. |  |
+| **steps** | [**ImageModelConstraintsSteps**](ImageModelConstraintsSteps.md) |  |  |
+| **width_height_divisor** | **Float** | The requested width and height of the image generation must be divisible by this value. |  |
+| **temperature** | [**TextModelConstraintsTemperature**](TextModelConstraintsTemperature.md) |  |  |
+| **top_p** | [**TextModelConstraintsTopP**](TextModelConstraintsTopP.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ModelResponseModelSpecConstraints.new(
+  prompt_character_limit: 2048,
+  steps: null,
+  width_height_divisor: 8,
+  temperature: null,
+  top_p: null
+)
+```
+

data/docs/ModelResponseModelSpecPricing.md

@@ -0,0 +1,24 @@
+# VeniceClient::ModelResponseModelSpecPricing
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **input** | [**AudioModelPricingInput**](AudioModelPricingInput.md) |  |  |
+| **output** | [**LLMModelPricingOutput**](LLMModelPricingOutput.md) |  |  |
+| **generation** | [**ImageModelPricingGeneration**](ImageModelPricingGeneration.md) |  |  |
+| **upscale** | [**ImageModelPricingUpscale**](ImageModelPricingUpscale.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ModelResponseModelSpecPricing.new(
+  input: null,
+  output: null,
+  generation: null,
+  upscale: null
+)
+```
+