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
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Polygon {
    /// The bounding polygon vertices.
    #[prost(message, repeated, tag = "1")]
    pub vertices: ::prost::alloc::vec::Vec<Vertex>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Vertex {
    /// X coordinate in pixels.
    #[prost(int64, tag = "1")]
    pub x: i64,
    /// Y coordinate in pixels.
    #[prost(int64, tag = "2")]
    pub y: i64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TextAnnotation {
    /// Page width in pixels.
    #[prost(int64, tag = "1")]
    pub width: i64,
    /// Page height in pixels.
    #[prost(int64, tag = "2")]
    pub height: i64,
    /// Recognized text blocks in this page.
    #[prost(message, repeated, tag = "3")]
    pub blocks: ::prost::alloc::vec::Vec<Block>,
    /// Recognized entities.
    #[prost(message, repeated, tag = "4")]
    pub entities: ::prost::alloc::vec::Vec<Entity>,
    #[prost(message, repeated, tag = "5")]
    pub tables: ::prost::alloc::vec::Vec<Table>,
    /// Full text recognized from image.
    #[prost(string, tag = "6")]
    pub full_text: ::prost::alloc::string::String,
    /// Angle of image rotation.
    #[prost(enumeration = "Angle", tag = "7")]
    pub rotate: i32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Entity {
    /// Entity name.
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    /// Recognized entity text.
    #[prost(string, tag = "2")]
    pub text: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Block {
    /// Area on the page where the text block is located.
    #[prost(message, optional, tag = "1")]
    pub bounding_box: ::core::option::Option<Polygon>,
    /// Recognized lines in this block.
    #[prost(message, repeated, tag = "2")]
    pub lines: ::prost::alloc::vec::Vec<Line>,
    /// A list of detected languages
    #[prost(message, repeated, tag = "3")]
    pub languages: ::prost::alloc::vec::Vec<block::DetectedLanguage>,
    /// Block position from full_text string.
    #[prost(message, repeated, tag = "4")]
    pub text_segments: ::prost::alloc::vec::Vec<TextSegments>,
}
/// Nested message and enum types in `Block`.
pub mod block {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Message)]
    pub struct DetectedLanguage {
        /// Detected language code.
        #[prost(string, tag = "1")]
        pub language_code: ::prost::alloc::string::String,
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Line {
    /// Area on the page where the line is located.
    #[prost(message, optional, tag = "1")]
    pub bounding_box: ::core::option::Option<Polygon>,
    /// Recognized text.
    #[prost(string, tag = "2")]
    pub text: ::prost::alloc::string::String,
    /// Recognized words.
    #[prost(message, repeated, tag = "3")]
    pub words: ::prost::alloc::vec::Vec<Word>,
    /// Line position from full_text string.
    #[prost(message, repeated, tag = "4")]
    pub text_segments: ::prost::alloc::vec::Vec<TextSegments>,
    /// Angle of line rotation.
    #[prost(enumeration = "Angle", tag = "5")]
    pub orientation: i32,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Word {
    /// Area on the page where the word is located.
    #[prost(message, optional, tag = "1")]
    pub bounding_box: ::core::option::Option<Polygon>,
    /// Recognized word value.
    #[prost(string, tag = "2")]
    pub text: ::prost::alloc::string::String,
    /// ID of the recognized word in entities array.
    #[prost(int64, tag = "3")]
    pub entity_index: i64,
    /// Word position from full_text string.
    #[prost(message, repeated, tag = "4")]
    pub text_segments: ::prost::alloc::vec::Vec<TextSegments>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TextSegments {
    /// Start character position from full_text string.
    #[prost(int64, tag = "1")]
    pub start_index: i64,
    /// Text segment length.
    #[prost(int64, tag = "2")]
    pub length: i64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Table {
    /// Area on the page where the table is located.
    #[prost(message, optional, tag = "1")]
    pub bounding_box: ::core::option::Option<Polygon>,
    /// Number of rows in table.
    #[prost(int64, tag = "2")]
    pub row_count: i64,
    /// Number of columns in table.
    #[prost(int64, tag = "3")]
    pub column_count: i64,
    /// Table cells.
    #[prost(message, repeated, tag = "4")]
    pub cells: ::prost::alloc::vec::Vec<TableCell>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TableCell {
    /// Area on the page where the table cell is located.
    #[prost(message, optional, tag = "1")]
    pub bounding_box: ::core::option::Option<Polygon>,
    /// Row index.
    #[prost(int64, tag = "2")]
    pub row_index: i64,
    /// Column index.
    #[prost(int64, tag = "3")]
    pub column_index: i64,
    /// Column span.
    #[prost(int64, tag = "4")]
    pub column_span: i64,
    /// Row span.
    #[prost(int64, tag = "5")]
    pub row_span: i64,
    /// Text in cell.
    #[prost(string, tag = "6")]
    pub text: ::prost::alloc::string::String,
    /// Table cell position from full_text string.
    #[prost(message, repeated, tag = "7")]
    pub text_segments: ::prost::alloc::vec::Vec<TextSegments>,
}
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Angle {
    Unspecified = 0,
    Angle0 = 1,
    Angle90 = 2,
    Angle180 = 3,
    Angle270 = 4,
}
impl Angle {
    /// 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 {
            Angle::Unspecified => "ANGLE_UNSPECIFIED",
            Angle::Angle0 => "ANGLE_0",
            Angle::Angle90 => "ANGLE_90",
            Angle::Angle180 => "ANGLE_180",
            Angle::Angle270 => "ANGLE_270",
        }
    }
    /// Creates an enum from field names used in the ProtoBuf definition.
    pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
        match value {
            "ANGLE_UNSPECIFIED" => Some(Self::Unspecified),
            "ANGLE_0" => Some(Self::Angle0),
            "ANGLE_90" => Some(Self::Angle90),
            "ANGLE_180" => Some(Self::Angle180),
            "ANGLE_270" => Some(Self::Angle270),
            _ => None,
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RecognizeTextRequest {
    /// Specifications of the ([MIME type](<https://en.wikipedia.org/wiki/Media_type>)). Each specification contains the file to analyze and features to use for analysis. Restrictions:
    /// * Supported file formats: `JPEG`, `PNG`, `PDF`.
    /// * Maximum file size: see \[documentation\](/docs/vision/concepts/limits).
    /// * Image size should not exceed 20M pixels (length x width).
    /// * The number of pages in a PDF file should not exceed 1.
    #[prost(string, tag = "2")]
    pub mime_type: ::prost::alloc::string::String,
    /// [List of the languages](/docs/vision/concepts/ocr/supported-languages) to recognize text.
    /// Specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `ru`).
    #[prost(string, repeated, tag = "3")]
    pub language_codes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    /// \[Model\](/docs/vision/concepts/ocr/template-recognition#models) to use for text detection.
    #[prost(string, tag = "4")]
    pub model: ::prost::alloc::string::String,
    #[prost(oneof = "recognize_text_request::Source", tags = "1")]
    pub source: ::core::option::Option<recognize_text_request::Source>,
}
/// Nested message and enum types in `RecognizeTextRequest`.
pub mod recognize_text_request {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Source {
        /// Bytes with 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 RecognizeTextResponse {
    /// Recognized text blocks in page or text from entities.
    #[prost(message, optional, tag = "1")]
    pub text_annotation: ::core::option::Option<TextAnnotation>,
    /// Page number in PDF file.
    #[prost(int64, tag = "2")]
    pub page: i64,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetRecognitionRequest {
    /// Operation ID of async recognition request.
    #[prost(string, tag = "1")]
    pub operation_id: ::prost::alloc::string::String,
}
/// Generated client implementations.
pub mod text_recognition_service_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 the Vision OCR service.
    #[derive(Debug, Clone)]
    pub struct TextRecognitionServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl TextRecognitionServiceClient<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> TextRecognitionServiceClient<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,
        ) -> TextRecognitionServiceClient<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,
        {
            TextRecognitionServiceClient::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
        }
        /// To send the image for text recognition.
        pub async fn recognize(
            &mut self,
            request: impl tonic::IntoRequest<super::RecognizeTextRequest>,
        ) -> std::result::Result<
            tonic::Response<tonic::codec::Streaming<super::RecognizeTextResponse>>,
            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(
                "/yandex.cloud.ai.ocr.v1.TextRecognitionService/Recognize",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.ocr.v1.TextRecognitionService",
                        "Recognize",
                    ),
                );
            self.inner.server_streaming(req, path, codec).await
        }
    }
}
/// Generated client implementations.
pub mod text_recognition_async_service_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 managing operations for asynchronous API requests.
    #[derive(Debug, Clone)]
    pub struct TextRecognitionAsyncServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl TextRecognitionAsyncServiceClient<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> TextRecognitionAsyncServiceClient<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,
        ) -> TextRecognitionAsyncServiceClient<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,
        {
            TextRecognitionAsyncServiceClient::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
        }
        /// To send the image for asynchronous text recognition.
        pub async fn recognize(
            &mut self,
            request: impl tonic::IntoRequest<super::RecognizeTextRequest>,
        ) -> std::result::Result<
            tonic::Response<super::super::super::super::operation::Operation>,
            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(
                "/yandex.cloud.ai.ocr.v1.TextRecognitionAsyncService/Recognize",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.ocr.v1.TextRecognitionAsyncService",
                        "Recognize",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// To get recognition results.
        pub async fn get_recognition(
            &mut self,
            request: impl tonic::IntoRequest<super::GetRecognitionRequest>,
        ) -> std::result::Result<
            tonic::Response<tonic::codec::Streaming<super::RecognizeTextResponse>>,
            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(
                "/yandex.cloud.ai.ocr.v1.TextRecognitionAsyncService/GetRecognition",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.ocr.v1.TextRecognitionAsyncService",
                        "GetRecognition",
                    ),
                );
            self.inner.server_streaming(req, path, codec).await
        }
    }
}