yandex-cloud 2025.4.14

Generated gRPC clients for the Yandex Cloud API
Documentation
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TranslatedText {
    /// Translated text.
    #[prost(string, tag = "1")]
    pub text: ::prost::alloc::string::String,
    /// The language code of the source text.
    /// Most languages are specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `` ru ``), but the field are not limited to it.
    #[prost(string, tag = "2")]
    pub detected_language_code: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Language {
    /// The language code.
    /// Most languages are specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `` ru ``), but the field are not limited to it.
    #[prost(string, tag = "1")]
    pub code: ::prost::alloc::string::String,
    /// The name of the language (for example, `` English ``).
    #[prost(string, tag = "2")]
    pub name: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TranslateRequest {
    /// The text language to translate from.
    /// Most languages are specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `` ru ``), but the field are not limited to it.
    ///
    /// Required for translating with \[glossary\](/docs/translate/concepts/glossary).
    #[prost(string, tag = "1")]
    pub source_language_code: ::prost::alloc::string::String,
    /// The target language to translate the text.
    /// Most languages are specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `` ru ``), but the field are not limited to it.
    #[prost(string, tag = "2")]
    pub target_language_code: ::prost::alloc::string::String,
    /// Format of the text to be translated.
    #[prost(enumeration = "translate_request::Format", tag = "3")]
    pub format: i32,
    /// Array of the strings to translate.
    /// The maximum total length of all strings is 10000 characters.
    #[prost(string, repeated, tag = "4")]
    pub texts: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    /// ID of the folder to which you have access.
    /// Required for authorization with a [user account](/docs/iam/concepts/users/accounts).
    /// Do not specify this field if you make the request on behalf of a [service account](/docs/iam/concepts/users/accounts#sa).
    #[prost(string, tag = "5")]
    pub folder_id: ::prost::alloc::string::String,
    /// Model ID if you use custom model.
    #[prost(string, tag = "6")]
    pub model: ::prost::alloc::string::String,
    /// Glossary to be applied for the translation. For more information, see \[Glossaries\](/docs/translate/concepts/glossary).
    #[prost(message, optional, tag = "7")]
    pub glossary_config: ::core::option::Option<TranslateGlossaryConfig>,
    /// Enable spell checking.
    #[prost(bool, tag = "8")]
    pub speller: bool,
}
/// Nested message and enum types in `TranslateRequest`.
pub mod translate_request {
    #[derive(
        Clone,
        Copy,
        Debug,
        PartialEq,
        Eq,
        Hash,
        PartialOrd,
        Ord,
        ::prost::Enumeration
    )]
    #[repr(i32)]
    pub enum Format {
        Unspecified = 0,
        /// Text without markup. Default value.
        PlainText = 1,
        /// Text in the HTML format.
        Html = 2,
    }
    impl Format {
        /// 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 {
                Format::Unspecified => "FORMAT_UNSPECIFIED",
                Format::PlainText => "PLAIN_TEXT",
                Format::Html => "HTML",
            }
        }
        /// Creates an enum from field names used in the ProtoBuf definition.
        pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
            match value {
                "FORMAT_UNSPECIFIED" => Some(Self::Unspecified),
                "PLAIN_TEXT" => Some(Self::PlainText),
                "HTML" => Some(Self::Html),
                _ => None,
            }
        }
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TranslateGlossaryConfig {
    #[prost(oneof = "translate_glossary_config::GlossarySource", tags = "1")]
    pub glossary_source: ::core::option::Option<
        translate_glossary_config::GlossarySource,
    >,
}
/// Nested message and enum types in `TranslateGlossaryConfig`.
pub mod translate_glossary_config {
    #[allow(clippy::derive_partial_eq_without_eq)]
    #[derive(Clone, PartialEq, ::prost::Oneof)]
    pub enum GlossarySource {
        /// Pass glossary data in the request. Currently, the only way to pass glossary.
        #[prost(message, tag = "1")]
        GlossaryData(super::GlossaryData),
    }
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GlossaryData {
    /// Array of text pairs.
    ///
    /// The maximum total length of all source texts is 10000 characters.
    /// The maximum total length of all translated texts is 10000 characters.
    #[prost(message, repeated, tag = "1")]
    pub glossary_pairs: ::prost::alloc::vec::Vec<GlossaryPair>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GlossaryPair {
    /// Text in the source language.
    #[prost(string, tag = "1")]
    pub source_text: ::prost::alloc::string::String,
    /// Text in the target language.
    #[prost(string, tag = "2")]
    pub translated_text: ::prost::alloc::string::String,
    /// Allows to add translations for specific terms to \[neuroglossaries\](/docs/translate/concepts/glossary#word-forms).
    #[prost(bool, tag = "3")]
    pub exact: bool,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct TranslateResponse {
    /// Array of the translations.
    #[prost(message, repeated, tag = "1")]
    pub translations: ::prost::alloc::vec::Vec<TranslatedText>,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DetectLanguageRequest {
    /// The text to detect the language for.
    #[prost(string, tag = "1")]
    pub text: ::prost::alloc::string::String,
    /// List of the most likely languages. These languages will be given preference when detecting the text language.
    /// Most languages are specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `` ru ``), but the field are not limited to it.
    ///
    /// To get the list of supported languages, use a \[TranslationService.ListLanguages\] request.
    #[prost(string, repeated, tag = "2")]
    pub language_code_hints: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
    /// 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 = "3")]
    pub folder_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DetectLanguageResponse {
    /// Most languages are specified in [ISO 639-1](<https://en.wikipedia.org/wiki/ISO_639-1>) format (for example, `` ru ``), but the field are not limited to it.
    ///
    /// To get the language name, use a \[TranslationService.ListLanguages\] request.
    #[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 ListLanguagesRequest {
    /// ID of the folder to which you have access.
    /// Required for authorization with a [user account](/docs/iam/concepts/users/accounts).
    /// Do not specify this field if you make the request on behalf of a [service account](/docs/iam/concepts/users/accounts#sa).
    #[prost(string, tag = "1")]
    pub folder_id: ::prost::alloc::string::String,
}
#[allow(clippy::derive_partial_eq_without_eq)]
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListLanguagesResponse {
    /// List of supported languages.
    #[prost(message, repeated, tag = "1")]
    pub languages: ::prost::alloc::vec::Vec<Language>,
}
/// Generated client implementations.
pub mod translation_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 Translate service.
    ///
    /// Make sure you send your [authentication](/docs/translate/api-ref/authentication) credentials in the `Authorization` header of each request.
    #[derive(Debug, Clone)]
    pub struct TranslationServiceClient<T> {
        inner: tonic::client::Grpc<T>,
    }
    impl TranslationServiceClient<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> TranslationServiceClient<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,
        ) -> TranslationServiceClient<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,
        {
            TranslationServiceClient::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
        }
        /// Translates the text to the specified language.
        pub async fn translate(
            &mut self,
            request: impl tonic::IntoRequest<super::TranslateRequest>,
        ) -> std::result::Result<
            tonic::Response<super::TranslateResponse>,
            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.translate.v2.TranslationService/Translate",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.translate.v2.TranslationService",
                        "Translate",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Detects the language of the text.
        pub async fn detect_language(
            &mut self,
            request: impl tonic::IntoRequest<super::DetectLanguageRequest>,
        ) -> std::result::Result<
            tonic::Response<super::DetectLanguageResponse>,
            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.translate.v2.TranslationService/DetectLanguage",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.translate.v2.TranslationService",
                        "DetectLanguage",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
        /// Retrieves the list of supported languages.
        pub async fn list_languages(
            &mut self,
            request: impl tonic::IntoRequest<super::ListLanguagesRequest>,
        ) -> std::result::Result<
            tonic::Response<super::ListLanguagesResponse>,
            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.translate.v2.TranslationService/ListLanguages",
            );
            let mut req = request.into_request();
            req.extensions_mut()
                .insert(
                    GrpcMethod::new(
                        "yandex.cloud.ai.translate.v2.TranslationService",
                        "ListLanguages",
                    ),
                );
            self.inner.unary(req, path, codec).await
        }
    }
}