Руководство по ошибкам версии 4.0, v3.1 и v3.0
Аналитика документов использует унифицированную структуру для представления всех ошибок, возникающих в REST API. Каждый раз, когда операция API возвращает код состояния 4xx или 5xx, дополнительные сведения об ошибке возвращаются в теле ответа JSON следующим образом:
{
"error": {
"code": "InvalidRequest",
"message": "Invalid request.",
"innererror": {
"code": "InvalidContent",
"message": "The file format is unsupported or corrupted. Refer to documentation for the list of supported formats."
}
}
}
Для длительных операций, в которых обнаружены несколько ошибок, код ошибки верхнего уровня устанавливается на самую серьезную ошибку с отдельными ошибками, перечисленными в свойстве error.details . В таких сценариях свойство target каждой отдельной ошибки указывает на триггер ошибки.
{
"status": "failed",
"createdDateTime": "2021-07-14T10:17:51Z",
"lastUpdatedDateTime": "2021-07-14T10:17:51Z",
"error": {
"code": "InternalServerError",
"message": "An unexpected error occurred.",
"details": [
{
"code": "InternalServerError",
"message": "An unexpected error occurred."
},
{
"code": "InvalidContentDimensions",
"message": "The input image dimensions are out of range. Refer to documentation for supported image dimensions.",
"target": "2"
}
]
}
}
В качестве значения свойства error.code верхнего уровня может выступать одно из следующих сообщений с кодом ошибки:
| Код ошибки | Сообщение | Состояние HTTP |
|---|---|---|
| InvalidRequest | Недопустимый запрос. | 400 |
| InvalidArgument | Недопустимый аргумент. | 400 |
| Запрещено | Доступ запрещен из-за параметров политики или другой конфигурации. | 403 |
| Не найдено | Ресурс не найден. | 404 |
| MethodNotAllowed | Запрошенный метод HTTP не разрешен. | 405 |
| Конфликт | Запрос не удалось завершить из-за конфликта. | 409 |
| UnsupportedMediaType | Тип контента запроса не поддерживается. | 415 |
| InternalServerError | Произошла непредвиденная ошибка. | 500 |
| ServiceUnavailable | Произошел временный сбой. Повторите попытку. | 503 |
По возможности дополнительные сведения указываются в свойстве inner error.
| Код ошибки верхнего уровня | Внутренний код ошибки | Message |
|---|---|---|
| Конфликт | ModelExists | Модель с указанным именем уже существует. |
| Запрещено | AuthorizationFailed | Ошибка авторизации: {подробности}. |
| Запрещено | InvalidDataProtectionKey | Недопустимый ключ защиты данных: {подробности}. |
| Запрещено | OutboundAccessForbidden | Запрос содержит запрещенное доменное имя или нарушает текущую политику управления доступом. |
| InternalServerError | Неизвестно | Неизвестную погрешность. |
| InvalidArgument | InvalidContentSourceFormat | Недопустимый источник содержимого: {подробности}. |
| InvalidArgument | InvalidParameter | Недопустимый параметр {имя параметра}: {подробности}. |
| InvalidArgument | InvalidParameterLength | Длина параметра {имя параметра} не должна превышать {максимальное количество символов} символов. |
| InvalidArgument | InvalidSasToken | Недопустимый подписанный URL-адрес (SAS): {подробности}. |
| InvalidArgument | ParameterMissing | Параметр {имя параметра} является обязательным. |
| InvalidRequest | ContentSourceNotAccessible | Содержимое недоступно: {details} |
| InvalidRequest | ContentSourceTimeout | Истекло время ожидания при получении файла от клиента. |
| InvalidRequest | DocumentModelLimit | Учетная запись не может создавать больше моделей {maximumModels}. |
| InvalidRequest | DocumentModelLimitNeural | Учетная запись не может создавать более 10 пользовательских нейронных моделей в месяц. Обратитесь в службу поддержки, чтобы запросить больше емкости. |
| InvalidRequest | DocumentModelLimitComposed | Учетная запись не может создать модель с более чем моделями компонентов {details}. |
| InvalidRequest | InvalidContent | Файл поврежден, или такой формат не поддерживается. Список поддерживаемых форматов см. в документации. |
| InvalidRequest | InvalidContentDimensions | Размер входящего изображения превышает максимально допустимый. Информацию об ограничениях для размера изображений см. в документации. |
| InvalidRequest | InvalidContentLength | Входящее изображение слишком большое. Информацию о максимально допустимым размерах файлов см. в документации. |
| InvalidRequest | InvalidFieldsDefinition | Недопустимые поля: {подробности}. |
| InvalidRequest | InvalidTrainingContentLength | Размер обучающего содержимого: {количество байт} байт. Максимально допустимый размер для обучения: {максимальное количество байт} байт. |
| InvalidRequest | InvalidTrainingContentPageCount | Объем обучающего содержимого: {количество страниц} страниц. Максимально допустимый объем для обучения: {максимальное количество страниц} страниц. |
| InvalidRequest | ModelAnalyzeError | Не удалось проанализировать с помощью пользовательской модели: {details} |
| InvalidRequest | ModelBuildError | Не удалось создать модель: {details} |
| InvalidRequest | ModelComposeError | Не удалось создать модель: {details} |
| InvalidRequest | ModelNotReady | Модель не готова к запрошенной операции. Дождитесь завершения обучения или проверьте наличие ошибок в работе. |
| InvalidRequest | ModelReadOnly | Запрошенная модель доступна только для чтения. |
| InvalidRequest | NotSupportedApiVersion | Для запрошенной операции требуется версия {минимальная версия API} или более поздняя. |
| InvalidRequest | OperationNotCancellable | Операцию уже нельзя отменить. |
| InvalidRequest | TrainingContentMissing | Отсутствуют обучающие данные: {подробности}. |
| InvalidRequest | UnsupportedContent | Содержимое не поддерживается: {details} |
| Не найдено | ModelNotFound | Запрошенная модель не найдена. Он удаляется или по-прежнему строится. |
| Не найдено | OperationNotFound | Запрошенная операция не найдена. Идентификатор недопустим или истек срок действия. |