Analyzer - Get Analyze Id Document Result

Ссылка

Служба:: Azure AI Services

Версия API:: 2.1

Отслеживайте ход выполнения и получите результат операции анализа идентификатора.

GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/{resultId}

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например : https://westus2.api.cognitive.microsoft.com).
resultId	path	True	string uuid	Анализ идентификатора результата операции.

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

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

Ответы

Имя	Тип	Описание
200 OK	AnalyzeOperationResult	Успешное завершение
Other Status Codes	ErrorResponse	Сущность ответа, сопровождающая несвоевременные ответы, содержащие дополнительные сведения об ошибке.

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

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

Примеры

Get analyze ID result

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

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/idDocument/analyzeResults/3b1e6c5b-e113-4114-ab6b-ce65dfe8050f

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

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

{
  "status": "running",
  "createdDateTime": "2019-05-01T10:53:21Z",
  "lastUpdatedDateTime": "2019-05-01T10:53:23Z",
  "analyzeResult": {
    "version": "v2.1",
    "readResults": [],
    "pageResults": [],
    "documentResults": [],
    "errors": []
  }
}

Определения

Имя	Описание
AnalyzeOperationResult	Состояние и результат операции анализа в очереди.
AnalyzeResult	Анализ результата операции.
Appearance	Объект , представляющий внешний вид текстовой строки.
DataTable	Сведения о извлеченной таблице, содержащейся на странице.
DataTableCell	Сведения о извлеченной ячейке в таблице.
DocumentResult	Набор извлеченных полей, соответствующих входным документам.
ErrorInformation
ErrorResponse
FieldValue	Распознанное значение поля.
FieldValueType	Семантический тип данных значения поля.
KeyValueElement	Сведения о извлеченном ключе или значении в паре "ключ-значение".
KeyValuePair	Сведения о извлеченной паре "ключ-значение".
KeyValueType	Семантический тип данных элемента ключевого значения.
LengthUnit	Единица измерения, используемая свойствами width, height и boundingBox. Для изображений единицей является пиксель. Для PDF единица имеет значение "дюйм".
OperationStatus	Состояние операции в очереди.
PageResult	Извлекается информация из одной страницы.
ReadResult	Текст, извлеченный из страницы входного документа.
SelectionMark	Сведения о извлеченной выделенной метки.
Style	Объект , представляющий стиль текстовой строки.
TextLine	Объект , представляющий извлеченную текстовую строку.
TextStyle	Имя стиля строки текста, включая рукописный и другие.
TextWord	Объект , представляющий слово.

AnalyzeOperationResult

Состояние и результат операции анализа в очереди.

Имя	Тип	Описание
analyzeResult	AnalyzeResult	Результаты операции анализа.
createdDateTime	string	Дата и время (UTC) отправки операции анализа.
lastUpdatedDateTime	string	Дата и время (UTC) последнего обновления состояния.
status	OperationStatus	Состояние операции.

AnalyzeResult

Анализ результата операции.

Имя	Тип	Описание
documentResults	DocumentResult[]	Сведения на уровне документа, извлеченные из входных данных.
errors	ErrorInformation[]	Список ошибок, сообщаемых во время операции анализа.
pageResults	PageResult[]	Сведения на уровне страницы, извлеченные из входных данных.
readResults	ReadResult[]	Текст, извлеченный из входных данных.
version	string	Версия схемы, используемая для этого результата.

Appearance

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

Имя	Тип	Описание
style	Style	Объект , представляющий стиль текстовой строки.

DataTable

Сведения о извлеченной таблице, содержащейся на странице.

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник таблицы.
cells	DataTableCell[]	Список ячеек, содержащихся в таблице.
columns	integer	Число столбцов.
rows	integer	Число строк.

DataTableCell

Сведения о извлеченной ячейке в таблице.

Имя	Тип	Default value	Описание
boundingBox	number[]		Ограничивающий прямоугольник ячейки.
columnIndex	integer		Индекс столбца ячейки.
columnSpan	integer	1	Число столбцов, охватываемых этой ячейкой.
confidence	number		Значение достоверности.
elements	string[]		Если параметру includeTextDetails присвоено значение true, создается список ссылок на текстовые элементы, составляющие эту ячейку таблицы.
isFooter	boolean	False	Является ли текущая ячейка ячейкой нижнего колонтитула?
isHeader	boolean	False	Является ли текущая ячейка ячейкой заголовка?
rowIndex	integer		Индекс строки ячейки.
rowSpan	integer	1	Число строк, охватываемых этой ячейкой.
text	string		Текстовое содержимое ячейки.

DocumentResult

Набор извлеченных полей, соответствующих входным документам.

Имя	Тип	Описание
docType	string	Тип документа.
docTypeConfidence	number	Прогнозируемое доверие к типу документа.
fields	<string, FieldValue>	Словарь именованных значений полей.
modelId	string	Идентификатор модели.
pageRange	integer[]	Первая и последняя страницы, на которой находится документ.

