assemblyai 1.0.0.pre.beta.11 → 1.0.0.pre.beta.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 157742ad6decb8b828c23cf549a4e700d4cb0b2fdd9435bef9ca5e44424fdbda
-  data.tar.gz: a97d6acfec405cb63d78c6388602ede6ff6c885053feb054f82044ea17658a92
+  metadata.gz: 57111906829dc5c8b672c47fcfac95d6e6e05d6fd3df8523d16c5299f09e5aaf
+  data.tar.gz: 0300a4db2f0fa441594d7053f5232e06aaf70fddba251abe6664f4fbe4c1a617
 SHA512:
-  metadata.gz: 3136c68cf8ebeefb44cde0e3e55f968726bbf1d748a414d727ea6e0d73f244ac6a51f4edd688d4343ba857d2db28475fdcd4786f911ab2ce854d9206a3945b8a
-  data.tar.gz: 8f28783285bea24b5bd283f4385d748d81b0187276f6fedb4923df3be63493191391a99adcc478fd15d9b551186ca054a7822f76d16eae690292420c78d23339
+  metadata.gz: 501408f75273f6695433ea50640fa988db643e729341d70e1cc9275b0f3c26731d3321d62b3b610ccdbc6791ee8fc4a7824d448c3060d9f403ed7bf0e2e550ec
+  data.tar.gz: 4ee7018bf271a68a4fdec8c7676253188375ee9f00fb40a7d34d284fc93b87a0e3a31e702f5883031cb27712674abc9aa8462ad289ce7dd8aba4b66eb98f93a5

data/lib/assemblyai/lemur/client.rb

@@ -230,7 +230,7 @@ module AssemblyAI
     # @param request_id [String] The ID of the LeMUR request you previously made.
     #  This would be found in the response of the original request.
     # @param request_options [AssemblyAI::RequestOptions]
-    # @return [AssemblyAI::Lemur::LemurTaskResponse, AssemblyAI::Lemur::LemurSummaryResponse, AssemblyAI::Lemur::LemurQuestionAnswerResponse, AssemblyAI::Lemur::LemurActionItemsResponse]
+    # @return [AssemblyAI::Lemur::LemurStringResponse, AssemblyAI::Lemur::LemurQuestionAnswerResponse]
     # @example
     #  api = AssemblyAI::Client.new(
     #    environment: AssemblyAI::Environment::DEFAULT,
@@ -499,7 +499,7 @@ module AssemblyAI
     # @param request_id [String] The ID of the LeMUR request you previously made.
     #  This would be found in the response of the original request.
     # @param request_options [AssemblyAI::RequestOptions]
-    # @return [AssemblyAI::Lemur::LemurTaskResponse, AssemblyAI::Lemur::LemurSummaryResponse, AssemblyAI::Lemur::LemurQuestionAnswerResponse, AssemblyAI::Lemur::LemurActionItemsResponse]
+    # @return [AssemblyAI::Lemur::LemurStringResponse, AssemblyAI::Lemur::LemurQuestionAnswerResponse]
     # @example
     #  api = AssemblyAI::Client.new(
     #    environment: AssemblyAI::Environment::DEFAULT,

data/lib/assemblyai/lemur/types/lemur_action_items_response.rb

@@ -7,7 +7,7 @@ require "json"
 module AssemblyAI
   class Lemur
     class LemurActionItemsResponse
-      # @return [String] The response generated by LeMUR
+      # @return [String] The response generated by LeMUR.
       attr_reader :response
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
@@ -21,7 +21,7 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param response [String] The response generated by LeMUR
+      # @param response [String] The response generated by LeMUR.
       # @param request_id [String] The ID of the LeMUR request
       # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/assemblyai/lemur/types/lemur_response.rb

@@ -1,10 +1,8 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "lemur_task_response"
-require_relative "lemur_summary_response"
+require_relative "lemur_string_response"
 require_relative "lemur_question_answer_response"
-require_relative "lemur_action_items_response"
 
 module AssemblyAI
   class Lemur
