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

Get Analyze Invoice Result - Get Analyze Invoice Result

获取分析发票结果
跟踪进度并获取分析发票操作的结果。

GET {endpoint}/formrecognizer/v2.1-preview.2/prebuilt/invoice/analyzeResults/{resultId}

URI 参数

Name In Required Type Description
endpoint
path True
  • string

支持的认知服务终结点 (协议和主机名,例如: https://westus2.api.cognitive.microsoft.com) 。

resultId
path True
  • string
uuid

分析操作结果标识符。

请求头

Name Required Type Description
Ocp-Apim-Subscription-Key True
  • string

响应

Name Type Description
200 OK

Success

Other Status Codes

包含有关错误的其他详细信息的非成功响应的响应实体。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

示例

Get analyze receipt result

Sample Request

GET {endpoint}/formrecognizer/v2.1-preview.2/prebuilt/invoice/analyzeResults/{result Id}

Sample Response

{
  "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

键值元素的语义数据类型。

Language

语言代码

LengthUnit

宽度、高度和边界Box 属性使用的单位。 对于图像,该单元为“像素”。 对于 PDF,该单元为“英寸”。

OperationStatus

排队操作的状态。

PageResult

从单个页面提取的信息。

ReadResult

从输入文档中的页面中提取的文本。

SelectionMark

有关提取的选择标记的信息。

Style

一个对象,表示文本行的样式。

TextLine

一个表示提取的文本行的对象。

TextStyle

文本行样式名称,包括手写和其他。

TextWord

一个表示单词的对象。

AnalyzeOperationResult

排队分析操作的状态和结果。

Name Type Description
analyzeResult

分析操作的结果。

createdDateTime
  • string

提交分析操作时的日期和时间 (UTC) 。

lastUpdatedDateTime
  • string

上次更新状态时的日期和时间 (UTC) 。

status

操作状态。

AnalyzeResult

分析操作结果。

Name Type Description
documentResults

从输入中提取的文档级信息。

errors

分析操作期间报告的错误列表。

pageResults

从输入中提取的页面级信息。

readResults

从输入中提取的文本。

version
  • string

用于此结果的架构版本。

Appearance

一个对象,表示文本行的外观。

Name Type Description
style

一个对象,表示文本行的样式。

DataTable

有关页面中包含的提取表的信息。

Name Type Description
boundingBox
  • number[]

表的边界框。

cells

表中包含的单元格列表。

columns
  • integer

列数。

rows
  • integer

行数。

DataTableCell

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

Name Type Default Value Description
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

与输入文档对应的一组提取字段。

Name Type Description
docType
  • string

文档类型。

docTypeConfidence
  • number

预测的文档类型置信度。

fields

命名字段值的字典。

modelId
  • string

模型标识符。

pageRange
  • integer[]

找到文档的第一页和最后一页码。

ErrorInformation

Name Type Description
code
  • string
message
  • string

ErrorResponse

Name Type Description
error

FieldValue

已识别的字段值。

Name Type Description
boundingBox
  • number[]

字段值的边界框(如果适用)。

confidence
  • number

置信度分数。

elements
  • string[]

如果 includeTextDetails 设置为 true,则构成此字段的文本元素的引用列表。

page
  • integer

输入文档中基于 1 的页码。

text
  • string

提取字段的文本内容。

type

字段值的类型。

valueArray

字段值的数组。

valueDate
  • string

日期值。

valueInteger
  • integer

整数值。

valueNumber
  • number

浮点值。

valueObject

命名字段值的字典。

valuePhoneNumber
  • string

电话数字值。

valueSelectionMark enum:
  • selected
  • unselected

选择标记值。

valueString
  • string

字符串值。

valueTime
  • string

时间值。

FieldValueType

字段值的语义数据类型。

Name Type Description
array
  • string
date
  • string
integer
  • string
number
  • string
object
  • string
phoneNumber
  • string
selectionMark
  • string
string
  • string
time
  • string

KeyValueElement

有关键值配对中提取的键或值的信息。

Name Type Description
boundingBox
  • number[]

键或值的边界框。

elements
  • string[]

如果 includeTextDetails 设置为 true,则构成此键或值的文本元素的引用列表。

text
  • string

键或值的文本内容。

type

键值元素的语义数据类型。

KeyValuePair

有关提取的键值配对的信息。

Name Type Description
confidence
  • number

置信度值。

key

有关键值配对中提取的密钥的信息。

label
  • string

键/值配对项的用户定义标签。

value

有关键值配对中提取的值的信息。

KeyValueType

键值元素的语义数据类型。

Name Type Description
selectionMark
  • string
string
  • string

Language

语言代码

Name Type Description
de
  • string
en
  • string
es
  • string
fr
  • string
it
  • string
ja
  • string
nl
  • string
pt
  • string
zh-Hans
  • string

LengthUnit

宽度、高度和边界Box 属性使用的单位。 对于图像,该单元为“像素”。 对于 PDF,该单元为“英寸”。

Name Type Description
inch
  • string
pixel
  • string

OperationStatus

排队操作的状态。

Name Type Description
failed
  • string
notStarted
  • string
running
  • string
succeeded
  • string

PageResult

从单个页面提取的信息。

Name Type Description
clusterId
  • integer

群集标识符。

keyValuePairs

从页面中提取的键值对的列表。

page
  • integer

页码。

tables

从页中提取的数据表列表。

ReadResult

从输入文档中的页面中提取的文本。

Name Type Description
angle
  • number

以顺时针方向测量的文本的一般方向,以 (-180、180 之间的度为单位测量。

height
  • number

图像/PDF 的高度(以像素/英寸为单位)。

language

整个页面上检测到的语言。

lines

当 includeTextDetails 设置为 true 时,会列出已识别的文本行。 返回的最大行数是每页 300 行。 这些行按从上到下、从左到右排序,但在某些情况下,邻近度处理优先级较高。 由于排序顺序取决于检测到的文本,因此它可能会在图像和 OCR 版本更新之间更改。 因此,业务逻辑应基于实际行位置而不是订单生成。

page
  • integer

输入文档中基于 1 的页码。

selectionMarks

从页面中提取的选择标记列表。

unit

宽度、高度和边界Box 属性使用的单位。 对于图像,该单元为“像素”。 对于 PDF,该单元为“英寸”。

width
  • number

图像/PDF 的宽度(以像素/英寸为单位)。

SelectionMark

有关提取的选择标记的信息。

Name Type Description
boundingBox
  • number[]

所选标记的边界框。

confidence
  • number

置信度值。

state enum:
  • selected
  • unselected

选择标记的状态。

Style

一个对象,表示文本行的样式。

Name Type Description
confidence
  • number

文本行样式的置信度。

name

文本行样式名称,包括手写和其他。

TextLine

一个表示提取的文本行的对象。

Name Type Description
appearance

文本外观属性。

boundingBox
  • number[]

提取行的边界框。

language

此行检测到的语言(如果不同于整个页面语言)。

text
  • string

行的文本内容。

words

文本行中的单词列表。

TextStyle

文本行样式名称,包括手写和其他。

Name Type Description
handwriting
  • string
other
  • string

TextWord

一个表示单词的对象。

Name Type Description
boundingBox
  • number[]

提取单词的边界框。

confidence
  • number

置信度值。

text
  • string

单词的文本内容。