runapi-gemini-omni 0.2.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7eeb20441c69a3760cb85713f6089a3945f0338f689977e4389e6cd61247536
-  data.tar.gz: faeff081599dba899a2c097fa5ff24f9232abb6e36b93359f81e93c1ef5ad3d0
+  metadata.gz: 2ce28cbcd6a2e1ceeaa92132547c164196fc252f45991ef1806040d140637fc6
+  data.tar.gz: 19d8e45aa77191626e074d9aba1f93ac3e3749e9f257d850badcb221e648c803
 SHA512:
-  metadata.gz: be6ba08cff48a8edbd3d7e5ec10e8363aca7c08f822798a4a6b1ed52bfba3f5a1fa4efc4c0854cf322c052a708c81f9bb4c233bd6df0e55598ca154a4dc25132
-  data.tar.gz: c78fb526856111cd7b37206fcfdf324719b7375095ef1e2a47f79f668a6e7efc9048f8355aed37c01a1d729642603bc7d05d47dadba8fd755342c2960459e1c4
+  metadata.gz: ecb2027e247bbea97c967d597f9365451de272c8e571895e7abcec4f889130fc390c21f39021f5974672061279846d09c81b5c52d875afe8858bb7ff7b00ba31
+  data.tar.gz: 254fe608847cd99b86de64ee5dcc7ce83c1aba5101fac0cdb2fdfeaa836efa0b4f7bf9357224de0116e0303199ee25a86d1422d1cce6e923270cc2eb8cca5230

data/README.md

@@ -1,6 +1,6 @@
-# Gemini Omni API Ruby SDK for RunAPI
+# Gemini Omni Ruby SDK for RunAPI
 
-The gemini omni api Ruby SDK is the language-specific package for Gemini Omni on RunAPI. Use this package for voice resources, character resources, and multimodal video workflows that need JSON request bodies, task status lookup, and consistent RunAPI errors in Ruby.
+The Gemini Omni Ruby SDK is the language-specific package for Gemini Omni on RunAPI. Use this package for voice resources, character resources, and multimodal video generation workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in Ruby.
 
 ## Install
 
@@ -11,7 +11,7 @@ gem install runapi-gemini-omni
 ## Quick start
 
 ```ruby
-require "runapi-gemini_omni"
+require "runapi/gemini_omni"
 
 client = RunApi::GeminiOmni::Client.new
 voice = client.create_audio.run(
@@ -21,23 +21,25 @@ voice = client.create_audio.run(
 
 character = client.create_character.run(
   descriptions: "A silver-haired cyberpunk guide",
-  image_urls: ["https://file.runapi.ai/demo/character.png"]
+  reference_image_url: "https://cdn.runapi.ai/public/samples/reference-1.jpg"
 )
 
 video = client.text_to_video.run(
-  prompt: "Create a neon city tracking shot with the character walking forward.",
-  duration: "8",
-  resolution: "1080p",
-  character_ids: [character.id]
+  model: "gemini-omni-flash-preview",
+  prompt: "A paper airplane glides through a sunlit studio.",
+  aspect_ratio: "16:9",
+  output_resolution: "720p"
 )
 ```
 
+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.
+
 ## Links
 
 - Model page: https://runapi.ai/models/gemini-omni
 - SDK docs: https://runapi.ai/docs#sdk-gemini-omni
 - Product docs: https://runapi.ai/docs#gemini-omni
-- Pricing and rate limits: https://runapi.ai/models/gemini-omni
+- Flash Preview pricing and rate limits: https://runapi.ai/models/gemini-omni/flash-preview
 - Provider comparison: https://runapi.ai/providers/google
 - Full catalog: https://runapi.ai/models
 

data/lib/runapi/gemini_omni/client.rb

@@ -2,14 +2,29 @@
 
 module RunApi
   module GeminiOmni