@@ -16,16 +14,8 @@ module AssemblyAI
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         begin
-          AssemblyAI::Lemur::LemurTaskResponse.validate_raw(obj: struct)
-          return AssemblyAI::Lemur::LemurTaskResponse.from_json(json_object: json_object) unless json_object.nil?
-
-          return nil
-        rescue StandardError
-          # noop
-        end
-        begin
-          AssemblyAI::Lemur::LemurSummaryResponse.validate_raw(obj: struct)
-          return AssemblyAI::Lemur::LemurSummaryResponse.from_json(json_object: json_object) unless json_object.nil?
+          AssemblyAI::Lemur::LemurStringResponse.validate_raw(obj: struct)
+          return AssemblyAI::Lemur::LemurStringResponse.from_json(json_object: json_object) unless json_object.nil?
 
           return nil
         rescue StandardError
@@ -41,14 +31,6 @@ module AssemblyAI
         rescue StandardError
           # noop
         end
-        begin
-          AssemblyAI::Lemur::LemurActionItemsResponse.validate_raw(obj: struct)
-          return AssemblyAI::Lemur::LemurActionItemsResponse.from_json(json_object: json_object) unless json_object.nil?
-
-          return nil
-        rescue StandardError
-          # noop
-        end
         struct
       end
 
@@ -60,12 +42,7 @@ module AssemblyAI
       # @return [Void]
       def self.validate_raw(obj:)
         begin
-          return AssemblyAI::Lemur::LemurTaskResponse.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
-        begin
-          return AssemblyAI::Lemur::LemurSummaryResponse.validate_raw(obj: obj)
+          return AssemblyAI::Lemur::LemurStringResponse.validate_raw(obj: obj)
         rescue StandardError
           # noop
         end
@@ -74,11 +51,6 @@ module AssemblyAI
         rescue StandardError
           # noop
         end
-        begin
-          return AssemblyAI::Lemur::LemurActionItemsResponse.validate_raw(obj: obj)
-        rescue StandardError
-          # noop
-        end
         raise("Passed value matched no type within the union, validation failed.")
       end
     end

data/lib/assemblyai/lemur/types/lemur_string_response.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "lemur_usage"
+require "ostruct"
+require "json"
+
+module AssemblyAI
+  class Lemur
+    class LemurStringResponse
+      # @return [String] The response generated by LeMUR.
+      attr_reader :response
+      # @return [String] The ID of the LeMUR request
+      attr_reader :request_id
+      # @return [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      attr_reader :usage
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
+
+      OMIT = Object.new
+
+      # @param response [String] The response generated by LeMUR.
+      # @param request_id [String] The ID of the LeMUR request
+      # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [AssemblyAI::Lemur::LemurStringResponse]
+      def initialize(response:, request_id:, usage:, additional_properties: nil)
+        @response = response
+        @request_id = request_id
+        @usage = usage
+        @additional_properties = additional_properties
+        @_field_set = { "response": response, "request_id": request_id, "usage": usage }
+      end
+
+      # Deserialize a JSON object to an instance of LemurStringResponse
+      #
+      # @param json_object [String]
+      # @return [AssemblyAI::Lemur::LemurStringResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        response = struct["response"]
+        request_id = struct["request_id"]
+        if parsed_json["usage"].nil?
+          usage = nil
+        else
+          usage = parsed_json["usage"].to_json
+          usage = AssemblyAI::Lemur::LemurUsage.from_json(json_object: usage)
+        end
+        new(
+          response: response,
+          request_id: request_id,
+          usage: usage,
+          additional_properties: struct
+        )
+      end
+
+      # Serialize an instance of LemurStringResponse to a JSON object
+      #
+      # @return [String]
+      def to_json(*_args)
+        @_field_set&.to_json
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        obj.response.is_a?(String) != false || raise("Passed value for field obj.response is not the expected type, validation failed.")
+        obj.request_id.is_a?(String) != false || raise("Passed value for field obj.request_id is not the expected type, validation failed.")
+        AssemblyAI::Lemur::LemurUsage.validate_raw(obj: obj.usage)
+      end
+    end
+  end
+end

data/lib/assemblyai/lemur/types/lemur_summary_response.rb

@@ -7,7 +7,7 @@ require "json"
 module AssemblyAI
   class Lemur
     class LemurSummaryResponse
-      # @return [String] The response generated by LeMUR
+      # @return [String] The response generated by LeMUR.
       attr_reader :response
       # @return [String] The ID of the LeMUR request
       attr_reader :request_id
