assemblyai 1.0.2 → 1.2.0

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

@@ -18,19 +18,34 @@ module AssemblyAI
     class TranscriptOptionalParams
       # @return [AssemblyAI::Transcripts::TranscriptLanguageCode]
       attr_reader :language_code
+      # @return [Boolean] Enable [Automatic language
+      #  www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection),
+      #  either true or false.
+      attr_reader :language_detection
+      # @return [Float] The confidence threshold for the automatically detected language.
+      #  An error will be returned if the language confidence is below this threshold.
+      #  Defaults to 0.
+      attr_reader :language_confidence_threshold
+      # @return [AssemblyAI::Transcripts::SpeechModel]
+      attr_reader :speech_model
       # @return [Boolean] Enable Automatic Punctuation, can be true or false
       attr_reader :punctuate
       # @return [Boolean] Enable Text Formatting, can be true or false
       attr_reader :format_text
+      # @return [Boolean] Transcribe Filler Words, like "umm", in your media file; can be true or false
+      attr_reader :disfluencies
+      # @return [Boolean] Enable
+      #  ://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription)
+      #  transcription, can be true or false.
+      attr_reader :multichannel
       # @return [Boolean] Enable [Dual
       #  ://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription)
       #  transcription, can be true or false.
       attr_reader :dual_channel
-      # @return [AssemblyAI::Transcripts::SpeechModel]
-      attr_reader :speech_model
-      # @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.
+      # @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 to be sent with the transcript completed or failed webhook
       #  requests
@@ -46,7 +61,7 @@ module AssemblyAI
       attr_reader :audio_end_at
       # @return [Array<String>] The list of custom vocabulary to boost transcription probability for
       attr_reader :word_boost
-      # @return [AssemblyAI::Transcripts::TranscriptBoostParam] The word boost parameter value
+      # @return [AssemblyAI::Transcripts::TranscriptBoostParam] How much to boost specified words
       attr_reader :boost_param
       # @return [Boolean] Filter profanity from the transcribed text, can be true or false
       attr_reader :filter_profanity
@@ -89,14 +104,8 @@ module AssemblyAI
       #  Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true
       #  or false
       attr_reader :iab_categories
-      # @return [Boolean] Enable [Automatic language
-      #  www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection),
-      #  either true or false.
-      attr_reader :language_detection
       # @return [Array<AssemblyAI::Transcripts::TranscriptCustomSpelling>] Customize how words are spelled and formatted using to and from values
       attr_reader :custom_spelling
-      # @return [Boolean] Transcribe Filler Words, like "umm", in your media file; can be true or false
-      attr_reader :disfluencies
       # @return [Boolean] Enable [Sentiment
       #  Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be
       #  true or false
@@ -131,15 +140,26 @@ module AssemblyAI
       OMIT = Object.new
 
       # @param language_code [AssemblyAI::Transcripts::TranscriptLanguageCode]
+      # @param language_detection [Boolean] Enable [Automatic language
+      #  www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection),
+      #  either true or false.
+      # @param language_confidence_threshold [Float] The confidence threshold for the automatically detected language.
+      #  An error will be returned if the language confidence is below this threshold.
+      #  Defaults to 0.
+      # @param speech_model [AssemblyAI::Transcripts::SpeechModel]
       # @param punctuate [Boolean] Enable Automatic Punctuation, can be true or false
       # @param format_text [Boolean] Enable Text Formatting, can be true or false
+      # @param disfluencies [Boolean] Transcribe Filler Words, like "umm", in your media file; can be true or false
+      # @param multichannel [Boolean] Enable
+      #  ://www.assemblyai.com/docs/models/speech-recognition#multichannel-transcription)
+      #  transcription, can be true or false.
       # @param dual_channel [Boolean] Enable [Dual
       #  ://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 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_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
@@ -148,7 +168,7 @@ module AssemblyAI
       # @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
       # @param word_boost [Array<String>] The list of custom vocabulary to boost transcription probability for
