Analyzer - Analyze Receipt

Служба:

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/receipt/analyze

С использованием необязательных параметров:

POST {endpoint}/formrecognizer/v2.1/prebuilt/receipt/analyze?includeTextDetails={includeTextDetails}&locale={locale}&pages={pages}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например). https://westus2.api.cognitive.microsoft.com
includeTextDetails	query		boolean	Включите текстовые строки и ссылки на элементы в результат.
locale	query		Locale	Языковой стандарт входного документа. Поддерживаемые языковые параметры: en-AU, en-CA, en-GB, en-IN, en-US (по умолчанию).
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 receipt

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

HTTP

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

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

Код состояния:

202

Operation-Location: {endpoint}/formrecognizer/v2.1/prebuilt/receipt/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

Определения

Имя	Описание
ErrorInformation
ErrorResponse
Locale	Языковой стандарт входного документа. Поддерживаемые языковые параметры: en-AU, en-CA, en-GB, en-IN, en-US (по умолчанию).
SourcePath	URI или локальный путь к исходным данным.

ErrorInformation

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

ErrorResponse

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

Locale

Языковой стандарт входного документа. Поддерживаемые языковые параметры: en-AU, en-CA, en-GB, en-IN, en-US (по умолчанию).

Имя	Тип	Описание
en-AU	string
en-CA	string
en-GB	string
en-IN	string
en-US	string

SourcePath

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

Имя	Тип	Описание
source	string	Путь к исходному файлу.