Class: Google::Cloud::Speech::V2::PhraseSet

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/speech/v2/cloud_speech.rb

Overview

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.

Defined Under Namespace

Modules: State Classes: AnnotationsEntry, Phrase

Instance Attribute Summary collapse

Instance Attribute Details

#annotations ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#boost ⇒ ::Float

Returns 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.

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.



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Creation time.

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#delete_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#display_name ⇒ ::String

Returns 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.



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#etag ⇒ ::String (readonly)

Returns 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:

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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#expire_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#kms_key_name ⇒ ::String (readonly)

Returns 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:

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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#kms_key_version_name ⇒ ::String (readonly)

Returns 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:

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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#name ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#phrases ⇒ ::Array<::Google::Cloud::Speech::V2::PhraseSet::Phrase>

Returns A list of word and phrases.

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#reconciling ⇒ ::Boolean (readonly)

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

Returns:

  • (::Boolean) —

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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#state ⇒ ::Google::Cloud::Speech::V2::PhraseSet::State (readonly)

Returns Output only. The PhraseSet lifecycle state.

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#uid ⇒ ::String (readonly)

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

Returns:

  • (::String) —

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



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

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

Returns:



1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1339

class PhraseSet
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A Phrase contains words and phrase "hints" so that the speech recognition
  # is more likely to recognize them. This can be used to improve the accuracy
  # for specific words and phrases, for example, if specific commands are
  # typically spoken by the user. This can also be used to add additional words
  # to the vocabulary of the recognizer.
  #
  # List items can also include CustomClass references containing groups of
  # words that represent common concepts that occur in natural language.
  # @!attribute [rw] value
  #   @return [::String]
  #     The phrase itself.
  # @!attribute [rw] boost
  #   @return [::Float]
  #     Hint Boost. Overrides the boost set at the phrase set level.
  #     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. Negative
  #     boost values would correspond to anti-biasing. Anti-biasing is not
  #     enabled, so negative boost will simply be ignored. Though `boost` can
  #     accept a wide range of positive values, most use cases are best served
  #     with values between 0 and 20. We recommend using a binary search approach
  #     to finding the optimal value for your use case. Speech recognition
  #     will skip PhraseSets with a boost value of 0.
  class Phrase
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class AnnotationsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Set of states that define the lifecycle of a PhraseSet.
  module State
    # Unspecified state.  This is only used/useful for distinguishing
    # unset values.
    STATE_UNSPECIFIED = 0

    # The normal and active state.
    ACTIVE = 2

    # This PhraseSet has been deleted.
    DELETED = 4
  end
end