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

Analyzer - Analyze Id Document

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

Извлечение текста поля и семантических значений из заданного документа идентификатора. Входной документ должен относиться к одному из поддерживаемых типов контента : "application/pdf", "image/jpeg", "image/png", "image/tiff" или "image/bmp". Кроме того, используйте тип application/json, чтобы указать расположение (URI) анализируемого документа.

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze
С использованием необязательных параметров: 
POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze?includeTextDetails={includeTextDetails}&pages={pages}

Параметры URI

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

string

Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://westus2.api.cognitive.microsoft.com
includeTextDetails
 query

boolean

Включите текстовые строки и ссылки на элементы в результат.
pages
 query

string[]

Пользовательские номера страниц для многостраничных документов (PDF/TIFF), введите количество страниц, которые вы хотите получить результат OCR. Для диапазона страниц используйте дефис. Разделите каждую страницу или диапазон с помощью запятой.

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

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

Имя Обязательно Тип Описание
Ocp-Apim-Subscription-Key True

string

Текст запроса

Media Types: "application/pdf", "application/json", "image/jpeg", "image/png", "image/tiff", "image/bmp"

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

string

Путь к исходному файлу.

Ответы

Имя Тип Описание
202 Accepted

Запрос успешно поставлен в очередь.

Заголовки

Operation-Location: string
Other Status Codes

ErrorResponse

Сущность ответа, сопровождающая несвоевременные ответы, содержащие дополнительные сведения об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Analyze ID

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

POST {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyze

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

Код состояния:
202 
Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Определения

Имя Описание
ErrorInformation
ErrorResponse
SourcePath

URI или локальный путь к исходным данным.

ErrorInformation

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

string

message

string

ErrorResponse

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

ErrorInformation

SourcePath

URI или локальный путь к исходным данным.

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

string

Путь к исходному файлу.