-    class Client
-      attr_reader :create_audio, :create_character, :text_to_video
+    # Gemini Omni multimodal generation client for voice presets, character creation,
+    # and text-to-video with optional characters, audio voices, and reference media.
+    #
+    # @example
+    #   client = RunApi::GeminiOmni::Client.new(api_key: "sk-...")
+    #
+    #   audio = client.create_audio.run(audio_id: "zephyr", name: "Narrator")
+    #   video = client.text_to_video.run(
+    #     prompt: "A narrator walks through a futuristic city",
+    #     duration_seconds: 6,
+    #     audio_ids: [audio.audio.id]
+    #   )
+    #   puts video.videos.first.url
+    class Client < RunApi::Core::Client
+      # @return [Resources::CreateAudio] Registers reusable voice presets (synchronous).
+      attr_reader :create_audio
+      # @return [Resources::CreateCharacter] Builds reusable characters from reference images (synchronous).
+      attr_reader :create_character
+      # @return [Resources::TextToVideo] Generates video from prompts with optional characters and voices (async).
+      attr_reader :text_to_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
         @create_audio = Resources::CreateAudio.new(http)
         @create_character = Resources::CreateCharacter.new(http)
         @text_to_video = Resources::TextToVideo.new(http)

data/lib/runapi/gemini_omni/contract_gen.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module RunApi
+  module GeminiOmni
+    CONTRACT = {
+      "create-audio" => {
+        "models" => ["gemini-omni-audio"],
+        "fields_by_model" => {
+          "gemini-omni-audio" => {
+            "audio_id" => {
+              "required" => true
+            },
+            "name" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "create-character" => {
+        "models" => ["gemini-omni-character"],
+        "fields_by_model" => {
+          "gemini-omni-character" => {
+            "descriptions" => {
+              "required" => true
+            },
+            "reference_image_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "text-to-video" => {
+        "models" => ["gemini-omni-flash-preview", "gemini-omni-text-to-video"],
+        "fields_by_model" => {
+          "gemini-omni-flash-preview" => {
+            "aspect_ratio" => {
+              "enum" => ["16:9", "9:16"]
+            },
+            "duration_seconds" => {
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["720p"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          },
+          "gemini-omni-text-to-video" => {
+            "aspect_ratio" => {
+              "enum" => ["16:9", "9:16"]
+            },
+            "duration_seconds" => {
+              "enum" => [4, 6, 8, 10],
+              "required" => true,
+              "type" => "integer"
+            },
+            "output_resolution" => {
+              "enum" => ["720p", "1080p", "4k"]
+            },
+            "prompt" => {
+              "required" => true
+            },
+            "seed" => {
+              "type" => "integer"
+            }
+          }
+        },
+        "rules" => [{
+          "when" => {
+            "model" => "gemini-omni-flash-preview"
+          },
+          "forbidden" => ["reference_image_urls", "audio_ids", "video_list", "character_ids", "duration_seconds", "seed"]
+        }]
+      }
+    }.freeze
+  end
+end

data/lib/runapi/gemini_omni/resources/create_audio.rb

@@ -3,11 +3,14 @@
 module RunApi
   module GeminiOmni
     module Resources
+      # Registers a reusable voice preset from a built-in voice identity.
+      # Synchronous -- only +run+ is available (no create/get polling).
       class CreateAudio
         include RunApi::Core::ResourceHelpers
 
         ENDPOINT = "/api/v1/gemini_omni/create_audio"
         RESPONSE_CLASS = Types::CreateAudioResponse
+        MODEL = "gemini-omni-audio"
         NAME_MAX_LENGTH = 210
         VOICE_DESCRIPTION_MAX_LENGTH = 20_000
         EXAMPLE_DIALOGUE_MAX_LENGTH = 120
@@ -16,29 +19,21 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
+        def run(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         private
 
         def validate_params!(params)
-          validate_required!(params, :audio_id)
-          validate_required!(params, :name)
+          validate_contract!(CONTRACT["create-audio"], params.merge(model: MODEL))
           validate_length!(params, :name, NAME_MAX_LENGTH)
           validate_length!(params, :voice_description, VOICE_DESCRIPTION_MAX_LENGTH)
           validate_length!(params, :example_dialogue, EXAMPLE_DIALOGUE_MAX_LENGTH)
         end
 
-        def validate_required!(params, key)
-          value = param(params, key)
-          return if value.is_a?(String) ? !value.empty? : !value.nil?
-
-          raise Core::ValidationError, "#{key} is required"
-        end
-
         def validate_length!(params, key, max_length)
           value = param(params, key)
           return if value.nil? || value.to_s.length <= max_length

data/lib/runapi/gemini_omni/resources/create_character.rb

@@ -3,11 +3,15 @@
 module RunApi
   module GeminiOmni
     module Resources
+      # Builds a reusable character from a reference image and description.
+      # Attach audio IDs to give the character a specific voice.
+      # Synchronous -- only +run+ is available (no create/get polling).
       class CreateCharacter
         include RunApi::Core::ResourceHelpers
 
         ENDPOINT = "/api/v1/gemini_omni/create_character"
         RESPONSE_CLASS = Types::CreateCharacterResponse
+        MODEL = "gemini-omni-character"
         DESCRIPTIONS_MAX_LENGTH = 20_000
         CHARACTER_NAME_MAX_LENGTH = 210
 
@@ -15,34 +19,21 @@ module RunApi
           @http = http
         end
 
-        def run(**params)
+        def run(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
         private
 
         def validate_params!(params)
-          validate_required!(params, :descriptions)
-          validate_required!(params, :reference_image_url)
+          validate_contract!(CONTRACT["create-character"], params.merge(model: MODEL))
           validate_array!(params, :audio_ids) if param(params, :audio_ids)
           validate_length!(params, :descriptions, DESCRIPTIONS_MAX_LENGTH)
           validate_length!(params, :character_name, CHARACTER_NAME_MAX_LENGTH)
         end
 
-        def validate_required!(params, key)
-          value = param(params, key)
-          present = if value.is_a?(Array)
-            value.any?
-          else
-            value.is_a?(String) ? !value.empty? : !value.nil?
-          end
-          return if present
-
-          raise Core::ValidationError, "#{key} is required"
-        end
-
         def validate_array!(params, key)
           return if param(params, key).is_a?(Array)
 

data/lib/runapi/gemini_omni/resources/text_to_video.rb

@@ -3,12 +3,16 @@
 module RunApi
   module GeminiOmni
     module Resources
+      # Generates video from a prompt with optional characters, audio voices,
+      # reference images, and source video clips.
+      # Async -- use +run+ for automatic polling or +create+/+get+ for manual control.
       class TextToVideo
         include RunApi::Core::ResourceHelpers
 
         ENDPOINT = "/api/v1/gemini_omni/text_to_video"
         RESPONSE_CLASS = Types::TextToVideoResponse
         COMPLETED_RESPONSE_CLASS = Types::CompletedTextToVideoResponse
+        DEFAULT_MODEL = "gemini-omni-text-to-video"
         PROMPT_MAX_LENGTH = 20_000
         REFERENCE_IMAGE_URLS_MAX = 7
         AUDIO_IDS_MAX = 3
@@ -22,30 +26,28 @@ module RunApi
           @http = http
         end
 
-        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
 
-        def create(**params)
+        def create(options: nil, **params)
           params = compact_params(params)
           validate_params!(params)
-          request(:post, ENDPOINT, body: params)
+          request(:post, ENDPOINT, body: params, options: options)
         end
 
-        def get(id)
-          request(:get, "#{ENDPOINT}/#{id}")
+        def get(id, options: nil)
+          request(:get, "#{ENDPOINT}/#{id}", options: options)
         end
 
         private
 
         def validate_params!(params)
-          validate_required!(params, :prompt)
-          validate_required!(params, :duration_seconds)
+          selected_model = param(params, :model)
+          selected_model = DEFAULT_MODEL if selected_model.nil? || selected_model.to_s.empty?
+          validate_contract!(CONTRACT["text-to-video"], params.merge(model: selected_model))
           validate_length!(params, :prompt, PROMPT_MAX_LENGTH)
-          validate_optional!(params, :duration_seconds, Types::DURATIONS)
-          validate_optional!(params, :aspect_ratio, Types::ASPECT_RATIOS)
-          validate_optional!(params, :output_resolution, Types::OUTPUT_RESOLUTIONS)
           validate_array!(params, :reference_image_urls, REFERENCE_IMAGE_URLS_MAX) if param(params, :reference_image_urls)
           validate_array!(params, :audio_ids, AUDIO_IDS_MAX) if param(params, :audio_ids)
           validate_array!(params, :video_list, VIDEO_LIST_MAX) if param(params, :video_list)
@@ -55,18 +57,6 @@ module RunApi
           validate_seed!(params)
         end
 
-        def validate_required!(params, key)
-          value = param(params, key)
-          present = if value.is_a?(Array)
-            value.any?
-          else
-            value.is_a?(String) ? !value.empty? : !value.nil?
-          end
-          return if present
-
-          raise Core::ValidationError, "#{key} is required"
-        end
-
         def validate_length!(params, key, max_length)
           value = param(params, key)
           return if value.nil? || value.to_s.length <= max_length

data/lib/runapi/gemini_omni/types.rb

@@ -2,7 +2,9 @@
 
 module RunApi
   module GeminiOmni
+    # Type definitions and constants for the Gemini Omni API.
     module Types
+      # The 30 preset voice identities, each with distinct pitch, cadence, and personality.
       AUDIO_VOICES = %w[
         achernar achird algenib algieba alnilam aoede autonoe callirrhoe charon
         despina enceladus erinome fenrir gacrux iapetus kore laomedeia leda orus
@@ -10,46 +12,53 @@ module RunApi
         vindemiatrix zephyr zubenelgenubi
       ].freeze
 
+      # A created voice preset with its server-assigned ID.
       class Audio < RunApi::Core::BaseModel
         required :id, String
         optional :name, String
       end
 
+      # Result of a synchronous create-audio call.
       class CreateAudioResponse < RunApi::Core::BaseModel
         required :id, String
         optional :audio, -> { Audio }
         optional :error, String
       end
 
+      # URL to a generated or reference image.
       class Image < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # A created character with its ID, name, and reference images.
       class Character < RunApi::Core::BaseModel
         required :id, String
         optional :name, String
         optional :images, [-> { Image }]
       end
 
+      # Result of a synchronous create-character call.
       class CreateCharacterResponse < RunApi::Core::BaseModel
         required :id, String
         optional :character, -> { Character }
         optional :error, String
       end
 
-      DURATIONS = [4, 6, 8, 10].freeze
-      ASPECT_RATIOS = %w[16:9 9:16].freeze
-      OUTPUT_RESOLUTIONS = %w[720p 1080p 4k].freeze
+      # Valid seed range for reproducible generation.
       SEED_RANGE = (0..2_147_483_647)
 
+      # URL to a generated video file.
       class Video < RunApi::Core::BaseModel
         optional :url, String
       end
 
+      # Async text-to-video task result with lifecycle status and generated videos.
       class TextToVideoResponse < RunApi::Core::TaskResponse
         optional :videos, [-> { Video }]
       end
 
+      # Narrowed response returned by +run+ once polling confirms completion.
+      # Videos are guaranteed present.
       class CompletedTextToVideoResponse < TextToVideoResponse
         required :videos, [-> { Video }]
       end

data/lib/runapi/gemini_omni.rb

@@ -2,6 +2,7 @@
 
 require "runapi/core"
 require_relative "gemini_omni/types"
+require_relative "gemini_omni/contract_gen"
 require_relative "gemini_omni/resources/create_audio"
 require_relative "gemini_omni/resources/create_character"
 require_relative "gemini_omni/resources/text_to_video"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-gemini-omni
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - RunAPI
@@ -15,18 +15,18 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
+        version: 0.2.13
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.5
-description: The gemini omni api Ruby SDK is the language-specific package for Gemini
+        version: 0.2.13
+description: The Gemini Omni Ruby SDK is the language-specific package for Gemini
   Omni on RunAPI. Use this package for voice resources, character resources, and multimodal
-  video workflows that need JSON request bodies, task status lookup, and consistent
-  RunAPI errors in Ruby.
+  video generation workflows when your application needs request bodies, task status
+  lookup, and consistent RunAPI errors in Ruby.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,6 +39,7 @@ files:
 - lib/runapi-gemini_omni.rb
 - lib/runapi/gemini_omni.rb
 - lib/runapi/gemini_omni/client.rb
+- lib/runapi/gemini_omni/contract_gen.rb
 - lib/runapi/gemini_omni/resources/create_audio.rb
 - lib/runapi/gemini_omni/resources/create_character.rb
 - lib/runapi/gemini_omni/resources/text_to_video.rb
@@ -47,9 +48,11 @@ homepage: https://runapi.ai/models/gemini-omni
 licenses:
 - Apache-2.0
 metadata:
+  runapi_slug: gemini-omni
   homepage_uri: https://runapi.ai/models/gemini-omni
   documentation_uri: https://github.com/runapi-ai/gemini-omni-sdk/blob/main/ruby/README.md
   source_code_uri: https://github.com/runapi-ai/gemini-omni-sdk
+  bug_tracker_uri: https://github.com/runapi-ai/gemini-omni-sdk/issues
   changelog_uri: https://github.com/runapi-ai/gemini-omni-sdk/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
@@ -67,5 +70,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 4.0.10
 specification_version: 4
-summary: Gemini Omni API Ruby SDK for RunAPI
+summary: Gemini Omni Ruby SDK for RunAPI
 test_files: []