feat: promote CustomVoiceParams to v1

Google APIs · copybara-github · commit 9916192ab15e · 2022-03-10T12:55:25.000-08:00
PiperOrigin-RevId: 433829087
diff --git a/google/cloud/texttospeech/v1/cloud_tts.proto b/google/cloud/texttospeech/v1/cloud_tts.proto
@@ -1,4 +1,4 @@
-// Copyright 2021 Google LLC
+// Copyright 2022 Google LLC
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -58,19 +58,6 @@ service TextToSpeech {
   }
 }
 
-// The top-level message sent by the client for the `ListVoices` method.
-message ListVoicesRequest {
-  // Optional. Recommended.
-  // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
-  // If not specified, the API will return all supported voices.
-  // If specified, the ListVoices call will only return voices that can be used
-  // to synthesize this language_code. For example, if you specify `"en-NZ"`,
-  // all `"en-NZ"` voices will be returned. If you specify `"no"`, both
-  // `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be
-  // returned.
-  string language_code = 1 [(google.api.field_behavior) = OPTIONAL];
-}
-
 // Gender of the voice as described in
 // [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).
 enum SsmlVoiceGender {
@@ -119,6 +106,19 @@ enum AudioEncoding {
   ALAW = 6;
 }
 
+// The top-level message sent by the client for the `ListVoices` method.
+message ListVoicesRequest {
+  // Optional. Recommended.
+  // [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag.
+  // If not specified, the API will return all supported voices.
+  // If specified, the ListVoices call will only return voices that can be used
+  // to synthesize this language_code. For example, if you specify `"en-NZ"`,
+  // all `"en-NZ"` voices will be returned. If you specify `"no"`, both
+  // `"no-\*"` (Norwegian) and `"nb-\*"` (Norwegian Bokmal) voices will be
+  // returned.
+  string language_code = 1 [(google.api.field_behavior) = OPTIONAL];
+}
+
 // The message returned to the client by the `ListVoices` method.
 message ListVoicesResponse {
   // The list of voices.
@@ -197,6 +197,11 @@ message VoiceSelectionParams {
   // voice of the appropriate gender is not available, the synthesizer should
   // substitute a voice with a different gender rather than failing the request.
   SsmlVoiceGender ssml_gender = 3;
+
+  // The configuration for a custom voice. If [CustomVoiceParams.model] is set,
+  // the service will choose the custom voice matching the specified
+  // configuration.
+  CustomVoiceParams custom_voice = 4;
 }
 
 // Description of audio data to be synthesized.
@@ -255,6 +260,37 @@ message AudioConfig {
   ];
 }
 
+// Description of the custom voice to be synthesized.
+message CustomVoiceParams {
+  // The usage of the synthesized audio. You must report your honest and
+  // correct usage of the service as it's regulated by contract and will cause
+  // significant difference in billing.
+  enum ReportedUsage {
+    // Request with reported usage unspecified will be rejected.
+    REPORTED_USAGE_UNSPECIFIED = 0;
+
+    // For scenarios where the synthesized audio is not downloadable and can
+    // only be used once. For example, real-time request in IVR system.
+    REALTIME = 1;
+
+    // For scenarios where the synthesized audio is downloadable and can be
+    // reused. For example, the synthesized audio is downloaded, stored in
+    // customer service system and played repeatedly.
+    OFFLINE = 2;
+  }
+
+  // Required. The name of the AutoML model that synthesizes the custom voice.
+  string model = 1 [
+    (google.api.field_behavior) = REQUIRED,
+    (google.api.resource_reference) = {
+      type: "automl.googleapis.com/Model"
+    }
+  ];
+
+  // Optional. The usage of the synthesized audio to be reported.
+  ReportedUsage reported_usage = 3 [(google.api.field_behavior) = OPTIONAL];
+}
+
 // The message returned to the client by the `SynthesizeSpeech` method.
 message SynthesizeSpeechResponse {
   // The audio data bytes encoded as specified in the request, including the