@@ -21,7 +21,7 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param response [String] The response generated by LeMUR
+      # @param response [String] The response generated by LeMUR.
       # @param request_id [String] The ID of the LeMUR request
       # @param usage [AssemblyAI::Lemur::LemurUsage] The usage numbers for the LeMUR request
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

data/lib/assemblyai/{streaming/types/streaming.rb → realtime/types/realtime.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module AssemblyAI
-  class Streaming
+  class Realtime
     # The encoding of the audio data
-    class Streaming
+    class Realtime
       PCM_S16LE = "pcm_s16le"
       PCM_MULAW = "pcm_mulaw"
     end

data/lib/assemblyai/{streaming → realtime}/types/receive_message.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "../../realtime/types/session_begins"
-require_relative "../../realtime/types/partial_transcript"
-require_relative "../../realtime/types/final_transcript"
-require_relative "../../realtime/types/session_information"
-require_relative "../../realtime/types/session_terminated"
-require_relative "../../realtime/types/realtime_error"
+require_relative "session_begins"
+require_relative "partial_transcript"
+require_relative "final_transcript"
+require_relative "session_information"
+require_relative "session_terminated"
+require_relative "realtime_error"
 
 module AssemblyAI
-  class Streaming
+  class Realtime
     # Receive messages from the WebSocket
     class ReceiveMessage
       # Deserialize a JSON object to an instance of ReceiveMessage
       #
       # @param json_object [String]
-      # @return [AssemblyAI::Streaming::ReceiveMessage]
+      # @return [AssemblyAI::Realtime::ReceiveMessage]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         begin

data/lib/assemblyai/{streaming → realtime}/types/send_message.rb

@@ -1,18 +1,18 @@
 # frozen_string_literal: true
 
 require "json"
-require_relative "../../realtime/types/terminate_session"
-require_relative "../../realtime/types/force_end_utterance"
-require_relative "../../realtime/types/configure_end_utterance_silence_threshold"
+require_relative "terminate_session"
+require_relative "force_end_utterance"
+require_relative "configure_end_utterance_silence_threshold"
 
 module AssemblyAI
-  class Streaming
+  class Realtime
     # Send messages to the WebSocket
     class SendMessage
       # Deserialize a JSON object to an instance of SendMessage
       #
       # @param json_object [String]
-      # @return [AssemblyAI::Streaming::SendMessage]
+      # @return [AssemblyAI::Realtime::SendMessage]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         begin

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/transcripts/types/paragraphs_response.rb

@@ -11,7 +11,7 @@ module AssemblyAI
       attr_reader :id
       # @return [Float]
       attr_reader :confidence
-      # @return [Float]
+      # @return [Integer]
       attr_reader :audio_duration
       # @return [Array<AssemblyAI::Transcripts::TranscriptParagraph>]
       attr_reader :paragraphs
@@ -25,7 +25,7 @@ module AssemblyAI
 
       # @param id [String]
       # @param confidence [Float]
-      # @param audio_duration [Float]
+      # @param audio_duration [Integer]
       # @param paragraphs [Array<AssemblyAI::Transcripts::TranscriptParagraph>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::ParagraphsResponse]
@@ -77,7 +77,7 @@ module AssemblyAI
       def self.validate_raw(obj:)
         obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.confidence.is_a?(Float) != false || raise("Passed value for field obj.confidence is not the expected type, validation failed.")
-        obj.audio_duration.is_a?(Float) != false || raise("Passed value for field obj.audio_duration is not the expected type, validation failed.")
+        obj.audio_duration.is_a?(Integer) != false || raise("Passed value for field obj.audio_duration is not the expected type, validation failed.")
         obj.paragraphs.is_a?(Array) != false || raise("Passed value for field obj.paragraphs is not the expected type, validation failed.")
       end
     end

data/lib/assemblyai/transcripts/types/redacted_audio_notification.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "redacted_audio_response"
+
+module AssemblyAI
+  class Transcripts
+    REDACTED_AUDIO_NOTIFICATION = AssemblyAI::Transcripts::RedactedAudioResponse
+  end
+end

data/lib/assemblyai/transcripts/types/sentences_response.rb

@@ -11,7 +11,7 @@ module AssemblyAI
       attr_reader :id
       # @return [Float]
       attr_reader :confidence
-      # @return [Float]
+      # @return [Integer]
       attr_reader :audio_duration
       # @return [Array<AssemblyAI::Transcripts::TranscriptSentence>]
       attr_reader :sentences
@@ -25,7 +25,7 @@ module AssemblyAI
 
       # @param id [String]
       # @param confidence [Float]
-      # @param audio_duration [Float]
+      # @param audio_duration [Integer]
       # @param sentences [Array<AssemblyAI::Transcripts::TranscriptSentence>]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::SentencesResponse]
@@ -77,7 +77,7 @@ module AssemblyAI
       def self.validate_raw(obj:)
         obj.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
         obj.confidence.is_a?(Float) != false || raise("Passed value for field obj.confidence is not the expected type, validation failed.")
-        obj.audio_duration.is_a?(Float) != false || raise("Passed value for field obj.audio_duration is not the expected type, validation failed.")
+        obj.audio_duration.is_a?(Integer) != false || raise("Passed value for field obj.audio_duration is not the expected type, validation failed.")
         obj.sentences.is_a?(Array) != false || raise("Passed value for field obj.sentences is not the expected type, validation failed.")
       end
     end

data/lib/assemblyai/transcripts/types/transcript.rb

@@ -55,7 +55,7 @@ module AssemblyAI
       # @return [Float] The confidence score for the transcript, between 0.0 (low confidence) and 1.0
       #  (high confidence)
       attr_reader :confidence
-      # @return [Float] The duration of this transcript object's media file, in seconds
+      # @return [Integer] The duration of this transcript object's media file, in seconds
       attr_reader :audio_duration
       # @return [Boolean] Whether Automatic Punctuation is enabled, either true or false
       attr_reader :punctuate
@@ -67,14 +67,18 @@ module AssemblyAI
       attr_reader :dual_channel
       # @return [AssemblyAI::Transcripts::SpeechModel]
       attr_reader :speech_model
-      # @return [String] The URL to which we send webhooks upon transcription completion
+      # @return [String] The URL to which we send webhook requests.
+      #  We sends two different types of webhook requests.
+      #  One request when a transcript is completed or failed, and one request when the
+      #  redacted audio is ready if redact_pii_audio is enabled.
       attr_reader :webhook_url
-      # @return [Integer] The status code we received from your server when delivering your webhook, if a
-      #  webhook URL was provided
+      # @return [Integer] The status code we received from your server when delivering the transcript
+      #  completed or failed webhook request, if a webhook URL was provided
       attr_reader :webhook_status_code
       # @return [Boolean] Whether webhook authentication details were provided
       attr_reader :webhook_auth
-      # @return [String] The header name which should be sent back with webhook calls
+      # @return [String] The header name to be sent with the transcript completed or failed webhook
+      #  requests
       attr_reader :webhook_auth_header_name
       # @return [Boolean] Whether speed boost is enabled
       attr_reader :speed_boost
@@ -223,18 +227,22 @@ module AssemblyAI
       #  more information.
       # @param confidence [Float] The confidence score for the transcript, between 0.0 (low confidence) and 1.0
       #  (high confidence)
-      # @param audio_duration [Float] The duration of this transcript object's media file, in seconds
+      # @param audio_duration [Integer] The duration of this transcript object's media file, in seconds
       # @param punctuate [Boolean] Whether Automatic Punctuation is enabled, either true or false
       # @param format_text [Boolean] Whether Text Formatting is enabled, either true or false
       # @param dual_channel [Boolean] Whether [Dual channel
       #  ://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription)
       #  was enabled in the transcription request, either true or false
       # @param speech_model [AssemblyAI::Transcripts::SpeechModel]
-      # @param webhook_url [String] The URL to which we send webhooks upon transcription completion
-      # @param webhook_status_code [Integer] The status code we received from your server when delivering your webhook, if a
-      #  webhook URL was provided
+      # @param webhook_url [String] The URL to which we send webhook requests.
+      #  We sends two different types of webhook requests.
+      #  One request when a transcript is completed or failed, and one request when the
+      #  redacted audio is ready if redact_pii_audio is enabled.
+      # @param webhook_status_code [Integer] The status code we received from your server when delivering the transcript
+      #  completed or failed webhook request, if a webhook URL was provided
       # @param webhook_auth [Boolean] Whether webhook authentication details were provided
-      # @param webhook_auth_header_name [String] The header name which should be sent back with webhook calls
+      # @param webhook_auth_header_name [String] The header name to be sent with the transcript completed or failed webhook
+      #  requests
       # @param speed_boost [Boolean] Whether speed boost is enabled
       # @param auto_highlights [Boolean] Whether Key Phrases is enabled, either true or false
       # @param auto_highlights_result [AssemblyAI::Transcripts::AutoHighlightsResult]
@@ -618,7 +626,7 @@ module AssemblyAI
         obj.words&.is_a?(Array) != false || raise("Passed value for field obj.words is not the expected type, validation failed.")
         obj.utterances&.is_a?(Array) != false || raise("Passed value for field obj.utterances is not the expected type, validation failed.")
         obj.confidence&.is_a?(Float) != false || raise("Passed value for field obj.confidence is not the expected type, validation failed.")
-        obj.audio_duration&.is_a?(Float) != false || raise("Passed value for field obj.audio_duration is not the expected type, validation failed.")
+        obj.audio_duration&.is_a?(Integer) != false || raise("Passed value for field obj.audio_duration is not the expected type, validation failed.")
         obj.punctuate&.is_a?(Boolean) != false || raise("Passed value for field obj.punctuate is not the expected type, validation failed.")
         obj.format_text&.is_a?(Boolean) != false || raise("Passed value for field obj.format_text is not the expected type, validation failed.")
         obj.dual_channel&.is_a?(Boolean) != false || raise("Passed value for field obj.dual_channel is not the expected type, validation failed.")

data/lib/assemblyai/transcripts/types/transcript_optional_params.rb

@@ -28,12 +28,15 @@ module AssemblyAI
       attr_reader :dual_channel
       # @return [AssemblyAI::Transcripts::SpeechModel]
       attr_reader :speech_model
-      # @return [String] The URL to which AssemblyAI send webhooks upon transcription completion
+      # @return [String] The URL to which we send webhook requests. We sends two different types of
+      #  webhook requests. One request when a transcript is completed or failed, and one
+      #  request when the redacted audio is ready if redact_pii_audio is enabled.
       attr_reader :webhook_url
-      # @return [String] The header name which should be sent back with webhook calls
+      # @return [String] The header name to be sent with the transcript completed or failed webhook
+      #  requests
       attr_reader :webhook_auth_header_name
-      # @return [String] Specify a header name and value to send back with a webhook call for added
-      #  security
+      # @return [String] The header value to send back with the transcript completed or failed webhook
+      #  requests for added security
       attr_reader :webhook_auth_header_value
       # @return [Boolean] Enable Key Phrases, either true or false
       attr_reader :auto_highlights
@@ -134,10 +137,13 @@ module AssemblyAI
       #  ://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription)
       #  transcription, can be true or false.
       # @param speech_model [AssemblyAI::Transcripts::SpeechModel]
-      # @param webhook_url [String] The URL to which AssemblyAI send webhooks upon transcription completion
-      # @param webhook_auth_header_name [String] The header name which should be sent back with webhook calls
-      # @param webhook_auth_header_value [String] Specify a header name and value to send back with a webhook call for added
-      #  security
+      # @param webhook_url [String] The URL to which we send webhook requests. We sends two different types of
+      #  webhook requests. One request when a transcript is completed or failed, and one
+      #  request when the redacted audio is ready if redact_pii_audio is enabled.
+      # @param webhook_auth_header_name [String] The header name to be sent with the transcript completed or failed webhook
+      #  requests
+      # @param webhook_auth_header_value [String] The header value to send back with the transcript completed or failed webhook
+      #  requests for added security
       # @param auto_highlights [Boolean] Enable Key Phrases, either true or false
       # @param audio_start_from [Integer] The point in time, in milliseconds, to begin transcribing in your media file
       # @param audio_end_at [Integer] The point in time, in milliseconds, to stop transcribing in your media file

data/lib/assemblyai/transcripts/types/transcript_webhook_notification.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "transcript_ready_notification"
+require_relative "redacted_audio_response"
+
+module AssemblyAI
+  class Transcripts
+    # The notifications sent to the webhook URL.
+    class TranscriptWebhookNotification
+      # Deserialize a JSON object to an instance of TranscriptWebhookNotification
+      #
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::TranscriptWebhookNotification]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          AssemblyAI::Transcripts::TranscriptReadyNotification.validate_raw(obj: struct)
+          unless json_object.nil?
+            return AssemblyAI::Transcripts::TranscriptReadyNotification.from_json(json_object: json_object)
+          end
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        begin
+          AssemblyAI::Transcripts::RedactedAudioResponse.validate_raw(obj: struct)
+          unless json_object.nil?
+            return AssemblyAI::Transcripts::RedactedAudioResponse.from_json(json_object: json_object)
+          end
+
+          return nil
+        rescue StandardError
+          # noop
+        end
+        struct
+      end
+
+      # Leveraged for Union-type generation, validate_raw attempts to parse the given
+      #  hash and check each fields type against the current object's property
+      #  definitions.
+      #
+      # @param obj [Object]
+      # @return [Void]
+      def self.validate_raw(obj:)
+        begin
+          return AssemblyAI::Transcripts::TranscriptReadyNotification.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return AssemblyAI::Transcripts::RedactedAudioResponse.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  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.13"
     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/types_export.rb

