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

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

#delete_time

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

#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

#kms_key_name

def kms_key_name() -> ::String
Returns
  • (::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

def kms_key_version_name() -> ::String
Returns
  • (::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}.

#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

#phrases=

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

#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

#uid

def uid() -> ::String
Returns
  • (::String) — Output only. System-assigned unique identifier for the PhraseSet.

#update_time

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