assemblyai 1.0.0.pre.beta.6 → 1.0.0.pre.beta.8

data/lib/assemblyai/transcripts/client.rb

@@ -31,7 +31,8 @@ module AssemblyAI
       @request_client = request_client
     end
 
-    # Retrieve a list of transcripts you created
+    # Retrieve a list of transcripts you created.
+    # Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
     #
     # @param limit [Integer] Maximum amount of transcripts to retrieve
     # @param status [Transcripts::TranscriptStatus] Filter by transcript status
@@ -43,7 +44,7 @@ module AssemblyAI
     # @return [Transcripts::TranscriptList]
     def list(limit: nil, status: nil, created_on: nil, before_id: nil, after_id: nil, throttled_only: nil,
              request_options: nil)
-      response = @request_client.conn.get("/v2/transcript") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
@@ -56,6 +57,7 @@ module AssemblyAI
           "after_id": after_id,
           "throttled_only": throttled_only
         }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript"
       end
       Transcripts::TranscriptList.from_json(json_object: response.body)
     end
@@ -107,7 +109,8 @@ module AssemblyAI
     # @return [Transcripts::Transcript]
     def submit(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)
-      response = @request_client.conn.post("/v2/transcript") do |req|
+      deprecate_conformer2(speech_model: speech_model)
+      response = @request_client.conn.post do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
@@ -152,6 +155,7 @@ module AssemblyAI
           additional_properties: additional_properties,
           audio_url: audio_url
         }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript"
       end
       Transcripts::Transcript.from_json(json_object: response.body)
     end
@@ -162,10 +166,11 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [Transcripts::Transcript]
     def get(transcript_id:, request_options: nil)
-      response = @request_client.conn.get("/v2/transcript/#{transcript_id}") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}"
       end
       Transcripts::Transcript.from_json(json_object: response.body)
     end
@@ -176,10 +181,11 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [Transcripts::Transcript]
     def delete(transcript_id:, request_options: nil)
-      response = @request_client.conn.delete("/v2/transcript/#{transcript_id}") do |req|
+      response = @request_client.conn.delete do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}"
       end
       Transcripts::Transcript.from_json(json_object: response.body)
     end
@@ -192,7 +198,7 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [String]
     def get_subtitles(transcript_id:, subtitle_format:, chars_per_caption: nil, request_options: nil)
-      response = @request_client.conn.get("/v2/transcript/#{transcript_id}/#{subtitle_format}") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
@@ -200,6 +206,7 @@ module AssemblyAI
           **(request_options&.additional_query_parameters || {}),
           "chars_per_caption": chars_per_caption
         }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/#{subtitle_format}"
       end
       response.body
     end
@@ -210,10 +217,11 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [Transcripts::SentencesResponse]
     def get_sentences(transcript_id:, request_options: nil)
-      response = @request_client.conn.get("/v2/transcript/#{transcript_id}/sentences") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/sentences"
       end
       Transcripts::SentencesResponse.from_json(json_object: response.body)
     end
@@ -224,10 +232,11 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [Transcripts::ParagraphsResponse]
     def get_paragraphs(transcript_id:, request_options: nil)
-      response = @request_client.conn.get("/v2/transcript/#{transcript_id}/paragraphs") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/paragraphs"
       end
       Transcripts::ParagraphsResponse.from_json(json_object: response.body)
     end
@@ -239,11 +248,12 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [Transcripts::WordSearchResponse]
     def word_search(transcript_id:, words: nil, request_options: nil)
-      response = @request_client.conn.get("/v2/transcript/#{transcript_id}/word-search") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
         req.params = { **(request_options&.additional_query_parameters || {}), "words": words }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/word-search"
       end
       Transcripts::WordSearchResponse.from_json(json_object: response.body)
     end
@@ -254,13 +264,20 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @return [Transcripts::RedactedAudioResponse]
     def get_redacted_audio(transcript_id:, request_options: nil)
-      response = @request_client.conn.get("/v2/transcript/#{transcript_id}/redacted-audio") do |req|
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/redacted-audio"
       end
       Transcripts::RedactedAudioResponse.from_json(json_object: response.body)
     end