-      # @param boost_param [AssemblyAI::Transcripts::TranscriptBoostParam] The word boost parameter value
+      # @param boost_param [AssemblyAI::Transcripts::TranscriptBoostParam] How much to boost specified words
       # @param filter_profanity [Boolean] Filter profanity from the transcribed text, can be true or false
       # @param redact_pii [Boolean] Redact PII from the transcribed text using the Redact PII model, can be true or
       #  false
@@ -179,11 +199,7 @@ module AssemblyAI
       # @param iab_categories [Boolean] Enable [Topic
       #  Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true
       #  or false
-      # @param language_detection [Boolean] Enable [Automatic language
-      #  www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection),
-      #  either true or false.
       # @param custom_spelling [Array<AssemblyAI::Transcripts::TranscriptCustomSpelling>] Customize how words are spelled and formatted using to and from values
-      # @param disfluencies [Boolean] Transcribe Filler Words, like "umm", in your media file; can be true or false
       # @param sentiment_analysis [Boolean] Enable [Sentiment
       #  Analysis](https://www.assemblyai.com/docs/models/sentiment-analysis), can be
       #  true or false
@@ -202,13 +218,17 @@ module AssemblyAI
       # @param topics [Array<String>] The list of custom topics
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::TranscriptOptionalParams]
-      def initialize(language_code: OMIT, punctuate: OMIT, format_text: OMIT, dual_channel: OMIT, speech_model: OMIT,
-                     webhook_url: OMIT, webhook_auth_header_name: OMIT, webhook_auth_header_value: OMIT, auto_highlights: OMIT, audio_start_from: OMIT, audio_end_at: OMIT, word_boost: OMIT, boost_param: OMIT, filter_profanity: OMIT, redact_pii: OMIT, redact_pii_audio: OMIT, redact_pii_audio_quality: OMIT, redact_pii_policies: OMIT, redact_pii_sub: OMIT, speaker_labels: OMIT, speakers_expected: OMIT, content_safety: OMIT, content_safety_confidence: OMIT, iab_categories: OMIT, language_detection: OMIT, custom_spelling: OMIT, disfluencies: OMIT, sentiment_analysis: OMIT, auto_chapters: OMIT, entity_detection: OMIT, speech_threshold: OMIT, summarization: OMIT, summary_model: OMIT, summary_type: OMIT, custom_topics: OMIT, topics: OMIT, additional_properties: nil)
+      def initialize(language_code: OMIT, language_detection: OMIT, language_confidence_threshold: OMIT,
+                     speech_model: OMIT, punctuate: OMIT, format_text: OMIT, disfluencies: OMIT, multichannel: OMIT, dual_channel: OMIT, webhook_url: OMIT, webhook_auth_header_name: OMIT, webhook_auth_header_value: OMIT, auto_highlights: OMIT, audio_start_from: OMIT, audio_end_at: OMIT, word_boost: OMIT, boost_param: OMIT, filter_profanity: OMIT, redact_pii: OMIT, redact_pii_audio: OMIT, redact_pii_audio_quality: OMIT, redact_pii_policies: OMIT, redact_pii_sub: OMIT, speaker_labels: OMIT, speakers_expected: OMIT, content_safety: OMIT, content_safety_confidence: OMIT, iab_categories: OMIT, custom_spelling: OMIT, sentiment_analysis: OMIT, auto_chapters: OMIT, entity_detection: OMIT, speech_threshold: OMIT, summarization: OMIT, summary_model: OMIT, summary_type: OMIT, custom_topics: OMIT, topics: OMIT, additional_properties: nil)
         @language_code = language_code if language_code != OMIT
+        @language_detection = language_detection if language_detection != OMIT
+        @language_confidence_threshold = language_confidence_threshold if language_confidence_threshold != OMIT
+        @speech_model = speech_model if speech_model != OMIT
         @punctuate = punctuate if punctuate != OMIT
         @format_text = format_text if format_text != OMIT
