共用方式為


Azure AI 文件智慧服務 (表單辨識器)

根據預先訓練的模型(佈局、發票、收據、ID、名片)或自訂模型,將文字(列印和手寫 OCR)和其他資訊(表格、複選框、欄位/鍵值組)從 PDF、圖像或 Microsoft Office 文件和表單中提取為結構化資料,這些模型由一組使用 AI 驅動的文件理解的代表性訓練表單創建。

此連接器適用於以下產品和區域:

服務 Class Regions
副駕駛工作室 標準 除下列區域外的所有 Power Automate 區域
     - 美國國防部 (DoD)
邏輯應用程式 標準 所有 Logic Apps 區域, 但下列區域除外:
     - 美國國防部 (DoD)
Power Apps - 無法提供
Power Automate(自動化服務) 標準 除下列區域外的所有 Power Automate 區域
     - 美國國防部 (DoD)
連絡人​​
名稱 Microsoft
URL https://aka.ms/formrecognizer
Email formrecog_contact@microsoft.com
連接器中繼資料
Publisher Microsoft
網站 https://aka.ms/formrecognizer
隱私策略 https://aka.ms/form-recognizer/privacy
類別 人工智慧;商業智慧

Azure AI 文件智慧服務 (先前稱為表單辨識器) 連接器提供與 Azure AI 文件智慧服務的整合。 它允許 從表格、發票、收據、名片、身份證件和多種其他文檔類型中分析和提取信息。

先決條件

若要使用此整合,您需要 Azure 入口網站中的 Azure AI 文件智慧服務資源 。 建立資源 連結。 您將獲得一個端點和一個用於驗證應用程式的金鑰。 若要建立連線,請提供帳戶金鑰、網站 URL,然後選取 建立連線。 有關連線的營運成本,請 在此處深入瞭解。

如何取得認證

  1. 在 Azure 入口網站中開啟文件智慧服務資源 (請參閱 必要條件)。
  2. 選取資源管理下的金鑰和端點
  3. 複製 端點金鑰 ,並使用它們來建立新的連線。

開始使用連接器

嘗試文件智慧服務連接器的最簡單方式是使用任何預先建置的模型 (預先建置發票、預先建置版面配置等)。 提供文件的 PDF 或影像。 根據您的文件類型使用連接器操作進行分析,並檢查偵測到的欄位。 此處 型號和支援功能的完整清單。

正在建立連線

連接器支援下列驗證類型:

API 金鑰 提供文件智慧資源名稱與 API 金鑰。 所有區域 可共用
Logic Apps 受控識別 使用 LogicApps 受控識別建立連線 僅限 LOGICAPPS 可共用
Microsoft Entra ID 整合式 使用 Microsoft Entra ID 來存取 所有區域 不可共享
預設值 [已棄用] 此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。 所有區域 不可共享

API 金鑰

驗證 ID:keyBasedAuth

適用:所有地區

提供文件智慧資源名稱與 API 金鑰。

