getimg_client 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1028c687dea86e569bd237794d0a391db97d4079d7bbcdaa564eb5aff5fc1bc0
-  data.tar.gz: eac3cb2255aadf16b2c271aa3515201fd2a4bd55b5605ed276ebaac6e1252d92
+  metadata.gz: 49df7df20de9d97f5bc96e06eb517c007f55101e61b56c6d33d4878687f13249
+  data.tar.gz: 4dc36a54730384489acb5068e24e55fd272186f1c6cafb610272f05b777e522c
 SHA512:
-  metadata.gz: 015ba46c1a34e85ceb8bc42727ffcc0abc99a596167fdc33d9adc1bd10b79502bf3831be68f31344025db72cb9ff0f08b8d836834582bb0f77cfb5f906d04f72
-  data.tar.gz: 76b468d1a099a92316f25cd531189348381572841f5ab82ea96acd19a2c226488b3335fda0a52ca4e5ded3f34b6ad253741b57a6e2028c75c5d4c0053e09c44b
+  metadata.gz: c2a3a252131ecfca467e4ca97704a6d1d86d3ac4d0f8840a9f18c03a2686b5bdff4322ddf09e697d6cc765e5cd743579580c6be70c2b6a6a0df0c1c51aa9781d
+  data.tar.gz: 586153f30ac2646900cd7e0ad87d531ec1151ea53c5a7dd3271f0120774531f1df2f6ad1ee608a47ab8020a9e223ed42171932a0e66f3845725dfff1e790271e

data/README.md

@@ -1,4 +1,4 @@
-# GetimgClient
+# GetimgClient [![Gem Version](https://badge.fury.io/rb/getimg_client.svg)](https://badge.fury.io/rb/getimg_client)
 
 ## Introduction
 GetimgClient is a Ruby gem designed to interact with the Getimg.ai API, enabling users to generate, manipulate, and enhance images using various AI models. This gem simplifies the process of making API requests to Getimg.ai, allowing for seamless integration of image generation and manipulation capabilities into your Ruby applications.
@@ -46,14 +46,14 @@ Fetch and cache the list of available models from the API.
 ### `models`
 Retrieve cached models or fetch them if not already retrieved.
 
-### `generate_image(prompt, model:, **options)`
-Generate an image based on a text prompt and specified model. Supports various image manipulation methods such as image-to-image, inpainting, controlnet, face fixing, instruct and upscaling.
+### `generate_image(prompt, model: :essential, **options)`
+Generate an image based on a text prompt and specified model. Supports various image manipulation methods such as image-to-image, inpainting, controlnet, face fixing, instruct, and upscaling. Specifying a model is optional; by default, it will invoke the Essential V1 endpoint.
 
 ### `get_balance`
 Retrieve the current account balance from the Getimg.ai API.
 
 ## Request Routing
-The `generate_image` method routes requests based on the provided options and the model's supported pipelines, sending it to its respective pipeline whether that's SD1.5, SDXL or LCM based:
+The `generate_image` method routes requests based on the provided options and the model's supported pipelines, sending it to its respective pipeline whether that's SD1.5, SDXL, Essential, or LCM based:
 - **text-to-image**: Default if no images are provided.
 - **image-to-image**: Triggered if a base image is provided.
 - **inpaint**: Triggered if a mask image is provided.
@@ -82,8 +82,12 @@ If an HTTP error occurs, the error message will include both the HTTP status and
 ## Models
 The provided `model` option will determine the model use, and contribute to the client's inference of the desired endpoint. Models can be the string `id` listed online at [the GetImg dashboard](https://dashboard.getimg.ai/models) or retrieved using the `GetimgClient.models` method. Equally, you can use symbols instead. For example, `:realistic_vision_v5_1` will translate to `'realistic-vision-v5-1'`
 
+## Essential
+Getimg offers the "essential" checkpoints, which perform more abstract Stable Diffusion operations based on the provided prompt. Note that *:essential* and *:essential_v2* will *not* be listed in the model listing, as these are not in fact actual models, nor valid "model" values at the API's end.
+In order to route a request to Essential or Essential V2 however, you can provide *:essential* or *:essential_v2* as a model argument in *#generate_image*.
+
 ## Latent Consistency Models (LCM)
-Latent consistency models are designed to speed up image generation by circumventing the iterative generation process of diffusion-based methods. Building on direct consistency models that operate on image pixels, latent consistency models operate in the latent (lower-dimensional) space. The client will automatically route requests to these models as needed.
+Latent Consistency Models (LCM) are optimized for faster image generation and lower costs by avoiding the repetitive steps of traditional diffusion methods. They work in a lower-dimensional space, resulting in quicker outputs but with slightly less detail compared to standard models.
 
 ## Base Image Options
 The `base_image` option can be provided, which will automatically set the "image" property for image-to-image, controlnet, face-fix, upscale, inpaint and instruct calls, and can be either a file path or a base64 encoded string of the file contents.