+        @disfluencies = disfluencies if disfluencies != OMIT
+        @multichannel = multichannel if multichannel != OMIT
         @dual_channel = dual_channel if dual_channel != OMIT
-        @speech_model = speech_model if speech_model != OMIT
         @webhook_url = webhook_url if webhook_url != OMIT
         @webhook_auth_header_name = webhook_auth_header_name if webhook_auth_header_name != OMIT
         @webhook_auth_header_value = webhook_auth_header_value if webhook_auth_header_value != OMIT
@@ -228,9 +248,7 @@ module AssemblyAI
         @content_safety = content_safety if content_safety != OMIT
         @content_safety_confidence = content_safety_confidence if content_safety_confidence != OMIT
         @iab_categories = iab_categories if iab_categories != OMIT
-        @language_detection = language_detection if language_detection != OMIT
         @custom_spelling = custom_spelling if custom_spelling != OMIT
-        @disfluencies = disfluencies if disfluencies != OMIT
         @sentiment_analysis = sentiment_analysis if sentiment_analysis != OMIT
         @auto_chapters = auto_chapters if auto_chapters != OMIT
         @entity_detection = entity_detection if entity_detection != OMIT
@@ -243,10 +261,14 @@ module AssemblyAI
         @additional_properties = additional_properties
         @_field_set = {
           "language_code": language_code,
+          "language_detection": language_detection,
+          "language_confidence_threshold": language_confidence_threshold,
+          "speech_model": speech_model,
           "punctuate": punctuate,
           "format_text": format_text,
+          "disfluencies": disfluencies,
+          "multichannel": multichannel,
           "dual_channel": dual_channel,
-          "speech_model": speech_model,
           "webhook_url": webhook_url,
           "webhook_auth_header_name": webhook_auth_header_name,
           "webhook_auth_header_value": webhook_auth_header_value,
@@ -266,9 +288,7 @@ module AssemblyAI
           "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,
@@ -291,10 +311,14 @@ module AssemblyAI
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
         language_code = struct["language_code"]
+        language_detection = struct["language_detection"]
+        language_confidence_threshold = struct["language_confidence_threshold"]
+        speech_model = struct["speech_model"]
         punctuate = struct["punctuate"]
         format_text = struct["format_text"]
+        disfluencies = struct["disfluencies"]
+        multichannel = struct["multichannel"]
         dual_channel = struct["dual_channel"]
-        speech_model = struct["speech_model"]
         webhook_url = struct["webhook_url"]
         webhook_auth_header_name = struct["webhook_auth_header_name"]
         webhook_auth_header_value = struct["webhook_auth_header_value"]
@@ -314,12 +338,10 @@ module AssemblyAI
         content_safety = struct["content_safety"]
         content_safety_confidence = struct["content_safety_confidence"]
         iab_categories = struct["iab_categories"]
-        language_detection = struct["language_detection"]
         custom_spelling = parsed_json["custom_spelling"]&.map do |v|
           v = v.to_json
           AssemblyAI::Transcripts::TranscriptCustomSpelling.from_json(json_object: v)
         end
-        disfluencies = struct["disfluencies"]
         sentiment_analysis = struct["sentiment_analysis"]
         auto_chapters = struct["auto_chapters"]
         entity_detection = struct["entity_detection"]
@@ -331,10 +353,14 @@ module AssemblyAI
         topics = struct["topics"]
         new(
           language_code: language_code,
+          language_detection: language_detection,
+          language_confidence_threshold: language_confidence_threshold,
+          speech_model: speech_model,
           punctuate: punctuate,
           format_text: format_text,
+          disfluencies: disfluencies,
+          multichannel: multichannel,
           dual_channel: dual_channel,
-          speech_model: speech_model,
           webhook_url: webhook_url,
           webhook_auth_header_name: webhook_auth_header_name,
           webhook_auth_header_value: webhook_auth_header_value,
@@ -354,9 +380,7 @@ module AssemblyAI
           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,
@@ -385,10 +409,14 @@ module AssemblyAI
       # @return [Void]
       def self.validate_raw(obj:)
         obj.language_code&.is_a?(AssemblyAI::Transcripts::TranscriptLanguageCode) != false || raise("Passed value for field obj.language_code is not the expected type, validation failed.")
+        obj.language_detection&.is_a?(Boolean) != false || raise("Passed value for field obj.language_detection is not the expected type, validation failed.")
+        obj.language_confidence_threshold&.is_a?(Float) != false || raise("Passed value for field obj.language_confidence_threshold is not the expected type, validation failed.")
+        obj.speech_model&.is_a?(AssemblyAI::Transcripts::SpeechModel) != false || raise("Passed value for field obj.speech_model 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.disfluencies&.is_a?(Boolean) != false || raise("Passed value for field obj.disfluencies is not the expected type, validation failed.")
+        obj.multichannel&.is_a?(Boolean) != false || raise("Passed value for field obj.multichannel 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.")
-        obj.speech_model&.is_a?(AssemblyAI::Transcripts::SpeechModel) != false || raise("Passed value for field obj.speech_model is not the expected type, validation failed.")
         obj.webhook_url&.is_a?(String) != false || raise("Passed value for field obj.webhook_url is not the expected type, validation failed.")
         obj.webhook_auth_header_name&.is_a?(String) != false || raise("Passed value for field obj.webhook_auth_header_name is not the expected type, validation failed.")
         obj.webhook_auth_header_value&.is_a?(String) != false || raise("Passed value for field obj.webhook_auth_header_value is not the expected type, validation failed.")
@@ -408,9 +436,7 @@ module AssemblyAI
         obj.content_safety&.is_a?(Boolean) != false || raise("Passed value for field obj.content_safety is not the expected type, validation failed.")
         obj.content_safety_confidence&.is_a?(Integer) != false || raise("Passed value for field obj.content_safety_confidence is not the expected type, validation failed.")
         obj.iab_categories&.is_a?(Boolean) != false || raise("Passed value for field obj.iab_categories is not the expected type, validation failed.")
-        obj.language_detection&.is_a?(Boolean) != false || raise("Passed value for field obj.language_detection is not the expected type, validation failed.")
         obj.custom_spelling&.is_a?(Array) != false || raise("Passed value for field obj.custom_spelling is not the expected type, validation failed.")
-        obj.disfluencies&.is_a?(Boolean) != false || raise("Passed value for field obj.disfluencies is not the expected type, validation failed.")
         obj.sentiment_analysis&.is_a?(Boolean) != false || raise("Passed value for field obj.sentiment_analysis is not the expected type, validation failed.")
         obj.auto_chapters&.is_a?(Boolean) != false || raise("Passed value for field obj.auto_chapters is not the expected type, validation failed.")
         obj.entity_detection&.is_a?(Boolean) != false || raise("Passed value for field obj.entity_detection is not the expected type, validation failed.")

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

@@ -7,20 +7,16 @@ require "json"
 module AssemblyAI
   class Transcripts
     class TranscriptParagraph
-      # @return [String]
+      # @return [String] The transcript of the paragraph
       attr_reader :text
-      # @return [Integer]
+      # @return [Integer] The starting time, in milliseconds, of the paragraph
       attr_reader :start
-      # @return [Integer]
+      # @return [Integer] The ending time, in milliseconds, of the paragraph
       attr_reader :end_
-      # @return [Float]
+      # @return [Float] The confidence score for the transcript of this paragraph
       attr_reader :confidence
-      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>] An array of words in the paragraph
       attr_reader :words
-      # @return [String] The speaker of the sentence if [Speaker
-      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
-      #  enabled, else null
-      attr_reader :speaker
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
       # @return [Object]
@@ -29,34 +25,21 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param text [String]
-      # @param start [Integer]
-      # @param end_ [Integer]
-      # @param confidence [Float]
-      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>]
-      # @param speaker [String] The speaker of the sentence if [Speaker
-      #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
-      #  enabled, else null
+      # @param text [String] The transcript of the paragraph
+      # @param start [Integer] The starting time, in milliseconds, of the paragraph
+      # @param end_ [Integer] The ending time, in milliseconds, of the paragraph
+      # @param confidence [Float] The confidence score for the transcript of this paragraph
+      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>] An array of words in the paragraph
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::TranscriptParagraph]
-      def initialize(text:, start:, end_:, confidence:, words:, speaker: OMIT, additional_properties: nil)
+      def initialize(text:, start:, end_:, confidence:, words:, additional_properties: nil)
         @text = text
         @start = start
         @end_ = end_
         @confidence = confidence
         @words = words
