TranslationService
Статья создана
Обновлена 15 августа 2024 г.
Набор методов для сервиса Yandex Translate.
При работе с API Translate отправляйте данные для аутентификации в заголовке Authorization каждого запроса.
| Вызов | Описание |
|---|---|
| Translate | Переводит текст на указанный язык. |
| DetectLanguage | Определяет язык текста. |
| ListLanguages | Получает список поддерживаемых языков. |
Вызовы TranslationService
Translate
Переводит текст на указанный язык.
rpc Translate (TranslateRequest) returns (TranslateResponse)
TranslateRequest
| Поле | Описание |
|---|---|
| source_language_code | string Язык, на котором написан исходный текст (например, ru). Обязательно при переводе с глоссарием. Максимальная длина строки в символах — 3. |
| target_language_code | string Обязательное поле. Язык, на который переводится текст (например, en). Максимальная длина строки в символах — 3. |
| format | enum Format Формат текста.
|
| texts[] | string Массив строк для перевода. Максимальная общая длина всех строк составляет 10000 символов. Количество элементов должно быть больше 0. |
| folder_id | string Идентификатор каталога, к которому у вас есть доступ. Требуется для авторизации с пользовательским аккаунтом (см. ресурс yandex.cloud.iam.v1.UserAccount) . Не используйте это поле, если вы делаете запрос от имени сервисного аккаунта. Максимальная длина строки в символах — 50. |
| model | string Не используйте это поле, пользовательские модели пока не поддерживаются. Максимальная длина строки в символах — 50. |
| glossary_config | TranslateGlossaryConfig Глоссарий для применения при переводе. Дополнительные сведения см. в разделе Глоссарии. |
| speller | boolean Параметр, который включает проверку орфографии. |
TranslateGlossaryConfig
| Поле | Описание |
|---|---|
| glossary_source | oneof: glossary_data |
| glossary_data | GlossaryData Передать содержимое глоссария в запросе. В настоящее время поддерживается только этот способ передачи глоссария. |
GlossaryData
| Поле | Описание |
|---|---|
| glossary_pairs[] | GlossaryPair Массив текстовых пар. Максимальная общая длина всех исходных текстов 10000 символов. Максимальная общая длина всех переведенных текстов 10000 символов. Количество элементов должно находиться в диапазоне от 1 до 50. |
GlossaryPair
| Поле | Описание |
|---|---|
| source_text | string Обязательное поле. Текст на языке оригинала. |
| translated_text | string Обязательное поле. Текст на языке перевода. |
TranslateResponse
| Поле | Описание |
|---|---|
| translations[] | TranslatedText Массив переводов. |
TranslatedText
| Поле | Описание |
|---|---|
| text | string Переведенный текст. |
| detected_language_code | string Код языка исходного текста (например, en). |
DetectLanguage
Определяет язык текста.
rpc DetectLanguage (DetectLanguageRequest) returns (DetectLanguageResponse)
DetectLanguageRequest
| Поле | Описание |
|---|---|
| text | string Обязательное поле. Текст, язык которого требуется определить. Максимальная длина строки в символах — 1000. |
| language_code_hints[] | string Список наиболее вероятных языков (например, ru). Этим языкам будет отдаваться предпочтение при определении языка текста.Чтобы получить список поддерживаемых языков, используйте запрос TranslationService.ListLanguages. Максимальное количество элементов — 10. Максимальная длина строки в символах для каждого значения — 3. |
| folder_id | string Идентификатор каталога, к которому у вас есть доступ. Требуется для авторизации с пользовательским аккаунтом (см. ресурс yandex.cloud.iam.v1.UserAccount) . Не используйте это поле, если вы делаете запрос от имени сервисного аккаунта. Максимальная длина строки в символах — 50. |
DetectLanguageResponse
| Поле | Описание |
|---|---|
| language_code | string Язык текста (например, ru). Чтобы получить название языка, используйте запрос TranslationService.ListLanguages. |
ListLanguages
Получает список поддерживаемых языков.
rpc ListLanguages (ListLanguagesRequest) returns (ListLanguagesResponse)
ListLanguagesRequest
| Поле | Описание |
|---|---|
| folder_id | string Идентификатор каталога, к которому у вас есть доступ. Требуется для авторизации с пользовательским аккаунтом (см. ресурс yandex.cloud.iam.v1.UserAccount) . Не используйте это поле, если вы делаете запрос от имени сервисного аккаунта. Максимальная длина строки в символах — 50. |
ListLanguagesResponse
| Поле | Описание |
|---|---|
| languages[] | Language Список поддерживаемых языков. |
Language
| Поле | Описание |
|---|---|
| code | string Код языка (например, en). |
| name | string Название языка (например, English). |