# Cloud Speech-to-Text V2 API - Class Google::Cloud::Speech::V2::PhraseSet (v1.8.0)

1.8.0 (latest) 1.7.1 1.6.0 1.5.0 1.4.1 1.3.0 1.2.1 1.1.0 1.0.1 0.16.0 0.15.0 0.14.0 0.13.1 0.12.0 0.11.0 0.10.0 0.9.2 0.8.0 0.7.0 0.6.0 0.5.1 0.4.0 0.3.0 0.2.0 0.1.0 Reference documentation and code samples for the Cloud Speech-to-Text V2 API class Google::Cloud::Speech::V2::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.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #annotations

    def annotations() -> ::Google::Protobuf::Map{::String => ::String}

**Returns**

- (::Google::Protobuf::Map{::String =\> ::String}) --- 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.

### #annotations=

    def annotations=(value) -> ::Google::Protobuf::Map{::String => ::String}

**Parameter**

- **value** (::Google::Protobuf::Map{::String =\> ::String}) --- 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**

- (::Google::Protobuf::Map{::String =\> ::String}) --- 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.

### #boost

    def boost() -> ::Float

**Returns**

- (::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.

### #boost=

    def boost=(value) -> ::Float

**Parameter**

- **value** (::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.
**Returns**

- (::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.

### #create_time

    def create_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Protobuf-Timestamp)) --- Output only. Creation time.

### #delete_time

    def delete_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Protobuf-Timestamp)) --- Output only. The time at which this resource was requested for deletion.

### #display_name

    def display_name() -> ::String

**Returns**

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

### #display_name=

    def display_name=(value) -> ::String

**Parameter**

- **value** (::String) --- User-settable, human-readable name for the PhraseSet. Must be 63 characters or less.
**Returns**

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

### #etag

    def etag() -> ::String

**Returns**

- (::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.

### #expire_time

    def expire_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Protobuf-Timestamp)) --- Output only. The time at which this resource will be purged.

### #kms_key_name

    def kms_key_name() -> ::String

**Returns**

- (::String) --- Output only. The [KMS key
  name](https://cloud.google.com/kms/docs/resource-hierarchy#keys) with which the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.

### #kms_key_version_name

    def kms_key_version_name() -> ::String

**Returns**

- (::String) --- Output only. The [KMS key version
  name](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions) with which the PhraseSet is encrypted. The expected format is `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}/cryptoKeyVersions/{crypto_key_version}`.

### #name

    def name() -> ::String

**Returns**

- (::String) --- Output only. Identifier. The resource name of the PhraseSet. Format: `projects/{project}/locations/{location}/phraseSets/{phrase_set}`.

### #phrases

    def phrases() -> ::Array<::Google::Cloud::Speech::V2::PhraseSet::Phrase>

**Returns**

- (::Array\<[::Google::Cloud::Speech::V2::PhraseSet::Phrase](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Cloud-Speech-V2-PhraseSet-Phrase)\>) --- A list of word and phrases.

### #phrases=

    def phrases=(value) -> ::Array<::Google::Cloud::Speech::V2::PhraseSet::Phrase>

**Parameter**

- **value** (::Array\<[::Google::Cloud::Speech::V2::PhraseSet::Phrase](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Cloud-Speech-V2-PhraseSet-Phrase)\>) --- A list of word and phrases.
**Returns**

- (::Array\<[::Google::Cloud::Speech::V2::PhraseSet::Phrase](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Cloud-Speech-V2-PhraseSet-Phrase)\>) --- A list of word and phrases.

### #reconciling

    def reconciling() -> ::Boolean

**Returns**

- (::Boolean) --- Output only. Whether or not this PhraseSet is in the process of being updated.

### #state

    def state() -> ::Google::Cloud::Speech::V2::PhraseSet::State

**Returns**

- ([::Google::Cloud::Speech::V2::PhraseSet::State](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Cloud-Speech-V2-PhraseSet-State)) --- Output only. The PhraseSet lifecycle state.

### #uid

    def uid() -> ::String

**Returns**

- (::String) --- Output only. System-assigned unique identifier for the PhraseSet.

### #update_time

    def update_time() -> ::Google::Protobuf::Timestamp

**Returns**

- ([::Google::Protobuf::Timestamp](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-speech-v2/latest/Google-Protobuf-Timestamp)) --- Output only. The most recent time this resource was modified.