yandex-cloud 2025.4.14

Generated gRPC clients for the Yandex Cloud API
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudioContent {
    /// Description of the audio format.
    #[prost(message, optional, tag = "2")]
    pub audio_spec: ::core::option::Option<AudioFormatOptions>,
    /// The audio source to read the data from.
    #[prost(oneof = "audio_content::AudioSource", tags = "1")]
    pub audio_source: ::core::option::Option<audio_content::AudioSource>,
}
/// Nested message and enum types in `AudioContent`.
pub mod audio_content {
    /// The audio source to read the data from.
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum AudioSource {
        /// Bytes with audio data.
        #[prost(bytes, tag = "1")]
        Content(::prost::alloc::vec::Vec<u8>),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudioFormatOptions {
    #[prost(oneof = "audio_format_options::AudioFormat", tags = "1, 2")]
    pub audio_format: ::core::option::Option<audio_format_options::AudioFormat>,
}
/// Nested message and enum types in `AudioFormatOptions`.
pub mod audio_format_options {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum AudioFormat {
        /// The audio format specified in request parameters.
        #[prost(message, tag = "1")]
        RawAudio(super::RawAudio),
        /// The audio format specified inside the container metadata.
        #[prost(message, tag = "2")]
        ContainerAudio(super::ContainerAudio),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RawAudio {
    /// Encoding type.
    #[prost(enumeration = "raw_audio::AudioEncoding", tag = "1")]
    pub audio_encoding: i32,
    /// Sampling frequency of the signal.
    #[prost(int64, tag = "2")]
    pub sample_rate_hertz: i64,
}
/// Nested message and enum types in `RawAudio`.
pub mod raw_audio {
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum AudioEncoding {
        Unspecified = 0,
        /// Audio bit depth 16-bit signed little-endian (Linear PCM).
        Linear16Pcm = 1,
    }
    impl AudioEncoding {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                AudioEncoding::Unspecified => "AUDIO_ENCODING_UNSPECIFIED",
                AudioEncoding::Linear16Pcm => "LINEAR16_PCM",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "AUDIO_ENCODING_UNSPECIFIED" => Some(Self::Unspecified),
                "LINEAR16_PCM" => Some(Self::Linear16Pcm),
                _ => None,
            }
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ContainerAudio {
    #[prost(enumeration = "container_audio::ContainerAudioType", tag = "1")]
    pub container_audio_type: i32,
}
/// Nested message and enum types in `ContainerAudio`.
pub mod container_audio {
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum ContainerAudioType {
        Unspecified = 0,
        /// Audio bit depth 16-bit signed little-endian (Linear PCM).
        Wav = 1,
        /// Data is encoded using the OPUS audio codec and compressed using the OGG container format.
        OggOpus = 2,
        /// Data is encoded using MPEG-1/2 Layer III and compressed using the MP3 container format.
        Mp3 = 3,
    }
    impl ContainerAudioType {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                ContainerAudioType::Unspecified => "CONTAINER_AUDIO_TYPE_UNSPECIFIED",
                ContainerAudioType::Wav => "WAV",
                ContainerAudioType::OggOpus => "OGG_OPUS",
                ContainerAudioType::Mp3 => "MP3",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "CONTAINER_AUDIO_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
                "WAV" => Some(Self::Wav),
                "OGG_OPUS" => Some(Self::OggOpus),
                "MP3" => Some(Self::Mp3),
                _ => None,
            }
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TextVariable {
    /// The name of the variable.
    #[prost(string, tag = "1")]
    pub variable_name: ::prost::alloc::string::String,
    /// The text of the variable.
    #[prost(string, tag = "2")]
    pub variable_value: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudioVariable {
    /// The name of the variable.
    #[prost(string, tag = "1")]
    pub variable_name: ::prost::alloc::string::String,
    /// Start time of the variable in milliseconds.
    #[prost(int64, tag = "2")]
    pub variable_start_ms: i64,
    /// Length of the variable in milliseconds.
    #[prost(int64, tag = "3")]
    pub variable_length_ms: i64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UtteranceSynthesisResponse {
    /// Part of synthesized audio.
    #[prost(message, optional, tag = "1")]
    pub audio_chunk: ::core::option::Option<AudioChunk>,
    /// Part of synthesized text.
    #[prost(message, optional, tag = "2")]
    pub text_chunk: ::core::option::Option<TextChunk>,
    /// Start time of the audio chunk in milliseconds.
    #[prost(int64, tag = "3")]
    pub start_ms: i64,
    /// Length of the audio chunk in milliseconds.
    #[prost(int64, tag = "4")]
    pub length_ms: i64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudioTemplate {
    /// Audio file.
    #[prost(message, optional, tag = "1")]
    pub audio: ::core::option::Option<AudioContent>,
    /// Template and description of its variables.
    #[prost(message, optional, tag = "2")]
    pub text_template: ::core::option::Option<TextTemplate>,
    /// Describing variables in audio.
    #[prost(message, repeated, tag = "3")]
    pub variables: ::prost::alloc::vec::Vec<AudioVariable>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AudioChunk {
    /// Sequence of bytes of the synthesized audio in format specified in output_audio_spec.
    #[prost(bytes = "vec", tag = "1")]
    pub data: ::prost::alloc::vec::Vec<u8>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TextChunk {
    /// Synthesized text.
    #[prost(string, tag = "1")]
    pub text: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TextTemplate {
    /// Template text.
    ///
    /// Sample:`The {animal} goes to the {place}.`
    #[prost(string, tag = "1")]
    pub text_template: ::prost::alloc::string::String,
    /// Defining variables in template text.
    ///
    /// Sample: `{animal: cat, place: forest}`
    #[prost(message, repeated, tag = "2")]
    pub variables: ::prost::alloc::vec::Vec<TextVariable>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DurationHint {
    /// Type of duration constraint.
    #[prost(enumeration = "duration_hint::DurationHintPolicy", tag = "1")]
    pub policy: i32,
    /// Constraint on audio duration in milliseconds.
    #[prost(int64, tag = "2")]
    pub duration_ms: i64,
}
/// Nested message and enum types in `DurationHint`.
pub mod duration_hint {
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum DurationHintPolicy {
        Unspecified = 0,
        /// Limit audio duration to exact value.
        ExactDuration = 1,
        /// Limit the minimum audio duration.
        MinDuration = 2,
        /// Limit the maximum audio duration.
        MaxDuration = 3,
    }
    impl DurationHintPolicy {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                DurationHintPolicy::Unspecified => "DURATION_HINT_POLICY_UNSPECIFIED",
                DurationHintPolicy::ExactDuration => "EXACT_DURATION",
                DurationHintPolicy::MinDuration => "MIN_DURATION",
                DurationHintPolicy::MaxDuration => "MAX_DURATION",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "DURATION_HINT_POLICY_UNSPECIFIED" => Some(Self::Unspecified),
                "EXACT_DURATION" => Some(Self::ExactDuration),
                "MIN_DURATION" => Some(Self::MinDuration),
                "MAX_DURATION" => Some(Self::MaxDuration),
                _ => None,
            }
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Hints {
    /// The hint for TTS engine to specify synthesised audio characteristics.
    #[prost(oneof = "hints::Hint", tags = "1, 2, 3, 4, 5, 6, 7")]
    pub hint: ::core::option::Option<hints::Hint>,
}
/// Nested message and enum types in `Hints`.
pub mod hints {
    /// The hint for TTS engine to specify synthesised audio characteristics.
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Hint {
        /// Name of speaker to use.
        #[prost(string, tag = "1")]
        Voice(::prost::alloc::string::String),
        /// Template for synthesizing.
        #[prost(message, tag = "2")]
        AudioTemplate(super::AudioTemplate),
        /// Hint to change speed.
        #[prost(double, tag = "3")]
        Speed(f64),
        /// Hint to regulate normalization level.
        /// * For `MAX_PEAK` loudness_normalization_type: volume changes in a range (0;1], default value is 0.7.
        /// * For `LUFS` loudness_normalization_type: volume changes in a range [-145;0), default value is -19.
        #[prost(double, tag = "4")]
        Volume(f64),
        /// Hint to specify pronunciation character for the speaker.
        #[prost(string, tag = "5")]
        Role(::prost::alloc::string::String),
        /// Hint to increase (or decrease) speaker's pitch, measured in Hz. Valid values are in range \[-1000;1000\], default value is 0.
        #[prost(double, tag = "6")]
        PitchShift(f64),
        /// Hint to limit both minimum and maximum audio duration.
        #[prost(message, tag = "7")]
        Duration(super::DurationHint),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UtteranceSynthesisRequest {
    /// The name of the model.
    /// Specifies basic synthesis functionality. Currently should be empty. Do not use it.
    #[prost(string, tag = "1")]
    pub model: ::prost::alloc::string::String,
    /// Optional hints for synthesis.
    #[prost(message, repeated, tag = "4")]
    pub hints: ::prost::alloc::vec::Vec<Hints>,
    /// Optional. Default: 22050 Hz, linear 16-bit signed little-endian PCM, with WAV header
    #[prost(message, optional, tag = "5")]
    pub output_audio_spec: ::core::option::Option<AudioFormatOptions>,
    /// Specifies type of loudness normalization.
    /// Optional. Default: `LUFS`.
    #[prost(
        enumeration = "utterance_synthesis_request::LoudnessNormalizationType",
        tag = "6"
    )]
    pub loudness_normalization_type: i32,
    /// Optional. Automatically split long text to several utterances and bill accordingly. Some degradation in service quality is possible.
    #[prost(bool, tag = "7")]
    pub unsafe_mode: bool,
    /// Text to synthesis, one of text synthesis markups.
    #[prost(oneof = "utterance_synthesis_request::Utterance", tags = "2, 3")]
    pub utterance: ::core::option::Option<utterance_synthesis_request::Utterance>,
}
/// Nested message and enum types in `UtteranceSynthesisRequest`.
pub mod utterance_synthesis_request {
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum LoudnessNormalizationType {
        Unspecified = 0,
        /// The type of normalization, wherein the gain is changed to bring the highest PCM sample value or analog signal peak to a given level.
        MaxPeak = 1,
        /// The type of normalization based on EBU R 128 recommendation.
        Lufs = 2,
    }
    impl LoudnessNormalizationType {
        /// String value of the enum field names used in the ProtoBuf definition.
        ///
        /// The values are not transformed in any way and thus are considered stable
        /// (if the ProtoBuf definition does not change) and safe for programmatic use.
        pub fn as_str_name(&self) -> &'static str {
            match self {
                LoudnessNormalizationType::Unspecified => {
                    "LOUDNESS_NORMALIZATION_TYPE_UNSPECIFIED"
                }
                LoudnessNormalizationType::MaxPeak => "MAX_PEAK",
                LoudnessNormalizationType::Lufs => "LUFS",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "LOUDNESS_NORMALIZATION_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
                "MAX_PEAK" => Some(Self::MaxPeak),
                "LUFS" => Some(Self::Lufs),
                _ => None,
            }
        }
    }
    /// Text to synthesis, one of text synthesis markups.
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Utterance {
        /// Raw text (e.g. "Hello, Alice").
        #[prost(string, tag = "2")]
        Text(::prost::alloc::string::String),
        /// Text template instance, e.g. `{"Hello, {username}" with username="Alice"}`.
        #[prost(message, tag = "3")]
        TextTemplate(super::TextTemplate),
    }
}
/// Generated client implementations.
pub mod synthesizer_client {
    #![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
    use tonic::codegen::*;
    use tonic::codegen::http::Uri;
    /// A set of methods for voice synthesis.
    #[derive(Debug, Clone)]
    pub struct SynthesizerClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl SynthesizerClient<tonic::transport::Channel> {
        /// Attempt to create a new client by connecting to a given endpoint.
        pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
        where
            D: TryInto<tonic::transport::Endpoint>,
            D::Error: Into<StdError>,
        {
            let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
            Ok(Self::new(conn))
        }
    }
    impl<T> SynthesizerClient<T>
    where
        T: tonic::client::GrpcService<tonic::body::BoxBody>,
        T::Error: Into<StdError>,
        T::ResponseBody: Body<Data = Bytes> + Send + 'static,
        <T::ResponseBody as Body>::Error: Into<StdError> + Send,
    {
        pub fn new(inner: T) -> Self {
            let inner = tonic::client::Grpc::new(inner);
            Self { inner }
        }
        pub fn with_origin(inner: T, origin: Uri) -> Self {
            let inner = tonic::client::Grpc::with_origin(inner, origin);
            Self { inner }
        }
        pub fn with_interceptor<F>(
            inner: T,
            interceptor: F,
        ) -> SynthesizerClient<InterceptedService<T, F>>
        where
            F: tonic::service::Interceptor,
            T::ResponseBody: Default,
            T: tonic::codegen::Service<
                http::Request<tonic::body::BoxBody>,
                Response = http::Response<
                    <T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
                >,
            >,
            <T as tonic::codegen::Service<
                http::Request<tonic::body::BoxBody>,
            >>::Error: Into<StdError> + Send + Sync,
        {
            SynthesizerClient::new(InterceptedService::new(inner, interceptor))
        }
        /// Compress requests with the given encoding.
        ///
        /// This requires the server to support it otherwise it might respond with an
        /// error.
        #[must_use]
        pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.send_compressed(encoding);
            self
        }
        /// Enable decompressing responses.
        #[must_use]
        pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
            self.inner = self.inner.accept_compressed(encoding);
            self
        }
        /// Limits the maximum size of a decoded message.
        ///
        /// Default: `4MB`
        #[must_use]
        pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_decoding_message_size(limit);
            self
        }
        /// Limits the maximum size of an encoded message.
        ///
        /// Default: `usize::MAX`
        #[must_use]
        pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
            self.inner = self.inner.max_encoding_message_size(limit);
            self
        }
        /// Synthesizing text into speech.
        pub async fn utterance_synthesis(
            &mut self,
            request: impl tonic::IntoRequest<super::UtteranceSynthesisRequest>,
        ) -> std::result::Result<
            tonic::Response<tonic::codec::Streaming<super::UtteranceSynthesisResponse>>,
            tonic::Status,
        > {
            self.inner
                .ready()
                .await
                .map_err(|e| {
                    tonic::Status::new(
                        tonic::Code::Unknown,
                        format!("Service was not ready: {}", e.into()),
                    )
                })?;
            let codec = tonic::codec::ProstCodec::default();
            let path = http::uri::PathAndQuery::from_static(
                "/speechkit.tts.v3.Synthesizer/UtteranceSynthesis",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new("speechkit.tts.v3.Synthesizer", "UtteranceSynthesis"),
                );
            self.inner.server_streaming(req, path, codec).await
        }
    }
}