-        @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
-        @_field_set = {
-          "text": text,
-          "start": start,
-          "end": end_,
-          "confidence": confidence,
-          "words": words,
-          "speaker": speaker
-        }.reject do |_k, v|
-          v == OMIT
-        end
+        @_field_set = { "text": text, "start": start, "end": end_, "confidence": confidence, "words": words }
       end
 
       # Deserialize a JSON object to an instance of TranscriptParagraph
@@ -74,14 +57,12 @@ module AssemblyAI
           v = v.to_json
           AssemblyAI::Transcripts::TranscriptWord.from_json(json_object: v)
         end
-        speaker = struct["speaker"]
         new(
           text: text,
           start: start,
           end_: end_,
           confidence: confidence,
           words: words,
-          speaker: speaker,
           additional_properties: struct
         )
       end
@@ -105,7 +86,6 @@ module AssemblyAI
         obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ 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.words.is_a?(Array) != false || raise("Passed value for field obj.words is not the expected type, validation failed.")
-        obj.speaker&.is_a?(String) != false || raise("Passed value for field obj.speaker is not the expected type, validation failed.")
       end
     end
   end

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

@@ -7,16 +7,19 @@ require "json"
 module AssemblyAI
   class Transcripts
     class TranscriptSentence
-      # @return [String]
+      # @return [String] The transcript of the sentence
       attr_reader :text
