Represents a RecognitionConfig.
Package
@google-cloud/speechConstructors
(constructor)(properties)
constructor(properties?: google.cloud.speech.v1p1beta1.IRecognitionConfig);Constructs a new RecognitionConfig.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRecognitionConfig
Properties to set |
Properties
adaptation
public adaptation?: (google.cloud.speech.v1p1beta1.ISpeechAdaptation|null);RecognitionConfig adaptation.
alternativeLanguageCodes
public alternativeLanguageCodes: string[];RecognitionConfig alternativeLanguageCodes.
audioChannelCount
public audioChannelCount: number;RecognitionConfig audioChannelCount.
diarizationConfig
public diarizationConfig?: (google.cloud.speech.v1p1beta1.ISpeakerDiarizationConfig|null);RecognitionConfig diarizationConfig.
diarizationSpeakerCount
public diarizationSpeakerCount: number;RecognitionConfig diarizationSpeakerCount.
enableAutomaticPunctuation
public enableAutomaticPunctuation: boolean;RecognitionConfig enableAutomaticPunctuation.
enableSeparateRecognitionPerChannel
public enableSeparateRecognitionPerChannel: boolean;RecognitionConfig enableSeparateRecognitionPerChannel.
enableSpeakerDiarization
public enableSpeakerDiarization: boolean;RecognitionConfig enableSpeakerDiarization.
enableSpokenEmojis
public enableSpokenEmojis?: (google.protobuf.IBoolValue|null);RecognitionConfig enableSpokenEmojis.
enableSpokenPunctuation
public enableSpokenPunctuation?: (google.protobuf.IBoolValue|null);RecognitionConfig enableSpokenPunctuation.
enableWordConfidence
public enableWordConfidence: boolean;RecognitionConfig enableWordConfidence.
enableWordTimeOffsets
public enableWordTimeOffsets: boolean;RecognitionConfig enableWordTimeOffsets.
encoding
public encoding: (google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding|keyof typeof google.cloud.speech.v1p1beta1.RecognitionConfig.AudioEncoding);RecognitionConfig encoding.
languageCode
public languageCode: string;RecognitionConfig languageCode.
maxAlternatives
public maxAlternatives: number;RecognitionConfig maxAlternatives.
metadata
public metadata?: (google.cloud.speech.v1p1beta1.IRecognitionMetadata|null);RecognitionConfig metadata.
model
public model: string;RecognitionConfig model.
profanityFilter
public profanityFilter: boolean;RecognitionConfig profanityFilter.
sampleRateHertz
public sampleRateHertz: number;RecognitionConfig sampleRateHertz.
speechContexts
public speechContexts: google.cloud.speech.v1p1beta1.ISpeechContext[];RecognitionConfig speechContexts.
transcriptNormalization
public transcriptNormalization?: (google.cloud.speech.v1p1beta1.ITranscriptNormalization|null);RecognitionConfig transcriptNormalization.
useEnhanced
public useEnhanced: boolean;RecognitionConfig useEnhanced.
Methods
create(properties)
public static create(properties?: google.cloud.speech.v1p1beta1.IRecognitionConfig): google.cloud.speech.v1p1beta1.RecognitionConfig;Creates a new RecognitionConfig instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IRecognitionConfig
Properties to set |
| Returns | |
|---|---|
| Type | Description |
RecognitionConfig | RecognitionConfig instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.speech.v1p1beta1.RecognitionConfig;Decodes a RecognitionConfig message from the specified reader or buffer.
| Parameters | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
| Returns | |
|---|---|
| Type | Description |
RecognitionConfig | RecognitionConfig |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.speech.v1p1beta1.RecognitionConfig;Decodes a RecognitionConfig message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
RecognitionConfig | RecognitionConfig |
encode(message, writer)
public static encode(message: google.cloud.speech.v1p1beta1.IRecognitionConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RecognitionConfig message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRecognitionConfig
RecognitionConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
encodeDelimited(message, writer)
public static encodeDelimited(message: google.cloud.speech.v1p1beta1.IRecognitionConfig, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified RecognitionConfig message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IRecognitionConfig
RecognitionConfig message or plain object to encode |
writer |
$protobuf.Writer
Writer to encode to |
| Returns | |
|---|---|
| Type | Description |
$protobuf.Writer | Writer |
fromObject(object)
public static fromObject(object: { [k: string]: any }): google.cloud.speech.v1p1beta1.RecognitionConfig;Creates a RecognitionConfig message from a plain object. Also converts values to their respective internal types.
| Parameter | |
|---|---|
| Name | Description |
object |
{ [k: string]: any }
Plain object |
| Returns | |
|---|---|
| Type | Description |
RecognitionConfig | RecognitionConfig |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for RecognitionConfig
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this RecognitionConfig to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.speech.v1p1beta1.RecognitionConfig, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a RecognitionConfig message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
RecognitionConfig
RecognitionConfig |
options |
$protobuf.IConversionOptions
Conversion options |
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | Plain object |
verify(message)
public static verify(message: { [k: string]: any }): (string|null);Verifies a RecognitionConfig message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|