Диагностика ошибок в Yandex Translate

Если у вас возникла ошибка при отправке запросов в API и вам нужна помощь, обратитесь в техническую поддержку.

Техническая поддержка сможет быстрее решить вашу проблему, если вы будете использовать дополнительные заголовки HTTP-запросов и ответов.

Заголовки запросов

При отправке HTTP-запросов используйте следующие заголовки:

  • x-client-request-id — уникальный идентификатор запроса. Рекомендуем использовать UUID. Сообщите этот идентификатор технической поддержке, чтобы мы смогли найти конкретный запрос в системе и помочь вам.

    Вы можете сгенерировать UUID онлайн или воспользоваться библиотекой для используемого языка программирования.

  • x-data-logging-enabled — флаг, разрешающий сохранять данные, переданные пользователем в запросе.

    По умолчанию сервис не сохраняет ваши данные, отправленные по API. Если вы передадите значение true в этом заголовке, то ваши данные будут сохраняться. Вместе с идентификатором запроса это поможет технической поддержке решить вашу проблему.

Примеры

Например, используйте эти заголовки, чтобы потом сообщить, что ваш текст перевелся плохо, и помочь нам доработать модель перевода.

export IAM_TOKEN=<IAM-токен>
        
        curl \
          --request POST \
          --header "x-client-request-id: fa18fa9b-176d-4ae0-92b8-bd78********" \
          --header "x-data-logging-enabled: true" \
          --header "Content-Type: application/json" \
          --header "Authorization: Bearer ${IAM_TOKEN}" \
          --data '@<путь_до_файла_json>' \
          "https://translate.api.cloud.yandex.net/translate/v2/translate"
        

Где IAM_TOKENIAM-токен, необходимый для аутентификации.

Заголовки ответов

Каждый ответ сервера содержит заголовки, которые позволяют получить еще больше информации о ходе выполнения запроса, например: x-server-trace-id — уникальный идентификатор логов выполнения запроса.

Чтобы получить значение x-server-trace-id, ваше приложение должно логировать заголовки ответов сервера.

Пример реализации доступа к заголовкам протокола gRPC приведен в документации библиотеки grpc-go.