Document Classifiers - Get Classify Result

Service:

Azure AI Services

API Version:

2024-02-29-preview

取得文件分類器的結果。

GET {endpoint}/documentintelligence/documentClassifiers/{classifierId}/analyzeResults/{resultId}?api-version=2024-02-29-preview

URI 參數

名稱	位於	必要	類型	Description
classifierId	path	True	string	唯一的檔分類器名稱。 Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9._~-]{1,63}$
endpoint	path	True	string	Document Intelligence 服務端點。
resultId	path	True	string uuid	分析作業結果標識碼。
api-version	query	True	string	用於此作業的 API 版本。

回應

名稱	類型	Description
200 OK	AnalyzeResultOperation	要求已成功。
Other Status Codes	ErrorResponse	未預期的錯誤回應。

安全性

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Flow: accessCode
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize
Token URL: https://login.microsoftonline.com/common/oauth2/token

Scopes

名稱	Description
https://cognitiveservices.azure.com/.default

範例

Get Classify Document Result

Sample Request

HTTP

GET https://myendpoint.cognitiveservices.azure.com/documentintelligence/documentClassifiers/myClassifier/analyzeResults/3b31320d-8bab-4f88-b19c-2322a7f11034?api-version=2024-02-29-preview

Sample Response

Status code:

200