ErrorInformation

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

ErrorResponse

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

FieldValue

Распознанное значение поля.

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник значения поля, если это необходимо.
confidence	number	Оценка достоверности.
elements	string[]	Если параметру includeTextDetails присвоено значение true, создается список ссылок на текстовые элементы, составляющие это поле.
page	integer	Номер 1 страницы во входном документе.
text	string	Текстовое содержимое извлеченного поля.
type	FieldValueType	Тип значения поля.
valueArray	FieldValue[]	Массив значений полей.
valueCountryRegion	string	3-буквенный код страны (ISO 3166-1 alpha-3).
valueDate	string	Значение даты.
valueInteger	integer	Целое значение.
valueNumber	number	Значение с плавающей запятой.
valueObject	<string, FieldValue>	Словарь именованных значений полей.
valuePhoneNumber	string	Значение номера телефона.
valueSelectionMark	enum: selected unselected	Значение метки выбора.
valueString	string	Строковое значение.
valueTime	string	Значение времени.

FieldValueType

Семантический тип данных значения поля.

Имя	Тип	Описание
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

Сведения о извлеченном ключе или значении в паре "ключ-значение".

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник ключа или значения.
elements	string[]	Если параметру includeTextDetails присвоено значение true, создается список ссылок на текстовые элементы, составляющие этот ключ или значение.
text	string	Текстовое содержимое ключа или значения.
type	KeyValueType	Семантический тип данных элемента ключевого значения.

KeyValuePair

Сведения о извлеченной паре "ключ-значение".

Имя	Тип	Описание
confidence	number	Значение достоверности.
key	KeyValueElement	Сведения о извлеченном ключе в паре "ключ-значение".
label	string	Определяемая пользователем метка для записи пары "ключ-значение".
value	KeyValueElement	Сведения о извлеченном значении в паре "ключ-значение".

KeyValueType

Семантический тип данных элемента ключевого значения.

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

LengthUnit

Единица измерения, используемая свойствами width, height и boundingBox. Для изображений единицей является пиксель. Для PDF единица имеет значение "дюйм".

Имя	Тип	Описание
inch	string
pixel	string

OperationStatus

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

Имя	Тип	Описание
failed	string
notStarted	string
running	string
succeeded	string

PageResult

Извлекается информация из одной страницы.

Имя	Тип	Описание
clusterId	integer	Идентификатор кластера.
keyValuePairs	KeyValuePair[]	Список пар "ключ-значение", извлеченных из страницы.
page	integer	Номер страницы.
tables	DataTable[]	Список таблиц данных, извлеченных из страницы.

ReadResult

Текст, извлеченный из страницы входного документа.

Имя	Тип	Описание
angle	number	Общая ориентация текста в направлении по часовой стрелке, измеряемая в градусах между (-180, 180].
height	number	Высота изображения/PDF в пикселях/дюймах соответственно.
lines	TextLine[]	Если параметру includeTextDetails присвоено значение true, отображается список распознаваемых текстовых строк. Максимальное количество возвращаемых строк — 300 на страницу. Линии сортируются сверху вниз, слева направо, хотя в некоторых случаях близость рассматривается с более высоким приоритетом. Так как порядок сортировки зависит от обнаруженного текста, он может изменяться в разных изображениях и обновлениях версий OCR. Таким образом, бизнес-логика должна строиться на основе фактического расположения строки, а не порядка.
page	integer	Номер 1 страницы во входном документе.
selectionMarks	SelectionMark[]	Список меток выделения, извлеченных из страницы.
unit	LengthUnit	Единица измерения, используемая свойствами width, height и boundingBox. Для изображений единицей является пиксель. Для PDF единица имеет значение "дюйм".
width	number	Ширина изображения/PDF в пикселях/дюймах соответственно.

SelectionMark

Сведения о извлеченной выделенной метки.

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник выделенной метки.
confidence	number	Значение достоверности.
state	enum: selected unselected	Состояние выделенной метки.

Style

Объект , представляющий стиль текстовой строки.

Имя	Тип	Описание
confidence	number	Достоверность стиля строки текста.
name	TextStyle	Имя стиля строки текста, включая рукописный и другие.

TextLine

Объект , представляющий извлеченную текстовую строку.

Имя	Тип	Описание
appearance	Appearance	Свойства внешнего вида текста.
boundingBox	number[]	Ограничивающий прямоугольник извлеченной строки.
text	string	Текстовое содержимое строки.
words	TextWord[]	Список слов в текстовой строке.

TextStyle

Имя стиля строки текста, включая рукописный и другие.

Имя	Тип	Описание
handwriting	string
other	string

TextWord

Объект , представляющий слово.

Имя	Тип	Описание
boundingBox	number[]	Ограничивающий прямоугольник извлеченного слова.
confidence	number	Значение достоверности.
text	string	Текстовое содержимое слова.

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