+
+    # @param speech_model [Transcripts::SpeechModel]
+    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 :deprecate_conformer2
   end
 
   class AsyncTranscriptsClient
@@ -273,7 +290,8 @@ module AssemblyAI
       @request_client = request_client
     end
 
-    # Retrieve a list of transcripts you created
+    # Retrieve a list of transcripts you created.
+    # Transcripts are sorted from newest to oldest. The previous URL always points to a page with older transcripts.
     #
     # @param limit [Integer] Maximum amount of transcripts to retrieve
     # @param status [Transcripts::TranscriptStatus] Filter by transcript status
@@ -286,7 +304,7 @@ module AssemblyAI
     def list(limit: nil, status: nil, created_on: nil, before_id: nil, after_id: nil, throttled_only: nil,
              request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
@@ -299,6 +317,7 @@ module AssemblyAI
             "after_id": after_id,
             "throttled_only": throttled_only
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript"
         end
         Transcripts::TranscriptList.from_json(json_object: response.body)
       end
@@ -351,8 +370,9 @@ module AssemblyAI
     # @return [Transcripts::Transcript]
     def submit(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)
+      deprecate_conformer2(speech_model: speech_model)
       Async do
-        response = @request_client.conn.post("/v2/transcript") do |req|
+        response = @request_client.conn.post do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
@@ -397,6 +417,7 @@ module AssemblyAI
             additional_properties: additional_properties,
             audio_url: audio_url
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript"
         end
         Transcripts::Transcript.from_json(json_object: response.body)
       end
@@ -409,10 +430,11 @@ module AssemblyAI
     # @return [Transcripts::Transcript]
     def get(transcript_id:, request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript/#{transcript_id}") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}"
         end
         Transcripts::Transcript.from_json(json_object: response.body)
       end
@@ -425,10 +447,11 @@ module AssemblyAI
     # @return [Transcripts::Transcript]
     def delete(transcript_id:, request_options: nil)
       Async do
-        response = @request_client.conn.delete("/v2/transcript/#{transcript_id}") do |req|
+        response = @request_client.conn.delete do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}"
         end
         Transcripts::Transcript.from_json(json_object: response.body)
       end
@@ -443,7 +466,7 @@ module AssemblyAI
     # @return [String]
     def get_subtitles(transcript_id:, subtitle_format:, chars_per_caption: nil, request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript/#{transcript_id}/#{subtitle_format}") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
@@ -451,6 +474,7 @@ module AssemblyAI
             **(request_options&.additional_query_parameters || {}),
             "chars_per_caption": chars_per_caption
           }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/#{subtitle_format}"
         end
         response.body
       end
@@ -463,10 +487,11 @@ module AssemblyAI
     # @return [Transcripts::SentencesResponse]
     def get_sentences(transcript_id:, request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript/#{transcript_id}/sentences") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/sentences"
         end
         Transcripts::SentencesResponse.from_json(json_object: response.body)
       end
@@ -479,10 +504,11 @@ module AssemblyAI
     # @return [Transcripts::ParagraphsResponse]
     def get_paragraphs(transcript_id:, request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript/#{transcript_id}/paragraphs") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/paragraphs"
         end
         Transcripts::ParagraphsResponse.from_json(json_object: response.body)
       end
@@ -496,11 +522,12 @@ module AssemblyAI
     # @return [Transcripts::WordSearchResponse]
     def word_search(transcript_id:, words: nil, request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript/#{transcript_id}/word-search") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
           req.params = { **(request_options&.additional_query_parameters || {}), "words": words }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/word-search"
         end
         Transcripts::WordSearchResponse.from_json(json_object: response.body)
       end
@@ -513,13 +540,20 @@ module AssemblyAI
     # @return [Transcripts::RedactedAudioResponse]
     def get_redacted_audio(transcript_id:, request_options: nil)
       Async do
-        response = @request_client.conn.get("/v2/transcript/#{transcript_id}/redacted-audio") do |req|
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url "#{@request_client.get_url(request_options: request_options)}/v2/transcript/#{transcript_id}/redacted-audio"
         end
         Transcripts::RedactedAudioResponse.from_json(json_object: response.body)
       end
     end
+
+    # @param speech_model [Transcripts::SpeechModel]
+    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 :deprecate_conformer2
   end
 end

data/lib/assemblyai/transcripts/list_by_url_client.rb

@@ -18,11 +18,12 @@ module AssemblyAI
     #   transcript_list = client.transcripts.list(limit: 1)
     #   client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
     def list_by_url(url: nil, request_options: nil)
-      url = "/v2/transcript" if url.nil?
-      response = @request_client.conn.get(url) do |req|
+      url = "#{@request_client.get_url(request_options: request_options)}/v2/transcript" if url.nil?
+      response = @request_client.conn.get do |req|
         req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
         req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
         req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.url url
       end
       Transcripts::TranscriptList.from_json(json_object: response.body)
     end
@@ -44,11 +45,12 @@ module AssemblyAI
     #   end
     def list_by_url(url: nil, request_options: nil)
       Async do
-        url = "/v2/transcript" if url.nil?
-        response = @request_client.conn.get(url) do |req|
+        url = "#{@request_client.get_url(request_options: request_options)}/v2/transcript" if url.nil?
+        response = @request_client.conn.get do |req|
           req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
           req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
           req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.url url
         end
         Transcripts::TranscriptList.from_json(json_object: response.body)
       end

data/lib/assemblyai/transcripts/polling_client.rb

@@ -72,6 +72,7 @@ module AssemblyAI
     # @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)
+      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)
@@ -92,7 +93,11 @@ module AssemblyAI
       end
     end
 
-    private :poll_transcript
+    # @param speech_model [Transcripts::SpeechModel]
+    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
   end
 
   # :nodoc:
@@ -146,6 +151,7 @@ module AssemblyAI
     # @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)
+      deprecate_conformer2(speech_model: speech_model)
       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
@@ -170,6 +176,10 @@ module AssemblyAI
       end
     end
 
-    private :poll_transcript
+    # @param speech_model [Transcripts::SpeechModel]
+    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
   end
 end

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

@@ -1,57 +1,78 @@
 # frozen_string_literal: true
 
 require_relative "timestamp"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     class AutoHighlightResult
-      attr_reader :count, :rank, :text, :timestamps, :additional_properties
+      # @return [Integer] The total number of times the key phrase appears in the audio file
+      attr_reader :count
+      # @return [Float] The total relevancy to the overall audio file of this key phrase - a greater
+      #  number means more relevant
+      attr_reader :rank
+      # @return [String] The text itself of the key phrase
+      attr_reader :text
+      # @return [Array<AssemblyAI::Transcripts::Timestamp>] The timestamp of the of the key phrase
+      attr_reader :timestamps
+      # @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 count [Integer] The total number of times the key phrase appears in the audio file
-      # @param rank [Float] The total relevancy to the overall audio file of this key phrase - a greater number means more relevant
+      # @param rank [Float] The total relevancy to the overall audio file of this key phrase - a greater
+      #  number means more relevant
       # @param text [String] The text itself of the key phrase
-      # @param timestamps [Array<Transcripts::Timestamp>] The timestamp of the of the key phrase
+      # @param timestamps [Array<AssemblyAI::Transcripts::Timestamp>] The timestamp of the of the key phrase
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::AutoHighlightResult]
+      # @return [AssemblyAI::Transcripts::AutoHighlightResult]
       def initialize(count:, rank:, text:, timestamps:, additional_properties: nil)
-        # @type [Integer] The total number of times the key phrase appears in the audio file
         @count = count
-        # @type [Float] The total relevancy to the overall audio file of this key phrase - a greater number means more relevant
         @rank = rank
-        # @type [String] The text itself of the key phrase
         @text = text
-        # @type [Array<Transcripts::Timestamp>] The timestamp of the of the key phrase
         @timestamps = timestamps
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "count": count, "rank": rank, "text": text, "timestamps": timestamps }
       end
 
       # Deserialize a JSON object to an instance of AutoHighlightResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::AutoHighlightResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::AutoHighlightResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        count = struct.count
-        rank = struct.rank
-        text = struct.text
+        count = struct["count"]
+        rank = struct["rank"]
+        text = struct["text"]
         timestamps = parsed_json["timestamps"]&.map do |v|
           v = v.to_json
-          Transcripts::Timestamp.from_json(json_object: v)
+          AssemblyAI::Transcripts::Timestamp.from_json(json_object: v)
         end
-        new(count: count, rank: rank, text: text, timestamps: timestamps, additional_properties: struct)
+        new(
+          count: count,
+          rank: rank,
+          text: text,
+          timestamps: timestamps,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of AutoHighlightResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "count": @count, "rank": @rank, "text": @text, "timestamps": @timestamps }.to_json
+        @_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.
+      # 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]

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

@@ -1,51 +1,75 @@
 # frozen_string_literal: true
 
+require_relative "audio_intelligence_model_status"
 require_relative "auto_highlight_result"
+require "ostruct"
 require "json"
 
 module AssemblyAI
   class Transcripts
     # An array of results for the Key Phrases model, if it is enabled.
-    # See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more information.
+    #  See [Key phrases](https://www.assemblyai.com/docs/models/key-phrases) for more
+    #  information.
     class AutoHighlightsResult
-      attr_reader :results, :additional_properties
+      # @return [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Key Phrases model. Either success, or unavailable in the rare
+      #  case that the model failed.
+      attr_reader :status
+      # @return [Array<AssemblyAI::Transcripts::AutoHighlightResult>] A temporally-sequential array of Key Phrases
+      attr_reader :results
+      # @return [OpenStruct] Additional properties unmapped to the current class definition
+      attr_reader :additional_properties
+      # @return [Object]
+      attr_reader :_field_set
+      protected :_field_set
 
-      # @param results [Array<Transcripts::AutoHighlightResult>] A temporally-sequential array of Key Phrases
+      OMIT = Object.new
+
+      # @param status [AssemblyAI::Transcripts::AudioIntelligenceModelStatus] The status of the Key Phrases model. Either success, or unavailable in the rare
+      #  case that the model failed.
+      # @param results [Array<AssemblyAI::Transcripts::AutoHighlightResult>] A temporally-sequential array of Key Phrases
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-      # @return [Transcripts::AutoHighlightsResult]
-      def initialize(results:, additional_properties: nil)
-        # @type [Array<Transcripts::AutoHighlightResult>] A temporally-sequential array of Key Phrases
+      # @return [AssemblyAI::Transcripts::AutoHighlightsResult]
+      def initialize(status:, results:, additional_properties: nil)
+        @status = status
         @results = results
-        # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
+        @_field_set = { "status": status, "results": results }
       end
 
       # Deserialize a JSON object to an instance of AutoHighlightsResult
       #
-      # @param json_object [JSON]
-      # @return [Transcripts::AutoHighlightsResult]
+      # @param json_object [String]
+      # @return [AssemblyAI::Transcripts::AutoHighlightsResult]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
+        status = struct["status"]
         results = parsed_json["results"]&.map do |v|
           v = v.to_json
-          Transcripts::AutoHighlightResult.from_json(json_object: v)
+          AssemblyAI::Transcripts::AutoHighlightResult.from_json(json_object: v)
         end
-        new(results: results, additional_properties: struct)
+        new(
+          status: status,
+          results: results,
+          additional_properties: struct
+        )
       end
 
       # Serialize an instance of AutoHighlightsResult to a JSON object
       #
-      # @return [JSON]
+      # @return [String]
       def to_json(*_args)
-        { "results": @results }.to_json
+        @_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.
+      # 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.status.is_a?(AssemblyAI::Transcripts::AudioIntelligenceModelStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
         obj.results.is_a?(Array) != false || raise("Passed value for field obj.results is not the expected type, validation failed.")
       end
     end