runapi-qwen-2 0.2.4 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c78ff54d710cf9de225f0f6abab5f57503946872e382bf780dd7084d630801a
-  data.tar.gz: 93ca839ada0fc05d7c99fcbed4cf023e1c837163266968da9691769e2f241e99
+  metadata.gz: 1f3700e2cf81d87fa6bf94631a0f6d153cbc481a5b978f1f6a684f2986a8ebda
+  data.tar.gz: 948da5705c89ac0e4cab9b06c6a89e36426615d9b1e8656095a04e0ee2450dbc
 SHA512:
-  metadata.gz: 9b753024a71658d987ec33b0524ef2cdf7d437c5ae0604b612be932b6d9bcec63dd90722b07d2e22088aad31bf4a58345a97696ab0da5a956eab585002fe097d
-  data.tar.gz: a61c665168372a5b982ff68f5eea4243c70480cea9bac062645107f4dd08825b677c6bc421379951e334c609dac6d813e09c8ad8c013e3ac89c3b35ba48b70db
+  metadata.gz: d23d2d3fd38f3a16f49214ad0f122dbed63504eb61eaa463e41fa584a4a93efe7e61d2027997d996b8fb2d51d04edcbea50e12964e8b3a5c5f584f6cf86ecdcc
+  data.tar.gz: 981e76b782d1584f10e782be8d45e38a3a267d7f0adc8d47f799f01eaf0a16a3809278b42ffead6a04ae356aee77b114d8acc5a1bb2f91f5dafdce23f695fb89

data/README.md

@@ -0,0 +1,45 @@
+# Qwen Image API Ruby SDK for RunAPI
+
+The qwen image api Ruby SDK is the language-specific package for Qwen 2 on RunAPI. Use this qwen 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 qwen image api README is the Ruby package guide inside the public `qwen2-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/qwen-2; for API reference, use https://runapi.ai/docs#qwen-2; for SDK docs, use https://runapi.ai/docs#sdk-qwen-2.
+
+## Install
+
+```bash
+gem install runapi-qwen2
+```
+
+## Quick start
+
+```ruby
+require "runapi-qwen2"
+
+client = RunApi::Qwen2::Client.new
+task = client.generations.create(
+  # Pass the Qwen 2 JSON request body from https://runapi.ai/docs#qwen-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::Qwen2` error classes when building image jobs, Rails workers, or scripts. The available resources include generations, image to images, 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/qwen-2
+- SDK docs: https://runapi.ai/docs#sdk-qwen-2
+- Product docs: https://runapi.ai/docs#qwen-2
+- Pricing and rate limits: https://runapi.ai/models/qwen-2/text-to-image
+- Provider comparison: https://runapi.ai/providers/alibaba
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/qwen2-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/qwen_2/client.rb

@@ -2,26 +2,31 @@
 
 module RunApi
   module Qwen2
-    # Qwen2 text-to-image, image-to-image, and edit-image API client.
+    # Qwen 2 image generation, remixing, and editing API client.
+    #
+    # Three operations: pure text-to-image generation, remix (prompt-guided
+    # variation of a source image with configurable strength), and edit
+    # (targeted modifications to a source image).
     #
     # @example
     #   client = RunApi::Qwen2::Client.new(api_key: "your-api-key")
     #   result = client.edit_image.run(
-    #     model: "qwen-2-image-edit",
+    #     model: "qwen-2-edit-image",
     #     prompt: "Replace the background with a neon-lit city skyline",
-    #     image_url: "https://example.com/input.jpg"
+    #     source_image_url: "https://cdn.runapi.ai/public/samples/input.jpg"
     #   )
-    class Client
-      # @return [Resources::TextToImage, Resources::ImageToImage, Resources::EditImage] Image operations.
-      attr_reader :text_to_image, :image_to_image, :edit_image
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Generate images from text prompts.
+      attr_reader :text_to_image
+      # @return [Resources::RemixImage] Create prompt-guided variations with adjustable strength (0 = faithful, 1 = creative).
+      attr_reader :remix_image
+      # @return [Resources::EditImage] Apply targeted edits to a source image using natural-language prompts.
+      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)
-        @image_to_image = Resources::ImageToImage.new(http)
+        @remix_image = Resources::RemixImage.new(http)
         @edit_image = Resources::EditImage.new(http)
       end
     end

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

