venice_client 1.0.1 → 1.0.2

data/docs/ModelsApi.md

@@ -2,50 +2,73 @@
 
 All URIs are relative to *https://api.venice.ai/api/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list_model_compatibility_mapping**](ModelsApi.md#list_model_compatibility_mapping) | **GET** /models/compatibility_mapping | /api/v1/models/compatibility_mapping
-[**list_model_traits**](ModelsApi.md#list_model_traits) | **GET** /models/traits | /api/v1/models/traits
-[**list_models**](ModelsApi.md#list_models) | **GET** /models | /api/v1/models
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_model_compatibility_mapping**](ModelsApi.md#list_model_compatibility_mapping) | **GET** /models/compatibility_mapping | /api/v1/models/compatibility_mapping |
+| [**list_model_traits**](ModelsApi.md#list_model_traits) | **GET** /models/traits | /api/v1/models/traits |
+| [**list_models**](ModelsApi.md#list_models) | **GET** /models | /api/v1/models |
 
-# **list_model_compatibility_mapping**
-> InlineResponse2006 list_model_compatibility_mapping(opts)
+
+## list_model_compatibility_mapping
+
+> <ListModelCompatibilityMapping200Response> list_model_compatibility_mapping(opts)
 
 /api/v1/models/compatibility_mapping
 
 Returns a list of model compatibility mappings and the associated model.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'venice_client'
 # setup authorization
 VeniceClient.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = VeniceClient::ModelsApi.new
-opts = { 
-  type: 'text' # String | 
+opts = {
+  type: 'embedding' # String | 
 }
 
 begin
-  #/api/v1/models/compatibility_mapping
+  # /api/v1/models/compatibility_mapping
   result = api_instance.list_model_compatibility_mapping(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ModelsApi->list_model_compatibility_mapping: #{e}"
+  puts "Error when calling ModelsApi->list_model_compatibility_mapping: #{e}"
+end
+```
+
+#### Using the list_model_compatibility_mapping_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListModelCompatibilityMapping200Response>, Integer, Hash)> list_model_compatibility_mapping_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/models/compatibility_mapping
+  data, status_code, headers = api_instance.list_model_compatibility_mapping_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListModelCompatibilityMapping200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ModelsApi->list_model_compatibility_mapping_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **type** | **String**|  | [optional] [default to text]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to &#39;text&#39;] |
 
 ### Return type
 
-[**InlineResponse2006**](InlineResponse2006.md)
+[**ListModelCompatibilityMapping200Response**](ListModelCompatibilityMapping200Response.md)
 
 ### Authorization
 
@@ -53,49 +76,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_model_traits
 
-# **list_model_traits**
-> InlineResponse2005 list_model_traits(opts)
+> <ListModelTraits200Response> list_model_traits(opts)
 
 /api/v1/models/traits
 
 Returns a list of model traits and the associated model.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'venice_client'
 # setup authorization
 VeniceClient.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = VeniceClient::ModelsApi.new
-opts = { 
-  type: 'text' # String | 
+opts = {
+  type: 'embedding' # String | 
 }
 
 begin
-  #/api/v1/models/traits
+  # /api/v1/models/traits
   result = api_instance.list_model_traits(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ModelsApi->list_model_traits: #{e}"
+  puts "Error when calling ModelsApi->list_model_traits: #{e}"
+end
+```
+
+#### Using the list_model_traits_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListModelTraits200Response>, Integer, Hash)> list_model_traits_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/models/traits
+  data, status_code, headers = api_instance.list_model_traits_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListModelTraits200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ModelsApi->list_model_traits_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **type** | **String**|  | [optional] [default to text]
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional][default to &#39;text&#39;] |
 
 ### Return type
 
-[**InlineResponse2005**](InlineResponse2005.md)
+[**ListModelTraits200Response**](ListModelTraits200Response.md)
 
 ### Authorization
 
@@ -103,49 +147,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## list_models
 
-# **list_models**
-> InlineResponse2004 list_models(opts)
+> <ListModels200Response> list_models(opts)
 
 /api/v1/models
 
 Returns a list of available models supported by the Venice.ai API for both text and image inference.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'venice_client'
 # setup authorization
 VeniceClient.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = VeniceClient::ModelsApi.new
-opts = { 
-  type: VeniceClient::Type.new # Type | 
+opts = {
+  type: VeniceClient::ListModelsTypeParameter.new # ListModelsTypeParameter | 
 }
 
 begin
-  #/api/v1/models
+  # /api/v1/models
   result = api_instance.list_models(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ModelsApi->list_models: #{e}"
+  puts "Error when calling ModelsApi->list_models: #{e}"
+end
+```
+
+#### Using the list_models_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListModels200Response>, Integer, Hash)> list_models_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/models
+  data, status_code, headers = api_instance.list_models_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListModels200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ModelsApi->list_models_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **type** | [**Type**](.md)|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**ListModelsTypeParameter**](.md) |  | [optional] |
 
 ### Return type
 
-[**InlineResponse2004**](InlineResponse2004.md)
+[**ListModels200Response**](ListModels200Response.md)
 
 ### Authorization
 
@@ -153,8 +218,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/ObjectsInner.md

@@ -0,0 +1,49 @@
+# VeniceClient::ObjectsInner
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'venice_client'
+
+VeniceClient::ObjectsInner.openapi_one_of
+# =>
+# [
+#   :'ImageUrl',
+#   :'Text'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'venice_client'
+
+VeniceClient::ObjectsInner.build(data)
+# => #<ImageUrl:0x00007fdd4aab02a0>
+
+VeniceClient::ObjectsInner.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `ImageUrl`
+- `Text`
+- `nil` (if no type matches)
+

data/docs/PostApiKeyGenerateWeb3KeyRequest.md

@@ -0,0 +1,30 @@
+# VeniceClient::PostApiKeyGenerateWeb3KeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_key_type** | **String** | The API Key type. Admin keys have full access to the API while inference keys are only able to call inference endpoints. |  |
+| **consumption_limit** | [**GetApiKeys200ResponseDataInnerConsumptionLimits**](GetApiKeys200ResponseDataInnerConsumptionLimits.md) |  | [optional] |
+| **description** | **String** | The API Key description | [optional][default to 'Web3 API Key'] |
+| **expires_at** | [**CreateApiKeyRequestExpiresAt**](CreateApiKeyRequestExpiresAt.md) |  | [optional] |
+| **address** | **String** | The wallet's address |  |
+| **signature** | **String** | The token, signed with the wallet's private key |  |
+| **token** | **String** | The token obtained from https://api.venice.ai/api/v1/api_keys/generate_web3_key |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::PostApiKeyGenerateWeb3KeyRequest.new(
+  api_key_type: ADMIN,
+  consumption_limit: null,
+  description: Web3 API Key,
+  expires_at: null,
+  address: 0x45B73055F3aDcC4577Bb709db10B19d11b5c94eE,
+  signature: 0xbb5ff2e177f3a97fa553057864ad892eb64120f3eaf9356b4742a10f9a068d42725de895b5e45160b679cbe6961dc4cb552ba10dc97bdd8258d9154810785c451c,
+  token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+)
+```
+

data/docs/PreviewApi.md

@@ -2,42 +2,66 @@
 
 All URIs are relative to *https://api.venice.ai/api/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**list_characters**](PreviewApi.md#list_characters) | **GET** /characters | /api/v1/characters
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_characters**](PreviewApi.md#list_characters) | **GET** /characters | /api/v1/characters |
 
-# **list_characters**
-> InlineResponse20013 list_characters
+
+## list_characters
+
+> <ListCharacters200Response> list_characters
 
 /api/v1/characters
 
 This is a preview API and may change. Returns a list of characters supported in the API.
 
-### Example
+### Examples
+
 ```ruby
-# load the gem
+require 'time'
 require 'venice_client'
 # setup authorization
 VeniceClient.configure do |config|
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
 end
 
 api_instance = VeniceClient::PreviewApi.new
 
 begin
-  #/api/v1/characters
+  # /api/v1/characters
   result = api_instance.list_characters
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling PreviewApi->list_characters: #{e}"
+  puts "Error when calling PreviewApi->list_characters: #{e}"
+end
+```
+
+#### Using the list_characters_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCharacters200Response>, Integer, Hash)> list_characters_with_http_info
+
+```ruby
+begin
+  # /api/v1/characters
+  data, status_code, headers = api_instance.list_characters_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCharacters200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling PreviewApi->list_characters_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
+
 This endpoint does not need any parameter.
 
 ### Return type
 
-[**InlineResponse20013**](InlineResponse20013.md)
+[**ListCharacters200Response**](ListCharacters200Response.md)
 
 ### Authorization
 
@@ -45,8 +69,6 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
+- **Content-Type**: Not defined
+- **Accept**: application/json
 

data/docs/SimpleGenerateImage200Response.md

@@ -0,0 +1,20 @@
+# VeniceClient::SimpleGenerateImage200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created** | **Integer** | Unix timestamp for when the request was created |  |
+| **data** | [**Array<SimpleGenerateImage200ResponseDataInner>**](SimpleGenerateImage200ResponseDataInner.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::SimpleGenerateImage200Response.new(
+  created: 1713833628,
+  data: null
+)
+```
+

data/docs/SimpleGenerateImage200ResponseDataInner.md

@@ -0,0 +1,20 @@
+# VeniceClient::SimpleGenerateImage200ResponseDataInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **b64_json** | **String** | Base64-encoded JSON string of the generated image |  |
+| **url** | **String** | Data URL of the generated image |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::SimpleGenerateImage200ResponseDataInner.new(
+  b64_json: iVBORw0KGgoAAAANSUhEUgAA...,
+  url: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...
+)
+```
+

data/docs/SimpleGenerateImage200ResponseDataInnerAnyOf.md

@@ -0,0 +1,18 @@
+# VeniceClient::SimpleGenerateImage200ResponseDataInnerAnyOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **b64_json** | **String** | Base64-encoded JSON string of the generated image |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::SimpleGenerateImage200ResponseDataInnerAnyOf.new(
+  b64_json: iVBORw0KGgoAAAANSUhEUgAA...
+)
+```
+

data/docs/SimpleGenerateImage200ResponseDataInnerAnyOf1.md

@@ -0,0 +1,18 @@
+# VeniceClient::SimpleGenerateImage200ResponseDataInnerAnyOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Data URL of the generated image |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::SimpleGenerateImage200ResponseDataInnerAnyOf1.new(
+  url: data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...
+)
+```
+

data/docs/SimpleGenerateImageRequest.md

@@ -1,18 +1,40 @@
 # VeniceClient::SimpleGenerateImageRequest
 
 ## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**background** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional] [default to 'auto']
-**model** | **String** | The model to use for image generation. Defaults to Venice's default image model. If a non-existent model is specified (ie an OpenAI model name), it will default to Venice's default image model. | [optional] [default to 'default']
-**moderation** | **String** | auto enables safe venice mode which will blur out adult content. low disables safe venice mode. | [optional] [default to 'auto']
-**n** | **Integer** | Number of images to generate. Venice presently only supports 1 image per request. | [optional] [default to 1]
-**output_compression** | **Integer** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional] [default to 100]
-**output_format** | **String** | Output format for generated images | [optional] [default to 'png']
-**prompt** | **String** | A text description of the desired image. | 
-**quality** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional] [default to 'auto']
-**response_format** | **String** | Response format. URL will be a data URL. | [optional] [default to 'b64_json']
-**size** | **String** | Size of generated images. Default is 1024x1024 | [optional] [default to 'auto']
-**style** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional] [default to 'natural']
-**user** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional] 
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **background** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional][default to 'auto'] |
+| **model** | **String** | The model to use for image generation. Defaults to Venice's default image model. If a non-existent model is specified (ie an OpenAI model name), it will default to Venice's default image model. | [optional][default to 'default'] |
+| **moderation** | **String** | auto enables safe venice mode which will blur out adult content. low disables safe venice mode. | [optional][default to 'auto'] |
+| **n** | **Integer** | Number of images to generate. Venice presently only supports 1 image per request. | [optional][default to 1] |
+| **output_compression** | **Integer** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional][default to 100] |
+| **output_format** | **String** | Output format for generated images | [optional][default to 'png'] |
+| **prompt** | **String** | A text description of the desired image. |  |
+| **quality** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional][default to 'auto'] |
+| **response_format** | **String** | Response format. URL will be a data URL. | [optional][default to 'b64_json'] |
+| **size** | **String** | Size of generated images. Default is 1024x1024 | [optional][default to 'auto'] |
+| **style** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional][default to 'natural'] |
+| **user** | **String** | This parameter is not used in Venice image generation but is supported for compatibility with OpenAI API | [optional] |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::SimpleGenerateImageRequest.new(
+  background: auto,
+  model: hidream,
+  moderation: auto,
+  n: 1,
+  output_compression: null,
+  output_format: png,
+  prompt: A beautiful sunset over mountain ranges,
+  quality: auto,
+  response_format: b64_json,
+  size: 1024x1024,
+  style: natural,
+  user: user123
+)
+```