{
  "status": "succeeded",
  "createdDateTime": "2021-09-24T13:00:46Z",
  "lastUpdatedDateTime": "2021-09-24T13:00:49Z",
  "analyzeResult": {
    "apiVersion": "2024-02-29-preview",
    "modelId": "myClassifier",
    "stringIndexType": "textElements",
    "contentFormat": "text",
    "content": "",
    "pages": [
      {
        "pageNumber": 1,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 2,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      },
      {
        "pageNumber": 3,
        "width": 8.5,
        "height": 11,
        "unit": "inch",
        "spans": []
      }
    ],
    "documents": [
      {
        "docType": "formA",
        "boundingRegions": [
          {
            "pageNumber": 1,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          },
          {
            "pageNumber": 2,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      },
      {
        "docType": "formB",
        "boundingRegions": [
          {
            "pageNumber": 3,
            "polygon": [
              0,
              0,
              8.5,
              0,
              8.5,
              11,
              0,
              11
            ]
          }
        ],
        "confidence": 0.97,
        "spans": []
      }
    ]
  }
}

定義

名稱	Description
AddressValue	位址域值。
AnalyzeResult	檔分析結果。
AnalyzeResultOperation	分析作業的狀態和結果。
BoundingRegion	在輸入的特定頁面上周框多邊形。
ContentFormat	分析結果中的內容格式。
CurrencyValue	貨幣域值。
Document	物件，描述檔的位置和語意內容。
DocumentBarcode	條碼物件。
DocumentBarcodeKind	條碼種類。
DocumentCaption	描述數據表或圖表的 標題 物件。
DocumentField	物件，表示域值的內容和位置。
DocumentFieldType	域值的語意數據類型。
DocumentFigure	物件，表示檔中的圖表。
DocumentFootnote	描述數據表或圖表的腳注物件。
DocumentFormula	公式物件。
DocumentFormulaKind	公式種類。
DocumentKeyValueElement	物件，表示索引鍵/值組中的欄位索引鍵或值。
DocumentKeyValuePair	物件，代表具有不同欄位卷標的表單域， (索引鍵) 和域值 (可能是空的) 。
DocumentLanguage	物件，表示指定文字範圍的偵測到語言。
DocumentLine	內容行物件，由相鄰的內容元素序列組成，例如文字和選取標記。
DocumentList	物件，表示檔中的清單。
DocumentListItem	物件，表示檔中的清單專案。
DocumentPage	從輸入中擷取頁面的內容和版面配置元素。
DocumentParagraph	包含連續行的段落物件，通常具有一般對齊和間距。
DocumentSection	物件，表示檔中的區段。
DocumentSelectionMark	選取標記物件，代表複選框、單選按鈕，以及其他表示選取範圍的元素。
DocumentSelectionMarkState	選取標記的狀態。
DocumentSignatureType	簽章是否存在。
DocumentSpan	串連內容屬性的連續區域，指定為位移和長度。
DocumentStyle	物件，表示觀察到的文字樣式。
DocumentTable	表格物件，包含以矩形版面配置排列的表格單元格。
DocumentTableCell	物件，表示表格單元格的位置和內容。
DocumentTableCellKind	表格儲存格種類。
DocumentWord	由連續字元序列組成的 word 物件。 對於非空格分隔的語言，例如中文、日文和韓文，每個字元都會以自己的單字表示。
Error	錯誤物件。
ErrorResponse	錯誤回應物件。
FontStyle	字型樣式。
FontWeight	字型粗細。
InnerError	物件，包含有關錯誤的更特定資訊。
LengthUnit	寬度、高度和多邊形屬性所使用的單位。 針對影像，單位為「圖元」。 如果是 PDF，則單位為 「inch」。
OperationStatus	作業狀態。
ParagraphRole	段落的語意角色。
StringIndexType	用來計算字串位移和長度的方法。

AddressValue

位址域值。

名稱	類型	Description
city	string	城市、城市、城市、鄉鎮等的名稱。
cityDistrict	string	城市內的區域或城市，例如紐約市的 Brooklyn 或倫敦西部城市。
countryRegion	string	國家/地區。
house	string	組建名稱，例如 World Trade Center。
houseNumber	string	房屋或建築物編號。
level	string	樓層編號，例如 3F。
poBox	string	辦公室信箱號碼。
postalCode	string	用於郵件排序的郵遞區號。
road	string	街地名。
state	string	第一層系統管理部門。
stateDistrict	string	特定地區設定中使用的第二層系統管理部門。
streetAddress	string	街道層級位址，不包括城市、州、國家/地區和郵遞區號。
suburb	string	非官方的鄰近區名稱，例如中國城市。
unit	string	Apartment 或辦公室號碼

AnalyzeResult

檔分析結果。

名稱	類型	Description
apiVersion	string	用來產生此結果的 API 版本。
content	string	依閱讀順序串連所有文字和視覺元素的字串表示。
contentFormat	ContentFormat	分析結果最上層內容的格式。
documents	Document[]	擷取的檔。
figures	DocumentFigure[]	擷取的圖表。
keyValuePairs	DocumentKeyValuePair[]	擷取的索引鍵/值組。
languages	DocumentLanguage[]	偵測到的語言。
lists	DocumentList[]	擷取的清單。
modelId	string	用來產生此結果的檔模型標識碼。
pages	DocumentPage[]	分析的頁面。
paragraphs	DocumentParagraph[]	擷取的段落。
sections	DocumentSection[]	擷取的區段。
stringIndexType	StringIndexType	用來計算字串位移和長度的方法。
styles	DocumentStyle[]	擷取的字型樣式。
tables	DocumentTable[]	擷取的數據表。

AnalyzeResultOperation

分析作業的狀態和結果。

名稱	類型	Description
analyzeResult	AnalyzeResult	檔分析結果。
createdDateTime	string	提交分析作業時的日期和時間 (UTC) 。
error	Error	在檔案分析期間發生錯誤。
lastUpdatedDateTime	string	上次更新狀態的日期和時間 (UTC) 。
status	OperationStatus	作業狀態。 notStarted、執行中、成功或失敗

BoundingRegion

在輸入的特定頁面上周框多邊形。

名稱	類型	Description
pageNumber	integer	以 1 起始的頁碼，包含周框區域的頁碼。
polygon	number[]	頁面上的周框多邊形，如果未指定，則為整個頁面。 相對於頁面左上方指定的座標。 數位代表多邊形頂點的 x、y 值，從左方 (-180 度的順時針) 相對於專案方向。

ContentFormat

分析結果中的內容格式。

名稱	類型	Description
markdown	string	具有區段標題、表格等的文件內容的 Markdown 表示法。
text	string	文件內容的純文本表示，不含任何格式設定。

CurrencyValue

貨幣域值。

名稱	類型	Description
amount	number	貨幣金額。
currencyCode	string	已解決的貨幣代碼 (ISO 4217) ，如果有的話。
currencySymbol	string	貨幣符號標籤，如果有的話。

Document

物件，描述檔的位置和語意內容。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋檔的周框區域。
confidence	number	正確擷取檔信賴度。
docType	string	檔案類型。
fields	<string,  DocumentField>	具名域值的字典。
spans	DocumentSpan[]	以閱讀順序串連內容的檔案位置。

DocumentBarcode

條碼物件。

名稱	類型	Description
confidence	number	正確擷取條碼的信賴度。
kind	DocumentBarcodeKind	條碼種類。
polygon	number[]	條碼的周框多邊形，指定相對於頁面左上方的座標。 數位代表多邊形頂點的 x、y 值，從左方 (-180 度的順時針) 相對於專案方向。
span	DocumentSpan	讀取順序串連內容的條碼位置。
value	string	條碼值。

DocumentBarcodeKind

條碼種類。

名稱	類型	Description
Aztec	string	Aztec 程式代碼，如 ISO/IEC 24778：2008 中所定義。
Codabar	string	Codabar 條碼，如 ANSI/AIM BC3-1995 中所定義。
Code128	string	代碼 128 條碼，如 ISO/IEC 15417：2007 中所定義。
Code39	string	代碼 39 條碼，如 ISO/IEC 16388：2007 中所定義。
Code93	string	程序代碼 93 條碼，如 ANSI/AIM BC5-1995 中所定義。
DataBar	string	GS1 DataBar 條碼。
DataBarExpanded	string	GS1 DataBar 展開條碼。
DataMatrix	string	數據矩陣程序代碼，如 ISO/IEC 16022：2006 中所定義。
EAN13	string	GS1 13 位數國際發行項編號 (歐洲發行項編號) 。
EAN8	string	GS1 8 位數國際發行項編號 (歐洲發行項編號) 。
ITF	string	交錯 2/5 個條碼，如 ANSI/AIM BC2-1995 中所定義。
MaxiCode	string	MaxiCode，如 ISO/IEC 16023：2000 中所定義。
MicroQRCode	string	Micro QR 代碼，如 ISO/IEC 23941：2022 中所定義。
PDF417	string	PDF417，如 ISO 15438 中所定義。
QRCode	string	QR 代碼，如 ISO/IEC 18004：2015 中所定義。
UPCA	string	GS1 12 位數通用產品代碼。
UPCE	string	GS1 6 位數通用產品代碼。

DocumentCaption

描述數據表或圖表的 標題 物件。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋 標題 的周框區域。
content	string	標題的內容。
elements	string[]	標題 的子專案。
spans	DocumentSpan[]	讀取順序串連內容中 標題 的位置。

DocumentField

物件，表示域值的內容和位置。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋欄位的周框區域。
confidence	number	正確擷取字段的信賴度。
content	string	欄位內容。
spans	DocumentSpan[]	讀取順序串連內容中的欄位位置。
type	DocumentFieldType	域值的數據類型。
valueAddress	AddressValue	位址值。
valueArray	DocumentField[]	域值的陣列。
valueBoolean	boolean	布林值。
valueCountryRegion	string	ISO 3166-1 alpha-3) (3 字母國家/地區代碼值。
valueCurrency	CurrencyValue	貨幣值。
valueDate	string	YYYY-MM-DD 格式的日期值， (ISO 8601) 。
valueInteger	integer	整數值。
valueNumber	number	浮點值。
valueObject	<string,  DocumentField>	具名域值的字典。
valuePhoneNumber	string	E.164 格式的電話號碼值 (例如 +19876543210) 。
valueSelectionGroup	string[]	選取群組值。
valueSelectionMark	DocumentSelectionMarkState	選取標記值。
valueSignature	DocumentSignatureType	簽章是否存在。
valueString	string	字串值。
valueTime	string	hh：mm：ss 格式 (ISO 8601) 的時間值。

DocumentFieldType

域值的語意數據類型。

名稱	類型	Description
address	string	剖析的位址。
array	string	相同類型的子欄位清單。
boolean	string	布爾值，標準化為 true 或 false。
countryRegion	string	國家/地區，標準化為 ISO 3166-1 alpha-3 格式 (，例如美國) 。
currency	string	具有選擇性貨幣符號和單位的貨幣金額。
date	string	日期，標準化為 ISO 8601 (YYYY-MM-DD) 格式。
integer	string	整數數位，標準化為64位帶正負號的整數。
number	string	浮點數，標準化為雙精確度浮點數。
object	string	可能不同類型的子欄位具名清單。
phoneNumber	string	電話號碼，標準化為 E.164 (+{CountryCode}{SubscriberNumber}) 格式。
selectionGroup	string	選取字串值的陣列。
selectionMark	string	是否已選取欄位？
signature	string	簽章是否存在？
string	string	純文字。
time	string	標準化為 ISO 8601 (hh：mm：ss) 格式的時間。

DocumentFigure

物件，表示檔中的圖表。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋圖形的周框區域。
caption	DocumentCaption	與圖形相關聯的標題。
elements	string[]	圖的子元素，不包括任何 標題 或腳注。
footnotes	DocumentFootnote[]	與圖形相關聯的腳注清單。
spans	DocumentSpan[]	在讀取順序串連內容中的圖形位置。

DocumentFootnote

描述數據表或圖表的腳注物件。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋腳注的周框區域。
content	string	腳注的內容。
elements	string[]	腳注的子元素。
spans	DocumentSpan[]	閱讀順序串連內容的腳註位置。

DocumentFormula

公式物件。

名稱	類型	Description
confidence	number	正確擷取公式的信賴度。
kind	DocumentFormulaKind	公式種類。
polygon	number[]	公式的周框多邊形，指定相對於頁面左上方的座標。 數位代表多邊形頂點的 x、y 值，從左方 (-180 度的順時針) 相對於專案方向。
span	DocumentSpan	在讀取順序串連內容中的公式位置。
value	string	描述公式的 LaTex 運算式。

DocumentFormulaKind

公式種類。

名稱	類型	Description
display	string	顯示模式中佔用整行的公式。
inline	string	內嵌在段落內容中的公式。

DocumentKeyValueElement

物件，表示索引鍵/值組中的欄位索引鍵或值。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋索引鍵/值專案的周框區域。
content	string	依閱讀順序串連索引鍵/值項目的內容。
spans	DocumentSpan[]	在讀取順序串連內容中索引鍵/值專案的位置。

DocumentKeyValuePair

物件，代表具有不同欄位卷標的表單域， (索引鍵) 和域值 (可能是空的) 。

名稱	類型	Description
confidence	number	正確擷取索引鍵/值組的信賴度。
key	DocumentKeyValueElement	索引鍵/值組的欄位標籤。
value	DocumentKeyValueElement	索引鍵/值組的域值。

DocumentLanguage

物件，表示指定文字範圍的偵測到語言。

名稱	類型	Description
confidence	number	正確識別語言的信賴度。
locale	string	偵測到的語言。 值可以是 ISO 639-1 語言代碼 (例如 “en”、“fr”) 或 BCP 47 語言標記 (例如 “zh-Hans”) 。
spans	DocumentSpan[]	語言所套用之串連內容中的文字元素位置。

DocumentLine

內容行物件，由相鄰的內容元素序列組成，例如文字和選取標記。

名稱	類型	Description
content	string	依閱讀順序串連包含之元素的內容。
polygon	number[]	線條的周框多邊形，其中指定相對於頁面左上方的座標。 數位代表多邊形頂點的 x、y 值，從左方 (-180 度的順時針) 相對於專案方向。
spans	DocumentSpan[]	在閱讀順序串連內容中的行位置。

DocumentList

物件，表示檔中的清單。

名稱	類型	Description
items	DocumentListItem[]	清單中的專案。
spans	DocumentSpan[]	以閱讀順序串連內容的清單位置。

DocumentListItem

物件，表示檔中的清單專案。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋清單專案的周框區域。
content	string	清單項目的內容。
elements	string[]	清單專案的子專案。
level	integer	清單專案 (1 個索引) 的層級。
spans	DocumentSpan[]	讀取順序串連內容中的清單專案位置。

DocumentPage

從輸入中擷取頁面的內容和版面配置元素。

名稱	類型	Description
angle	number	以順時針方向測量內容的一般方向，以 (-180、180 之間的度為單位。
barcodes	DocumentBarcode[]	已從頁面擷取條碼。
formulas	DocumentFormula[]	從頁面擷取的公式。
height	number	影像/PDF 的高度，分別以圖元/英吋為單位。
lines	DocumentLine[]	從頁面擷取的行，可能同時包含文字和視覺元素。
pageNumber	integer	輸入檔中以 1 起始的頁碼。
selectionMarks	DocumentSelectionMark[]	從頁面擷取選取標記。
spans	DocumentSpan[]	以閱讀順序串連內容的頁面位置。
unit	LengthUnit	寬度、高度和多邊形屬性所使用的單位。 針對影像，單位為「圖元」。 如果是 PDF，則單位為 「inch」。
width	number	影像/PDF 的寬度，分別以圖元/英吋為單位。
words	DocumentWord[]	從頁面擷取的字組。

DocumentParagraph

包含連續行的段落物件，通常具有一般對齊和間距。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋段落的周框區域。
content	string	以閱讀順序串連段落的內容。
role	ParagraphRole	段落的語意角色。
spans	DocumentSpan[]	讀取順序串連內容的段落位置。

DocumentSection

物件，表示檔中的區段。

名稱	類型	Description
elements	string[]	區段的子元素。
spans	DocumentSpan[]	讀取順序串連內容的區段位置。

DocumentSelectionMark

選取標記物件，代表複選框、單選按鈕，以及其他表示選取範圍的元素。

名稱	類型	Description
confidence	number	正確擷取選取標記的信賴度。
polygon	number[]	選取標記的周框多邊形，指定相對於頁面左上方的座標。 數位代表多邊形頂點的 x、y 值，從左方 (-180 度的順時針) 相對於專案方向。
span	DocumentSpan	讀取順序串連內容中選取標記的位置。
state	DocumentSelectionMarkState	選取標記的狀態。

DocumentSelectionMarkState

選取標記的狀態。

名稱	類型	Description
selected	string	選取標記是選取的，通常以選取標記內的複選 ✓ 或交叉 X 表示。
unselected	string	未選取選取標記。

DocumentSignatureType

簽章是否存在。

名稱	類型	Description
signed	string	偵測到簽章。
unsigned	string	不會偵測到簽章。

DocumentSpan

串連內容屬性的連續區域，指定為位移和長度。

名稱	類型	Description
length	integer	範圍所代表內容中的字元數。
offset	integer	範圍所代表內容的以零起始的索引。

DocumentStyle

物件，表示觀察到的文字樣式。

名稱	類型	Description
backgroundColor	string	#rrggbb 十六進位格式的背景色彩。
color	string	#rrggbb 十六進位格式的前景色彩。
confidence	number	正確識別樣式的信賴度。
fontStyle	FontStyle	字型樣式。
fontWeight	FontWeight	字型粗細。
isHandwritten	boolean	內容是否手寫？
similarFontFamily	string	從支援的字型系列集合中，以可視化方式最類似的字型，其後援字型遵循 CSS 慣例 (例如 'Arial， sans-serif') 。
spans	DocumentSpan[]	樣式所套用之串連內容中的文字元素位置。

DocumentTable

表格物件，包含以矩形版面配置排列的表格單元格。

名稱	類型	Description
boundingRegions	BoundingRegion[]	涵蓋數據表的周框區域。
caption	DocumentCaption	與數據表相關聯的標題。
cells	DocumentTableCell[]	表格中包含的儲存格。
columnCount	integer	數據表中的數據行數目。
footnotes	DocumentFootnote[]	與數據表相關聯的腳注清單。
rowCount	integer	資料表中的資料列數。
spans	DocumentSpan[]	在讀取順序串連內容中的數據表位置。

DocumentTableCell

物件，表示表格單元格的位置和內容。

名稱	類型	預設值	Description
boundingRegions	BoundingRegion[]		涵蓋表格儲存格的周框區域。
columnIndex	integer		單元格的數據行索引。
columnSpan	integer	1	此儲存格跨越的數據列數目。
content	string		依閱讀順序串連數據表單元格的內容。
elements	string[]		數據表單元格的子元素。
kind	DocumentTableCellKind	content	表格儲存格種類。
rowIndex	integer		單元格的數據列索引。
rowSpan	integer	1	此儲存格跨越的數據列數目。
spans	DocumentSpan[]		在讀取順序串連內容中的表格單元格位置。

DocumentTableCellKind

表格儲存格種類。

名稱	類型	Description
columnHeader	string	描述數據行的內容。
content	string	包含主要內容/數據。
description	string	描述數據表中) (部分的內容。
rowHeader	string	描述數據列的內容。
stubHead	string	描述數據列標頭，通常位於數據表的左上角。

DocumentWord

由連續字元序列組成的 word 物件。 對於非空格分隔的語言，例如中文、日文和韓文，每個字元都會以自己的單字表示。

名稱	類型	Description
confidence	number	正確擷取文字的信賴度。
content	string	文字內容的文字內容。
polygon	number[]	文字的周框多邊形，指定相對於頁面左上方的座標。 數位代表多邊形頂點的 x、y 值，從左方 (-180 度的順時針) 相對於專案方向。
span	DocumentSpan	在閱讀順序中串連內容的字組位置。

Error

錯誤物件。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
details	Error[]	導致此錯誤之特定錯誤的詳細數據陣列。
innererror	InnerError	物件，包含比目前對象有關錯誤的更特定資訊。
message	string	人類看得懂的錯誤表示法。
target	string	錯誤的目標。

ErrorResponse

錯誤回應物件。

名稱	類型	Description
error	Error	錯誤資訊。

FontStyle

字型樣式。

名稱	類型	Description
italic	string	字元會以視覺方式斜向右傾斜。
normal	string	字元通常會表示。

FontWeight

字型粗細。

名稱	類型	Description
bold	string	字元會以較粗的筆劃表示。
normal	string	字元通常會表示。

InnerError

物件，包含有關錯誤的更特定資訊。

名稱	類型	Description
code	string	其中一組伺服器定義的錯誤碼。
innererror	InnerError	內部錯誤。
message	string	人類看得懂的錯誤表示法。

LengthUnit

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

名稱	類型	Description
inch	string	PDF 檔案的長度單位。
pixel	string	圖像檔案的長度單位。

OperationStatus

作業狀態。

名稱	類型	Description
canceled	string	作業已取消。
completed	string	作業已完成。
failed	string	作業失敗。
notStarted	string	作業尚未啟動。
running	string	作業正在進行中。
succeeded	string	此作業已成功。

ParagraphRole

段落的語意角色。

名稱	類型	Description
footnote	string	通常放在頁面上主要內容之後的附註。
formulaBlock	string	公式區塊，通常具有共用對齊方式。
pageFooter	string	靠近頁面下邊緣的文字。
pageHeader	string	靠近頁面上邊緣的文字。
pageNumber	string	頁碼。
sectionHeading	string	描述檔區段的子標題。
title	string	描述整份檔的最上層標題。

StringIndexType

用來計算字串位移和長度的方法。

名稱	類型	Description
textElements	string	使用者感知的顯示字元或 grapheme 叢集，如 Unicode 8.0.0 所定義。
unicodeCodePoint	string	以單一 Unicode 字碼指標表示的字元單位。 由 Python 3 使用。
utf16CodeUnit	string	以16位Unicode字碼單位表示的字元單位。 由 JavaScript、Java 和 .NET 使用。