-      # @return [Integer]
+      # @return [Integer] The starting time, in milliseconds, for the sentence
       attr_reader :start
-      # @return [Integer]
+      # @return [Integer] The ending time, in milliseconds, for the sentence
       attr_reader :end_
-      # @return [Float]
+      # @return [Float] The confidence score for the transcript of this sentence
       attr_reader :confidence
-      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      # @return [Array<AssemblyAI::Transcripts::TranscriptWord>] An array of words in the sentence
       attr_reader :words
+      # @return [String] The channel of the sentence. The left and right channels are channels 1 and 2.
+      #  Additional channels increment the channel number sequentially.
+      attr_reader :channel
       # @return [String] The speaker of the sentence if [Speaker
       #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
       #  enabled, else null
@@ -29,22 +32,26 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param text [String]
-      # @param start [Integer]
-      # @param end_ [Integer]
-      # @param confidence [Float]
-      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>]
+      # @param text [String] The transcript of the sentence
+      # @param start [Integer] The starting time, in milliseconds, for the sentence
+      # @param end_ [Integer] The ending time, in milliseconds, for the sentence
+      # @param confidence [Float] The confidence score for the transcript of this sentence
+      # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>] An array of words in the sentence
+      # @param channel [String] The channel of the sentence. The left and right channels are channels 1 and 2.
+      #  Additional channels increment the channel number sequentially.
       # @param speaker [String] The speaker of the sentence if [Speaker
       #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
       #  enabled, else null
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::TranscriptSentence]
-      def initialize(text:, start:, end_:, confidence:, words:, speaker: OMIT, additional_properties: nil)
+      def initialize(text:, start:, end_:, confidence:, words:, channel: OMIT, speaker: OMIT,
+                     additional_properties: nil)
         @text = text
         @start = start
         @end_ = end_
         @confidence = confidence
         @words = words
