runapi-gpt-4o-image 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e67bec430137ebcd7f223ac43481d3a80d26720490b9f3a73c5de0aec5934bbf
-  data.tar.gz: 55c388c3d12c333e1bf9eebc33847bad30a8751ad8ecdeb915ff7fdb026d1788
+  metadata.gz: fcb80b291743336ea11105108372ae8f5116811907b1a38fe6cc1e284ffc6b72
+  data.tar.gz: ef2b5b960ccb1d416975249bef34350f69e5940765b2f27130ad4d666bd94f4b
 SHA512:
-  metadata.gz: f28753e09bd6b3eec8db927000e3529767411f4ff21ebdf53ecc166a5c1369f5e078b4ea0a6c7f1ad7679a1e726afa1699df1bf8fee86b0ba6114b1cb61e925b
-  data.tar.gz: 57367a8847e2187baa587dbfe732bd7a34f264675f0e2709db6b9b8b180f274587e16e679aed1c70aad1fe4d476d451239aa62ddd3113af53deff66344916b1f
+  metadata.gz: b2985e5a58b0a66ac18c6eae6e04d3ab31118338f1cffb8d7ded264e661a010b90c09a6a0a38da5f855bbea46e1f9eed58f4ae0502da1eab29e810f677d046fd
+  data.tar.gz: 56001d933cf766d533410f88edea4892fcdd7e75b1b5310699c94c7cf2ea7cd4abeffe20cbf6def298b4d3f721a782ca75d2cd8323c320b44caf57cd912f9c91

data/README.md

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

data/lib/runapi/gpt_4o_image/client.rb

@@ -2,14 +2,32 @@
 
 module RunApi
   module Gpt4oImage
-    class Client
+    # GPT-4o Image generation and editing API client.
+    #
+    # Supports pure text-to-image generation, image editing with source images,
+    # and inpainting with an optional mask.
+    #
+    # @example
+    #   client = RunApi::Gpt4oImage::Client.new(api_key: "your-api-key")
+    #
+    #   # Pure generation
+    #   result = client.text_to_image.run(
+    #     model: "gpt-4o-image", prompt: "A mountain lake at dawn",
+    #     aspect_ratio: "3:2"
+    #   )
+    #
+    #   # Edit with source images
+    #   edited = client.text_to_image.run(
+    #     model: "gpt-4o-image", prompt: "Add a rainbow",
+    #     aspect_ratio: "3:2",
+    #     source_image_urls: ["https://example.com/photo.jpg"]
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Image generation and editing operations.
       attr_reader :text_to_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)
       end
     end

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

@@ -3,6 +3,8 @@
 module RunApi
   module Gpt4oImage
     module Resources
+      # GPT-4o Image generation and editing resource.
+      # Generate images from text, edit with source images, or inpaint with a mask.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 
@@ -34,16 +36,15 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model)
-          raise Core::ValidationError, "size is required" unless param(params, :size)
+          raise Core::ValidationError, "aspect_ratio is required" unless param(params, :aspect_ratio)
 
           model = param(params, :model)
           unless Types::MODELS.include?(model)
             raise Core::ValidationError, "Invalid model: #{model}. Must be: #{Types::MODELS.join(", ")}"
           end
 
-          validate_optional!(params, :size, Types::SIZES)
-          validate_optional!(params, :n_variants, Types::N_VARIANTS)
-          validate_optional!(params, :fallback_model, Types::FALLBACK_MODELS)
+          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
+          validate_optional!(params, :output_count, Types::OUTPUT_COUNTS)
         end
       end
     end

data/lib/runapi/gpt_4o_image/types.rb

@@ -2,20 +2,26 @@
 
 module RunApi
   module Gpt4oImage
+    # GPT-4o Image type constants and response models.
+    # Supports pure generation, editing with source images, and inpainting with a mask.
     module Types
       MODELS = %w[gpt-4o-image].freeze
-      SIZES = %w[1:1 3:2 2:3].freeze
-      FALLBACK_MODELS = %w[GPT_IMAGE_1 FLUX_MAX].freeze
-      N_VARIANTS = [ 1, 2, 4 ].freeze
+      # Required output aspect ratio.
+      ASPECT_RATIOS = %w[1:1 3:2 2:3].freeze
+      # Batch sizes: 1, 2, or 4 images per request.
+      OUTPUT_COUNTS = [1, 2, 4].freeze
 
+      # A generated image with its CDN URL.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Response for GPT-4o Image tasks. Progress contains an intermediate
+      # status string while the task is running.
       class TextToImageResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :images, [ -> { Image } ]
+        optional :images, [-> { Image }]
         optional :progress, String
         optional :error, String
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-gpt-4o-image
 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-4o Image SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The gpt-4o image api Ruby SDK is the language-specific package for GPT-4o
+  Image on RunAPI. Use this gpt-4o image 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_4o_image.rb
 - lib/runapi/gpt_4o_image.rb
 - lib/runapi/gpt_4o_image/client.rb
@@ -41,7 +46,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/gpt-4o-image
-  documentation_uri: https://github.com/runapi-ai/gpt-4o-image-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/gpt-4o-image-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/gpt-4o-image-sdk
   changelog_uri: https://github.com/runapi-ai/gpt-4o-image-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -60,5 +65,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: GPT-4o Image API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: GPT-4o Image API Ruby SDK for RunAPI
 test_files: []