@@ -3,6 +3,8 @@
 require_relative "assemblyai/files/types/uploaded_file"
 require_relative "assemblyai/transcripts/types/transcript_ready_notification"
 require_relative "assemblyai/transcripts/types/redacted_audio_response"
+require_relative "assemblyai/transcripts/types/redacted_audio_notification"
+require_relative "assemblyai/transcripts/types/transcript_webhook_notification"
 require_relative "assemblyai/transcripts/types/redacted_audio_status"
 require_relative "assemblyai/transcripts/types/subtitle_format"
 require_relative "assemblyai/transcripts/types/word_search_response"
@@ -46,31 +48,35 @@ require_relative "assemblyai/transcripts/types/page_details"
 require_relative "assemblyai/transcripts/types/transcript_list_item"
 require_relative "assemblyai/transcripts/types/transcript_list"
 require_relative "assemblyai/transcripts/types/audio_intelligence_model_status"
-require_relative "assemblyai/realtime/types/realtime_base_message"
+require_relative "assemblyai/realtime/types/realtime"
 require_relative "assemblyai/realtime/types/session_begins"
 require_relative "assemblyai/realtime/types/partial_transcript"
 require_relative "assemblyai/realtime/types/final_transcript"
 require_relative "assemblyai/realtime/types/session_information"
 require_relative "assemblyai/realtime/types/session_terminated"
 require_relative "assemblyai/realtime/types/realtime_error"
