runapi-gpt-image-2 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc6c0a3f30021b0e9e5de2228d900e90cdd83ae1978741267c9fc47f208c5d44
-  data.tar.gz: d8f8942ed6b2ce27c34c382fec419875208c5d5f5e4a34c9b454a016b8f93c1d
+  metadata.gz: 7664913b3073c7ef5cec93d7661a89f41df732140b1bb741f558b37a0c707484
+  data.tar.gz: ed6c4be520bcaaab01bf5a20be19cff0947ca1951c961fb8eae93a9713a62007
 SHA512:
-  metadata.gz: 6ceb52e828549b8a8bf98d45e414eaa6c52cb32f43eac704f0af8f03b7d8bdf2a6f853238b7d74a80eed8a1c0ed076af1836ae23ca0d8db942aa959363bee230
-  data.tar.gz: 01c7f6ffaf3f86f02bcbb79b46a21eede90144971839ec512f896149fc95850d0d6beffefbd8baabe00194c18dea73e5db07ae33408c951faec6c7754c7bab1c
+  metadata.gz: deeb9ac2db537db1101e79fe045c5906aac1b4e573f13dedf01dd562001e8047869612e2f5a0fcd5f80aafe9eae81a0ffe8580ce71930011d722439b06495b5b
+  data.tar.gz: 223abf29ac0d43b6c71113101e69b050c8618471c934c5c0a0d900c7718f3fe3612e5888213ddc1ae8530bab3528b1ac19c5949da121069c27cfe64015efa027

data/README.md

@@ -0,0 +1,45 @@
+# GPT Image 2 API Ruby SDK for RunAPI
+
+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 status lookup, and consistent RunAPI errors in Ruby.
+
+This gpt image 2 api README is the Ruby package guide inside the public `gpt-image-2-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/gpt-image-2; for API reference, use https://runapi.ai/docs#gpt-image-2; for SDK docs, use https://runapi.ai/docs#sdk-gpt-image-2.
+
+## Install
+
+```bash
+gem install runapi-gpt-image-2
+```
+
+## Quick start
+
+```ruby
+require "runapi-gpt-image-2"
+
+client = RunApi::GptImage2::Client.new
+task = client.generations.create(
+  # Pass the GPT Image 2 JSON request body from https://runapi.ai/docs#gpt-image-2.
+)
+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.
+
+## Links
+
+- Model page: https://runapi.ai/models/gpt-image-2
+- SDK docs: https://runapi.ai/docs#sdk-gpt-image-2
+- Product docs: https://runapi.ai/docs#gpt-image-2
+- Pricing and rate limits: https://runapi.ai/models/gpt-image-2/text-to-image
+- Provider comparison: https://runapi.ai/providers/openai
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/gpt-image-2-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

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
 
@@ -41,12 +43,13 @@ module RunApi
             raise Core::ValidationError, "Invalid model: #{model}. Must be: #{Types::EDIT_MODELS.join(", ")}"
           end
 
-          urls = param(params, :input_urls)
+          urls = param(params, :source_image_urls)
           if urls.nil? || (urls.respond_to?(:empty?) && urls.empty?)
-            raise Core::ValidationError, "input_urls is required for image-to-image models"
+            raise Core::ValidationError, "source_image_urls is required for edit image requests"
           end
 
           validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
+          validate_optional!(params, :output_resolution, Types::RESOLUTIONS)
         end
       end
     end

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
 
@@ -42,6 +44,7 @@ module RunApi
           end
 
           validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
+          validate_optional!(params, :output_resolution, Types::RESOLUTIONS)
         end
       end
     end

data/lib/runapi/gpt_image_2/types.rb

@@ -2,28 +2,37 @@
 
 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
-      GENERATION_MODELS = %w[gpt-image-2-text-to-image].freeze
-      EDIT_MODELS = %w[gpt-image-2-image-to-image].freeze
-      MODELS = (GENERATION_MODELS + EDIT_MODELS).freeze
+      MODELS = %w[gpt-image-2].freeze
+      GENERATION_MODELS = MODELS
+      EDIT_MODELS = MODELS
 
-      ASPECT_RATIOS = %w[auto 1:1 5:4 9:16 21:9 16:9 4:3 3:2 4:5 3:4 2:3].freeze
+      # '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 }
-        optional :images, [ -> { Image } ]
+        optional :images, [-> { Image }]
         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 } ]
+        required :images, [-> { Image }]
       end
 
       CompletedEditImageResponse = CompletedTextToImageResponse

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-gpt-image-2
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.6
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.4
-description: RunAPI GPT Image 2 SDK for JavaScript, Ruby, and Go
+        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
+  status lookup, and consistent RunAPI errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
 files:
 - LICENSE
+- README.md
 - lib/runapi-gpt_image_2.rb
 - lib/runapi/gpt_image_2.rb
 - lib/runapi/gpt_image_2/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/gpt-image-2
-  documentation_uri: https://github.com/runapi-ai/gpt-image-2-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/gpt-image-2-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/gpt-image-2-sdk
   changelog_uri: https://github.com/runapi-ai/gpt-image-2-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -61,5 +66,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: GPT Image 2 API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: GPT Image 2 API Ruby SDK for RunAPI
 test_files: []