Analyzer - Get Analyze Id Document Result

參考

服務:: Azure AI Services

API 版本:: 2.1

追蹤進度並取得分析標識符作業的結果。

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

URI 參數

名稱	位於	必要	類型	Description
endpoint	path	True	string	支援的認知服務端點 (通訊協定和主機名，例如： https://westus2.api.cognitive.microsoft.com) 。
resultId	path	True	string uuid	分析作業結果標識碼。

要求標頭

名稱	必要	類型	Description
Ocp-Apim-Subscription-Key	True	string

回應

名稱	類型	Description
200 OK	AnalyzeOperationResult	Success
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": []
  }
}

定義

名稱	Description
AnalyzeOperationResult	佇列分析作業的狀態和結果。
AnalyzeResult	分析作業結果。
Appearance	物件，表示文字行的外觀。
DataTable	包含在頁面中的擷取數據表相關信息。
DataTableCell	數據表中擷取之單元格的相關信息。
DocumentResult	對應至輸入檔的一組擷取欄位。
ErrorInformation
ErrorResponse
FieldValue	辨識的域值。
FieldValueType	域值的語意數據類型。
KeyValueElement	索引鍵/值組中擷取索引鍵或值的相關信息。
KeyValuePair	擷取之索引鍵/值組的相關信息。
KeyValueType	索引鍵值項目的語意數據類型。
LengthUnit	寬度、高度和周框Box 屬性所使用的單位。針對影像，單位為「圖元」。如果是 PDF，則單位為「inch」。
OperationStatus	佇列作業的狀態。
PageResult	從單一頁面擷取的資訊。
ReadResult	從輸入檔中的頁面擷取的文字。
SelectionMark	擷取選取標記的相關信息。
Style	物件，表示文字行的樣式。
TextLine	物件，表示擷取的文字行。
TextStyle	文字線條樣式名稱，包括手寫和其他名稱。
TextWord	代表單字的物件。

AnalyzeOperationResult

佇列分析作業的狀態和結果。

名稱	類型	Description
analyzeResult	AnalyzeResult	分析作業的結果。
createdDateTime	string	提交分析作業時的日期和時間 (UTC) 。
lastUpdatedDateTime	string	上次更新狀態的日期和時間 (UTC) 。
status	OperationStatus	作業狀態。

AnalyzeResult

分析作業結果。

名稱	類型	Description
documentResults	DocumentResult[]	從輸入擷取的文件層級資訊。
errors	ErrorInformation[]	分析作業期間報告的錯誤清單。
pageResults	PageResult[]	從輸入擷取的頁面層級資訊。
readResults	ReadResult[]	從輸入擷取的文字。
version	string	用於此結果的架構版本。

Appearance

物件，表示文字行的外觀。

名稱	類型	Description
style	Style	物件，表示文字行的樣式。

DataTable

包含在頁面中的擷取數據表相關信息。

名稱	類型	Description
boundingBox	number[]	數據表的周框方塊。
cells	DataTableCell[]	表格中包含的儲存格清單。
columns	integer	資料行數目。
rows	integer	資料列數目。

DataTableCell

數據表中擷取之單元格的相關信息。

名稱	類型	預設值	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

對應至輸入檔的一組擷取欄位。

名稱	類型	Description
docType	string	檔案類型。
docTypeConfidence	number	預測檔類型信賴度。
fields	<string, FieldValue>	具名域值的字典。
modelId	string	模型標識碼。
pageRange	integer[]	找到檔的第一頁和最後頁碼。

ErrorInformation

名稱	類型	Description
code	string
message	string

ErrorResponse

名稱	類型	Description
error	ErrorInformation

FieldValue

辨識的域值。

