assemblyai 1.0.0.pre.beta.11 → 1.0.0.pre.beta.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157742ad6decb8b828c23cf549a4e700d4cb0b2fdd9435bef9ca5e44424fdbda
-  data.tar.gz: a97d6acfec405cb63d78c6388602ede6ff6c885053feb054f82044ea17658a92
+  metadata.gz: 9034fb96ca90c8408fbfd7fc97683c4d9a3ece611dd24c48cf1c4359fdb34f60
+  data.tar.gz: dcac6189a3a041f59a0b3eb67f4c27fa9bae181d3823fd514e3dbbd52ff69d71
 SHA512:
-  metadata.gz: 3136c68cf8ebeefb44cde0e3e55f968726bbf1d748a414d727ea6e0d73f244ac6a51f4edd688d4343ba857d2db28475fdcd4786f911ab2ce854d9206a3945b8a
-  data.tar.gz: 8f28783285bea24b5bd283f4385d748d81b0187276f6fedb4923df3be63493191391a99adcc478fd15d9b551186ca054a7822f76d16eae690292420c78d23339
+  metadata.gz: 8c949d40ee00af765612f85dd2291050d67b86171d8861927c7f70bc32bcfa06dd7af93e3877ac8d3ed3b2432b9c11c5e9394cc60aa1e34341ec05ad786c8939
+  data.tar.gz: 2b2f829a93d8d6c86c8d39c19190f2610edcb154882ba5b0e7b2a49be4ccbf6c6557835a6161ba327ab27bb47fad1b2acbe290c9f221e284f6168eb726d6e039

data/lib/assemblyai/transcripts/polling_client.rb

@@ -75,10 +75,15 @@ module AssemblyAI
       deprecate_conformer2(speech_model: speech_model)
       transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
                           webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options)
-      poll_transcript(transcript_id: transcript.id, polling_options: polling_options)
+      wait_until_ready(transcript_id: transcript.id, polling_options: polling_options)
     end
 
-    def poll_transcript(transcript_id:, polling_options:)
+    # Wait until the transcript is ready. The transcript is ready when the "status" is "completed".
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param polling_options [PollingOptions]
+    # @return [Transcripts::Transcript]
+    def wait_until_ready(transcript_id:, polling_options: Transcripts::PollingOptions.new)
       start_time = Time.now
       timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
       loop do
@@ -97,7 +102,8 @@ module AssemblyAI
     def deprecate_conformer2(speech_model: nil)
       warn "[DEPRECATION] `conformer-2` is deprecated.  Please use `best` or `nano` instead." if speech_model == "conformer-2"
     end
-    private :poll_transcript, :deprecate_conformer2
+
+    private :deprecate_conformer2
   end
 
   # :nodoc:
@@ -155,18 +161,23 @@ module AssemblyAI
       Async do
         transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
                             webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options).wait
-        poll_transcript(transcript_id: transcript.id, polling_options: polling_options).wait
+        wait_until_ready(transcript_id: transcript.id, polling_options: polling_options).wait
       end
     end
 
-    def poll_transcript(transcript_id:, polling_options:)
+    # Wait until the transcript is ready. The transcript is ready when the "status" is "completed".
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param polling_options [PollingOptions]
+    # @return [Transcripts::Transcript]
+    def wait_until_ready(transcript_id:, polling_options: Transcripts::PollingOptions.new)
       Async do
         start_time = Time.now
         timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
         loop do
-          transcript = get(transcript_id: transcript_id).wait
+          transcript = get(transcript_id: transcript_id)
           if transcript.status == Transcripts::TranscriptStatus::COMPLETED || transcript.status == Transcripts::TranscriptStatus::ERROR
-            break transcript
+            return transcript
           elsif polling_options.timeout.positive? && Time.now - start_time > timeout_in_seconds
             raise StandardError, "Polling timeout"
           end
