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

Analyzer - Get Analyze Receipt Result

参考

服务:: Azure AI Services

API 版本:: 2.1

跟踪进度并获取分析回执操作的结果。

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

示例请求

HTTP

GET {endpoint}/formrecognizer/v2.1/prebuilt/receipt/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	宽度、高度和 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

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

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

宽度、高度和 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	宽度、高度和 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	单词的文本内容。

通过