+require_relative "assemblyai/realtime/types/receive_message"
+require_relative "assemblyai/realtime/types/terminate_session"
+require_relative "assemblyai/realtime/types/force_end_utterance"
+require_relative "assemblyai/realtime/types/configure_end_utterance_silence_threshold"
+require_relative "assemblyai/realtime/types/send_message"
+require_relative "assemblyai/realtime/types/realtime_base_message"
 require_relative "assemblyai/realtime/types/realtime_message"
 require_relative "assemblyai/realtime/types/message_type"
 require_relative "assemblyai/realtime/types/realtime_transcript_type"
 require_relative "assemblyai/realtime/types/realtime_transcript"
 require_relative "assemblyai/realtime/types/realtime_base_transcript"
 require_relative "assemblyai/realtime/types/word"
-require_relative "assemblyai/realtime/types/force_end_utterance"
-require_relative "assemblyai/realtime/types/configure_end_utterance_silence_threshold"
-require_relative "assemblyai/realtime/types/terminate_session"
 require_relative "assemblyai/realtime/types/audio_encoding"
 require_relative "assemblyai/realtime/types/realtime_temporary_token_response"
 require_relative "assemblyai/lemur/types/purge_lemur_request_data_response"
 require_relative "assemblyai/lemur/types/lemur_base_response"
