runapi-ideogram-v3 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc1b721eb9666ebffa9d974a30ffb4f015b4d69ca74ead610686c17b6b0bcff2
-  data.tar.gz: 786042996e23818cdb4bc76eb869812176acd99415210cff8ddd68bdb16bea17
+  metadata.gz: dde03331810a873fb90e94add731e8b5ba2fb708b65793635ba116c62da37097
+  data.tar.gz: 30b5662428e00828dbe82f6a86c3d606cd250a1146bc2587bf634bda637985dd
 SHA512:
-  metadata.gz: 8f266081742ba4681706682f442ede15030f87414320db93931a0ecf01bc4c93de779b8bbdf373bd82c0c9a5476aade094f3e53c53bd20c2c606f37974a64496
-  data.tar.gz: 67f3908f740aea4409b719a265b019d5da5fdd538ff5e2ddd4b02173ec5b7c01b22c452ead216da9f663c1717996a9b381696d3447e8fff8b0e1d87f08c8d1cc
+  metadata.gz: 844c94f0cc39f4f591ea2cef59d31f7db91b0a33e0901df371e027b3bb14e80ff12cacb73c295b039894a3236b6f047fee0d9ce6fa7b046b590c6502246677c9
+  data.tar.gz: 32848ec85bbdc5d9b57e2e45215260a0652a40053a9d7584061d6aeebabaa8ebc46cf96f831bfd55d7513d9a90b6ed22479e6c0c5842f1948cdb81f6e96db771

data/README.md

@@ -25,6 +25,8 @@ status = client.text_to_image.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::IdeogramV3` error classes when building image jobs, Rails workers, or scripts. The available resources are `text_to_image`, `edit_image`, `remix_image`, and `reframe_image`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/ideogram_v3/client.rb

@@ -4,24 +4,27 @@ module RunApi
   module IdeogramV3
     # Ideogram V3 image generation API client.
     #
+    # Supports text-to-image, inpaint editing, remix, and reframe operations.
+    # Character model variants add character consistency from reference images.
+    #
     # @example
     #   client = RunApi::IdeogramV3::Client.new(api_key: "your-api-key")
     #   result = client.text_to_image.run(
     #     model: "ideogram-v3-text-to-image",
     #     prompt: "A cinematic lakeside at twilight"
     #   )
-    class Client
-      # @return [Resources::TextToImage] Text-to-image operations.
-      # @return [Resources::EditImage] Inpaint-with-mask operations.
-      # @return [Resources::RemixImage] Image remix operations.
-      # @return [Resources::ReframeImage] Image reframe operations.
-      attr_reader :text_to_image, :edit_image, :remix_image, :reframe_image
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation operations.
+      attr_reader :text_to_image
+      # @return [Resources::EditImage] Inpaint-with-mask editing operations.
+      attr_reader :edit_image
+      # @return [Resources::RemixImage] Prompt-guided image variation operations.
+      attr_reader :remix_image
+      # @return [Resources::ReframeImage] Aspect ratio reframing operations.
+      attr_reader :reframe_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)
         @edit_image = Resources::EditImage.new(http)
         @remix_image = Resources::RemixImage.new(http)

data/lib/runapi/ideogram_v3/resources/edit_image.rb

@@ -3,7 +3,7 @@
 module RunApi
   module IdeogramV3
     module Resources
-      # Inpaint with mask (model: ideogram-v3-edit).
+      # Inpaint editing using a mask to define the regenerated region.
       class EditImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/ideogram_v3/resources/reframe_image.rb

@@ -3,7 +3,7 @@
 module RunApi
   module IdeogramV3
     module Resources
-      # Reframe an input image (model: ideogram-v3-reframe).
+      # Extends or crops an image to a new aspect ratio without regenerating content.
       class ReframeImage
         include RunApi::Core::ResourceHelpers
 

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

@@ -3,7 +3,7 @@
 module RunApi
   module IdeogramV3
     module Resources
-      # Image remix (model: ideogram-v3-remix).
+      # Creates a variation of a source image guided by a new text prompt.
       class RemixImage
         include RunApi::Core::ResourceHelpers
 

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

@@ -3,7 +3,7 @@
 module RunApi
   module IdeogramV3
     module Resources
-      # Text-to-image generation (model: ideogram-v3-text-to-image).
+      # Generates images from text with configurable speed, style, and aspect ratio.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/ideogram_v3/types.rb

@@ -2,6 +2,8 @@
 
 module RunApi
   module IdeogramV3
+    # Type definitions and constants for Ideogram V3.
+    # Character model variants add character consistency from reference images.
     module Types
       GENERATION_MODEL = "ideogram-v3-text-to-image"
       EDIT_MODEL = "ideogram-v3-edit"
@@ -11,16 +13,23 @@ module RunApi
       CHARACTER_REMIX_MODEL = "ideogram-v3-character-remix"
       REFRAME_MODEL = "ideogram-v3-reframe"
 
+      # Speed-quality tradeoff: turbo is fastest, quality is highest fidelity.
       RENDERING_SPEEDS = %w[turbo balanced quality].freeze
+      # Visual style presets for standard (non-character) models.
       STYLES = %w[auto general realistic design].freeze
+      # Visual style presets for character-consistency models.
       CHARACTER_STYLES = %w[auto realistic fiction].freeze
       ASPECT_RATIOS = %w[1:1 3:4 9:16 4:3 16:9].freeze
+      # Number of images per request (1-4).
       OUTPUT_COUNTS = [1, 2, 3, 4].freeze
 
+      # A single generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Normalized response for all Ideogram V3 endpoints.
+      # +images+ is populated once +status+ is +"completed"+.
       class IdeogramResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-ideogram-v3
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 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 ideogram api Ruby SDK is the language-specific package for Ideogram
   V3 on RunAPI. Use this ideogram api package for text-to-image, character reference
   generation, edit, remix, reframe, and creative production flows when your application