@@ -98,7 +102,13 @@ If all went well and no errors were reported, the response will be equal to the
 GetimgClient.set_api_key('your_api_key')
 ```
 
-### Generate Text-to-Image
+### Generate Text-to-Image using Essential V1 with default options
+```ruby
+result = GetimgClient.generate_image("A city skyline at night")
+puts result["image"]
+```
+
+### Generate Text-to-Image using Stable Diffusion 1.5
 ```ruby
 result = GetimgClient.generate_image("A scenic landscape", model: :stable_diffusion_v1_5, width: 512, height: 512)
 puts result["image"]
@@ -114,7 +124,7 @@ puts result["image"]
 ### Generate an image using Controlnet
 ```ruby
 base_image = "path/to/base_image.jpg"
-result = GetimgClient.generate_image("Enhance the scene", model: :stable_diffusion_v1_5, base_image:, strength: 0.7, controlnet: canny-1.1)
+result = GetimgClient.generate_image("Enhance the scene", model: :stable_diffusion_v1_5, base_image:, strength: 0.7, controlnet: 'canny-1.1')
 puts result["image"]
 ```
 
@@ -148,7 +158,21 @@ puts result["image"]
 ```
 
 ## Logging
-Request logging will automatically be enabled, if the **RAILS_ENV** environment variable is set to "development"
+GetimgClient supports logging request details for debugging and development purposes. The logging behavior depends on the environment and configuration:
+
+Rails Development Environment: If the **RAILS_ENV** environment variable is set to "development" and Rails is defined, logs will be sent to the Rails logger.
+
+**GETIMG_LOG** Environment Variable: If the GETIMG_LOG environment variable is set, logs will be printed to the standard output.
+
+#### Log output example
+```text
+Generating image with the following details:
+Prompt: A scenic landscape
+Model: stable-diffusion-v1-5
+Requested Pipeline: text-to-image
+Endpoint URI: https://api.getimg.ai/v1/stable-diffusion/text-to-image
+Options: {width: 512, height: 512}
+```
 
 ## Unit Testing
 The gem includes unit tests using Minitest. Integration tests make real API calls and will incur usage fees. Ensure your API key is set in the environment before running tests.

data/lib/endpoints.json

@@ -10,6 +10,7 @@
     "lcm_text_to_image": "https://api.getimg.ai/v1/latent-consistency/text-to-image",
     "lcm_image_to_image": "https://api.getimg.ai/v1/latent-consistency/image-to-image",
     "essential_text_to_image": "https://api.getimg.ai/v1/essential/text-to-image",
+    "essentialv2_text_to_image": "https://api.getimg.ai/v1/essential-v2/text-to-image",
     "face_fix": "https://api.getimg.ai/v1/enhancements/face-fix",
     "upscale": "https://api.getimg.ai/v1/enhancements/upscale",
     "models": "https://api.getimg.ai/v1/models",

data/lib/getimg_client.rb

@@ -32,7 +32,7 @@ class GetimgClient
   end
 
   # Generate an image based on the prompt and model
-  def self.generate_image(prompt, model:, **options)
+  def self.generate_image(prompt, model: :essential, **options)
     # Validate the prompt
     raise ArgumentError, 'Prompt is required' unless prompt.is_a?(String) && !prompt.strip.empty?
 
@@ -43,7 +43,11 @@ class GetimgClient
 
     # Convert model to appropriate ID format
     model_id = model.to_s.gsub('_', '-')
-    model_info = models[model_id] || raise(ArgumentError, "Unknown model: #{model}")
+    if %w[essential essential-v2].include?(model_id)
+      model_info = models[model_id] || { name: model_id, pipelines: ['text-to-image'] }
+    else
+      model_info = models[model_id] || raise(ArgumentError, "Unknown model: #{model}")
+    end
 
     # Determine the requested pipeline
     requested_pipeline = method_requested(base_image, mask_image_path, controlnet, model_info).to_s.gsub('_', '-')
@@ -54,7 +58,7 @@ class GetimgClient
     end
 
     # Determine the endpoint key based on the model family and pipeline
-    endpoint_key = determine_endpoint_key(model_info, requested_pipeline)
+    endpoint_key = determine_endpoint_key(model_info, requested_pipeline, model_id)
     uri = URI(API_ENDPOINTS[endpoint_key.to_s])
 
     # Handle image to image, controlnet, instruct, inpaint, face-fix, and upscale pipelines
@@ -71,16 +75,8 @@ class GetimgClient
     # Ensure scale is an integer if present
     options[:scale] = options[:scale].to_i if options[:scale]
 
-    # Logging request details in development environment
-    if ENV['RAILS_ENV'] == 'development'
-      puts "Generating image with the following details:"
-      puts "Prompt: #{prompt}"
-      puts "Model: #{model_id}"
-      puts "Requested Pipeline: #{requested_pipeline}"
-      puts "Endpoint URI: #{uri}"
-      truncated_options = options.transform_values { |v| v.is_a?(String) && v.length > 50 ? "#{v[0, 50]}..." : v }
-      puts "Options: #{truncated_options}"
-    end
+    # Log the request details
+    log_request_details(prompt, model_id, requested_pipeline, uri, options)
 
     # Create and send the request
     request = create_request(uri, prompt, model: model_id, **options)
@@ -101,6 +97,25 @@ class GetimgClient
 
   private
 
+  # Log request details
+  def self.log_request_details(prompt, model_id, requested_pipeline, uri, options)
+    log_message = <<~LOG
+      Generating image with the following details:
+      Prompt: #{prompt}
+      Model: #{model_id}
+      Requested Pipeline: #{requested_pipeline}
+      Endpoint URI: #{uri}
+      Options: #{options.transform_values { |v| v.is_a?(String) && v.length > 50 ? "#{v[0, 50]}..." : v }}
+    LOG
+
+    if ENV['RAILS_ENV'] === 'development' && defined?(Rails) && Rails.logger
+      Rails.logger.info(log_message)
+    end
+    if ENV['GETIMG_LOG']
+      puts log_message
+    end
+  end
+
   # Determine the requested method based on provided image paths, controlnet, and model_info
   def self.method_requested(base_image, mask_image_path, controlnet, model_info)
     return :controlnet if controlnet
@@ -113,8 +128,12 @@ class GetimgClient
   end
 
   # Determine the appropriate endpoint key based on the model family and pipeline
-  def self.determine_endpoint_key(model_info, requested_pipeline)
-    if model_info[:family] == 'stable-diffusion-xl'
+  def self.determine_endpoint_key(model_info, requested_pipeline, model_id)
+    if model_id == 'essential'
+      return :essential_text_to_image
+    elsif model_id == 'essential-v2'
+      return :essentialv2_text_to_image
+    elsif model_info[:family] == 'stable-diffusion-xl'
       return :sdxl_image_to_image if requested_pipeline == 'image-to-image'
       return :sdxl_inpaint if requested_pipeline == 'inpaint'
       return :sdxl_text_to_image
@@ -133,10 +152,8 @@ class GetimgClient
     request['accept'] = 'application/json'
     request['content-type'] = 'application/json'
 
-    body = {
-      prompt: prompt,
-      model: model
-    }.merge(options)
+    body = { prompt: prompt }.merge(options)
+    body[:model] = model unless %w[essential essential-v2].include?(model)
 
     request.body = body.to_json
     request

data/test/integration/getimg_client_integration_test.rb

@@ -1,11 +1,10 @@
 require_relative "../test_helper"
+require 'stringio'
 
 class GetimgClientIntegrationTest < Minitest::Test
   def setup
     @base_image = Base64.strict_encode64(File.read(File.join(__dir__, "sample_image.jpeg")))
-
     @small_image = Base64.strict_encode64(File.read(File.join(__dir__, "small_sample_image.jpeg")))
-
     @mask_image = Base64.strict_encode64(File.read(File.join(__dir__, "mask_image.jpeg")))
   end
 
@@ -58,6 +57,42 @@ class GetimgClientIntegrationTest < Minitest::Test
     save_image(result["image"], "test_upscale")
   end
 
+  def test_generate_text_to_image_essential
+    puts "-- Running test_generate_text_to_image_essential..."
+    result = GetimgClient.generate_image("A modern cityscape")
+    assert result["image"]
+    save_image(result["image"], "test_generate_text_to_image_essential")
+  end
+
+  def test_logging_to_rails_logger
+    skip "Rails not defined, skipping Rails logger test" unless defined?(Rails) && ENV['RAILS_ENV'] === 'development'
+
+    original_logger = Rails.logger
+    log_output = StringIO.new
+    Rails.logger = Logger.new(log_output)
+
+    GetimgClient.generate_image("A scenic landscape", model: :stable_diffusion_v1_5, width: 512, height: 512)
+
+    assert_includes log_output.string, "Generating image with the following details:"
+    assert_includes log_output.string, "Prompt: A scenic landscape"
+
+    Rails.logger = original_logger
+  end
+
+  def test_logging_to_puts
+    ENV['GETIMG_LOG'] = '1'
+    log_output = StringIO.new
+    $stdout = log_output
+
+    GetimgClient.generate_image("A scenic landscape", model: :stable_diffusion_v1_5, width: 512, height: 512)
+
+    assert_includes log_output.string, "Generating image with the following details:"
+    assert_includes log_output.string, "Prompt: A scenic landscape"
+
+    $stdout = STDOUT
+    ENV.delete('GETIMG_LOG')
+  end
+
   private
 
   def save_image(base64_image, filename)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: getimg_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Melvin Sommer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-15 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest