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

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

Overview

Config for SPEECH_TRANSCRIPTION.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudVideointelligenceV1SpeechTranscriptionConfig

Returns a new instance of GoogleCloudVideointelligenceV1SpeechTranscriptionConfig.



1115
1116
1117
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1115

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

Instance Attribute Details

#audio_output_uri_prefix ⇒ String

Optional. Legacy field. This field must be a Cloud Storage URI prefix. (e.g., gs://bucket/path/). Corresponds to the JSON property audioOutputUriPrefix

Returns:

  • (String) 


1040
1041
1042
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1040

def audio_output_uri_prefix
  @audio_output_uri_prefix
end

#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>) 


1046
1047
1048
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1046

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) 


1053
1054
1055
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1053

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) 


1063
1064
1065
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1063

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 response. 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) 


1074
1075
1076
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1074

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) 


1082
1083
1084
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1082

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) 


1090
1091
1092
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1090

def filter_profanity
  @filter_profanity
end

#language_code ⇒ String

Required. 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) 


1099
1100
1101
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1099

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) 


1108
1109
1110
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1108

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:



1113
1114
1115
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1113

def speech_contexts
  @speech_contexts
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
 
# File 'lib/google/apis/videointelligence_v1/classes.rb', line 1120

def update!(**args)
  @audio_output_uri_prefix = args[:audio_output_uri_prefix] if args.key?(:audio_output_uri_prefix)
  @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