名稱	類型	Description
boundingBox	number[]	如果適用，則為域值的周框方塊。
confidence	number	信賴分數。
elements	string[]	當 includeTextDetails 設定為 true 時，會列出參照到此字段的文字元素。
page	integer	輸入檔中以 1 起始的頁碼。
text	string	擷取欄位的文字內容。
type	FieldValueType	域值的型別。
valueArray	FieldValue[]	域值的陣列。
valueCountryRegion	string	ISO 3166-1 alpha-3) 的 3 字母國家/地區代碼 (。
valueDate	string	日期值。
valueInteger	integer	整數值。
valueNumber	number	浮點值。
valueObject	<string, FieldValue>	具名域值的字典。
valuePhoneNumber	string	電話號碼值。
valueSelectionMark	enum: selected unselected	選取標記值。
valueString	string	字串值。
valueTime	string	時間值。

FieldValueType

域值的語意數據類型。

名稱	類型	Description
array	string
countryRegion	string
date	string
integer	string
number	string
object	string
phoneNumber	string
selectionMark	string
string	string
time	string

KeyValueElement

索引鍵/值組中擷取索引鍵或值的相關信息。

名稱	類型	Description
boundingBox	number[]	索引鍵或值的周框方塊。
elements	string[]	當 includeTextDetails 設定為 true 時，會列出參照此索引鍵或值的文字元素。
text	string	索引鍵或值的文字內容。
type	KeyValueType	索引鍵值項目的語意數據類型。

KeyValuePair

擷取之索引鍵/值組的相關信息。

名稱	類型	Description
confidence	number	信賴值。
key	KeyValueElement	索引鍵/值組中擷取金鑰的相關信息。
label	string	索引鍵/值組專案的使用者定義標籤。
value	KeyValueElement	索引鍵/值組中擷取值的相關信息。

KeyValueType

索引鍵值項目的語意數據類型。

名稱	類型	Description
selectionMark	string
string	string

LengthUnit

寬度、高度和周框Box 屬性所使用的單位。針對影像，單位為「圖元」。如果是 PDF，則單位為「inch」。

名稱	類型	Description
inch	string
pixel	string

OperationStatus

佇列作業的狀態。

名稱	類型	Description
failed	string
notStarted	string
running	string
succeeded	string

PageResult

從單一頁面擷取的資訊。

名稱	類型	Description
clusterId	integer	叢集標識碼。
keyValuePairs	KeyValuePair[]	從頁面擷取的索引鍵/值組清單。
page	integer	頁碼。
tables	DataTable[]	從頁面擷取的數據表清單。

ReadResult

從輸入檔中的頁面擷取的文字。

名稱	類型	Description
angle	number	以順時針方向測量文字的一般方向，以 (-180、180 之間的度為單位。
height	number	影像/PDF 的高度，分別以圖元/英吋為單位。
lines	TextLine[]	當 includeTextDetails 設定為 true 時，會列出可辨識的文字行。每頁傳回的行數上限為 300。這些行會依上至下、由左至右排序，但在某些情況下，會以較高的優先順序來處理鄰近性。隨著排序順序取決於偵測到的文字，它可能會隨著影像和 OCR 版本更新而變更。因此，商業規則應該建立在實際行位置而非順序上。
page	integer	輸入檔中以 1 起始的頁碼。
selectionMarks	SelectionMark[]	從頁面擷取的選取標記清單。
unit	LengthUnit	寬度、高度和周框Box 屬性所使用的單位。針對影像，單位為「圖元」。如果是 PDF，則單位為「inch」。
width	number	影像/PDF 的寬度，分別以圖元/英吋為單位。

SelectionMark

擷取選取標記的相關信息。

名稱	類型	Description
boundingBox	number[]	選取標記的周框方塊。
confidence	number	信賴值。
state	enum: selected unselected	選取標記的狀態。

Style

物件，表示文字行的樣式。

名稱	類型	Description
confidence	number	文字線條樣式的信賴度。
name	TextStyle	文字線條樣式名稱，包括手寫和其他名稱。

TextLine

物件，表示擷取的文字行。

名稱	類型	Description
appearance	Appearance	文字外觀屬性。
boundingBox	number[]	擷取行的周框方塊。
text	string	行的文字內容。
words	TextWord[]	文字行中的單字清單。

TextStyle

文字線條樣式名稱，包括手寫和其他名稱。

名稱	類型	Description
handwriting	string
other	string

TextWord

代表單字的物件。

名稱	類型	Description
boundingBox	number[]	已擷取文字的周框方塊。
confidence	number	信賴值。
text	string	文字的文字內容。

共用方式為