Class: Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechTranscriptionConfig

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/videointelligence_v1/classes.rb,
generated/google/apis/videointelligence_v1/representations.rb,
generated/google/apis/videointelligence_v1/representations.rb

Overview

Config for SPEECH_TRANSCRIPTION.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ GoogleCloudVideointelligenceV1SpeechTranscriptionConfig

Returns a new instance of GoogleCloudVideointelligenceV1SpeechTranscriptionConfig



559
560
561
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 559

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#audio_tracks ⇒ Array<Fixnum>

Optional For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0. Corresponds to the JSON property audioTracks

Returns:

  • (Array<Fixnum>) 


486
487
488
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 486

def audio_tracks
  @audio_tracks
end

#diarization_speaker_count ⇒ Fixnum

Optional If set, specifies the estimated number of speakers in the conversation. If not set, defaults to '2'. Ignored unless enable_speaker_diarization is set to true. Corresponds to the JSON property diarizationSpeakerCount

Returns:

  • (Fixnum) 


494
495
496
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 494

def diarization_speaker_count
  @diarization_speaker_count
end

#enable_automatic_punctuation ⇒ Boolean Also known as: enable_automatic_punctuation?

Optional If 'true', adds punctuation to recognition result hypotheses. This feature is only available in select languages. Setting this for requests in other languages has no effect at all. The default 'false' value does not add punctuation to result hypotheses. NOTE: "This is currently offered as an experimental service, complimentary to all users. In the future this may be exclusively available as a premium feature." Corresponds to the JSON property enableAutomaticPunctuation

Returns:

  • (Boolean) 


504
505
506
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 504

def enable_automatic_punctuation
  @enable_automatic_punctuation
end

#enable_speaker_diarization ⇒ Boolean Also known as: enable_speaker_diarization?

Optional If 'true', enables speaker detection for each recognized word in the top alternative of the recognition result using a speaker_tag provided in the WordInfo. Note: When this is true, we send all the words from the beginning of the audio for the top alternative in every consecutive responses. This is done in order to improve our speaker tags as our models learn to identify the speakers in the conversation over time. Corresponds to the JSON property enableSpeakerDiarization

Returns:

  • (Boolean) 


516
517
518
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 516

def enable_speaker_diarization
  @enable_speaker_diarization
end

#enable_word_confidence ⇒ Boolean Also known as: enable_word_confidence?

Optional If true, the top result includes a list of words and the confidence for those words. If false, no word-level confidence information is returned. The default is false. Corresponds to the JSON property enableWordConfidence

Returns:

  • (Boolean) 


524
525
526
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 524

def enable_word_confidence
  @enable_word_confidence
end

#filter_profanity ⇒ Boolean Also known as: filter_profanity?

Optional If set to true, the server will attempt to filter out profanities, replacing all but the initial character in each filtered word with asterisks, e.g. "f***". If set to false or omitted, profanities won't be filtered out. Corresponds to the JSON property filterProfanity

Returns:

  • (Boolean) 


533
534
535
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 533

def filter_profanity
  @filter_profanity
end

#language_code ⇒ String

Required The language of the supplied audio as a BCP-47 language tag. Example: "en-US". See Language Support for a list of the currently supported language codes. Corresponds to the JSON property languageCode

Returns:

  • (String) 


543
544
545
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 543

def language_code
  @language_code
end

#max_alternatives ⇒ Fixnum

Optional Maximum number of recognition hypotheses to be returned. Specifically, the maximum number of SpeechRecognitionAlternative messages within each SpeechTranscription. The server may return fewer than max_alternatives. Valid values are 0-30. A value of 0 or 1 will return a maximum of one. If omitted, will return a maximum of one. Corresponds to the JSON property maxAlternatives

Returns:

  • (Fixnum) 


552
553
554
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 552

def max_alternatives
  @max_alternatives
end

#speech_contexts ⇒ Array<Google::Apis::VideointelligenceV1::GoogleCloudVideointelligenceV1SpeechContext>

Optional A means to provide context to assist the speech recognition. Corresponds to the JSON property speechContexts

Returns:



557
558
559
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 557

def speech_contexts
  @speech_contexts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



564
565
566
567
568
569
570
571
572
573
574
 
# File 'generated/google/apis/videointelligence_v1/classes.rb', line 564

def update!(**args)
  @audio_tracks = args[:audio_tracks] if args.key?(:audio_tracks)
  @diarization_speaker_count = args[:diarization_speaker_count] if args.key?(:diarization_speaker_count)
  @enable_automatic_punctuation = args[:enable_automatic_punctuation] if args.key?(:enable_automatic_punctuation)
  @enable_speaker_diarization = args[:enable_speaker_diarization] if args.key?(:enable_speaker_diarization)
  @enable_word_confidence = args[:enable_word_confidence] if args.key?(:enable_word_confidence)
  @filter_profanity = args[:filter_profanity] if args.key?(:filter_profanity)
  @language_code = args[:language_code] if args.key?(:language_code)
  @max_alternatives = args[:max_alternatives] if args.key?(:max_alternatives)
  @speech_contexts = args[:speech_contexts] if args.key?(:speech_contexts)
end