assemblyai 1.0.0.pre.beta → 1.0.0.pre.beta.3

data/lib/assemblyai/realtime/types/terminate_session.rb

@@ -1,22 +1,18 @@
 # frozen_string_literal: true
 
-require_relative "message_type"
 require "json"
 
 module AssemblyAI
   class Realtime
     class TerminateSession
-      attr_reader :terminate_session, :message_type, :additional_properties
+      attr_reader :terminate_session, :additional_properties
 
       # @param terminate_session [Boolean] Set to true to end your real-time session forever
-      # @param message_type [MESSAGE_TYPE] Describes the type of the message
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Realtime::TerminateSession]
-      def initialize(terminate_session:, message_type:, additional_properties: nil)
+      def initialize(terminate_session:, additional_properties: nil)
         # @type [Boolean] Set to true to end your real-time session forever
         @terminate_session = terminate_session
-        # @type [MESSAGE_TYPE] Describes the type of the message
-        @message_type = message_type
         # @type [OpenStruct] Additional properties unmapped to the current class definition
         @additional_properties = additional_properties
       end
@@ -27,20 +23,16 @@ module AssemblyAI
       # @return [Realtime::TerminateSession]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
+        JSON.parse(json_object)
         terminate_session = struct.terminate_session
-        message_type = Realtime::MESSAGE_TYPE.key(parsed_json["message_type"]) || parsed_json["message_type"]
-        new(terminate_session: terminate_session, message_type: message_type, additional_properties: struct)
+        new(terminate_session: terminate_session, additional_properties: struct)
       end
 
       # Serialize an instance of TerminateSession to a JSON object
       #
       # @return [JSON]
       def to_json(*_args)
-        {
-          "terminate_session": @terminate_session,
-          "message_type": Realtime::MESSAGE_TYPE[@message_type] || @message_type
-        }.to_json
+        { "terminate_session": @terminate_session }.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.
@@ -49,7 +41,6 @@ module AssemblyAI
       # @return [Void]
       def self.validate_raw(obj:)
         obj.terminate_session.is_a?(Boolean) != false || raise("Passed value for field obj.terminate_session is not the expected type, validation failed.")
-        obj.message_type.is_a?(Realtime::MESSAGE_TYPE) != false || raise("Passed value for field obj.message_type is not the expected type, validation failed.")
       end
     end
   end

data/lib/assemblyai/transcripts/client.rb

@@ -34,7 +34,7 @@ module AssemblyAI
     # Retrieve a list of transcripts you created
     #
     # @param limit [Integer] Maximum amount of transcripts to retrieve
-    # @param status [TRANSCRIPT_STATUS] Filter by transcript status
+    # @param status [Transcripts::TranscriptStatus] Filter by transcript status
     # @param created_on [String] Only get transcripts created on this date
     # @param before_id [String] Get transcripts that were created before this transcript ID
     # @param after_id [String] Get transcripts that were created after this transcript ID
@@ -62,8 +62,8 @@ module AssemblyAI
 
     # Create a transcript from an audio or video file that is accessible via a URL.
     #
-    # @param speech_model [Transcripts::SPEECH_MODEL]
-    # @param language_code [TRANSCRIPT_LANGUAGE_CODE]
+    # @param speech_model [Transcripts::SpeechModel]
+    # @param language_code [Transcripts::TranscriptLanguageCode]
     # @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.
@@ -74,13 +74,13 @@ 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 [TRANSCRIPT_BOOST_PARAM] The word boost parameter value
+    # @param boost_param [Transcripts::TranscriptBoostParam] The word boost parameter value
     # @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 [REDACT_PII_AUDIO_QUALITY] 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::PII_POLICY>] 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 [SUBSTITUTION_POLICY]
+    # @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
@@ -97,8 +97,8 @@ module AssemblyAI
     # @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 [SUMMARY_MODEL] The model to summarize the transcript
-    # @param summary_type [SUMMARY_TYPE] The type of summary
+    # @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
@@ -187,7 +187,7 @@ module AssemblyAI
     # Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.
     #
     # @param transcript_id [String] ID of the transcript
-    # @param subtitle_format [SUBTITLE_FORMAT] The format of the captions
+    # @param subtitle_format [Transcripts::SubtitleFormat] The format of the captions
     # @param chars_per_caption [Integer] The maximum number of characters per caption
     # @param request_options [RequestOptions]
     # @return [String]
@@ -276,7 +276,7 @@ module AssemblyAI
     # Retrieve a list of transcripts you created
     #
     # @param limit [Integer] Maximum amount of transcripts to retrieve
