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
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ClassAnnotation {
    /// Properties extracted by a specified model.
    ///
    /// For example, if you ask to evaluate the image quality,
    /// the service could return such properties as `good` and `bad`.
    #[prost(message, repeated, tag = "1")]
    pub properties: ::prost::alloc::vec::Vec<Property>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Property {
    /// Property name.
    #[prost(string, tag = "1")]
    pub name: ::prost::alloc::string::String,
    /// Probability of the property, from 0 to 1.
    #[prost(double, tag = "2")]
    pub probability: f64,
}
#[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 FaceAnnotation {
    /// An array of detected faces for the specified image.
    #[prost(message, repeated, tag = "1")]
    pub faces: ::prost::alloc::vec::Vec<Face>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Face {
    /// Area on the image where the face is located.
    #[prost(message, optional, tag = "1")]
    pub bounding_box: ::core::option::Option<Polygon>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ImageCopySearchAnnotation {
    /// Number of image copies
    #[prost(int64, tag = "1")]
    pub copy_count: i64,
    /// Top relevance result of image copy search
    #[prost(message, repeated, tag = "2")]
    pub top_results: ::prost::alloc::vec::Vec<CopyMatch>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CopyMatch {
    /// url of image
    #[prost(string, tag = "1")]
    pub image_url: ::prost::alloc::string::String,
    /// url of page that contains image
    #[prost(string, tag = "2")]
    pub page_url: ::prost::alloc::string::String,
    /// page title that contains image
    #[prost(string, tag = "3")]
    pub title: ::prost::alloc::string::String,
    /// image description
    #[prost(string, tag = "4")]
    pub description: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TextAnnotation {
    /// Pages of the recognized file.
    ///
    /// For JPEG and PNG files contains only 1 page.
    #[prost(message, repeated, tag = "1")]
    pub pages: ::prost::alloc::vec::Vec<Page>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Page {
    /// 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>,
}
#[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>,
}
#[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 words in this line.
    #[prost(message, repeated, tag = "2")]
    pub words: ::prost::alloc::vec::Vec<Word>,
    /// Confidence of the OCR results for the line. Range [0, 1].
    #[prost(double, tag = "3")]
    pub confidence: f64,
}
#[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,
    /// Confidence of the OCR results for the word. Range [0, 1].
    #[prost(double, tag = "3")]
    pub confidence: f64,
    /// A list of detected languages together with confidence.
    #[prost(message, repeated, tag = "4")]
    pub languages: ::prost::alloc::vec::Vec<word::DetectedLanguage>,
    /// Id of recognized word in entities array
    #[prost(int64, tag = "5")]
    pub entity_index: i64,
}
/// Nested message and enum types in `Word`.
pub mod word {
    #[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,
        /// Confidence of detected language. Range [0, 1].
        #[prost(double, tag = "2")]
        pub confidence: f64,
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchAnalyzeRequest {
    /// A list of specifications. Each specification contains the file to analyze and features to use for analysis.
    ///
    /// Restrictions:
    /// * Supported file formats: `JPEG`, `PNG`.
    /// * Maximum file size: 1 MB.
    /// * Image size should not exceed 20M pixels (length x width).
    #[prost(message, repeated, tag = "1")]
    pub analyze_specs: ::prost::alloc::vec::Vec<AnalyzeSpec>,
    /// ID of the folder to which you have access.
    /// Required for authorization with a user account (see \[yandex.cloud.iam.v1.UserAccount\] resource).
    /// Don't specify this field if you make the request on behalf of a service account.
    #[prost(string, tag = "2")]
    pub folder_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AnalyzeSpec {
    /// Requested features to use for analysis.
    ///
    /// Max count of requested features for one file is 8.
    #[prost(message, repeated, tag = "3")]
    pub features: ::prost::alloc::vec::Vec<Feature>,
    /// [MIME type](<https://en.wikipedia.org/wiki/Media_type>) of content (for example, `` application/pdf ``).
    #[prost(string, tag = "4")]
    pub mime_type: ::prost::alloc::string::String,
    #[prost(oneof = "analyze_spec::Source", tags = "1, 5")]
    pub source: ::core::option::Option<analyze_spec::Source>,
}
/// Nested message and enum types in `AnalyzeSpec`.
pub mod analyze_spec {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Source {
        /// Image content, represented as a stream of bytes.
        /// Note: As with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
        #[prost(bytes, tag = "1")]
        Content(::prost::alloc::vec::Vec<u8>),
        #[prost(string, tag = "5")]
        Signature(::prost::alloc::string::String),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Feature {
    /// Type of requested feature.
    #[prost(enumeration = "feature::Type", tag = "1")]
    pub r#type: i32,
    #[prost(oneof = "feature::Config", tags = "2, 3")]
    pub config: ::core::option::Option<feature::Config>,
}
/// Nested message and enum types in `Feature`.
pub mod feature {
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum Type {
        Unspecified = 0,
        /// Text detection (OCR) feature.
        TextDetection = 1,
        /// Classification feature.
        Classification = 2,
        /// Face detection feature.
        FaceDetection = 3,
        /// Image copy search.
        ImageCopySearch = 4,
    }
    impl Type {
        /// 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 {
                Type::Unspecified => "TYPE_UNSPECIFIED",
                Type::TextDetection => "TEXT_DETECTION",
                Type::Classification => "CLASSIFICATION",
                Type::FaceDetection => "FACE_DETECTION",
                Type::ImageCopySearch => "IMAGE_COPY_SEARCH",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "TYPE_UNSPECIFIED" => Some(Self::Unspecified),
                "TEXT_DETECTION" => Some(Self::TextDetection),
                "CLASSIFICATION" => Some(Self::Classification),
                "FACE_DETECTION" => Some(Self::FaceDetection),
                "IMAGE_COPY_SEARCH" => Some(Self::ImageCopySearch),
                _ => None,
            }
        }
    }
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Config {
        /// Required for the `CLASSIFICATION` type. Specifies configuration for the classification feature.
        #[prost(message, tag = "2")]
        ClassificationConfig(super::FeatureClassificationConfig),
        /// Required for the `TEXT_DETECTION` type. Specifies configuration for the text detection (OCR) feature.
        #[prost(message, tag = "3")]
        TextDetectionConfig(super::FeatureTextDetectionConfig),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureClassificationConfig {
    /// Model to use for image classification.
    #[prost(string, tag = "1")]
    pub model: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureTextDetectionConfig {
    /// List of the 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 = "1")]
    pub language_codes: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    /// Model to use for text detection.
    /// Possible values:
    /// * `page` (default): this model is suitable for detecting multiple text entries in an image.
    /// * `line`: this model is suitable for cropped images with one line of text.
    #[prost(string, tag = "2")]
    pub model: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BatchAnalyzeResponse {
    /// Request results.
    /// Results have the same order as specifications in the request.
    #[prost(message, repeated, tag = "1")]
    pub results: ::prost::alloc::vec::Vec<AnalyzeResult>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AnalyzeResult {
    /// Results for each requested feature.
    /// Feature results have the same order as in the request.
    #[prost(message, repeated, tag = "2")]
    pub results: ::prost::alloc::vec::Vec<FeatureResult>,
    /// Return error in case of error with file processing.
    #[prost(message, optional, tag = "1")]
    pub error: ::core::option::Option<
        super::super::super::super::super::google::rpc::Status,
    >,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FeatureResult {
    /// Return error in case of error during the specified feature processing.
    #[prost(message, optional, tag = "1")]
    pub error: ::core::option::Option<
        super::super::super::super::super::google::rpc::Status,
    >,
    #[prost(oneof = "feature_result::Feature", tags = "2, 3, 4, 5")]
    pub feature: ::core::option::Option<feature_result::Feature>,
}
/// Nested message and enum types in `FeatureResult`.
pub mod feature_result {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum Feature {
        /// Text detection (OCR) result.
        #[prost(message, tag = "2")]
        TextDetection(super::TextAnnotation),
        /// Classification result.
        #[prost(message, tag = "3")]
        Classification(super::ClassAnnotation),
        /// Face detection result.
        #[prost(message, tag = "4")]
        FaceDetection(super::FaceAnnotation),
        /// Image Copy Search result.
        #[prost(message, tag = "5")]
        ImageCopySearch(super::ImageCopySearchAnnotation),
    }
}
/// Generated client implementations.
pub mod vision_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 service.
    #[derive(Debug, Clone)]
    pub struct VisionServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl VisionServiceClient<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> VisionServiceClient<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,
        ) -> VisionServiceClient<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,
        {
            VisionServiceClient::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
        }
        /// Analyzes a batch of images and returns results with annotations.
        pub async fn batch_analyze(
            &mut self,
            request: impl tonic::IntoRequest<super::BatchAnalyzeRequest>,
        ) -> std::result::Result<
            tonic::Response<super::BatchAnalyzeResponse>,
            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.vision.v1.VisionService/BatchAnalyze",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.vision.v1.VisionService",
                        "BatchAnalyze",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}