你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Analyzer - Get Analyze Layout Result

服务:: Azure AI Services

API 版本:: 2.1

跟踪进度并获取分析布局作的结果

GET {endpoint}/formrecognizer/v2.1/layout/analyzeResults/{resultId}

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点（协议和主机名，例如：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 layout result

示例请求

HTTP

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

示例响应

状态代码:: 200

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

定义

名称	说明
AnalyzeOperationResult	排队分析作的状态和结果。
AnalyzeResult	分析作结果。
Appearance	一个表示文本行外观的对象。
DataTable	有关页面中包含的提取表的信息。
DataTableCell	有关表中提取的单元格的信息。
DocumentResult	对应于输入文档的一组提取字段。
ErrorInformation
ErrorResponse
FieldValue	已识别的字段值。
FieldValueType	字段值的语义数据类型。
KeyValueElement	有关键值对中提取的键或值的信息。
KeyValuePair	有关提取的键值对的信息。
KeyValueType	键值元素的语义数据类型。
LengthUnit	宽度、高度和 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

有关表中提取的单元格的信息。

名称	类型	默认值	说明
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

枚举

宽度、高度和 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	宽度、高度和 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 Layout Result

URI 参数

请求头

响应

安全性

Ocp-Apim-Subscription-Key

示例

Get analyze layout result

示例请求

示例响应

定义

AnalyzeOperationResult

AnalyzeResult

Appearance

DataTable

DataTableCell

DocumentResult

ErrorInformation

ErrorResponse

FieldValue

FieldValueType

KeyValueElement

KeyValuePair

KeyValueType

LengthUnit

OperationStatus

PageResult

ReadResult

SelectionMark

Style

TextLine

TextStyle

TextWord