Заголовки запросов для диагностики ошибок в Yandex SpeechKit

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

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

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

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

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

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

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

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

Примеры

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

export FOLDER_ID=<идентификатор_каталога>
        export IAM_TOKEN=<IAM-токен>
        
        curl \
          --verbose \
          --insecure \
          --header "x-client-request-id: fa18fa9b-176d-4ae0-92b8-bd78********" \
          --header "x-data-logging-enabled: true" \
          --header "authorization: Bearer ${IAM_TOKEN}" \
          --header "x-folder-id: ${FOLDER_ID}" \
          --data @request.json https://stt.api.cloud.yandex.net:443/stt/v3/recognizeFileAsync

Где:

Совет

Используйте флаг -v или --verbose, чтобы вывести в терминал полный лог выполнения команды.

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

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

  • x-request-id — уникальный идентификатор ответа.
  • x-server-trace-id — уникальный идентификатор логов выполнения запроса.

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

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

Предыдущая
Коды ошибок
Следующая
Общие вопросы