Поделиться через

Document Models - List Analyze Batch Results

  • Ссылка
Служба:
Azure AI Services
Версия API:
2024-11-30

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

GET {endpoint}/documentintelligence/documentModels/{modelId}/analyzeBatchResults?api-version=2024-11-30

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (uri)

Конечная точка службы аналитики документов.
modelId
 path True

string

maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$

Уникальное имя модели документа.
api-version
 query True

string

minLength: 1

Версия API, используемая для этой операции.

Ответы

Имя Тип Описание
200 OK

PagedAnalyzeBatchOperation

Запрос выполнен успешно.
Other Status Codes

DocumentIntelligenceErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize
URL-адрес токена: https://login.microsoftonline.com/common/oauth2/token

Области

Имя Описание
https://cognitiveservices.azure.com/.default

Примеры

List Analyze Batch Documents Results

Образец запроса

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults?api-version=2024-11-30

Пример ответа

Код состояния:
200 
{
  "value": [
    {
      "resultId": "f4d8b3b3-7f76-4b3b-8b3b-3b7f76f4d8b3",
      "status": "succeeded",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "lastUpdatedDateTime": "2021-09-24T12:54:35Z"
    },
    {
      "resultId": "f4d8b3b3-7f76-4b3b-8b3b-3b7f76f4d8b4",
      "status": "running",
      "createdDateTime": "2021-09-24T12:54:35Z",
      "lastUpdatedDateTime": "2021-09-24T12:54:35Z"
    }
  ],
  "nextLink": "https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentModels/prebuilt-invoice/analyzeBatchResults?nextLink=nextLinkData"
}

Определения

Имя Описание
AnalyzeBatchOperation

Состояние и результат выполнения пакетной операции анализа.
AnalyzeBatchOperationDetail

Сведения об операции для документа в пакетном анализе.
AnalyzeBatchResult

Результат анализа пакетного документа.
DocumentIntelligenceError

Объект ошибки.
DocumentIntelligenceErrorResponse

Объект ответа об ошибке.
DocumentIntelligenceInnerError

Объект, содержащий более конкретные сведения об ошибке.
DocumentIntelligenceOperationStatus

Состояние операции.
PagedAnalyzeBatchOperation

Коллекция paged элементов AnalyzeBatchOperation

AnalyzeBatchOperation

Object

Состояние и результат выполнения пакетной операции анализа.

Имя Тип Описание
createdDateTime

string (date-time)

Дата и время (UTC) при отправке операции.
error

DocumentIntelligenceError

Обнаружена ошибка во время анализа пакетного документа.
lastUpdatedDateTime

string (date-time)

Дата и время (UTC) при последнем обновлении состояния.
percentCompleted

integer (int32)

minimum: 0
maximum: 100

Ход выполнения операции (0–100).
result

AnalyzeBatchResult

Результат анализа пакетного документа.
resultId

string (uuid)

Анализ идентификатора результата пакетной операции.
status

DocumentIntelligenceOperationStatus

Состояние операции. notStarted, запуск, успешное выполнение или сбой

AnalyzeBatchOperationDetail

Object

Сведения об операции для документа в пакетном анализе.

Имя Тип Описание
error

DocumentIntelligenceError

Обнаружена ошибка.
resultUrl

string (uri)

URL-адрес json результата анализа.
sourceUrl

string (uri)

URL-адрес исходного документа.
status

DocumentIntelligenceOperationStatus

Анализ состояния. успешно, неудачно или пропущено

AnalyzeBatchResult

Object

Результат анализа пакетного документа.

Имя Тип Описание
details

AnalyzeBatchOperationDetail[]

Сведения об операциях для каждого документа в пакете.
failedCount

integer (int32)

Количество документов, завершенных с ошибкой состояния.
skippedCount

integer (int32)

Количество документов, завершенных с пропущенным состоянием.
succeededCount

integer (int32)

Количество документов, завершенных с состоянием успешно.

DocumentIntelligenceError

Object

Объект ошибки.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
details

DocumentIntelligenceError[]

Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror

DocumentIntelligenceInnerError

Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message

string

Читаемое пользователем представление ошибки.
target

string

Целевой объект ошибки.

DocumentIntelligenceErrorResponse

Object

Объект ответа об ошибке.

Имя Тип Описание
error

DocumentIntelligenceError

Сведения об ошибке.

DocumentIntelligenceInnerError

Object

Объект, содержащий более конкретные сведения об ошибке.

Имя Тип Описание
code

string

Один из определяемых сервером кодов ошибок.
innererror

DocumentIntelligenceInnerError

Внутренняя ошибка.
message

string

Читаемое пользователем представление ошибки.

DocumentIntelligenceOperationStatus

Перечисление

Состояние операции.

Значение Описание
canceled

Операция отменена.
failed

Операция завершилась ошибкой.
notStarted

Операция еще не запущена.
running

Операция выполняется.
skipped

Операция пропущена.
succeeded

Операция выполнена успешно.

PagedAnalyzeBatchOperation

Object

Коллекция paged элементов AnalyzeBatchOperation

Имя Тип Описание
nextLink

string (uri)

Ссылка на следующую страницу элементов
value

AnalyzeBatchOperation[]

Элементы AnalyzeBatchOperation на этой странице