@@ -48,14 +48,14 @@ module RunApi
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "image_url is required" unless param(params, :image_url)
+          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
 
           model = param(params, :model)
           unless Types::EDIT_MODELS.include?(model)
             raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::EDIT_MODELS.join(", ")}"
           end
 
-          validate_optional!(params, :image_size, Types::IMAGE_SIZES)
+          validate_optional!(params, :aspect_ratio, Types::EDIT_IMAGE_ASPECT_RATIOS)
           validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
         end
       end

data/lib/runapi/qwen_2/resources/{image_to_image.rb → remix_image.rb}

@@ -3,42 +3,42 @@
 module RunApi
   module Qwen2
     module Resources
-      # Qwen2 image-to-image resource. Transforms images with natural-language prompts.
-      class ImageToImage
+      # Qwen2 remix-image resource. Creates prompt-guided variations from a source image.
+      class RemixImage
         include RunApi::Core::ResourceHelpers
 
-        ENDPOINT = "/api/v1/qwen_2/image_to_image"
+        ENDPOINT = "/api/v1/qwen_2/remix_image"
 
-        RESPONSE_CLASS = Types::ImageToImageResponse
-        COMPLETED_RESPONSE_CLASS = Types::CompletedImageToImageResponse
+        RESPONSE_CLASS = Types::RemixImageResponse
+        COMPLETED_RESPONSE_CLASS = Types::CompletedRemixImageResponse
 
         def initialize(http)
           @http = http
         end
 
-        # Transform an image and wait until complete.
+        # Remix an image and wait until complete.
         #
-        # @param params [Hash] image-to-image parameters
-        # @return [RunApi::Qwen2::Types::CompletedImageToImageResponse] completed image-to-image result
+        # @param params [Hash] remix-image parameters
+        # @return [RunApi::Qwen2::Types::CompletedRemixImageResponse] completed remix-image result
         def run(**params)
           task = create(**params)
           poll_until_complete { get(task.id) }
         end
 
-        # Create an image-to-image task.
+        # Create a remix-image task.
         #
-        # @param params [Hash] image-to-image parameters
-        # @return [RunApi::Qwen2::Types::ImageToImageResponse] task creation result with id
+        # @param params [Hash] remix-image parameters
+        # @return [RunApi::Qwen2::Types::RemixImageResponse] task creation result with id
         def create(**params)
           params = compact_params(params)
           validate_params!(params)
           request(:post, ENDPOINT, body: params)
         end
 
-        # Get image-to-image status by task ID.
+        # Get remix-image status by task ID.
         #
         # @param id [String] task ID
-        # @return [RunApi::Qwen2::Types::ImageToImageResponse] current image-to-image status
+        # @return [RunApi::Qwen2::Types::RemixImageResponse] current remix-image status
         def get(id)
           request(:get, "#{ENDPOINT}/#{id}")
         end
@@ -48,11 +48,11 @@ module RunApi
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model)
           raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          raise Core::ValidationError, "image_url is required" unless param(params, :image_url)
+          raise Core::ValidationError, "source_image_url is required" unless param(params, :source_image_url)
 
           model = param(params, :model)
-          unless Types::IMAGE_TO_IMAGE_MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::IMAGE_TO_IMAGE_MODELS.join(", ")}"
+          unless Types::REMIX_IMAGE_MODELS.include?(model)
+            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::REMIX_IMAGE_MODELS.join(", ")}"
           end
 
           validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)

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

@@ -53,7 +53,7 @@ module RunApi
             raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::TEXT_TO_IMAGE_MODELS.join(", ")}"
           end
 
