assemblyai 1.0.2 → 1.2.0

data/lib/assemblyai/transcripts/polling_client.rb

@@ -26,54 +26,93 @@ module AssemblyAI
     # Create a transcript from an audio or video file that is accessible via a URL.
     # .transcribe polls for completion of the transcription, while the .submit function does not.
     #
-    # @param speech_model [Transcripts::SpeechModel]
-    # @param language_code [Transcripts::TranscriptLanguageCode]
+    # @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 dual_channel [Boolean] Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
-    # @param webhook_url [String] The URL to which AssemblyAI send webhooks upon trancription 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 auto_highlights [Boolean] Whether Key Phrases is enabled, either 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 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
     # @param word_boost [Array<String>] The list of custom vocabulary to boost transcription probability for
-    # @param boost_param [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
-    # @param redact_pii_audio [Boolean] Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_audio_quality [Transcripts::RedactPiiAudioQuality] Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_policies [Array<Transcripts::PiiPolicy>] The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_sub [Transcripts::SubstitutionPolicy]
-    # @param speaker_labels [Boolean] Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
-    # @param speakers_expected [Integer] Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
-    # @param content_safety [Boolean] Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
-    # @param content_safety_confidence [Integer] The confidence threshold for content moderation. Values must be between 25 and 100.
-    # @param iab_categories [Boolean] Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false
-    # @param language_detection [Boolean] Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) was enabled in the transcription request, either true or false.
-    # @param custom_spelling [Array<Hash>] Customize how words are spelled and formatted using to and from valuesRequest of type Array<Transcripts::TranscriptCustomSpelling>, as a Hash
+    # @param redact_pii [Boolean] Redact PII from the transcribed text using the Redact PII model, can be true or
+    #  false
+    # @param redact_pii_audio [Boolean] Generate a copy of the original media file with spoken PII "beeped" out, can be
+    #  true or false. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
+    # @param redact_pii_audio_quality [AssemblyAI::Transcripts::RedactPiiAudioQuality] Controls the filetype of the audio created by redact_pii_audio. Currently
+    #  supports mp3 (default) and wav. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
+    # @param redact_pii_policies [Array<AssemblyAI::Transcripts::PiiPolicy>] The list of PII Redaction policies to enable. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
+    # @param redact_pii_sub [AssemblyAI::Transcripts::SubstitutionPolicy]
+    # @param speaker_labels [Boolean] Enable [Speaker
+    #  diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be
+    #  true or false
+    # @param speakers_expected [Integer] Tells the speaker label model how many speakers it should attempt to identify,
+    #  up to 10. See [Speaker
+    #  diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for
+    #  more details.
+    # @param content_safety [Boolean] Enable [Content
+    #  Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be
+    #  true or false
+    # @param content_safety_confidence [Integer] The confidence threshold for the Content Moderation model. Values must be
+    #  between 25 and 100.
+    # @param iab_categories [Boolean] Enable [Topic
+    #  Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true
+    #  or false
+    # @param custom_spelling [Array<Hash>] Customize how words are spelled and formatted using to and from valuesRequest of type Array<AssemblyAI::Transcripts::TranscriptCustomSpelling>, as a Hash
     #   * :from (Array<String>)
     #   * :to (String)
-    # @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
-    # @param auto_chapters [Boolean] Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false
-    # @param entity_detection [Boolean] Enable [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection), 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
+    # @param auto_chapters [Boolean] Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters),
+    #  can be true or false
+    # @param entity_detection [Boolean] Enable [Entity
+    #  Detection](https://www.assemblyai.com/docs/models/entity-detection), can be true
+    #  or false
     # @param speech_threshold [Float] Reject audio files that contain less than this fraction of speech.
