docs: Clarified boost usage

Google APIs · copybara-github · commit c8a382b9980b · 2023-02-01T13:21:36.000-08:00
PiperOrigin-RevId: 506405333
diff --git a/google/cloud/speech/v1/cloud_speech_adaptation.proto b/google/cloud/speech/v1/cloud_speech_adaptation.proto
@@ -34,7 +34,8 @@ option objc_class_prefix = "GCS";
 // Service that implements Google Cloud Speech Adaptation API.
 service Adaptation {
   option (google.api.default_host) = "speech.googleapis.com";
-  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
 
   // Create a set of phrase hints. Each item in the set can be a single word or
   // a multi-word phrase. The items in the PhraseSet are favored by the
@@ -86,7 +87,8 @@ service Adaptation {
       post: "/v1/{parent=projects/*/locations/*}/customClasses"
       body: "*"
     };
-    option (google.api.method_signature) = "parent,custom_class,custom_class_id";
+    option (google.api.method_signature) =
+        "parent,custom_class,custom_class_id";
   }
 
   // Get a custom class.
@@ -98,7 +100,8 @@ service Adaptation {
   }
 
   // List custom classes.
-  rpc ListCustomClasses(ListCustomClassesRequest) returns (ListCustomClassesResponse) {
+  rpc ListCustomClasses(ListCustomClassesRequest)
+      returns (ListCustomClassesResponse) {
     option (google.api.http) = {
       get: "/v1/{parent=projects/*/locations/*}/customClasses"
     };
@@ -115,7 +118,8 @@ service Adaptation {
   }
 
   // Delete a custom class.
-  rpc DeleteCustomClass(DeleteCustomClassRequest) returns (google.protobuf.Empty) {
+  rpc DeleteCustomClass(DeleteCustomClassRequest)
+      returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v1/{name=projects/*/locations/*/customClasses/*}"
     };
@@ -125,7 +129,8 @@ service Adaptation {
 
 // Message sent by the client for the `CreatePhraseSet` method.
 message CreatePhraseSetRequest {
-  // Required. The parent resource where this phrase set will be created. Format:
+  // Required. The parent resource where this phrase set will be created.
+  // Format:
   //
   // `projects/{project}/locations/{location}/phraseSets`
   //
@@ -248,7 +253,8 @@ message DeletePhraseSetRequest {
 
 // Message sent by the client for the `CreateCustomClass` method.
 message CreateCustomClassRequest {
-  // Required. The parent resource where this custom class will be created. Format:
+  // Required. The parent resource where this custom class will be created.
+  // Format:
   //
   // `projects/{project}/locations/{location}/customClasses`
   //
diff --git a/google/cloud/speech/v1/resource.proto b/google/cloud/speech/v1/resource.proto
@@ -82,8 +82,8 @@ message PhraseSet {
   // 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](/speech-to-text/docs/endpoints) with matching `us` or
-  // `eu` location value.
+  // [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+  // with matching `us` or `eu` location value.
   message Phrase {
     // The phrase itself.
     string value = 1;
@@ -95,8 +95,8 @@ message PhraseSet {
     // 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.
+    // to finding the optimal value for your use case as well as adding
+    // phrases both with and without boost to your requests.
     float boost = 2;
   }
 
@@ -113,8 +113,8 @@ message PhraseSet {
   // 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. 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.
   float boost = 4;
 }
 
diff --git a/google/cloud/speech/v1p1beta1/cloud_speech_adaptation.proto b/google/cloud/speech/v1p1beta1/cloud_speech_adaptation.proto
@@ -34,7 +34,8 @@ option objc_class_prefix = "GCS";
 // Service that implements Google Cloud Speech Adaptation API.
 service Adaptation {
   option (google.api.default_host) = "speech.googleapis.com";
-  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
+  option (google.api.oauth_scopes) =
+      "https://www.googleapis.com/auth/cloud-platform";
 
   // Create a set of phrase hints. Each item in the set can be a single word or
   // a multi-word phrase. The items in the PhraseSet are favored by the
@@ -86,7 +87,8 @@ service Adaptation {
       post: "/v1p1beta1/{parent=projects/*/locations/*}/customClasses"
       body: "*"
     };
-    option (google.api.method_signature) = "parent,custom_class,custom_class_id";
+    option (google.api.method_signature) =
+        "parent,custom_class,custom_class_id";
   }
 
   // Get a custom class.
@@ -98,7 +100,8 @@ service Adaptation {
   }
 
   // List custom classes.
-  rpc ListCustomClasses(ListCustomClassesRequest) returns (ListCustomClassesResponse) {
+  rpc ListCustomClasses(ListCustomClassesRequest)
+      returns (ListCustomClassesResponse) {
     option (google.api.http) = {
       get: "/v1p1beta1/{parent=projects/*/locations/*}/customClasses"
     };
@@ -115,7 +118,8 @@ service Adaptation {
   }
 
   // Delete a custom class.
-  rpc DeleteCustomClass(DeleteCustomClassRequest) returns (google.protobuf.Empty) {
+  rpc DeleteCustomClass(DeleteCustomClassRequest)
+      returns (google.protobuf.Empty) {
     option (google.api.http) = {
       delete: "/v1p1beta1/{name=projects/*/locations/*/customClasses/*}"
     };
@@ -125,7 +129,8 @@ service Adaptation {
 
 // Message sent by the client for the `CreatePhraseSet` method.
 message CreatePhraseSetRequest {
-  // Required. The parent resource where this phrase set will be created. Format:
+  // Required. The parent resource where this phrase set will be created.
+  // Format:
   //
   // `projects/{project}/locations/{location}/phraseSets`
   //
@@ -248,7 +253,8 @@ message DeletePhraseSetRequest {
 
 // Message sent by the client for the `CreateCustomClass` method.
 message CreateCustomClassRequest {
-  // Required. The parent resource where this custom class will be created. Format:
+  // Required. The parent resource where this custom class will be created.
+  // Format:
   //
   // `projects/{project}/locations/{location}/customClasses`
   //
diff --git a/google/cloud/speech/v1p1beta1/resource.proto b/google/cloud/speech/v1p1beta1/resource.proto
@@ -82,8 +82,8 @@ message PhraseSet {
   // 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](/speech-to-text/docs/endpoints) with matching `us` or
-  // `eu` location value.
+  // [regional endpoint](https://cloud.google.com/speech-to-text/docs/endpoints)
+  // with matching `us` or `eu` location value.
   message Phrase {
     // The phrase itself.
     string value = 1;
