runapi-gpt-image 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7077b69df98c9dabd0c94760877f1406f9359cc8aeaccbeecf82cb07faa677c
-  data.tar.gz: 4ed9190bc5ee799a3be8194ff191c7d4331b17f0282e62dada30750436ce9135
+  metadata.gz: cd933bb97d1ca6a8ccf0708928f4985b1cfb06aae5cef4ec9d65b8b84448d0b1
+  data.tar.gz: cd13517224d400ec1f493166b6fc9ce4b6c479c967e14b680efa4f0c4f1db2f2
 SHA512:
-  metadata.gz: 8b07b7ca66c3c7307c9544cbc5493e67a1c241562f531aca037f5cd7a38cc7440827729d4c918d18a0b34bdf252a585d3aa73f174899994b3251a6e7ec4f6eb5
-  data.tar.gz: c6d80eaf49c615d4172e8b277eb1c68bbd694f1898ef816bdc28e40e5c6fcd1d5bfacaf01c04d363e8a512baf94fdfdaafc848242ca90b9eabdc0dc1c83ca40c
+  metadata.gz: 2706384365717c217ffd71e4e654e92c1e24bb57318cd07cf7a420f78f1cb33a74faf19c0e01d6b30075e4d180204afc21cf66a5f6ce6f5a6f975d5eda50d3e6
+  data.tar.gz: 2c3b05a82ff0868976e4c0c0277dd1b8baeb9364eb816da8989f7161a6b91a9a36aa9a882e78a8de055a8ed1812e62146098dfb74e5d75285896e41f3fe65b18

data/README.md

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

data/lib/runapi/gpt_image/client.rb

@@ -2,33 +2,32 @@
 
 module RunApi
   module GptImage
-    # GPT Image 1.5 image generation API client.
+    # GPT Image 1.5 generation and editing API client.
+    #
+    # Both aspect_ratio and quality are required for all operations.
     #
     # @example
     #   client = RunApi::GptImage::Client.new(api_key: "your-api-key")
     #
     #   # Text-to-image
     #   result = client.text_to_image.run(
-    #     model: "gpt-image-1.5-text-to-image", prompt: "A futuristic cityscape"
+    #     model: "gpt-image-1.5", prompt: "A futuristic cityscape"
     #   )
     #
-    #   # Image-to-image
+    #   # Edit image
     #   edited = client.edit_image.run(
-    #     model: "gpt-image-1.5-image-to-image",
+    #     model: "gpt-image-1.5",
     #     prompt: "Transform into oil painting",
-    #     input_urls: ["https://example.com/photo.jpg"]
+    #     source_image_urls: ["https://cdn.runapi.ai/public/samples/photo.jpg"]
     #   )
-    class Client
+    class Client < RunApi::Core::Client
       # @return [Resources::TextToImage] Text-to-image generation operations.
       attr_reader :text_to_image
-      # @return [Resources::EditImage] Image-to-image edit operations.
+      # @return [Resources::EditImage] Image edit 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/resources/edit_image.rb

@@ -3,7 +3,7 @@
 module RunApi
   module GptImage
     module Resources
-      # GPT Image 1.5 image-to-image edit resource.
+      # GPT Image 1.5 image edit resource.
       class EditImage
         include RunApi::Core::ResourceHelpers
 
@@ -25,7 +25,7 @@ module RunApi
           poll_until_complete { get(task.id) }
         end
 
-        # Create an image-to-image edit task.
+        # Create an image editing task.
         #
         # @param params [Hash] edit parameters
         # @return [RunApi::GptImage::Types::EditImageResponse] task creation result with id
@@ -54,9 +54,9 @@ 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 image editing"
           end
 
           raise Core::ValidationError, "aspect_ratio is required" unless param(params, :aspect_ratio)

data/lib/runapi/gpt_image/types.rb

@@ -2,32 +2,39 @@
 
 module RunApi
   module GptImage
+    # Type definitions and constants for GPT Image 1.5.
+    # Both aspect_ratio and quality are required for all operations.
     module Types
-      GENERATION_MODELS = %w[gpt-image-1.5-text-to-image].freeze
-      EDIT_MODELS = %w[gpt-image-1.5-image-to-image].freeze
-      MODELS = (GENERATION_MODELS + EDIT_MODELS).freeze
+      MODELS = %w[gpt-image-1.5].freeze
+      GENERATION_MODELS = MODELS
+      EDIT_MODELS = MODELS
 
+      # Required for all operations.
       ASPECT_RATIOS = %w[1:1 2:3 3:2].freeze
+      # Higher quality takes longer but produces finer detail.
       QUALITY_VALUES = %w[medium high].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 returned by `run()` methods once polling observes
       # `status: "completed"`. `images` is required so consumers never have to
       # null-check it on a successful task.
       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
 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 SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The gpt image api Ruby SDK is the language-specific package for GPT Image
+  on RunAPI. Use this gpt 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_image.rb
 - lib/runapi/gpt_image.rb
 - lib/runapi/gpt_image/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/gpt-image
-  documentation_uri: https://github.com/runapi-ai/gpt-image-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/gpt-image-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/gpt-image-sdk
   changelog_uri: https://github.com/runapi-ai/gpt-image-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 API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: GPT Image API Ruby SDK for RunAPI
 test_files: []