Cloud Speech V2 Client - Class PhraseSet (1.18.2)

Reference documentation and code samples for the Cloud Speech V2 Client class PhraseSet.

PhraseSet for biasing in speech recognition. A PhraseSet is used to provide "hints" to the speech recognizer to favor specific words and phrases in the results.

Generated from protobuf message google.cloud.speech.v2.PhraseSet

Namespace

Google \ Cloud \ Speech \ V2

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

Output only. Identifier. The resource name of the PhraseSet. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.
↳ uid string

Output only. System-assigned unique identifier for the PhraseSet.
↳ phrases array<Google\Cloud\Speech\V2\PhraseSet\Phrase>

A list of word and phrases.
↳ boost float

Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well. Valid boost values are between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.
↳ display_name string

User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.
↳ state int

Output only. The PhraseSet lifecycle state.
↳ create_time Google\Protobuf\Timestamp

Output only. Creation time.
↳ update_time Google\Protobuf\Timestamp

Output only. The most recent time this resource was modified.
↳ delete_time Google\Protobuf\Timestamp

Output only. The time at which this resource was requested for deletion.
↳ expire_time Google\Protobuf\Timestamp

Output only. The time at which this resource will be purged.
↳ annotations array|Google\Protobuf\Internal\MapField

Allows users to store small amounts of arbitrary data. Both the key and the value must be 63 characters or less each. At most 100 annotations.
↳ etag string

Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.
↳ reconciling bool

Output only. Whether or not this PhraseSet is in the process of being updated.
↳ kms_key_name string

Output only. The KMS key name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
↳ kms_key_version_name string

Output only. The KMS key version name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

getName

Output only. Identifier. The resource name of the PhraseSet.

Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Returns
Type Description
string

setName

Output only. Identifier. The resource name of the PhraseSet.

Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Parameter
Name Description
var string
Returns
Type Description
$this

getUid

Output only. System-assigned unique identifier for the PhraseSet.

Returns
Type Description
string

setUid

Output only. System-assigned unique identifier for the PhraseSet.

Parameter
Name Description
var string
Returns
Type Description
$this

getPhrases

A list of word and phrases.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setPhrases

A list of word and phrases.

Parameter
Name Description
var array<Google\Cloud\Speech\V2\PhraseSet\Phrase>
Returns
Type Description
$this

getBoost

Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well.

Valid boost values are between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

Returns
Type Description
float

setBoost

Hint Boost. Positive value will increase the probability that a specific phrase will be recognized over other similar sounding phrases. The higher the boost, the higher the chance of false positive recognition as well.

Valid boost values are between 0 (exclusive) and 20. We recommend using a binary search approach to finding the optimal value for your use case as well as adding phrases both with and without boost to your requests.

Parameter
Name Description
var float
Returns
Type Description
$this

getDisplayName

User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.

Returns
Type Description
string

setDisplayName

User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.

Parameter
Name Description
var string
Returns
Type Description
$this

getState

Output only. The PhraseSet lifecycle state.

Returns
Type Description
int

setState

Output only. The PhraseSet lifecycle state.

Parameter
Name Description
var int
Returns
Type Description
$this

getCreateTime

Output only. Creation time.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Creation time.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getUpdateTime

Output only. The most recent time this resource was modified.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The most recent time this resource was modified.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getDeleteTime

Output only. The time at which this resource was requested for deletion.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasDeleteTime

clearDeleteTime

setDeleteTime

Output only. The time at which this resource was requested for deletion.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getExpireTime

Output only. The time at which this resource will be purged.

Returns
Type Description
Google\Protobuf\Timestamp|null

hasExpireTime

clearExpireTime

setExpireTime

Output only. The time at which this resource will be purged.

Parameter
Name Description
var Google\Protobuf\Timestamp
Returns
Type Description
$this

getAnnotations

Allows users to store small amounts of arbitrary data.

Both the key and the value must be 63 characters or less each. At most 100 annotations.

Returns
Type Description
Google\Protobuf\Internal\MapField

setAnnotations

Allows users to store small amounts of arbitrary data.

Both the key and the value must be 63 characters or less each. At most 100 annotations.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getEtag

Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Returns
Type Description
string

setEtag

Output only. This checksum is computed by the server based on the value of other fields. This may be sent on update, undelete, and delete requests to ensure the client has an up-to-date value before proceeding.

Parameter
Name Description
var string
Returns
Type Description
$this

getReconciling

Output only. Whether or not this PhraseSet is in the process of being updated.

Returns
Type Description
bool

setReconciling

Output only. Whether or not this PhraseSet is in the process of being updated.

Parameter
Name Description
var bool
Returns
Type Description
$this

getKmsKeyName

Output only. The KMS key name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Returns
Type Description
string

setKmsKeyName

Output only. The KMS key name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

Parameter
Name Description
var string
Returns
Type Description
$this

getKmsKeyVersionName

Output only. The KMS key version name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

Returns
Type Description
string

setKmsKeyVersionName

Output only. The KMS key version name with which the PhraseSet is encrypted. The expected format is projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}.

Parameter
Name Description
var string
Returns
Type Description
$this