@@ -180,6 +191,7 @@ module AssemblyAI
     def deprecate_conformer2(speech_model:)
       warn "[DEPRECATION] `conformer-2` is deprecated.  Please use `best` or `nano` instead." if speech_model == "conformer-2"
     end
-    private :poll_transcript, :deprecate_conformer2
+
+    private :deprecate_conformer2
   end
 end

data/lib/assemblyai.rb

@@ -14,14 +14,15 @@ module AssemblyAI
   class Client
     attr_reader :files, :transcripts, :realtime, :lemur
 
+    # @param api_key [String]
     # @param environment [Environment]
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
-    # @param api_key [String]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [Client]
-    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil)
+    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil, user_agent: nil)
       @request_client = RequestClient.new(environment: environment, max_retries: max_retries,
-                                          timeout_in_seconds: timeout_in_seconds, api_key: api_key)
+                                          timeout_in_seconds: timeout_in_seconds, api_key: api_key, user_agent: user_agent)
       @files = FilesClient.new(request_client: @request_client)
       @transcripts = TranscriptsClient.new(request_client: @request_client)
       @realtime = RealtimeClient.new(request_client: @request_client)
@@ -32,14 +33,15 @@ module AssemblyAI
   class AsyncClient
     attr_reader :files, :transcripts, :realtime, :lemur
 
+    # @param api_key [String]
     # @param environment [Environment]
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
-    # @param api_key [String]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [AsyncClient]
-    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil)
+    def initialize(api_key:, environment: Environment::DEFAULT, max_retries: nil, timeout_in_seconds: nil, user_agent: nil)
       @async_request_client = AsyncRequestClient.new(environment: environment, max_retries: max_retries,
-                                                     timeout_in_seconds: timeout_in_seconds, api_key: api_key)
+                                                     timeout_in_seconds: timeout_in_seconds, api_key: api_key, user_agent: user_agent)
       @files = AsyncFilesClient.new(request_client: @async_request_client)
       @transcripts = AsyncTranscriptsClient.new(request_client: @async_request_client)
       @realtime = AsyncRealtimeClient.new(request_client: @async_request_client)

data/lib/gemconfig.rb

@@ -2,11 +2,12 @@
 
 module AssemblyAI
   module Gemconfig
-    VERSION = ""
+    VERSION = "1.0.0-beta.12"
     AUTHORS = [""].freeze
-    EMAIL = ""
-    SUMMARY = ""
-    DESCRIPTION = ""
+    EMAIL = "support@assemblyai.com"
+    SUMMARY = "AssemblyAI Ruby SDK"
+    DESCRIPTION = "The AssemblyAI Ruby SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async, audio intelligence models, as well as the latest LeMUR models.
+The Ruby SDK does not support Streaming STT at this time."
     HOMEPAGE = "https://github.com/AssemblyAI/assemblyai-ruby-sdk"
     SOURCE_CODE_URI = "https://github.com/AssemblyAI/assemblyai-ruby-sdk"
     CHANGELOG_URI = "https://github.com/AssemblyAI/assemblyai-ruby-sdk/blob/master/CHANGELOG.md"

data/lib/requests.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "environment"
+require_relative "user_agent"
 require "faraday"
 require "faraday/retry"
 require "async/http/faraday"
@@ -16,21 +17,23 @@ module AssemblyAI
     # @return [String]
     attr_reader :default_environment
 
+    # @param api_key [String]
     # @param environment [AssemblyAI::Environment]
     # @param base_url [String]
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
-    # @param api_key [String]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [AssemblyAI::RequestClient]
     def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
-                   timeout_in_seconds: nil)
+                   timeout_in_seconds: nil, user_agent: nil)
       @default_environment = environment
       @base_url = environment || base_url
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.11",
-        "Authorization": api_key.to_s
+        "X-Fern-SDK-Version": AssemblyAI::Gemconfig::VERSION,
+        "Authorization": api_key.to_s,
+        "User-Agent": AssemblyAI::UserAgent.merge(AssemblyAI::DefaultUserAgent.instance.user_agent, user_agent).serialize
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
         faraday.request :json