-    #   Valid values are in the range [0, 1] inclusive.
-    # @param summarization [Boolean] Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false
-    # @param summary_model [Transcripts::SummaryModel] The model to summarize the transcript
-    # @param summary_type [Transcripts::SummaryType] The type of summary
-    # @param custom_topics [Boolean] Whether custom topics is enabled, either true or false
-    # @param topics [Array<String>] The list of custom topics provided, if custom topics is enabled
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    #  Valid values are in the range [0, 1] inclusive.
+    # @param summarization [Boolean] Enable [Summarization](https://www.assemblyai.com/docs/models/summarization),
+    #  can be true or false
+    # @param summary_model [AssemblyAI::Transcripts::SummaryModel] The model to summarize the transcript
+    # @param summary_type [AssemblyAI::Transcripts::SummaryType] The type of summary
+    # @param custom_topics [Boolean] Enable custom topics, either true or false
+    # @param topics [Array<String>] The list of custom topics
     # @param audio_url [String] The URL of the audio or video file to transcribe.
-    # @param request_options [RequestOptions]
+    # @param request_options [AssemblyAI::RequestOptions]
     # @param polling_options [Transcripts::PollingOptions] Configuration options for polling requests.
     # @return [Transcripts::Transcript]
-    def transcribe(audio_url:, speech_model: nil, language_code: nil, punctuate: nil, format_text: nil, dual_channel: nil,
-                   webhook_url: nil, webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, language_detection: nil, custom_spelling: nil, disfluencies: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, additional_properties: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
+    def transcribe(audio_url:, language_code: nil, language_detection: nil, language_confidence_threshold: nil, speech_model: nil,
+                   punctuate: nil, format_text: nil, disfluencies: nil, multichannel: nil, dual_channel: nil, webhook_url: nil, webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, custom_spelling: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
       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)
+                          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, language_confidence_threshold: language_confidence_threshold, custom_spelling: custom_spelling, disfluencies: disfluencies, multichannel: multichannel, 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, request_options: request_options)
       wait_until_ready(transcript_id: transcript.id, polling_options: polling_options)
     end
 
@@ -103,55 +142,94 @@ module AssemblyAI
     # Create a transcript from an audio or video file that is accessible via a URL.
     # .transcribe polls for completion of the transcription, while the .submit function does not.
     #
-    # @param speech_model [Transcripts::SpeechModel]
-    # @param language_code [Transcripts::TranscriptLanguageCode]
+    # @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 dual_channel [Boolean] Enable [Dual Channel](https://www.assemblyai.com/docs/models/speech-recognition#dual-channel-transcription) transcription, can be true or false.
-    # @param webhook_url [String] The URL to which AssemblyAI send webhooks upon trancription 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 auto_highlights [Boolean] Whether Key Phrases is enabled, either 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 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
     # @param word_boost [Array<String>] The list of custom vocabulary to boost transcription probability for
-    # @param boost_param [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
-    # @param redact_pii_audio [Boolean] Generate a copy of the original media file with spoken PII "beeped" out, can be true or false. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_audio_quality [Transcripts::RedactPiiAudioQuality] Controls the filetype of the audio created by redact_pii_audio. Currently supports mp3 (default) and wav. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_policies [Array<Transcripts::PiiPolicy>] The list of PII Redaction policies to enable. See [PII redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more details.
-    # @param redact_pii_sub [Transcripts::SubstitutionPolicy]
-    # @param speaker_labels [Boolean] Enable [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be true or false
-    # @param speakers_expected [Integer] Tells the speaker label model how many speakers it should attempt to identify, up to 10. See [Speaker diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for more details.
-    # @param content_safety [Boolean] Enable [Content Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be true or false
-    # @param content_safety_confidence [Integer] The confidence threshold for content moderation. Values must be between 25 and 100.
-    # @param iab_categories [Boolean] Enable [Topic Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true or false
-    # @param language_detection [Boolean] Whether [Automatic language detection](https://www.assemblyai.com/docs/models/speech-recognition#automatic-language-detection) was enabled in the transcription request, either true or false.
-    # @param custom_spelling [Array<Hash>] Customize how words are spelled and formatted using to and from valuesRequest of type Array<Transcripts::TranscriptCustomSpelling>, as a Hash
+    # @param redact_pii [Boolean] Redact PII from the transcribed text using the Redact PII model, can be true or
+    #  false
+    # @param redact_pii_audio [Boolean] Generate a copy of the original media file with spoken PII "beeped" out, can be
+    #  true or false. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
+    # @param redact_pii_audio_quality [AssemblyAI::Transcripts::RedactPiiAudioQuality] Controls the filetype of the audio created by redact_pii_audio. Currently
+    #  supports mp3 (default) and wav. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
+    # @param redact_pii_policies [Array<AssemblyAI::Transcripts::PiiPolicy>] The list of PII Redaction policies to enable. See [PII
+    #  redaction](https://www.assemblyai.com/docs/models/pii-redaction) for more
+    #  details.
+    # @param redact_pii_sub [AssemblyAI::Transcripts::SubstitutionPolicy]
+    # @param speaker_labels [Boolean] Enable [Speaker
+    #  diarization](https://www.assemblyai.com/docs/models/speaker-diarization), can be
+    #  true or false
+    # @param speakers_expected [Integer] Tells the speaker label model how many speakers it should attempt to identify,
+    #  up to 10. See [Speaker
+    #  diarization](https://www.assemblyai.com/docs/models/speaker-diarization) for
+    #  more details.
+    # @param content_safety [Boolean] Enable [Content
+    #  Moderation](https://www.assemblyai.com/docs/models/content-moderation), can be
+    #  true or false
+    # @param content_safety_confidence [Integer] The confidence threshold for the Content Moderation model. Values must be
+    #  between 25 and 100.
+    # @param iab_categories [Boolean] Enable [Topic
+    #  Detection](https://www.assemblyai.com/docs/models/topic-detection), can be true
+    #  or false
+    # @param custom_spelling [Array<Hash>] Customize how words are spelled and formatted using to and from valuesRequest of type Array<AssemblyAI::Transcripts::TranscriptCustomSpelling>, as a Hash
     #   * :from (Array<String>)
     #   * :to (String)
