runapi-qwen-2 0.2.6 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7cbfba501dd88b37a82629dee1237753f030d6d92a06faac41f6165985aed21
-  data.tar.gz: ec3086cde57f139b0621c21c4e33e18a32aefbaf96be7f53c9757ddefb2631a4
+  metadata.gz: 2956586742f9d0861230f9896d032a1b9525325c3f18107eb3051133041ae180
+  data.tar.gz: d4639d731229589fa4e6b389771bbd1219ce62fe8488a86cc4671ef32a034ce3
 SHA512:
-  metadata.gz: c98213aac1b753e131550119533febb83cbf2e7543479750074458085e54d5be05772018d511f0cb3011aa70c55bbe1d53bce4691b410cfdea7758ade3c4f840
-  data.tar.gz: 7f564584fcde1efed7db34abf0a606d36ca59661b496f449cdf00d8137d9a91c32765e5289e357ed15a58627424dbf0ff91ee1a3335c5c6963045ae388550be8
+  metadata.gz: c668a2fbf31074afecc12aac9d4d493afe3fada577f0506f9993268355e2d1f3046f1d6db659812294ab0f71bc4d01c00ddd9a7d252c34b015ca0465f1f42e95
+  data.tar.gz: 7f14e473674084d4a1e76b28d28ab3a8703089ab91e9a80bc8310bf3b0e460b3960255ad76d7721098800bff50b9b380779fda48027566d7ea899325956e2fba

data/README.md