-    # @param status [TRANSCRIPT_STATUS] Filter by transcript status
+    # @param status [Transcripts::TranscriptStatus] Filter by transcript status
     # @param created_on [String] Only get transcripts created on this date
     # @param before_id [String] Get transcripts that were created before this transcript ID
     # @param after_id [String] Get transcripts that were created after this transcript ID
@@ -306,8 +306,8 @@ module AssemblyAI
 
     # Create a transcript from an audio or video file that is accessible via a URL.
     #
-    # @param speech_model [Transcripts::SPEECH_MODEL]
-    # @param language_code [TRANSCRIPT_LANGUAGE_CODE]
+    # @param speech_model [Transcripts::SpeechModel]
+    # @param language_code [Transcripts::TranscriptLanguageCode]
     # @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.
@@ -318,13 +318,13 @@ 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 [TRANSCRIPT_BOOST_PARAM] The word boost parameter value
+    # @param boost_param [Transcripts::TranscriptBoostParam] The word boost parameter value
     # @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 [REDACT_PII_AUDIO_QUALITY] 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::PII_POLICY>] 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 [SUBSTITUTION_POLICY]
+    # @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
@@ -341,8 +341,8 @@ module AssemblyAI
     # @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 [SUMMARY_MODEL] The model to summarize the transcript
-    # @param summary_type [SUMMARY_TYPE] The type of summary
+    # @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
@@ -437,7 +437,7 @@ module AssemblyAI
     # Export your transcript in SRT or VTT format, to be plugged into a video player for subtitles and closed captions.
     #
     # @param transcript_id [String] ID of the transcript
-    # @param subtitle_format [SUBTITLE_FORMAT] The format of the captions
+    # @param subtitle_format [Transcripts::SubtitleFormat] The format of the captions
     # @param chars_per_caption [Integer] The maximum number of characters per caption
     # @param request_options [RequestOptions]
     # @return [String]

data/lib/assemblyai/transcripts/list_by_url_client.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/transcript_list"
+require "async"
+
+module AssemblyAI
+  # :nodoc:
+  class TranscriptsClient
+    # Retrieve a list of transcripts you created, this is used for pagination to easily retrieve the next page of transcripts
+    #
+    # @param url [String] The URL to retrieve the transcript list from
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::TranscriptList]
+    #
+    # @example Retrieve the next page of results
+    #   client = AssemblyAI::Client.new(api_key: "YOUR_API_KEY")
+    #   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|
+        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
+      end
+      Transcripts::TranscriptList.from_json(json_object: response.body)
+    end
+  end
+
+  # :nodoc:
+  class AsyncTranscriptsClient
+    # Retrieve a list of transcripts you created
+    #
+    # @param url [String] The URL to retrieve the transcript list from
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::TranscriptList]
+    #
+    # @example Retrieve the next page of results
+    #   client = AssemblyAI::AsyncClient.new(api_key: "YOUR_API_KEY")
+    #   Sync do
+    #     transcript_list = client.transcripts.list(limit: 1).wait
+    #     client.transcripts.list_by_url(url: transcript_list.page_details.next_url)
+    #   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|
+          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
+        end
+        Transcripts::TranscriptList.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/assemblyai/transcripts/polling_client.rb

@@ -26,7 +26,8 @@ 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 language_code [TRANSCRIPT_LANGUAGE_CODE]
+    # @param speech_model [Transcripts::SpeechModel]
+    # @param language_code [Transcripts::TranscriptLanguageCode]
     # @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.
@@ -37,13 +38,13 @@ 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 [TRANSCRIPT_BOOST_PARAM] The word boost parameter value
+    # @param boost_param [Transcripts::TranscriptBoostParam] The word boost parameter value
     # @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 [REDACT_PII_AUDIO_QUALITY] 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::PII_POLICY>] 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 [SUBSTITUTION_POLICY]
+    # @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
@@ -60,8 +61,8 @@ module AssemblyAI
     # @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 [SUMMARY_MODEL] The model to summarize the transcript
-    # @param summary_type [SUMMARY_TYPE] The type of summary
+    # @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
@@ -69,10 +70,10 @@ module AssemblyAI
     # @param request_options [RequestOptions]
     # @param polling_options [Transcripts::PollingOptions] Configuration options for polling requests.
     # @return [Transcripts::Transcript]
-    def transcribe(audio_url:, 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)
-      transcript = submit(audio_url: audio_url, 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)
+    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)
+      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)
     end
 
@@ -81,7 +82,7 @@ module AssemblyAI
       timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
       loop do
         transcript = get(transcript_id: transcript_id)
-        if transcript.status == :completed || transcript.status == :error
+        if transcript.status == Transcripts::TranscriptStatus::COMPLETED || transcript.status == Transcripts::TranscriptStatus::ERROR
           return transcript
         elsif polling_options.timeout.positive? && Time.now - start_time > timeout_in_seconds
           raise StandardError, "Polling timeout"
@@ -99,7 +100,8 @@ 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 language_code [TRANSCRIPT_LANGUAGE_CODE]
+    # @param speech_model [Transcripts::SpeechModel]
+    # @param language_code [Transcripts::TranscriptLanguageCode]
     # @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.
@@ -110,13 +112,13 @@ 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 [TRANSCRIPT_BOOST_PARAM] The word boost parameter value
+    # @param boost_param [Transcripts::TranscriptBoostParam] The word boost parameter value
     # @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 [REDACT_PII_AUDIO_QUALITY] 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::PII_POLICY>] 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 [SUBSTITUTION_POLICY]
+    # @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
@@ -133,20 +135,20 @@ module AssemblyAI
     # @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 [SUMMARY_MODEL] The model to summarize the transcript
-    # @param summary_type [SUMMARY_TYPE] The type of summary
+    # @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
     # @param audio_url [String] The URL of the audio or video file to transcribe.
     # @param request_options [RequestOptions]
-    # @param polling_options [PollingOptions] Configuration options for polling requests.
+    # @param polling_options [Transcripts::PollingOptions] Configuration options for polling requests.
     # @return [Transcripts::Transcript]
-    def transcribe(audio_url:, 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:, 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)
       Async do
-        transcript = submit(audio_url: audio_url, 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
+        transcript = submit(audio_url: audio_url, speech_model: speech_model, language_code: language_code, punctuate: punctuate, format_text: format_text, dual_channel: dual_channel,
+                            webhook_url: webhook_url, webhook_auth_header_name: webhook_auth_header_name, webhook_auth_header_value: webhook_auth_header_value, auto_highlights: auto_highlights, audio_start_from: audio_start_from, audio_end_at: audio_end_at, word_boost: word_boost, boost_param: boost_param, filter_profanity: filter_profanity, redact_pii: redact_pii, redact_pii_audio: redact_pii_audio, redact_pii_audio_quality: redact_pii_audio_quality, redact_pii_policies: redact_pii_policies, redact_pii_sub: redact_pii_sub, speaker_labels: speaker_labels, speakers_expected: speakers_expected, content_safety: content_safety, content_safety_confidence: content_safety_confidence, iab_categories: iab_categories, language_detection: language_detection, custom_spelling: custom_spelling, disfluencies: disfluencies, sentiment_analysis: sentiment_analysis, auto_chapters: auto_chapters, entity_detection: entity_detection, speech_threshold: speech_threshold, summarization: summarization, summary_model: summary_model, summary_type: summary_type, custom_topics: custom_topics, topics: topics, additional_properties: additional_properties, request_options: request_options).wait
         poll_transcript(transcript_id: transcript.id, polling_options: polling_options).wait
       end
     end
@@ -157,7 +159,7 @@ module AssemblyAI
         timeout_in_seconds = polling_options.timeout / 1000 if polling_options.timeout.positive?
         loop do
           transcript = get(transcript_id: transcript_id).wait
-          if transcript.status == :completed || transcript.status == :error
+          if transcript.status == Transcripts::TranscriptStatus::COMPLETED || transcript.status == Transcripts::TranscriptStatus::ERROR
             break transcript
           elsif polling_options.timeout.positive? && Time.now - start_time > timeout_in_seconds
             raise StandardError, "Polling timeout"

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

@@ -2,7 +2,10 @@
 
 module AssemblyAI
   class Transcripts
-    # @type [AUDIO_INTELLIGENCE_MODEL_STATUS]
-    AUDIO_INTELLIGENCE_MODEL_STATUS = { success: "success", unavailable: "unavailable" }.freeze
+    # Either success, or unavailable in the rare case that the model failed
+    class AudioIntelligenceModelStatus
+      SUCCESS = "success"
+      UNAVAILABLE = "unavailable"
+    end
   end
 end

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

@@ -11,14 +11,14 @@ module AssemblyAI
     class ContentSafetyLabelsResult
       attr_reader :status, :results, :summary, :severity_score_summary, :additional_properties
 
-      # @param status [AUDIO_INTELLIGENCE_MODEL_STATUS] The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
+      # @param status [Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
       # @param results [Array<Transcripts::ContentSafetyLabelResult>]
       # @param summary [Hash{String => String}] A summary of the Content Moderation confidence results for the entire audio file
       # @param severity_score_summary [Hash{String => String}] 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
       # @return [Transcripts::ContentSafetyLabelsResult]
       def initialize(status:, results:, summary:, severity_score_summary:, additional_properties: nil)
-        # @type [AUDIO_INTELLIGENCE_MODEL_STATUS] The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
+        # @type [Transcripts::AudioIntelligenceModelStatus] The status of the Content Moderation model. Either success, or unavailable in the rare case that the model failed.
         @status = status
         # @type [Array<Transcripts::ContentSafetyLabelResult>]
         @results = results
@@ -37,7 +37,7 @@ module AssemblyAI
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
         parsed_json = JSON.parse(json_object)
-        status = Transcripts::AUDIO_INTELLIGENCE_MODEL_STATUS.key(parsed_json["status"]) || parsed_json["status"]
+        status = struct.status
         results = parsed_json["results"]&.map do |v|
           v = v.to_json
           Transcripts::ContentSafetyLabelResult.from_json(json_object: v)
@@ -53,7 +53,7 @@ module AssemblyAI
       # @return [JSON]
       def to_json(*_args)
         {
-          "status": Transcripts::AUDIO_INTELLIGENCE_MODEL_STATUS[@status] || @status,
+          "status": @status,
           "results": @results,
           "summary": @summary,
           "severity_score_summary": @severity_score_summary
@@ -65,7 +65,7 @@ module AssemblyAI
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.status.is_a?(Transcripts::AUDIO_INTELLIGENCE_MODEL_STATUS) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+        obj.status.is_a?(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.")
         obj.summary.is_a?(Hash) != false || raise("Passed value for field obj.summary is not the expected type, validation failed.")
         obj.severity_score_summary.is_a?(Hash) != false || raise("Passed value for field obj.severity_score_summary is not the expected type, validation failed.")

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

@@ -9,14 +9,14 @@ module AssemblyAI
     class Entity
       attr_reader :entity_type, :text, :start, :end_, :additional_properties
 
-      # @param entity_type [ENTITY_TYPE] The type of entity for the detected entity
+      # @param entity_type [Transcripts::EntityType] The type of entity for the detected entity
       # @param text [String] The text for the detected entity
       # @param start [Integer] The starting time, in milliseconds, at which the detected entity appears in the audio file
       # @param end_ [Integer] The ending time, in milliseconds, for the detected entity in the audio file
       # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
       # @return [Transcripts::Entity]
       def initialize(entity_type:, text:, start:, end_:, additional_properties: nil)
-        # @type [ENTITY_TYPE] The type of entity for the detected entity
+        # @type [Transcripts::EntityType] The type of entity for the detected entity
         @entity_type = entity_type
         # @type [String] The text for the detected entity
         @text = text
@@ -34,8 +34,8 @@ module AssemblyAI
       # @return [Transcripts::Entity]
       def self.from_json(json_object:)
         struct = JSON.parse(json_object, object_class: OpenStruct)
-        parsed_json = JSON.parse(json_object)
-        entity_type = Transcripts::ENTITY_TYPE.key(parsed_json["entity_type"]) || parsed_json["entity_type"]
+        JSON.parse(json_object)
+        entity_type = struct.entity_type
         text = struct.text
         start = struct.start
         end_ = struct.end
@@ -46,12 +46,7 @@ module AssemblyAI
       #
       # @return [JSON]
       def to_json(*_args)
-        {
-          "entity_type": Transcripts::ENTITY_TYPE[@entity_type] || @entity_type,
-          "text": @text,
-          "start": @start,
-          "end": @end_
-        }.to_json
+        { "entity_type": @entity_type, "text": @text, "start": @start, "end": @end_ }.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.
@@ -59,7 +54,7 @@ module AssemblyAI
       # @param obj [Object]
       # @return [Void]
       def self.validate_raw(obj:)
-        obj.entity_type.is_a?(Transcripts::ENTITY_TYPE) != false || raise("Passed value for field obj.entity_type is not the expected type, validation failed.")
+        obj.entity_type.is_a?(Transcripts::EntityType) != false || raise("Passed value for field obj.entity_type 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.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.")

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

@@ -2,37 +2,37 @@
 
 module AssemblyAI
   class Transcripts
-    # @type [ENTITY_TYPE]
-    ENTITY_TYPE = {
-      banking_information: "banking_information",
-      blood_type: "blood_type",
-      credit_card_cvv: "credit_card_cvv",
-      credit_card_expiration: "credit_card_expiration",
-      credit_card_number: "credit_card_number",
-      date: "date",
-      date_of_birth: "date_of_birth",
-      drivers_license: "drivers_license",
-      drug: "drug",
-      email_address: "email_address",
-      event: "event",
-      injury: "injury",
-      language: "language",
-      location: "location",
-      medical_condition: "medical_condition",
-      medical_process: "medical_process",
-      money_amount: "money_amount",
-      nationality: "nationality",
-      occupation: "occupation",
-      organization: "organization",
-      password: "password",
-      person_age: "person_age",
-      person_name: "person_name",
-      phone_number: "phone_number",
-      political_affiliation: "political_affiliation",
-      religion: "religion",
-      time: "time",
-      url: "url",
-      us_social_security_number: "us_social_security_number"
-    }.freeze
+    # The type of entity for the detected entity
+    class EntityType
+      BANKING_INFORMATION = "banking_information"
+      BLOOD_TYPE = "blood_type"
+      CREDIT_CARD_CVV = "credit_card_cvv"
+      CREDIT_CARD_EXPIRATION = "credit_card_expiration"
+      CREDIT_CARD_NUMBER = "credit_card_number"
+      DATE = "date"
+      DATE_OF_BIRTH = "date_of_birth"
+      DRIVERS_LICENSE = "drivers_license"
+      DRUG = "drug"
+      EMAIL_ADDRESS = "email_address"
+      EVENT = "event"
+      INJURY = "injury"
+      LANGUAGE = "language"
+      LOCATION = "location"
+      MEDICAL_CONDITION = "medical_condition"
+      MEDICAL_PROCESS = "medical_process"
+      MONEY_AMOUNT = "money_amount"
+      NATIONALITY = "nationality"
+      OCCUPATION = "occupation"
+      ORGANIZATION = "organization"
+      PASSWORD = "password"
+      PERSON_AGE = "person_age"
+      PERSON_NAME = "person_name"
+      PHONE_NUMBER = "phone_number"
+      POLITICAL_AFFILIATION = "political_affiliation"
+      RELIGION = "religion"
+      TIME = "time"
+      URL = "url"
+      US_SOCIAL_SECURITY_NUMBER = "us_social_security_number"
+    end
   end
 end

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

@@ -2,35 +2,34 @@
 
 module AssemblyAI
   class Transcripts
-    # @type [PII_POLICY]
-    PII_POLICY = {
-      medical_process: "medical_process",
-      medical_condition: "medical_condition",
-      blood_type: "blood_type",
-      drug: "drug",
-      injury: "injury",
-      number_sequence: "number_sequence",
-      email_address: "email_address",
-      date_of_birth: "date_of_birth",
-      phone_number: "phone_number",
-      us_social_security_number: "us_social_security_number",
-      credit_card_number: "credit_card_number",
-      credit_card_expiration: "credit_card_expiration",
-      credit_card_cvv: "credit_card_cvv",
-      date: "date",
-      nationality: "nationality",
-      event: "event",
-      language: "language",
-      location: "location",
-      money_amount: "money_amount",
-      person_name: "person_name",
-      person_age: "person_age",
-      organization: "organization",
-      political_affiliation: "political_affiliation",
-      occupation: "occupation",
-      religion: "religion",
-      drivers_license: "drivers_license",
-      banking_information: "banking_information"
-    }.freeze
+    class PiiPolicy
+      MEDICAL_PROCESS = "medical_process"
+      MEDICAL_CONDITION = "medical_condition"
+      BLOOD_TYPE = "blood_type"
+      DRUG = "drug"
+      INJURY = "injury"
+      NUMBER_SEQUENCE = "number_sequence"
+      EMAIL_ADDRESS = "email_address"
+      DATE_OF_BIRTH = "date_of_birth"
+      PHONE_NUMBER = "phone_number"
+      US_SOCIAL_SECURITY_NUMBER = "us_social_security_number"
+      CREDIT_CARD_NUMBER = "credit_card_number"
+      CREDIT_CARD_EXPIRATION = "credit_card_expiration"
+      CREDIT_CARD_CVV = "credit_card_cvv"
+      DATE = "date"
+      NATIONALITY = "nationality"
+      EVENT = "event"
+      LANGUAGE = "language"
+      LOCATION = "location"
+      MONEY_AMOUNT = "money_amount"
+      PERSON_NAME = "person_name"
+      PERSON_AGE = "person_age"
+      ORGANIZATION = "organization"
+      POLITICAL_AFFILIATION = "political_affiliation"
+      OCCUPATION = "occupation"
+      RELIGION = "religion"
+      DRIVERS_LICENSE = "drivers_license"
+      BANKING_INFORMATION = "banking_information"
+    end
   end
 end