+        @channel = channel if channel != OMIT
         @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
         @_field_set = {
@@ -53,6 +60,7 @@ module AssemblyAI
           "end": end_,
           "confidence": confidence,
           "words": words,
+          "channel": channel,
           "speaker": speaker
         }.reject do |_k, v|
           v == OMIT
@@ -74,6 +82,7 @@ module AssemblyAI
           v = v.to_json
           AssemblyAI::Transcripts::TranscriptWord.from_json(json_object: v)
         end
+        channel = struct["channel"]
         speaker = struct["speaker"]
         new(
           text: text,
@@ -81,6 +90,7 @@ module AssemblyAI
           end_: end_,
           confidence: confidence,
           words: words,
+          channel: channel,
           speaker: speaker,
           additional_properties: struct
         )
@@ -105,6 +115,7 @@ module AssemblyAI
         obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ 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.words.is_a?(Array) != false || raise("Passed value for field obj.words is not the expected type, validation failed.")
+        obj.channel&.is_a?(String) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
         obj.speaker&.is_a?(String) != false || raise("Passed value for field obj.speaker is not the expected type, validation failed.")
       end
     end

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

@@ -17,6 +17,9 @@ module AssemblyAI
       attr_reader :text
       # @return [Array<AssemblyAI::Transcripts::TranscriptWord>] The words in the utterance.
       attr_reader :words
+      # @return [String] The channel of this utterance. The left and right channels are channels 1 and 2.
+      #  Additional channels increment the channel number sequentially.
+      attr_reader :channel
       # @return [String] The speaker of this utterance, where each speaker is assigned a sequential
       #  capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
       attr_reader :speaker
@@ -33,16 +36,19 @@ module AssemblyAI
       # @param end_ [Integer] The ending time, in milliseconds, of the utterance in the audio file
       # @param text [String] The text for this utterance
       # @param words [Array<AssemblyAI::Transcripts::TranscriptWord>] The words in the utterance.
+      # @param channel [String] The channel of this utterance. The left and right channels are channels 1 and 2.
+      #  Additional channels increment the channel number sequentially.
       # @param speaker [String] The speaker of this utterance, where each speaker is assigned a sequential
       #  capital letter - e.g. "A" for Speaker A, "B" for Speaker B, etc.
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::TranscriptUtterance]
-      def initialize(confidence:, start:, end_:, text:, words:, speaker:, additional_properties: nil)
+      def initialize(confidence:, start:, end_:, text:, words:, speaker:, channel: OMIT, additional_properties: nil)
         @confidence = confidence
         @start = start
         @end_ = end_
         @text = text
         @words = words
+        @channel = channel if channel != OMIT
         @speaker = speaker
         @additional_properties = additional_properties
         @_field_set = {
@@ -51,8 +57,11 @@ module AssemblyAI
           "end": end_,
           "text": text,
           "words": words,
+          "channel": channel,
           "speaker": speaker
-        }
+        }.reject do |_k, v|
+          v == OMIT
+        end
       end
 
       # Deserialize a JSON object to an instance of TranscriptUtterance
@@ -70,6 +79,7 @@ module AssemblyAI
           v = v.to_json
           AssemblyAI::Transcripts::TranscriptWord.from_json(json_object: v)
         end
+        channel = struct["channel"]
         speaker = struct["speaker"]
         new(
           confidence: confidence,
@@ -77,6 +87,7 @@ module AssemblyAI
           end_: end_,
           text: text,
           words: words,
+          channel: channel,
           speaker: speaker,
           additional_properties: struct
         )
@@ -101,6 +112,7 @@ module AssemblyAI
         obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
         obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
         obj.words.is_a?(Array) != false || raise("Passed value for field obj.words is not the expected type, validation failed.")
