runapi-fish-audio 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 370d607320f1810125fdf732de7b8ec975b26ca62c47b1886338601ebdec10db
-  data.tar.gz: 86236d72fc06d5e105701df377d11542d5b291828c4cad809017505d1a85c58f
+  metadata.gz: 7787228caf6e8b7f36cde94f0930290801d93ae6fb7d613a948ca44013d3959e
+  data.tar.gz: '087c22f1cb69cdf5223f51b6448a966747e98352cecd52207bc00f04dda9ac82'
 SHA512:
-  metadata.gz: 57c267f3e0e8cf89caef1f2d7032363b79a8e7ae3809350887936a2e0d29912f56e8e3e2bea6fd1c0fc04076ab21cf084dd7f7c17a681fadda68cf8f243777b8
-  data.tar.gz: 100dfc8467279f6b2901f44269962fdb3d4ca630aa83cf5a50bcdc632fdd0572257aabe4ea7728730156fa7f6d8fa9e6a4e86d0acf31f9c7faa97b5ef024d19a
+  metadata.gz: 75e4e995715cca713106a0924f13589d64abe674cc490789bef0b2759563a22f1fa706ceb314302e04fcf811d7fd71659639c5917a3071ecb37555410442cda5
+  data.tar.gz: 7ca414ef2c860949a2de6fcfd981e6b0e6f93b306025b0f90a392394a3c47e55b1c409ba1d8753ab98b5bb9e49cd9863533588a367c2a4e54e84555ab2d63015

data/README.md

@@ -1,9 +1,18 @@
 # Fish Audio Ruby SDK for RunAPI
 
-Install `runapi-fish-audio`, create `RunApi::FishAudio::Client`, and call `client.text_to_speech.run(model: "s2.1-pro", text: "Hello [excited]", output_format: "wav", sample_rate_hz: 44_100)`.
+Install `runapi-fish-audio` and create a `RunApi::FishAudio::Client`.
+
+```ruby
+created = client.create_voice.run(name: "Narrator", source_audio_url: "https://cdn.runapi.ai/public/samples/voice.mp3")
+voice = client.get_voice.run(voice_id: created.voice.voice_id)
+raise "Voice is #{voice.voice.state}" unless voice.voice.state == "trained"
+result = client.text_to_speech.run(model: "s2.1-pro", text: "Hello [excited]", voice_id: created.voice.voice_id, output_format: "wav", sample_rate_hz: 44_100)
+```
 
 Pass optional `references` entries with base64-encoded raw audio bytes and exact transcripts for request-scoped voice matching.
 
+Use `list_voices` and `get_voice` to inspect account-owned voice resources. Only `trained` voices can be submitted for speech generation; a returned `voice_id` is a best-effort reference and may stop working later. Update, delete, revoke, or voice-library management methods are not provided; voice retention is not promised.
+
 The output defaults to MP3. Select WAV with `output_format`; `bitrate_kbps` applies only to MP3.
 
 Model details and pricing: https://runapi.ai/models/fish-audio/s2.1-pro

data/lib/runapi/fish_audio/client.rb

@@ -2,13 +2,16 @@
 
 module RunApi
   module FishAudio
-    # Fish Audio speech generation client.
+    # Fish Audio reusable voice and speech generation client.
     class Client < RunApi::Core::Client
-      attr_reader :text_to_speech
+      attr_reader :text_to_speech, :create_voice, :list_voices, :get_voice
 
       def initialize(api_key: nil, **options)
         super
         @text_to_speech = Resources::TextToSpeech.new(http)
+        @create_voice = Resources::CreateVoice.new(http)
+        @list_voices = Resources::ListVoices.new(http)
+        @get_voice = Resources::GetVoice.new(http)
       end
     end
   end

data/lib/runapi/fish_audio/contract_gen.rb

