Class: Telnyx::Resources::SpeechToText

Inherits:

Object

• Object
• Telnyx::Resources::SpeechToText

Defined in:

lib/telnyx/resources/speech_to_text.rb

Instance Method Summary

• #initialize(client:) ⇒ SpeechToText constructor private

  A new instance of SpeechToText.

• #transcribe(input_format:, transcription_engine:, interim_results: nil, language: nil, model: nil, request_options: {}) ⇒ nil

  Transcribe audio streams to text over WebSocket.

Constructor Details

#initialize(client:) ⇒ SpeechToText

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of SpeechToText.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/speech_to_text.rb', line 39

def initialize(client:)
  @client = client
end

Instance Method Details

#transcribe(input_format:, transcription_engine:, interim_results: nil, language: nil, model: nil, request_options: {}) ⇒ nil

Transcribe audio streams to text over WebSocket.

Parameters:

• input_format (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::InputFormat) —

  The format of input audio stream.

• transcription_engine (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::TranscriptionEngine) —

  The transcription engine to use for processing the audio stream.

• interim_results (Boolean) —

  Whether to receive interim transcription results.

• language (String) —

  The language spoken in the audio stream.

• model (Symbol, Telnyx::Models::SpeechToTextTranscribeParams::Model) —

  The specific model to use within the selected transcription engine.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (nil)

See Also:

• Models::SpeechToTextTranscribeParams

# File 'lib/telnyx/resources/speech_to_text.rb', line 25

def transcribe(params)
  parsed, options = Telnyx::SpeechToTextTranscribeParams.dump_request(params)
  @client.request(
    method: :get,
    path: "speech-to-text/transcription",
    query: parsed,
    model: NilClass,
    options: options
  )
end