Заголовки для диагностики ошибок в Yandex AI Studio

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

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

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

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

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

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

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

    По умолчанию все запросы к AI Studio логируются. Вместе с указанием идентификатора запроса при обращении в техническую поддержку, логирование поможет решить вашу проблему. Вы можете отключить логирование, если в запросе необходимо передать чувствительную информацию.

Примеры

Например, эти заголовки помогут найти ваш асинхронный запрос к модели:

export FOLDER_ID=<идентификатор_каталога>
        export IAM_TOKEN=<IAM-токен>
        curl \
          --request POST \
          --header "Content-Type: application/json" \
          --header "Authorization: Bearer ${IAM_TOKEN}" \
          --header "x-folder-id: ${FOLDER_ID}" \
          --data "@<путь_до_файла_json>" \
          "https://ai.api.cloud.yandex.net/foundationModels/v1/completionAsync"

Где:

  • FOLDER_ID— идентификатор каталога, на который у вашего аккаунта есть роль ai.languageModels.user или выше.
  • IAM_TOKEN — IAM-токен, полученный перед началом работы.

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

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

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

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

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

Предыдущая
Коды ошибок
Следующая
Обзор технологий SpeechKit