+        obj.channel&.is_a?(String) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
         obj.speaker.is_a?(String) != false || raise("Passed value for field obj.speaker is not the expected type, validation failed.")
       end
     end

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

@@ -6,15 +6,18 @@ require "json"
 module AssemblyAI
   class Transcripts
     class TranscriptWord
-      # @return [Float]
+      # @return [Float] The confidence score for the transcript of this word
       attr_reader :confidence
-      # @return [Integer]
+      # @return [Integer] The starting time, in milliseconds, for the word
       attr_reader :start
-      # @return [Integer]
+      # @return [Integer] The ending time, in milliseconds, for the word
       attr_reader :end_
-      # @return [String]
+      # @return [String] The text of the word
       attr_reader :text
-      # @return [String] The speaker of the sentence if [Speaker
+      # @return [String] The channel of the word. The left and right channels are channels 1 and 2.
+      #  Additional channels increment the channel number sequentially.
+      attr_reader :channel
+      # @return [String] The speaker of the word if [Speaker
       #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
       #  enabled, else null
       attr_reader :speaker
@@ -26,20 +29,23 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param confidence [Float]
-      # @param start [Integer]
-      # @param end_ [Integer]
-      # @param text [String]
-      # @param speaker [String] The speaker of the sentence if [Speaker
+      # @param confidence [Float] The confidence score for the transcript of this word
+      # @param start [Integer] The starting time, in milliseconds, for the word
+      # @param end_ [Integer] The ending time, in milliseconds, for the word
+      # @param text [String] The text of the word
+      # @param channel [String] The channel of the word. The left and right channels are channels 1 and 2.
+      #  Additional channels increment the channel number sequentially.
+      # @param speaker [String] The speaker of the word if [Speaker
       #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
       #  enabled, else null
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::TranscriptWord]
-      def initialize(confidence:, start:, end_:, text:, speaker: OMIT, additional_properties: nil)
+      def initialize(confidence:, start:, end_:, text:, channel: OMIT, speaker: OMIT, additional_properties: nil)
         @confidence = confidence
         @start = start
         @end_ = end_
         @text = text
+        @channel = channel if channel != OMIT
         @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
         @_field_set = {
@@ -47,6 +53,7 @@ module AssemblyAI
           "start": start,
           "end": end_,
           "text": text,
+          "channel": channel,
           "speaker": speaker
         }.reject do |_k, v|
           v == OMIT
@@ -63,12 +70,14 @@ module AssemblyAI
         start = struct["start"]
         end_ = struct["end"]
         text = struct["text"]
+        channel = struct["channel"]
         speaker = struct["speaker"]
         new(
           confidence: confidence,
           start: start,
           end_: end_,
           text: text,
+          channel: channel,
           speaker: speaker,
           additional_properties: struct
         )
@@ -92,6 +101,7 @@ module AssemblyAI
         obj.start.is_a?(Integer) != false || raise("Passed value for field obj.start is not the expected type, validation failed.")
         obj.end_.is_a?(Integer) != false || raise("Passed value for field obj.end_ is not the expected type, validation failed.")
         obj.text.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
+        obj.channel&.is_a?(String) != false || raise("Passed value for field obj.channel is not the expected type, validation failed.")
         obj.speaker&.is_a?(String) != false || raise("Passed value for field obj.speaker is not the expected type, validation failed.")
       end
     end

data/lib/gemconfig.rb

@@ -2,7 +2,7 @@
 
 module AssemblyAI
   module Gemconfig
-    VERSION = "1.0.2"
+    VERSION = "1.2.0"
     AUTHORS = ["AssemblyAI"].freeze
     EMAIL = "support@assemblyai.com"
     SUMMARY = "AssemblyAI Ruby SDK"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assemblyai
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.2.0
 platform: ruby
 authors:
 - AssemblyAI
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-08-20 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday