assemblyai 1.0.0.pre.beta

data/lib/assemblyai/transcripts/client.rb

@@ -0,0 +1,525 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/transcript_status"
+require_relative "types/transcript_list"
+require_relative "types/speech_model"
+require_relative "types/transcript_language_code"
+require_relative "types/transcript_boost_param"
+require_relative "types/redact_pii_audio_quality"
+require_relative "types/pii_policy"
+require_relative "types/substitution_policy"
+require_relative "types/transcript_custom_spelling"
+require_relative "types/summary_model"
+require_relative "types/summary_type"
+require_relative "types/transcript"
+require_relative "types/subtitle_format"
+require_relative "types/sentences_response"
+require_relative "types/paragraphs_response"
+require_relative "types/word_search_response"
+require_relative "types/redacted_audio_response"
+require "async"
+
+module AssemblyAI
+  class TranscriptsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [TranscriptsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # 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 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
+    # @param throttled_only [Boolean] Only get throttled transcripts, overrides the status filter
+    # @param request_options [RequestOptions]
+    # @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|
+        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 || {}),
+          "limit": limit,
+          "status": status,
+          "created_on": created_on,
+          "before_id": before_id,
+          "after_id": after_id,
+          "throttled_only": throttled_only
+        }.compact
+      end
+      Transcripts::TranscriptList.from_json(json_object: response.body)
+    end
+
+    # 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 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 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 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 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
+    #   * :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 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 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]
+    # @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|
+        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.body = {
+          **(request_options&.additional_body_parameters || {}),
+          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,
+          audio_url: audio_url
+        }.compact
+      end
+      Transcripts::Transcript.from_json(json_object: response.body)
+    end
+
+    # Get the transcript resource. The transcript is ready when the "status" is "completed".
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @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|
+        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::Transcript.from_json(json_object: response.body)
+    end
+
+    # Delete the transcript
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @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|
+        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::Transcript.from_json(json_object: response.body)
+    end
+
+    # 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 chars_per_caption [Integer] The maximum number of characters per caption
+    # @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|
+        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 || {}),
+          "chars_per_caption": chars_per_caption
+        }.compact
+      end
+      response.body
+    end
+
+    # Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @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|
+        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::SentencesResponse.from_json(json_object: response.body)
+    end
+
+    # Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @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|
+        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::ParagraphsResponse.from_json(json_object: response.body)
+    end
+
+    # Search through the transcript for a specific set of keywords. You can search for individual words, numbers, or phrases containing up to five words or numbers.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param words [String] Keywords to search for
+    # @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|
+        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
+      end
+      Transcripts::WordSearchResponse.from_json(json_object: response.body)
+    end
+
+    # Retrieve the redacted audio object containing the status and URL to the redacted audio.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @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|
+        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::RedactedAudioResponse.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncTranscriptsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncTranscriptsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # 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 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
+    # @param throttled_only [Boolean] Only get throttled transcripts, overrides the status filter
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::TranscriptList]
+    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|
+          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 || {}),
+            "limit": limit,
+            "status": status,
+            "created_on": created_on,
+            "before_id": before_id,
+            "after_id": after_id,
+            "throttled_only": throttled_only
+          }.compact
+        end
+        Transcripts::TranscriptList.from_json(json_object: response.body)
+      end
+    end
+
+    # 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 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 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 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 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
+    #   * :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 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 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]
+    # @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)
+      Async do
+        response = @request_client.conn.post("/v2/transcript") 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.body = {
+            **(request_options&.additional_body_parameters || {}),
+            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,
+            audio_url: audio_url
+          }.compact
+        end
+        Transcripts::Transcript.from_json(json_object: response.body)
+      end
+    end
+
+    # Get the transcript resource. The transcript is ready when the "status" is "completed".
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::Transcript]
+    def get(transcript_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/v2/transcript/#{transcript_id}") 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::Transcript.from_json(json_object: response.body)
+      end
+    end
+
+    # Delete the transcript
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param request_options [RequestOptions]
+    # @return [Transcripts::Transcript]
+    def delete(transcript_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.delete("/v2/transcript/#{transcript_id}") 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::Transcript.from_json(json_object: response.body)
+      end
+    end
+
+    # 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 chars_per_caption [Integer] The maximum number of characters per caption
+    # @param request_options [RequestOptions]
+    # @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|
+          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 || {}),
+            "chars_per_caption": chars_per_caption
+          }.compact
+        end
+        response.body
+      end
+    end
+
+    # Get the transcript split by sentences. The API will attempt to semantically segment the transcript into sentences to create more reader-friendly transcripts.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param request_options [RequestOptions]
+    # @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|
+          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::SentencesResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Get the transcript split by paragraphs. The API will attempt to semantically segment your transcript into paragraphs to create more reader-friendly transcripts.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param request_options [RequestOptions]
+    # @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|
+          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::ParagraphsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Search through the transcript for a specific set of keywords. You can search for individual words, numbers, or phrases containing up to five words or numbers.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param words [String] Keywords to search for
+    # @param request_options [RequestOptions]
+    # @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|
+          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
+        end
+        Transcripts::WordSearchResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Retrieve the redacted audio object containing the status and URL to the redacted audio.
+    #
+    # @param transcript_id [String] ID of the transcript
+    # @param request_options [RequestOptions]
+    # @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|
+          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::RedactedAudioResponse.from_json(json_object: response.body)
+      end
+    end
+  end
+end