-          validate_optional!(params, :image_size, Types::QWEN_IMAGE_SIZES)
+          validate_optional!(params, :aspect_ratio, Types::TEXT_TO_IMAGE_ASPECT_RATIOS)
           validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
         end
       end

data/lib/runapi/qwen_2/types.rb

@@ -3,39 +3,46 @@
 module RunApi
   module Qwen2
     module Types
-      MODELS = %w[qwen-2-image-edit qwen-2-text-to-image qwen-2-image-to-image].freeze
-      EDIT_MODELS = %w[qwen-2-image-edit].freeze
+      # All Qwen 2 model variants, each dedicated to a single operation type.
+      MODELS = %w[qwen-2-edit-image qwen-2-text-to-image qwen-2-remix-image].freeze
+      EDIT_MODELS = %w[qwen-2-edit-image].freeze
       TEXT_TO_IMAGE_MODELS = %w[qwen-2-text-to-image].freeze
-      IMAGE_TO_IMAGE_MODELS = %w[qwen-2-image-to-image].freeze
-      IMAGE_SIZES = %w[1:1 2:3 3:2 3:4 4:3 9:16 16:9 21:9].freeze
-      QWEN_IMAGE_SIZES = %w[square square_hd portrait_4_3 portrait_16_9 landscape_4_3 landscape_16_9].freeze
+      REMIX_IMAGE_MODELS = %w[qwen-2-remix-image].freeze
+      # Edit-image aspect ratios include ultra-wide 21:9; narrower set than generation.
+      EDIT_IMAGE_ASPECT_RATIOS = %w[1:1 2:3 3:2 3:4 4:3 9:16 16:9 21:9].freeze
+      TEXT_TO_IMAGE_ASPECT_RATIOS = %w[1:1 3:4 4:3 9:16 16:9].freeze
       OUTPUT_FORMATS = %w[jpeg png].freeze
 
+      # A single generated image result.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Shared task result for all Qwen 2 image operations.
       class ImageTaskResponse < 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
 
       class TextToImageResponse < ImageTaskResponse; end
-      class ImageToImageResponse < ImageTaskResponse; end
+      class RemixImageResponse < ImageTaskResponse; end
       class EditImageResponse < ImageTaskResponse; end
 
+      # Narrowed responses 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
 
-      class CompletedImageToImageResponse < ImageToImageResponse
-        required :images, [ -> { Image } ]
+      class CompletedRemixImageResponse < RemixImageResponse
+        required :images, [-> { Image }]
       end
 
       class CompletedEditImageResponse < EditImageResponse
-        required :images, [ -> { Image } ]
+        required :images, [-> { Image }]
       end
     end
   end

data/lib/runapi/qwen_2.rb

@@ -3,7 +3,7 @@
 require "runapi/core"
 require_relative "qwen_2/types"
 require_relative "qwen_2/resources/text_to_image"
-require_relative "qwen_2/resources/image_to_image"
+require_relative "qwen_2/resources/remix_image"
 require_relative "qwen_2/resources/edit_image"
 require_relative "qwen_2/client"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-qwen-2
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,27 +15,32 @@ 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 Qwen 2 SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The qwen image api Ruby SDK is the language-specific package for Qwen
+  2 on RunAPI. Use this qwen 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-qwen_2.rb
 - lib/runapi/qwen_2.rb
 - lib/runapi/qwen_2/client.rb
 - lib/runapi/qwen_2/resources/edit_image.rb
-- lib/runapi/qwen_2/resources/image_to_image.rb
+- lib/runapi/qwen_2/resources/remix_image.rb
 - lib/runapi/qwen_2/resources/text_to_image.rb
 - lib/runapi/qwen_2/types.rb
 homepage: https://runapi.ai/models/qwen-2
@@ -43,7 +48,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/qwen-2
-  documentation_uri: https://github.com/runapi-ai/qwen-2-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/qwen-2-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/qwen-2-sdk
   changelog_uri: https://github.com/runapi-ai/qwen-2-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
@@ -62,5 +67,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Qwen 2 API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Qwen Image API Ruby SDK for RunAPI
 test_files: []