venice_client 1.0.0 → 1.0.2

data/docs/GetApiKeyRateLimits200ResponseDataApiTier.md

@@ -0,0 +1,20 @@
+# VeniceClient::GetApiKeyRateLimits200ResponseDataApiTier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the API tier. |  |
+| **is_charged** | **Boolean** | Is the API key pay per use (in Diem or USD). |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeyRateLimits200ResponseDataApiTier.new(
+  id: paid,
+  is_charged: true
+)
+```
+

data/docs/GetApiKeyRateLimits200ResponseDataBalances.md

@@ -0,0 +1,22 @@
+# VeniceClient::GetApiKeyRateLimits200ResponseDataBalances
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** | The USD balance of the key. | [optional] |
+| **vcu** | **Float** | The VCU balance of the key. VCU is being deprecated in favor of Diem. | [optional] |
+| **diem** | **Float** | The Diem balance of the key. | [optional] |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeyRateLimits200ResponseDataBalances.new(
+  usd: 50.23,
+  vcu: 100.023,
+  diem: 100.023
+)
+```
+

data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInner.md

@@ -0,0 +1,20 @@
+# VeniceClient::GetApiKeyRateLimits200ResponseDataRateLimitsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_model_id** | **String** | The ID of the API model. | [optional] |
+| **rate_limits** | [**Array<GetApiKeyRateLimits200ResponseDataRateLimitsInnerRateLimitsInner>**](GetApiKeyRateLimits200ResponseDataRateLimitsInnerRateLimitsInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeyRateLimits200ResponseDataRateLimitsInner.new(
+  api_model_id: venice-uncensored,
+  rate_limits: null
+)
+```
+

data/docs/GetApiKeyRateLimits200ResponseDataRateLimitsInnerRateLimitsInner.md

@@ -0,0 +1,20 @@
+# VeniceClient::GetApiKeyRateLimits200ResponseDataRateLimitsInnerRateLimitsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | The rate limit for the API model. |  |
+| **type** | **String** | The time period for the rate limit. Can be Requests Per Minute (RPM), Requests Per Day (RPD), or Tokens Per Minute (TPM). |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeyRateLimits200ResponseDataRateLimitsInnerRateLimitsInner.new(
+  amount: 100,
+  type: RPM
+)
+```
+

data/docs/GetApiKeys200Response.md

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

data/docs/GetApiKeys200ResponseDataInner.md

@@ -0,0 +1,34 @@
+# VeniceClient::GetApiKeys200ResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key_type** | **String** | API Key type |  |
+| **consumption_limits** | [**GetApiKeys200ResponseDataInnerConsumptionLimits**](GetApiKeys200ResponseDataInnerConsumptionLimits.md) |  |  |
+| **created_at** | **String** | API Key creation date |  |
+| **description** | **String** | API Key description | [optional] |
+| **expires_at** | **String** | API Key expiration date |  |
+| **id** | **String** | API Key ID |  |
+| **last6_chars** | **String** | Last 6 characters of the API Key |  |
+| **last_used_at** | **String** | API Key last used date |  |
+| **usage** | [**GetApiKeys200ResponseDataInnerUsage**](GetApiKeys200ResponseDataInnerUsage.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeys200ResponseDataInner.new(
+  api_key_type: ADMIN,
+  consumption_limits: null,
+  created_at: 2023-10-01T12:00:00Z,
+  description: Example API Key,
+  expires_at: 2023-10-01T12:00:00Z,
+  id: e28e82dc-9df2-4b47-b726-d0a222ef2ab5,
+  last6_chars: 2V2jNW,
+  last_used_at: 2023-10-01T12:00:00Z,
+  usage: null
+)
+```
+

data/docs/GetApiKeys200ResponseDataInnerConsumptionLimits.md

@@ -0,0 +1,22 @@
+# VeniceClient::GetApiKeys200ResponseDataInnerConsumptionLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** |  | [optional] |
+| **diem** | **Float** |  | [optional] |
+| **vcu** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeys200ResponseDataInnerConsumptionLimits.new(
+  usd: null,
+  diem: null,
+  vcu: null
+)
+```
+

data/docs/GetApiKeys200ResponseDataInnerUsage.md

@@ -0,0 +1,18 @@
+# VeniceClient::GetApiKeys200ResponseDataInnerUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **trailing_seven_days** | [**GetApiKeys200ResponseDataInnerUsageTrailingSevenDays**](GetApiKeys200ResponseDataInnerUsageTrailingSevenDays.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeys200ResponseDataInnerUsage.new(
+  trailing_seven_days: null
+)
+```
+

data/docs/GetApiKeys200ResponseDataInnerUsageTrailingSevenDays.md

@@ -0,0 +1,22 @@
+# VeniceClient::GetApiKeys200ResponseDataInnerUsageTrailingSevenDays
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **String** | USD usage in the trailing 7 days |  |
+| **vcu** | **String** | VCU usage in the trailing 7 days (deprecated - use Diem instead) |  |
+| **diem** | **String** | Diem usage in the trailing 7 days |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetApiKeys200ResponseDataInnerUsageTrailingSevenDays.new(
+  usd: 10.2424,
+  vcu: 42.2315,
+  diem: 4.2231
+)
+```
+

data/docs/GetBillingUsage200Response.md

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

data/docs/GetBillingUsage200ResponseDataInner.md

@@ -0,0 +1,32 @@
+# VeniceClient::GetBillingUsage200ResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | The total amount charged for the billing usage entry |  |
+| **currency** | **String** | The currency charged for the billing usage entry |  |
+| **inference_details** | [**GetBillingUsage200ResponseDataInnerInferenceDetails**](GetBillingUsage200ResponseDataInnerInferenceDetails.md) |  |  |
+| **notes** | **String** | Notes about the billing usage entry |  |
+| **price_per_unit_usd** | **Float** | The price per unit in USD |  |
+| **sku** | **String** | The product associated with the billing usage entry |  |
+| **timestamp** | **String** | The timestamp the billing usage entry was created |  |
+| **units** | **Float** | The number of units consumed |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetBillingUsage200ResponseDataInner.new(
+  amount: null,
+  currency: USD,
+  inference_details: null,
+  notes: null,
+  price_per_unit_usd: null,
+  sku: null,
+  timestamp: 2025-01-01T00:00:00Z,
+  units: null
+)
+```
+

data/docs/GetBillingUsage200ResponseDataInnerInferenceDetails.md

@@ -0,0 +1,24 @@
+# VeniceClient::GetBillingUsage200ResponseDataInnerInferenceDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completion_tokens** | **Float** | Number of tokens used in the completion. Only present for LLM usage. |  |
+| **inference_execution_time** | **Float** | Time taken for inference execution in milliseconds |  |
+| **prompt_tokens** | **Float** | Number of tokens requested in the prompt. Only present for LLM usage. |  |
+| **request_id** | **String** | Unique identifier for the inference request |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetBillingUsage200ResponseDataInnerInferenceDetails.new(
+  completion_tokens: null,
+  inference_execution_time: null,
+  prompt_tokens: null,
+  request_id: null
+)
+```
+

data/docs/GetBillingUsage200ResponsePagination.md

@@ -0,0 +1,24 @@
+# VeniceClient::GetBillingUsage200ResponsePagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  |  |
+| **page** | **Float** |  |  |
+| **total** | **Float** |  |  |
+| **total_pages** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::GetBillingUsage200ResponsePagination.new(
+  limit: null,
+  page: null,
+  total: null,
+  total_pages: null
+)
+```
+