@@ -1,32 +1,34 @@
-# Qwen Image API Ruby SDK for RunAPI
+# Qwen 2 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.
+The Qwen 2 Ruby SDK is the language-specific package for Qwen 2 on RunAPI. Use this package for image generation, image editing, and creative production workflows when your application needs 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.
+This README is the Ruby package guide inside the public `qwen-2-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
+gem install runapi-qwen-2
 ```
 
 ## Quick start
 
 ```ruby
-require "runapi-qwen2"
+require "runapi/qwen_2"
 
 client = RunApi::Qwen2::Client.new
-task = client.generations.create(
+task = client.text_to_image.create(
   # Pass the Qwen 2 JSON request body from https://runapi.ai/docs#qwen-2.
 )
-status = client.generations.get(task.id)
+status = client.text_to_image.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.
+Use Ruby keyword arguments and the `RunApi::Qwen2` error classes when building image jobs, Rails workers, or scripts. The available resources are `text_to_image` and `edit_image`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

data/lib/runapi/qwen_2/client.rb

@@ -2,7 +2,9 @@
 
 module RunApi
   module Qwen2
-    # Qwen2 text-to-image, remix-image, and edit-image API client.
+    # Qwen 2 image generation and editing API client.
+    #
+    # Text-to-image generation and targeted modifications to source images.
     #
     # @example
     #   client = RunApi::Qwen2::Client.new(api_key: "your-api-key")
@@ -11,17 +13,15 @@ module RunApi
     #     prompt: "Replace the background with a neon-lit city skyline",
     #     source_image_url: "https://cdn.runapi.ai/public/samples/input.jpg"
     #   )
-    class Client
-      # @return [Resources::TextToImage, Resources::RemixImage, Resources::EditImage] Image operations.
-      attr_reader :text_to_image, :remix_image, :edit_image
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Generate images from text prompts.
+      attr_reader :text_to_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)
-        @remix_image = Resources::RemixImage.new(http)
         @edit_image = Resources::EditImage.new(http)
       end
     end

data/lib/runapi/qwen_2/contract_gen.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RunApi
+  module Qwen2
+    CONTRACT = {
+      "edit-image" => {
+        "models" => ["qwen-2-edit-image"],
+        "fields_by_model" => {
+          "qwen-2-edit-image" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "2:3", "3:2", "3:4", "4:3", "9:16", "16:9", "21:9"]
+            },
+            "output_format" => {
+              "enum" => ["jpeg", "png"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "seed" => {
+              "type" => "integer"
+            },
+            "source_image_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "text-to-image" => {
+        "models" => ["qwen-2-text-to-image"],
+        "fields_by_model" => {
+          "qwen-2-text-to-image" => {
+            "aspect_ratio" => {
+              "enum" => ["1:1", "3:4", "4:3", "9:16", "16:9"]
+            },
+            "output_format" => {
+              "enum" => ["png", "jpeg"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          }
+        }
+      }
+    }.freeze
+  end
+end

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

@@ -20,43 +20,27 @@ module RunApi
         #
         # @param params [Hash] edit-image parameters
         # @return [RunApi::Qwen2::Types::CompletedEditImageResponse] completed edit-image result
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
         # Create an edit-image task.
         #
         # @param params [Hash] edit-image parameters
         # @return [RunApi::Qwen2::Types::EditImageResponse] task creation result with id
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
-          validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          validate_contract!(CONTRACT["edit-image"], params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         # Get edit-image status by task ID.
         #
         # @param id [String] task ID
         # @return [RunApi::Qwen2::Types::EditImageResponse] current edit-image status
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
-        end
-
-        private
-
-        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, "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, :aspect_ratio, Types::EDIT_IMAGE_ASPECT_RATIOS)
-          validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

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

@@ -20,41 +20,27 @@ module RunApi
         #
         # @param params [Hash] text-to-image parameters
         # @return [RunApi::Qwen2::Types::CompletedTextToImageResponse] completed text-to-image result
-        def run(**params)
-          task = create(**params)
-          poll_until_complete { get(task.id) }
+        def run(options: nil, **params)
+          task = create(options: options, **params)
+          poll_until_complete { get(task.id, options: options) }
         end
 
         # Create a text-to-image task.
         #
         # @param params [Hash] text-to-image parameters
         # @return [RunApi::Qwen2::Types::TextToImageResponse] task creation result with id
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
-          validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          validate_contract!(CONTRACT["text-to-image"], params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         # Get text-to-image status by task ID.
         #
         # @param id [String] task ID
         # @return [RunApi::Qwen2::Types::TextToImageResponse] current text-to-image status
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
-        end
-
-        private
-
-        def validate_params!(params)
-          raise Core::ValidationError, "model is required" unless param(params, :model)
-          raise Core::ValidationError, "prompt is required" unless param(params, :prompt)
-          model = param(params, :model)
-          unless Types::TEXT_TO_IMAGE_MODELS.include?(model)
-            raise Core::ValidationError, "Invalid model: #{model}. Must be one of: #{Types::TEXT_TO_IMAGE_MODELS.join(", ")}"
-          end
-
-          validate_optional!(params, :aspect_ratio, Types::TEXT_TO_IMAGE_ASPECT_RATIOS)
-          validate_optional!(params, :output_format, Types::OUTPUT_FORMATS)
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
       end
     end

data/lib/runapi/qwen_2/types.rb

@@ -3,18 +3,12 @@
 module RunApi
   module Qwen2
     module Types
-      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
-      REMIX_IMAGE_MODELS = %w[qwen-2-remix-image].freeze
-      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 }
@@ -23,17 +17,15 @@ module RunApi
       end
 
       class TextToImageResponse < 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 }]
       end
 
-      class CompletedRemixImageResponse < RemixImageResponse
-        required :images, [-> { Image }]
-      end
-
       class CompletedEditImageResponse < EditImageResponse
         required :images, [-> { Image }]
       end

data/lib/runapi/qwen_2.rb

@@ -2,8 +2,8 @@
 
 require "runapi/core"
 require_relative "qwen_2/types"
+require_relative "qwen_2/contract_gen"
 require_relative "qwen_2/resources/text_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.6
+  version: 0.2.8
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-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.
+        version: 0.3.0
+description: The Qwen 2 Ruby SDK is the language-specific package for Qwen 2 on RunAPI.
+  Use this package for image generation, image editing, and creative production workflows
+  when your application needs request bodies, task status lookup, and consistent RunAPI
+  errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,17 +39,19 @@ files:
 - lib/runapi-qwen_2.rb
 - lib/runapi/qwen_2.rb
 - lib/runapi/qwen_2/client.rb
+- lib/runapi/qwen_2/contract_gen.rb
 - lib/runapi/qwen_2/resources/edit_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
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: qwen-2
   homepage_uri: https://runapi.ai/models/qwen-2
   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
+  bug_tracker_uri: https://github.com/runapi-ai/qwen-2-sdk/issues
   changelog_uri: https://github.com/runapi-ai/qwen-2-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -65,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.17
 specification_version: 4
-summary: Qwen Image API Ruby SDK for RunAPI
+summary: Qwen 2 API Ruby SDK for RunAPI
 test_files: []

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-module RunApi
-  module Qwen2
-    module Resources
-      # Qwen2 remix-image resource. Creates prompt-guided variations from a source image.
-      class RemixImage
-        include RunApi::Core::ResourceHelpers
-
-        ENDPOINT = "/api/v1/qwen_2/remix_image"
-
-        RESPONSE_CLASS = Types::RemixImageResponse
-        COMPLETED_RESPONSE_CLASS = Types::CompletedRemixImageResponse
-
-        def initialize(http)
-          @http = http
-        end
-
-        # Remix an image and wait until complete.
-        #
-        # @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 a remix-image task.
-        #
-        # @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 remix-image status by task ID.
-        #
-        # @param id [String] task ID
-        # @return [RunApi::Qwen2::Types::RemixImageResponse] current remix-image status
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
-        end
-
-        private
-
-        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, "source_image_url is required" unless param(params, :source_image_url)
-
-          model = param(params, :model)
-          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)
-        end
-      end
-    end
-  end
-end