Class protos.google.cloud.speech.v1.RecognitionConfig (4.7.0)

Represents a RecognitionConfig.

Package

@google-cloud/speech!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.speech.v1.IRecognitionConfig);

Constructs a new RecognitionConfig.

Parameter

Name	Description
properties	`IRecognitionConfig` Properties to set

Properties

audioChannelCount

public audioChannelCount: number;

RecognitionConfig audioChannelCount.

Property Value

Type	Description
number

diarizationConfig

public diarizationConfig?: (google.cloud.speech.v1.ISpeakerDiarizationConfig|null);

RecognitionConfig diarizationConfig.

Property Value

Type	Description
(google.cloud.speech.v1.ISpeakerDiarizationConfig\|null)

enableAutomaticPunctuation

public enableAutomaticPunctuation: boolean;

RecognitionConfig enableAutomaticPunctuation.

Property Value

Type	Description
boolean

enableSeparateRecognitionPerChannel

public enableSeparateRecognitionPerChannel: boolean;

RecognitionConfig enableSeparateRecognitionPerChannel.

Property Value

Type	Description
boolean

enableWordTimeOffsets

public enableWordTimeOffsets: boolean;

RecognitionConfig enableWordTimeOffsets.

Property Value

Type	Description
boolean

encoding

public encoding: (google.cloud.speech.v1.RecognitionConfig.AudioEncoding|keyof typeof google.cloud.speech.v1.RecognitionConfig.AudioEncoding);

RecognitionConfig encoding.

Property Value

Type	Description
(google.cloud.speech.v1.RecognitionConfig.AudioEncoding\|keyof typeof google.cloud.speech.v1.RecognitionConfig.AudioEncoding)

languageCode

public languageCode: string;

RecognitionConfig languageCode.

Property Value

Type	Description
string

maxAlternatives

public maxAlternatives: number;

RecognitionConfig maxAlternatives.

Property Value

Type	Description
number

metadata

public metadata?: (google.cloud.speech.v1.IRecognitionMetadata|null);

RecognitionConfig metadata.

Property Value

Type	Description
(google.cloud.speech.v1.IRecognitionMetadata\|null)

model

public model: string;

RecognitionConfig model.

Property Value

Type	Description
string

profanityFilter

public profanityFilter: boolean;

RecognitionConfig profanityFilter.

Property Value

Type	Description
boolean

sampleRateHertz

public sampleRateHertz: number;

RecognitionConfig sampleRateHertz.

Property Value

Type	Description
number

speechContexts

public speechContexts: google.cloud.speech.v1.ISpeechContext[];

RecognitionConfig speechContexts.

Property Value

Type	Description
google.cloud.speech.v1.ISpeechContext[]

useEnhanced

public useEnhanced: boolean;

RecognitionConfig useEnhanced.

Property Value

Type	Description
boolean

Methods

create(properties)

public static create(properties?: google.cloud.speech.v1.IRecognitionConfig): google.cloud.speech.v1.RecognitionConfig;

Creates a new RecognitionConfig instance using the specified properties.

Parameter

Name	Description
properties	`IRecognitionConfig` Properties to set

Returns

Type	Description
google.cloud.speech.v1.RecognitionConfig	RecognitionConfig instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.speech.v1.RecognitionConfig;

Decodes a RecognitionConfig message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
google.cloud.speech.v1.RecognitionConfig	RecognitionConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.speech.v1.RecognitionConfig;

Decodes a RecognitionConfig message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
google.cloud.speech.v1.RecognitionConfig	RecognitionConfig

encode(message, writer)

public static encode(message: google.cloud.speech.v1.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.v1.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.v1.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
google.cloud.speech.v1.RecognitionConfig	RecognitionConfig

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.v1.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	`google.cloud.speech.v1.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)	`null` if valid, otherwise the reason why it is not