# Cloud Video Intelligence V1p3beta1 API - Class Google::Cloud::VideoIntelligence::V1p3beta1::SpeechTranscriptionConfig (v0.14.0)

0.14.0 (latest) 0.13.0 0.12.1 0.11.0 0.10.0 0.9.1 0.8.0 0.7.2 0.6.2 0.5.0 0.4.1 0.3.0 0.2.0 0.1.2 Reference documentation and code samples for the Cloud Video Intelligence V1p3beta1 API class Google::Cloud::VideoIntelligence::V1p3beta1::SpeechTranscriptionConfig.

Config for SPEECH_TRANSCRIPTION.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #audio_tracks

    def audio_tracks() -> ::Array<::Integer>

**Returns**

- (::Array\<::Integer\>) --- Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.

### #audio_tracks=

    def audio_tracks=(value) -> ::Array<::Integer>

**Parameter**

- **value** (::Array\<::Integer\>) --- Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.
**Returns**

- (::Array\<::Integer\>) --- Optional. For file formats, such as MXF or MKV, supporting multiple audio tracks, specify up to two tracks. Default: track 0.

### #diarization_speaker_count

    def diarization_speaker_count() -> ::Integer

**Returns**

- (::Integer) --- 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.

### #diarization_speaker_count=

    def diarization_speaker_count=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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.
**Returns**

- (::Integer) --- 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.

### #enable_automatic_punctuation

    def enable_automatic_punctuation() -> ::Boolean

**Returns**

- (::Boolean) --- 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."

### #enable_automatic_punctuation=

    def enable_automatic_punctuation=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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."
**Returns**

- (::Boolean) --- 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."

### #enable_speaker_diarization

    def enable_speaker_diarization() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #enable_speaker_diarization=

    def enable_speaker_diarization=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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.
**Returns**

- (::Boolean) --- 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.

### #enable_word_confidence

    def enable_word_confidence() -> ::Boolean

**Returns**

- (::Boolean) --- 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`.

### #enable_word_confidence=

    def enable_word_confidence=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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`.
**Returns**

- (::Boolean) --- 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`.

### #filter_profanity

    def filter_profanity() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #filter_profanity=

    def filter_profanity=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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.
**Returns**

- (::Boolean) --- 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.

### #language_code

    def language_code() -> ::String

**Returns**

- (::String) --- Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes.

### #language_code=

    def language_code=(value) -> ::String

**Parameter**

- **value** (::String) --- Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes.
**Returns**

- (::String) --- Required. *Required* The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: "en-US". See [Language Support](https://cloud.google.com/speech/docs/languages) for a list of the currently supported language codes.

### #max_alternatives

    def max_alternatives() -> ::Integer

**Returns**

- (::Integer) --- 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.

### #max_alternatives=

    def max_alternatives=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- 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.
**Returns**

- (::Integer) --- 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.

### #speech_contexts

    def speech_contexts() -> ::Array<::Google::Cloud::VideoIntelligence::V1p3beta1::SpeechContext>

**Returns**

- (::Array\<[::Google::Cloud::VideoIntelligence::V1p3beta1::SpeechContext](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-video_intelligence-v1p3beta1/latest/Google-Cloud-VideoIntelligence-V1p3beta1-SpeechContext)\>) --- Optional. A means to provide context to assist the speech recognition.

### #speech_contexts=

    def speech_contexts=(value) -> ::Array<::Google::Cloud::VideoIntelligence::V1p3beta1::SpeechContext>

**Parameter**

- **value** (::Array\<[::Google::Cloud::VideoIntelligence::V1p3beta1::SpeechContext](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-video_intelligence-v1p3beta1/latest/Google-Cloud-VideoIntelligence-V1p3beta1-SpeechContext)\>) --- Optional. A means to provide context to assist the speech recognition.
**Returns**

- (::Array\<[::Google::Cloud::VideoIntelligence::V1p3beta1::SpeechContext](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-video_intelligence-v1p3beta1/latest/Google-Cloud-VideoIntelligence-V1p3beta1-SpeechContext)\>) --- Optional. A means to provide context to assist the speech recognition.