Analyzer - Get Analyze Business Card Result

Служба:: Azure AI Services

Версия API:: 2.1

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

GET {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/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 business card result

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

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/businessCard/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

Object

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

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

AnalyzeResult

Object

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

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

Appearance

Object

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

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

DataTable

Object

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

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

DataTableCell

Object

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

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

DocumentResult

Object

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

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

ErrorInformation

Object

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

ErrorResponse

Object

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

FieldValue

Object

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

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

FieldValueType

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

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

Значение	Описание
string
date
time
phoneNumber
number
integer
array
object
selectionMark
countryRegion

KeyValueElement

Object

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

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

KeyValuePair

Object

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

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

KeyValueType

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

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

Значение	Описание
string
selectionMark

LengthUnit

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

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

Значение	Описание
pixel
inch

OperationStatus

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

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

Значение	Описание
notStarted
running
succeeded
failed

PageResult

Object

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

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

ReadResult

Object

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

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

SelectionMark

Object

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

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

Style

Object

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

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

TextLine

Object

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

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

TextStyle

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

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

Значение	Описание
other
handwriting

TextWord

Object

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

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

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

Analyzer - Get Analyze Business Card Result

Параметры URI

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

Ответы

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

Ocp-Apim-Subscription-Key

Примеры

Get analyze business card result

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

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

Определения

AnalyzeOperationResult

AnalyzeResult

Appearance

DataTable

DataTableCell

DocumentResult

ErrorInformation

ErrorResponse

FieldValue

FieldValueType

KeyValueElement

KeyValuePair

KeyValueType

LengthUnit

OperationStatus

PageResult

ReadResult

SelectionMark

Style

TextLine

TextStyle

TextWord