Class google.cloud.speech.v1p1beta1.PhraseSet (4.1.3)

Represents a PhraseSet.

Package

@google-cloud/speech!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.speech.v1p1beta1.IPhraseSet);

Constructs a new PhraseSet.

Parameter

Name	Description
properties	`IPhraseSet` Properties to set

Properties

boost

public boost: number;

PhraseSet boost.

Property Value

Type	Description
number

name

public name: string;

PhraseSet name.

Property Value

Type	Description
string

phrases

public phrases: google.cloud.speech.v1p1beta1.PhraseSet.IPhrase[];

PhraseSet phrases.

Property Value

Type	Description
google.cloud.speech.v1p1beta1.PhraseSet.IPhrase[]

Methods

create(properties)

public static create(properties?: google.cloud.speech.v1p1beta1.IPhraseSet): google.cloud.speech.v1p1beta1.PhraseSet;

Creates a new PhraseSet instance using the specified properties.

Parameter

Name	Description
properties	`IPhraseSet` Properties to set

Returns

Type	Description
PhraseSet	PhraseSet instance

decode(reader, length)

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

Decodes a PhraseSet 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
PhraseSet	PhraseSet

decodeDelimited(reader)

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

Decodes a PhraseSet 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
PhraseSet	PhraseSet

encode(message, writer)

public static encode(message: google.cloud.speech.v1p1beta1.IPhraseSet, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified PhraseSet message. Does not implicitly messages.

Parameters

Name	Description
message	`IPhraseSet` PhraseSet 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.IPhraseSet, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IPhraseSet` PhraseSet 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.PhraseSet;

Creates a PhraseSet 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
PhraseSet	PhraseSet

toJSON()

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

Converts this PhraseSet to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.speech.v1p1beta1.PhraseSet, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters

Name	Description
message	`PhraseSet` PhraseSet
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 PhraseSet 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