@@ -3,6 +3,45 @@
 module RunApi
   module FishAudio
     CONTRACT = {
+      "create-voice" => {
+        "models" => [],
+        "fields_by_model" => {
+          "_" => {
+            "name" => {
+              "required" => true
+            },
+            "source_audio_url" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "get-voice" => {
+        "models" => [],
+        "fields_by_model" => {
+          "_" => {
+            "voice_id" => {
+              "required" => true
+            }
+          }
+        }
+      },
+      "list-voices" => {
+        "models" => [],
+        "fields_by_model" => {
+          "_" => {
+            "page_number" => {
+              "min" => 1,
+              "type" => "integer"
+            },
+            "page_size" => {
+              "min" => 1,
+              "max" => 100,
+              "type" => "integer"
+            }
+          }
+        }
+      },
       "text-to-speech" => {
         "models" => ["s1", "s2-pro", "s2.1-pro"],
         "fields_by_model" => {

data/lib/runapi/fish_audio/resources/create_voice.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module RunApi
+  module FishAudio
+    module Resources
+      # Creates an account-owned reusable voice from source audio.
+      class CreateVoice
+        include RunApi::Core::ResourceHelpers
+
+        ENDPOINT = "/api/v1/fish_audio/voices"
+        RESPONSE_CLASS = Types::VoiceResponse
+
+        def initialize(http)
+          @http = http
+        end
+
+        def run(options: nil, **params)
+          params = compact_params(params)
+          validate_contract!(CONTRACT["create-voice"], params)
+          request(:post, ENDPOINT, body: params, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/runapi/fish_audio/resources/get_voice.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module RunApi
+  module FishAudio
+    module Resources
+      # Gets one reusable voice owned by the current account.
+      class GetVoice
+        include RunApi::Core::ResourceHelpers
+
+        ENDPOINT = "/api/v1/fish_audio/voices"
+        RESPONSE_CLASS = Types::VoiceResponse
+
+        def initialize(http)
+          @http = http
+        end
+
+        def run(voice_id:, options: nil)
+          params = compact_params(voice_id: voice_id)
+          validate_contract!(CONTRACT["get-voice"], params)
+          path = "#{ENDPOINT}/#{URI.encode_uri_component(voice_id)}"
+          request(:get, path, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/runapi/fish_audio/resources/list_voices.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module RunApi
+  module FishAudio
+    module Resources
+      # Lists reusable voices owned by the current account.
+      class ListVoices
+        include RunApi::Core::ResourceHelpers
+
+        ENDPOINT = "/api/v1/fish_audio/voices"
+        RESPONSE_CLASS = Types::VoicesResponse
+
+        def initialize(http)
+          @http = http
+        end
+
+        def run(options: nil, **params)
+          params = compact_params(params)
+          validate_contract!(CONTRACT["list-voices"], params)
+          query = URI.encode_www_form(params)
+          path = query.empty? ? ENDPOINT : "#{ENDPOINT}?#{query}"
+          request(:get, path, options: options)
+        end
+      end
+    end
+  end
+end

data/lib/runapi/fish_audio/types.rb

@@ -3,6 +3,28 @@
 module RunApi
   module FishAudio
     module Types
+      # An account-owned reusable voice.
+      class Voice < RunApi::Core::BaseModel
+        required :voice_id, String
+        optional :name, String
+        required :state, String
+      end
+
+      # Response containing one reusable voice.
+      class VoiceResponse < RunApi::Core::BaseModel
+        required :voice, -> { Voice }
+        required :billing, RunApi::Core::TaskBillingFacts
+      end
+
+      # Paginated response containing account-owned reusable voices.
+      class VoicesResponse < RunApi::Core::BaseModel
+        required :voices, [-> { Voice }]
+        required :total, Integer
+        required :page_number, Integer
+        required :page_size, Integer
+        required :billing, RunApi::Core::TaskBillingFacts
+      end
+
       # A RunAPI-managed audio result.
       class Audio < RunApi::Core::BaseModel
         required :url, String

data/lib/runapi/fish_audio.rb

@@ -3,6 +3,9 @@
 require "runapi/core"
 require_relative "fish_audio/types"
 require_relative "fish_audio/contract_gen"
+require_relative "fish_audio/resources/create_voice"
+require_relative "fish_audio/resources/list_voices"
+require_relative "fish_audio/resources/get_voice"
 require_relative "fish_audio/resources/text_to_speech"
 require_relative "fish_audio/client"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runapi-fish-audio
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - RunAPI
@@ -15,17 +15,15 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.3
-description: 'Install `runapi-fish-audio`, create `RunApi::FishAudio::Client`, and
-  call `client.text_to_speech.run(model: "s2.1-pro", text: "Hello [excited]", output_format:
-  "wav", sample_rate_hz: 44_100)`.'
+        version: 0.4.0
+description: Install `runapi-fish-audio` and create a `RunApi::FishAudio::Client`.
 email:
 - contact@runapi.ai
 executables: []
@@ -39,6 +37,9 @@ files:
 - lib/runapi/fish_audio.rb
 - lib/runapi/fish_audio/client.rb
 - lib/runapi/fish_audio/contract_gen.rb
+- lib/runapi/fish_audio/resources/create_voice.rb
+- lib/runapi/fish_audio/resources/get_voice.rb
+- lib/runapi/fish_audio/resources/list_voices.rb
 - lib/runapi/fish_audio/resources/text_to_speech.rb
 - lib/runapi/fish_audio/types.rb
 homepage: https://runapi.ai/models/fish-audio
@@ -65,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.17
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Fish Audio Ruby SDK for RunAPI
 test_files: []