-    # @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
-    # @param auto_chapters [Boolean] Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters), can be true or false
-    # @param entity_detection [Boolean] Enable [Entity Detection](https://www.assemblyai.com/docs/models/entity-detection), 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
+    # @param auto_chapters [Boolean] Enable [Auto Chapters](https://www.assemblyai.com/docs/models/auto-chapters),
+    #  can be true or false
+    # @param entity_detection [Boolean] Enable [Entity
+    #  Detection](https://www.assemblyai.com/docs/models/entity-detection), can be true
+    #  or false
     # @param speech_threshold [Float] Reject audio files that contain less than this fraction of speech.
-    #   Valid values are in the range [0, 1] inclusive.
-    # @param summarization [Boolean] Enable [Summarization](https://www.assemblyai.com/docs/models/summarization), can be true or false
-    # @param summary_model [Transcripts::SummaryModel] The model to summarize the transcript
-    # @param summary_type [Transcripts::SummaryType] The type of summary
-    # @param custom_topics [Boolean] Whether custom topics is enabled, either true or false
-    # @param topics [Array<String>] The list of custom topics provided, if custom topics is enabled
-    # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+    #  Valid values are in the range [0, 1] inclusive.
+    # @param summarization [Boolean] Enable [Summarization](https://www.assemblyai.com/docs/models/summarization),
+    #  can be true or false
+    # @param summary_model [AssemblyAI::Transcripts::SummaryModel] The model to summarize the transcript
+    # @param summary_type [AssemblyAI::Transcripts::SummaryType] The type of summary
+    # @param custom_topics [Boolean] Enable custom topics, either true or false
+    # @param topics [Array<String>] The list of custom topics
     # @param audio_url [String] The URL of the audio or video file to transcribe.
-    # @param request_options [RequestOptions]
+    # @param request_options [AssemblyAI::RequestOptions]
     # @param polling_options [Transcripts::PollingOptions] Configuration options for polling requests.
     # @return [Transcripts::Transcript]