這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱 類型 Description 為必填項目
帳戶金鑰 securestring 文件智慧服務帳戶金鑰
端點 URL 字串 文件智慧服務端點 URL (範例: https://your-documentintelligence-resource.cognitiveservices.azure.com/

Logic Apps 受控識別

驗證 ID:managedIdentityAuth

適用:僅限 LOGICAPPS

使用 LogicApps 受控識別建立連線

這是可共享的連接。 如果 Power App 與其他使用者共用,也會共用連線。 如需詳細資訊,請參閱 畫布應用程式的連接器概觀 - Power Apps |Microsoft 文件

名稱 類型 Description 為必填項目
LogicApps 受控識別 managedIdentity 使用 Logic Apps 受控識別登入
端點 URL 字串 文件智慧服務端點 URL (範例: https://your-documentintelligence-resource.cognitiveservices.azure.com/

Microsoft Entra ID 整合

驗證 ID:oauth

適用:所有地區

使用 Microsoft Entra ID 來存取

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
端點 URL 字串 文件智慧服務端點 URL (範例: https://your-documentintelligence-resource.cognitiveservices.azure.com/

預設值 [已棄用]

適用:所有地區

此選項僅適用於沒有明確驗證類型的舊連線,並且僅用於回溯相容性。

這不是可共用的連線。 如果 Power App 與其他使用者共用,系統會明確提示其他使用者建立新連線。

名稱 類型 Description 為必填項目
帳戶金鑰 securestring 文件智慧服務帳戶金鑰
端點 URL 字串 文件智慧服務端點 URL (範例: https://your-documentintelligence-resource.cognitiveservices.azure.com/

節流限制

名稱 呼叫 續約期間
每個連線的 API 呼叫 1200 60 秒

動作

使用文件分類器對文件進行分類 (v3.1 API)

使用文檔分類器(v3.1 API)對文檔進行分類。

使用文件分類器對文件進行分類 (v4.x API)

使用文檔分類器 (v4.x API) 對文檔進行分類。

分析名片 (已淘汰) [已淘汰]

從指定的名片文件中擷取欄位文字和語意值(已棄用)。

分析收據 (已棄用) [已棄用]

從指定的收據文件中擷取欄位文字和語意值(已棄用)。

分析版面配置 (已淘汰) [已淘汰]

從指定文件擷取文字和版面配置資訊 (已棄用)。

分析發票 (已淘汰) [已淘汰]

從指定的發票文件中擷取欄位文字和語意值(已棄用)。

分析自訂表單 (已淘汰) [已淘汰]

從指定文件中擷取索引鍵值組、表格和語意值 (已棄用)。

分析身分證件 (已淘汰) [已淘汰]

從指定的 ID 文件中擷取欄位文字和語意值 (已棄用)。

分析預先建置或自訂模型的文件 (v3.x API)

從給定文件(v3.x API)中提取鍵值組、表格和語意值。

分析預先建置或自訂模型的文件 (v4.x API)

從指定文件 (v4.x API) 擷取索引鍵值組、資料表和語意值。

使用文件分類器對文件進行分類 (v3.1 API)

使用文檔分類器(v3.1 API)對文檔進行分類。

參數

名稱 機碼 必要 類型 Description
分類器識別碼
classifierId True string

格式 - [a-zA-Z0-9][a-zA-Z0-9._~-]。{1,63} 唯一的分類器名稱。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從個別頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

用於文字辨識和文件分析的地區設定提示。 值只能包含語言代碼(例如“en”、“fr”)或BCP 47語言標籤(例如“en-US”)。

字串索引類型
stringIndexType string

用來計算字串偏移和長度的方法。 支援的選項:textElements、unicodeCodePoint、utf16CodeUnit。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或圖像 (JPG、PNG、BMP、TIFF) 文件。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

分析作業的狀態和結果。

使用文件分類器對文件進行分類 (v4.x API)

使用文檔分類器 (v4.x API) 對文檔進行分類。

參數

名稱 機碼 必要 類型 Description
文件智慧服務 API 版本
api-version True string

文件智慧服務 API 版本。

分類器識別碼
classifierId True string

格式 - [a-zA-Z0-9][a-zA-Z0-9._~-]。{1,63} 唯一的分類器名稱。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或圖像 (JPG、PNG、BMP、TIFF) 文件。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

分割模式
split string

檔案分割行為。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從個別頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

用於文字辨識和文件分析的地區設定提示。 值只能包含語言代碼(例如“en”、“fr”)或BCP 47語言標籤(例如“en-US”)。

字串索引類型
stringIndexType string

用來計算字串偏移和長度的方法。 支援的選項:textElements、unicodeCodePoint、utf16CodeUnit。

傳回

分析作業的狀態和結果。

分析名片 (已淘汰) [已淘汰]

從指定的名片文件中擷取欄位文字和語意值(已棄用)。

參數

名稱 機碼 必要 類型 Description
包含文字詳細資料
includeTextDetails boolean

在結果中包含文字行和元素參考。 預設值:True (僅適用於 FR 連接器)。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

發票的地區設定。 支援的地區設定包括:en-US。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或影像 (JPG 或 PNG) 檔案。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

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

分析收據 (已棄用) [已棄用]

從指定的收據文件中擷取欄位文字和語意值(已棄用)。

參數

名稱 機碼 必要 類型 Description
包含文字詳細資料
includeTextDetails boolean

在結果中包含文字行和元素參考。 預設值:True (僅適用於 FR 連接器)。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

發票的地區設定。 支援的地區設定包括:en-US。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或影像 (JPG 或 PNG) 檔案。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

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

分析版面配置 (已淘汰) [已淘汰]

從指定文件擷取文字和版面配置資訊 (已棄用)。

參數

名稱 機碼 必要 類型 Description
頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

語言
language string

文件中文字的 BCP-47 語言代碼。

閱讀順序
readingOrder string

選擇性參數,用於指定在對擷取文字元素進行排序時應套用的讀取順序演算法。 可以是“基本”或“自然”。 如果未指定,將預設為基本。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或影像 (JPG 或 PNG) 檔案。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

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

分析發票 (已淘汰) [已淘汰]

從指定的發票文件中擷取欄位文字和語意值(已棄用)。

參數

名稱 機碼 必要 類型 Description
包含文字詳細資料
includeTextDetails boolean

在結果中包含文字行和元素參考。 預設值:True (僅適用於 FR 連接器)。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

發票的地區設定。 支援的地區設定包括:en-US。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或影像 (JPG 或 PNG) 檔案。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

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

分析自訂表單 (已淘汰) [已淘汰]

從指定文件中擷取索引鍵值組、表格和語意值 (已棄用)。

參數

名稱 機碼 必要 類型 Description
模型識別碼
modelId True string

格式 - uuid。 模型識別碼。

包含文字詳細資料
includeTextDetails boolean

在結果中包含文字行和元素參考。 預設值:True (僅適用於 FR 連接器)。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或影像 (JPG 或 PNG) 檔案。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

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

分析身分證件 (已淘汰) [已淘汰]

從指定的 ID 文件中擷取欄位文字和語意值 (已棄用)。

參數

名稱 機碼 必要 類型 Description
包含文字詳細資料
includeTextDetails boolean

在結果中包含文字行和元素參考。 預設值:True (僅適用於 FR 連接器)。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或影像 (JPG 或 PNG) 檔案。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

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

分析預先建置或自訂模型的文件 (v3.x API)

從給定文件(v3.x API)中提取鍵值組、表格和語意值。

參數

名稱 機碼 必要 類型 Description
文件智慧服務 API 版本
api-version True string

文件智慧服務 API 版本。

模型識別碼
modelId True string

預先建置的 modelIds:預先建置讀取、預先建置版面配置、預先建置文件、預先建置 businessCard、預先建置 idDocument、預先建置發票、預先建置收據、prebuilt-tax.us.w2、prebuilt-vaccinationCard prebuilt-healthInsuranceCard.us。 自訂 modelId 格式 - [a-zA-Z0-9][a-zA-Z0-9._~-]。{1,63} 唯一的型號名稱。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

用於文字辨識和文件分析的地區設定提示。 值只能包含語言代碼(例如“en”、“fr”)或BCP 47語言標籤(例如“en-US”)。

字串索引類型
stringIndexType string

用來計算字串偏移和長度的方法。 支援的選項:textElements、unicodeCodePoint、utf16CodeUnit。

可選和進階功能
features array

選用分析功能清單 (例如 ocrHighResolution、語言、條碼、公式、keyValuePairs 和 styleFont)。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或圖像 (JPG、PNG、BMP、TIFF) 文件。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

傳回

分析作業的狀態和結果。

分析預先建置或自訂模型的文件 (v4.x API)

從指定文件 (v4.x API) 擷取索引鍵值組、資料表和語意值。

參數

名稱 機碼 必要 類型 Description
文件智慧服務 API 版本
api-version True string

文件智慧服務 API 版本。

模型識別碼
modelId True string

預先建置的 modelIds:預先建置讀取、預先建置的版面配置、預先建置的 businessCard、預先建置的 idDocument、預先建置的發票、預先建置收據、預先建置的 tax.us.w2、預先建置的疫苗接種卡、prebuilt-healthInsuranceCard.us、預先建置的 tax.us.1098、prebuilt-tax.us.1098E、prebuilt-tax.us.1098T、預先建置合約等。自訂 modelId 格式 - [a-zA-Z0-9][a-zA-Z0-9._~-]。{1,63} 唯一的型號名稱。

文件/影像檔案內容
inputFileContent binary

要分析的 PDF 文件或圖像 (JPG、PNG、BMP、TIFF) 文件。

文件/影像 URL
inputFileUrl string

輸入檔案的 URL 路徑。 文件/影像檔案內容的替代方案。

頁面
pages string

多頁 PDF 和 TIFF 文件的頁面選擇,透過輸入以逗號分隔的頁碼和範圍(例如「2、5-7」),從單一頁面和一系列頁面(例如第 2 頁和第 5-7 頁)中提取發票資訊。 如果未設定,則會處理所有頁面。

Locale
locale string

用於文字辨識和文件分析的地區設定提示。 值只能包含語言代碼(例如“en”、“fr”)或BCP 47語言標籤(例如“en-US”)。

字串索引類型
stringIndexType string

用來計算字串偏移和長度的方法。 支援的選項:textElements、unicodeCodePoint、utf16CodeUnit。

可選和進階功能
features array

選用分析功能清單 (例如 ocrHighResolution、語言、條碼、公式、keyValuePairs、styleFont 和 queryFields)。

查詢欄位
queryFields array

要擷取的其他欄位清單。 例如 「客人數量,商店號碼」

輸出內容格式
outputContentFormat string

分析結果頂層內容的格式。

傳回

分析作業的狀態和結果。

定義

OperationStatus

佇列作業的狀態。

佇列作業的狀態。

LayoutAnalyzeOperation結果

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

名稱 路徑 類型 Description
狀態
status OperationStatus

佇列作業的狀態。

createdDateTime
createdDateTime string

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime string

上次更新狀態的日期和時間 (UTC)。

分析結果
analyzeResult LayoutAnalyzeResult

分析操作結果。

InvoiceAnalyzeOperation結果

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

名稱 路徑 類型 Description
狀態
status OperationStatus

佇列作業的狀態。

createdDateTime
createdDateTime string

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime string

上次更新狀態的日期和時間 (UTC)。

分析結果
analyzeResult InvoiceAnalyzeResult

分析操作結果。

BusinessCardAnalyzeOperationResult

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

名稱 路徑 類型 Description
狀態
status OperationStatus

佇列作業的狀態。

createdDateTime
createdDateTime string

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime string

上次更新狀態的日期和時間 (UTC)。

分析結果
analyzeResult BusinessCardAnalyzeResult

分析操作結果。

收據分析作業結果

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

名稱 路徑 類型 Description
狀態
status OperationStatus

佇列作業的狀態。

createdDateTime
createdDateTime string

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime string

上次更新狀態的日期和時間 (UTC)。

分析結果
analyzeResult ReceiptAnalyzeResult

分析操作結果。

IdAnalyzeOperation結果

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

名稱 路徑 類型 Description
狀態
status OperationStatus

佇列作業的狀態。

createdDateTime
createdDateTime string

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime string

上次更新狀態的日期和時間 (UTC)。

分析結果
analyzeResult IdAnalyzeResult

分析操作結果。

CustomFormsAnalyzeOperation結果

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

名稱 路徑 類型 Description
狀態
status OperationStatus

佇列作業的狀態。

createdDateTime
createdDateTime string

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime string

上次更新狀態的日期和時間 (UTC)。

分析結果
analyzeResult CustomFormsAnalyzeResult

分析操作結果。

FormOperation錯誤

作業期間報告的錯誤。

名稱 路徑 類型 Description
訊息
message string

錯誤訊息。

版面配置分析結果

分析操作結果。

名稱 路徑 類型 Description
版本
version string

用於此結果的結構描述版本。

read結果
readResults array of ReadResult

從輸入擷取的文字。

頁面結果
pageResults array of PageResult

從輸入擷取的頁面層級資訊。

錯誤
errors array of FormOperationError

分析作業期間報告的錯誤清單。

發票分析結果

分析操作結果。

名稱 路徑 類型 Description
版本
version string

用於此結果的結構描述版本。

read結果
readResults array of ReadResult

從輸入擷取的文字。

頁面結果
pageResults array of PageResult

從輸入擷取的頁面層級資訊。

文件結果
documentResults array of InvoiceDocumentResult

從輸入擷取的文件層級資訊。

錯誤
errors array of FormOperationError

分析作業期間報告的錯誤清單。

名片分析結果

分析操作結果。

名稱 路徑 類型 Description
版本
version string

用於此結果的結構描述版本。

read結果
readResults array of ReadResult

從輸入擷取的文字。

頁面結果
pageResults array of PageResult

從輸入擷取的頁面層級資訊。

文件結果
documentResults array of BusinessCardDocumentResult

從輸入擷取的文件層級資訊。

錯誤
errors array of FormOperationError

分析作業期間報告的錯誤清單。

收據分析結果

分析操作結果。

名稱 路徑 類型 Description
版本
version string

用於此結果的結構描述版本。

read結果
readResults array of ReadResult

從輸入擷取的文字。

頁面結果
pageResults array of PageResult

從輸入擷取的頁面層級資訊。

文件結果
documentResults array of ReceiptDocumentResult

從輸入擷取的文件層級資訊。

錯誤
errors array of FormOperationError

分析作業期間報告的錯誤清單。

IdAnalyze結果

分析操作結果。

名稱 路徑 類型 Description
版本
version string

用於此結果的結構描述版本。

read結果
readResults array of ReadResult

從輸入擷取的文字。

頁面結果
pageResults array of PageResult

從輸入擷取的頁面層級資訊。

文件結果
documentResults array of IdDocumentResult

從輸入擷取的文件層級資訊。

錯誤
errors array of FormOperationError

分析作業期間報告的錯誤清單。

CustomFormsAnalyze結果

分析操作結果。

名稱 路徑 類型 Description
版本
version string

用於此結果的結構描述版本。

read結果
readResults array of ReadResult

從輸入擷取的文字。

頁面結果
pageResults array of PageResult

從輸入擷取的頁面層級資訊。

文件結果
documentResults array of CustomFormsDocumentResult

從輸入擷取的文件層級資訊。

錯誤
errors array of FormOperationError

分析作業期間報告的錯誤清單。

讀取結果

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

名稱 路徑 類型 Description
頁面
page integer

輸入文件中從 1 開始的頁碼。

angle float

文本順時針方向的一般方向,以 (-180, 180) 之間的度數測量。

寬度
width float

影像/PDF的寬度,分別以像素/英吋為單位。

height
height float

影像/PDF 的高度,分別以像素/英吋為單位。

單位
unit string

width、height 和 boundingBox 屬性所使用的單位。 對於圖像,單位為“像素”。 對於 PDF,單位為“英寸”。

lines array of TextLine

當 includeTextDetails 設定為 true 時,可辨識的文字行清單。 傳回的行數上限為每頁 300 行。 這些行會從上到下、從左到右排序,但在某些情況下,鄰近會以更高的優先順序處理。 由於排序順序取決於偵測到的文本,因此它可能會隨著圖像和 OCR 版本更新而變化。 因此,商務邏輯應該建置在實際的行位置上,而不是順序。

文字線

代表擷取文字行的物件。

名稱 路徑 類型 Description
收發簡訊
text string

該行的文字內容。

邊界框
boundingBox BoundingBox

四邊形邊界框,其座標相對於原始影像的左上方指定。 八個數字代表四個點,從左上角相對於文字方向順時針方向。 對於影像,(x, y) 座標以像素為單位。 對於 PDF,(x, y) 座標以英吋為單位。

words
words array of TextWord

文字行中的單字清單。

文字詞

代表單字的物件。

名稱 路徑 類型 Description
收發簡訊
text string

字組的文字內容。

邊界框
boundingBox BoundingBox

四邊形邊界框,其座標相對於原始影像的左上方指定。 八個數字代表四個點,從左上角相對於文字方向順時針方向。 對於影像,(x, y) 座標以像素為單位。 對於 PDF,(x, y) 座標以英吋為單位。

信賴度
confidence Confidence

置信值。

邊界框

四邊形邊界框,其座標相對於原始影像的左上方指定。 八個數字代表四個點,從左上角相對於文字方向順時針方向。 對於影像,(x, y) 座標以像素為單位。 對於 PDF,(x, y) 座標以英吋為單位。

名稱 路徑 類型 Description
物品
float

頁面結果

從單個頁面中提取的信息。

名稱 路徑 類型 Description
頁面
page integer

頁碼。

clusterId
clusterId integer

叢集識別碼。

keyValuePairs
keyValuePairs array of KeyValuePair

從頁面擷取的索引鍵值組清單。

tables
tables array of DataTable

從頁面擷取的資料表清單。

KeyValuePair

擷取索引鍵值組的相關資訊。

名稱 路徑 類型 Description
標籤
label string

索引鍵/值組項目的使用者定義標籤。

Key
key KeyValueElement

索引鍵值組中擷取索引鍵或值的相關資訊。

value
value KeyValueElement

索引鍵值組中擷取索引鍵或值的相關資訊。

信賴度
confidence Confidence

置信值。

KeyValue元素

索引鍵值組中擷取索引鍵或值的相關資訊。

名稱 路徑 類型 Description
收發簡訊
text string

索引鍵或值的文字內容。

邊界框
boundingBox BoundingBox

四邊形邊界框,其座標相對於原始影像的左上方指定。 八個數字代表四個點,從左上角相對於文字方向順時針方向。 對於影像,(x, y) 座標以像素為單位。 對於 PDF,(x, y) 座標以英吋為單位。

元素
elements array of ElementReference

當 includeTextDetails 設定為 true 時,這是構成此索引鍵或值之文字元素的參考清單。

元素參考

對行或單字的引用。

對行或單字的引用。

資料表

頁面中包含的擷取表格的相關資訊。

名稱 路徑 類型 Description
資料列
rows integer

列數。

columns
columns integer

欄數。

細胞
cells array of DataTableCell

表格中包含的儲存格清單。

資料表儲存格

表格中擷取儲存格的相關資訊。

名稱 路徑 類型 Description
行索引
rowIndex integer

儲存格的列索引。

直欄索引
columnIndex integer

儲存格的資料行索引。

rowSpan (行跨度)
rowSpan integer

此儲存格跨越的資料列數。

資料行跨度
columnSpan integer

此儲存格跨越的資料行數。

收發簡訊
text string

儲存格的文字內容。

邊界框
boundingBox BoundingBox

四邊形邊界框,其座標相對於原始影像的左上方指定。 八個數字代表四個點,從左上角相對於文字方向順時針方向。 對於影像,(x, y) 座標以像素為單位。 對於 PDF,(x, y) 座標以英吋為單位。

元素
elements array of ElementReference

當 includeTextDetails 設定為 true 時,會是構成此表格儲存格之文字元素的參考清單。

is標頭
isHeader boolean

如果目前儲存格是標頭儲存格,則傳回。

is頁尾
isFooter boolean

如果目前儲存格是頁尾儲存格,則傳回。

發票文件結果

一組擷取的欄位,對應至輸入文件。

名稱 路徑 類型 Description
文件類型
docType string

文件類型。

page範圍
pageRange array of integer

找到文件的第一個和最後一個頁碼。

fields
fields InvoiceFields

2.1 的發票欄位。

BusinessCardDocument結果

一組擷取的欄位,對應至輸入文件。

名稱 路徑 類型 Description
文件類型
docType string

文件類型。

page範圍
pageRange array of integer

找到文件的第一個和最後一個頁碼。

fields
fields BusinessCardFields

2.1 的 BusinessCard 欄位。

CustomFormsDocument結果

一組擷取的欄位,對應至輸入文件。

名稱 路徑 類型 Description
文件類型
docType string

文件類型。

page範圍
pageRange array of integer

找到文件的第一個和最後一個頁碼。

Fields
_fields array of CustomFormsFields

具有 fieldName 和 fieldValue 屬性的欄位陣列。

收據文件結果

一組擷取的欄位,對應至輸入文件。

名稱 路徑 類型 Description
文件類型
docType string

文件類型。

page範圍
pageRange array of integer

找到文件的第一個和最後一個頁碼。

fields
fields ReceiptFields

Receipt欄位。

IdDocument結果

一組擷取的欄位,對應至輸入文件。

名稱 路徑 類型 Description
文件類型
docType string

文件類型。

page範圍
pageRange array of integer

找到文件的第一個和最後一個頁碼。

fields
fields IdFields

2.1 的 ID 文件欄位。

自訂表單欄位

自訂表單欄位。

名稱 路徑 類型 Description
欄位名稱
fieldName string
欄位值
fieldValue FieldValue

預測欄位值物件。

發票欄位

2.1 的發票欄位。

名稱 路徑 類型 Description
應付金額(文字)
AmountDue.text string

退回發票上寫的應付金額。

應付金額(數量)
AmountDue.valueNumber number

格式化為數字。 範例:1234.98。

應付金額的置信度
AmountDue.confidence float

模型對其預測的信心程度。

帳單地址
BillingAddress.text string
帳單地址的信賴度
BillingAddress.confidence float

模型對其預測的信心程度。

帳單地址收件者
BillingAddressRecipient.text string
帳單地址收件者的信賴度
BillingAddressRecipient.confidence float

模型對其預測的信心程度。

客戶地址
CustomerAddress.text string
客戶地址的可信度
CustomerAddress.confidence float

模型對其預測的信心程度。

客戶地址收件者
CustomerAddressRecipient.text string
客戶地址收件者的信心
CustomerAddressRecipient.confidence float

模型對其預測的信心程度。

客戶識別碼
CustomerId.text string
客戶 ID 的置信度
CustomerId.confidence float

模型對其預測的信心程度。

客戶名稱
CustomerName.text string
客戶名稱的信賴度
CustomerName.confidence float

模型對其預測的信心程度。

截止日期(文字)
DueDate.text string

退回發票上寫的到期日。

截止日期(日期)
DueDate.valueDate date

格式化為日期。 範例:2019-05-31。

到期日的置信度
DueDate.confidence float

模型對其預測的信心程度。

發票日期 (文字)
InvoiceDate.text string

傳回發票上寫的發票日期。

發票日期(日期)
InvoiceDate.valueDate date

格式化為日期。 範例:2019-05-31。

發票日期的置信度
InvoiceDate.confidence float

模型對其預測的信心程度。

發票識別碼
InvoiceId.text string
發票 ID 的信賴度
InvoiceId.confidence float

模型對其預測的信心程度。

發票總計 (文字)
InvoiceTotal.text string

傳回發票上寫的發票總計。

發票總計 (數量)
InvoiceTotal.valueNumber number

格式化為數字。 範例:1234.98。

發票總額的置信度
InvoiceTotal.confidence float

模型對其預測的信心程度。

先前未付餘額 (文字)
PreviousUnpaidBalance.text string

傳回發票上寫的先前未付餘額。

先前未付餘額(數字)
PreviousUnpaidBalance.valueNumber number

格式化為數字。 範例:1234.98。

先前未付餘額的置信度
PreviousUnpaidBalance.confidence float

模型對其預測的信心程度。

採購單
PurchaseOrder.text string
採購訂單的置信度
PurchaseOrder.confidence float

模型對其預測的信心程度。

匯款地址
RemittanceAddress.text string
匯款地址的置信度
RemittanceAddress.confidence float

模型對其預測的信心程度。

匯款地址收款人
RemittanceAddressRecipient.text string
匯款地址收款人的信心
RemittanceAddressRecipient.confidence float

模型對其預測的信心程度。

服務地址
ServiceAddress.text string
服務地址的置信度
ServiceAddress.confidence float

模型對其預測的信心程度。

服務地址接收者
ServiceAddressRecipient.text string
服務地址接收者的信心
ServiceAddressRecipient.confidence float

模型對其預測的信心程度。

服務結束日期 (文字)
ServiceEndDate.text string

退回發票上寫的服務結束日期。

服務結束日期(日期)
ServiceEndDate.valueDate date

格式化為日期。 範例:2019-05-31。

服務結束日期的置信度
ServiceEndDate.confidence float

模型對其預測的信心程度。

服務開始日期(文字)
ServiceStartDate.text string

退回發票上寫的服務開始日期。

服務開始日期(日期)
ServiceStartDate.valueDate date

格式化為日期。 範例:2019-05-31。

服務開始日期的置信度
ServiceStartDate.confidence float

模型對其預測的信心程度。

送貨地址
ShippingAddress.text string
送貨地址的信心
ShippingAddress.confidence float

模型對其預測的信心程度。

送貨地址收件人
ShippingAddressRecipient.text string
收貨地址收件人的信心
ShippingAddressRecipient.confidence float

模型對其預測的信心程度。

小計 (文字)
SubTotal.text string

傳回發票上寫的小計。

小計 (數字)
SubTotal.valueNumber number

格式化為數字。 範例:1234.98。

小計的信賴度
SubTotal.confidence float

模型對其預測的信心程度。

稅金總額(文字)
TotalTax.text string

傳回發票上寫的總稅款。

稅金總額(數量)
TotalTax.valueNumber number

格式化為數字。 範例:1234.98。

總稅款的信心
TotalTax.confidence float

模型對其預測的信心程度。

廠商地址
VendorAddress.text string
供應商地址的置信度
VendorAddress.confidence float

模型對其預測的信心程度。

廠商地址收件者
VendorAddressRecipient.text string
供應商地址收件人的信心
VendorAddressRecipient.confidence float

模型對其預測的信心程度。

廠商名稱
VendorName.text string
供應商名稱的置信度
VendorName.confidence float

模型對其預測的信心程度。

物品
Items.valueArray array of object

委刊項陣列

金額(文字)
Items.valueArray.valueObject.Amount.text string

傳回發票上寫的金額。

金額(數字)
Items.valueArray.valueObject.Amount.valueNumber number

格式化為數字。 範例:12.

金額信心
Items.valueArray.valueObject.Amount.confidence float

模型對其預測的信心程度。

Description
Items.valueArray.valueObject.Description.text string
描述的置信度
Items.valueArray.valueObject.Description.confidence float

模型對其預測的信心程度。

數量(文字)
Items.valueArray.valueObject.Quantity.text string

傳回發票上寫的數量。

數量(數量)
Items.valueArray.valueObject.Quantity.valueNumber number

格式化為數字。 範例:12.

數量的置信度
Items.valueArray.valueObject.Quantity.confidence float

模型對其預測的信心程度。

單價(文字)
Items.valueArray.valueObject.UnitPrice.text string

傳回發票上寫的單價。

單價 (數字)
Items.valueArray.valueObject.UnitPrice.valueNumber number

格式化為數字。 範例:12.

單價置信度
Items.valueArray.valueObject.UnitPrice.confidence float

模型對其預測的信心程度。

產品代碼
Items.valueArray.valueObject.ProductCode.text string
產品代碼的置信度
Items.valueArray.valueObject.ProductCode.confidence float

模型對其預測的信心程度。

單位
Items.valueArray.valueObject.Unit.text string
單位置信度
Items.valueArray.valueObject.Unit.confidence float

模型對其預測的信心程度。

日期(文字)
Items.valueArray.valueObject.Date.text string

退回發票上寫的日期。

Date (日期)
Items.valueArray.valueObject.Date.valueDate date

格式化為日期。 範例:2019-05-31。

日期置信度
Items.valueArray.valueObject.Date.confidence float

模型對其預測的信心程度。

稅金(文字)
Items.valueArray.valueObject.Tax.text string

退稅如發票上所寫。

稅金(數字)
Items.valueArray.valueObject.Tax.valueNumber number

格式化為數字。 範例:12.

稅收信心
Items.valueArray.valueObject.Tax.confidence float

模型對其預測的信心程度。

BusinessCardFields

2.1 的 BusinessCard 欄位。

名稱 路徑 類型 Description
聯絡人姓名
ContactNames.valueArray array of object

連絡人名稱陣列

名字
ContactNames.valueArray.valueObject.FirstName.text string
名字的置信度
ContactNames.valueArray.valueObject.FirstName.confidence float

模型對其預測的信心程度。

姓氏
ContactNames.valueArray.valueObject.LastName.text string
姓氏的置信度
ContactNames.valueArray.valueObject.LastName.confidence float

模型對其預測的信心程度。

公司名稱
CompanyNames.valueArray array of object

公司名稱陣列

公司名稱
CompanyNames.valueArray.text string
公司名稱的置信度
CompanyNames.valueArray.confidence float

模型對其預測的信心程度。

Departments
Departments.valueArray array of object

一系列部門

部門
Departments.valueArray.text string
部門的信心
Departments.valueArray.confidence float

模型對其預測的信心程度。

職稱
JobTitles.valueArray array of object

職位名稱陣列

職稱
JobTitles.valueArray.text string
職稱的信心
JobTitles.valueArray.confidence float

模型對其預測的信心程度。

電子郵件
Emails.valueArray array of object

電子郵件陣列

Email
Emails.valueArray.text string
電子郵件的信心
Emails.valueArray.confidence float

模型對其預測的信心程度。

網站
Websites.valueArray array of object

網站陣列

網站
Websites.valueArray.text string
網站的信心
Websites.valueArray.confidence float

模型對其預測的信心程度。

Addresses
Addresses.valueArray array of object

位址陣列

Address
Addresses.valueArray.text string
位址的信賴度
Addresses.valueArray.confidence float

模型對其預測的信心程度。

手機
MobilePhones.valueArray array of object

手機陣列

行動電話
MobilePhones.valueArray.text string
手機的底氣
MobilePhones.valueArray.confidence float

模型對其預測的信心程度。

傳真
Faxes.valueArray array of object

傳真陣列

傳真
Faxes.valueArray.text string
傳真的信心
Faxes.valueArray.confidence float

模型對其預測的信心程度。

工作電話
WorkPhones.valueArray array of object

一系列工作電話

公司電話
WorkPhones.valueArray.text string
工作電話的信心
WorkPhones.valueArray.confidence float

模型對其預測的信心程度。

其他手機
OtherPhones.valueArray array of object

其他手機陣列

其他電話
OtherPhones.valueArray.text string
其他手機的置信度
OtherPhones.valueArray.confidence float

模型對其預測的信心程度。

收據欄位

Receipt欄位。

名稱 路徑 類型 Description
收據類型
ReceiptType.text string
收據類型的信賴度
ReceiptType.confidence float

模型對其預測的信心程度。

商家名稱
MerchantName.text string
商家名稱的置信度
MerchantName.confidence float

模型對其預測的信心程度。

商家電話號碼
MerchantPhoneNumber.text string
商家電話號碼的置信度
MerchantPhoneNumber.confidence float

模型對其預測的信心程度。

商家地址
MerchantAddress.text string
商家地址的置信度
MerchantAddress.confidence float

模型對其預測的信心程度。

交易日期(文字)
TransactionDate.text string

傳回發票上所寫的交易日期。

交易日期(日期)
TransactionDate.valueDate date

格式化為日期。 範例:2019-05-31。

交易日期的置信度
TransactionDate.confidence float

模型對其預測的信心程度。

交易時間(文字)
TransactionTime.text string

傳回發票上所寫的交易時間。

交易時間(時間)
TransactionTime.valueDate time

格式化為日期。 範例:2019-05-31。

交易時間的信心
TransactionTime.confidence float

模型對其預測的信心程度。

總計(文字)
Total.text string

傳回發票上寫的總計。

總計(數量)
Total.valueNumber number

格式化為數字。 範例:1234.98。

總計的置信度
Total.confidence float

模型對其預測的信心程度。

小計 (文字)
Subtotal.text string

傳回發票上寫的小計。

小計 (數字)
Subtotal.valueNumber number

格式化為數字。 範例:1234.98。

小計的信賴度
Subtotal.confidence float

模型對其預測的信心程度。

稅金(文字)
Tax.text string

退稅如發票上所寫。

稅金(數字)
Tax.valueNumber number

格式化為數字。 範例:1234.98。

稅收信心
Tax.confidence float

模型對其預測的信心程度。

提示(文字)
Tip.text string

退回發票上寫的小費。

小費(數字)
Tip.valueNumber number

格式化為數字。 範例:1234.98。

小費的置信度
Tip.confidence float

模型對其預測的信心程度。

物品
Items.valueArray array of object

委刊項陣列

名稱
Items.valueArray.valueObject.Name.text string
名稱的置信度
Items.valueArray.valueObject.Name.confidence float

模型對其預測的信心程度。

數量(文字)
Items.valueArray.valueObject.Quantity.text string

傳回發票上寫的數量。

數量(數量)
Items.valueArray.valueObject.Quantity.valueNumber number

格式化為數字。 範例:12.

數量的置信度
Items.valueArray.valueObject.Quantity.confidence float

模型對其預測的信心程度。

價格(文字)
Items.valueArray.valueObject.Price.text string

傳回發票上寫明的價格。

價格(數量)
Items.valueArray.valueObject.Price.valueNumber number

格式化為數字。 範例:12.

價格信心
Items.valueArray.valueObject.Price.confidence float

模型對其預測的信心程度。

總價(文字)
Items.valueArray.valueObject.TotalPrice.text string

傳回發票上寫的總價。

總價 (數目)
Items.valueArray.valueObject.TotalPrice.valueNumber number

格式化為數字。 範例:12.

總價置信度
Items.valueArray.valueObject.TotalPrice.confidence float

模型對其預測的信心程度。

Id欄位

2.1 的 ID 文件欄位。

名稱 路徑 類型 Description
國家地區
CountryRegion.valueCountryRegion string
國家地區的信心
CountryRegion.confidence float

模型對其預測的信心程度。

到期日期
DateOfExpiration.text string

傳回發票上寫的到期日期。

到期日期(日期)
DateOfExpiration.valueDate date

格式化為日期。 範例:2019-05-31。

到期日期的置信度
DateOfExpiration.confidence float

模型對其預測的信心程度。

出生日期(文字)
DateOfBirth.text string

傳回發票上寫的出生日期。

出生日期(日期)
DateOfBirth.valueDate date

格式化為日期。 範例:2019-05-31。

出生日期的置信度
DateOfBirth.confidence float

模型對其預測的信心程度。

文件編號
DocumentNumber.text string
文件編號的置信度
DocumentNumber.confidence float

模型對其預測的信心程度。

名字
FirstName.text string
名字的置信度
FirstName.confidence float

模型對其預測的信心程度。

姓氏
LastName.text string
姓氏的置信度
LastName.confidence float

模型對其預測的信心程度。

Nationality
Nationality.valueCountryRegion string
國籍信心
Nationality.confidence float

模型對其預測的信心程度。

Sex
Sex.text string
對性的信心
Sex.confidence float

模型對其預測的信心程度。

機器可讀區域
MachineReadableZone.text string
機器可讀區域的置信度
MachineReadableZone.confidence float

模型對其預測的信心程度。

文件類型
DocumentType.text string
文件類型的信賴度
DocumentType.confidence float

模型對其預測的信心程度。

Address
Address.text string
位址的信賴度
Address.confidence float

模型對其預測的信心程度。

區域
Region.text string
地區信心
Region.confidence float

模型對其預測的信心程度。

欄位值

預測欄位值物件。

名稱 路徑 類型 Description
型別
type FieldValueType

欄位值的語意資料類型。

值字串
valueString string

字串值。

valueDate
valueDate date-time

日期值。

值時間
valueTime date-time

時間值。

value電話號碼
valuePhoneNumber string

電話號碼值。

值編號
valueNumber number

浮點值。

value整數
valueInteger integer

整數值。

收發簡訊
text string
邊界框
boundingBox BoundingBox

四邊形邊界框,其座標相對於原始影像的左上方指定。 八個數字代表四個點,從左上角相對於文字方向順時針方向。 對於影像,(x, y) 座標以像素為單位。 對於 PDF,(x, y) 座標以英吋為單位。

信賴度
confidence Confidence

置信值。

元素
elements array of ElementReference

當 includeTextDetails 設定為 true 時,會是構成此欄位之文字元素的參考清單。

頁面
page integer

輸入文件中從 1 開始的頁碼。

欄位值類型

欄位值的語意資料類型。

欄位值的語意資料類型。

信賴度

置信值。

置信值。

ApiVersion_V30

API 版本。

API 版本。

AnalyzeResultOperation_V30

分析作業的狀態和結果。

名稱 路徑 類型 Description
狀態
status string

作業狀態。

createdDateTime
createdDateTime date-time

提交分析作業的日期和時間 (UTC)。

lastUpdatedDateTime
lastUpdatedDateTime date-time

上次更新狀態的日期和時間 (UTC)。

錯誤
error Error_V30

錯誤資訊。

分析結果
analyzeResult AnalyzeResult_V30

文檔分析結果。

AnalyzeResult_V30

文檔分析結果。

名稱 路徑 類型 Description
apiVersion
apiVersion ApiVersion_V30

API 版本。

modelId
modelId ModelId_V30

唯一的型號名稱。

stringIndexType
stringIndexType StringIndexType_V30

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

內容
content string

按閱讀順序串連所有文字和視覺元素的字串表示。

contentFormat
contentFormat ContentFormat_V40

分析結果中內容的格式。

pages
pages array of DocumentPage_V30

分析的頁面。

段落
paragraphs array of DocumentParagraph_V30

摘錄的段落。

tables
tables array of DocumentTable_V30

擷取的表格。

數字
figures array of DocumentFigure_V40

提取的數字。

部分
sections array of DocumentSection_V40

擷取的部分。

keyValuePairs
keyValuePairs array of DocumentKeyValuePair_V30

擷取的索引鍵值組。

entities
entities array of DocumentEntity_V30

擷取的實體。

風格
styles array of DocumentStyle_V30

提取的字體樣式。

語言
languages array of DocumentLanguage_V30

偵測到的語言。

documents array of Document_V30

提取的文件。

警告
warnings array of Warning_V40

遇到的警告清單。

DocumentPage_V30

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

名稱 路徑 類型 Description
類型
kind string

文檔頁面的種類。

頁號
pageNumber integer

輸入文件中從 1 開始的頁碼。

angle number

內容物順時針方向的一般方向,以 (-180, 180) 之間的度數測量。

寬度
width number

影像/PDF的寬度,分別以像素/英吋為單位。

height
height number

影像/PDF 的高度,分別以像素/英吋為單位。

單位
unit string

寬度、高度和多邊形屬性所使用的單位。 對於圖像,單位為“像素”。 對於 PDF,單位為“英寸”。

spans
spans array of DocumentSpan_V30

頁面在閱讀順序串連內容中的位置。

words
words array of DocumentWord_V30

從頁面中提取的單詞。

selection標記
selectionMarks array of DocumentSelectionMark_V30

從頁面中提取選取標記。

images
images array of DocumentImage_V30

從頁面中提取的圖像。

lines array of DocumentLine_V30

從頁面中提取的行,可能包含文本和視覺元素。

條碼
barcodes array of DocumentBarcode_V31

從頁面中提取條碼。

formulas
formulas array of DocumentFormula_V31

從頁面擷取公式。

DocumentWord_V30

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

名稱 路徑 類型 Description
內容
content string

單詞的文本內容。

多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

span
span DocumentSpan_V30

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

信賴度
confidence Confidence_V30

預測信賴度。

DocumentSelectionMark_V30

選取標記物件,代表核取方塊、選項按鈕和其他指示選取項目的元素。

名稱 路徑 類型 Description
狀態
state DocumentSelectionMarkState_V30

選取標記的狀態。

多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

span
span DocumentSpan_V30

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

信賴度
confidence Confidence_V30

預測信賴度。

DocumentImage_V30

在頁面中偵測到的影像物件。

名稱 路徑 類型 Description
多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

span
span DocumentSpan_V30

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

頁面參考
pageRef integer

包含影像內容之全域頁面陣列的從 0 開始的索引。

信賴度
confidence Confidence_V30

預測信賴度。

DocumentSelectionMarkState_V30

選取標記的狀態。

選取標記的狀態。

DocumentStyle_V30

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

名稱 路徑 類型 Description
背景顏色
backgroundColor string

十六進位格式 #rrggbb 背景顏色。

color
color string

十六進位格式 #rrggbb 前景色。

fontStyle
fontStyle string

字型樣式。

字體粗細
fontWeight string

字體粗細。

是手寫的
isHandwritten boolean

內容是手寫的。

類似字型家族
similarFontFamily string

在支援的字型系列集合中,視覺上最相似的字型,具有遵循 CSS 慣例的後援字型 (例如 'Arial, sans-serif')。

spans
spans array of DocumentSpan_V30

文字元素在樣式套用的串連內容中的位置。

信賴度
confidence Confidence_V30

預測信賴度。

DocumentLanguage_V30

代表給定文字範圍的偵測到語言的物件。

名稱 路徑 類型 Description
地區設定
locale string

偵測到的語言。 值可以是 ISO 639-1 語言代碼(例如“en”、“fr”)或 BCP 47 語言標籤(例如“zh-Hans”)。

spans
spans array of DocumentSpan_V30

文字元素在語言套用的串連內容中的位置。

信賴度
confidence Confidence_V30

預測信賴度。

DocumentLine_V30

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

名稱 路徑 類型 Description
內容
content string

按閱讀順序排列的所包含元素的串聯內容。

多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

spans
spans array of DocumentSpan_V30

閱讀順序串連內容中該行的位置。

DocumentParagraph_V30

由連續行組成的段落物件,通常具有共同的對齊方式和間距。

名稱 路徑 類型 Description
角色
role string

段落的語義作用。

內容
content string

段落內容按閱讀順序串連。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋段落的邊界區域。

spans
spans array of DocumentSpan_V30

段落在閱讀順序中的位置 串聯內容。

DocumentTable_V30

以矩形佈局排列的表格儲存格組成的表格物件。

名稱 路徑 類型 Description
rowCount
rowCount integer

表格中的列數。

直欄計數
columnCount integer

表格中的欄數。

細胞
cells array of DocumentTableCell_V30

表格中包含的儲存格。

字幕
caption DocumentCaption_V30

代表表格標題位置和內容的物件。

註腳
footnotes array of DocumentFootnote_V30

與表格相關聯的註腳。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋表格的邊界區域。

spans
spans array of DocumentSpan_V30

表格在閱讀順序串連內容中的位置。

DocumentTableCell_V30

代表表格儲存格位置和內容的物件。

名稱 路徑 類型 Description
類型
kind string

表單元格種類。

行索引
rowIndex integer

儲存格的列索引。

直欄索引
columnIndex integer

儲存格的資料行索引。

rowSpan (行跨度)
rowSpan integer

此儲存格跨越的資料列數。

資料行跨度
columnSpan integer

此儲存格跨越的資料行數。

內容
content string

按讀取順序串連表格儲存格的內容。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋表格儲存格的邊界區域。

spans
spans array of DocumentSpan_V30

表格儲存格在閱讀順序串連內容中的位置。

DocumentCaption_V30

代表表格標題位置和內容的物件。

名稱 路徑 類型 Description
內容
content string

表格標題內容。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋表格標題的邊界區域。

spans
spans array of DocumentSpan_V30

表格標題在閱讀順序串連內容中的位置。

DocumentFootnote_V30

代表表格註腳的位置和內容的物件。

名稱 路徑 類型 Description
內容
content string

表格註腳內容。

boundingRegions
boundingRegions array of BoundingRegion_V30

覆蓋表格註腳的邊界區域。

spans
spans array of DocumentSpan_V30

表格註腳在閱讀順序串聯內容中的位置。

DocumentKeyValuePair_V30

代表表單欄位的物件,具有不同的欄位標籤 (索引鍵) 和欄位值 (可以是空的)。

名稱 路徑 類型 Description
Key
key DocumentKeyValueElement_V30

代表索引鍵值組中欄位索引鍵或值的物件。

value
value DocumentKeyValueElement_V30

代表索引鍵值組中欄位索引鍵或值的物件。

信賴度
confidence Confidence_V30

預測信賴度。

DocumentKeyValueElement_V30

代表索引鍵值組中欄位索引鍵或值的物件。

名稱 路徑 類型 Description
內容
content string

按讀取順序串連索引鍵值元素的內容。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋索引鍵值元素的邊界區域。

spans
spans array of DocumentSpan_V30

索引鍵值元素在讀取順序串連內容中的位置。

DocumentEntity_V30

代表各種實體類別的物件。

名稱 路徑 類型 Description
分類
category string

實體類型。

子類別
subCategory string

實體子類型。

內容
content string

實體內容。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋實體的邊界區域。

spans
spans array of DocumentSpan_V30

實體在讀取順序串連內容中的位置。

信賴度
confidence Confidence_V30

預測信賴度。

DocumentBarcode_V31

條碼物件。

名稱 路徑 類型 Description
信賴度
confidence Confidence_V30

預測信賴度。

類型
kind string

條碼種類。

多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

span
span DocumentSpan_V30

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

value
value string

條碼值

DocumentFormula_V31

公式物件。

名稱 路徑 類型 Description
信賴度
confidence Confidence_V30

預測信賴度。

類型
kind string

公式種類。

多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

span
span DocumentSpan_V30

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

value
value string

描述公式的 LaTex 表達式。

DocumentFigure_V40

代表文件中圖形的物件。

名稱 路徑 類型 Description
boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋圖形的邊界區域。

spans
spans array of DocumentSpan_V30

圖在閱讀順序串聯內容中的位置。

元素
elements array of DocumentElement_V40

圖形的子元素,不包括任何標題或註腳。

字幕
caption DocumentCaption_V30

代表表格標題位置和內容的物件。

註腳
footnotes array of DocumentFootnote_V30

與圖相關聯的註腳清單。

識別碼
id string

圖 ID。

DocumentSection_V40

代表文件中區段的物件。

名稱 路徑 類型 Description
spans
spans array of DocumentSpan_V30

區段在閱讀順序串連內容中的位置。

元素
elements array of DocumentElement_V40

區段的子元素。

DocumentElement_V40

參考文件元素的 JSON 指標,例如段落、表格、區段等。

參考文件元素的 JSON 指標,例如段落、表格、區段等。

Warning_V40

error 物件。

名稱 路徑 類型 Description
字碼
code string

伺服器定義的一組警告碼之一。

訊息
message string

警告的人類可讀表示法。

目標
target string

錯誤的目標。

ContentFormat_V40

分析結果中內容的格式。

分析結果中內容的格式。

Document_V30

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

名稱 路徑 類型 Description
文件類型
docType DocType_V30

文件類型名稱。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋文件的邊界區域。

spans
spans array of DocumentSpan_V30

文件在閱讀順序中串連內容的位置。

fields
fields object

具名欄位值的字典。

Fields
_fields array of DocumentFieldNameValue_V30

具有 fieldName 和 fieldValue 屬性的欄位陣列。

信賴度
confidence Confidence_V30

預測信賴度。

BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

名稱 路徑 類型 Description
物品
number

BoundingRegion_V30

輸入特定頁面上的邊界多邊形。

名稱 路徑 類型 Description
頁號
pageNumber integer

包含邊界區域的頁面頁碼從 1 開始。

多邊形
polygon BoundingPolygon_V30

邊界多邊形,其座標相對於頁面左上方指定。 數字代表多邊形頂點的 x、y 值,相對於元素方向從左順時針方向 (包括-180 度)。

DocumentFieldType_V30

欄位值的語意資料類型。

欄位值的語意資料類型。

DocumentFieldNameValue_V30

具有欄位名稱及其值的文件欄位物件。

名稱 路徑 類型 Description
欄位名稱
fieldName string
欄位值
fieldValue DocumentField_V30

代表欄位值內容和位置的物件。

DocumentField_V30

代表欄位值內容和位置的物件。

名稱 路徑 類型 Description
型別
type DocumentFieldType_V30

欄位值的語意資料類型。

值字串
valueString string

字串值。

valueDate
valueDate date

YYYY-MM-DD 格式的日期值(ISO 8601)。

值時間
valueTime time

hh:mm:ss 格式的時間值 (ISO 8601)。

value電話號碼
valuePhoneNumber string

E.164 格式的電話號碼值 (例如 +19876543210)。

值編號
valueNumber number

浮點值。

value整數
valueInteger integer

整數值。

valueSelectionMark
valueSelectionMark DocumentSelectionMarkState_V30

選取標記的狀態。

valueSignature
valueSignature string

簽名的存在。

valueCountryRegion
valueCountryRegion string

3 個字母的國家/地區代碼值 (ISO 3166-1 alpha-3)。

valueCurrency
valueCurrency CurrencyValue_V30

貨幣欄位值。

value地址
valueAddress AddressValue_V30

地址欄位值。

value布林值
valueBoolean boolean

布林值。

內容
content string

欄位內容。

boundingRegions
boundingRegions array of BoundingRegion_V30

涵蓋欄位的邊界區域。

spans
spans array of DocumentSpan_V30

欄位在閱讀順序串連內容中的位置。

信賴度
confidence Confidence_V30

預測信賴度。

Confidence_V30

預測信賴度。

預測信賴度。

DocType_V30

文件類型名稱。

文件類型名稱。

DocumentSpan_V30

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

名稱 路徑 類型 Description
位移
offset integer

範圍所代表之內容的零基礎索引。

length
length integer

範圍所代表的內容中的字元數。

StringIndexType_V30

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

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

ModelId_V30

唯一的型號名稱。

唯一的型號名稱。

Error_V30

錯誤資訊。

名稱 路徑 類型 Description
字碼
code string

錯誤碼。

訊息
message string

錯誤訊息。

目標
target string

錯誤的目標。

details
details array of InnerError_V30

詳細錯誤清單。

inner錯誤
innererror InnerError_V30

詳細錯誤。

InnerError_V30

詳細錯誤。

名稱 路徑 類型 Description
字碼
code string

錯誤碼。

訊息
message string

錯誤訊息。

CurrencyValue_V30

貨幣欄位值。

名稱 路徑 類型 Description
金額
amount double

貨幣金額。

貨幣代碼
currencyCode string

已解析的貨幣代碼 (ISO 4217)(如果有)。

貨幣符號
currencySymbol string

貨幣符號標籤 (如果有的話)。

AddressValue_V30

地址欄位值。

名稱 路徑 類型 Description
門牌號碼
houseNumber string

門牌號或建築物號。

郵政信箱
poBox string

郵政信箱號碼。

道路
road string

街道名稱。

city
city string

城市、城鎮、村莊等名稱。

狀態
state string

一級行政區劃。

postalCode
postalCode string

郵遞區號用於郵件分類。

國家/地區
countryRegion string

國家或地區。

街道地址
streetAddress string

街道層級地址,不包括城市、州、國家/地區和郵遞區號。

城市區
cityDistrict string

城市內的地區或行政區,例如紐約市的布魯克林或倫敦的威斯敏斯特市。

房子
house string

建構名稱,例如 World Trade Center。

水平儀
level string

樓層號,例如 3F。

州區
stateDistrict string

特定地區使用的二級行政區劃。

郊區
suburb string

非官方的街區名稱,如唐人街。

單位
unit string

公寓或辦公室號碼。