+require_relative "assemblyai/lemur/types/lemur_string_response"
 require_relative "assemblyai/lemur/types/lemur_task_response"
 require_relative "assemblyai/lemur/types/lemur_summary_response"
+require_relative "assemblyai/lemur/types/lemur_action_items_response"
 require_relative "assemblyai/lemur/types/lemur_question_answer_response"
 require_relative "assemblyai/lemur/types/lemur_question_answer"
-require_relative "assemblyai/lemur/types/lemur_action_items_response"
 require_relative "assemblyai/lemur/types/lemur_response"
 require_relative "assemblyai/lemur/types/lemur_base_params_context"
 require_relative "assemblyai/lemur/types/lemur_base_params"
@@ -78,7 +84,4 @@ require_relative "assemblyai/lemur/types/lemur_question_context"
 require_relative "assemblyai/lemur/types/lemur_question"
 require_relative "assemblyai/lemur/types/lemur_model"
 require_relative "assemblyai/lemur/types/lemur_usage"
-require_relative "assemblyai/streaming/types/streaming"
-require_relative "assemblyai/streaming/types/receive_message"
-require_relative "assemblyai/streaming/types/send_message"
 require_relative "assemblyai/types/error"

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.13
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-06-27 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: []
@@ -110,6 +112,7 @@ files:
 - lib/assemblyai/lemur/types/lemur_question_answer_response.rb
 - lib/assemblyai/lemur/types/lemur_question_context.rb
 - lib/assemblyai/lemur/types/lemur_response.rb
