runapi-gpt-image-2 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93e24a0cc8419599b2adea4066cf690d2181f89e2b2644834373e971d542f38d
-  data.tar.gz: 7389dcf5a964ca44a6ecc6a377d1b989711503df69a267815ca41a0388691ae3
+  metadata.gz: 7664913b3073c7ef5cec93d7661a89f41df732140b1bb741f558b37a0c707484
+  data.tar.gz: ed6c4be520bcaaab01bf5a20be19cff0947ca1951c961fb8eae93a9713a62007
 SHA512:
-  metadata.gz: 8e0439329c6d4f35c72539f1f6fae4ed3a8948e0a848f2a3ca14451632f9e50a119491251c4c3c21fe1ff77cba5c087374ee56ac3d6cbb4301abc94228025516
-  data.tar.gz: 197a2fb299f84efa8a5a004765913658cc7112dade20daa15f1b1e4a53a6c712d3bb102dcc1d4903326d5bf707a9168f7c4631687869dc43f53d0017eaa6e990
+  metadata.gz: deeb9ac2db537db1101e79fe045c5906aac1b4e573f13dedf01dd562001e8047869612e2f5a0fcd5f80aafe9eae81a0ffe8580ce71930011d722439b06495b5b
+  data.tar.gz: 223abf29ac0d43b6c71113101e69b050c8618471c934c5c0a0d900c7718f3fe3612e5888213ddc1ae8530bab3528b1ac19c5949da121069c27cfe64015efa027

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::GptImage2` error classes when building image jobs, Rails workers, or scripts. The available resources include generations, and edits. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/gpt_image_2/client.rb

@@ -2,14 +2,31 @@
 
 module RunApi
   module GptImage2
-    class Client
-      attr_reader :text_to_image, :edit_image
+    # GPT Image 2 generation and editing API client.
+    #
+    # Supports up to 4k output resolution and 'auto' aspect ratio.
+    #
+    # @example
+    #   client = RunApi::GptImage2::Client.new(api_key: "your-api-key")
+    #
+    #   # Text-to-image
+    #   result = client.text_to_image.run(
+    #     model: "gpt-image-2", prompt: "A futuristic cityscape"
+    #   )
+    #
+    #   # Edit image
+    #   edited = client.edit_image.run(
+    #     model: "gpt-image-2", prompt: "Transform into oil painting",
+    #     source_image_urls: ["https://example.com/photo.jpg"]
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation operations.
+      attr_reader :text_to_image
+      # @return [Resources::EditImage] Prompt-guided image editing operations.
+      attr_reader :edit_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)
       end

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

@@ -3,6 +3,8 @@
 module RunApi
   module GptImage2
     module Resources
+      # GPT Image 2 prompt-guided image editing resource.
+      # Apply text-guided edits to source images (up to 16).
       class EditImage
         include RunApi::Core::ResourceHelpers
 

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

@@ -3,6 +3,8 @@
 module RunApi
   module GptImage2
     module Resources
+      # GPT Image 2 text-to-image generation resource.
+      # Generate images from text with up to 4k output resolution.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/gpt_image_2/types.rb

@@ -2,18 +2,24 @@
 
 module RunApi
   module GptImage2
+    # Type definitions and constants for GPT Image 2.
+    # Unlike GPT Image 1.5, aspect_ratio and output_resolution are optional.
     module Types
       MODELS = %w[gpt-image-2].freeze
       GENERATION_MODELS = MODELS
       EDIT_MODELS = MODELS
 
+      # 'auto' lets the model choose based on the prompt content.
       ASPECT_RATIOS = %w[auto 1:1 9:16 16:9 4:3 3:4].freeze
+      # Output resolution tiers. 1:1 is limited to 1k and 2k.
       RESOLUTIONS = %w[1k 2k 4k].freeze
 
+      # A single generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Generation result. +images+ is populated once +status+ is +"completed"+.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
@@ -21,8 +27,10 @@ module RunApi
         optional :error, String
       end
 
+      # Edit response -- same shape as generation.
       EditImageResponse = TextToImageResponse
 
+      # Narrowed response from +run()+ where +images+ is guaranteed present.
       class CompletedTextToImageResponse < TextToImageResponse
         required :images, [-> { Image }]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-gpt-image-2
 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 gpt image 2 api Ruby SDK is the language-specific package for GPT
   Image 2 on RunAPI. Use this gpt image 2 api package for text-to-image, image editing,
   and creative production flows when your application needs JSON request bodies, task