Как начать работать с Translate

Yandex Translate предоставляет API для интеграции технологий перевода в свои приложения. Если вы хотите использовать для перевода графический интерфейс, воспользуйтесь Яндекс Переводчиком.

В этом разделе вы научитесь переводить текст, используя Translate API.

Чтобы воспользоваться примерами, установите cURL.

Больше примеров на разных языках программирования доступно в пошаговых инструкциях.

О том, как создать сервисный аккаунт и API-ключ для интеграции Yandex Translate в свое приложение, см. Как создать API-ключ для работы в Yandex AI Studio.

Перед началом работы

  1. На странице Биллинг убедитесь, что платежный аккаунт находится в статусе ACTIVE или TRIAL_ACTIVE. Если платежного аккаунта нет, создайте его.

  2. Для аутентификации от имени сервисного аккаунта вы можете использовать API-ключ или IAM-токен, для аутентификации от имени пользовательского аккаунта — только IAM-токен.

    Получите данные вашего аккаунта для аутентификации в API Translate:

    1. Если у вас еще нет сервисного аккаунта, создайте его.

    2. Назначьте сервисному аккаунту роль ai.translate.user на каталог.

    3. Получите идентификатор каталога, в котором создан ваш сервисный аккаунт. Идентификатор каталога должен передаваться в теле каждого запроса в поле folderId.

    4. Создайте API-ключ с областью действия yc.ai.translate.execute.

      Передавайте полученный ключ в заголовке Authorization каждого запроса в формате:

      Authorization: Api-Key <API-ключ>

    1. Получите идентификатор любого каталога, на который у вашего аккаунта есть роль ai.translate.user или выше. Идентификатор каталога должен передаваться в теле каждого запроса в поле folderId.

    2. Получите IAM-токен для аккаунта на Яндексе, федеративного аккаунта, локального аккаунта или сервисного аккаунта.

      Передавайте полученный токен в заголовке Authorization каждого запроса в формате:

      Authorization: Bearer <IAM-токен>

Перевести текст

Пример ниже разработан для выполнения в операционных системах MacOS и Linux. Чтобы выполнить его в системе Windows, ознакомьтесь с особенностями работы с Bash в Microsoft Windows.

В этом примере показано, как выполнить перевод на русский язык двух строк с текстом: «Hello» и «World». Язык исходного текста будет определен автоматически.

  1. Создайте файл с телом запроса (например, body.json):

    {
            "folderId": "<идентификатор_каталога>",
            "texts": ["Hello", "World"],
            "targetLanguageCode": "ru"
        }

    Где:

  2. Передайте файл на перевод, выполнив команду:

    export API_KEY=<API-ключ>
        curl \
          --request POST \
          --header "Content-Type: application/json" \
          --header "Authorization: Api-Key ${API_KEY}" \
          --data '@<путь_до_файла_json>' \
          "https://translate.api.cloud.yandex.net/translate/v2/translate"

    Где API_KEY — API-ключ, полученный перед началом работы. Если для аутентификации вы используете IAM-токен, измените заголовок Authorization на "Authorization: Bearer <IAM-токен>".

    В ответе сервис вернет переведенные строки текста:

    {
            "translations": [
                {
                "text": "Привет",
                "detectedLanguageCode": "en"
                },
                {
                "text": "Мир",
                "detectedLanguageCode": "en"
                }
            ]
        }

Что дальше

Предыдущая
О сервисе Translate
Следующая
Поддерживаемые языки