runapi-imagen-4 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f4e5fd22878c20e6318ec7fc7bdd5e7effe61fae9befa12bffdba5db425a4f7
-  data.tar.gz: ec0458e1aae7aa8258c38b5087fd4cdf082eb296a7e7bd310cec8aade7591f49
+  metadata.gz: 0bbf9045af4c340dcafd79540eb6ad94787e442eca639d8d274553212b94fe4b
+  data.tar.gz: 3dbfbfe5bb5b55cc79425a7c453299cb293805d0069e506dc31062811329fdb6
 SHA512:
-  metadata.gz: 7bd0e43504a2503944520588dfbc0d54bfdd9853e14d278cc8f8cefe89415e7925ae5b44cf9f966ed3d647b64f5b4800f505da2baf2cffbd375ce8cc624bbd40
-  data.tar.gz: f4af6fed80942b5b91c87ea59b4ca1c2779acc988e10f2c1ee744983181aa532cc2d8a1ef514b457e1b97b474112c2895ad8505dc456ebcb4fa6b5eb9a388df9
+  metadata.gz: a88bfe60addfcf7ff41e0dba18c93b3809c57330d837c2dacc5ca1e630edc770cfcddf7ae818632fa13f4c206426824104d1d735740a6a94bb9a9491a9069a74
+  data.tar.gz: 600070f645056e36fa40caafcfb165e746ff69a572dcb4da4c9fb5d91bdd801f4cdcc77fff0668968cd01e902f3515f7020cb34ccb9c77d67b128efea0771dde

data/README.md

@@ -24,6 +24,8 @@ status = client.generations.get(task.id)
 
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
 
+RunAPI-generated file URLs are temporary. Download and store generated images, videos, audio, or other files in your own durable storage within 7 days; do not treat returned URLs as long-term assets.
+
 ## Language notes
 
 Use Ruby keyword arguments and the `RunApi::Imagen4` error classes when building image jobs, Rails workers, or scripts. The available resources include generations. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/imagen_4/client.rb

@@ -2,13 +2,24 @@
 
 module RunApi
   module Imagen4
-    class Client
-      attr_reader :text_to_image, :remix_image
+    # Imagen 4 text-to-image and remix API client.
+    #
+    # Three text-to-image quality tiers (imagen-4, imagen-4-fast, imagen-4-ultra)
+    # and a dedicated remix model for guided image transformation.
+    #
+    # @example
+    #   client = RunApi::Imagen4::Client.new(api_key: "your-api-key")
+    #   result = client.text_to_image.run(
+    #     model: "imagen-4", prompt: "A photorealistic mountain landscape"
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation across quality tiers.
+      attr_reader :text_to_image
+      # @return [Resources::RemixImage] Remix existing images with text-guided transformations.
+      attr_reader :remix_image
 
       def initialize(api_key: nil, **options)
-        @api_key = Core::Auth.resolve_api_key(api_key)
-        client_options = Core::ClientOptions.new(api_key: @api_key, **options)
-        http = client_options.http_client || Core::HttpClient.new(client_options)
+        super
         @text_to_image = Resources::TextToImage.new(http)
         @remix_image = Resources::RemixImage.new(http)
       end

data/lib/runapi/imagen_4/resources/remix_image.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Imagen4
     module Resources
+      # Imagen 4 image remix resource.
+      # Transform source images guided by a text prompt (up to 8 source images).
       class RemixImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/imagen_4/resources/text_to_image.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Imagen4
     module Resources
+      # Imagen 4 text-to-image generation resource.
+      # Generate images from text with three quality tiers; imagen-4-fast supports batch output.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/imagen_4/types.rb

@@ -2,16 +2,22 @@
 
 module RunApi
   module Imagen4
+    # Imagen 4 type constants and response models.
+    # Text-to-image supports three quality tiers; remix accepts source images
+    # with extended aspect ratios, resolution, and format control.
     module Types
       TEXT_MODELS = %w[imagen-4 imagen-4-fast imagen-4-ultra].freeze
       REMIX_MODELS = %w[imagen-4-pro-remix-image].freeze
       MODELS = (TEXT_MODELS + REMIX_MODELS).freeze
       TEXT_ASPECT_RATIOS = %w[1:1 16:9 9:16 3:4 4:3].freeze
+      # Extended aspect ratios for remix, including "auto" which infers from source images.
       PRO_ASPECT_RATIOS = %w[1:1 2:3 3:2 3:4 4:3 4:5 5:4 9:16 16:9 21:9 auto].freeze
       OUTPUT_RESOLUTIONS = %w[1k 2k 4k].freeze
       OUTPUT_FORMATS = %w[png jpg].freeze
+      # Batch sizes for imagen-4-fast (the only model supporting multi-image output).
       OUTPUT_COUNTS = [1, 2, 3, 4].freeze
 
+      # A generated image with its CDN URL and optional unprocessed origin URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
         optional :origin_url, String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-imagen-4
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
 description: The imagen api Ruby SDK is the language-specific package for Imagen 4
   on RunAPI. Use this imagen api package for text-to-image, image editing, and creative
   production flows when your application needs JSON request bodies, task status lookup,