runapi-topaz 0.2.4 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd549096b5cd6f6d44fcfe621bd74d6e67af7be365fc1d3852f7627372a1e46b
-  data.tar.gz: d9fedb3f0ddd26c9a7c0ed24385e50f37004e3522e42974f84b07392d35062f6
+  metadata.gz: 8bb62f2b5c763e463433c6a31953baaf2f0f6fe9d2586898149e759b2b7a4544
+  data.tar.gz: 2890b5d76de93833bb898c9d2ad25eee601dc3597db7d35e1f332f3d3499b199
 SHA512:
-  metadata.gz: a1092ed17ba3fff61ff5130c47fcaf2e6653059ed2b4caf45b9d7091f1c7a2ae38e71fec07e03dccd24df800f52819c309419e4c070ef3f0855b978632d37af6
-  data.tar.gz: 80cc131adf8bac5eca114001426c96ecbc461ef09dfcb1a4687d5b8393998ed4172c983a3f08e8a34dcf07eb892b082f46f68a44214748394780ec567483c2f9
+  metadata.gz: 52ede417926cb5fffe3af6af0dd5e5a9e00ccb2cbb73ca86be7b963a94ee1dd04c913b4c05817a0ab34c9eafcca34c90bf936fef8fa21ef8f575d3ed03abaf34
+  data.tar.gz: 4d0496f468fd8c1277420c461cb7856e61efe269dc17614836c25da379104f42e9574b4b04f8d69885e458956ab60b52e3d1febaf3e62bf22edddc40f3192bf9

data/README.md

