runapi-seedream 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd5375e0156b01735780ac14365797062e03a0e0659b2fa18077b8b00103d7a0
-  data.tar.gz: 2a3501a778307978b225a90234903ae77ce518b3d6cb206604cb5efa72be4f03
+  metadata.gz: d8ca9b02c90b624e837c7652223020526592784b12d0f0a6f54f7afc6d9ed4d7
+  data.tar.gz: a7b2b5fe72b6135055d4f0838fd9e704f6222c9cd1410615d6b1ca718af078c2
 SHA512:
-  metadata.gz: 00a681e2011e9a77015c55036e537aaa40f0d451142f1b2cd0582e91dd500c24599f17be6b2f226a46f986c6ac2c406fd0241b2fc6a22e309c930185f49e874d
-  data.tar.gz: e6e1ac147c0b246d308571e541e6aa5f5782e7c5fb2bff7bcd51385646af17893f8537a1999d237e0e0337700e814fd31e546506a37e97e2fca48ca26cc6f93e
+  metadata.gz: f4a3270d5d1920a9151e5d9053aba445e7a07125522e4508a5da35585d9fc69ecbed5681607fe5895bd829ef50b79b8fb16021dfcb7c76174a8e14e5c090cf28
+  data.tar.gz: 2f5cfa1042a0b46d66c70586cd95b24e688eac376699708a8806c8c78bc1ee9aa5abce75eb98f5ef32bbc73985aadad9b99ebead702603dbfef2a2d64cbd60a6

data/README.md

@@ -28,6 +28,8 @@ 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::Seedream` error classes when building image jobs, Rails workers, or scripts. The package exposes `text_to_image` for text models and `edit_image` for editing models. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.

data/lib/runapi/seedream/client.rb

@@ -2,14 +2,36 @@
 
 module RunApi
   module Seedream
-    class Client
-      attr_reader :text_to_image, :edit_image
+    # Seedream image generation and editing API client.
+    #
+    # Three model families with different field requirements:
+    # - 4.5: requires aspect_ratio and output_quality
+    # - 5-lite: same required fields as 4.5, faster generation
+    # - V4: uses output_resolution instead; supports seed and batch output_count
+    #
+    # @example
+    #   client = RunApi::Seedream::Client.new(api_key: "your-api-key")
+    #
+    #   # Seedream 4.5
+    #   result = client.text_to_image.run(
+    #     model: "seedream-4.5-text-to-image",
+    #     prompt: "A beautiful product render",
+    #     aspect_ratio: "16:9", output_quality: "high"
+    #   )
+    #
+    #   # Seedream V4 with batch output
+    #   batch = client.text_to_image.run(
+    #     model: "seedream-v4-text-to-image",
+    #     prompt: "Minimalist logo design", output_count: 4
+    #   )
+    class Client < RunApi::Core::Client
+      # @return [Resources::TextToImage] Text-to-image generation across model versions.
+      attr_reader :text_to_image
+      # @return [Resources::EditImage] Edit source images with a text prompt.
+      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/seedream/resources/edit_image.rb

@@ -3,6 +3,9 @@
 module RunApi
   module Seedream
     module Resources
+      # Seedream image editing resource.
+      # Modifies source images according to a text prompt.
+      # V4 models accept up to 10 source images; 4.5 and 5-lite accept up to 14.
       class EditImage
         include RunApi::Core::ResourceHelpers
 

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

@@ -3,6 +3,9 @@
 module RunApi
   module Seedream
     module Resources
+      # Seedream text-to-image generation resource.
+      # Field requirements vary by model: 4.5/5-lite require aspect_ratio and
+      # output_quality; V4 uses output_resolution and supports seed/output_count.
       class TextToImage
         include RunApi::Core::ResourceHelpers
 

data/lib/runapi/seedream/types.rb

@@ -2,6 +2,9 @@
 
 module RunApi
   module Seedream
+    # Seedream type constants and response models.
+    # Model families differ in supported params: 4.5/5-lite require aspect_ratio
+    # and output_quality; V4 uses output_resolution and supports seed/output_count.
     module Types
       MODELS = %w[
         seedream-4.5-text-to-image

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-seedream
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - RunAPI
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.6
 description: The seedream api Ruby SDK is the language-specific package for Seedream
   on RunAPI. Use this seedream api package for text-to-image, image editing, and creative
   production flows when your application needs JSON request bodies, task status lookup,