Skip to content

Commit fd273d6

Browse files
gcf-owl-bot[bot]gcf-owl-bot[bot]
authored
docs: [speech] Clarified boost usage (#9032)
* docs: Clarify boost usage in Reference PiperOrigin-RevId: 504332057 Source-Link: googleapis/googleapis@13dd16c Source-Link: https://github.com/googleapis/googleapis-gen/commit/75a668a05f5e438fbc0105c85433ae181ef37ec0 Copy-Tag: eyJwIjoiamF2YS1zcGVlY2gvLk93bEJvdC55YW1sIiwiaCI6Ijc1YTY2OGEwNWY1ZTQzOGZiYzAxMDVjODU0MzNhZTE4MWVmMzdlYzAifQ== * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md * docs: Clarified boost usage PiperOrigin-RevId: 506405333 Source-Link: googleapis/googleapis@c8a382b Source-Link: https://github.com/googleapis/googleapis-gen/commit/655941e193fa93cbb2eac7ad5cd2b943b3cf287e Copy-Tag: eyJwIjoiamF2YS1zcGVlY2gvLk93bEJvdC55YW1sIiwiaCI6IjY1NTk0MWUxOTNmYTkzY2JiMmVhYzdhZDVjZDJiOTQzYjNjZjI4N2UifQ== * 🦉 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>
1 parent 2bf4ad6 commit fd273d6

17 files changed

Lines changed: 159 additions & 111 deletions

File tree

‎java-speech/README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ If you are using Maven, add this to your pom.xml file:
1919
<dependency>
2020
<groupId>com.google.cloud</groupId>
2121
<artifactId>google-cloud-speech</artifactId>
22-
<version>4.3.0</version>
22+
<version>4.4.0</version>
2323
</dependency>
2424
```
2525

2626
If you are using Gradle without BOM, add this to your dependencies:
2727

2828
```Groovy
29-
implementation 'com.google.cloud:google-cloud-speech:4.3.0'
29+
implementation 'com.google.cloud:google-cloud-speech:4.4.0'
3030
```
3131

3232
If you are using SBT, add this to your dependencies:
3333

3434
```Scala
35-
libraryDependencies += "com.google.cloud" % "google-cloud-speech" % "4.3.0"
35+
libraryDependencies += "com.google.cloud" % "google-cloud-speech" % "4.4.0"
3636
```
3737

3838
## Authentication

‎java-speech/proto-google-cloud-speech-v1/src/main/java/com/google/cloud/speech/v1/CreateCustomClassRequest.java‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
7676
*
7777
*
7878
* <pre>
79-
* Required. The parent resource where this custom class will be created. Format:
79+
* Required. The parent resource where this custom class will be created.
80+
* Format:
8081
* `projects/{project}/locations/{location}/customClasses`
8182
* Speech-to-Text supports three locations: `global`, `us` (US North America),
8283
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -107,7 +108,8 @@ public java.lang.String getParent() {
107108
*
108109
*
109110
* <pre>
110-
* Required. The parent resource where this custom class will be created. Format:
111+
* Required. The parent resource where this custom class will be created.
112+
* Format:
111113
* `projects/{project}/locations/{location}/customClasses`
112114
* Speech-to-Text supports three locations: `global`, `us` (US North America),
113115
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -651,7 +653,8 @@ public Builder mergeFrom(
651653
*
652654
*
653655
* <pre>
654-
* Required. The parent resource where this custom class will be created. Format:
656+
* Required. The parent resource where this custom class will be created.
657+
* Format:
655658
* `projects/{project}/locations/{location}/customClasses`
656659
* Speech-to-Text supports three locations: `global`, `us` (US North America),
657660
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -681,7 +684,8 @@ public java.lang.String getParent() {
681684
*
682685
*
683686
* <pre>
684-
* Required. The parent resource where this custom class will be created. Format:
687+
* Required. The parent resource where this custom class will be created.
688+
* Format:
685689
* `projects/{project}/locations/{location}/customClasses`
686690
* Speech-to-Text supports three locations: `global`, `us` (US North America),
687691
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -711,7 +715,8 @@ public com.google.protobuf.ByteString getParentBytes() {
711715
*
712716
*
713717
* <pre>
714-
* Required. The parent resource where this custom class will be created. Format:
718+
* Required. The parent resource where this custom class will be created.
719+
* Format:
715720
* `projects/{project}/locations/{location}/customClasses`
716721
* Speech-to-Text supports three locations: `global`, `us` (US North America),
717722
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -740,7 +745,8 @@ public Builder setParent(java.lang.String value) {
740745
*
741746
*
742747
* <pre>
743-
* Required. The parent resource where this custom class will be created. Format:
748+
* Required. The parent resource where this custom class will be created.
749+
* Format:
744750
* `projects/{project}/locations/{location}/customClasses`
745751
* Speech-to-Text supports three locations: `global`, `us` (US North America),
746752
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -765,7 +771,8 @@ public Builder clearParent() {
765771
*
766772
*
767773
* <pre>
768-
* Required. The parent resource where this custom class will be created. Format:
774+
* Required. The parent resource where this custom class will be created.
775+
* Format:
769776
* `projects/{project}/locations/{location}/customClasses`
770777
* Speech-to-Text supports three locations: `global`, `us` (US North America),
771778
* and `eu` (Europe). If you are calling the `speech.googleapis.com`

‎java-speech/proto-google-cloud-speech-v1/src/main/java/com/google/cloud/speech/v1/CreateCustomClassRequestOrBuilder.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ public interface CreateCustomClassRequestOrBuilder
2727
*
2828
*
2929
* <pre>
30-
* Required. The parent resource where this custom class will be created. Format:
30+
* Required. The parent resource where this custom class will be created.
31+
* Format:
3132
* `projects/{project}/locations/{location}/customClasses`
3233
* Speech-to-Text supports three locations: `global`, `us` (US North America),
3334
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -47,7 +48,8 @@ public interface CreateCustomClassRequestOrBuilder
4748
*
4849
*
4950
* <pre>
50-
* Required. The parent resource where this custom class will be created. Format:
51+
* Required. The parent resource where this custom class will be created.
52+
* Format:
5153
* `projects/{project}/locations/{location}/customClasses`
5254
* Speech-to-Text supports three locations: `global`, `us` (US North America),
5355
* and `eu` (Europe). If you are calling the `speech.googleapis.com`

‎java-speech/proto-google-cloud-speech-v1/src/main/java/com/google/cloud/speech/v1/CreatePhraseSetRequest.java‎

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,8 @@ public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() {
7676
*
7777
*
7878
* <pre>
79-
* Required. The parent resource where this phrase set will be created. Format:
79+
* Required. The parent resource where this phrase set will be created.
80+
* Format:
8081
* `projects/{project}/locations/{location}/phraseSets`
8182
* Speech-to-Text supports three locations: `global`, `us` (US North America),
8283
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -107,7 +108,8 @@ public java.lang.String getParent() {
107108
*
108109
*
109110
* <pre>
110-
* Required. The parent resource where this phrase set will be created. Format:
111+
* Required. The parent resource where this phrase set will be created.
112+
* Format:
111113
* `projects/{project}/locations/{location}/phraseSets`
112114
* Speech-to-Text supports three locations: `global`, `us` (US North America),
113115
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -650,7 +652,8 @@ public Builder mergeFrom(
650652
*
651653
*
652654
* <pre>
653-
* Required. The parent resource where this phrase set will be created. Format:
655+
* Required. The parent resource where this phrase set will be created.
656+
* Format:
654657
* `projects/{project}/locations/{location}/phraseSets`
655658
* Speech-to-Text supports three locations: `global`, `us` (US North America),
656659
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -680,7 +683,8 @@ public java.lang.String getParent() {
680683
*
681684
*
682685
* <pre>
683-
* Required. The parent resource where this phrase set will be created. Format:
686+
* Required. The parent resource where this phrase set will be created.
687+
* Format:
684688
* `projects/{project}/locations/{location}/phraseSets`
685689
* Speech-to-Text supports three locations: `global`, `us` (US North America),
686690
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -710,7 +714,8 @@ public com.google.protobuf.ByteString getParentBytes() {
710714
*
711715
*
712716
* <pre>
713-
* Required. The parent resource where this phrase set will be created. Format:
717+
* Required. The parent resource where this phrase set will be created.
718+
* Format:
714719
* `projects/{project}/locations/{location}/phraseSets`
715720
* Speech-to-Text supports three locations: `global`, `us` (US North America),
716721
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -739,7 +744,8 @@ public Builder setParent(java.lang.String value) {
739744
*
740745
*
741746
* <pre>
742-
* Required. The parent resource where this phrase set will be created. Format:
747+
* Required. The parent resource where this phrase set will be created.
748+
* Format:
743749
* `projects/{project}/locations/{location}/phraseSets`
744750
* Speech-to-Text supports three locations: `global`, `us` (US North America),
745751
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -764,7 +770,8 @@ public Builder clearParent() {
764770
*
765771
*
766772
* <pre>
767-
* Required. The parent resource where this phrase set will be created. Format:
773+
* Required. The parent resource where this phrase set will be created.
774+
* Format:
768775
* `projects/{project}/locations/{location}/phraseSets`
769776
* Speech-to-Text supports three locations: `global`, `us` (US North America),
770777
* and `eu` (Europe). If you are calling the `speech.googleapis.com`

‎java-speech/proto-google-cloud-speech-v1/src/main/java/com/google/cloud/speech/v1/CreatePhraseSetRequestOrBuilder.java‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,8 @@ public interface CreatePhraseSetRequestOrBuilder
2727
*
2828
*
2929
* <pre>
30-
* Required. The parent resource where this phrase set will be created. Format:
30+
* Required. The parent resource where this phrase set will be created.
31+
* Format:
3132
* `projects/{project}/locations/{location}/phraseSets`
3233
* Speech-to-Text supports three locations: `global`, `us` (US North America),
3334
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
@@ -47,7 +48,8 @@ public interface CreatePhraseSetRequestOrBuilder
4748
*
4849
*
4950
* <pre>
50-
* Required. The parent resource where this phrase set will be created. Format:
51+
* Required. The parent resource where this phrase set will be created.
52+
* Format:
5153
* `projects/{project}/locations/{location}/phraseSets`
5254
* Speech-to-Text supports three locations: `global`, `us` (US North America),
5355
* and `eu` (Europe). If you are calling the `speech.googleapis.com`

‎java-speech/proto-google-cloud-speech-v1/src/main/java/com/google/cloud/speech/v1/PhraseSet.java‎

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@ public interface PhraseOrBuilder
110110
* boost will simply be ignored. Though `boost` can accept a wide range of
111111
* positive values, most use cases are best served
112112
* with values between 0 and 20. We recommend using a binary search approach
113-
* to finding the optimal value for your use case. Speech recognition
114-
* will skip PhraseSets with a boost value of 0.
113+
* to finding the optimal value for your use case as well as adding
114+
* phrases both with and without boost to your requests.
115115
* </pre>
116116
*
117117
* <code>float boost = 2;</code>
@@ -145,8 +145,8 @@ public interface PhraseOrBuilder
145145
* Speech-to-Text supports three locations: `global`, `us` (US North America),
146146
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
147147
* endpoint, use the `global` location. To specify a region, use a
148-
* [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or
149-
* `eu` location value.
148+
* [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
149+
* with matching `us` or `eu` location value.
150150
* </pre>
151151
*
152152
* Protobuf type {@code google.cloud.speech.v1.PhraseSet.Phrase}
@@ -255,8 +255,8 @@ public com.google.protobuf.ByteString getValueBytes() {
255255
* boost will simply be ignored. Though `boost` can accept a wide range of
256256
* positive values, most use cases are best served
257257
* with values between 0 and 20. We recommend using a binary search approach
258-
* to finding the optimal value for your use case. Speech recognition
259-
* will skip PhraseSets with a boost value of 0.
258+
* to finding the optimal value for your use case as well as adding
259+
* phrases both with and without boost to your requests.
260260
* </pre>
261261
*
262262
* <code>float boost = 2;</code>
@@ -463,8 +463,8 @@ protected Builder newBuilderForType(
463463
* Speech-to-Text supports three locations: `global`, `us` (US North America),
464464
* and `eu` (Europe). If you are calling the `speech.googleapis.com`
465465
* endpoint, use the `global` location. To specify a region, use a
466-
* [regional endpoint](/speech-to-text/docs/endpoints) with matching `us` or
467-
* `eu` location value.
466+
* [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
467+
* with matching `us` or `eu` location value.
468468
* </pre>
469469
*
470470
* Protobuf type {@code google.cloud.speech.v1.PhraseSet.Phrase}
@@ -776,8 +776,8 @@ public Builder setValueBytes(com.google.protobuf.ByteString value) {
776776
* boost will simply be ignored. Though `boost` can accept a wide range of
777777
* positive values, most use cases are best served
778778
* with values between 0 and 20. We recommend using a binary search approach
779-
* to finding the optimal value for your use case. Speech recognition
780-
* will skip PhraseSets with a boost value of 0.
779+
* to finding the optimal value for your use case as well as adding
780+
* phrases both with and without boost to your requests.
781781
* </pre>
782782
*
783783
* <code>float boost = 2;</code>
@@ -799,8 +799,8 @@ public float getBoost() {
799799
* boost will simply be ignored. Though `boost` can accept a wide range of
800800
* positive values, most use cases are best served
801801
* with values between 0 and 20. We recommend using a binary search approach
802-
* to finding the optimal value for your use case. Speech recognition
803-
* will skip PhraseSets with a boost value of 0.
802+
* to finding the optimal value for your use case as well as adding
803+
* phrases both with and without boost to your requests.
804804
* </pre>
805805
*
806806
* <code>float boost = 2;</code>
@@ -826,8 +826,8 @@ public Builder setBoost(float value) {
826826
* boost will simply be ignored. Though `boost` can accept a wide range of
827827
* positive values, most use cases are best served
828828
* with values between 0 and 20. We recommend using a binary search approach
829-
* to finding the optimal value for your use case. Speech recognition
830-
* will skip PhraseSets with a boost value of 0.
829+
* to finding the optimal value for your use case as well as adding
830+
* phrases both with and without boost to your requests.
831831
* </pre>
832832
*
833833
* <code>float boost = 2;</code>
@@ -1040,8 +1040,8 @@ public com.google.cloud.speech.v1.PhraseSet.PhraseOrBuilder getPhrasesOrBuilder(
10401040
* enabled, so negative boost will simply be ignored. Though `boost` can
10411041
* accept a wide range of positive values, most use cases are best served with
10421042
* values between 0 (exclusive) and 20. We recommend using a binary search
1043-
* approach to finding the optimal value for your use case. Speech recognition
1044-
* will skip PhraseSets with a boost value of 0.
1043+
* approach to finding the optimal value for your use case as well as adding
1044+
* phrases both with and without boost to your requests.
10451045
* </pre>
10461046
*
10471047
* <code>float boost = 4;</code>
@@ -1953,8 +1953,8 @@ public com.google.cloud.speech.v1.PhraseSet.Phrase.Builder addPhrasesBuilder(int
19531953
* enabled, so negative boost will simply be ignored. Though `boost` can
19541954
* accept a wide range of positive values, most use cases are best served with
19551955
* values between 0 (exclusive) and 20. We recommend using a binary search
1956-
* approach to finding the optimal value for your use case. Speech recognition
1957-
* will skip PhraseSets with a boost value of 0.
1956+
* approach to finding the optimal value for your use case as well as adding
1957+
* phrases both with and without boost to your requests.
19581958
* </pre>
19591959
*
19601960
* <code>float boost = 4;</code>
@@ -1976,8 +1976,8 @@ public float getBoost() {
19761976
* enabled, so negative boost will simply be ignored. Though `boost` can
19771977
* accept a wide range of positive values, most use cases are best served with
19781978
* values between 0 (exclusive) and 20. We recommend using a binary search
1979-
* approach to finding the optimal value for your use case. Speech recognition
1980-
* will skip PhraseSets with a boost value of 0.
1979+
* approach to finding the optimal value for your use case as well as adding
1980+
* phrases both with and without boost to your requests.
19811981
* </pre>
19821982
*
19831983
* <code>float boost = 4;</code>
@@ -2003,8 +2003,8 @@ public Builder setBoost(float value) {
20032003
* enabled, so negative boost will simply be ignored. Though `boost` can
20042004
* accept a wide range of positive values, most use cases are best served with
20052005
* values between 0 (exclusive) and 20. We recommend using a binary search
2006-
* approach to finding the optimal value for your use case. Speech recognition
2007-
* will skip PhraseSets with a boost value of 0.
2006+
* approach to finding the optimal value for your use case as well as adding
2007+
* phrases both with and without boost to your requests.
20082008
* </pre>
20092009
*
20102010
* <code>float boost = 4;</code>

‎java-speech/proto-google-cloud-speech-v1/src/main/java/com/google/cloud/speech/v1/PhraseSetOrBuilder.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ public interface PhraseSetOrBuilder
111111
* enabled, so negative boost will simply be ignored. Though `boost` can
112112
* accept a wide range of positive values, most use cases are best served with
113113
* values between 0 (exclusive) and 20. We recommend using a binary search
114-
* approach to finding the optimal value for your use case. Speech recognition
115-
* will skip PhraseSets with a boost value of 0.
114+
* approach to finding the optimal value for your use case as well as adding
115+
* phrases both with and without boost to your requests.
116116
* </pre>
117117
*
118118
* <code>float boost = 4;</code>

‎java-speech/proto-google-cloud-speech-v1/src/main/proto/google/cloud/speech/v1/cloud_speech_adaptation.proto‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ option objc_class_prefix = "GCS";
3434
// Service that implements Google Cloud Speech Adaptation API.
3535
service Adaptation {
3636
option (google.api.default_host) = "speech.googleapis.com";
37-
option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
37+
option (google.api.oauth_scopes) =
38+
"https://www.googleapis.com/auth/cloud-platform";
3839

3940
// Create a set of phrase hints. Each item in the set can be a single word or
4041
// a multi-word phrase. The items in the PhraseSet are favored by the
@@ -86,7 +87,8 @@ service Adaptation {
8687
post: "/v1/{parent=projects/*/locations/*}/customClasses"
8788
body: "*"
8889
};
89-
option (google.api.method_signature) = "parent,custom_class,custom_class_id";
90+
option (google.api.method_signature) =
91+
"parent,custom_class,custom_class_id";
9092
}
9193

9294
// Get a custom class.
@@ -98,7 +100,8 @@ service Adaptation {
98100
}
99101

100102
// List custom classes.
101-
rpc ListCustomClasses(ListCustomClassesRequest) returns (ListCustomClassesResponse) {
103+
rpc ListCustomClasses(ListCustomClassesRequest)
104+
returns (ListCustomClassesResponse) {
102105
option (google.api.http) = {
103106
get: "/v1/{parent=projects/*/locations/*}/customClasses"
104107
};
@@ -115,7 +118,8 @@ service Adaptation {
115118
}
116119

117120
// Delete a custom class.
118-
rpc DeleteCustomClass(DeleteCustomClassRequest) returns (google.protobuf.Empty) {
121+
rpc DeleteCustomClass(DeleteCustomClassRequest)
122+
returns (google.protobuf.Empty) {
119123
option (google.api.http) = {
120124
delete: "/v1/{name=projects/*/locations/*/customClasses/*}"
121125
};
@@ -125,7 +129,8 @@ service Adaptation {
125129

126130
// Message sent by the client for the `CreatePhraseSet` method.
127131
message CreatePhraseSetRequest {
128-
// Required. The parent resource where this phrase set will be created. Format:
132+
// Required. The parent resource where this phrase set will be created.
133+
// Format:
129134
//
130135
// `projects/{project}/locations/{location}/phraseSets`
131136
//
@@ -248,7 +253,8 @@ message DeletePhraseSetRequest {
248253

249254
// Message sent by the client for the `CreateCustomClass` method.
250255
message CreateCustomClassRequest {
251-
// Required. The parent resource where this custom class will be created. Format:
256+
// Required. The parent resource where this custom class will be created.
257+
// Format:
252258
//
253259
// `projects/{project}/locations/{location}/customClasses`
254260
//

0 commit comments

Comments
 (0)