@@ -0,0 +1,45 @@
+# Topaz API Ruby SDK for RunAPI
+
+The topaz api Ruby SDK is the language-specific package for Topaz on RunAPI. Use this topaz api package for image upscale, video upscale, restoration, and production cleanup flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+
+This topaz api README is the Ruby package guide inside the public `topaz-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/topaz; for API reference, use https://runapi.ai/docs#topaz; for SDK docs, use https://runapi.ai/docs#sdk-topaz.
+
+## Install
+
+```bash
+gem install runapi-topaz
+```
+
+## Quick start
+
+```ruby
+require "runapi-topaz"
+
+client = RunApi::Topaz::Client.new
+task = client.image_upscales.create(
+  # Pass the Topaz JSON request body from https://runapi.ai/docs#topaz.
+)
+status = client.image_upscales.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::Topaz` error classes when building upscaling jobs, Rails workers, or scripts. The available resources include image upscales, and video upscales. 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/topaz
+- SDK docs: https://runapi.ai/docs#sdk-topaz
+- Product docs: https://runapi.ai/docs#topaz
+- Pricing and rate limits: https://runapi.ai/models/topaz/upscale-image
+- Provider comparison: https://runapi.ai/providers/topaz
+- Full catalog: https://runapi.ai/models
+- Repository: https://github.com/runapi-ai/topaz-sdk
+
+## License
+
+Licensed under the Apache License, Version 2.0.

data/lib/runapi/topaz/client.rb

@@ -2,14 +2,24 @@
 
 module RunApi
   module Topaz
-    class Client
-      attr_reader :upscale_image, :upscale_video
+    # Topaz AI upscaling client for increasing image and video resolution.
+    #
+    # @example
+    #   client = RunApi::Topaz::Client.new(api_key: "sk-...")
+    #   result = client.upscale_image.run(
+    #     model: "topaz-upscale-image",
+    #     source_image_url: "https://example.com/photo.jpg",
+    #     upscale_factor: 2
+    #   )
+    #   puts result.images.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::UpscaleImage] AI-powered image upscaling (1x, 2x, 4x, 8x).
+      attr_reader :upscale_image
+      # @return [Resources::UpscaleVideo] AI-powered video upscaling (1x, 2x, 4x).
+      attr_reader :upscale_video
 
       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
         @upscale_image = Resources::UpscaleImage.new(http)
         @upscale_video = Resources::UpscaleVideo.new(http)
       end

data/lib/runapi/topaz/resources/upscale_image.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Topaz
     module Resources
+      # AI-powered image upscaling resource.
+      # Supports upscale factors of 1x, 2x, 4x, and 8x.
       class UpscaleImage
         include RunApi::Core::ResourceHelpers
 
@@ -34,11 +36,11 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model) == Types::UPSCALE_IMAGE_MODEL
-          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)
 
           factor = param(params, :upscale_factor)
           raise Core::ValidationError, "upscale_factor is required" unless factor
-          return if Types::UPSCALE_IMAGE_FACTORS.include?(factor.to_s)
+          return if Types::UPSCALE_IMAGE_FACTORS.include?(factor)
 
           raise Core::ValidationError, "upscale_factor must be one of: #{Types::UPSCALE_IMAGE_FACTORS.join(", ")}"
         end

data/lib/runapi/topaz/resources/upscale_video.rb

@@ -3,6 +3,8 @@
 module RunApi
   module Topaz
     module Resources
+      # AI-powered video upscaling resource.
+      # Supports upscale factors of 1x, 2x, and 4x.
       class UpscaleVideo
         include RunApi::Core::ResourceHelpers
 
@@ -34,10 +36,10 @@ module RunApi
 
         def validate_params!(params)
           raise Core::ValidationError, "model is required" unless param(params, :model) == Types::UPSCALE_VIDEO_MODEL
-          raise Core::ValidationError, "video_url is required" unless param(params, :video_url)
+          raise Core::ValidationError, "source_video_url is required" unless param(params, :source_video_url)
 
           factor = param(params, :upscale_factor)
-          return unless factor && !Types::UPSCALE_VIDEO_FACTORS.include?(factor.to_s)
+          return unless factor && !Types::UPSCALE_VIDEO_FACTORS.include?(factor)
 
           raise Core::ValidationError, "upscale_factor must be one of: #{Types::UPSCALE_VIDEO_FACTORS.join(", ")}"
         end

data/lib/runapi/topaz/types.rb

@@ -2,40 +2,53 @@
 
 module RunApi
   module Topaz
+    # Type definitions and constants for the Topaz upscaling API.
     module Types
-      UPSCALE_IMAGE_MODEL = "topaz-image-upscale"
-      UPSCALE_VIDEO_MODEL = "topaz-video-upscale"
-      UPSCALE_IMAGE_FACTORS = %w[1 2 4 8].freeze
-      UPSCALE_VIDEO_FACTORS = %w[1 2 4].freeze
+      # Image upscaling model slug.
+      UPSCALE_IMAGE_MODEL = "topaz-upscale-image"
+      # Video upscaling model slug.
+      UPSCALE_VIDEO_MODEL = "topaz-upscale-video"
+      # Allowed image upscale factors. Higher factors produce larger output but take longer.
+      UPSCALE_IMAGE_FACTORS = [1, 2, 4, 8].freeze
+      # Allowed video upscale factors. Max 4x (8x is not supported for video).
+      UPSCALE_VIDEO_FACTORS = [1, 2, 4].freeze
 
+      # URL to an upscaled image.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # URL to an upscaled video.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Async image upscaling task result with lifecycle status.
       class UpscaleImageResponse < 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
 
+      # Async video upscaling task result with lifecycle status.
       class UpscaleVideoResponse < RunApi::Core::TaskResponse
         required :id, String
         optional :status, String, enum: -> { RunApi::Core::TaskResponse::Status::ALL }
-        optional :videos, [ -> { Video } ]
+        optional :videos, [-> { Video }]
         optional :error, String
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Images are guaranteed present.
       class CompletedUpscaleImageResponse < UpscaleImageResponse
-        required :images, [ -> { Image } ]
+        required :images, [-> { Image }]
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Videos are guaranteed present.
       class CompletedUpscaleVideoResponse < UpscaleVideoResponse
-        required :videos, [ -> { Video } ]
+        required :videos, [-> { Video }]
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-topaz
 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 Topaz SDK for JavaScript, Ruby, and Go
+        version: 0.2.6
+description: The topaz api Ruby SDK is the language-specific package for Topaz on
+  RunAPI. Use this topaz api package for image upscale, video upscale, restoration,
+  and production cleanup 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-topaz.rb
 - lib/runapi/topaz.rb
 - lib/runapi/topaz/client.rb
@@ -42,7 +47,7 @@ licenses:
 - Apache-2.0
 metadata:
   homepage_uri: https://runapi.ai/models/topaz
-  documentation_uri: https://github.com/runapi-ai/topaz-sdk/blob/main/README.md
+  documentation_uri: https://github.com/runapi-ai/topaz-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/topaz-sdk
   changelog_uri: https://github.com/runapi-ai/topaz-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: Topaz API SDKs for JavaScript, Ruby, and Go on RunAPI.
+summary: Topaz API Ruby SDK for RunAPI
 test_files: []