+- lib/assemblyai/lemur/types/lemur_string_response.rb
 - lib/assemblyai/lemur/types/lemur_summary_response.rb
 - lib/assemblyai/lemur/types/lemur_task_response.rb
 - lib/assemblyai/lemur/types/lemur_usage.rb
@@ -121,6 +124,7 @@ files:
 - lib/assemblyai/realtime/types/force_end_utterance.rb
 - lib/assemblyai/realtime/types/message_type.rb
 - lib/assemblyai/realtime/types/partial_transcript.rb
+- lib/assemblyai/realtime/types/realtime.rb
 - lib/assemblyai/realtime/types/realtime_base_message.rb
 - lib/assemblyai/realtime/types/realtime_base_transcript.rb
 - lib/assemblyai/realtime/types/realtime_error.rb
@@ -128,14 +132,13 @@ files:
 - lib/assemblyai/realtime/types/realtime_temporary_token_response.rb
 - lib/assemblyai/realtime/types/realtime_transcript.rb
 - lib/assemblyai/realtime/types/realtime_transcript_type.rb
+- lib/assemblyai/realtime/types/receive_message.rb
+- lib/assemblyai/realtime/types/send_message.rb
 - lib/assemblyai/realtime/types/session_begins.rb
 - lib/assemblyai/realtime/types/session_information.rb
 - lib/assemblyai/realtime/types/session_terminated.rb
 - lib/assemblyai/realtime/types/terminate_session.rb
 - lib/assemblyai/realtime/types/word.rb
-- lib/assemblyai/streaming/types/receive_message.rb
-- lib/assemblyai/streaming/types/send_message.rb
-- lib/assemblyai/streaming/types/streaming.rb
 - lib/assemblyai/transcripts/client.rb
 - lib/assemblyai/transcripts/list_by_url_client.rb
 - lib/assemblyai/transcripts/polling_client.rb
@@ -153,6 +156,7 @@ files:
 - lib/assemblyai/transcripts/types/pii_policy.rb
 - lib/assemblyai/transcripts/types/polling_options.rb
 - lib/assemblyai/transcripts/types/redact_pii_audio_quality.rb
+- lib/assemblyai/transcripts/types/redacted_audio_notification.rb
 - lib/assemblyai/transcripts/types/redacted_audio_response.rb
 - lib/assemblyai/transcripts/types/redacted_audio_status.rb
 - lib/assemblyai/transcripts/types/sentences_response.rb
@@ -181,6 +185,7 @@ files:
 - lib/assemblyai/transcripts/types/transcript_sentence.rb
 - lib/assemblyai/transcripts/types/transcript_status.rb
 - lib/assemblyai/transcripts/types/transcript_utterance.rb
+- lib/assemblyai/transcripts/types/transcript_webhook_notification.rb
 - lib/assemblyai/transcripts/types/transcript_word.rb
 - lib/assemblyai/transcripts/types/word_search_match.rb
 - lib/assemblyai/transcripts/types/word_search_response.rb
@@ -190,6 +195,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 +220,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: ''
+summary: AssemblyAI Ruby SDK
 test_files: []