Class: Transcript::Audio::Stream::ConnectOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/ultrasafeai/audio/stream/connect_options.rb

Overview

Options for opening a live ASR streaming session over WebSocket.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model: "usf-mini-asr", sample_rate: 16000, audio_format: "pcm_s16le", enable_vad: false, partial_results: true, interim_min_duration_ms: 500, full_context_retranscription: true, max_retries: 3, backoff_ms: 500.0) ⇒ ConnectOptions

Returns a new instance of ConnectOptions.

Parameters:

  • model (String) (defaults to: "usf-mini-asr") —

    ASR model ID

  • sample_rate (Integer) (defaults to: 16000) —

    Sample rate of the incoming audio in Hz

  • audio_format (String) (defaults to: "pcm_s16le") —

    PCM encoding format Valid values: "pcm_s16le", "pcm_f32le"

  • enable_vad (Boolean) (defaults to: false) —

    Enable voice activity detection

  • partial_results (Boolean) (defaults to: true) —

    Emit partial/interim results before a segment is final

  • interim_min_duration_ms (Integer) (defaults to: 500) —

    Minimum audio duration in ms before emitting an interim result

  • full_context_retranscription (Boolean) (defaults to: true) —

    Re-transcribe with full accumulated audio context on each final



27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 27

def initialize(model: "usf-mini-asr", sample_rate: 16000, audio_format: "pcm_s16le", enable_vad: false, partial_results: true, interim_min_duration_ms: 500, full_context_retranscription: true, max_retries: 3, backoff_ms: 500.0)
    @model = model
    @sample_rate = sample_rate
    @audio_format = audio_format
    @enable_vad = enable_vad
    @partial_results = partial_results
    @interim_min_duration_ms = interim_min_duration_ms
    @full_context_retranscription = full_context_retranscription
  @max_retries = max_retries
  @backoff_ms = backoff_ms
end

Instance Attribute Details

#audio_format ⇒ Object

Returns the value of attribute audio_format.



11
12
13
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 11

def audio_format
  @audio_format
end

#backoff_ms ⇒ Object

Returns the value of attribute backoff_ms.



39
40
41
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 39

def backoff_ms
  @backoff_ms
end

#enable_vad ⇒ Object

Returns the value of attribute enable_vad.



12
13
14
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 12

def enable_vad
  @enable_vad
end

#full_context_retranscription ⇒ Object

Returns the value of attribute full_context_retranscription.



15
16
17
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 15

def full_context_retranscription
  @full_context_retranscription
end

#interim_min_duration_ms ⇒ Object

Returns the value of attribute interim_min_duration_ms.



14
15
16
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 14

def interim_min_duration_ms
  @interim_min_duration_ms
end

#max_retries ⇒ Object

Returns the value of attribute max_retries.



39
40
41
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 39

def max_retries
  @max_retries
end

#model ⇒ Object

Returns the value of attribute model.



9
10
11
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 9

def model
  @model
end

#partial_results ⇒ Object

Returns the value of attribute partial_results.



13
14
15
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 13

def partial_results
  @partial_results
end

#sample_rate ⇒ Object

Returns the value of attribute sample_rate.



10
11
12
 
# File 'lib/ultrasafeai/audio/stream/connect_options.rb', line 10

def sample_rate
  @sample_rate
end