@@ -62,16 +65,18 @@ module AssemblyAI
     # @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
     # @param timeout_in_seconds [Long]
     # @param api_key [String]
+    # @param user_agent [AssemblyAI::UserAgent]
     # @return [AssemblyAI::AsyncRequestClient]
     def initialize(api_key:, environment: AssemblyAI::Environment::DEFAULT, base_url: nil, max_retries: nil,
-                   timeout_in_seconds: nil)
+                   timeout_in_seconds: nil, user_agent: nil)
       @default_environment = environment
       @base_url = environment || base_url
       @headers = {
         "X-Fern-Language": "Ruby",
         "X-Fern-SDK-Name": "assemblyai",
-        "X-Fern-SDK-Version": "1.0.0-beta.11",
-        "Authorization": api_key.to_s
+        "X-Fern-SDK-Version": AssemblyAI::Gemconfig::VERSION,
+        "Authorization": api_key.to_s,
+        "User-Agent": AssemblyAI::UserAgent.merge(AssemblyAI::DefaultUserAgent.instance.user_agent, user_agent).serialize
       }
       @conn = Faraday.new(headers: @headers) do |faraday|
         faraday.request :json

data/lib/user_agent.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "singleton"
+
+module AssemblyAI
+  class UserAgentItem
+    attr_reader :name, :value, :version
+
+    def initialize(name:, version:)
+      @name = name
+      @version = version
+    end
+  end
+
+  class UserAgent
+    attr_reader :user_agent_items
+
+    def initialize
+      @user_agent_items = {}
+    end
+
+    # @param key [String]
+    # @param user_agent_item [AssemblyAI::UserAgentItem]
+    def add_item(key, user_agent_item)
+      if user_agent_item.nil?
+        @user_agent_items.delete(key)
+      else
+        @user_agent_items[key] = user_agent_item
+      end
+    end
+
+    # @param user_agent1 [AssemblyAI::UserAgent]
+    # @param user_agent2 [AssemblyAI::UserAgent]
+    # @return [AssemblyAI::UserAgent]
+    def self.merge(user_agent1, user_agent2)
+      merged_user_agent = UserAgent.new
+
+      user_agent1&.user_agent_items&.each do |key, item|
+        merged_user_agent.add_item(key, item)
+      end
+
+      user_agent2&.user_agent_items&.each do |key, item|
+        merged_user_agent.add_item(key, item)
+      end
+
+      merged_user_agent
+    end
+
+    # @return [String]
+    def serialize
+      serialized_items = @user_agent_items.map do |key, item|
+        "#{key}=#{item.name}/#{item.version}"
+      end.join(" ")
+
+      "AssemblyAI/1.0 (#{serialized_items})"
+    end
+  end
+
+  class DefaultUserAgent
+    include Singleton
+
+    attr_reader :user_agent
+
+    def initialize
+      @user_agent = UserAgent.new
+      @user_agent.add_item("sdk", UserAgentItem.new(name: "Ruby", version: AssemblyAI::Gemconfig::VERSION))
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.beta.11
+  version: 1.0.0.pre.beta.12
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -90,8 +90,10 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: ''
-email: ''
+description: |-
+  The AssemblyAI Ruby SDK provides an easy-to-use interface for interacting with the AssemblyAI API, which supports async, audio intelligence models, as well as the latest LeMUR models.
+  The Ruby SDK does not support Streaming STT at this time.
+email: support@assemblyai.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -190,6 +192,7 @@ files:
 - lib/gemconfig.rb
 - lib/requests.rb
 - lib/types_export.rb
+- lib/user_agent.rb
 homepage: https://github.com/AssemblyAI/assemblyai-ruby-sdk
 licenses: []
 metadata:
@@ -214,5 +217,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: ''
+summary: AssemblyAI Ruby SDK
 test_files: []