venice_client 1.0.1 → 1.0.2

data/docs/ImageApi.md

@@ -2,54 +2,75 @@
 
 All URIs are relative to *https://api.venice.ai/api/v1*
 
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**generate_image**](ImageApi.md#generate_image) | **POST** /image/generate | /api/v1/image/generate
-[**image_styles_get**](ImageApi.md#image_styles_get) | **GET** /image/styles | /api/v1/image/styles
-[**simple_generate_image**](ImageApi.md#simple_generate_image) | **POST** /images/generations | /api/v1/image/generations
-[**upscale_image**](ImageApi.md#upscale_image) | **POST** /image/upscale | /api/v1/image/upscale
-[**upscale_image**](ImageApi.md#upscale_image) | **POST** /image/upscale | /api/v1/image/upscale
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**edit_image**](ImageApi.md#edit_image) | **POST** /image/edit | /api/v1/image/edit |
+| [**generate_image**](ImageApi.md#generate_image) | **POST** /image/generate | /api/v1/image/generate |
+| [**image_styles_get**](ImageApi.md#image_styles_get) | **GET** /image/styles | /api/v1/image/styles |
+| [**simple_generate_image**](ImageApi.md#simple_generate_image) | **POST** /images/generations | /api/v1/image/generations |
+| [**upscale_image**](ImageApi.md#upscale_image) | **POST** /image/upscale | /api/v1/image/upscale |
 
-# **generate_image**
-> InlineResponse2001 generate_image(opts)
 
-/api/v1/image/generate
+## edit_image
 
-Generate an image based on input parameters
+> File edit_image(opts)
+
+/api/v1/image/edit
+
+Edit or modify an image based on the supplied prompt. The image can be provided either as a multipart form-data file upload or as a base64-encoded string in a JSON request.
+
+### Examples
 
-### Example
 ```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::ImageApi.new
-opts = { 
-  body: VeniceClient::GenerateImageRequest.new # GenerateImageRequest | 
-  accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br). Only applied when return_binary is false.
+opts = {
+  edit_image_request: VeniceClient::EditImageRequest.new({prompt: 'Change the color of the sky to a sunrise', image: 'image_example'}) # EditImageRequest | 
 }
 
 begin
-  #/api/v1/image/generate
-  result = api_instance.generate_image(opts)
+  # /api/v1/image/edit
+  result = api_instance.edit_image(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ImageApi->generate_image: #{e}"
+  puts "Error when calling ImageApi->edit_image: #{e}"
+end
+```
+
+#### Using the edit_image_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> edit_image_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/image/edit
+  data, status_code, headers = api_instance.edit_image_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ImageApi->edit_image_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**GenerateImageRequest**](GenerateImageRequest.md)|  | [optional] 
- **accept_encoding** | **String**| Supported compression encodings (gzip, br). Only applied when return_binary is false. | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **edit_image_request** | [**EditImageRequest**](EditImageRequest.md) |  | [optional] |
 
 ### Return type
 
-[**InlineResponse2001**](InlineResponse2001.md)
+**File**
 
 ### Authorization
 
@@ -57,43 +78,72 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json, image/jpeg, image/png, image/webp
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: image/png, application/json
 
 
+## generate_image
 
-# **image_styles_get**
-> InlineResponse2003 image_styles_get
+> <GenerateImage200Response> generate_image(opts)
 
-/api/v1/image/styles
+/api/v1/image/generate
 
-List available image styles that can be used with the generate API.
+Generate an image based on input parameters
+
+### Examples
 
-### Example
 ```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::ImageApi.new
+opts = {
+  accept_encoding: 'gzip, br', # String | Supported compression encodings (gzip, br). Only applied when return_binary is false.
+  generate_image_request: VeniceClient::GenerateImageRequest.new({model: 'hidream', prompt: 'A beautiful sunset over a mountain range'}) # GenerateImageRequest | 
+}
 
 begin
-  #/api/v1/image/styles
-  result = api_instance.image_styles_get
+  # /api/v1/image/generate
+  result = api_instance.generate_image(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ImageApi->image_styles_get: #{e}"
+  puts "Error when calling ImageApi->generate_image: #{e}"
+end
+```
+
+#### Using the generate_image_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GenerateImage200Response>, Integer, Hash)> generate_image_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/image/generate
+  data, status_code, headers = api_instance.generate_image_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GenerateImage200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ImageApi->generate_image_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
-This endpoint does not need any parameter.
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_encoding** | **String** | Supported compression encodings (gzip, br). Only applied when return_binary is false. | [optional] |
+| **generate_image_request** | [**GenerateImageRequest**](GenerateImageRequest.md) |  | [optional] |
 
 ### Return type
 
-[**InlineResponse2003**](InlineResponse2003.md)
+[**GenerateImage200Response**](GenerateImage200Response.md)
 
 ### Authorization
 
@@ -101,51 +151,65 @@ This endpoint does not need any parameter.
 
 ### HTTP request headers
 
- - **Content-Type**: Not defined
- - **Accept**: application/json
+- **Content-Type**: application/json
+- **Accept**: application/json, image/jpeg, image/png, image/webp
 
 
+## image_styles_get
 
-# **simple_generate_image**
-> InlineResponse2002 simple_generate_image(opts)
+> <ImageStylesGet200Response> image_styles_get
 
-/api/v1/image/generations
+/api/v1/image/styles
 
-Generate an image based on input parameters using an OpenAI compatible endpoint. This endpoint does not support the full feature set of the Venice Image Generation endpoint, but is compatible with the existing OpenAI endpoint.
+List available image styles that can be used with the generate API.
+
+### Examples
 
-### Example
 ```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::ImageApi.new
-opts = { 
-  body: VeniceClient::SimpleGenerateImageRequest.new # SimpleGenerateImageRequest | 
-  accept_encoding: 'accept_encoding_example' # String | Supported compression encodings (gzip, br).
-}
 
 begin
-  #/api/v1/image/generations
-  result = api_instance.simple_generate_image(opts)
+  # /api/v1/image/styles
+  result = api_instance.image_styles_get
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ImageApi->simple_generate_image: #{e}"
+  puts "Error when calling ImageApi->image_styles_get: #{e}"
+end
+```
+
+#### Using the image_styles_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ImageStylesGet200Response>, Integer, Hash)> image_styles_get_with_http_info
+
+```ruby
+begin
+  # /api/v1/image/styles
+  data, status_code, headers = api_instance.image_styles_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ImageStylesGet200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ImageApi->image_styles_get_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**SimpleGenerateImageRequest**](SimpleGenerateImageRequest.md)|  | [optional] 
- **accept_encoding** | **String**| Supported compression encodings (gzip, br). | [optional] 
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**InlineResponse2002**](InlineResponse2002.md)
+[**ImageStylesGet200Response**](ImageStylesGet200Response.md)
 
 ### Authorization
 
@@ -153,49 +217,72 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
- - **Accept**: application/json
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
+## simple_generate_image
 
-# **upscale_image**
-> String upscale_image(opts)
+> <SimpleGenerateImage200Response> simple_generate_image(opts)
 
-/api/v1/image/upscale
+/api/v1/image/generations
 
-Upscale or enhance an image based on the supplied parameters. Using a scale of 1 with enhance enabled will only run the enhancer. The image can be provided either as a multipart form-data file upload or as a base64-encoded string in a JSON request.
+Generate an image based on input parameters using an OpenAI compatible endpoint. This endpoint does not support the full feature set of the Venice Image Generation endpoint, but is compatible with the existing OpenAI endpoint.
+
+### Examples
 
-### Example
 ```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::ImageApi.new
-opts = { 
-  body: VeniceClient::UpscaleImageRequest.new # UpscaleImageRequest | 
+opts = {
+  accept_encoding: 'gzip, br', # String | Supported compression encodings (gzip, br).
+  simple_generate_image_request: VeniceClient::SimpleGenerateImageRequest.new({prompt: 'A beautiful sunset over mountain ranges'}) # SimpleGenerateImageRequest | 
 }
 
 begin
-  #/api/v1/image/upscale
-  result = api_instance.upscale_image(opts)
+  # /api/v1/image/generations
+  result = api_instance.simple_generate_image(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ImageApi->upscale_image: #{e}"
+  puts "Error when calling ImageApi->simple_generate_image: #{e}"
+end
+```
+
+#### Using the simple_generate_image_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimpleGenerateImage200Response>, Integer, Hash)> simple_generate_image_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/image/generations
+  data, status_code, headers = api_instance.simple_generate_image_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimpleGenerateImage200Response>
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ImageApi->simple_generate_image_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **body** | [**UpscaleImageRequest**](UpscaleImageRequest.md)|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **accept_encoding** | **String** | Supported compression encodings (gzip, br). | [optional] |
+| **simple_generate_image_request** | [**SimpleGenerateImageRequest**](SimpleGenerateImageRequest.md) |  | [optional] |
 
 ### Return type
 
-**String**
+[**SimpleGenerateImage200Response**](SimpleGenerateImage200Response.md)
 
 ### Authorization
 
@@ -203,59 +290,70 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, multipart/form-data
- - **Accept**: image/png, application/json
+- **Content-Type**: application/json
+- **Accept**: application/json
 
 
+## upscale_image
 
-# **upscale_image**
-> String upscale_image(opts)
+> File upscale_image(opts)
 
 /api/v1/image/upscale
 
 Upscale or enhance an image based on the supplied parameters. Using a scale of 1 with enhance enabled will only run the enhancer. The image can be provided either as a multipart form-data file upload or as a base64-encoded string in a JSON request.
 
-### 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::ImageApi.new
-opts = { 
-  enhance: VeniceClient::null.new #  | 
-  enhance_creativity: VeniceClient::BigDecimal.new # BigDecimal | 
-  enhance_prompt: 'enhance_prompt_example' # String | 
-  image: VeniceClient::null.new #  | 
-  replication: VeniceClient::BigDecimal.new # BigDecimal | 
-  scale: VeniceClient::BigDecimal.new # BigDecimal | 
+opts = {
+  upscale_image_request: VeniceClient::UpscaleImageRequest.new({image: 'image_example'}) # UpscaleImageRequest | 
 }
 
 begin
-  #/api/v1/image/upscale
+  # /api/v1/image/upscale
   result = api_instance.upscale_image(opts)
   p result
 rescue VeniceClient::ApiError => e
-  puts "Exception when calling ImageApi->upscale_image: #{e}"
+  puts "Error when calling ImageApi->upscale_image: #{e}"
+end
+```
+
+#### Using the upscale_image_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(File, Integer, Hash)> upscale_image_with_http_info(opts)
+
+```ruby
+begin
+  # /api/v1/image/upscale
+  data, status_code, headers = api_instance.upscale_image_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => File
+rescue VeniceClient::ApiError => e
+  puts "Error when calling ImageApi->upscale_image_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **enhance** | [****](.md)|  | [optional] 
- **enhance_creativity** | **BigDecimal**|  | [optional] 
- **enhance_prompt** | **String**|  | [optional] 
- **image** | [****](.md)|  | [optional] 
- **replication** | **BigDecimal**|  | [optional] 
- **scale** | **BigDecimal**|  | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **upscale_image_request** | [**UpscaleImageRequest**](UpscaleImageRequest.md) |  | [optional] |
 
 ### Return type
 
-**String**
+**File**
 
 ### Authorization
 
@@ -263,8 +361,6 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
- - **Content-Type**: application/json, multipart/form-data
- - **Accept**: image/png, application/json
-
-
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: image/png, application/json
 

data/docs/ImageModelConstraints.md

@@ -0,0 +1,22 @@
+# VeniceClient::ImageModelConstraints
+
+## 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. |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageModelConstraints.new(
+  prompt_character_limit: 2048,
+  steps: null,
+  width_height_divisor: 8
+)
+```
+

data/docs/ImageModelConstraintsSteps.md

@@ -0,0 +1,20 @@
+# VeniceClient::ImageModelConstraintsSteps
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **default** | **Float** | The default steps value for the model |  |
+| **max** | **Float** | The maximum supported steps value for the model |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageModelConstraintsSteps.new(
+  default: 25,
+  max: 50
+)
+```
+

data/docs/ImageModelPricing.md

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

data/docs/ImageModelPricingGeneration.md

@@ -0,0 +1,22 @@
+# VeniceClient::ImageModelPricingGeneration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** | USD cost per image generation |  |
+| **vcu** | **Float** | VCU cost per image generation (deprecated - use Diem instead) |  |
+| **diem** | **Float** | Diem cost per image generation |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageModelPricingGeneration.new(
+  usd: 0.01,
+  vcu: 0.1,
+  diem: 0.1
+)
+```
+

data/docs/ImageModelPricingUpscale.md

@@ -0,0 +1,20 @@
+# VeniceClient::ImageModelPricingUpscale
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_2x** | [**ImageModelPricingUpscale2x**](ImageModelPricingUpscale2x.md) |  |  |
+| **_4x** | [**ImageModelPricingUpscale4x**](ImageModelPricingUpscale4x.md) |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageModelPricingUpscale.new(
+  _2x: null,
+  _4x: null
+)
+```
+

data/docs/ImageModelPricingUpscale2x.md

@@ -0,0 +1,22 @@
+# VeniceClient::ImageModelPricingUpscale2x
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** | USD cost for 2x upscale |  |
+| **vcu** | **Float** | VCU cost for 2x upscale (deprecated - use Diem instead) |  |
+| **diem** | **Float** | Diem cost for 2x upscale |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageModelPricingUpscale2x.new(
+  usd: 0.02,
+  vcu: 0.2,
+  diem: 0.2
+)
+```
+

data/docs/ImageModelPricingUpscale4x.md

@@ -0,0 +1,22 @@
+# VeniceClient::ImageModelPricingUpscale4x
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **usd** | **Float** | USD cost for 4x upscale |  |
+| **vcu** | **Float** | VCU cost for 4x upscale (deprecated - use Diem instead) |  |
+| **diem** | **Float** | Diem cost for 4x upscale |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageModelPricingUpscale4x.new(
+  usd: 0.08,
+  vcu: 0.8,
+  diem: 0.8
+)
+```
+

data/docs/ImageStylesGet200Response.md

@@ -0,0 +1,20 @@
+# VeniceClient::ImageStylesGet200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | **Array<String>** | List of available image styles |  |
+| **object** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageStylesGet200Response.new(
+  data: ["3D Model","Analog Film","Anime","Cinematic","Comic Book"],
+  object: null
+)
+```
+

data/docs/ImageStylesGet500Response.md

@@ -0,0 +1,18 @@
+# VeniceClient::ImageStylesGet500Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | **String** | A description of the error |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageStylesGet500Response.new(
+  error: An unknown error occurred
+)
+```
+

data/docs/ImageURLObject.md

@@ -0,0 +1,18 @@
+# VeniceClient::ImageURLObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL of the image. Can be a data URL with a base64 encoded image or a public URL. URL must be publicly accessible. Image must pass validation checks and be >= 64 pixels square. |  |
+
+## Example
+
+```ruby
+require 'venice_client'
+
+instance = VeniceClient::ImageURLObject.new(
+  url: null
+)
+```
+