Skip to content

Commit

Permalink
docs(v1): Clarified boost usage (#491)
Browse files Browse the repository at this point in the history
* docs: Clarified boost usage

PiperOrigin-RevId: 506405333

Source-Link: googleapis/googleapis@c8a382b

Source-Link: googleapis/googleapis-gen@655941e
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiNjU1OTQxZTE5M2ZhOTNjYmIyZWFjN2FkNWNkMmI5NDNiM2NmMjg3ZSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Feb 2, 2023
1 parent 8a91124 commit f83ccd0
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,8 @@ class PhraseSet(proto.Message):
``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. Speech
recognition will skip PhraseSets with a boost value of 0.
finding the optimal value for your use case as well as
adding phrases both with and without boost to your requests.
"""

class Phrase(proto.Message):
Expand Down Expand Up @@ -123,8 +123,8 @@ class Phrase(proto.Message):
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 </speech-to-text/docs/endpoints>`__ with matching ``us`` or
``eu`` location value.
endpoint <https://cloud.google.com/speech-to-text/docs/endpoints>`__
with matching ``us`` or ``eu`` location value.
Attributes:
value (str):
Expand All @@ -138,9 +138,9 @@ class Phrase(proto.Message):
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.
approach to finding the optimal value for your use case as
well as adding phrases both with and without boost to your
requests.
"""

value: str = proto.Field(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ class Phrase(proto.Message):
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 </speech-to-text/docs/endpoints>`__ with matching ``us`` or
``eu`` location value.
endpoint <https://cloud.google.com/speech-to-text/docs/endpoints>`__
with matching ``us`` or ``eu`` location value.
Attributes:
value (str):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-speech",
"version": "2.17.2"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-speech",
"version": "2.17.2"
"version": "0.1.0"
},
"snippets": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
],
"language": "PYTHON",
"name": "google-cloud-speech",
"version": "2.17.2"
"version": "0.1.0"
},
"snippets": [
{
Expand Down

0 comments on commit f83ccd0

Please sign in to comment.