runapi-gpt-4o-image 0.2.3 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8baa03d12ef44490c88c9041dea336e7e46788909e2ec904d00885a1fb84c46c
-  data.tar.gz: 55c388c3d12c333e1bf9eebc33847bad30a8751ad8ecdeb915ff7fdb026d1788
+  metadata.gz: 2472cd75263166ddf4f6f6dcbe222c458bae3ccfc1acd0c106e9a2ce42241b1f
+  data.tar.gz: adaa442f974bf4101270ab1bbc057e95045594fdd0ec487d09edd60300729908
 SHA512:
-  metadata.gz: 15041952b0ac0dc09e6c72869642c7f3c03b6082dce41df90430b2bb4598f7096a5b19b2b06dd0fae352c8383a62459dc4f683f4d8790bb3d27302954915345e
-  data.tar.gz: 57367a8847e2187baa587dbfe732bd7a34f264675f0e2709db6b9b8b180f274587e16e679aed1c70aad1fe4d476d451239aa62ddd3113af53deff66344916b1f
+  metadata.gz: 6471cd4c36028b46fc900d4d3236a8cd1f45eb14ad12aa343c6b8114ab89865a371769c9b57b215f94c5afd93ec873dc35dd32bde83fedfb6703c794d6843beb
+  data.tar.gz: f5211a22702956fec1df59e764c4b3d7c45498b768f69673c08ce6c375f8eb36fe7e4534d01293aab469ee4c08e6ebab0838489c49631df4cbc13c72402699f4

data/README.md

@@ -0,0 +1,43 @@
+# 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.
+
+## 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/resources/text_to_image.rb

@@ -34,16 +34,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

@@ -4,9 +4,8 @@ module RunApi
   module Gpt4oImage
     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
+      ASPECT_RATIOS = %w[1:1 3:2 2:3].freeze
+      OUTPUT_COUNTS = [1, 2, 4].freeze
 
       class Image < RunApi::Core::BaseModel
         optional :url, String
@@ -15,7 +14,7 @@ module RunApi
       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.3
+  version: 0.2.5
 platform: ruby
 authors:
 - RunAPI
@@ -15,22 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
+        version: 0.2.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.3
-description: RunAPI GPT-4o Image SDK for JavaScript, Ruby, and Go
+        version: 0.2.5
+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://runapi.ai/models/gpt-4o-image
+  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: []