Class: Google::Cloud::Speech::V1::PhraseSet

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

Overview

Provides "hints" to the speech recognizer to favor specific words and phrases in the results.

Defined Under Namespace

Classes: Phrase

Instance Attribute Summary collapse

Instance Attribute Details

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/speech/v1/resource.rb', line 70

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

  # A phrases containing 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. See
  # [usage limits](https://cloud.google.com/speech-to-text/quotas#content).
  #
  # List items can also include pre-built or custom classes containing groups
  # of words that represent common concepts that occur in natural language. For
  # example, rather than providing a phrase hint for every month of the
  # year (e.g. "i was born in january", "i was born in febuary", ...), use the
  # pre-built `$MONTH` class improves the likelihood of correctly transcribing
  # audio that includes months (e.g. "i was born in $month").
  # To refer to pre-built classes, use the class' symbol prepended with `$`
  # e.g. `$MONTH`. To refer to custom classes that were defined inline in the
  # request, set the class's `custom_class_id` to a string unique to all class
  # resources and inline classes. Then use the class' id wrapped in $`{...}`
  # e.g. "$\\{my-months}". To refer to custom classes resources, use the class'
  # id wrapped in `${}` (e.g. `${my-months}`).
  #
  # Speech-to-Text supports three locations: `global`, `us` (US North America),
  # and `eu` (Europe). If you are calling the `speech.googleapis.com`
  # endpoint, use the `global` location. To specify a region, use a
  # [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
  # with matching `us` or `eu` location value.
  # @!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 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 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
end

#name ⇒ ::String

Returns The resource name of the phrase set.

Returns:

  • (::String) —

    The resource name of the phrase set.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/speech/v1/resource.rb', line 70

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

  # A phrases containing 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. See
  # [usage limits](https://cloud.google.com/speech-to-text/quotas#content).
  #
  # List items can also include pre-built or custom classes containing groups
  # of words that represent common concepts that occur in natural language. For
  # example, rather than providing a phrase hint for every month of the
  # year (e.g. "i was born in january", "i was born in febuary", ...), use the
  # pre-built `$MONTH` class improves the likelihood of correctly transcribing
  # audio that includes months (e.g. "i was born in $month").
  # To refer to pre-built classes, use the class' symbol prepended with `$`
  # e.g. `$MONTH`. To refer to custom classes that were defined inline in the
  # request, set the class's `custom_class_id` to a string unique to all class
  # resources and inline classes. Then use the class' id wrapped in $`{...}`
  # e.g. "$\\{my-months}". To refer to custom classes resources, use the class'
  # id wrapped in `${}` (e.g. `${my-months}`).
  #
  # Speech-to-Text supports three locations: `global`, `us` (US North America),
  # and `eu` (Europe). If you are calling the `speech.googleapis.com`
  # endpoint, use the `global` location. To specify a region, use a
  # [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
  # with matching `us` or `eu` location value.
  # @!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 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 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
end

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

Returns A list of word and phrases.

Returns:



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/speech/v1/resource.rb', line 70

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

  # A phrases containing 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. See
  # [usage limits](https://cloud.google.com/speech-to-text/quotas#content).
  #
  # List items can also include pre-built or custom classes containing groups
  # of words that represent common concepts that occur in natural language. For
  # example, rather than providing a phrase hint for every month of the
  # year (e.g. "i was born in january", "i was born in febuary", ...), use the
  # pre-built `$MONTH` class improves the likelihood of correctly transcribing
  # audio that includes months (e.g. "i was born in $month").
  # To refer to pre-built classes, use the class' symbol prepended with `$`
  # e.g. `$MONTH`. To refer to custom classes that were defined inline in the
  # request, set the class's `custom_class_id` to a string unique to all class
  # resources and inline classes. Then use the class' id wrapped in $`{...}`
  # e.g. "$\\{my-months}". To refer to custom classes resources, use the class'
  # id wrapped in `${}` (e.g. `${my-months}`).
  #
  # Speech-to-Text supports three locations: `global`, `us` (US North America),
  # and `eu` (Europe). If you are calling the `speech.googleapis.com`
  # endpoint, use the `global` location. To specify a region, use a
  # [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
  # with matching `us` or `eu` location value.
  # @!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 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 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
end