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

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

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

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

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

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

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

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

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

ПримерыПримеры

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

export FOLDER_ID=<идентификатор_каталога>
export IAM_TOKEN=<IAM-токен>

curl \
  --verbose \
  --request POST \
  --header "x-client-request-id: fa18fa9b-176d-4ae0-92b8-bd78********" \
  --header "x-data-logging-enabled: true" \
  --header "authorization: Bearer ${IAM_TOKEN}" \
  --data-binary "@speech.ogg" \
  "https://stt.api.cloud.yandex.net/speech/v2/stt:recognize?folderId=${FOLDER_ID}"

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

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

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

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

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