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.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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 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.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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:



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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:



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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:



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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}.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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}.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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. Identifier. The resource name of the PhraseSet. Format: projects/{project}/locations/{location}/phraseSets/{phrase_set}.

Returns:

  • (::String) —

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



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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:



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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:



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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.



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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:



1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
 
# File 'proto_docs/google/cloud/speech/v2/cloud_speech.rb', line 1591

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 values will return an error. Boost values must
  #     be between 0 and 20. Any values outside that range will return an error.
  #     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.
  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