-    def transcribe(audio_url:, speech_model: nil, language_code: nil, punctuate: nil, format_text: nil, dual_channel: nil,
-                   webhook_url: nil, webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, language_detection: nil, custom_spelling: nil, disfluencies: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, additional_properties: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
+    def transcribe(audio_url:, language_code: nil, language_detection: nil, language_confidence_threshold: nil, speech_model: nil,
+                   punctuate: nil, format_text: nil, disfluencies: nil, multichannel: nil, dual_channel: nil, webhook_url: nil, webhook_auth_header_name: nil, webhook_auth_header_value: nil, auto_highlights: nil, audio_start_from: nil, audio_end_at: nil, word_boost: nil, boost_param: nil, filter_profanity: nil, redact_pii: nil, redact_pii_audio: nil, redact_pii_audio_quality: nil, redact_pii_policies: nil, redact_pii_sub: nil, speaker_labels: nil, speakers_expected: nil, content_safety: nil, content_safety_confidence: nil, iab_categories: nil, custom_spelling: nil, sentiment_analysis: nil, auto_chapters: nil, entity_detection: nil, speech_threshold: nil, summarization: nil, summary_model: nil, summary_type: nil, custom_topics: nil, topics: nil, request_options: nil, polling_options: Transcripts::PollingOptions.new)
       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
+                            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, language_confidence_threshold: language_confidence_threshold, custom_spelling: custom_spelling, disfluencies: disfluencies, multichannel: multichannel, 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, request_options: request_options)
         wait_until_ready(transcript_id: transcript.id, polling_options: polling_options).wait
       end
     end

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

@@ -15,7 +15,7 @@ module AssemblyAI
       # @return [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in
       #  the rare case that the model failed.
       attr_reader :status
-      # @return [Array<AssemblyAI::Transcripts::ContentSafetyLabelResult>]
+      # @return [Array<AssemblyAI::Transcripts::ContentSafetyLabelResult>] An array of results for the Content Moderation model
       attr_reader :results
       # @return [Hash{String => Float}] A summary of the Content Moderation confidence results for the entire audio file
       attr_reader :summary
@@ -31,7 +31,7 @@ module AssemblyAI
 
       # @param status [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in
       #  the rare case that the model failed.
-      # @param results [Array<AssemblyAI::Transcripts::ContentSafetyLabelResult>]
+      # @param results [Array<AssemblyAI::Transcripts::ContentSafetyLabelResult>] An array of results for the Content Moderation model
       # @param summary [Hash{String => Float}] A summary of the Content Moderation confidence results for the entire audio file
       # @param severity_score_summary [Hash{String => AssemblyAI::Transcripts::SeverityScoreSummary}] A summary of the Content Moderation severity results for the entire audio file
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition

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

@@ -7,13 +7,13 @@ require "json"
 module AssemblyAI
   class Transcripts
     class ParagraphsResponse
-      # @return [String]
+      # @return [String] The unique identifier of your transcript
       attr_reader :id
-      # @return [Float]
+      # @return [Float] The confidence score for the transcript
       attr_reader :confidence
-      # @return [Float]
+      # @return [Float] The duration of the audio file in seconds
       attr_reader :audio_duration
-      # @return [Array<AssemblyAI::Transcripts::TranscriptParagraph>]
+      # @return [Array<AssemblyAI::Transcripts::TranscriptParagraph>] An array of paragraphs in the transcript
       attr_reader :paragraphs
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -23,10 +23,10 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param id [String]
-      # @param confidence [Float]
-      # @param audio_duration [Float]
-      # @param paragraphs [Array<AssemblyAI::Transcripts::TranscriptParagraph>]
+      # @param id [String] The unique identifier of your transcript
+      # @param confidence [Float] The confidence score for the transcript
+      # @param audio_duration [Float] The duration of the audio file in seconds
+      # @param paragraphs [Array<AssemblyAI::Transcripts::TranscriptParagraph>] An array of paragraphs in the transcript
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::ParagraphsResponse]
       def initialize(id:, confidence:, audio_duration:, paragraphs:, additional_properties: nil)

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

@@ -7,13 +7,13 @@ require "json"
 module AssemblyAI
   class Transcripts
     class SentencesResponse
-      # @return [String]
+      # @return [String] The unique identifier for the transcript
       attr_reader :id
-      # @return [Float]
+      # @return [Float] The confidence score for the transcript
       attr_reader :confidence
-      # @return [Float]
+      # @return [Float] The duration of the audio file in seconds
       attr_reader :audio_duration
-      # @return [Array<AssemblyAI::Transcripts::TranscriptSentence>]
+      # @return [Array<AssemblyAI::Transcripts::TranscriptSentence>] An array of sentences in the transcript
       attr_reader :sentences
       # @return [OpenStruct] Additional properties unmapped to the current class definition
       attr_reader :additional_properties
