Class protos.google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult (4.3.1)

Represents a StreamingRecognitionResult.

Package

@google-cloud/dialogflow-cx

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.dialogflow.cx.v3beta1.IStreamingRecognitionResult);

Constructs a new StreamingRecognitionResult.

Parameter
NameDescription
properties IStreamingRecognitionResult

Properties to set

Properties

confidence

public confidence: number;

StreamingRecognitionResult confidence.

isFinal

public isFinal: boolean;

StreamingRecognitionResult isFinal.

languageCode

public languageCode: string;

StreamingRecognitionResult languageCode.

messageType

public messageType: (google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult.MessageType|keyof typeof google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult.MessageType);

StreamingRecognitionResult messageType.

speechEndOffset

public speechEndOffset?: (google.protobuf.IDuration|null);

StreamingRecognitionResult speechEndOffset.

speechWordInfo

public speechWordInfo: google.cloud.dialogflow.cx.v3beta1.ISpeechWordInfo[];

StreamingRecognitionResult speechWordInfo.

stability

public stability: number;

StreamingRecognitionResult stability.

transcript

public transcript: string;

StreamingRecognitionResult transcript.

Methods

create(properties)

public static create(properties?: google.cloud.dialogflow.cx.v3beta1.IStreamingRecognitionResult): google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult;

Creates a new StreamingRecognitionResult instance using the specified properties.

Parameter
NameDescription
properties IStreamingRecognitionResult

Properties to set

Returns
TypeDescription
StreamingRecognitionResult

StreamingRecognitionResult instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult;

Decodes a StreamingRecognitionResult message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
StreamingRecognitionResult

StreamingRecognitionResult

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
StreamingRecognitionResult

StreamingRecognitionResult

encode(message, writer)

public static encode(message: google.cloud.dialogflow.cx.v3beta1.IStreamingRecognitionResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified StreamingRecognitionResult message. Does not implicitly messages.

Parameters
NameDescription
message IStreamingRecognitionResult

StreamingRecognitionResult message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.dialogflow.cx.v3beta1.IStreamingRecognitionResult, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified StreamingRecognitionResult message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message IStreamingRecognitionResult

StreamingRecognitionResult message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult;

Creates a StreamingRecognitionResult message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
StreamingRecognitionResult

StreamingRecognitionResult

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for StreamingRecognitionResult

Parameter
NameDescription
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
TypeDescription
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this StreamingRecognitionResult to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.dialogflow.cx.v3beta1.StreamingRecognitionResult, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a StreamingRecognitionResult message. Also converts values to other types if specified.

Parameters
NameDescription
message StreamingRecognitionResult

StreamingRecognitionResult

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a StreamingRecognitionResult message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not