@@ -23,10 +23,10 @@ module AssemblyAI
 
       OMIT = Object.new
 
-      # @param id [String]
-      # @param confidence [Float]
-      # @param audio_duration [Float]
-      # @param sentences [Array<AssemblyAI::Transcripts::TranscriptSentence>]
+      # @param id [String] The unique identifier for the transcript
+      # @param confidence [Float] The confidence score for the transcript
+      # @param audio_duration [Float] The duration of the audio file in seconds
+      # @param sentences [Array<AssemblyAI::Transcripts::TranscriptSentence>] An array of sentences in the transcript
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::SentencesResponse]
       def initialize(id:, confidence:, audio_duration:, sentences:, additional_properties: nil)

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

@@ -18,6 +18,9 @@ module AssemblyAI
       attr_reader :sentiment
       # @return [Float] The confidence score for the detected sentiment of the sentence, from 0 to 1
       attr_reader :confidence
+      # @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 the sentence if [Speaker
       #  Diarization](https://www.assemblyai.com/docs/models/speaker-diarization) is
       #  enabled, else null
@@ -35,17 +38,21 @@ module AssemblyAI
       # @param end_ [Integer] The ending time, in milliseconds, of the sentence
       # @param sentiment [AssemblyAI::Transcripts::Sentiment] The detected sentiment for the sentence, one of POSITIVE, NEUTRAL, NEGATIVE
       # @param confidence [Float] The confidence score for the detected sentiment of the sentence, from 0 to 1
+      # @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 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::SentimentAnalysisResult]
-      def initialize(text:, start:, end_:, sentiment:, confidence:, speaker: OMIT, additional_properties: nil)
+      def initialize(text:, start:, end_:, sentiment:, confidence:, channel: OMIT, speaker: OMIT,
+                     additional_properties: nil)
         @text = text
         @start = start
         @end_ = end_
         @sentiment = sentiment
         @confidence = confidence
+        @channel = channel if channel != OMIT
         @speaker = speaker if speaker != OMIT
         @additional_properties = additional_properties
         @_field_set = {
@@ -54,6 +61,7 @@ module AssemblyAI
           "end": end_,
           "sentiment": sentiment,
           "confidence": confidence,
+          "channel": channel,
           "speaker": speaker
         }.reject do |_k, v|
           v == OMIT
@@ -71,6 +79,7 @@ module AssemblyAI
         end_ = struct["end"]
         sentiment = struct["sentiment"]
         confidence = struct["confidence"]
+        channel = struct["channel"]
         speaker = struct["speaker"]
         new(
           text: text,
@@ -78,6 +87,7 @@ module AssemblyAI
           end_: end_,
           sentiment: sentiment,
           confidence: confidence,
+          channel: channel,
           speaker: speaker,
           additional_properties: struct
         )
@@ -102,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.sentiment.is_a?(AssemblyAI::Transcripts::Sentiment) != false || raise("Passed value for field obj.sentiment 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.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/topic_detection_result.rb

@@ -11,7 +11,7 @@ module AssemblyAI
     class TopicDetectionResult
       # @return [String] The text in the transcript in which a detected topic occurs
       attr_reader :text
-      # @return [Array<AssemblyAI::Transcripts::TopicDetectionResultLabelsItem>]
+      # @return [Array<AssemblyAI::Transcripts::TopicDetectionResultLabelsItem>] An array of detected topics in the text
       attr_reader :labels
       # @return [AssemblyAI::Transcripts::Timestamp]
       attr_reader :timestamp
@@ -24,7 +24,7 @@ module AssemblyAI
       OMIT = Object.new
 
       # @param text [String] The text in the transcript in which a detected topic occurs
-      # @param labels [Array<AssemblyAI::Transcripts::TopicDetectionResultLabelsItem>]
+      # @param labels [Array<AssemblyAI::Transcripts::TopicDetectionResultLabelsItem>] An array of detected topics in the text
       # @param timestamp [AssemblyAI::Transcripts::Timestamp]
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [AssemblyAI::Transcripts::TopicDetectionResult]